feat: Changes hour_of_day in mongodbatlas_maintenance_window to Required (#3499)

* change hour_of_day to required

* correct start_asap

* changelong

* test

Author: oarbusi

.changelog/3499.txt

@@ -0,0 +1,7 @@
+```release-note:breaking-change
+resource/mongodbatlas_maintenance_window: Changes `hour_of_day` to Required
+```
+
+```release-note:breaking-change
+resource/mongodbatlas_maintenance_window: Changes `start_asap` to Computed only
+```

docs/data-sources/maintenance_window.md

@@ -41,7 +41,7 @@ In addition to all arguments above, the following attributes are exported:
 
 * `day_of_week` - Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
 * `hour_of_day` - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12  (Time zone is UTC).
-* `start_asap` - Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.
+* `start_asap` - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
 * `number_of_deferrals` - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
 * `auto_defer_once_enabled` - Flag that indicates whether you want to defer all maintenance windows one week they would be triggered.
 * `protected_hours` - (Optional) Defines the time period during which there will be no standard updates to the clusters. See [Protected Hours](#protected-hours).
@@ -52,4 +52,4 @@ In addition to all arguments above, the following attributes are exported:
 * `end_hour_of_day` - Zero-based integer that represents the end hour of the day for the protected hours window.
 
 
-For more information see: [MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/maintenance-windows/)
+For more information see: [MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/maintenance-windows/)

docs/resources/maintenance_window.md

@@ -41,15 +41,12 @@ Once maintenance is scheduled for your cluster, you cannot change your maintenan
 
 * `project_id` - The unique identifier of the project for the Maintenance Window.
 * `day_of_week` - (Required) Day of the week when you would like the maintenance window to start as a 1-based integer: Su=1, M=2, T=3, W=4, T=5, F=6, Sa=7.
-* `hour_of_day` - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12 (Time zone is UTC). Defaults to 0.
-* `start_asap` - Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.
+* `hour_of_day` - (Required) Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12 (Time zone is UTC).
 * `defer` - Defer the next scheduled maintenance for the given project for one week.
 * `auto_defer` - Defer any scheduled maintenance for the given project for one week.
 * `auto_defer_once_enabled` - Flag that indicates whether you want to defer all maintenance windows one week they would be triggered.
 * `protected_hours` - (Optional) Defines the time period during which there will be no standard updates to the clusters. See [Protected Hours](#protected-hours).
 
--> **NOTE:** The `start_asap` attribute can't be used because of breaks the Terraform flow, but you can enable via API.
-
 ### Protected Hours
 * `start_hour_of_day` - Zero-based integer that represents the beginning hour of the day for the protected hours window.
 - `end_hour_of_day` - Zero-based integer that represents the end hour of the day for the protected hours window.
@@ -60,6 +57,9 @@ In addition to all arguments above, the following attributes are exported:
 
 * `number_of_deferrals` - Number of times the current maintenance event for this project has been deferred, there can be a maximum of 2 deferrals.
 * `time_zone_id` - Identifier for the current time zone of the maintenance window. This can only be updated via the Project Settings UI.
+* `start_asap` - Flag indicating whether project maintenance has been directed to start immediately. If requested, this field returns true from the time the request was made until the time the maintenance event completes.
+
+-> **NOTE:** The `start_asap` attribute can only be enabled via API.
 
 ## Import
 

internal/service/maintenancewindow/resource_maintenance_window.go

@@ -49,10 +49,8 @@ func Resource() *schema.Resource {
 				},
 			},
 			"hour_of_day": {
-				Type:          schema.TypeInt,
-				Optional:      true,
-				Computed:      true,
-				ConflictsWith: []string{"start_asap"},
+				Type:     schema.TypeInt,
+				Required: true,
 				ValidateFunc: func(val any, key string) (warns []string, errs []error) {
 					v := val.(int)
 					if v < 0 || v > 23 {
@@ -63,7 +61,6 @@ func Resource() *schema.Resource {
 			},
 			"start_asap": {
 				Type:     schema.TypeBool,
-				Optional: true,
 				Computed: true,
 			},
 			"number_of_deferrals": {
@@ -124,9 +121,7 @@ func resourceCreate(ctx context.Context, d *schema.ResourceData, meta any) diag.
 	params := new(admin.GroupMaintenanceWindow)
 
 	params.DayOfWeek = cast.ToInt(d.Get("day_of_week"))
-
-	hourOfDay := d.Get("hour_of_day")
-	params.HourOfDay = conversion.Pointer(cast.ToInt(hourOfDay)) // during creation of maintenance window hourOfDay needs to be set in PATCH to avoid errors, 0 value is sent when absent
+	params.HourOfDay = conversion.Pointer(cast.ToInt(d.Get("hour_of_day")))
 
 	if autoDeferOnceEnabled, ok := d.GetOk("auto_defer_once_enabled"); ok {
 		params.AutoDeferOnceEnabled = conversion.Pointer(autoDeferOnceEnabled.(bool))

internal/service/maintenancewindow/resource_maintenance_window_migration_test.go

@@ -5,7 +5,6 @@ import (
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
-	"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/testutil/acc"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/testutil/mig"
 	"github.com/spf13/cast"
@@ -17,7 +16,7 @@ func TestMigConfigMaintenanceWindow_basic(t *testing.T) {
 		projectName = acc.RandomProjectName()
 		dayOfWeek   = 7
 		hourOfDay   = 3
-		config      = configBasic(orgID, projectName, dayOfWeek, conversion.Pointer(hourOfDay), nil)
+		config      = configBasic(orgID, projectName, dayOfWeek, hourOfDay, nil)
 	)
 
 	resource.ParallelTest(t, resource.TestCase{

internal/service/maintenancewindow/resource_maintenance_window_test.go

@@ -45,20 +45,19 @@ func TestAccConfigRSMaintenanceWindow_basic(t *testing.T) {
 		CheckDestroy:             checkDestroy,
 		Steps: []resource.TestStep{
 			{
-				// testing hour_of_day set to 0 during creation phase does not return errors
-				Config: configBasic(orgID, projectName, dayOfWeek, conversion.Pointer(hourOfDay), defaultProtectedHours),
+				Config: configBasic(orgID, projectName, dayOfWeek, hourOfDay, defaultProtectedHours),
 				Check:  checkBasic(dayOfWeek, hourOfDay, defaultProtectedHours),
 			},
 			{
-				Config: configBasic(orgID, projectName, dayOfWeek, conversion.Pointer(hourOfDayUpdated), updatedProtectedHours),
+				Config: configBasic(orgID, projectName, dayOfWeek, hourOfDayUpdated, updatedProtectedHours),
 				Check:  checkBasic(dayOfWeek, hourOfDayUpdated, updatedProtectedHours),
 			},
 			{
-				Config: configBasic(orgID, projectName, dayOfWeekUpdated, conversion.Pointer(hourOfDay), nil),
+				Config: configBasic(orgID, projectName, dayOfWeekUpdated, hourOfDay, nil),
 				Check:  checkBasic(dayOfWeekUpdated, hourOfDay, nil),
 			},
 			{
-				Config: configBasic(orgID, projectName, dayOfWeek, conversion.Pointer(hourOfDay), defaultProtectedHours),
+				Config: configBasic(orgID, projectName, dayOfWeek, hourOfDay, defaultProtectedHours),
 				Check:  checkBasic(dayOfWeek, hourOfDay, defaultProtectedHours),
 			},
 			{
@@ -71,26 +70,6 @@ func TestAccConfigRSMaintenanceWindow_basic(t *testing.T) {
 	})
 }
 
-func TestAccConfigRSMaintenanceWindow_emptyHourOfDay(t *testing.T) {
-	var (
-		orgID       = os.Getenv("MONGODB_ATLAS_ORG_ID")
-		projectName = acc.RandomProjectName()
-		dayOfWeek   = 7
-	)
-
-	resource.ParallelTest(t, resource.TestCase{
-		PreCheck:                 func() { acc.PreCheckBasic(t) },
-		ProtoV6ProviderFactories: acc.TestAccProviderV6Factories,
-		CheckDestroy:             checkDestroy,
-		Steps: []resource.TestStep{
-			{
-				Config: configBasic(orgID, projectName, dayOfWeek, nil, defaultProtectedHours),
-				Check:  checkBasic(dayOfWeek, 0, defaultProtectedHours),
-			},
-		},
-	})
-}
-
 func TestAccConfigRSMaintenanceWindow_autoDeferActivated(t *testing.T) {
 	var (
 		orgID       = os.Getenv("MONGODB_ATLAS_ORG_ID")
@@ -167,11 +146,7 @@ func importStateIDFunc(resourceName string) resource.ImportStateIdFunc {
 	}
 }
 
-func configBasic(orgID, projectName string, dayOfWeek int, hourOfDay *int, protectedHours *admin.ProtectedHours) string {
-	hourOfDayAttr := ""
-	if hourOfDay != nil {
-		hourOfDayAttr = fmt.Sprintf("hour_of_day = %d", *hourOfDay)
-	}
+func configBasic(orgID, projectName string, dayOfWeek, hourOfDay int, protectedHours *admin.ProtectedHours) string {
 	protectedHoursStr := ""
 	if protectedHours != nil {
 		protectedHoursStr = fmt.Sprintf(`
@@ -189,10 +164,10 @@ func configBasic(orgID, projectName string, dayOfWeek int, hourOfDay *int, prote
 		resource "mongodbatlas_maintenance_window" "test" {
 			project_id  = mongodbatlas_project.test.id
 			day_of_week = %[3]d
-			%[4]s
+			hour_of_day = %[4]d
 			%[5]s
 
-		}`, orgID, projectName, dayOfWeek, hourOfDayAttr, protectedHoursStr)
+		}`, orgID, projectName, dayOfWeek, hourOfDay, protectedHoursStr)
 }
 
 func configWithAutoDeferEnabled(orgID, projectName string, dayOfWeek, hourOfDay int) string {