Skip to content

Commit

Permalink
Service Account tests: Use OpenAPI client
Browse files Browse the repository at this point in the history 
Gets rid of the manually written checkers in favor of the new ones that use the OpenAPI client
  • Loading branch information
@julienduchesne
julienduchesne committed Nov 9, 2023
1 parent 222c4f1 commit 4dd1d26
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 95 deletions.
9 changes: 9 additions & 0 deletions internal/resources/grafana/common_check_exists_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
goapi "github.com/grafana/grafana-openapi-client-go/client"
"github.com/grafana/grafana-openapi-client-go/client/annotations"
"github.com/grafana/grafana-openapi-client-go/client/folders"
"github.com/grafana/grafana-openapi-client-go/client/service_accounts"
"github.com/grafana/grafana-openapi-client-go/client/teams"
"github.com/grafana/grafana-openapi-client-go/client/users"
"github.com/grafana/grafana-openapi-client-go/models"
Expand Down Expand Up @@ -37,6 +38,14 @@ var (
return payloadOrError(resp, err)
},
)
serviceAccountCheckExists = newCheckExistsHelper(
func(t *models.ServiceAccountDTO) string { return strconv.FormatInt(t.ID, 10) },
func(client *goapi.GrafanaHTTPAPI, id string) (*models.ServiceAccountDTO, error) {
params := service_accounts.NewRetrieveServiceAccountParams().WithServiceAccountID(mustParseInt64(id))
resp, err := client.ServiceAccounts.RetrieveServiceAccount(params, nil)
return payloadOrError(resp, err)
},
)
teamCheckExists = newCheckExistsHelper(
func(t *models.TeamDTO) string { return strconv.FormatInt(t.ID, 10) },
func(client *goapi.GrafanaHTTPAPI, id string) (*models.TeamDTO, error) {
Expand Down
108 changes: 21 additions & 87 deletions internal/resources/grafana/resource_service_account_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,31 @@ import (
"errors"
"fmt"
"regexp"
"strconv"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"

gapi "github.com/grafana/grafana-api-golang-client"
"github.com/grafana/terraform-provider-grafana/internal/common"
"github.com/grafana/terraform-provider-grafana/internal/resources/grafana"
"github.com/grafana/grafana-openapi-client-go/models"
"github.com/grafana/terraform-provider-grafana/internal/testutils"
)

func TestAccServiceAccount_basic(t *testing.T) {
testutils.CheckOSSTestsEnabled(t, ">=9.1.0")

var sa gapi.ServiceAccountDTO
var updatedSA gapi.ServiceAccountDTO
var sa models.ServiceAccountDTO
var updatedSA models.ServiceAccountDTO
name := acctest.RandString(10)

resource.ParallelTest(t, resource.TestCase{
ProviderFactories: testutils.ProviderFactories,
CheckDestroy: testAccServiceAccountCheckDestroy,
CheckDestroy: serviceAccountCheckExists.destroyed(&updatedSA, nil),
Steps: []resource.TestStep{
{
Config: testServiceAccountConfig(name, "Editor"),
Check: resource.ComposeTestCheckFunc(
testAccServiceAccountCheckExists(&sa),
serviceAccountCheckExists.exists("grafana_service_account.test", &sa),
resource.TestCheckResourceAttr("grafana_service_account.test", "name", name),
resource.TestCheckResourceAttr("grafana_service_account.test", "org_id", "1"),
resource.TestCheckResourceAttr("grafana_service_account.test", "role", "Editor"),
Expand All @@ -43,7 +40,7 @@ func TestAccServiceAccount_basic(t *testing.T) {
{
Config: testServiceAccountConfig(name+"-updated", "Editor"),
Check: resource.ComposeTestCheckFunc(
testAccServiceAccountCheckExists(&updatedSA),
serviceAccountCheckExists.exists("grafana_service_account.test", &updatedSA),
func(s *terraform.State) error {
if sa.ID != updatedSA.ID {
return errors.New("ID changed")
Expand All @@ -65,16 +62,16 @@ func TestAccServiceAccount_NoneRole(t *testing.T) {
testutils.CheckOSSTestsEnabled(t, ">=10.2.0")

name := acctest.RandString(10)
var sa gapi.ServiceAccountDTO
var sa models.ServiceAccountDTO

resource.ParallelTest(t, resource.TestCase{
ProviderFactories: testutils.ProviderFactories,
CheckDestroy: testAccServiceAccountCheckDestroy,
CheckDestroy: serviceAccountCheckExists.destroyed(&sa, nil),
Steps: []resource.TestStep{
{
Config: testServiceAccountConfig(name, "None"),
Check: resource.ComposeTestCheckFunc(
testAccServiceAccountCheckExists(&sa),
serviceAccountCheckExists.exists("grafana_service_account.test", &sa),
resource.TestCheckResourceAttr("grafana_service_account.test", "name", name),
resource.TestCheckResourceAttr("grafana_service_account.test", "org_id", "1"),
resource.TestCheckResourceAttr("grafana_service_account.test", "role", "None"),
Expand All @@ -94,16 +91,23 @@ func TestAccServiceAccount_many_longtest(t *testing.T) {

name := acctest.RandString(10)

// For each SA, check that it exists and has the correct name, then check that it is properly destroyed
createdServiceAccounts := make([]models.ServiceAccountDTO, 60)
checks := []resource.TestCheckFunc{}
destroyedChecks := []resource.TestCheckFunc{}
for i := 0; i < 60; i++ {
checks = append(checks, serviceAccountCheckExists.exists(fmt.Sprintf("grafana_service_account.test_%d", i), &createdServiceAccounts[i]))
checks = append(checks, resource.TestCheckResourceAttr(fmt.Sprintf("grafana_service_account.test_%d", i), "name", fmt.Sprintf("%s-%d", name, i)))
destroyedChecks = append(destroyedChecks, serviceAccountCheckExists.destroyed(&createdServiceAccounts[i], nil))
}

resource.ParallelTest(t, resource.TestCase{
ProviderFactories: testutils.ProviderFactories,
CheckDestroy: testAccServiceAccountCheckDestroy,
CheckDestroy: resource.ComposeAggregateTestCheckFunc(destroyedChecks...),
Steps: []resource.TestStep{
{
Config: testManyServiceAccountsConfig(name, 60),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("grafana_service_account.test_1", "name", name+"-1"),
resource.TestCheckResourceAttr("grafana_service_account.test_2", "name", name+"-2"),
),
Check: resource.ComposeAggregateTestCheckFunc(checks...),
},
},
})
Expand All @@ -114,7 +118,6 @@ func TestAccServiceAccount_invalid_role(t *testing.T) {

resource.ParallelTest(t, resource.TestCase{
ProviderFactories: testutils.ProviderFactories,
CheckDestroy: testAccServiceAccountCheckDestroy,
Steps: []resource.TestStep{
{
ExpectError: regexp.MustCompile(`.*expected role to be one of \[.+\], got InvalidRole`),
Expand All @@ -140,75 +143,6 @@ func testManyServiceAccountsConfig(prefix string, count int) string {
return config
}

func testAccServiceAccountCheckExists(sa *gapi.ServiceAccountDTO) resource.TestCheckFunc {
return func(s *terraform.State) error {
foundSA, err := testAccServiceAccountCheckExistsBool(s, true)
if err != nil {
return err
}
*sa = *foundSA
return nil
}
}

func testAccServiceAccountCheckDestroy(s *terraform.State) error {
_, err := testAccServiceAccountCheckExistsBool(s, false)
return err
}

func testAccServiceAccountCheckExistsBool(s *terraform.State, shouldExist bool) (*gapi.ServiceAccountDTO, error) {
c := testutils.Provider.Meta().(*common.Client).GrafanaAPI

for _, rs := range s.RootModule().Resources {
if rs.Type != "grafana_service_account" {
continue
}

orgID, idStr := grafana.SplitOrgResourceID(rs.Primary.ID)
id, err := strconv.ParseInt(idStr, 10, 32)
if err != nil {
return nil, err
}

// If orgID > 1, always check that the SA doesn't exist in the default org
if orgID > 1 {
sas, err := c.GetServiceAccounts()
if err != nil {
return nil, err
}

for _, sa := range sas {
if sa.ID == id {
return nil, errors.New("Service account exists in the default org")
}
}

c = c.WithOrgID(orgID)
}

sas, err := c.GetServiceAccounts()
if err != nil {
return nil, err
}

for _, sa := range sas {
if sa.ID == id {
if shouldExist {
return &sa, nil
} else {
return nil, errors.New("Service account still exists")
}
}
}

if shouldExist {
return nil, errors.New("Service account was not found")
}
}

return nil, nil
}

func testServiceAccountConfig(name, role string) string {
return fmt.Sprintf(`
resource "grafana_service_account" "test" {
Expand Down
23 changes: 15 additions & 8 deletions internal/resources/grafana/resource_service_account_token_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"testing"

gapi "github.com/grafana/grafana-api-golang-client"
"github.com/grafana/grafana-openapi-client-go/models"
"github.com/grafana/terraform-provider-grafana/internal/common"
"github.com/grafana/terraform-provider-grafana/internal/testutils"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
Expand All @@ -17,16 +18,19 @@ func TestAccServiceAccountToken_basic(t *testing.T) {
testutils.CheckOSSTestsEnabled(t, ">=9.1.0")

name := acctest.RandString(10)
var sa gapi.ServiceAccountDTO
var sa models.ServiceAccountDTO

resource.ParallelTest(t, resource.TestCase{
ProviderFactories: testutils.ProviderFactories,
CheckDestroy: testAccServiceAccountTokenCheckDestroy,
CheckDestroy: resource.ComposeTestCheckFunc(
serviceAccountCheckExists.destroyed(&sa, nil),
testAccServiceAccountTokenCheckDestroy,
),
Steps: []resource.TestStep{
{
Config: testAccServiceAccountTokenConfig(name, "Editor", 0, false),
Check: resource.ComposeTestCheckFunc(
testAccServiceAccountCheckExists(&sa),
serviceAccountCheckExists.exists("grafana_service_account.test", &sa),
resource.TestCheckResourceAttr("grafana_service_account.test", "name", name),
resource.TestCheckResourceAttr("grafana_service_account.test", "role", "Editor"),
resource.TestCheckResourceAttr("grafana_service_account_token.test", "name", name),
Expand All @@ -36,7 +40,7 @@ func TestAccServiceAccountToken_basic(t *testing.T) {
{
Config: testAccServiceAccountTokenConfig(name+"-updated", "Viewer", 300, false),
Check: resource.ComposeTestCheckFunc(
testAccServiceAccountCheckExists(&sa),
serviceAccountCheckExists.exists("grafana_service_account.test", &sa),
resource.TestCheckResourceAttr("grafana_service_account.test", "name", name+"-updated"),
resource.TestCheckResourceAttr("grafana_service_account.test", "role", "Viewer"),
resource.TestCheckResourceAttr("grafana_service_account_token.test", "name", name+"-updated"),
Expand All @@ -52,16 +56,19 @@ func TestAccServiceAccountToken_inOrg(t *testing.T) {

name := acctest.RandString(10)
var org gapi.Org
var sa gapi.ServiceAccountDTO
var sa models.ServiceAccountDTO

resource.ParallelTest(t, resource.TestCase{
ProviderFactories: testutils.ProviderFactories,
CheckDestroy: testAccServiceAccountTokenCheckDestroy,
CheckDestroy: resource.ComposeTestCheckFunc(
serviceAccountCheckExists.destroyed(&sa, &org),
testAccServiceAccountTokenCheckDestroy,
),
Steps: []resource.TestStep{
{
Config: testAccServiceAccountTokenConfig(name, "Editor", 0, true),
Check: resource.ComposeTestCheckFunc(
testAccServiceAccountCheckExists(&sa),
serviceAccountCheckExists.exists("grafana_service_account.test", &sa),
resource.TestCheckResourceAttr("grafana_service_account.test", "name", name),
resource.TestCheckResourceAttr("grafana_service_account.test", "role", "Editor"),
resource.TestCheckResourceAttr("grafana_service_account_token.test", "name", name),
Expand All @@ -76,7 +83,7 @@ func TestAccServiceAccountToken_inOrg(t *testing.T) {
{
Config: testAccServiceAccountTokenConfig(name+"-updated", "Viewer", 300, true),
Check: resource.ComposeTestCheckFunc(
testAccServiceAccountCheckExists(&sa),
serviceAccountCheckExists.exists("grafana_service_account.test", &sa),
resource.TestCheckResourceAttr("grafana_service_account.test", "name", name+"-updated"),
resource.TestCheckResourceAttr("grafana_service_account.test", "role", "Viewer"),
resource.TestCheckResourceAttr("grafana_service_account_token.test", "name", name+"-updated"),
Expand Down

0 comments on commit 4dd1d26

Please sign in to comment.