Merge pull request #5625 from terraform-providers/tph/parse-devspace

devspace - add ID parsing function

azurerm/internal/services/devspace/parse/devspace_controller.go

@@ -0,0 +1,33 @@
+package parse
+
+import (
+	"fmt"
+
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/helpers/azure"
+)
+
+type DevSpaceControllerId struct {
+	ResourceGroup string
+	Name          string
+}
+
+func DevSpaceControllerID(input string) (*DevSpaceControllerId, error) {
+	id, err := azure.ParseAzureResourceID(input)
+	if err != nil {
+		return nil, fmt.Errorf("[ERROR] Unable to parse DevSpace Controller ID %q: %+v", input, err)
+	}
+
+	controller := DevSpaceControllerId{
+		ResourceGroup: id.ResourceGroup,
+	}
+
+	if controller.Name, err = id.PopSegment("controllers"); err != nil {
+		return nil, err
+	}
+
+	if err := id.ValidateNoEmptySegments(input); err != nil {
+		return nil, err
+	}
+
+	return &controller, nil
+}

azurerm/internal/services/devspace/parse/devspace_controller_test.go

@@ -0,0 +1,73 @@
+package parse
+
+import (
+	"testing"
+)
+
+func TestDevSpaceControllerId(t *testing.T) {
+	testData := []struct {
+		Name     string
+		Input    string
+		Expected *DevSpaceControllerId
+	}{
+		{
+			Name:     "Empty",
+			Input:    "",
+			Expected: nil,
+		},
+		{
+			Name:     "No Resource Groups Segment",
+			Input:    "/subscriptions/00000000-0000-0000-0000-000000000000",
+			Expected: nil,
+		},
+		{
+			Name:     "No Resource Groups Value",
+			Input:    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/",
+			Expected: nil,
+		},
+		{
+			Name:     "Resource Group ID",
+			Input:    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/foo/",
+			Expected: nil,
+		},
+		{
+			Name:     "Missing Controllers Value",
+			Input:    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.DevSpaces/controllers/",
+			Expected: nil,
+		},
+		{
+			Name:  "DevSpace Controller ID",
+			Input: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.DevSpaces/controllers/Controller1",
+			Expected: &DevSpaceControllerId{
+				Name:          "Controller1",
+				ResourceGroup: "resGroup1",
+			},
+		},
+		{
+			Name:     "Wrong Casing",
+			Input:    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.DevSpaces/Controllers/Controller1",
+			Expected: nil,
+		},
+	}
+
+	for _, v := range testData {
+		t.Logf("[DEBUG] Testing %q", v.Name)
+
+		actual, err := DevSpaceControllerID(v.Input)
+		if err != nil {
+			if v.Expected == nil {
+				continue
+			}
+
+			t.Fatalf("Expected a value but got an error: %s", err)
+		}
+
+		if actual.Name != v.Expected.Name {
+			t.Fatalf("Expected %q but got %q for Name", v.Expected.Name, actual.Name)
+		}
+
+		if actual.ResourceGroup != v.Expected.ResourceGroup {
+			t.Fatalf("Expected %q but got %q for Resource Group", v.Expected.ResourceGroup, actual.ResourceGroup)
+		}
+	}
+}

azurerm/internal/services/devspace/resource_arm_devspace_controller.go

@@ -13,7 +13,9 @@ import (
 	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/helpers/validate"
 	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/clients"
 	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/features"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/devspace/parse"
 	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/tags"
+	azSchema "github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/tf/schema"
 	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/timeouts"
 	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/utils"
 )
@@ -24,9 +26,6 @@ func resourceArmDevSpaceController() *schema.Resource {
 		Read:   resourceArmDevSpaceControllerRead,
 		Update: resourceArmDevSpaceControllerUpdate,
 		Delete: resourceArmDevSpaceControllerDelete,
-		Importer: &schema.ResourceImporter{
-			State: schema.ImportStatePassthrough,
-		},
 
 		Timeouts: &schema.ResourceTimeout{
 			Create: schema.DefaultTimeout(30 * time.Minute),
@@ -35,6 +34,11 @@ func resourceArmDevSpaceController() *schema.Resource {
 			Delete: schema.DefaultTimeout(30 * time.Minute),
 		},
 
+		Importer: azSchema.ValidateResourceIDPriorToImport(func(id string) error {
+			_, err := parse.DevSpaceControllerID(id)
+			return err
+		}),
+
 		Schema: map[string]*schema.Schema{
 			"name": {
 				Type:         schema.TypeString,
@@ -194,20 +198,21 @@ func resourceArmDevSpaceControllerUpdate(d *schema.ResourceData, meta interface{
 
 	log.Printf("[INFO] preparing arguments for DevSpace Controller updating")
 
-	name := d.Get("name").(string)
-	resGroupName := d.Get("resource_group_name").(string)
-
+	id, err := parse.DevSpaceControllerID(d.Id())
+	if err != nil {
+		return err
+	}
 	params := devspaces.ControllerUpdateParameters{
 		Tags: tags.Expand(d.Get("tags").(map[string]interface{})),
 	}
 
-	result, err := client.Update(ctx, resGroupName, name, params)
+	result, err := client.Update(ctx, id.ResourceGroup, id.Name, params)
 	if err != nil {
-		return fmt.Errorf("Error updating DevSpace Controller %q (Resource Group %q): %+v", name, resGroupName, err)
+		return fmt.Errorf("Error updating DevSpace Controller %q (Resource Group %q): %+v", id.Name, id.ResourceGroup, err)
 	}
 
 	if result.ID == nil {
-		return fmt.Errorf("Cannot read DevSpace Controller %q (Resource Group %q) ID", name, resGroupName)
+		return fmt.Errorf("Cannot read DevSpace Controller %q (Resource Group %q) ID", id.Name, id.ResourceGroup)
 	}
 	d.SetId(*result.ID)
 
@@ -219,26 +224,24 @@ func resourceArmDevSpaceControllerRead(d *schema.ResourceData, meta interface{})
 	ctx, cancel := timeouts.ForRead(meta.(*clients.Client).StopContext, d)
 	defer cancel()
 
-	id, err := azure.ParseAzureResourceID(d.Id())
+	id, err := parse.DevSpaceControllerID(d.Id())
 	if err != nil {
 		return err
 	}
-	resGroupName := id.ResourceGroup
-	name := id.Path["controllers"]
 
-	resp, err := client.Get(ctx, resGroupName, name)
+	resp, err := client.Get(ctx, id.ResourceGroup, id.Name)
 	if err != nil {
 		if utils.ResponseWasNotFound(resp.Response) {
-			log.Printf("[DEBUG] DevSpace Controller %q was not found in Resource Group %q - removing from state!", name, resGroupName)
+			log.Printf("[DEBUG] DevSpace Controller %q was not found in Resource Group %q - removing from state!", id.Name, id.ResourceGroup)
 			d.SetId("")
 			return nil
 		}
 
-		return fmt.Errorf("Error making Read request on DevSpace Controller %q (Resource Group %q): %+v", name, resGroupName, err)
+		return fmt.Errorf("Error making Read request on DevSpace Controller %q (Resource Group %q): %+v", id.Name, id.ResourceGroup, err)
 	}
 
-	d.Set("name", resp.Name)
-	d.Set("resource_group_name", resGroupName)
+	d.Set("name", id.Name)
+	d.Set("resource_group_name", id.ResourceGroup)
 	if location := resp.Location; location != nil {
 		d.Set("location", azure.NormalizeLocation(*location))
 	}
@@ -265,20 +268,18 @@ func resourceArmDevSpaceControllerDelete(d *schema.ResourceData, meta interface{
 	ctx, cancel := timeouts.ForDelete(meta.(*clients.Client).StopContext, d)
 	defer cancel()
 
-	id, err := azure.ParseAzureResourceID(d.Id())
+	id, err := parse.DevSpaceControllerID(d.Id())
 	if err != nil {
 		return err
 	}
-	resGroupName := id.ResourceGroup
-	name := id.Path["controllers"]
 
-	future, err := client.Delete(ctx, resGroupName, name)
+	future, err := client.Delete(ctx, id.ResourceGroup, id.Name)
 	if err != nil {
-		return fmt.Errorf("Error deleting DevSpace Controller %q (Resource Group %q): %+v", name, resGroupName, err)
+		return fmt.Errorf("Error deleting DevSpace Controller %q (Resource Group %q): %+v", id.Name, id.ResourceGroup, err)
 	}
 
 	if err = future.WaitForCompletionRef(ctx, client.Client); err != nil {
-		return fmt.Errorf("Error waiting for the deletion of DevSpace Controller %q (Resource Group %q): %+v", name, resGroupName, err)
+		return fmt.Errorf("Error waiting for the deletion of DevSpace Controller %q (Resource Group %q): %+v", id.Name, id.ResourceGroup, err)
 	}
 
 	return nil

azurerm/internal/services/devspace/tests/resource_arm_devspace_controller_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/acceptance"
 	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/clients"
 	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/features"
+	"github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/devspace/parse"
 )
 
 func TestAccAzureRMDevSpaceController_basic(t *testing.T) {
@@ -98,20 +99,19 @@ func testCheckAzureRMDevSpaceControllerExists(resourceName string) resource.Test
 			return fmt.Errorf("Not found: %s", resourceName)
 		}
 
-		ctrlName := rs.Primary.Attributes["name"]
-		resGroupName, hasReseGroup := rs.Primary.Attributes["resource_group_name"]
-		if !hasReseGroup {
-			return fmt.Errorf("Bad: no resource group found in state for DevSpace Controller: %s", ctrlName)
+		id, err := parse.DevSpaceControllerID(rs.Primary.ID)
+		if err != nil {
+			return err
 		}
 
-		result, err := client.Get(ctx, resGroupName, ctrlName)
+		result, err := client.Get(ctx, id.ResourceGroup, id.Name)
 
 		if err == nil {
 			return nil
 		}
 
 		if result.StatusCode == http.StatusNotFound {
-			return fmt.Errorf("Bad: DevSpace Controller %q (Resource Group: %q) does not exist", ctrlName, resGroupName)
+			return fmt.Errorf("Bad: DevSpace Controller %q (Resource Group: %q) does not exist", id.Name, id.ResourceGroup)
 		}
 
 		return fmt.Errorf("Bad: Get devSpaceControllerClient: %+v", err)
@@ -129,10 +129,12 @@ func testCheckAzureRMDevSpaceControllerDestroy(s *terraform.State) error {
 
 		log.Printf("[WARN] azurerm_devspace_controller still exists in state file.")
 
-		ctrlName := rs.Primary.Attributes["name"]
-		resGroupName := rs.Primary.Attributes["resource_group_name"]
+		id, err := parse.DevSpaceControllerID(rs.Primary.ID)
+		if err != nil {
+			return err
+		}
 
-		result, err := client.Get(ctx, resGroupName, ctrlName)
+		result, err := client.Get(ctx, id.ResourceGroup, id.Name)
 
 		if err == nil {
 			return fmt.Errorf("DevSpace Controller still exists:\n%#v", result)