feat: Add support for project deployment freezes (#27)

* chore: move function to a shared place

* feat: add project deployment freeze resource

* chore(docs): add example usages of project deployment freezes

* chore(docs): update docs

* fix: project environment scopes should not be preserved as they live on the freeze resource now

* fix: add support for specifying users utc offset on recurring schedule

* chore(docs): update docs

* chore: add back moved functions

Author: hnrkndrssn

docs/resources/project_deployment_freeze.md

@@ -0,0 +1,117 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "octopusdeploy_project_deployment_freeze Resource - terraform-provider-octopusdeploy"
+subcategory: ""
+description: |-
+  
+---
+
+# octopusdeploy_project_deployment_freeze (Resource)
+
+
+
+## Example Usage
+
+```terraform
+# basic freeze with no environment scopes
+resource "octopusdeploy_project_deployment_freeze" "freeze" {
+  owner_id = "Projects-123"
+  name = "Xmas"
+  start = "2024-12-25T00:00:00+10:00"
+  end = "2024-12-27T00:00:00+08:00"
+}
+
+# Freeze with different timezones and single environment scope
+resource "octopusdeploy_deployment_freeze" "freeze" {
+  owner_id = "Projects-123"
+  name = "Xmas"
+  start = "2024-12-25T00:00:00+10:00"
+  end = "2024-12-27T00:00:00+08:00"
+  environment_ids = ["Environments-123"]
+}
+
+# Freeze recurring freeze yearly on Xmas
+resource "octopusdeploy_deployment_freeze" "freeze" {
+  owner_id = "Projects-123"
+  name = "Xmas"
+  start = "2024-12-25T00:00:00+10:00"
+  end = "2024-12-27T00:00:00+08:00"
+  recurring_schedule = {
+    type    = "Annually"
+    unit    = 1
+    end_type = "Never"
+  }
+}
+
+resource "octopusdeploy_deployment_freeze_project" "project_freeze" {
+  deploymentfreeze_id= octopusdeploy_deployment_freeze.freeze.id
+  project_id = "Projects-123"
+  environment_ids = [ "Environments-123", "Environments-456" ]
+}
+
+# Freeze with ids sourced from resources.
+resource "octopusdeploy_deployment_freeze" "freeze" {
+  owner_id = resource.octopusdeploy_project.project1.id
+  name = "End of financial year shutdown"
+  start = "2025-06-30T00:00:00+10:00"
+  end = "2025-07-02T00:00:00+10:00"
+  environment_ids = [resource.octopusdeploy_environment.production.id]
+}
+
+# Freeze with tenant environment scope and ids sourced from datasources.
+resource "octopusdeploy_deployment_freeze" "freeze" {
+  owner_id = data.octopusdeploy_project.project1.id
+  name = "End of financial year shutdown"
+  start = "2025-06-30T00:00:00+10:00"
+  end = "2025-07-02T00:00:00+10:00"
+  environment_ids = [data.octopusdeploy_environments.default_environment.environments[0].id]
+}
+
+resource "octopusdeploy_deployment_freeze_tenant" "tenant_freeze" {
+  deploymentfreeze_id = octopusdeploy_deployment_freeze.freeze.id
+  tenant_id           = data.octopusdeploy_tenants.default_tenant.tenants[0].id
+  project_id          = data.octopusdeploy_project.project1.id
+  environment_id      = data.octopusdeploy_environments.default_environment.environments[0].id
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `end` (String) The end time of the freeze, must be RFC3339 format
+- `name` (String) The name of this resource.
+- `owner_id` (String) The Owner ID of the freeze
+- `start` (String) The start time of the freeze, must be RFC3339 format
+
+### Optional
+
+- `environment_ids` (List of String) The environment IDs associated with this project deployment freeze scope
+- `recurring_schedule` (Attributes) (see [below for nested schema](#nestedatt--recurring_schedule))
+
+### Read-Only
+
+- `id` (String) The unique ID for this resource.
+
+<a id="nestedatt--recurring_schedule"></a>
+### Nested Schema for `recurring_schedule`
+
+Required:
+
+- `end_type` (String) When the recurring schedule should end (Never, OnDate, AfterOccurrences)
+- `type` (String) Type of recurring schedule (Daily, Weekly, Monthly, Annually)
+- `unit` (Number) The unit value for the schedule
+
+Optional:
+
+- `date_of_month` (String) The date of the month for monthly schedules
+- `day_number_of_month` (String) Specifies which weekday position in the month. Valid values: 1 (First), 2 (Second), 3 (Third), 4 (Fourth), L (Last). Used with day_of_week
+- `day_of_week` (String) The day of the week for monthly schedules when using DayOfMonth type
+- `days_of_week` (List of String) List of days of the week for weekly schedules. Must follow order: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
+- `end_after_occurrences` (Number) Number of occurrences after which the schedule should end
+- `end_on_date` (String) The date when the recurring schedule should end
+- `monthly_schedule_type` (String) Type of monthly schedule (DayOfMonth, DateOfMonth)
+- `utc_offset_in_minutes` (Number) The UTC offset in minutes of the timezone the schedule should run in, will use offset from freeze start date if not specified.
+
+

examples/resources/octopusdeploy_project_deployment_freeze/resource.tf

@@ -0,0 +1,60 @@
+# basic freeze with no environment scopes
+resource "octopusdeploy_project_deployment_freeze" "freeze" {
+  owner_id = "Projects-123"
+  name = "Xmas"
+  start = "2024-12-25T00:00:00+10:00"
+  end = "2024-12-27T00:00:00+08:00"
+}
+
+# Freeze with different timezones and single environment scope
+resource "octopusdeploy_deployment_freeze" "freeze" {
+  owner_id = "Projects-123"
+  name = "Xmas"
+  start = "2024-12-25T00:00:00+10:00"
+  end = "2024-12-27T00:00:00+08:00"
+  environment_ids = ["Environments-123"]
+}
+
+# Freeze recurring freeze yearly on Xmas
+resource "octopusdeploy_deployment_freeze" "freeze" {
+  owner_id = "Projects-123"
+  name = "Xmas"
+  start = "2024-12-25T00:00:00+10:00"
+  end = "2024-12-27T00:00:00+08:00"
+  recurring_schedule = {
+    type    = "Annually"
+    unit    = 1
+    end_type = "Never"
+  }
+}
+
+resource "octopusdeploy_deployment_freeze_project" "project_freeze" {
+  deploymentfreeze_id= octopusdeploy_deployment_freeze.freeze.id
+  project_id = "Projects-123"
+  environment_ids = [ "Environments-123", "Environments-456" ]
+}
+
+# Freeze with ids sourced from resources.
+resource "octopusdeploy_deployment_freeze" "freeze" {
+  owner_id = resource.octopusdeploy_project.project1.id
+  name = "End of financial year shutdown"
+  start = "2025-06-30T00:00:00+10:00"
+  end = "2025-07-02T00:00:00+10:00"
+  environment_ids = [resource.octopusdeploy_environment.production.id]
+}
+
+# Freeze with tenant environment scope and ids sourced from datasources.
+resource "octopusdeploy_deployment_freeze" "freeze" {
+  owner_id = data.octopusdeploy_project.project1.id
+  name = "End of financial year shutdown"
+  start = "2025-06-30T00:00:00+10:00"
+  end = "2025-07-02T00:00:00+10:00"
+  environment_ids = [data.octopusdeploy_environments.default_environment.environments[0].id]
+}
+
+resource "octopusdeploy_deployment_freeze_tenant" "tenant_freeze" {
+  deploymentfreeze_id = octopusdeploy_deployment_freeze.freeze.id
+  tenant_id           = data.octopusdeploy_tenants.default_tenant.tenants[0].id
+  project_id          = data.octopusdeploy_project.project1.id
+  environment_id      = data.octopusdeploy_environments.default_environment.environments[0].id
+}

octopusdeploy_framework/framework_provider.go

@@ -143,6 +143,7 @@ func (p *octopusDeployFrameworkProvider) Resources(ctx context.Context) []func()
 		NewProcessChildStepsOrderResource,
 		NewProcessTemplatedStepResource,
 		NewProcessTemplatedChildStepResource,
+		NewProjectDeploymentFreezeResource,
 	}
 }
 

octopusdeploy_framework/resource_deployment_freeze.go

@@ -2,6 +2,7 @@ package octopusdeploy_framework
 
 import (
 	"context"
+
 	"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/deploymentfreezes"
 	"github.com/OctopusDeploy/terraform-provider-octopusdeploy/internal"
 	"github.com/OctopusDeploy/terraform-provider-octopusdeploy/internal/errors"
@@ -12,14 +13,14 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-	"time"
 )
 
 const deploymentFreezeResourceName = "deployment_freeze"
 
 type recurringScheduleModel struct {
 	Type                types.String      `tfsdk:"type"`
 	Unit                types.Int64       `tfsdk:"unit"`
+	UtcOffsetInMinutes  types.Int64       `tfsdk:"utc_offset_in_minutes"`
 	EndType             types.String      `tfsdk:"end_type"`
 	EndOnDate           timetypes.RFC3339 `tfsdk:"end_on_date"`
 	EndAfterOccurrences types.Int64       `tfsdk:"end_after_occurrences"`
@@ -38,14 +39,6 @@ type deploymentFreezeModel struct {
 	schemas.ResourceModel
 }
 
-func getStringPointer(s types.String) *string {
-	if s.IsNull() {
-		return nil
-	}
-	value := s.ValueString()
-	return &value
-}
-
 type deploymentFreezeResource struct {
 	*Config
 }
@@ -230,12 +223,12 @@ func mapFromState(state *deploymentFreezeModel) (*deploymentfreezes.DeploymentFr
 			Type:                deploymentfreezes.RecurringScheduleType(state.RecurringSchedule.Type.ValueString()),
 			Unit:                int(state.RecurringSchedule.Unit.ValueInt64()),
 			EndType:             deploymentfreezes.RecurringScheduleEndType(state.RecurringSchedule.EndType.ValueString()),
-			EndAfterOccurrences: getOptionalIntValue(state.RecurringSchedule.EndAfterOccurrences),
-			MonthlyScheduleType: getOptionalString(state.RecurringSchedule.MonthlyScheduleType),
-			DateOfMonth:         getOptionalString(state.RecurringSchedule.DateOfMonth),
-			DayNumberOfMonth:    getOptionalString(state.RecurringSchedule.DayNumberOfMonth),
+			EndAfterOccurrences: util.GetOptionalIntValue(state.RecurringSchedule.EndAfterOccurrences),
+			MonthlyScheduleType: util.GetOptionalString(state.RecurringSchedule.MonthlyScheduleType),
+			DateOfMonth:         util.GetOptionalString(state.RecurringSchedule.DateOfMonth),
+			DayNumberOfMonth:    util.GetOptionalString(state.RecurringSchedule.DayNumberOfMonth),
 			DaysOfWeek:          daysOfWeek,
-			DayOfWeek:           getOptionalString(state.RecurringSchedule.DayOfWeek),
+			DayOfWeek:           util.GetOptionalString(state.RecurringSchedule.DayOfWeek),
 		}
 
 		if !state.RecurringSchedule.EndOnDate.IsNull() {
@@ -255,13 +248,13 @@ func mapToState(ctx context.Context, state *deploymentFreezeModel, deploymentFre
 	state.ID = types.StringValue(deploymentFreeze.ID)
 	state.Name = types.StringValue(deploymentFreeze.Name)
 
-	updatedStart, diags := calculateStateTime(ctx, state.Start, *deploymentFreeze.Start)
+	updatedStart, diags := util.CalculateStateTime(ctx, state.Start, *deploymentFreeze.Start)
 	if diags.HasError() {
 		return diags
 	}
 	state.Start = updatedStart
 
-	updatedEnd, diags := calculateStateTime(ctx, state.End, *deploymentFreeze.End)
+	updatedEnd, diags := util.CalculateStateTime(ctx, state.End, *deploymentFreeze.End)
 	if diags.HasError() {
 		return diags
 	}
@@ -290,7 +283,7 @@ func mapToState(ctx context.Context, state *deploymentFreezeModel, deploymentFre
 			Unit:                types.Int64Value(int64(deploymentFreeze.RecurringSchedule.Unit)),
 			EndType:             types.StringValue(string(deploymentFreeze.RecurringSchedule.EndType)),
 			DaysOfWeek:          daysOfWeek,
-			MonthlyScheduleType: mapOptionalStringValue(deploymentFreeze.RecurringSchedule.MonthlyScheduleType),
+			MonthlyScheduleType: util.MapOptionalStringValue(deploymentFreeze.RecurringSchedule.MonthlyScheduleType),
 		}
 
 		if deploymentFreeze.RecurringSchedule.EndOnDate != nil {
@@ -299,66 +292,11 @@ func mapToState(ctx context.Context, state *deploymentFreezeModel, deploymentFre
 			state.RecurringSchedule.EndOnDate = timetypes.NewRFC3339Null()
 		}
 
-		state.RecurringSchedule.EndAfterOccurrences = mapOptionalIntValue(deploymentFreeze.RecurringSchedule.EndAfterOccurrences)
-		state.RecurringSchedule.DateOfMonth = mapOptionalStringValue(deploymentFreeze.RecurringSchedule.DateOfMonth)
-		state.RecurringSchedule.DayNumberOfMonth = mapOptionalStringValue(deploymentFreeze.RecurringSchedule.DayNumberOfMonth)
-		state.RecurringSchedule.DayOfWeek = mapOptionalStringValue(deploymentFreeze.RecurringSchedule.DayOfWeek)
+		state.RecurringSchedule.EndAfterOccurrences = util.MapOptionalIntValue(deploymentFreeze.RecurringSchedule.EndAfterOccurrences)
+		state.RecurringSchedule.DateOfMonth = util.MapOptionalStringValue(deploymentFreeze.RecurringSchedule.DateOfMonth)
+		state.RecurringSchedule.DayNumberOfMonth = util.MapOptionalStringValue(deploymentFreeze.RecurringSchedule.DayNumberOfMonth)
+		state.RecurringSchedule.DayOfWeek = util.MapOptionalStringValue(deploymentFreeze.RecurringSchedule.DayOfWeek)
 	}
 
 	return nil
 }
-
-func calculateStateTime(ctx context.Context, stateValue timetypes.RFC3339, updatedValue time.Time) (timetypes.RFC3339, diag.Diagnostics) {
-	stateTime, diags := stateValue.ValueRFC3339Time()
-	if diags.HasError() {
-		return timetypes.RFC3339{}, diags
-	}
-	stateTimeUTC := timetypes.NewRFC3339TimeValue(stateTime.UTC())
-	updatedValueUTC := updatedValue.UTC()
-	valuesAreEqual, diags := stateTimeUTC.StringSemanticEquals(ctx, timetypes.NewRFC3339TimeValue(updatedValueUTC))
-	if diags.HasError() {
-		return timetypes.NewRFC3339Null(), diags
-	}
-
-	if valuesAreEqual {
-		return stateValue, diags
-	}
-
-	location := stateTime.Location()
-	newValue := timetypes.NewRFC3339TimeValue(updatedValueUTC.In(location))
-	return newValue, diags
-}
-
-func getOptionalStringPointer(value types.String) *string {
-	if value.IsNull() {
-		return nil
-	}
-	str := value.ValueString()
-	return &str
-}
-func mapOptionalStringValue(value string) types.String {
-	if value == "" {
-		return types.StringNull()
-	}
-	return types.StringValue(value)
-}
-func getOptionalIntValue(value types.Int64) int {
-	if value.IsNull() {
-		return 0
-	}
-	return int(value.ValueInt64())
-}
-
-func mapOptionalIntValue(value int) types.Int64 {
-	if value == 0 {
-		return types.Int64Null()
-	}
-	return types.Int64Value(int64(value))
-}
-
-func getOptionalString(value types.String) string {
-	if value.IsNull() {
-		return ""
-	}
-	return value.ValueString()
-}