feat: add import functionality for GitHub enterprise ruleset and update documentation

Author: Ravio1i

github/resource_github_enterprise_ruleset.go

@@ -3,6 +3,7 @@ package github
 import (
 	"context"
 	"errors"
+	"fmt"
 	"net/http"
 	"strconv"
 
@@ -22,6 +23,10 @@ func resourceGithubEnterpriseRuleset() *schema.Resource {
 		UpdateContext: resourceGithubEnterpriseRulesetUpdate,
 		DeleteContext: resourceGithubEnterpriseRulesetDelete,
 
+		Importer: &schema.ResourceImporter{
+			StateContext: resourceGithubEnterpriseRulesetImport,
+		},
+
 		CustomizeDiff: resourceGithubEnterpriseRulesetCustomizeDiff,
 
 		Schema: map[string]*schema.Schema{
@@ -958,3 +963,40 @@ func resourceGithubEnterpriseRulesetDelete(ctx context.Context, d *schema.Resour
 	return nil
 }
 
+func resourceGithubEnterpriseRulesetImport(ctx context.Context, d *schema.ResourceData, meta any) ([]*schema.ResourceData, error) {
+	enterpriseSlug, rulesetIDStr, err := parseTwoPartID(d.Id(), "enterprise_slug", "ruleset_id")
+	if err != nil {
+		return []*schema.ResourceData{d}, err
+	}
+
+	rulesetID, err := strconv.ParseInt(rulesetIDStr, 10, 64)
+	if err != nil {
+		return []*schema.ResourceData{d}, unconvertibleIdErr(rulesetIDStr, err)
+	}
+	if rulesetID == 0 {
+		return []*schema.ResourceData{d}, fmt.Errorf("`ruleset_id` must be present")
+	}
+
+	tflog.Debug(ctx, "Importing enterprise ruleset", map[string]any{
+		"enterprise_slug": enterpriseSlug,
+		"ruleset_id":      rulesetID,
+	})
+
+	client := meta.(*Owner).v3client
+
+	ruleset, _, err := client.Enterprise.GetRepositoryRuleset(ctx, enterpriseSlug, rulesetID)
+	if ruleset == nil || err != nil {
+		return []*schema.ResourceData{d}, err
+	}
+
+	d.SetId(strconv.FormatInt(ruleset.GetID(), 10))
+	_ = d.Set("enterprise_slug", enterpriseSlug)
+
+	tflog.Info(ctx, "Imported enterprise ruleset", map[string]any{
+		"enterprise_slug": enterpriseSlug,
+		"ruleset_id":      rulesetID,
+	})
+
+	return []*schema.ResourceData{d}, nil
+}
+

github/resource_github_enterprise_ruleset_test.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 )
 
 func TestAccGithubEnterpriseRuleset_basic(t *testing.T) {
@@ -766,3 +767,77 @@ resource "github_enterprise_ruleset" "test" {
 	})
 }
 
+
+func TestAccGithubEnterpriseRuleset_import(t *testing.T) {
+	randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
+	rulesetName := fmt.Sprintf("%s-enterprise-import-%s", testResourcePrefix, randomID)
+
+	rulesetHCL := `
+		resource "github_enterprise_ruleset" "test" {
+			enterprise_slug = "%s"
+			name            = "%s"
+			target          = "branch"
+			enforcement     = "active"
+
+			conditions {
+				organization_name {
+					include = ["~ALL"]
+					exclude = []
+				}
+
+				repository_name {
+					include = ["~ALL"]
+					exclude = []
+				}
+
+				ref_name {
+					include = ["~ALL"]
+					exclude = []
+				}
+			}
+
+			rules {
+				creation = true
+			}
+		}
+		`
+	config := fmt.Sprintf(rulesetHCL, testAccConf.enterpriseSlug, rulesetName)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { skipUnlessEnterprise(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: config,
+			},
+			{
+				ResourceName:            "github_enterprise_ruleset.test",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateIdFunc:       importEnterpriseRulesetByResourcePath("github_enterprise_ruleset.test"),
+				ImportStateVerifyIgnore: []string{"etag"},
+			},
+		},
+	})
+}
+
+func importEnterpriseRulesetByResourcePath(rulesetLogicalName string) resource.ImportStateIdFunc {
+	return func(s *terraform.State) (string, error) {
+		ruleset := s.RootModule().Resources[rulesetLogicalName]
+		if ruleset == nil {
+			return "", fmt.Errorf("Cannot find %s in terraform state", rulesetLogicalName)
+		}
+
+		rulesetID := ruleset.Primary.ID
+		if rulesetID == "" {
+			return "", fmt.Errorf("ruleset %s does not have an id in terraform state", rulesetLogicalName)
+		}
+
+		enterpriseSlug := ruleset.Primary.Attributes["enterprise_slug"]
+		if enterpriseSlug == "" {
+			return "", fmt.Errorf("ruleset %s does not have enterprise_slug in terraform state", rulesetLogicalName)
+		}
+
+		return fmt.Sprintf("%s:%s", enterpriseSlug, rulesetID), nil
+	}
+}

website/docs/r/enterprise_ruleset.html.markdown

@@ -599,8 +599,8 @@ The following additional attributes are exported:
 
 ## Import
 
-GitHub Enterprise Rulesets can be imported using the enterprise slug and ruleset ID in the format `{enterprise_slug}/{ruleset_id}`, e.g.
+GitHub Enterprise Rulesets can be imported using the enterprise slug and ruleset ID in the format `{enterprise_slug}:{ruleset_id}`, e.g.
 
 ```sh
-terraform import github_enterprise_ruleset.example my-enterprise/12345
+terraform import github_enterprise_ruleset.example my-enterprise:12345
 ```