add bitbucket support (#260)

* add bitbucket support

* add unit tests for repo URL expanding for Github + Bitbucket

* Unit Tests, Service Connection validation

by @nmiodice

* fix validateServiceConnectionIDExistsIfNeeded

Author: jonasbark

azuredevops/resource_build_definition.go

@@ -1,6 +1,7 @@
 package azuredevops
 
 import (
+	"errors"
 	"fmt"
 	"strconv"
 	"strings"
@@ -122,7 +123,7 @@ func resourceBuildDefinition() *schema.Resource {
 						"repo_type": {
 							Type:         schema.TypeString,
 							Required:     true,
-							ValidateFunc: validation.StringInSlice([]string{"GitHub", "TfsGit"}, false),
+							ValidateFunc: validation.StringInSlice([]string{"GitHub", "TfsGit", "Bitbucket"}, false),
 						},
 						"branch_name": {
 							Type:     schema.TypeString,
@@ -250,6 +251,10 @@ func resourceBuildDefinition() *schema.Resource {
 
 func resourceBuildDefinitionCreate(d *schema.ResourceData, m interface{}) error {
 	clients := m.(*config.AggregatedClient)
+	err := validateServiceConnectionIDExistsIfNeeded(d)
+	if err != nil {
+		return err
+	}
 	buildDefinition, projectID, err := expandBuildDefinition(d)
 	if err != nil {
 		return fmt.Errorf("Error creating resource Build Definition: %+v", err)
@@ -346,6 +351,10 @@ func resourceBuildDefinitionDelete(d *schema.ResourceData, m interface{}) error
 
 func resourceBuildDefinitionUpdate(d *schema.ResourceData, m interface{}) error {
 	clients := m.(*config.AggregatedClient)
+	err := validateServiceConnectionIDExistsIfNeeded(d)
+	if err != nil {
+		return err
+	}
 	buildDefinition, projectID, err := expandBuildDefinition(d)
 	if err != nil {
 		return err
@@ -706,6 +715,9 @@ func expandBuildDefinition(d *schema.ResourceData) (*build.BuildDefinition, stri
 	if strings.EqualFold(repoType, "github") {
 		repoURL = fmt.Sprintf("https://github.com/%s.git", repoName)
 	}
+	if strings.EqualFold(repoType, "bitbucket") {
+		repoURL = fmt.Sprintf("https://bitbucket.org/%s.git", repoName)
+	}
 
 	ciTriggers := expandBuildDefinitionTriggerList(
 		d.Get("ci_trigger").([]interface{}),
@@ -763,6 +775,23 @@ func expandBuildDefinition(d *schema.ResourceData) (*build.BuildDefinition, stri
 	return &buildDefinition, projectID, nil
 }
 
+/**
+ * certain types of build definitions require a service connection to run. This function
+ * returns an error if a service connection was needed but not provided
+ */
+func validateServiceConnectionIDExistsIfNeeded(d *schema.ResourceData) error {
+	repositories := d.Get("repository").([]interface{})
+	repository := repositories[0].(map[string]interface{})
+
+	repoType := repository["repo_type"].(string)
+	serviceConnectionID := repository["service_connection_id"].(string)
+
+	if strings.EqualFold(repoType, "bitbucket") && serviceConnectionID == "" {
+		return errors.New("bitbucket repositories need a referenced service connection ID")
+	}
+	return nil
+}
+
 func buildVariableGroup(id int) *build.VariableGroup {
 	return &build.VariableGroup{
 		Id: &id,

azuredevops/resource_build_definition_test.go

@@ -6,6 +6,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"regexp"
 	"sort"
 	"strconv"
 	"testing"
@@ -126,13 +127,47 @@ var testBuildDefinition = build.BuildDefinition{
 	VariableGroups: &[]build.VariableGroup{},
 }
 
+// This definition matches the overall structure of what a configured Bitbucket git repository would
+// look like.
+func testBuildDefinitionBitbucket() build.BuildDefinition {
+	return build.BuildDefinition{
+		Id:       converter.Int(100),
+		Revision: converter.Int(1),
+		Name:     converter.String("Name"),
+		Path:     converter.String("\\"),
+		Repository: &build.BuildRepository{
+			Url:           converter.String("https://bitbucket.com/RepoId.git"),
+			Id:            converter.String("RepoId"),
+			Name:          converter.String("RepoId"),
+			DefaultBranch: converter.String("RepoBranchName"),
+			Type:          converter.String("Bitbucket"),
+			Properties: &map[string]string{
+				"connectedServiceId": "ServiceConnectionID",
+			},
+		},
+		Process: &build.YamlProcess{
+			YamlFilename: converter.String("YamlFilename"),
+		},
+		Queue: &build.AgentPoolQueue{
+			Name: converter.String("BuildPoolName"),
+			Pool: &build.TaskAgentPoolReference{
+				Name: converter.String("BuildPoolName"),
+			},
+		},
+		QueueStatus:    &build.DefinitionQueueStatusValues.Enabled,
+		Type:           &build.DefinitionTypeValues.Build,
+		Quality:        &build.DefinitionQualityValues.Definition,
+		VariableGroups: &[]build.VariableGroup{},
+	}
+}
+
 /**
  * Begin unit tests
  */
 
 // validates that all supported repo types are allowed by the schema
 func TestAzureDevOpsBuildDefinition_RepoTypeListIsCorrect(t *testing.T) {
-	expectedRepoTypes := []string{"GitHub", "TfsGit"}
+	expectedRepoTypes := []string{"GitHub", "TfsGit", "Bitbucket"}
 	repoSchema := resourceBuildDefinition().Schema["repository"]
 	repoTypeSchema := repoSchema.Elem.(*schema.Resource).Schema["repo_type"]
 
@@ -160,6 +195,50 @@ func TestAzureDevOpsBuildDefinition_PathInvalidStartingSlashIsError(t *testing.T
 	require.Equal(t, "path must start with backslash", errors[0].Error())
 }
 
+// verifies that GitHub repo urls are expanded to URLs Azure DevOps expects
+func TestAzureDevOpsBuildDefinition_Expand_RepoUrl_Github(t *testing.T) {
+	resourceData := schema.TestResourceDataRaw(t, resourceBuildDefinition().Schema, nil)
+	flattenBuildDefinition(resourceData, &testBuildDefinition, testProjectID)
+	buildDefinitionAfterRoundTrip, projectID, err := expandBuildDefinition(resourceData)
+
+	require.Nil(t, err)
+	require.Equal(t, *buildDefinitionAfterRoundTrip.Repository.Url, "https://github.com/RepoId.git")
+	require.Equal(t, testProjectID, projectID)
+}
+
+// verifies that Bitbucket repo urls are expanded to URLs Azure DevOps expects
+func TestAzureDevOpsBuildDefinition_Expand_RepoUrl_Bitbucket(t *testing.T) {
+	resourceData := schema.TestResourceDataRaw(t, resourceBuildDefinition().Schema, nil)
+	bitBucketBuildDef := testBuildDefinitionBitbucket()
+	flattenBuildDefinition(resourceData, &bitBucketBuildDef, testProjectID)
+	buildDefinitionAfterRoundTrip, projectID, err := expandBuildDefinition(resourceData)
+
+	require.Nil(t, err)
+	require.Equal(t, *buildDefinitionAfterRoundTrip.Repository.Url, "https://bitbucket.org/RepoId.git")
+	require.Equal(t, testProjectID, projectID)
+}
+
+// verifies that a service connection is required for bitbucket repos
+func TestAzureDevOpsBuildDefinition_ValidatesServiceConnection_Bitbucket(t *testing.T) {
+	resourceData := schema.TestResourceDataRaw(t, resourceBuildDefinition().Schema, nil)
+	bitBucketBuildDef := testBuildDefinitionBitbucket()
+	(*bitBucketBuildDef.Repository.Properties)["connectedServiceId"] = ""
+	flattenBuildDefinition(resourceData, &bitBucketBuildDef, testProjectID)
+
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+	buildClient := azdosdkmocks.NewMockBuildClient(ctrl)
+	clients := &config.AggregatedClient{BuildClient: buildClient, Ctx: context.Background()}
+
+	err := resourceBuildDefinitionCreate(resourceData, clients)
+	require.NotNil(t, err)
+	require.Contains(t, err.Error(), "bitbucket repositories need a referenced service connection ID")
+
+	err = resourceBuildDefinitionUpdate(resourceData, clients)
+	require.NotNil(t, err)
+	require.Contains(t, err.Error(), "bitbucket repositories need a referenced service connection ID")
+}
+
 // verifies that the flatten/expand round trip yields the same build definition
 func TestAzureDevOpsBuildDefinition_ExpandFlatten_Roundtrip(t *testing.T) {
 	resourceData := schema.TestResourceDataRaw(t, resourceBuildDefinition().Schema, nil)
@@ -281,7 +360,7 @@ func TestAzureDevOpsBuildDefinition_Update_DoesNotSwallowError(t *testing.T) {
 
 // validates that an apply followed by another apply (i.e., resource update) will be reflected in AzDO and the
 // underlying terraform state.
-func TestAccAzureDevOpsBuildDefinition_CreateAndUpdate(t *testing.T) {
+func TestAccAzureDevOpsBuildDefinition_Create_Update_Import(t *testing.T) {
 	projectName := testhelper.TestAccResourcePrefix + acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum)
 	buildDefinitionPathEmpty := `\`
 	buildDefinitionNameFirst := testhelper.TestAccResourcePrefix + acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum)
@@ -300,7 +379,7 @@ func TestAccAzureDevOpsBuildDefinition_CreateAndUpdate(t *testing.T) {
 		CheckDestroy: testAccBuildDefinitionCheckDestroy,
 		Steps: []resource.TestStep{
 			{
-				Config: testhelper.TestAccBuildDefinitionResource(projectName, buildDefinitionNameFirst, buildDefinitionPathEmpty),
+				Config: testhelper.TestAccBuildDefinitionResourceGitHub(projectName, buildDefinitionNameFirst, buildDefinitionPathEmpty),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckBuildDefinitionResourceExists(buildDefinitionNameFirst),
 					resource.TestCheckResourceAttrSet(tfBuildDefNode, "project_id"),
@@ -309,7 +388,7 @@ func TestAccAzureDevOpsBuildDefinition_CreateAndUpdate(t *testing.T) {
 					resource.TestCheckResourceAttr(tfBuildDefNode, "path", buildDefinitionPathEmpty),
 				),
 			}, {
-				Config: testhelper.TestAccBuildDefinitionResource(projectName, buildDefinitionNameSecond, buildDefinitionPathEmpty),
+				Config: testhelper.TestAccBuildDefinitionResourceGitHub(projectName, buildDefinitionNameSecond, buildDefinitionPathEmpty),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckBuildDefinitionResourceExists(buildDefinitionNameSecond),
 					resource.TestCheckResourceAttrSet(tfBuildDefNode, "project_id"),
@@ -318,7 +397,7 @@ func TestAccAzureDevOpsBuildDefinition_CreateAndUpdate(t *testing.T) {
 					resource.TestCheckResourceAttr(tfBuildDefNode, "path", buildDefinitionPathEmpty),
 				),
 			}, {
-				Config: testhelper.TestAccBuildDefinitionResource(projectName, buildDefinitionNameFirst, buildDefinitionPathFirst),
+				Config: testhelper.TestAccBuildDefinitionResourceGitHub(projectName, buildDefinitionNameFirst, buildDefinitionPathFirst),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckBuildDefinitionResourceExists(buildDefinitionNameFirst),
 					resource.TestCheckResourceAttrSet(tfBuildDefNode, "project_id"),
@@ -327,7 +406,7 @@ func TestAccAzureDevOpsBuildDefinition_CreateAndUpdate(t *testing.T) {
 					resource.TestCheckResourceAttr(tfBuildDefNode, "path", buildDefinitionPathFirst),
 				),
 			}, {
-				Config: testhelper.TestAccBuildDefinitionResource(projectName, buildDefinitionNameFirst,
+				Config: testhelper.TestAccBuildDefinitionResourceGitHub(projectName, buildDefinitionNameFirst,
 					buildDefinitionPathSecond),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckBuildDefinitionResourceExists(buildDefinitionNameFirst),
@@ -337,7 +416,7 @@ func TestAccAzureDevOpsBuildDefinition_CreateAndUpdate(t *testing.T) {
 					resource.TestCheckResourceAttr(tfBuildDefNode, "path", buildDefinitionPathSecond),
 				),
 			}, {
-				Config: testhelper.TestAccBuildDefinitionResource(projectName, buildDefinitionNameFirst, buildDefinitionPathThird),
+				Config: testhelper.TestAccBuildDefinitionResourceGitHub(projectName, buildDefinitionNameFirst, buildDefinitionPathThird),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckBuildDefinitionResourceExists(buildDefinitionNameFirst),
 					resource.TestCheckResourceAttrSet(tfBuildDefNode, "project_id"),
@@ -346,7 +425,7 @@ func TestAccAzureDevOpsBuildDefinition_CreateAndUpdate(t *testing.T) {
 					resource.TestCheckResourceAttr(tfBuildDefNode, "path", buildDefinitionPathThird),
 				),
 			}, {
-				Config: testhelper.TestAccBuildDefinitionResource(projectName, buildDefinitionNameFirst, buildDefinitionPathFourth),
+				Config: testhelper.TestAccBuildDefinitionResourceGitHub(projectName, buildDefinitionNameFirst, buildDefinitionPathFourth),
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckBuildDefinitionResourceExists(buildDefinitionNameFirst),
 					resource.TestCheckResourceAttrSet(tfBuildDefNode, "project_id"),
@@ -365,6 +444,25 @@ func TestAccAzureDevOpsBuildDefinition_CreateAndUpdate(t *testing.T) {
 	})
 }
 
+// Verifies a build for Bitbucket can happen. Note: the update/import logic is tested in other tests
+func TestAccAzureDevOpsBuildDefinitionBitbucket_Create(t *testing.T) {
+	projectName := testhelper.TestAccResourcePrefix + acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum)
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testhelper.TestAccPreCheck(t, nil) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccBuildDefinitionCheckDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config:      testhelper.TestAccBuildDefinitionResourceBitbucket(projectName, "build-def-name", "\\", ""),
+				ExpectError: regexp.MustCompile("bitbucket repositories need a referenced service connection ID"),
+			}, {
+				Config: testhelper.TestAccBuildDefinitionResourceBitbucket(projectName, "build-def-name", "\\", "some-service-connection"),
+				Check:  testAccCheckBuildDefinitionResourceExists("build-def-name"),
+			},
+		},
+	})
+}
+
 // Given the name of an AzDO build definition, this will return a function that will check whether
 // or not the definition (1) exists in the state and (2) exist in AzDO and (3) has the correct name
 func testAccCheckBuildDefinitionResourceExists(expectedName string) resource.TestCheckFunc {

azuredevops/utils/testhelper/hcl.go

@@ -173,22 +173,61 @@ resource "azuredevops_agent_pool" "pool" {
 	}`, poolName)
 }
 
+// TestAccBuildDefinitionResourceGitHub HCL describing an AzDO build definition sourced from GitHub
+func TestAccBuildDefinitionResourceGitHub(projectName string, buildDefinitionName string, buildPath string) string {
+	return TestAccBuildDefinitionResource(
+		projectName,
+		buildDefinitionName,
+		buildPath,
+		"GitHub",
+		"repoOrg/repoName",
+		"master",
+		"path/to/yaml",
+		"")
+}
+
+// TestAccBuildDefinitionResourceBitbucket HCL describing an AzDO build definition sourced from Bitbucket
+func TestAccBuildDefinitionResourceBitbucket(projectName string, buildDefinitionName string, buildPath string, serviceConnectionID string) string {
+	return TestAccBuildDefinitionResource(
+		projectName,
+		buildDefinitionName,
+		buildPath,
+		"Bitbucket",
+		"repoOrg/repoName",
+		"master",
+		"path/to/yaml",
+		serviceConnectionID)
+}
+
 // TestAccBuildDefinitionResource HCL describing an AzDO build definition
-func TestAccBuildDefinitionResource(projectName string, buildDefinitionName string, buildPath string) string {
+func TestAccBuildDefinitionResource(
+	projectName string,
+	buildDefinitionName string,
+	buildPath string,
+	repoType string,
+	repoName string,
+	branchName string,
+	yamlPath string,
+	serviceConnectionID string,
+) string {
+	repositoryBlock := fmt.Sprintf(`
+repository {
+	repo_type             = "%s"
+	repo_name             = "%s"
+	branch_name           = "%s"
+	yml_path              = "%s"
+	service_connection_id = "%s"
+}`, repoType, repoName, branchName, yamlPath, serviceConnectionID)
+
 	buildDefinitionResource := fmt.Sprintf(`
 resource "azuredevops_build_definition" "build" {
 	project_id      = azuredevops_project.project.id
 	name            = "%s"
 	agent_pool_name = "Hosted Ubuntu 1604"
 	path			= "%s"
 
-	repository {
-	  repo_type             = "GitHub"
-	  repo_name             = "repoOrg/repoName"
-	  branch_name           = "branch"
-	  yml_path              = "path/to/yaml"
-	}
-}`, buildDefinitionName, strings.ReplaceAll(buildPath, `\`, `\\`))
+	%s
+}`, buildDefinitionName, strings.ReplaceAll(buildPath, `\`, `\\`), repositoryBlock)
 
 	projectResource := TestAccProjectResource(projectName)
 	return fmt.Sprintf("%s\n%s", projectResource, buildDefinitionResource)

website/docs/r/build_definition.html.markdown

@@ -39,6 +39,18 @@ resource "azuredevops_git_repository" "repository" {
   }
 }
 
+resource "azuredevops_variable_group" "vars" {
+  project_id   = local.project_id
+  name         = "Infrastructure Pipeline Variables"
+  description  = "Managed by Terraform"
+  allow_access = true
+
+  variable {
+    name  = "FOO"
+    value = "BAR"
+  }
+}
+
 resource "azuredevops_build_definition" "build" {
   project_id = azuredevops_project.project.id
   name       = "Sample Build Definition"
@@ -63,9 +75,9 @@ resource "azuredevops_build_definition" "build" {
     yml_path    = "azure-pipelines.yml"
   }
 
-  # Until https://github.com/microsoft/terraform-provider-azuredevops/issues/170, these are assumed
-  # to already exist in the project.
-  variables_groups = [1, 2, 3]
+  variable_groups = [
+    azuredevops_variable_group.vars.id
+  ]
 }
 ```
 
@@ -85,7 +97,7 @@ The following arguments are supported:
 
 * `branch_name` - (Optional) The branch name for which builds are triggered. Defaults to `master`.
 * `repo_name` - (Required) The name of the repository.
-* `repo_type` - (Optional) The repository type. Valid values: `GitHub` or `TfsGit`. Defaults to `Github`.
+* `repo_type` - (Optional) The repository type. Valid values: `GitHub` or `TfsGit` or `Bitbucket`. Defaults to `Github`.
 * `service_connection_id` - (Optional) The service connection ID. Used if the `repo_type` is `GitHub`.
 * `yml_path` - (Required) The path of the Yaml file describing the build definition.