Refactored unit tests, updated import documentation, fixed imports using project namespaces (+7 squashed commit)

Squashed commit:

[3e3f44e] Fixed capitalization on an acceptance test and remove the project attribute check on deploy key enable tests

[a0db074] Fixing up string conversion, fixing a lint error, refactoring the check destroy function for deploy key enable resource, fixing up check destroy in deploy key enable test

[153342e] Reverting deploy key id to original + refactoring deploy key enable a tad

[3f62ca1] Linter fixes I missed

[50c408c] Linter Fixes

[db9de1a] refactoring deploy key resources to remove the custom importers

[db6ebdb] Refactored Deploy Keys acceptance tests and made logging more helpful

Author: Shocktrooper

docs/resources/deploy_key.md

@@ -46,5 +46,8 @@ Import is supported using the following syntax:
 
 ```shell
 # GitLab deploy keys can be imported using an id made up of `{project_id}:{deploy_key_id}`, e.g.
+# `project_id` can be whatever the [get single project api][get_single_project] takes for
+# its `:id` value, so for example:
 terraform import gitlab_deploy_key.test 1:3
+terraform import gitlab_deploy_key.test richardc/example:3
 ```

docs/resources/deploy_key_enable.md

@@ -50,7 +50,7 @@ resource "gitlab_deploy_key_enable" "foo" {
 
 ### Optional
 
-- `can_push` (Boolean) Can deploy key push to the project’s repository.
+- `can_push` (Boolean) Can deploy key push to the project's repository.
 - `id` (String) The ID of this resource.
 - `key` (String) Deploy key.
 - `title` (String) Deploy key's title.
@@ -61,5 +61,8 @@ Import is supported using the following syntax:
 
 ```shell
 # GitLab enabled deploy keys can be imported using an id made up of `{project_id}:{deploy_key_id}`, e.g.
+# `project_id` can be whatever the [get single project api][get_single_project] takes for
+# its `:id` value, so for example:
 terraform import gitlab_deploy_key_enable.example 12345:67890
+terraform import gitlab_deploy_key_enable.example richardc/example:67890
 ```

examples/resources/gitlab_deploy_key/import.sh

@@ -1,2 +1,5 @@
 # GitLab deploy keys can be imported using an id made up of `{project_id}:{deploy_key_id}`, e.g.
+# `project_id` can be whatever the [get single project api][get_single_project] takes for
+# its `:id` value, so for example:
 terraform import gitlab_deploy_key.test 1:3
+terraform import gitlab_deploy_key.test richardc/example:3

examples/resources/gitlab_deploy_key_enable/import.sh

@@ -1,2 +1,5 @@
 # GitLab enabled deploy keys can be imported using an id made up of `{project_id}:{deploy_key_id}`, e.g.
+# `project_id` can be whatever the [get single project api][get_single_project] takes for
+# its `:id` value, so for example:
 terraform import gitlab_deploy_key_enable.example 12345:67890
+terraform import gitlab_deploy_key_enable.example richardc/example:67890

internal/provider/resource_gitlab_deploy_key.go

@@ -84,10 +84,12 @@ func resourceGitlabDeployKeyCreate(ctx context.Context, d *schema.ResourceData,
 func resourceGitlabDeployKeyRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
 	project := d.Get("project").(string)
+
 	deployKeyID, err := strconv.Atoi(d.Id())
 	if err != nil {
 		return diag.FromErr(err)
 	}
+
 	log.Printf("[DEBUG] read gitlab deploy key %s/%d", project, deployKeyID)
 
 	deployKey, _, err := client.DeployKeys.GetDeployKey(project, deployKeyID, gitlab.WithContext(ctx))
@@ -103,16 +105,19 @@ func resourceGitlabDeployKeyRead(ctx context.Context, d *schema.ResourceData, me
 	d.Set("title", deployKey.Title)
 	d.Set("key", deployKey.Key)
 	d.Set("can_push", deployKey.CanPush)
+
 	return nil
 }
 
 func resourceGitlabDeployKeyDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
 	project := d.Get("project").(string)
+
 	deployKeyID, err := strconv.Atoi(d.Id())
 	if err != nil {
 		return diag.FromErr(err)
 	}
+
 	log.Printf("[DEBUG] Delete gitlab deploy key %s", d.Id())
 
 	_, err = client.DeployKeys.DeleteDeployKey(project, deployKeyID, gitlab.WithContext(ctx))
@@ -128,7 +133,7 @@ func resourceGitlabDeployKeyStateImporter(ctx context.Context, d *schema.Resourc
 	s := strings.Split(d.Id(), ":")
 	if len(s) != 2 {
 		d.SetId("")
-		return nil, fmt.Errorf("Invalid Deploy Key import format; expected '{project_id}:{deploy_key_id}'")
+		return nil, fmt.Errorf("invalid Deploy Key import format; expected '{project_id}:{deploy_key_id}' was %v", s)
 	}
 	project, id := s[0], s[1]
 

internal/provider/resource_gitlab_deploy_key_enable.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"log"
 	"strconv"
-	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -22,7 +21,7 @@ var _ = registerResource("gitlab_deploy_key_enable", func() *schema.Resource {
 		ReadContext:   resourceGitlabDeployKeyEnableRead,
 		DeleteContext: resourceGitlabDeployKeyEnableDelete,
 		Importer: &schema.ResourceImporter{
-			StateContext: resourceGitlabDeployKeyEnableStateImporter,
+			StateContext: schema.ImportStatePassthroughContext,
 		},
 
 		Schema: map[string]*schema.Schema{
@@ -51,7 +50,7 @@ var _ = registerResource("gitlab_deploy_key_enable", func() *schema.Resource {
 				Computed:    true,
 			},
 			"can_push": {
-				Description: "Can deploy key push to the project’s repository.",
+				Description: "Can deploy key push to the project's repository.",
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Default:     false,
@@ -64,7 +63,11 @@ var _ = registerResource("gitlab_deploy_key_enable", func() *schema.Resource {
 func resourceGitlabDeployKeyEnableCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
 	project := d.Get("project").(string)
-	key_id, err := strconv.Atoi(d.Get("key_id").(string)) // nolint // TODO: Resolve this golangci-lint issue: ineffectual assignment to err (ineffassign)
+
+	key_id, err := strconv.Atoi(d.Get("key_id").(string))
+	if err != nil {
+		return diag.FromErr(err)
+	}
 
 	log.Printf("[DEBUG] enable gitlab deploy key %s/%d", project, key_id)
 
@@ -88,11 +91,12 @@ func resourceGitlabDeployKeyEnableCreate(ctx context.Context, d *schema.Resource
 
 func resourceGitlabDeployKeyEnableRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
-	project := d.Get("project").(string)
-	deployKeyID, err := strconv.Atoi(d.Get("key_id").(string))
+
+	project, deployKeyID, err := resourceGitLabDeployKeyEnableParseId(d.Id())
 	if err != nil {
 		return diag.FromErr(err)
 	}
+
 	log.Printf("[DEBUG] read gitlab deploy key %s/%d", project, deployKeyID)
 
 	deployKey, _, err := client.DeployKeys.GetDeployKey(project, deployKeyID, gitlab.WithContext(ctx))
@@ -110,16 +114,18 @@ func resourceGitlabDeployKeyEnableRead(ctx context.Context, d *schema.ResourceDa
 	d.Set("key", deployKey.Key)
 	d.Set("can_push", deployKey.CanPush)
 	d.Set("project", project)
+
 	return nil
 }
 
 func resourceGitlabDeployKeyEnableDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
-	project := d.Get("project").(string)
-	deployKeyID, err := strconv.Atoi(d.Get("key_id").(string))
+
+	project, deployKeyID, err := resourceGitLabDeployKeyEnableParseId(d.Id())
 	if err != nil {
 		return diag.FromErr(err)
 	}
+
 	log.Printf("[DEBUG] Delete gitlab deploy key %s/%d", project, deployKeyID)
 
 	response, err := client.DeployKeys.DeleteDeployKey(project, deployKeyID, gitlab.WithContext(ctx))
@@ -136,17 +142,16 @@ func resourceGitlabDeployKeyEnableDelete(ctx context.Context, d *schema.Resource
 	return nil
 }
 
-func resourceGitlabDeployKeyEnableStateImporter(ctx context.Context, d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
-	s := strings.Split(d.Id(), ":")
-	if len(s) != 2 {
-		d.SetId("")
-		return nil, fmt.Errorf("Invalid Deploy Key import format; expected '{project_id}:{deploy_key_id}'")
+func resourceGitLabDeployKeyEnableParseId(id string) (string, int, error) {
+	projectID, deployTokenID, err := parseTwoPartID(id)
+	if err != nil {
+		return "", 0, err
 	}
-	project, id := s[0], s[1]
 
-	d.SetId(fmt.Sprintf("%s:%s", project, id))
-	d.Set("key_id", id)
-	d.Set("project", project)
+	deployTokenIID, err := strconv.Atoi(deployTokenID)
+	if err != nil {
+		return "", 0, err
+	}
 
-	return []*schema.ResourceData{d}, nil
+	return projectID, deployTokenIID, nil
 }