Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CUSTESC-29915: unify output for rules without rule settings #2532

Merged
merged 6 commits into from
Jun 16, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/2532.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
resource/cloudflare_teams_rules.go: unify output for rules without rule settings
jacobbednarz marked this conversation as resolved.
Show resolved Hide resolved
```
21 changes: 21 additions & 0 deletions internal/sdkv2provider/resource_cloudflare_teams_rules.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,11 @@ func resourceCloudflareTeamsRuleRead(ctx context.Context, d *schema.ResourceData
if err := d.Set("version", int64(rule.Version)); err != nil {
return diag.FromErr(fmt.Errorf("error parsing rule version"))
}

if err := d.Set("rule_settings", flattenTeamsRuleSettings(&rule.RuleSettings)); err != nil {
return diag.FromErr(fmt.Errorf("error parsing rule settings"))
}

return nil
}

Expand Down Expand Up @@ -196,6 +198,25 @@ func resourceCloudflareTeamsRuleImport(ctx context.Context, d *schema.ResourceDa
}

func flattenTeamsRuleSettings(settings *cloudflare.TeamsRuleSettings) []interface{} {
if len(settings.OverrideIPs) == 0 &&
settings.BlockReason == "" &&
settings.OverrideHost == "" &&
settings.BISOAdminControls == nil &&
settings.L4Override == nil &&
len(settings.AddHeaders) == 0 &&
settings.CheckSession == nil &&
settings.BlockPageEnabled == false &&
settings.InsecureDisableDNSSECValidation == false &&
settings.EgressSettings == nil &&
settings.UntrustedCertSettings == nil &&
settings.PayloadLog == nil &&
settings.IPCategories == false &&
settings.AllowChildBypass == nil &&
settings.BypassParentRule == nil &&
settings.AuditSSH == nil {
return nil
}

result := map[string]interface{}{
"block_page_enabled": settings.BlockPageEnabled,
"block_page_reason": settings.BlockReason,
Expand Down
56 changes: 55 additions & 1 deletion internal/sdkv2provider/resource_cloudflare_teams_rules_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
"github.com/hashicorp/terraform-plugin-testing/terraform"
)

func TestAccCloudflareTeamsRuleBasic(t *testing.T) {
func TestAccCloudflareTeamsRule_Basic(t *testing.T) {
// Temporarily unset CLOUDFLARE_API_TOKEN if it is set as the Access
// service does not yet support the API tokens and it results in
// misleading state error messages.
Expand Down Expand Up @@ -41,6 +41,7 @@ func TestAccCloudflareTeamsRuleBasic(t *testing.T) {
resource.TestCheckResourceAttr(name, "action", "block"),
resource.TestCheckResourceAttr(name, "filters.0", "dns"),
resource.TestCheckResourceAttr(name, "traffic", "any(dns.domains[*] == \"example.com\")"),
resource.TestCheckResourceAttr(name, "rule_settings.#", "1"),
resource.TestCheckResourceAttr(name, "rule_settings.0.block_page_enabled", "false"),
resource.TestCheckResourceAttr(name, "rule_settings.0.block_page_reason", "cuz"),
resource.TestCheckResourceAttr(name, "rule_settings.0.insecure_disable_dnssec_validation", "false"),
Expand Down Expand Up @@ -83,6 +84,59 @@ resource "cloudflare_teams_rule" "%[1]s" {
`, rnd, accountID)
}

func TestAccCloudflareTeamsRule_NoSettings(t *testing.T) {
// Temporarily unset CLOUDFLARE_API_TOKEN if it is set as the Access
// service does not yet support the API tokens and it results in
// misleading state error messages.
if os.Getenv("CLOUDFLARE_API_TOKEN") != "" {
t.Setenv("CLOUDFLARE_API_TOKEN", "")
}

rnd := generateRandomResourceName()
name := fmt.Sprintf("cloudflare_teams_rule.%s", rnd)

resource.Test(t, resource.TestCase{
PreCheck: func() {
testAccPreCheck(t)
testAccPreCheck(t)
},
ProviderFactories: providerFactories,
CheckDestroy: testAccCheckCloudflareTeamsRuleDestroy,
Steps: []resource.TestStep{
{
Config: testAccCloudflareTeamsRuleConfigBasic(rnd, accountID),
},
{
Config: testAccCloudflareTeamsRuleConfigNoSettings(rnd, accountID),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(name, consts.AccountIDSchemaKey, accountID),
resource.TestCheckResourceAttr(name, "name", rnd),
resource.TestCheckResourceAttr(name, "description", "desc"),
resource.TestCheckResourceAttr(name, "precedence", "12302"),
resource.TestCheckResourceAttr(name, "action", "block"),
resource.TestCheckResourceAttr(name, "filters.0", "dns"),
resource.TestCheckResourceAttr(name, "traffic", "any(dns.domains[*] == \"example.com\")"),
resource.TestCheckResourceAttr(name, "rule_settings.#", "0"),
),
},
},
})
}

func testAccCloudflareTeamsRuleConfigNoSettings(rnd, accountID string) string {
return fmt.Sprintf(`
resource "cloudflare_teams_rule" "%[1]s" {
name = "%[1]s"
account_id = "%[2]s"
description = "desc"
precedence = 12302
action = "block"
filters = ["dns"]
traffic = "any(dns.domains[*] == \"example.com\")"
}
`, rnd, accountID)
}

func testAccCheckCloudflareTeamsRuleDestroy(s *terraform.State) error {
client := testAccProvider.Meta().(*cloudflare.API)

Expand Down