Add exclude_tags to data_source_workspace_ids

[Uk1288]

Description

Currently the list of Workspaces within an Organization can be filtered with tag_names to include. This PR adds the ability to exclude workspaces by tags using theexclude_tags parameter.

See usecase here: #393

Remember to:

• Update the Change Log

• Update the Documentation

Testing plan

1. Create an organization
2. Create workspaces with tags within the organization
3. Filtering workspaces using the exclude_tags options, should list all matching workspaces excluding those with the excluded tags.
4. See example block below:

resource "tfe_organization" "foobar" {
  name  = "tst-terraform-1"
  email = "admin@company.com"
}
resource "tfe_workspace" "foo" {
  name         = "workspace-foo-1"
  organization = tfe_organization.foobar.id
  tag_names    = ["good", "happy"]
}
resource "tfe_workspace" "bar" {
  name         = "workspace-bar-1"
  organization = tfe_organization.foobar.id
  tag_names    = ["good"]
}
data "tfe_workspace_ids" "good" {
  tag_names    = ["good"]
  exclude_tags    = ["happy"]
  organization = tfe_workspace.foo.organization
  depends_on = [
    tfe_workspace.foo,
    tfe_workspace.bar
  ]
}

External links

Include any links here that might be helpful for people reviewing your PR. If there are none, feel free to delete this section.

• go-tfe documentation
• API documentation
• Related PR

Output from acceptance tests

Please run applicable acceptance tests locally and include the output here. See TESTS.md to learn how to run acceptance tests.

If you are an external contributor, your contribution(s) will first be reviewed before running them against the project's CI pipeline.

$ TESTARGS="-run TestAccTFEWorkspace" make testacc

=== RUN   TestAccTFEWorkspaceIDsDataSource_basic
--- PASS: TestAccTFEWorkspaceIDsDataSource_basic (9.51s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_wildcard
--- PASS: TestAccTFEWorkspaceIDsDataSource_wildcard (11.21s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_tags
--- PASS: TestAccTFEWorkspaceIDsDataSource_tags (9.77s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_searchByTagAndName
--- PASS: TestAccTFEWorkspaceIDsDataSource_searchByTagAndName (8.96s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_empty
--- PASS: TestAccTFEWorkspaceIDsDataSource_empty (1.42s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_namesEmpty
--- PASS: TestAccTFEWorkspaceIDsDataSource_namesEmpty (8.94s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_excludeTags
--- PASS: TestAccTFEWorkspaceIDsDataSource_excludeTags (14.33s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_sameTagInTagNamesAndExcludeTags
--- PASS: TestAccTFEWorkspaceIDsDataSource_sameTagInTagNamesAndExcludeTags (10.58s)
PASS

[brandonc]

OK, unfortunately, some versions of TFE that we support will not have the "exclude_tags" field for awhile, so we have to provide a fallback as well. That means excluding workspaces if they contain excluded tags when building up the list of ids.

My feedback was addressed but I didn't have a chance to smoke test this PR

[annawinkler]

I reached out to @sudomateo about testing this PR with the last TFE. Maybe we could do that tomorrow? cc @sebasslash

[sebasslash]

Smoke tested ✅ Overall code changes look 🔥 with some really minor things below ⬇️

[sebasslash]

exclude_tags should be Type: schema.TypeSet since the order of the tags to exclude does not matter.

[sebasslash]

Good catch 👍

[sebasslash]

Looks like there's some extra spaces here

[faithlum]

Tested with a TFE instance that does not support exclude_tags to check if any other elements would break due to the change.

1. With exclude_tags included: argument not supported as expected (CLI & VCS)

2. Without exclude_tags included: tfe_workspace resources were still successfully created without error

[sebasslash]

🕺