Enums instead of strings (#279)

* use struct string like enums. remove AccountLicenseType & convertVisibility as this can be done implicitly. fix func name. add enums for RepoType, RepoInitType

* remove duplicate for set path

* fix merge issue

* use enum for BitBucket

* use strings.EqualFold for string compare

Author: Kalarrs Topham

azuredevops/data_projects.go

@@ -32,7 +32,7 @@ func dataProjects() *schema.Resource {
 				Type:     schema.TypeString,
 				ForceNew: true,
 				Optional: true,
-				Default:  "all",
+				Default:  core.ProjectStateValues.All,
 				ValidateFunc: validation.StringInSlice([]string{
 					string(core.ProjectStateValues.Deleting),
 					string(core.ProjectStateValues.New),

azuredevops/resource_agentpool.go

@@ -30,11 +30,14 @@ func resourceAzureAgentPool() *schema.Resource {
 				ValidateFunc: validate.NoEmptyStrings,
 			},
 			"pool_type": {
-				Type:         schema.TypeString,
-				Optional:     true,
-				ForceNew:     true,
-				Default:      taskagent.TaskAgentPoolTypeValues.Automation,
-				ValidateFunc: validation.StringInSlice([]string{string(taskagent.TaskAgentPoolTypeValues.Automation), string(taskagent.TaskAgentPoolTypeValues.Deployment)}, false),
+				Type:     schema.TypeString,
+				Optional: true,
+				ForceNew: true,
+				Default:  taskagent.TaskAgentPoolTypeValues.Automation,
+				ValidateFunc: validation.StringInSlice([]string{
+					string(taskagent.TaskAgentPoolTypeValues.Automation),
+					string(taskagent.TaskAgentPoolTypeValues.Deployment),
+				}, false),
 			},
 			"auto_provision": {
 				Type:     schema.TypeBool,

azuredevops/resource_build_definition.go

@@ -16,6 +16,22 @@ import (
 	"github.com/microsoft/terraform-provider-azuredevops/azuredevops/utils/validate"
 )
 
+// RepoType the type of the repository
+type RepoType string
+
+type repoTypeValuesType struct {
+	GitHub    RepoType
+	TfsGit    RepoType
+	Bitbucket RepoType
+}
+
+// RepoTypeValues enum of the type of the repository
+var RepoTypeValues = repoTypeValuesType{
+	GitHub:    "GitHub",
+	TfsGit:    "TfsGit",
+	Bitbucket: "Bitbucket",
+}
+
 func resourceBuildDefinition() *schema.Resource {
 	filterSchema := map[string]*schema.Schema{
 		"include": {
@@ -62,7 +78,7 @@ func resourceBuildDefinition() *schema.Resource {
 			State: func(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
 				projectID, buildDefinitionID, err := ParseImportedProjectIDAndID(meta.(*config.AggregatedClient), d.Id())
 				if err != nil {
-					return nil, fmt.Errorf("Error parsing the build definition ID from the Terraform resource data: %v", err)
+					return nil, fmt.Errorf("error parsing the build definition ID from the Terraform resource data: %v", err)
 				}
 				d.Set("project_id", projectID)
 				d.SetId(fmt.Sprintf("%d", buildDefinitionID))
@@ -121,9 +137,13 @@ func resourceBuildDefinition() *schema.Resource {
 							Required: true,
 						},
 						"repo_type": {
-							Type:         schema.TypeString,
-							Required:     true,
-							ValidateFunc: validation.StringInSlice([]string{"GitHub", "TfsGit", "Bitbucket"}, false),
+							Type:     schema.TypeString,
+							Required: true,
+							ValidateFunc: validation.StringInSlice([]string{
+								string(RepoTypeValues.GitHub),
+								string(RepoTypeValues.TfsGit),
+								string(RepoTypeValues.Bitbucket),
+							}, false),
 						},
 						"branch_name": {
 							Type:     schema.TypeString,
@@ -257,12 +277,12 @@ func resourceBuildDefinitionCreate(d *schema.ResourceData, m interface{}) error
 	}
 	buildDefinition, projectID, err := expandBuildDefinition(d)
 	if err != nil {
-		return fmt.Errorf("Error creating resource Build Definition: %+v", err)
+		return fmt.Errorf("error creating resource Build Definition: %+v", err)
 	}
 
 	createdBuildDefinition, err := createBuildDefinition(clients, buildDefinition, projectID)
 	if err != nil {
-		return fmt.Errorf("Error creating resource Build Definition: %+v", err)
+		return fmt.Errorf("error creating resource Build Definition: %+v", err)
 	}
 
 	flattenBuildDefinition(d, createdBuildDefinition, projectID)
@@ -282,10 +302,10 @@ func flattenBuildDefinition(d *schema.ResourceData, buildDefinition *build.Build
 
 	if buildDefinition.Triggers != nil {
 		yamlCiTrigger := hasSettingsSourceType(buildDefinition.Triggers, build.DefinitionTriggerTypeValues.ContinuousIntegration, 2)
-		d.Set("ci_trigger", flattenReleaseDefinitionTriggers(buildDefinition.Triggers, yamlCiTrigger, build.DefinitionTriggerTypeValues.ContinuousIntegration))
+		d.Set("ci_trigger", flattenBuildDefinitionTriggers(buildDefinition.Triggers, yamlCiTrigger, build.DefinitionTriggerTypeValues.ContinuousIntegration))
 
 		yamlPrTrigger := hasSettingsSourceType(buildDefinition.Triggers, build.DefinitionTriggerTypeValues.PullRequest, 2)
-		d.Set("pull_request_trigger", flattenReleaseDefinitionTriggers(buildDefinition.Triggers, yamlPrTrigger, build.DefinitionTriggerTypeValues.PullRequest))
+		d.Set("pull_request_trigger", flattenBuildDefinitionTriggers(buildDefinition.Triggers, yamlPrTrigger, build.DefinitionTriggerTypeValues.PullRequest))
 	}
 
 	revision := 0
@@ -513,7 +533,7 @@ func hasSettingsSourceType(m *[]interface{}, t build.DefinitionTriggerType, sst
 	hasSetting := false
 	for _, d := range *m {
 		if ms, ok := d.(map[string]interface{}); ok {
-			if ms["triggerType"].(string) == string(t) {
+			if strings.EqualFold(ms["triggerType"].(string), string(t)) {
 				if val, ok := ms["settingsSourceType"]; ok {
 					hasSetting = int(val.(float64)) == sst
 				}
@@ -523,7 +543,7 @@ func hasSettingsSourceType(m *[]interface{}, t build.DefinitionTriggerType, sst
 	return hasSetting
 }
 
-func flattenReleaseDefinitionTriggers(m *[]interface{}, isYaml bool, t build.DefinitionTriggerType) []interface{} {
+func flattenBuildDefinitionTriggers(m *[]interface{}, isYaml bool, t build.DefinitionTriggerType) []interface{} {
 	ds := make([]interface{}, 0, len(*m))
 	for _, d := range *m {
 		f := flattenBuildDefinitionTrigger(d, isYaml, t)
@@ -710,12 +730,12 @@ func expandBuildDefinition(d *schema.ResourceData) (*build.BuildDefinition, stri
 	repository := repositories[0].(map[string]interface{})
 
 	repoName := repository["repo_name"].(string)
-	repoType := repository["repo_type"].(string)
+	repoType := RepoType(repository["repo_type"].(string))
 	repoURL := ""
-	if strings.EqualFold(repoType, "github") {
+	if strings.EqualFold(string(repoType), string(RepoTypeValues.GitHub)) {
 		repoURL = fmt.Sprintf("https://github.com/%s.git", repoName)
 	}
-	if strings.EqualFold(repoType, "bitbucket") {
+	if strings.EqualFold(string(repoType), string(RepoTypeValues.Bitbucket)) {
 		repoURL = fmt.Sprintf("https://bitbucket.org/%s.git", repoName)
 	}
 
@@ -751,7 +771,7 @@ func expandBuildDefinition(d *schema.ResourceData) (*build.BuildDefinition, stri
 			Id:            &repoName,
 			Name:          &repoName,
 			DefaultBranch: converter.String(repository["branch_name"].(string)),
-			Type:          &repoType,
+			Type:          converter.String(string(repoType)),
 			Properties: &map[string]string{
 				"connectedServiceId": repository["service_connection_id"].(string),
 			},
@@ -786,7 +806,7 @@ func validateServiceConnectionIDExistsIfNeeded(d *schema.ResourceData) error {
 	repoType := repository["repo_type"].(string)
 	serviceConnectionID := repository["service_connection_id"].(string)
 
-	if strings.EqualFold(repoType, "bitbucket") && serviceConnectionID == "" {
+	if strings.EqualFold(repoType, string(RepoTypeValues.Bitbucket)) && serviceConnectionID == "" {
 		return errors.New("bitbucket repositories need a referenced service connection ID")
 	}
 	return nil

azuredevops/resource_git_repository.go

@@ -19,6 +19,24 @@ import (
 	"github.com/microsoft/terraform-provider-azuredevops/azuredevops/utils/validate"
 )
 
+// RepoInitType strategy for initializing the repo
+type RepoInitType string
+
+type repoInitTypeValuesType struct {
+	Uninitialized RepoInitType
+	Clean         RepoInitType
+	Fork          RepoInitType
+	Import        RepoInitType
+}
+
+// RepoInitTypeValues enum of strategy for initializing the repo
+var RepoInitTypeValues = repoInitTypeValuesType{
+	Uninitialized: "Uninitialized",
+	Clean:         "Clean",
+	Fork:          "Fork",
+	Import:        "Import",
+}
+
 func resourceGitRepository() *schema.Resource {
 	return &schema.Resource{
 		Create: resourceGitRepositoryCreate,
@@ -84,9 +102,14 @@ func resourceGitRepository() *schema.Resource {
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"init_type": {
-							Type:         schema.TypeString,
-							Required:     true,
-							ValidateFunc: validation.StringInSlice([]string{"uninitialized", "clean", "import"}, true),
+							Type:     schema.TypeString,
+							Required: true,
+							ValidateFunc: validation.StringInSlice([]string{
+								string(RepoInitTypeValues.Clean),
+								string(RepoInitTypeValues.Fork),
+								string(RepoInitTypeValues.Import),
+								string(RepoInitTypeValues.Uninitialized),
+							}, false),
 						},
 						"source_type": {
 							Type:     schema.TypeString,

azuredevops/resource_project.go

@@ -46,17 +46,23 @@ func resourceProject() *schema.Resource {
 				Default:  "",
 			},
 			"visibility": {
-				Type:         schema.TypeString,
-				Optional:     true,
-				Default:      "private",
-				ValidateFunc: validation.StringInSlice([]string{"private", "public"}, false),
+				Type:     schema.TypeString,
+				Optional: true,
+				Default:  core.ProjectVisibilityValues.Private,
+				ValidateFunc: validation.StringInSlice([]string{
+					string(core.ProjectVisibilityValues.Private),
+					string(core.ProjectVisibilityValues.Public),
+				}, false),
 			},
 			"version_control": {
-				Type:         schema.TypeString,
-				ForceNew:     true,
-				Optional:     true,
-				Default:      "Git",
-				ValidateFunc: validation.StringInSlice([]string{"Git", "Tfvc"}, true),
+				Type:     schema.TypeString,
+				ForceNew: true,
+				Optional: true,
+				Default:  core.SourceControlTypesValues.Git,
+				ValidateFunc: validation.StringInSlice([]string{
+					string(core.SourceControlTypesValues.Git),
+					string(core.SourceControlTypesValues.Tfvc),
+				}, true),
 			},
 			"work_item_template": {
 				Type:             schema.TypeString,
@@ -246,7 +252,7 @@ func expandProject(clients *config.AggregatedClient, d *schema.ResourceData, for
 		projectID = &parsedID
 	}
 
-	visibility := d.Get("visibility").(string)
+	visibility := core.ProjectVisibility(d.Get("visibility").(string))
 
 	var capabilities *map[string]map[string]string
 	if forCreate {
@@ -264,20 +270,13 @@ func expandProject(clients *config.AggregatedClient, d *schema.ResourceData, for
 		Id:           projectID,
 		Name:         converter.String(d.Get("project_name").(string)),
 		Description:  converter.String(d.Get("description").(string)),
-		Visibility:   convertVisibility(visibility),
+		Visibility:   &visibility,
 		Capabilities: capabilities,
 	}
 
 	return project, nil
 }
 
-func convertVisibility(v string) *core.ProjectVisibility {
-	if strings.EqualFold(v, "public") {
-		return &core.ProjectVisibilityValues.Public
-	}
-	return &core.ProjectVisibilityValues.Private
-}
-
 func flattenProject(clients *config.AggregatedClient, d *schema.ResourceData, project *core.TeamProject) error {
 	description := converter.ToString(project.Description, "")
 	processTemplateID := (*project.Capabilities)["processTemplate"]["templateTypeId"]

azuredevops/resource_serviceendpoint_bitbucket.go

@@ -24,7 +24,7 @@ func expandServiceEndpointBitBucket(d *schema.ResourceData) (*serviceendpoint.Se
 		},
 		Scheme: converter.String("UsernamePassword"),
 	}
-	serviceEndpoint.Type = converter.String("bitbucket")
+	serviceEndpoint.Type = converter.String(string(RepoTypeValues.Bitbucket))
 	serviceEndpoint.Url = converter.String("https://api.bitbucket.org/")
 	return serviceEndpoint, projectID
 }

azuredevops/resource_user_entitlement.go

@@ -13,7 +13,6 @@ import (
 	"github.com/microsoft/azure-devops-go-api/azuredevops/memberentitlementmanagement"
 	"github.com/microsoft/terraform-provider-azuredevops/azuredevops/utils"
 	"github.com/microsoft/terraform-provider-azuredevops/azuredevops/utils/config"
-	"github.com/microsoft/terraform-provider-azuredevops/azuredevops/utils/converter"
 )
 
 func resourceUserEntitlement() *schema.Resource {
@@ -41,11 +40,18 @@ func resourceUserEntitlement() *schema.Resource {
 				ValidateFunc: validation.StringInSlice([]string{"aad", "ghb"}, false),
 			},
 			"account_license_type": {
-				Type:         schema.TypeString,
-				Optional:     true,
-				ForceNew:     true,
-				Default:      "express",
-				ValidateFunc: validation.StringInSlice([]string{"advanced", "earlyAdopter", "express", "none", "professional", "stakeholder"}, false),
+				Type:     schema.TypeString,
+				Optional: true,
+				ForceNew: true,
+				Default:  licensing.AccountLicenseTypeValues.Express,
+				ValidateFunc: validation.StringInSlice([]string{
+					string(licensing.AccountLicenseTypeValues.None),
+					string(licensing.AccountLicenseTypeValues.Advanced),
+					string(licensing.AccountLicenseTypeValues.EarlyAdopter),
+					string(licensing.AccountLicenseTypeValues.Express),
+					string(licensing.AccountLicenseTypeValues.Professional),
+					string(licensing.AccountLicenseTypeValues.Stakeholder),
+				}, false),
 			},
 			"descriptor": {
 				Type:     schema.TypeString,
@@ -130,15 +136,12 @@ func expandUserEntitlement(d *schema.ResourceData) (*memberentitlementmanagement
 
 	subjectKind := "user"
 
-	accountLicenseType, err := converter.AccountLicenseType(d.Get("account_license_type").(string))
-	if err != nil {
-		return nil, err
-	}
+	accountLicenseType := licensing.AccountLicenseType(d.Get("account_license_type").(string))
 
 	return &memberentitlementmanagement.UserEntitlement{
 
 		AccessLevel: &licensing.AccessLevel{
-			AccountLicenseType: accountLicenseType,
+			AccountLicenseType: &accountLicenseType,
 		},
 
 		// TODO check if it works in both case for GitHub and AzureDevOps

azuredevops/utils/converter/converter.go

@@ -1,11 +1,6 @@
 package converter
 
-import (
-	"fmt"
-	"strings"
-
-	"github.com/microsoft/azure-devops-go-api/azuredevops/licensing"
-)
+import "strings"
 
 // String Get a pointer to a string
 func String(value string) *string {
@@ -47,25 +42,3 @@ func ToBool(value *bool, defaultValue bool) bool {
 
 	return defaultValue
 }
-
-// AccountLicenseType Get a pointer to an AccountLicenseType
-func AccountLicenseType(accountLicenseTypeValue string) (*licensing.AccountLicenseType, error) {
-	var accountLicenseType licensing.AccountLicenseType
-	switch accountLicenseTypeValue {
-	case "none":
-		accountLicenseType = licensing.AccountLicenseTypeValues.None
-	case "earlyAdopter":
-		accountLicenseType = licensing.AccountLicenseTypeValues.EarlyAdopter
-	case "express":
-		accountLicenseType = licensing.AccountLicenseTypeValues.Express
-	case "professional":
-		accountLicenseType = licensing.AccountLicenseTypeValues.Professional
-	case "advanced":
-		accountLicenseType = licensing.AccountLicenseTypeValues.Advanced
-	case "stakeholder":
-		accountLicenseType = licensing.AccountLicenseTypeValues.Stakeholder
-	default:
-		return nil, fmt.Errorf("Error unable to match given AccountLicenseType:%s", accountLicenseTypeValue)
-	}
-	return &accountLicenseType, nil
-}

azuredevops/utils/converter/converter_test.go

@@ -3,11 +3,7 @@
 package converter
 
 import (
-	"fmt"
 	"testing"
-
-	"github.com/microsoft/azure-devops-go-api/azuredevops/licensing"
-	"github.com/stretchr/testify/assert"
 )
 
 func TestString(t *testing.T) {
@@ -41,21 +37,3 @@ func TestBoolFalse(t *testing.T) {
 		t.Errorf("The pointer returned references a different value")
 	}
 }
-
-func TestLicenseTypeAccount(t *testing.T) {
-	assertAccountLicenseType(t, licensing.AccountLicenseTypeValues.None)
-	assertAccountLicenseType(t, licensing.AccountLicenseTypeValues.EarlyAdopter)
-	assertAccountLicenseType(t, licensing.AccountLicenseTypeValues.Advanced)
-	assertAccountLicenseType(t, licensing.AccountLicenseTypeValues.Professional)
-	assertAccountLicenseType(t, licensing.AccountLicenseTypeValues.Express)
-	assertAccountLicenseType(t, licensing.AccountLicenseTypeValues.Professional)
-
-	_, err := AccountLicenseType("foo")
-	assert.Equal(t, err.Error(), "Error unable to match given AccountLicenseType:foo")
-}
-
-func assertAccountLicenseType(t *testing.T, accountLicenseType licensing.AccountLicenseType) {
-	actualAccountLicenseType, err := AccountLicenseType(string(accountLicenseType))
-	assert.Nil(t, err, fmt.Sprintf("Error should not thrown by %s", string(accountLicenseType)))
-	assert.Equal(t, &accountLicenseType, actualAccountLicenseType, fmt.Sprintf("%s should be able to convert into the AccountLicenseType", string(accountLicenseType)))
-}