Merge pull request #4 from casey-robertson-paypal/fix/address-stevehipwell-review

Address @stevehipwell review: code idioms, lint, docs

Author: sprioriello

docs/resources/enterprise_security_configuration.md

@@ -13,7 +13,7 @@ This resource allows you to create and manage [code security configurations](htt
 
 You must have enterprise admin access to use this resource.
 
-~> **Note:** Some settings (such as `advanced_security` and `secret_scanning_generic_secrets`) require GitHub Advanced Security licensing.
+~> Some settings (such as `advanced_security` and `secret_scanning_generic_secrets`) require GitHub Advanced Security licensing.
 
 ## Example Usage
 
@@ -98,7 +98,18 @@ Optional:
 
 ## Import
 
-GitHub enterprise code security configurations can be imported using the enterprise slug and the configuration ID separated by a colon (`<enterprise_slug>:<configuration_id>`), for example:
+GitHub enterprise code security configurations can be imported using the enterprise slug and the configuration ID separated by a colon (`<enterprise_slug>:<configuration_id>`).
+
+In Terraform v1.5.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `id` attribute, for example:
+
+```terraform
+import {
+  to = github_enterprise_security_configuration.default
+  id = "my-enterprise:123"
+}
+```
+
+The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
 
 ```shell
 terraform import github_enterprise_security_configuration.default my-enterprise:123

docs/resources/organization_security_configuration.md

@@ -13,7 +13,7 @@ This resource allows you to create and manage [code security configurations](htt
 
 You must have organization admin access to use this resource.
 
-~> **Note:** Some settings (such as `advanced_security` and `secret_scanning_generic_secrets`) require GitHub Advanced Security licensing.
+~> Some settings (such as `advanced_security` and `secret_scanning_generic_secrets`) require GitHub Advanced Security licensing.
 
 ## Example Usage
 
@@ -137,7 +137,18 @@ Required:
 
 ## Import
 
-GitHub organization code security configurations can be imported using the configuration ID, for example:
+GitHub organization code security configurations can be imported using the configuration ID.
+
+In Terraform v1.5.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `id` attribute, for example:
+
+```terraform
+import {
+  to = github_organization_security_configuration.default
+  id = "123"
+}
+```
+
+The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
 
 ```shell
 terraform import github_organization_security_configuration.default 123

examples/resources/github_enterprise_security_configuration/import-by-string-id.tf

@@ -0,0 +1,4 @@
+import {
+  to = github_enterprise_security_configuration.default
+  id = "my-enterprise:123"
+}

examples/resources/github_organization_security_configuration/import-by-string-id.tf

@@ -0,0 +1,4 @@
+import {
+  to = github_organization_security_configuration.default
+  id = "123"
+}

github/resource_github_enterprise_security_configuration.go

@@ -264,25 +264,19 @@ func resourceGithubEnterpriseSecurityConfiguration() *schema.Resource {
 	}
 }
 
-func resourceGithubEnterpriseSecurityConfigurationCreate(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
-	client := meta.(*Owner).v3client
-	enterprise := d.Get("enterprise_slug").(string)
-	name := d.Get("name").(string)
+func resourceGithubEnterpriseSecurityConfigurationCreate(ctx context.Context, d *schema.ResourceData, m any) diag.Diagnostics {
+	meta, _ := m.(*Owner)
+	client := meta.v3client
+	enterprise, _ := d.Get("enterprise_slug").(string)
+	name, _ := d.Get("name").(string)
 
-	tflog.Debug(ctx, "Creating enterprise code security configuration", map[string]any{
-		"enterprise": enterprise,
-		"name":       name,
-	})
+	tflog.Debug(ctx, "Creating enterprise code security configuration", map[string]any{"enterprise": enterprise, "name": name})
 
 	config := expandCodeSecurityConfigurationCommon(d)
 
 	configuration, _, err := client.Enterprise.CreateCodeSecurityConfiguration(ctx, enterprise, config)
 	if err != nil {
-		tflog.Error(ctx, "Failed to create enterprise code security configuration", map[string]any{
-			"enterprise": enterprise,
-			"name":       name,
-			"error":      err.Error(),
-		})
+		tflog.Error(ctx, "Failed to create enterprise code security configuration", map[string]any{"enterprise": enterprise, "name": name, "error": err.Error()})
 		return diag.FromErr(err)
 	}
 
@@ -296,124 +290,86 @@ func resourceGithubEnterpriseSecurityConfigurationCreate(ctx context.Context, d
 		return diags
 	}
 
-	tflog.Info(ctx, "Created enterprise code security configuration", map[string]any{
-		"enterprise": enterprise,
-		"name":       name,
-		"id":         configuration.GetID(),
-	})
+	tflog.Info(ctx, "Created enterprise code security configuration", map[string]any{"enterprise": enterprise, "name": name, "id": configuration.GetID()})
 
 	return nil
 }
 
-func resourceGithubEnterpriseSecurityConfigurationRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
-	client := meta.(*Owner).v3client
-	enterprise := d.Get("enterprise_slug").(string)
-	id := int64(d.Get("configuration_id").(int))
+func resourceGithubEnterpriseSecurityConfigurationRead(ctx context.Context, d *schema.ResourceData, m any) diag.Diagnostics {
+	meta, _ := m.(*Owner)
+	client := meta.v3client
+	enterprise, _ := d.Get("enterprise_slug").(string)
+	configID, _ := d.Get("configuration_id").(int)
+	id := int64(configID)
 
-	tflog.Trace(ctx, "Reading enterprise code security configuration", map[string]any{
-		"enterprise": enterprise,
-		"id":         id,
-	})
+	tflog.Trace(ctx, "Reading enterprise code security configuration", map[string]any{"enterprise": enterprise, "id": id})
 
 	configuration, _, err := client.Enterprise.GetCodeSecurityConfiguration(ctx, enterprise, id)
 	if err != nil {
-		var ghErr *github.ErrorResponse
-		if errors.As(err, &ghErr) {
-			if ghErr.Response.StatusCode == http.StatusNotFound {
-				tflog.Info(ctx, "Removing enterprise code security configuration from state because it no longer exists in GitHub", map[string]any{
-					"enterprise": enterprise,
-					"id":         id,
-				})
-				d.SetId("")
-				return nil
-			}
+		if ghErr, ok := errors.AsType[*github.ErrorResponse](err); ok && ghErr.Response.StatusCode == http.StatusNotFound {
+			tflog.Info(ctx, "Removing enterprise code security configuration from state because it no longer exists in GitHub", map[string]any{"enterprise": enterprise, "id": id})
+			d.SetId("")
+			return nil
 		}
-		tflog.Error(ctx, "Failed to read enterprise code security configuration", map[string]any{
-			"enterprise": enterprise,
-			"id":         id,
-			"error":      err.Error(),
-		})
+		tflog.Error(ctx, "Failed to read enterprise code security configuration", map[string]any{"enterprise": enterprise, "id": id, "error": err.Error()})
 		return diag.FromErr(err)
 	}
 
 	if diags := setCodeSecurityConfigurationState(d, configuration); diags.HasError() {
 		return diags
 	}
 
-	tflog.Trace(ctx, "Successfully read enterprise code security configuration", map[string]any{
-		"enterprise": enterprise,
-		"id":         id,
-	})
+	tflog.Trace(ctx, "Successfully read enterprise code security configuration", map[string]any{"enterprise": enterprise, "id": id})
 
 	return nil
 }
 
-func resourceGithubEnterpriseSecurityConfigurationUpdate(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
-	client := meta.(*Owner).v3client
-	enterprise := d.Get("enterprise_slug").(string)
-	id := int64(d.Get("configuration_id").(int))
+func resourceGithubEnterpriseSecurityConfigurationUpdate(ctx context.Context, d *schema.ResourceData, m any) diag.Diagnostics {
+	meta, _ := m.(*Owner)
+	client := meta.v3client
+	enterprise, _ := d.Get("enterprise_slug").(string)
+	configID, _ := d.Get("configuration_id").(int)
+	id := int64(configID)
 
-	tflog.Debug(ctx, "Updating enterprise code security configuration", map[string]any{
-		"enterprise": enterprise,
-		"id":         id,
-	})
+	tflog.Debug(ctx, "Updating enterprise code security configuration", map[string]any{"enterprise": enterprise, "id": id})
 
 	config := expandCodeSecurityConfigurationCommon(d)
 
 	configuration, _, err := client.Enterprise.UpdateCodeSecurityConfiguration(ctx, enterprise, id, config)
 	if err != nil {
-		tflog.Error(ctx, "Failed to update enterprise code security configuration", map[string]any{
-			"enterprise": enterprise,
-			"id":         id,
-			"error":      err.Error(),
-		})
+		tflog.Error(ctx, "Failed to update enterprise code security configuration", map[string]any{"enterprise": enterprise, "id": id, "error": err.Error()})
 		return diag.FromErr(err)
 	}
 
 	if diags := setCodeSecurityConfigurationState(d, configuration); diags.HasError() {
 		return diags
 	}
 
-	tflog.Info(ctx, "Updated enterprise code security configuration", map[string]any{
-		"enterprise": enterprise,
-		"id":         id,
-	})
+	tflog.Info(ctx, "Updated enterprise code security configuration", map[string]any{"enterprise": enterprise, "id": id})
 
 	return nil
 }
 
-func resourceGithubEnterpriseSecurityConfigurationDelete(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
-	client := meta.(*Owner).v3client
-	enterprise := d.Get("enterprise_slug").(string)
-	id := int64(d.Get("configuration_id").(int))
+func resourceGithubEnterpriseSecurityConfigurationDelete(ctx context.Context, d *schema.ResourceData, m any) diag.Diagnostics {
+	meta, _ := m.(*Owner)
+	client := meta.v3client
+	enterprise, _ := d.Get("enterprise_slug").(string)
+	configID, _ := d.Get("configuration_id").(int)
+	id := int64(configID)
 
-	tflog.Debug(ctx, "Deleting enterprise code security configuration", map[string]any{
-		"enterprise": enterprise,
-		"id":         id,
-	})
+	tflog.Debug(ctx, "Deleting enterprise code security configuration", map[string]any{"enterprise": enterprise, "id": id})
 
 	_, err := client.Enterprise.DeleteCodeSecurityConfiguration(ctx, enterprise, id)
 	if err != nil {
-		var ghErr *github.ErrorResponse
-		if errors.As(err, &ghErr) && ghErr.Response.StatusCode == http.StatusNotFound {
-			tflog.Info(ctx, "Enterprise code security configuration already deleted", map[string]any{
-				"enterprise": enterprise,
-				"id":         id,
-			})
+		if ghErr, ok := errors.AsType[*github.ErrorResponse](err); ok && ghErr.Response.StatusCode == http.StatusNotFound {
+			tflog.Info(ctx, "Enterprise code security configuration already deleted", map[string]any{"enterprise": enterprise, "id": id})
 			return nil
 		}
-		tflog.Error(ctx, "Failed to delete enterprise code security configuration", map[string]any{
-			"enterprise": enterprise,
-			"id":         id,
-			"error":      err.Error(),
-		})
+		tflog.Error(ctx, "Failed to delete enterprise code security configuration", map[string]any{"enterprise": enterprise, "id": id, "error": err.Error()})
 		return diag.FromErr(err)
 	}
 
-	tflog.Info(ctx, "Deleted enterprise code security configuration", map[string]any{
-		"enterprise": enterprise,
-		"id":         id,
-	})
+	tflog.Info(ctx, "Deleted enterprise code security configuration", map[string]any{"enterprise": enterprise, "id": id})
 
 	return nil
 }
@@ -439,4 +395,3 @@ func resourceGithubEnterpriseSecurityConfigurationImport(_ context.Context, d *s
 
 	return []*schema.ResourceData{d}, nil
 }
-