feat: updated gateway rule action audit ssh and rule properties

[rexscaria]

No breaking changes. Just updating some new api properties.

Closes #2316

[github-actions]

changelog detected ✅

[jacobbednarz]

i added some comments inline but do sing out if you have any questions/issues.

once you're ready, you'll also want to run make docs to generate the automatic registry documentation.

[rexscaria]

@jacobbednarz All suggestions are applied and doc generated. Thanks

[jacobbednarz]

i think we may need to do some work here as the test suite is failing for non-tenants.

=== RUN   TestAccCloudflareTeamsRuleBasic
    resource_cloudflare_teams_rules_test.go:26: Step 1/1 error: Error running apply: exit status 1

        Error: error creating Teams rule for account "f037e56e89293a057740de681ac9abbe": Bypass settings cannot be set for non-tenant accounts (2020)

          with cloudflare_teams_rule.piflgoxaaq,
          on terraform_plugin_test.tf line 2, in resource "cloudflare_teams_rule" "piflgoxaaq":
           2: resource "cloudflare_teams_rule" "piflgoxaaq" {

--- FAIL: TestAccCloudflareTeamsRuleBasic (6.25s)
FAIL
FAIL	github.com/cloudflare/terraform-provider-cloudflare/internal/sdkv2provider	7.484s

which means a large portion of the user base will be broken if we merge and release this. we'll need the fields to be conditionally sent only if they are specified in the config.

[rexscaria]

Yes that's right. I will fix it tomorrow.

On Tue, Mar 21, 2023 at 8:11 PM Jacob Bednarz ***@***.***> wrote: i think we may need to do some work here as the test suite is failing for non-tenants. === RUN TestAccCloudflareTeamsRuleBasic resource_cloudflare_teams_rules_test.go:26: Step 1/1 error: Error running apply: exit status 1 Error: error creating Teams rule for account "f037e56e89293a057740de681ac9abbe": Bypass settings cannot be set for non-tenant accounts (2020) with cloudflare_teams_rule.piflgoxaaq, on terraform_plugin_test.tf line 2, in resource "cloudflare_teams_rule" "piflgoxaaq": 2: resource "cloudflare_teams_rule" "piflgoxaaq" { --- FAIL: TestAccCloudflareTeamsRuleBasic (6.25s) FAIL FAIL github.com/cloudflare/terraform-provider-cloudflare/internal/sdkv2provider 7.484s which means a large portion of the user base will be broken if we merge and release this. we'll need the fields to be conditionally sent only if they are specified in the config. — Reply to this email directly, view it on GitHub <#2303 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFN7RE4YZIXF7SUCPCQ4HTW5I7R5ANCNFSM6AAAAAAWBGAKNY> . You are receiving this because you authored the thread.Message ID: ***@***.*** com>

-- *Arun Scaria | ***@***.*** ***@***.***> | ***@***.*** ***@***.***> | +1-480-628-9203*

[rexscaria]

i think we may need to do some work here as the test suite is failing for non-tenants.

=== RUN   TestAccCloudflareTeamsRuleBasic
    resource_cloudflare_teams_rules_test.go:26: Step 1/1 error: Error running apply: exit status 1

        Error: error creating Teams rule for account "f037e56e89293a057740de681ac9abbe": Bypass settings cannot be set for non-tenant accounts (2020)

          with cloudflare_teams_rule.piflgoxaaq,
          on terraform_plugin_test.tf line 2, in resource "cloudflare_teams_rule" "piflgoxaaq":
           2: resource "cloudflare_teams_rule" "piflgoxaaq" {

--- FAIL: TestAccCloudflareTeamsRuleBasic (6.25s)
FAIL
FAIL	github.com/cloudflare/terraform-provider-cloudflare/internal/sdkv2provider	7.484s

which means a large portion of the user base will be broken if we merge and release this. we'll need the fields to be conditionally sent only if they are specified in the config.

How exactly did you run this test? I feel like I am missing some account credentials when i run this

[jacobbednarz]

you can run make testacc which initiates the acceptance test suite. you will need additional environment variables that the acceptance test will prompt you for (like CLOUDFLARE_ZONE_ID, etc).

my usual invocation looks like this (minus some env vars) - TEST="./internal/sdkv2provider" TESTARGS='-run "^TestAccCloudflareTeamsRuleBasic"' make testacc

[jacobbednarz]

i think the part of the issue is that even though the values are being sent as false but the service is not expecting it to be defined at all.

request

{
  "name": "gdruuwmzcg",
  "description": "desc",
  "precedence": 12302004,
  "enabled": false,
  "action": "block",
  "filters": [
    "dns"
  ],
  "traffic": "any(dns.domains[*] == \"example.com\")",
  "identity": "",
  "device_posture": "",
  "version": 0,
  "rule_settings": {
    "override_ips": null,
    "block_reason": "cuz",
    "override_host": "",
    "biso_admin_controls": null,
    "l4override": null,
    "add_headers": {},
    "check_session": null,
    "block_page_enabled": false,
    "insecure_disable_dnssec_validation": false,
    "egress": {
      "ipv6": "2001:db8::/32",
      "ipv4": "203.0.113.1",
      "ipv4_fallback": ""
    },
    "payload_log": {
      "enabled": true
    },
    "audit_ssh": null,
    "ip_categories": false,
    "allow_child_bypass": false,
    "bypass_parent_rule": false,
    "untrusted_cert": {
      "action": "error"
    }
  }
}

response

{
  "result": null,
  "success": false,
  "errors": [
    {
      "code": 2020,
      "message": "Bypass settings cannot be set for non-tenant accounts"
    }
  ],
  "messages": []
}

[jacobbednarz]

with the latest cloudflare-go changes shimmed in, this looks much better, thanks! once that lands, i'll update this branch and we can get it merged in.

[rexscaria]

Thanks Jacob.

[jacobbednarz]

acceptance tests all passing

TF_ACC=1 go test ./internal/sdkv2provider -v -run "^TestAccCloudflareTeamsRuleBasic" -timeout 120m -parallel 1
=== RUN   TestAccCloudflareTeamsRuleBasic
--- PASS: TestAccCloudflareTeamsRuleBasic (13.14s)
PASS
ok  	github.com/cloudflare/terraform-provider-cloudflare/internal/sdkv2provider	14.168s

[github-actions]

This functionality has been released in v4.3.0 of the Terraform Cloudflare Provider.

Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!