feat: deployment freezes #822

benPearce1 · 2024-11-21T06:54:10Z

Note: for some reason running tfplugindocs resulted in an update to remove some whitespace from most of the docs files.

Source

resource "octopusdeploy_deployment_freeze" "freeze" {
  name = "Xmas"
  start = "2024-12-25T00:00:00+10:00"
  end = "2024-12-27T00:00:00+08:00"
}

resource "octopusdeploy_deployment_freeze_project" "project_freeze" {
  deploymentfreeze_id= octopusdeploy_deployment_freeze.freeze.id
  project_id = resource.octopusdeploy_project.project1.id
  environment_ids = [resource.octopusdeploy_environment.dev.id, resource.octopusdeploy_environment.test.id]
}

resource "octopusdeploy_deployment_freeze_project" "project_freeze_2" {
  deploymentfreeze_id= octopusdeploy_deployment_freeze.freeze.id
  project_id = data.octopusdeploy_projects.second_project.projects[0].id
  environment_ids = [ data.octopusdeploy_environments.default_environment.environments[0].id ]
 }

Create

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # octopusdeploy_deployment_freeze.freeze will be created
  + resource "octopusdeploy_deployment_freeze" "freeze" {
      + end   = "2024-12-27T00:00:00+08:00"
      + id    = (known after apply)
      + name  = "Xmas"
      + start = "2024-12-25T00:00:00+10:00"
    }

  # octopusdeploy_deployment_freeze_project.project_freeze will be created
  + resource "octopusdeploy_deployment_freeze_project" "project_freeze" {
      + deploymentfreeze_id = (known after apply)
      + environment_ids     = [
          + "Environments-1561",
          + "Environments-1562",
        ]
      + id                  = (known after apply)
      + project_id          = "Projects-3161"
    }

  # octopusdeploy_deployment_freeze_project.project_freeze_2 will be created
  + resource "octopusdeploy_deployment_freeze_project" "project_freeze_2" {
      + deploymentfreeze_id = (known after apply)
      + environment_ids     = [
          + "Environments-223",
        ]
      + id                  = (known after apply)
      + project_id          = "Projects-2713"
    }

Plan: 3 to add, 0 to change, 0 to destroy.
octopusdeploy_deployment_freeze.freeze: Creating...
octopusdeploy_deployment_freeze.freeze: Creation complete after 0s [id=DeploymentFreezes-262]
octopusdeploy_deployment_freeze_project.project_freeze_2: Creating...
octopusdeploy_deployment_freeze_project.project_freeze: Creating...
octopusdeploy_deployment_freeze_project.project_freeze: Creation complete after 0s [id=DeploymentFreezes-262:Projects-3161]
octopusdeploy_deployment_freeze_project.project_freeze_2: Creation complete after 0s [id=DeploymentFreezes-262:Projects-2713]

Update

end = "2024-12-27T00:00:00+10:00"

Terraform will perform the following actions:

  # octopusdeploy_deployment_freeze.freeze will be updated in-place
  ~ resource "octopusdeploy_deployment_freeze" "freeze" {
      ~ end                       = "2024-12-26T16:00:00Z" -> "2024-12-27T00:00:00+10:00"
        id                        = "DeploymentFreezes-113"
        name                      = "Xmas"
      ~ start                     = "2024-12-24T16:00:00Z" -> "2024-12-25T00:00:00+08:00"
        # (1 unchanged attribute hidden)
    }

Plan: 0 to add, 1 to change, 0 to destroy.
octopusdeploy_deployment_freeze.freeze: Modifying... [id=DeploymentFreezes-113]
octopusdeploy_deployment_freeze.freeze: Modifications complete after 1s [id=DeploymentFreezes-113]

Destroy

Terraform will perform the following actions:

  # octopusdeploy_deployment_freeze.freeze will be destroyed
  # (because octopusdeploy_deployment_freeze.freeze is not in configuration)
  - resource "octopusdeploy_deployment_freeze" "freeze" {
      - end                       = "2024-12-27T00:00:00+10:00" -> null
      - id                        = "DeploymentFreezes-113" -> null
      - name                      = "Xmas" -> null
      - project_environment_scope = {
          - "Projects-2713" = [
              - "Environments-223",
            ]
          - "Projects-3084" = [
              - "Environments-1506",
              - "Environments-1507",
            ]
        } -> null
      - start                     = "2024-12-25T00:00:00+08:00" -> null
    }

Plan: 0 to add, 0 to change, 1 to destroy.
octopusdeploy_deployment_freeze.freeze: Destroying... [id=DeploymentFreezes-113]
octopusdeploy_deployment_freeze.freeze: Destruction complete after 0s

Apply complete! Resources: 0 added, 0 changed, 1 destroyed.

Datasource

data "octopusdeploy_deployment_freezes" "all_freezes" {
  skip = 0
  take = 10
  partial_name = "empty"
}

output "all_freezes" {
  value = data.octopusdeploy_deployment_freezes.all_freezes
}

Output:

all_freezes = {
  "deployment_freezes" = tolist([
    {
      "end" = "2024-11-25T04:45:53Z"
      "id" = "DeploymentFreezes-163"
      "name" = "empty via ui"
      "project_environment_scope" = tomap({
        "Projects-2716" = tolist([
          "Environments-1176",
        ])
      })
      "start" = "2024-11-25T04:15:53Z"
    },
    {
      "end" = "2025-11-15T22:42:09+10:00"
      "id" = "DeploymentFreezes-181"
      "name" = "empty"
      "project_environment_scope" = tomap({})
      "start" = "2025-11-05T10:12:09+10:00"
    },
    {
      "end" = "2025-11-15T22:42:09+10:00"
      "id" = "DeploymentFreezes-201"
      "name" = "empty2"
      "project_environment_scope" = tomap({})
      "start" = "2025-11-05T10:12:09+10:00"
    },
  ])
  "environment_ids" = tolist(null) /* of string */
  "id" = "Deployment Freezes 2024-11-28 07:20:05.291351 +0000 UTC"
  "ids" = tolist(null) /* of string */
  "include_complete" = tobool(null)
  "partial_name" = "empty"
  "project_ids" = tolist(null) /* of string */
  "skip" = 0
  "status" = tostring(null)
  "take" = 10
}

benPearce1 · 2024-11-21T06:55:10Z

internal/errors/error.go

@@ -32,20 +32,20 @@ func ProcessApiError(ctx context.Context, d *schema.ResourceData, err error, res
 	return diag.FromErr(err)
 }

-func DeleteFromStateV2(ctx context.Context, resp *resource.ReadResponse, resource schemas.IResourceModel, resourceDescription string) error {
+func DeleteFromStateV2(ctx context.Context, state *tfsdk.State, resource schemas.IResourceModel, resourceDescription string) error {


the changes in this file allow this functionality to be used in the delete and read functions
this also accounts for the majority of small changes

benPearce1 · 2024-11-21T07:07:07Z

octopusdeploy_framework/resource_deploymentfreeze.go

+	if useSourceForDates {
+		state.Start = types.StringValue(deploymentFreeze.Start.Format(time.RFC3339))
+		state.End = types.StringValue(deploymentFreeze.End.Format(time.RFC3339))
+	}


if the time contains a timezone the value for the times are returned with a server local timezone, for create and update operations we just store the value provided in the plan, for a refresh (read) operation it will store the value from the api as it may have been changed.

benPearce1 · 2024-11-21T07:09:40Z

octopusdeploy_framework/schemas/schema.go

@@ -432,3 +433,14 @@ func GetSensitiveResourceSchema(description string, isRequired bool) resourceSch

 	return s
 }
+
+func GetDateTimeResourceSchema(description string, isRequired bool) resourceSchema.Attribute {
+	regex := "^((?:(\\d{4}-\\d{2}-\\d{2})T(\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?))(?:Z|[\\+-]\\d{2}:\\d{2})?)"


this is the RFC3339 specification
https://regex101.com/r/qH0sU7/1

benPearce1 · 2024-11-21T07:11:37Z

octopusdeploy_framework/resource_project_flatten.go

-func convertMapStringToMapAttrValue(m map[string]string) map[string]attr.Value {
-	result := make(map[string]attr.Value, len(m))
-	for k, v := range m {
-		result[k] = types.StringValue(v)
-	}
-	return result
-}


This was moved to util.go

domenicsim1

Some questions about the error handling. Did we mean to fall through the error conditions?

Also please add and addition step to the test so we cover update.

domenicsim1 · 2024-11-24T22:22:12Z

octopusdeploy_framework/resource_deploymentfreeze.go

+
+	updatedFreeze, err = deploymentfreezes.Update(f.Config.Client, updatedFreeze)
+	if err != nil {
+		resp.Diagnostics.AddError("error while updating deployment freeze", err.Error())


missing return?

domenicsim1 · 2024-11-24T22:22:34Z

octopusdeploy_framework/resource_deploymentfreeze.go

+
+	updatedFreeze, err := mapFromState(plan)
+	if err != nil {
+		resp.Diagnostics.AddError("error while mapping deployment freeze", err.Error())


missing return?

domenicsim1 · 2024-11-24T22:23:21Z

octopusdeploy_framework/resource_deploymentfreeze.go

+
+	err = deploymentfreezes.Delete(f.Config.Client, freeze)
+	if err != nil {
+		resp.Diagnostics.AddError("unable to delete deployment freeze", err.Error())


domenicsim1 · 2024-11-24T22:24:28Z

octopusdeploy_framework/resource_deploymentfreeze_test.go

+					resource.TestCheckResourceAttr(resourceName, "start", start),
+					resource.TestCheckResourceAttr(resourceName, "end", end)),
+				Config: testDeploymentFreezeBasic(localName, name, start, end, spaceName, environmentName, projectName, projectGroupName, lifecycleName),
+			},


please add one more step so we can also test update.

… deployment freeze datasource

benPearce1 · 2024-11-28T07:22:26Z

octopusdeploy_framework/resource_tenant_project.go

 	}

-	plan.ID = types.StringValue(schemas.BuildTenantProjectID(spaceId, plan.TenantID.ValueString(), plan.ProjectID.ValueString()))
+	plan.ID = types.StringValue(util.BuildCompositeId(spaceId, plan.TenantID.ValueString(), plan.ProjectID.ValueString()))


moved to shared function

benPearce1 · 2024-11-28T07:22:32Z

octopusdeploy_framework/resource_tenant_project.go

@@ -83,7 +82,7 @@ func (t *tenantProjectResource) Read(ctx context.Context, req resource.ReadReque
 		return
 	}

-	bits := strings.Split(data.ID.ValueString(), ":")
+	bits := util.SplitCompositeId(data.ID.ValueString())


moved to shared function

domenicsim1

Looks good, left some comments

octopusdeploy_framework/resource_deployment_freeze_project.go

domenicsim1 · 2024-11-28T23:25:59Z

octopusdeploy_framework/resource_deployment_freeze_test.go

+					resource.TestCheckResourceAttr(resourceName, "end", end)),
+				Config: testDeploymentFreezeBasic(localName, name, start, end, spaceName, []string{environmentName1}, projectName, projectGroupName, lifecycleName),
+			},
+		},


Would appreciate if we run a 2nd step with an updated config so we can test the update function for the resource

I put in an update as a second resource.Test block. I will move it into the same set and make the update do more changes

…e' into bp/deployment-freeze

benPearce1 added 6 commits November 20, 2024 12:12

wip

cf62bb2

fixed casing on project scope

fb919c6

refactored state cleanup to support all functions

1ce7c08

added date time schema

63c094b

fixes for deployment freeze resources

9b1ee2f

store the supplied times in state for create and updated

879becd

benPearce1 commented Nov 21, 2024

View reviewed changes

benPearce1 requested review from hnrkndrssn, IsaacCalligeros95, HuyPhanNguyen and grace-rehn November 21, 2024 07:16

benPearce1 marked this pull request as draft November 21, 2024 07:17

benPearce1 added 4 commits November 22, 2024 10:06

updated client library

84b7fe4

Merge branch 'main' into bp/deployment-freeze

a67a0b6

update following merge

b2eb8d6

reverted incorrect change to missing resource handling

c761241

benPearce1 marked this pull request as ready for review November 22, 2024 00:29

domenicsim1 reviewed Nov 24, 2024

View reviewed changes

benPearce1 added 9 commits November 25, 2024 09:54

added update test to project freeze

1aa7b68

refresh docs

e9da4d6

extracted deployment freeze project scope out to separate resource

9b70c40

updated go-octopusdeploy reference

7660848

updated examples

c22a0c0

updated build composite id to take params

70f2a6b

split deployment freeze project scopes to separate resource and added…

f4ac55b

… deployment freeze datasource

updated go-octopusdeploy reference

96dc497

update go.sum

e31e4f4

updated docs

efd1d83

benPearce1 commented Nov 28, 2024

View reviewed changes

benPearce1 requested a review from domenicsim1 November 28, 2024 07:23

missed return statement

9e504eb

domenicsim1 reviewed Nov 28, 2024

View reviewed changes

benPearce1 and others added 8 commits November 29, 2024 09:37

missed return statement

b834bc4

updated test to perform update

91da299

Merge branch 'main' into bp/deployment-freeze

268cf29

fixed up imports

a82d9d7

chore: fix docs

dfc11c4

fixed formatting string

872fc77

Merge remote-tracking branch 'refs/remotes/origin/bp/deployment-freez…

7deb89d

…e' into bp/deployment-freeze

deleted tests for testing build issue

0b61d02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: deployment freezes #822

feat: deployment freezes #822

benPearce1 commented Nov 21, 2024 •

edited

Loading

benPearce1 Nov 21, 2024 •

edited

Loading

benPearce1 Nov 21, 2024

benPearce1 Nov 21, 2024

benPearce1 Nov 21, 2024

domenicsim1 left a comment

domenicsim1 Nov 24, 2024

domenicsim1 Nov 24, 2024

domenicsim1 Nov 24, 2024

domenicsim1 Nov 24, 2024

benPearce1 Nov 28, 2024

benPearce1 Nov 28, 2024

domenicsim1 left a comment

domenicsim1 Nov 28, 2024

benPearce1 Nov 28, 2024

feat: deployment freezes #822

Are you sure you want to change the base?

feat: deployment freezes #822

Conversation

benPearce1 commented Nov 21, 2024 • edited Loading

Create

Update

Destroy

Datasource

benPearce1 Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domenicsim1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domenicsim1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benPearce1 commented Nov 21, 2024 •

edited

Loading

benPearce1 Nov 21, 2024 •

edited

Loading