[fix] Fixes for org and repo rulesets

Author: nickfloyd

github/resource_github_organization_ruleset.go

@@ -43,7 +43,6 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
 				ValidateFunc: validation.StringInSlice([]string{"disabled", "active", "evaluate"}, false),
 				Description:  "Possible values for Enforcement are `disabled`, `active`, `evaluate`. Note: `evaluate` is currently only supported for owners of type `organization`.",
 			},
-
 			"bypass_actors": {
 				Type:        schema.TypeList,
 				Optional:    true,
@@ -63,11 +62,12 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
 						},
 						"bypass_mode": {
 							Type:         schema.TypeString,
-							Optional:     true,
+							Required:     true,
 							ValidateFunc: validation.StringInSlice([]string{"always", "pull_request"}, false),
 							Description:  "When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: `always`, `pull_request`.",
 						},
-					}},
+					},
+				},
 			},
 			"node_id": {
 				Type:        schema.TypeString,
@@ -118,7 +118,7 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
 							ConflictsWith: []string{"conditions.0.repository_id"},
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
-									"inlcude": {
+									"include": {
 										Type:        schema.TypeList,
 										Required:    true,
 										Description: "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.",
@@ -137,6 +137,7 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
 									"protected": {
 										Type:        schema.TypeBool,
 										Optional:    true,
+										Default:     false,
 										Description: "Whether renaming of target repositories is prevented.",
 									},
 								},
@@ -145,7 +146,6 @@ func resourceGithubOrganizationRuleset() *schema.Resource {
 						"repository_id": {
 							Type:          schema.TypeList,
 							Optional:      true,
-							MaxItems:      1,
 							ConflictsWith: []string{"conditions.0.repository_name"},
 							Description:   "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.",
 							Elem: &schema.Schema{

github/resource_github_repository_ruleset.go

@@ -67,7 +67,7 @@ func resourceGithubRepositoryRuleset() *schema.Resource {
 						},
 						"bypass_mode": {
 							Type:         schema.TypeString,
-							Optional:     true,
+							Required:     true,
 							ValidateFunc: validation.StringInSlice([]string{"always", "pull_request"}, false),
 							Description:  "When the specified actor can bypass the ruleset. pull_request means that an actor can only bypass rules on pull requests. Can be one of: `always`, `pull_request`.",
 						},

github/respository_rules_utils.go

@@ -3,6 +3,7 @@ package github
 import (
 	"encoding/json"
 	"log"
+	"sort"
 
 	"github.com/google/go-github/v55/github"
 	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
@@ -54,7 +55,6 @@ func expandBypassActors(input []interface{}) []*github.BypassActor {
 		}
 		bypassActors = append(bypassActors, actor)
 	}
-
 	return bypassActors
 }
 
@@ -63,7 +63,11 @@ func flattenBypassActors(bypassActors []*github.BypassActor) []interface{} {
 		return []interface{}{}
 	}
 
-	actorsSlice := make([]map[string]interface{}, 0)
+	sort.SliceStable(bypassActors, func(i, j int) bool {
+		return bypassActors[i].GetActorID() > bypassActors[j].GetActorID()
+	})
+
+	actorsSlice := make([]interface{}, 0)
 	for _, v := range bypassActors {
 		actorMap := make(map[string]interface{})
 
@@ -74,7 +78,7 @@ func flattenBypassActors(bypassActors []*github.BypassActor) []interface{} {
 		actorsSlice = append(actorsSlice, actorMap)
 	}
 
-	return []interface{}{actorsSlice}
+	return actorsSlice
 }
 
 func expandConditions(input []interface{}, org bool) *github.RulesetConditions {
@@ -110,7 +114,7 @@ func expandConditions(input []interface{}, org bool) *github.RulesetConditions {
 
 	// org-only fields
 	if org {
-		// repository_name
+		// repository_name and repository_id
 		if v, ok := inputConditions["repository_name"].([]interface{}); ok && v != nil && len(v) != 0 {
 			inputRepositoryName := v[0].(map[string]interface{})
 			include := make([]string, 0)
@@ -135,10 +139,7 @@ func expandConditions(input []interface{}, org bool) *github.RulesetConditions {
 				Exclude:   exclude,
 				Protected: &protected,
 			}
-		}
-
-		// repository_id
-		if v, ok := inputConditions["repository_id"].([]interface{}); ok && v != nil {
+		} else if v, ok := inputConditions["repository_id"].([]interface{}); ok && v != nil && len(v) != 0 {
 			repositoryIDs := make([]int64, 0)
 
 			for _, v := range v {
@@ -174,10 +175,16 @@ func flattenConditions(conditions *github.RulesetConditions, org bool) []interfa
 		repositoryNameSlice := make([]map[string]interface{}, 0)
 
 		if conditions.RepositoryName != nil {
+			var protected bool
+
+			if conditions.RepositoryName.Protected != nil {
+				protected = *conditions.RepositoryName.Protected
+			}
+
 			repositoryNameSlice = append(repositoryNameSlice, map[string]interface{}{
 				"include":   conditions.RepositoryName.Include,
 				"exclude":   conditions.RepositoryName.Exclude,
-				"protected": *conditions.RepositoryName.Protected,
+				"protected": protected,
 			})
 			conditionsMap["repository_name"] = repositoryNameSlice
 		}
@@ -351,16 +358,25 @@ func flattenRules(rules []*github.RepositoryRule, org bool) []interface{} {
 
 		case "commit_message_pattern", "commit_author_email_pattern", "committer_email_pattern", "branch_name_pattern", "tag_name_pattern":
 			var params github.RulePatternParameters
+			var name string
+			var negate bool
 
 			err := json.Unmarshal(*v.Parameters, &params)
 			if err != nil {
 				log.Printf("[INFO] Unexpected error unmarshalling rule %s with parameters: %v",
 					v.Type, v.Parameters)
 			}
 
+			if params.Name != nil {
+				name = *params.Name
+			}
+			if params.Negate != nil {
+				negate = *params.Negate
+			}
+
 			rule := make(map[string]interface{})
-			rule["name"] = *params.Name
-			rule["negate"] = *params.Negate
+			rule["name"] = name
+			rule["negate"] = negate
 			rule["operator"] = params.Operator
 			rule["pattern"] = params.Pattern
 			rulesMap[v.Type] = []map[string]interface{}{rule}

website/docs/r/organization_ruleset.html.markdown

@@ -203,7 +203,7 @@ One of `repository_id` and `repository_name` must be set for the rule to target
 
 * `exclude` - (Required) (List of String) Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.
 
-* `inlcude` - (Required) (List of String) Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
+* `include` - (Required) (List of String) Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.
 
 ## Attributes Reference