fix: Refactor repository custom property (#3476)

* fix: Refactor repository custom property

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>

* fixup! fix: Refactor repository custom property

* fixup! fix: Refactor repository custom property

* fixup! fix: Refactor repository custom property

* fixup! fix: Refactor repository custom property

* fixup! fix: Refactor repository custom property

* fixup! fix: Refactor repository custom property

---------

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>

Author: stevehipwell

ARCHITECTURE.md

@@ -178,7 +178,10 @@ func resourceGithubExample() *schema.Resource {
             StateContext: resourceGithubExampleImport,
         },
 
-        // Include SchemaVersion and StateUpgraders if state migrations exist
+        // Only if required.
+        CustomizeDiff: diffExample,
+
+        // Include SchemaVersion and StateUpgraders if state migrations exist.
         SchemaVersion: 1,
         StateUpgraders: []schema.StateUpgrader{
             {
@@ -188,8 +191,10 @@ func resourceGithubExample() *schema.Resource {
             },
         },
 
+        Description: "Manages an example GitHub resource.",
+
         Schema: map[string]*schema.Schema{
-            // Schema definition
+            // Schema definition.
         },
     }
 }

docs/resources/repository_custom_property.md

@@ -1,45 +1,62 @@
 ---
 page_title: "github_repository_custom_property (Resource) - GitHub"
+subcategory: ""
 description: |-
-  Creates and a specific custom property for a GitHub repository
+  Resource to manage GitHub repository custom properties.
 ---
 
 # github_repository_custom_property (Resource)
 
-This resource allows you to create and manage a specific custom property for a GitHub repository.
+Resource to manage GitHub repository custom properties.
+For more information, see the [GitHub API documentation](https://docs.github.com/rest/metadata/custom-properties#create-or-update-repository-custom-property).
 
 ## Example Usage
 
-> Note that this assumes there already is a custom property defined on the org level called `my-cool-property` of type `string`
-
 ```terraform
+# NOTE: This assumes there already is a custom property defined on the org level called `my-cool-string` of type `string`
+
 resource "github_repository" "example" {
   name        = "example"
   description = "My awesome codebase"
 }
-resource "github_repository_custom_property" "string" {
+
+resource "github_repository_custom_property" "example" {
   repository     = github_repository.example.name
-  property_name  = "my-cool-property"
+  property_name  = "my-cool-string"
   property_type  = "string"
   property_value = ["test"]
 }
 ```
 
-## Argument Reference
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-The following arguments are supported:
+### Required
 
-- `repository` - (Required) The repository of the environment.
+- `property_name` (String) Name of the custom property.
+- `property_type` (String) Type of the custom property. Valid values are `string`, `single_select`, `multi_select`, `true_false`, and `url`.
+- `property_value` (Set of String) Value of the custom property. For `string`, `single_select`, `true_false`, and `url` property types, this should be a single value. For `multi_select` property types, this can be multiple values.
+- `repository` (String) Name of the repository.
 
-- `property_type` - (Required) Type of the custom property. Can be one of `single_select`, `multi_select`, `string`, or `true_false`
+### Read-Only
 
-- `property_name` - (Required) Name of the custom property. Note that a pre-requisiste for this resource is that a custom property of this name has already been defined on the organization level
-
-- `property_value` - (Required) Value of the custom property in the form of an array. Properties of type `single_select`, `string`, and `true_false` are represented as a string array of length 1
+- `id` (String) The ID of this resource.
+- `repository_id` (Number) ID of the repository.
 
 ## Import
 
-GitHub Repository Custom Property can be imported using an ID made up of a combination of the names of the organization, repository, custom property separated by a `:` character, e.g.
+Import is supported using the following syntax:
+
+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_repository_custom_property.example
+  id = "organization-name:repo-name:custom-property-name"
+}
+```
+
+The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
 
 ```shell
 terraform import github_repository_custom_property.example organization-name:repo-name:custom-property-name

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

@@ -0,0 +1,4 @@
+import {
+  to = github_repository_custom_property.example
+  id = "organization-name:repo-name:custom-property-name"
+}

examples/resources/github_repository_custom_property/import.sh

@@ -0,0 +1 @@
+terraform import github_repository_custom_property.example organization-name:repo-name:custom-property-name

examples/resources/github_repository_custom_property/resource_1.tf

@@ -0,0 +1,13 @@
+# NOTE: This assumes there already is a custom property defined on the org level called `my-cool-string` of type `string`
+
+resource "github_repository" "example" {
+  name        = "example"
+  description = "My awesome codebase"
+}
+
+resource "github_repository_custom_property" "example" {
+  repository     = github_repository.example.name
+  property_name  = "my-cool-string"
+  property_type  = "string"
+  property_value = ["test"]
+}

examples/resources/repository_custom_property/example_1.tf

@@ -0,0 +1,106 @@
+package github
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"testing"
+
+	"github.com/google/go-github/v88/github"
+	"github.com/hashicorp/terraform-plugin-testing/helper/acctest"
+)
+
+const testRandomIDLength = 5
+
+func mustGetTestMockResponse(t *testing.T, uri string, statusCode int, body any) *mockResponse {
+	resp := &mockResponse{
+		ExpectedUri: uri,
+		StatusCode:  statusCode,
+	}
+
+	if body != nil {
+		bodyBytes, err := json.Marshal(body)
+		if err != nil {
+			t.Fatalf("failed to marshal mock response body: %v", err)
+		}
+		resp.ResponseBody = string(bodyBytes)
+	}
+
+	return resp
+}
+
+func mustCreateTestGitHubClient(t *testing.T, baseURL string, opts ...github.ClientOptionsFunc) *github.Client {
+	client, err := github.NewClient(append([]github.ClientOptionsFunc{github.WithURLs(&baseURL, nil)}, opts...)...)
+	if err != nil {
+		t.Fatalf("failed to create GitHub client: %s", err)
+	}
+	return client
+}
+
+func mustCreateTestOrganizationRepositoryCustomProperty(t *testing.T, valType string, allowed []string) *github.CustomProperty {
+	t.Helper()
+
+	meta, err := getTestMeta()
+	if err != nil {
+		t.Fatalf("failed to get test meta: %v", err)
+	}
+
+	randomID := acctest.RandString(testRandomIDLength)
+	name := fmt.Sprintf("%s%s", testResourcePrefix, randomID)
+
+	req := &github.CustomProperty{
+		PropertyName:  &name,
+		ValueType:     github.PropertyValueType(valType),
+		AllowedValues: allowed,
+	}
+
+	prop, _, err := meta.v3client.Organizations.CreateOrUpdateCustomProperty(t.Context(), meta.name, name, req)
+	if err != nil {
+		t.Fatalf("failed to create test organization repository custom property: %v", err)
+	}
+
+	t.Cleanup(func() {
+		if _, err := meta.v3client.Organizations.RemoveCustomProperty(context.Background(), meta.name, name); err != nil {
+			if err, ok := errors.AsType[*github.ErrorResponse](err); ok && err.Response.StatusCode == 404 {
+				return
+			}
+			t.Logf("failed to delete test organization repository custom property %s: %v", name, err)
+		}
+	})
+
+	return prop
+}
+
+func mustCreateTestRepository(t *testing.T) *github.Repository {
+	t.Helper()
+
+	meta, err := getTestMeta()
+	if err != nil {
+		t.Fatalf("failed to get test meta: %v", err)
+	}
+
+	randomID := acctest.RandString(testRandomIDLength)
+	name := fmt.Sprintf("%s%s", testResourcePrefix, randomID)
+
+	req := &github.Repository{
+		Name:     &name,
+		AutoInit: new(true),
+	}
+
+	repo, _, err := meta.v3client.Repositories.Create(t.Context(), meta.name, req)
+	if err != nil {
+		t.Fatalf("failed to create test repository: %v", err)
+	}
+
+	t.Cleanup(func() {
+		if _, err := meta.v3client.Repositories.Delete(context.Background(), meta.name, name); err != nil {
+			if err, ok := errors.AsType[*github.ErrorResponse](err); ok && err.Response.StatusCode == 404 {
+				return
+			}
+			t.Logf("failed to delete test repository %s: %v", name, err)
+		}
+	})
+
+	return repo
+}

github/acc_helpers_test.go

@@ -32,7 +32,7 @@ func TestAccGithubAppTokenDataSource(t *testing.T) {
 		})
 		defer ts.Close()
 
-		client := mustGitHubClient(t, ts.URL)
+		client := mustCreateTestGitHubClient(t, ts.URL)
 
 		meta := &Owner{
 			name:     owner,

github/data_source_github_app_token_test.go

@@ -0,0 +1,43 @@
+package github
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/google/go-github/v88/github"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+)
+
+// migrateRepositoryWithID is a helper function to migrate a raw state where the repository is set to make usre that the repository_id is added to the state.
+func migrateRepositoryWithID(ctx context.Context, client *github.Client, owner string, rawState map[string]any) (map[string]any, error) {
+	tflog.Debug(ctx, "Migrating state to add repository_id.")
+
+	repoNameVal, ok := rawState["repository"]
+	if !ok {
+		return nil, fmt.Errorf("repository name not found in state")
+	}
+
+	repoName, ok := repoNameVal.(string)
+	if !ok {
+		return nil, fmt.Errorf("repository name is not a string")
+	}
+
+	if repoID, ok := rawState["repository_id"]; ok {
+		if _, ok := repoID.(int); ok {
+			tflog.Debug(ctx, "Found repository_id in state, skipping migration.", map[string]any{"repository": repoName, "repository_id": repoID})
+			return rawState, nil
+		}
+	}
+
+	repo, _, err := client.Repositories.Get(ctx, owner, repoName)
+	if err != nil {
+		return nil, fmt.Errorf("failed to retrieve repository %s: %w", repoName, err)
+	}
+
+	repoID := int(repo.GetID())
+	rawState["repository_id"] = repoID
+
+	tflog.Debug(ctx, "State migrated to add repository_id.", map[string]any{"repository": repoName, "repository_id": repoID})
+
+	return rawState, nil
+}