fix: Address maintainer review feedback on enterprise custom property resources

Switch to context-aware CRUD functions, add 404 handling in delete,
properly propagate d.Set() errors, add top-level Description to data
source, fix data source schema to use Computed-only fields, and update
tests to use testResourcePrefix and ConfigStateChecks.

Author: faradayfan

github/data_source_github_enterprise_custom_property.go

@@ -9,6 +9,8 @@ import (
 
 func dataSourceGithubEnterpriseCustomProperty() *schema.Resource {
 	return &schema.Resource{
+		Description: "Use this data source to retrieve information about a custom property definition for a GitHub enterprise.",
+
 		ReadContext: dataSourceGithubEnterpriseCustomPropertyRead,
 
 		Schema: map[string]*schema.Schema{
@@ -71,14 +73,31 @@ func dataSourceGithubEnterpriseCustomPropertyRead(ctx context.Context, d *schema
 	defaultValue, _ := property.DefaultValueString()
 
 	d.SetId(buildTwoPartID(enterpriseSlug, propertyName))
-	_ = d.Set("enterprise_slug", enterpriseSlug)
-	_ = d.Set("property_name", property.GetPropertyName())
-	_ = d.Set("value_type", string(property.ValueType))
-	_ = d.Set("required", property.GetRequired())
-	_ = d.Set("default_value", defaultValue)
-	_ = d.Set("description", property.GetDescription())
-	_ = d.Set("allowed_values", property.AllowedValues)
-	_ = d.Set("values_editable_by", property.GetValuesEditableBy())
+
+	if err := d.Set("enterprise_slug", enterpriseSlug); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("property_name", property.GetPropertyName()); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("value_type", string(property.ValueType)); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("required", property.GetRequired()); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("default_value", defaultValue); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("description", property.GetDescription()); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("allowed_values", property.AllowedValues); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("values_editable_by", property.GetValuesEditableBy()); err != nil {
+		return diag.FromErr(err)
+	}
 
 	return nil
 }

github/resource_github_enterprise_custom_properties.go

@@ -6,18 +6,19 @@ import (
 	"net/http"
 
 	"github.com/google/go-github/v84/github"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 )
 
 func resourceGithubEnterpriseCustomProperties() *schema.Resource {
 	return &schema.Resource{
-		Create: resourceGithubEnterpriseCustomPropertiesCreate,
-		Read:   resourceGithubEnterpriseCustomPropertiesRead,
-		Update: resourceGithubEnterpriseCustomPropertiesUpdate,
-		Delete: resourceGithubEnterpriseCustomPropertiesDelete,
+		CreateContext: resourceGithubEnterpriseCustomPropertiesCreate,
+		ReadContext:   resourceGithubEnterpriseCustomPropertiesRead,
+		UpdateContext: resourceGithubEnterpriseCustomPropertiesUpdate,
+		DeleteContext: resourceGithubEnterpriseCustomPropertiesDelete,
 		Importer: &schema.ResourceImporter{
-			State: resourceGithubEnterpriseCustomPropertiesImport,
+			StateContext: schema.ImportStatePassthroughContext,
 		},
 
 		Schema: map[string]*schema.Schema{
@@ -53,7 +54,6 @@ func resourceGithubEnterpriseCustomProperties() *schema.Resource {
 			"description": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Computed:    true,
 				Description: "A short description of the custom property.",
 			},
 			"allowed_values": {
@@ -74,9 +74,8 @@ func resourceGithubEnterpriseCustomProperties() *schema.Resource {
 	}
 }
 
-func resourceGithubEnterpriseCustomPropertiesCreate(d *schema.ResourceData, meta any) error {
+func resourceGithubEnterpriseCustomPropertiesCreate(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
 	client := meta.(*Owner).v3client
-	ctx := context.Background()
 
 	enterpriseSlug := d.Get("enterprise_slug").(string)
 	propertyName := d.Get("property_name").(string)
@@ -85,20 +84,19 @@ func resourceGithubEnterpriseCustomPropertiesCreate(d *schema.ResourceData, meta
 
 	_, _, err := client.Enterprise.CreateOrUpdateCustomProperty(ctx, enterpriseSlug, propertyName, property)
 	if err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
 	d.SetId(buildTwoPartID(enterpriseSlug, propertyName))
-	return resourceGithubEnterpriseCustomPropertiesRead(d, meta)
+	return resourceGithubEnterpriseCustomPropertiesRead(ctx, d, meta)
 }
 
-func resourceGithubEnterpriseCustomPropertiesRead(d *schema.ResourceData, meta any) error {
+func resourceGithubEnterpriseCustomPropertiesRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
 	client := meta.(*Owner).v3client
-	ctx := context.Background()
 
 	enterpriseSlug, propertyName, err := parseTwoPartID(d.Id(), "enterprise_slug", "property_name")
 	if err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
 	property, resp, err := client.Enterprise.GetCustomProperty(ctx, enterpriseSlug, propertyName)
@@ -108,54 +106,74 @@ func resourceGithubEnterpriseCustomPropertiesRead(d *schema.ResourceData, meta a
 			d.SetId("")
 			return nil
 		}
-		return err
+		return diag.FromErr(err)
 	}
 
 	defaultValue, _ := property.DefaultValueString()
 
-	d.SetId(buildTwoPartID(enterpriseSlug, propertyName))
-	_ = d.Set("enterprise_slug", enterpriseSlug)
-	_ = d.Set("property_name", property.GetPropertyName())
-	_ = d.Set("value_type", string(property.ValueType))
-	_ = d.Set("required", property.GetRequired())
-	_ = d.Set("default_value", defaultValue)
-	_ = d.Set("description", property.GetDescription())
-	_ = d.Set("allowed_values", property.AllowedValues)
-	_ = d.Set("values_editable_by", property.GetValuesEditableBy())
+	if err := d.Set("enterprise_slug", enterpriseSlug); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("property_name", property.GetPropertyName()); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("value_type", string(property.ValueType)); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("required", property.GetRequired()); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("default_value", defaultValue); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("description", property.GetDescription()); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("allowed_values", property.AllowedValues); err != nil {
+		return diag.FromErr(err)
+	}
+	if err := d.Set("values_editable_by", property.GetValuesEditableBy()); err != nil {
+		return diag.FromErr(err)
+	}
 
 	return nil
 }
 
-func resourceGithubEnterpriseCustomPropertiesUpdate(d *schema.ResourceData, meta any) error {
+func resourceGithubEnterpriseCustomPropertiesUpdate(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
 	client := meta.(*Owner).v3client
-	ctx := context.Background()
 
 	enterpriseSlug, propertyName, err := parseTwoPartID(d.Id(), "enterprise_slug", "property_name")
 	if err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
 	property := buildEnterpriseCustomProperty(d)
 
 	_, _, err = client.Enterprise.CreateOrUpdateCustomProperty(ctx, enterpriseSlug, propertyName, property)
 	if err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
-	return resourceGithubEnterpriseCustomPropertiesRead(d, meta)
+	return resourceGithubEnterpriseCustomPropertiesRead(ctx, d, meta)
 }
 
-func resourceGithubEnterpriseCustomPropertiesDelete(d *schema.ResourceData, meta any) error {
+func resourceGithubEnterpriseCustomPropertiesDelete(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
 	client := meta.(*Owner).v3client
-	ctx := context.Background()
 
 	enterpriseSlug, propertyName, err := parseTwoPartID(d.Id(), "enterprise_slug", "property_name")
 	if err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
-	_, err = client.Enterprise.RemoveCustomProperty(ctx, enterpriseSlug, propertyName)
-	return err
+	resp, err := client.Enterprise.RemoveCustomProperty(ctx, enterpriseSlug, propertyName)
+	if err != nil {
+		if resp != nil && resp.StatusCode == http.StatusNotFound {
+			return nil
+		}
+		return diag.FromErr(err)
+	}
+
+	return nil
 }
 
 func resourceGithubEnterpriseCustomPropertiesImport(d *schema.ResourceData, meta any) ([]*schema.ResourceData, error) {
@@ -164,8 +182,12 @@ func resourceGithubEnterpriseCustomPropertiesImport(d *schema.ResourceData, meta
 		return nil, err
 	}
 
-	_ = d.Set("enterprise_slug", enterpriseSlug)
-	_ = d.Set("property_name", propertyName)
+	if err := d.Set("enterprise_slug", enterpriseSlug); err != nil {
+		return nil, err
+	}
+	if err := d.Set("property_name", propertyName); err != nil {
+		return nil, err
+	}
 
 	return []*schema.ResourceData{d}, nil
 }