Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for setting desired_status to different values than "RUNNING" on creation of google_compute_instance #11902

Merged
merged 4 commits into from
Oct 25, 2024
Merged

Allow for setting desired_status to different values than "RUNNING" on creation of google_compute_instance #11902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8a985ba
add mechanism
karolgorc Oct 2, 2024
465795b
add tests
karolgorc Oct 3, 2024
dec4cf1
reinforce conditions for edge-cases
karolgorc Oct 18, 2024
85dcc96
minor variable changes
karolgorc Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 40 additions & 27 deletions mmv1/third_party/terraform/services/compute/resource_compute_instance.go.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1272,7 +1272,6 @@ be from 0 to 999,999,999 inclusive.`,
},
suppressEmptyGuestAcceleratorDiff,
),
desiredStatusDiff,
validateSubnetworkProject,
forceNewIfNetworkIPNotUpdatable,
tpgresource.SetLabelsDiff,
Expand Down Expand Up @@ -1462,10 +1461,34 @@ func getAllStatusBut(status string) []string {
return computeInstanceStatus
}

func waitUntilInstanceHasDesiredStatus(config *transport_tpg.Config, d *schema.ResourceData) error {
desiredStatus := d.Get("desired_status").(string)
func changeInstanceStatusOnCreation(config *transport_tpg.Config, d *schema.ResourceData, project, zone, status, userAgent string) error {
BBBmau marked this conversation as resolved.
Show resolved Hide resolved
var op *compute.Operation
var err error
if status == "TERMINATED" {
op, err = config.NewComputeClient(userAgent).Instances.Stop(project, zone, d.Get("name").(string)).Do()
} else if status == "SUSPENDED" {
op, err = config.NewComputeClient(userAgent).Instances.Suspend(project, zone, d.Get("name").(string)).Do()
}
if err != nil {
return fmt.Errorf("Error changing instance status after creation: %s", err)
}

waitErr := ComputeOperationWaitTime(config, op, project, "changing instance status", userAgent, d.Timeout(schema.TimeoutCreate))
if waitErr != nil {
d.SetId("")
return waitErr
}

err = waitUntilInstanceHasDesiredStatus(config, d, status)
if err != nil {
return fmt.Errorf("Error waiting for status: %s", err)
}

return nil
}

if desiredStatus != "" {
func waitUntilInstanceHasDesiredStatus(config *transport_tpg.Config, d *schema.ResourceData, status string) error {
if status != "" {
stateRefreshFunc := func() (interface{}, string, error) {
instance, err := getInstance(config, d)
if err != nil || instance == nil {
Expand All @@ -1476,17 +1499,17 @@ func waitUntilInstanceHasDesiredStatus(config *transport_tpg.Config, d *schema.R
}
stateChangeConf := retry.StateChangeConf{
Delay: 5 * time.Second,
Pending: getAllStatusBut(desiredStatus),
Pending: getAllStatusBut(status),
Refresh: stateRefreshFunc,
Target: []string{desiredStatus},
Target: []string{status},
Timeout: d.Timeout(schema.TimeoutUpdate),
MinTimeout: 2 * time.Second,
}
_, err := stateChangeConf.WaitForState()

if err != nil {
return fmt.Errorf(
"Error waiting for instance to reach desired status %s: %s", desiredStatus, err)
"Error waiting for instance to reach desired status %s: %s", status, err)
}
}

Expand Down Expand Up @@ -1553,11 +1576,20 @@ func resourceComputeInstanceCreate(d *schema.ResourceData, meta interface{}) err
}
{{- end }}

err = waitUntilInstanceHasDesiredStatus(config, d)
err = waitUntilInstanceHasDesiredStatus(config, d, "RUNNING")
if err != nil {
return fmt.Errorf("Error waiting for status: %s", err)
}

if val, ok := d.GetOk("desired_status"); ok {
if val.(string) != "RUNNING" {
err = changeInstanceStatusOnCreation(config, d, project, zone.Name, val.(string), userAgent)
if err != nil {
return fmt.Errorf("Error changing instance status after creation: %s", err)
}
}
}

return resourceComputeInstanceRead(d, meta)
}

Expand Down Expand Up @@ -2895,25 +2927,6 @@ func suppressEmptyGuestAcceleratorDiff(_ context.Context, d *schema.ResourceDiff
return nil
}

// return an error if the desired_status field is set to a value other than RUNNING on Create.
func desiredStatusDiff(_ context.Context, diff *schema.ResourceDiff, meta interface{}) error {
// when creating an instance, name is not set
oldName, _ := diff.GetChange("name")

if oldName == nil || oldName == "" {
_, newDesiredStatus := diff.GetChange("desired_status")

if newDesiredStatus == nil || newDesiredStatus == "" {
return nil
} else if newDesiredStatus != "RUNNING" {
return fmt.Errorf("When creating an instance, desired_status can only accept RUNNING value")
}
return nil
}

return nil
}

func resourceComputeInstanceDelete(d *schema.ResourceData, meta interface{}) error {
config := meta.(*transport_tpg.Config)
userAgent, err := tpgresource.GenerateUserAgentString(d, config.UserAgent)
Expand Down
100 changes: 90 additions & 10 deletions mmv1/third_party/terraform/services/compute/resource_compute_instance_test.go.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2287,27 +2287,80 @@ func TestAccComputeInstance_enableDisplay(t *testing.T) {
})
}

func TestAccComputeInstance_desiredStatusOnCreation(t *testing.T) {
func TestAccComputeInstance_desiredStatusTerminatedOnCreation(t *testing.T) {
t.Parallel()

var instance compute.Instance
var instanceName = fmt.Sprintf("tf-test-%s", acctest.RandString(t, 10))

context_1 := map[string]interface{}{
"instance_name": fmt.Sprintf("tf-test-%s", acctest.RandString(t, 10)),
"zone": "us-central1-a",
"desired_status": "TERMINATED",
}

context_2 := map[string]interface{}{
"instance_name": context_1["instance_name"],
"zone": context_1["zone"],
"desired_status": "RUNNING",
}

acctest.VcrTest(t, resource.TestCase{
PreCheck: func() { acctest.AccTestPreCheck(t) },
PreCheck: func() { acctest.AccTestPreCheck(t) },
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
CheckDestroy: testAccCheckComputeInstanceDestroyProducer(t),
CheckDestroy: testAccCheckComputeInstanceDestroyProducer(t),
Steps: []resource.TestStep{
{
Config: testAccComputeInstance_machineType_desiredStatus_allowStoppingForUpdate(instanceName, "e2-medium", "TERMINATED", false),
ExpectError: regexp.MustCompile("When creating an instance, desired_status can only accept RUNNING value"),
Config: testAccComputeInstance_desiredStatusOnCreation(context_1),
Check: resource.ComposeTestCheckFunc(
testAccCheckComputeInstanceExists(t, "google_compute_instance.foobar", &instance),
testAccCheckComputeInstanceHasStatus(&instance, context_1["desired_status"].(string)),
),
},
{
Config: testAccComputeInstance_machineType_desiredStatus_allowStoppingForUpdate(instanceName, "e2-medium", "RUNNING", false),
Config: testAccComputeInstance_desiredStatusOnCreation(context_2),
Check: resource.ComposeTestCheckFunc(
testAccCheckComputeInstanceExists(
t, "google_compute_instance.foobar", &instance),
testAccCheckComputeInstanceHasStatus(&instance, "RUNNING"),
testAccCheckComputeInstanceExists(t, "google_compute_instance.foobar", &instance),
testAccCheckComputeInstanceHasStatus(&instance, context_2["desired_status"].(string)),
),
},
},
})
}

func TestAccComputeInstance_desiredStatusSuspendedOnCreation(t *testing.T) {
t.Parallel()

var instance compute.Instance

context_1 := map[string]interface{}{
"instance_name": fmt.Sprintf("tf-test-%s", acctest.RandString(t, 10)),
"zone": "us-central1-a",
"desired_status": "SUSPENDED",
}

context_2 := map[string]interface{}{
"instance_name": context_1["instance_name"],
"zone": context_1["zone"],
"desired_status": "RUNNING",
}

acctest.VcrTest(t, resource.TestCase{
PreCheck: func() { acctest.AccTestPreCheck(t) },
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
CheckDestroy: testAccCheckComputeInstanceDestroyProducer(t),
Steps: []resource.TestStep{
{
Config: testAccComputeInstance_desiredStatusOnCreation(context_1),
Check: resource.ComposeTestCheckFunc(
testAccCheckComputeInstanceExists(t, "google_compute_instance.foobar", &instance),
testAccCheckComputeInstanceHasStatus(&instance, context_1["desired_status"].(string)),
),
},
{
Config: testAccComputeInstance_desiredStatusOnCreation(context_2),
Check: resource.ComposeTestCheckFunc(
testAccCheckComputeInstanceExists(t, "google_compute_instance.foobar", &instance),
testAccCheckComputeInstanceHasStatus(&instance, context_2["desired_status"].(string)),
),
},
},
Expand Down Expand Up @@ -8937,6 +8990,33 @@ resource "google_compute_instance" "foobar" {
`, instance)
}

func testAccComputeInstance_desiredStatusOnCreation(context map[string]interface{}) string {
return acctest.Nprintf(`
data "google_compute_image" "my_image" {
family = "debian-11"
project = "debian-cloud"
}

resource "google_compute_instance" "foobar" {
name = "%{instance_name}"
machine_type = "e2-medium"
zone = "%{zone}"

boot_disk {
initialize_params{
image = "${data.google_compute_image.my_image.self_link}"
}
}

network_interface {
network = "default"
}

desired_status = "%{desired_status}"
}
`, context)
}

func testAccComputeInstance_resourcePolicyCollocate(instance, suffix string) string {
return fmt.Sprintf(`
data "google_compute_image" "my_image" {
Expand Down