resource/cloudflare_ruleset: add 'ignore' to cache rules query_string

[jafowler]

Add the 'ignore' field to cache rules 'query_string'. This replaces 'exclude = "*"'.

[github-actions]

changelog detected ✅

[jafowler]

depends on cloudflare/cloudflare-go#1140

[jafowler]

I'll need to update the logic to transform this ignore = true/false into exclude = [*]/include = [*]

[jafowler]

i cherry picked dependabots bump of cloudflare-go into this PR so i can make the additional changes i needed. We can wait to merge this until after the dependency bump PR goes through.

[jacobbednarz]

you shouldn't need to cherry pick in version bumps as we do them in a way that once it is merged, you can rebase in master and everything works without weird dependencies between branches.

[jacobbednarz]

can you please add test coverage for this new schema field and run make docs to generate the updated documentation?

[jafowler]

@jacobbednarz I believe this is good to go now.

[jacobbednarz]

cool! will run the acceptance tests later today and get this merged.

[jacobbednarz]

running the tests shows that we aren't setting the ignore key correctly

TF_ACC=1 go test $(go list ./...) -v -run "^TestAccCloudflareRuleset_CacheSettings" -count 1 -parallel 1 -timeout 120m -parallel 1
?   	github.com/cloudflare/terraform-provider-cloudflare	[no test files]
=== RUN   TestAccCloudflareRuleset_CacheSettingsFull
=== PAUSE TestAccCloudflareRuleset_CacheSettingsFull
=== RUN   TestAccCloudflareRuleset_CacheSettingsOptionalsEmpty
=== PAUSE TestAccCloudflareRuleset_CacheSettingsOptionalsEmpty
=== RUN   TestAccCloudflareRuleset_CacheSettingsOptionalCacheKeys
=== PAUSE TestAccCloudflareRuleset_CacheSettingsOptionalCacheKeys
=== RUN   TestAccCloudflareRuleset_CacheSettingsQueryStringIgnoreTrue
=== PAUSE TestAccCloudflareRuleset_CacheSettingsQueryStringIgnoreTrue
=== RUN   TestAccCloudflareRuleset_CacheSettingsIgnoreQueryStringFalse
=== PAUSE TestAccCloudflareRuleset_CacheSettingsIgnoreQueryStringFalse
=== CONT  TestAccCloudflareRuleset_CacheSettingsFull
    resource_cloudflare_ruleset_test.go:1551: Step 1/1 error: Check failed: Check 21/38 error: cloudflare_ruleset.jgdfglzysx: Attribute 'rules.0.action_parameters.0.cache_key.0.custom_key.0.query_string.0.ignore' not found
--- FAIL: TestAccCloudflareRuleset_CacheSettingsFull (9.28s)
=== CONT  TestAccCloudflareRuleset_CacheSettingsQueryStringIgnoreTrue
    resource_cloudflare_ruleset_test.go:1698: Step 1/1 error: Check failed: Check 9/9 error: cloudflare_ruleset.zjvajibhgf: Attribute 'rules.0.action_parameters.0.cache_key.0.custom_key.0.query_string.0.ignore' not found
--- FAIL: TestAccCloudflareRuleset_CacheSettingsQueryStringIgnoreTrue (7.64s)
=== CONT  TestAccCloudflareRuleset_CacheSettingsIgnoreQueryStringFalse
    resource_cloudflare_ruleset_test.go:1728: Step 1/1 error: Check failed: Check 9/9 error: cloudflare_ruleset.giltygcddz: Attribute 'rules.0.action_parameters.0.cache_key.0.custom_key.0.query_string.0.ignore' not found
--- FAIL: TestAccCloudflareRuleset_CacheSettingsIgnoreQueryStringFalse (7.03s)
=== CONT  TestAccCloudflareRuleset_CacheSettingsOptionalCacheKeys
--- PASS: TestAccCloudflareRuleset_CacheSettingsOptionalCacheKeys (10.20s)
=== CONT  TestAccCloudflareRuleset_CacheSettingsOptionalsEmpty
--- PASS: TestAccCloudflareRuleset_CacheSettingsOptionalsEmpty (10.55s)

the transformation is missing from https://github.com/cloudflare/terraform-provider-cloudflare/blob/master/internal/provider/resource_cloudflare_ruleset.go#L1078-L1103 but at the same time, we aren't actually setting a key anywhere for rules.0.action_parameters.0.cache_key.0.custom_key.0.query_string.0.ignore, should we be? what is the intended use of this? i'm not seeing this in the API response so a little confused as to what we're intending to happen here.

[jafowler]

Using ignore was what we used to do for cache page rules. Basically anytime include = "*" or exclude = "*" we would return ignore = false or ignore = true.

Right now, the cache ruleset can return a couple of different responses.
ignore all query params

"rules": [
      {
        "id": "f809a6d15f65450ea004efe8d4ea295d",
        "version": "1",
        "action": "set_cache_settings",
        "expression": "(http.host eq \"example.com\")",
        "description": "test",
        "last_updated": "2022-12-14T11:49:22.4216Z",
        "ref": "f809a6d15f65450ea004efe8d4ea295d",
        "enabled": true,
        "action_parameters": {
          "cache": true,
          "cache_key": {
            "custom_key": {
              "query_string": {
                "exclude": "*"
              }
            }
          }
        }
      }
    ],

include all query params

    "rules": [
      {
        "id": "f809a6d15f65450ea004efe8d4ea295d",
        "version": "2",
        "action": "set_cache_settings",
        "expression": "(http.host eq \"example.com")",
        "description": "test",
        "last_updated": "2022-12-14T11:55:25.526402Z",
        "ref": "f809a6d15f65450ea004efe8d4ea295d",
        "enabled": true,
        "action_parameters": {
          "cache": true,
          "cache_key": {
            "custom_key": {
              "query_string": {
                "include": "*"
              }
            }
          }
        }
      }
    ],

The response can also have a list of query strings to include or exclude.
The overarching problem is that the type cannot be both a string and a list. So i had thought that by re-implementing the ignore field in the provider, and allowing cf-terraforming to transform the api response from include = * to ignore = false (and vise versa).

[jafowler]

Taking another look at this, i think i'm making this more complicated than it needs to be. I think this could be completely handled in cf-terraforming by transform the response from include = "*" to include =["*"].