Added a test of the git username and password settings

Author: mcasperson

cmd/octoterra_test.go

@@ -3326,3 +3326,59 @@ func TestSingleProjectGroupExport(t *testing.T) {
 		return nil
 	})
 }
+
+// TestProjectWithGitUsernameExport verifies that a project can be reimported with the correct git settings
+func TestProjectWithGitUsernameExport(t *testing.T) {
+	performTest(t, func(t *testing.T, container *octopusContainer) error {
+		// Arrange
+		newSpaceId, err := arrange(t, container, "../test/terraform/39-projectgitusername", []string{
+			"-var=project_git_password=" + os.Getenv("GIT_CREDENTIAL"),
+		})
+
+		if err != nil {
+			return err
+		}
+
+		// Act
+		recreatedSpaceId, err := act(t, container, newSpaceId, []string{
+			"-var=project_test_git_password=" + os.Getenv("GIT_CREDENTIAL"),
+			"-var=project_test_git_base_path=.octopus/projectgitusername",
+		})
+
+		if err != nil {
+			return err
+		}
+
+		// Assert
+		octopusClient := createClient(container, recreatedSpaceId)
+
+		collection := octopus.GeneralCollection[octopus.Project]{}
+		err = octopusClient.GetAllResources("Projects", &collection)
+
+		if err != nil {
+			return err
+		}
+
+		resourceName := "Test"
+		found := false
+		for _, v := range collection.Items {
+			if v.Name == resourceName {
+				found = true
+
+				if v.PersistenceSettings.Credentials.Type != "UsernamePassword" {
+					t.Fatal("The project must be have a git credential type of \"UsernamePassword\" (was \"" + v.PersistenceSettings.Credentials.Type + "\")")
+				}
+
+				if v.PersistenceSettings.Credentials.Username != "mcasperson" {
+					t.Fatal("The project must be have a git username of \"mcasperson\" (was \"" + v.PersistenceSettings.Credentials.Username + "\")")
+				}
+			}
+		}
+
+		if !found {
+			t.Fatal("Space must have an project called \"" + resourceName + "\"")
+		}
+
+		return nil
+	})
+}

internal/converters/project_converter.go

@@ -208,9 +208,9 @@ func (c ProjectConverter) convertUsernamePasswordGitPersistence(project octopus.
 
 	return &terraform.TerraformGitUsernamePasswordPersistenceSettings{
 		Url:               project.PersistenceSettings.Url,
-		Username:          "${var." + projectName + "_git_base_path}",
+		Username:          project.PersistenceSettings.Credentials.Username,
 		Password:          "${var." + projectName + "_git_password}",
-		BasePath:          project.PersistenceSettings.BasePath,
+		BasePath:          "${var." + projectName + "_git_base_path}",
 		DefaultBranch:     project.PersistenceSettings.DefaultBranch,
 		ProtectedBranches: project.PersistenceSettings.ProtectedBranchNamePatterns,
 	}

test/terraform/39-projectgitusername/space_creation/config.tf

@@ -0,0 +1,5 @@
+terraform {
+  required_providers {
+    octopusdeploy = { source = "OctopusDeployLabs/octopusdeploy", version = "0.10.1" }
+  }
+}

test/terraform/39-projectgitusername/space_creation/provider.tf

@@ -0,0 +1,4 @@
+provider "octopusdeploy" {
+  address = "${var.octopus_server}"
+  api_key = "${var.octopus_apikey}"
+}

test/terraform/39-projectgitusername/space_creation/provider_vars.tf

@@ -0,0 +1,18 @@
+variable "octopus_server" {
+  type        = string
+  nullable    = false
+  sensitive   = false
+  description = "The URL of the Octopus server e.g. https://myinstance.octopus.app."
+}
+variable "octopus_apikey" {
+  type        = string
+  nullable    = false
+  sensitive   = true
+  description = "The API key used to access the Octopus server. See https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key for details on creating an API key."
+}
+variable "octopus_space_id" {
+  type        = string
+  nullable    = false
+  sensitive   = false
+  description = "The space ID to populate"
+}

test/terraform/39-projectgitusername/space_creation/space.tf

@@ -0,0 +1,19 @@
+resource "octopusdeploy_space" "octopus_space_test" {
+  name                  = "${var.octopus_space_name}"
+  is_default            = false
+  is_task_queue_stopped = false
+  description           = "My test space"
+  space_managers_teams  = ["teams-administrators"]
+}
+
+output "octopus_space_id" {
+  value = octopusdeploy_space.octopus_space_test.id
+}
+
+variable "octopus_space_name" {
+  type        = string
+  nullable    = false
+  sensitive   = false
+  description = "The name of the new space"
+  default     = "Test"
+}

test/terraform/39-projectgitusername/space_population/config.tf

@@ -0,0 +1,5 @@
+terraform {
+  required_providers {
+    octopusdeploy = { source = "OctopusDeployLabs/octopusdeploy", version = "0.10.1" }
+  }
+}

test/terraform/39-projectgitusername/space_population/project.tf

@@ -0,0 +1,49 @@
+data "octopusdeploy_lifecycles" "lifecycle_default_lifecycle" {
+  ids          = null
+  partial_name = "Default Lifecycle"
+  skip         = 0
+  take         = 1
+}
+
+
+resource "octopusdeploy_project" "deploy_frontend_project" {
+  auto_create_release                  = false
+  default_guided_failure_mode          = "EnvironmentDefault"
+  default_to_skip_if_already_installed = false
+  description                          = "Test project"
+  discrete_channel_release             = false
+  is_disabled                          = false
+  is_discrete_channel_release          = false
+  is_version_controlled                = false
+  lifecycle_id                         = data.octopusdeploy_lifecycles.lifecycle_default_lifecycle.lifecycles[0].id
+  name                                 = "Test"
+  project_group_id                     = octopusdeploy_project_group.project_group_test.id
+  tenanted_deployment_participation    = "Untenanted"
+  space_id                             = var.octopus_space_id
+  included_library_variable_sets       = []
+  versioning_strategy {
+    template = "#{Octopus.Version.LastMajor}.#{Octopus.Version.LastMinor}.#{Octopus.Version.LastPatch}.#{Octopus.Version.NextRevision}"
+  }
+
+  connectivity_policy {
+    allow_deployments_to_no_targets = false
+    exclude_unhealthy_targets       = false
+    skip_machine_behavior           = "SkipUnavailableMachines"
+  }
+
+  git_username_password_persistence_settings {
+    url                = "https://github.com/mcasperson/octogittest.git"
+    username           = "mcasperson"
+    password           = "${var.project_git_password}"
+    base_path          = ".octopus/projectest"
+    default_branch     = "main"
+    protected_branches = []
+  }
+}
+
+variable "project_git_password" {
+  type        = string
+  nullable    = false
+  sensitive   = true
+  description = "The git password for the project"
+}

test/terraform/39-projectgitusername/space_population/project_group_test.tf

@@ -0,0 +1,4 @@
+resource "octopusdeploy_project_group" "project_group_test" {
+  name        = "Test"
+  description = "Test Description"
+}

test/terraform/39-projectgitusername/space_population/provider.tf

@@ -0,0 +1,5 @@
+provider "octopusdeploy" {
+  address  = "${var.octopus_server}"
+  api_key  = "${var.octopus_apikey}"
+  space_id = "${var.octopus_space_id}"
+}