Refactor flattenRules and expandRules to use context

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

Author: deiga

github/resource_github_organization_ruleset.go

@@ -654,7 +654,7 @@ func resourceGithubOrganizationRulesetCreate(ctx context.Context, d *schema.Reso
 	_ = d.Set("ruleset_id", ruleset.ID)
 	_ = d.Set("node_id", ruleset.GetNodeID())
 	_ = d.Set("etag", resp.Header.Get("ETag"))
-	_ = d.Set("rules", flattenRules(ruleset.Rules, true))
+	_ = d.Set("rules", flattenRules(ctx, ruleset.Rules, true))
 
 	tflog.Info(ctx, fmt.Sprintf("Created organization ruleset: %s/%s (ID: %d)", owner, name, *ruleset.ID), map[string]any{
 		"owner":      owner,
@@ -721,8 +721,8 @@ func resourceGithubOrganizationRulesetRead(ctx context.Context, d *schema.Resour
 	_ = d.Set("target", ruleset.GetTarget())
 	_ = d.Set("enforcement", ruleset.Enforcement)
 	_ = d.Set("bypass_actors", flattenBypassActors(ruleset.BypassActors))
-	_ = d.Set("conditions", flattenConditionsWithContext(ctx, ruleset.GetConditions(), true))
-	_ = d.Set("rules", flattenRules(ruleset.Rules, true))
+	_ = d.Set("conditions", flattenConditions(ctx, ruleset.GetConditions(), true))
+	_ = d.Set("rules", flattenRules(ctx, ruleset.Rules, true))
 	_ = d.Set("node_id", ruleset.GetNodeID())
 	_ = d.Set("etag", resp.Header.Get("ETag"))
 

github/resource_github_organization_ruleset_test.go

@@ -889,7 +889,7 @@ func TestOrganizationPushRulesetSupport(t *testing.T) {
 	}
 
 	// Test flatten functionality (organization rulesets use org=true)
-	flattenedResult := flattenRules(expandedRules, true)
+	flattenedResult := flattenRules(t.Context(), expandedRules, true)
 
 	if len(flattenedResult) != 1 {
 		t.Fatalf("Expected 1 flattened result, got %d", len(flattenedResult))

github/resource_github_repository_ruleset.go

@@ -657,7 +657,7 @@ func resourceGithubRepositoryRulesetCreate(ctx context.Context, d *schema.Resour
 	_ = d.Set("ruleset_id", ruleset.ID)
 	_ = d.Set("node_id", ruleset.GetNodeID())
 	_ = d.Set("etag", resp.Header.Get("ETag"))
-	_ = d.Set("rules", flattenRules(ruleset.Rules, false))
+	_ = d.Set("rules", flattenRules(ctx, ruleset.Rules, false))
 
 	return nil
 }
@@ -704,8 +704,8 @@ func resourceGithubRepositoryRulesetRead(ctx context.Context, d *schema.Resource
 	_ = d.Set("target", ruleset.GetTarget())
 	_ = d.Set("enforcement", ruleset.Enforcement)
 	_ = d.Set("bypass_actors", flattenBypassActors(ruleset.BypassActors))
-	_ = d.Set("conditions", flattenConditions(ruleset.GetConditions(), false))
-	_ = d.Set("rules", flattenRules(ruleset.Rules, false))
+	_ = d.Set("conditions", flattenConditions(ctx, ruleset.GetConditions(), false))
+	_ = d.Set("rules", flattenRules(ctx, ruleset.Rules, false))
 	_ = d.Set("node_id", ruleset.GetNodeID())
 	_ = d.Set("etag", resp.Header.Get("ETag"))
 

github/util_rules.go

@@ -2,7 +2,6 @@ package github
 
 import (
 	"context"
-	"log"
 	"reflect"
 	"sort"
 
@@ -219,11 +218,7 @@ func expandConditions(input []any, org bool) *github.RepositoryRulesetConditions
 	return rulesetConditions
 }
 
-func flattenConditions(conditions *github.RepositoryRulesetConditions, org bool) []any {
-	return flattenConditionsWithContext(context.TODO(), conditions, org)
-}
-
-func flattenConditionsWithContext(ctx context.Context, conditions *github.RepositoryRulesetConditions, org bool) []any {
+func flattenConditions(ctx context.Context, conditions *github.RepositoryRulesetConditions, org bool) []any {
 	if conditions == nil || reflect.DeepEqual(conditions, &github.RepositoryRulesetConditions{}) {
 		tflog.Debug(ctx, "Conditions are empty, returning empty list")
 		return []any{}
@@ -537,7 +532,7 @@ func expandRules(input []any, org bool) *github.RepositoryRulesetRules {
 	return rulesetRules
 }
 
-func flattenRules(rules *github.RepositoryRulesetRules, org bool) []any {
+func flattenRules(ctx context.Context, rules *github.RepositoryRulesetRules, org bool) []any {
 	if rules == nil {
 		return []any{}
 	}
@@ -582,7 +577,7 @@ func flattenRules(rules *github.RepositoryRulesetRules, org bool) []any {
 			"required_review_thread_resolution": rules.PullRequest.RequiredReviewThreadResolution,
 			"allowed_merge_methods":             rules.PullRequest.AllowedMergeMethods,
 		})
-		log.Printf("[DEBUG] Flattened Pull Request rules slice: %#v", pullRequestSlice)
+		tflog.Debug(ctx, "Flattened Pull Request rules slice", map[string]any{"pull_request": pullRequestSlice})
 		rulesMap["pull_request"] = pullRequestSlice
 	}
 

github/util_rules_test.go

@@ -57,7 +57,7 @@ func TestFlattenRulesBasicRules(t *testing.T) {
 		NonFastForward:        &github.EmptyRuleParameters{},
 	}
 
-	result := flattenRules(rules, false)
+	result := flattenRules(t.Context(), rules, false)
 
 	if len(result) != 1 {
 		t.Fatalf("Expected 1 element in result, got %d", len(result))
@@ -126,7 +126,7 @@ func TestFlattenRulesMaxFilePathLength(t *testing.T) {
 		},
 	}
 
-	result := flattenRules(rules, false)
+	result := flattenRules(t.Context(), rules, false)
 
 	if len(result) != 1 {
 		t.Fatalf("Expected 1 element in result, got %d", len(result))
@@ -167,7 +167,7 @@ func TestRoundTripMaxFilePathLength(t *testing.T) {
 	}
 
 	// Flatten back to terraform format
-	flattenedResult := flattenRules(expandedRules, false)
+	flattenedResult := flattenRules(t.Context(), expandedRules, false)
 
 	if len(flattenedResult) != 1 {
 		t.Fatalf("Expected 1 flattened result, got %d", len(flattenedResult))
@@ -224,7 +224,7 @@ func TestFlattenRulesMaxFileSize(t *testing.T) {
 		},
 	}
 
-	result := flattenRules(rules, false)
+	result := flattenRules(t.Context(), rules, false)
 
 	if len(result) != 1 {
 		t.Fatalf("Expected 1 element in result, got %d", len(result))
@@ -292,7 +292,7 @@ func TestFlattenRulesFileExtensionRestriction(t *testing.T) {
 		},
 	}
 
-	result := flattenRules(rules, false)
+	result := flattenRules(t.Context(), rules, false)
 
 	if len(result) != 1 {
 		t.Fatalf("Expected 1 element in result, got %d", len(result))
@@ -372,7 +372,7 @@ func TestCompletePushRulesetSupport(t *testing.T) {
 	}
 
 	// Flatten back to terraform format
-	flattenedResult := flattenRules(expandedRules, false)
+	flattenedResult := flattenRules(t.Context(), expandedRules, false)
 
 	if len(flattenedResult) != 1 {
 		t.Fatalf("Expected 1 flattened result, got %d", len(flattenedResult))
@@ -452,7 +452,7 @@ func TestCopilotCodeReviewRoundTrip(t *testing.T) {
 	}
 
 	// Flatten back to terraform format
-	flattenedResult := flattenRules(expandedRules, false)
+	flattenedResult := flattenRules(t.Context(), expandedRules, false)
 
 	if len(flattenedResult) != 1 {
 		t.Fatalf("Expected 1 flattened result, got %d", len(flattenedResult))
@@ -485,7 +485,7 @@ func TestFlattenConditions_PushRuleset_WithRepositoryNameOnly(t *testing.T) {
 		},
 	}
 
-	result := flattenConditions(conditions, true) // org=true for organization rulesets
+	result := flattenConditions(t.Context(), conditions, true) // org=true for organization rulesets
 
 	if len(result) != 1 {
 		t.Fatalf("Expected 1 conditions block, got %d", len(result))
@@ -531,7 +531,7 @@ func TestFlattenConditions_BranchRuleset_WithRefNameAndRepositoryName(t *testing
 		},
 	}
 
-	result := flattenConditions(conditions, true) // org=true for organization rulesets
+	result := flattenConditions(t.Context(), conditions, true) // org=true for organization rulesets
 
 	if len(result) != 1 {
 		t.Fatalf("Expected 1 conditions block, got %d", len(result))
@@ -599,7 +599,7 @@ func TestFlattenConditions_PushRuleset_WithRepositoryIdOnly(t *testing.T) {
 		},
 	}
 
-	result := flattenConditions(conditions, true) // org=true for organization rulesets
+	result := flattenConditions(t.Context(), conditions, true) // org=true for organization rulesets
 
 	if len(result) != 1 {
 		t.Fatalf("Expected 1 conditions block, got %d", len(result))