Feature/add trigger patterns #502

matejrisek · 2022-05-20T13:11:47Z

Description

We're introducing a new field to the workspace model. The field is called trigger-patterns and it is meant to be another way of defining when to trigger a run based on file changes. It is mutually exclusive with trigger-prefixes which is reflect in the provider, as well as on the backend.

Remember to:

Update the Change Log
Update the Documentation

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.

Asana

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.

omarismail · 2022-05-20T14:16:19Z

tfe/data_source_workspace_test.go

+  file_triggers_enabled = true
+  trigger_patterns      = ["/modules/**/*", "/**/network/*"]
+  working_directory     = "terraform/test"
+}


Although this technically works as a data source test, it would be better to just only the data source. The way to do this is in the test itself TestAccTFEWorkspaceDataSource_with_trigger_patterns, to use the go-tfe client to create a workspace with the trigger patterns, then pass that workspace.name and org.name here in this testAccTFEWorkspaceDataSourceConfigWithTriggerPatterns config to be used as strings in the data source fields (name and organization). Then continue with verifying that the data is the same.

This way you also don't need a depends_on.

omarismail · 2022-05-20T14:18:27Z

tfe/resource_tfe_workspace.go

-		for _, tp := range tps.([]interface{}) {
-			if t, ok := tp.(string); ok {
-				options.TriggerPrefixes = append(options.TriggerPrefixes, t)
+	if d.HasChange("trigger_prefixes") {


This HasChange is needed in create function?

Yeah, good point, we'd need https://github.com/hashicorp/go-tfe/pull/410/files merged for that

tfe/resource_tfe_workspace_test.go

…version in tests

omarismail · 2022-05-31T12:49:41Z

tfe/resource_tfe_workspace.go

+			}
+		} else {
+			options.TriggerPatterns = []string{}
+		}


So now we've handled all the potential data conflicts over on the API side?

These tests should prove that since they're hitting the real thing :-)

Yeah on backend we allow for the presence of both trigger-patterns and trigger-prefixes at the same time, but both cannot be populated.

tfe/resource_tfe_workspace_test.go

omarismail

just one test comment, otherwise LGTM

matejrisek · 2022-06-01T11:20:52Z

website/docs/d/workspace.html.markdown

@@ -52,6 +52,7 @@ In addition to all arguments above, the following attributes are exported:
 * `tag_names` - The names of tags added to this workspace.
 * `terraform_version` - The version (or version constraint) of Terraform used for this workspace.
 * `trigger_prefixes` - List of repository-root-relative paths which describe all locations to be tracked for changes.
+* `trigger_patterns` - List of repository-root-relative GLOB patterns which describe all locations to be tracked for changes.


We should probably link to a page explaining GLOB patterns being used here.
We also need the GLOB page for the UI changes currently in work, so once we decide what to link I'll add it here as well.

# Conflicts: # go.mod # go.sum # website/docs/r/workspace.html.markdown

laurapacilio · 2022-07-05T14:42:42Z

website/docs/r/workspace.html.markdown

@@ -12,6 +12,8 @@ Provides a workspace resource.

 ~> **NOTE:** Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1.

+~> **NOTE:** Using `trigger-patterns` requires using the provider with Terraform Cloud.


I wonder if we could put this under the actual trigger patterns bullet? I also wonder if it needs to be a note, or if we could incorporate it into the bullet text. The reason why is that I'm thinking it'd be easy for someone to kind of skip right to the available attributes and miss this note. I think it'd be more helpful for users to see the information about its requirements in context:

"trigger_prefixes - (Optional) List of prefixes that describe the paths Terraform Cloud monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository. Terraform Cloud or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes. Mutually exclusive with trigger-patterns. Only available for Terraform Cloud."

Good point -> 8a22a37

laurapacilio · 2022-07-05T14:45:01Z

website/docs/d/workspace.html.markdown

+* `trigger_prefixes` - List of trigger prefixes that describe the paths Terraform Cloud monitors for changes, in addition to the working directory. Trigger prefixes are always appended to the root directory of the repository.
+  Terraform Cloud or Terraform Enterprise will start a run when files are changed in any directory path matching the provided set of prefixes.
+* `trigger_patterns` - List of glob patterns that describe the files Terraform Cloud monitors for changes. Trigger patterns are always appended to the root directory of the repository.


Do we also need to say here that the prefixes are only available for Terraform Cloud?

Also - and feel free to push back here because I don't want to go against what we typically do in these docs, but do we ever provide links to the documentation where folks can find out more about these? Like. wonder if the patterns section could benefit from a link to that new glob patterns section you're adding onto the actual VCS settings page?

I'll link it once the Atlas documentation is published. This will not be merged for few days at least. Thanks for the suggestion.

annawinkler · 2022-07-05T15:19:21Z

Does the changelog need to be updated also?

annawinkler

Thank you for submitting this PR! I think we want to update the Changelog too.

matejrisek · 2022-07-06T10:24:40Z

Does the changelog need to be updated also?

@annawinkler sure, thanks for the reminder. 7232415

I think I'll have to update it with a link to glob patterns once the Atlas documentation is published

# Conflicts: # website/docs/r/workspace.html.markdown

annawinkler · 2022-07-07T17:35:31Z

Note: this feature is already in GA. It's in TFC UI and API docs

annawinkler · 2022-07-07T18:50:00Z

@omarismail This PR is a little hard for folks to test without testing instructions. Wondering if you could contribute a few bullet points?

Things that I've collected:

We've got this related go-tfe PR
The API docs are here

omarismail · 2022-07-07T19:02:56Z

Testing Plan

Create a new config with

terraform {
  required_providers {
    tfe = {
      version = "~> 0.25.0"
    }
  }
}

provider "tfe" {
  hostname = "app.terraform.io"
  token    = "<atlas-token>"
}

resource "tfe_organization" "foobar" {
  name  = "tst-terraform-random-name"
  email = "admin@company.com"
}
resource "tfe_workspace" "foobar" {
  name             = "workspace-test"
  organization     = tfe_organization.foobar.id
  auto_apply       = true
  trigger_prefixes = []
}

Then terraform apply it.
Then go into TFC -> Newly created workspace -> Settings. Validate that the trigger_prefixes are empty
Then modify the config resource "tfe_workspace" "foobar" { to be

resource "tfe_workspace" "foobar" {
  name             = "workspace-test"
  organization     = tfe_organization.foobar.id
  auto_apply       = true
  trigger_prefixes = ["submodules/**"]
}

then terraform apply it.
Then go back into that same Worksapce -> Settings and verify that the trigger_prefixes are set to "submodules/**"
Then remove the field trigger_prefixes from the tfe_workspace resource, and go back to Workspace Settings to verify its removed.

annawinkler · 2022-07-07T19:12:12Z

For folks who test, make sure you follow the steps to build the provider manually, then update the dev overrides in your .terraformrc:

provider_installation {
  dev_overrides {
    "hashicorp/tfe" = "/Users/YOURNAME/go/bin"
  }
  direct {}
}

annawinkler

🌟 Looks good! Thank you for the testing steps. Let's make sure to squash the commits.

This reverts commit 33de91d.

matejrisek added 5 commits May 19, 2022 15:26

WIP

aba159f

Add initial tests

86c46a6

Merge branch 'main' into feature/add-trigger-patterns

2f3c66c

Add trigger-patterns to data source

c59474c

Add trigger-patterns conflicting test

3c21d01

matejrisek requested a review from a team May 20, 2022 13:11

omarismail reviewed May 20, 2022

View reviewed changes

tfe/resource_tfe_workspace_test.go Show resolved Hide resolved

omarismail reviewed May 20, 2022

View reviewed changes

tfe/resource_tfe_workspace_test.go Show resolved Hide resolved

matejrisek added 5 commits May 23, 2022 14:08

Use client to create workspace in order to test datasource

fd75979

Address PR comments around tests

bfe5602

Update go-tfe version

50354e8

Attempt on addressing unrelated changes caused by bumping the go-tfe …

5801d3f

…version in tests

Remove additional check for the presence of fields

23397ee

matejrisek requested a review from omarismail May 30, 2022 13:03

omarismail reviewed May 31, 2022

View reviewed changes

tfe/resource_tfe_workspace_test.go Show resolved Hide resolved

omarismail approved these changes May 31, 2022

View reviewed changes

Add additional test verification

76619f9

omarismail approved these changes May 31, 2022

View reviewed changes

Update documentation

75e0169

matejrisek commented Jun 1, 2022

View reviewed changes

sebasslash added the feature-flag Features that sit behind a feature flag label Jun 1, 2022

matejrisek added 5 commits July 4, 2022 15:11

Merge branch 'main' into feature/add-trigger-patterns

c6bb9db

# Conflicts: # go.mod # go.sum # website/docs/r/workspace.html.markdown

Update doc

4a08571

Update doc

1ebec4c

Update documentation for trigger patterns and prefixes

16c89be

Update documentation for trigger patterns and prefixes

c8acc3e

laurapacilio reviewed Jul 5, 2022

View reviewed changes

annawinkler suggested changes Jul 5, 2022

View reviewed changes

omarismail approved these changes Jul 5, 2022

View reviewed changes

matejrisek added 3 commits July 6, 2022 12:13

Address PR comment

8a22a37

Initial Changelog entry

0ca900f

Add PR link

7232415

matejrisek added 6 commits July 6, 2022 16:53

Update changelog

3a33ec8

Add links

2b22efa

Merge branch 'main' into feature/add-trigger-patterns

5b72c99

# Conflicts: # website/docs/r/workspace.html.markdown

Add back newline

4abe99d

Reorder tag names by alphabet

d3770ca

Fix

0419be5

sebasslash removed the feature-flag Features that sit behind a feature flag label Jul 7, 2022

annawinkler approved these changes Jul 8, 2022

View reviewed changes

omarismail merged commit 33de91d into main Jul 8, 2022

omarismail deleted the feature/add-trigger-patterns branch July 8, 2022 16:12

matejrisek added a commit that referenced this pull request Jul 20, 2022

Revert "Feature/add trigger patterns (#502)"

71175a9

This reverts commit 33de91d.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/add trigger patterns #502

Feature/add trigger patterns #502

matejrisek commented May 20, 2022 •

edited

Loading

omarismail May 20, 2022

omarismail May 20, 2022

matejrisek May 23, 2022 •

edited

Loading

omarismail May 31, 2022

matejrisek May 31, 2022

omarismail left a comment

matejrisek Jun 1, 2022

laurapacilio Jul 5, 2022

matejrisek Jul 6, 2022

laurapacilio Jul 5, 2022

matejrisek Jul 6, 2022

annawinkler commented Jul 5, 2022

annawinkler left a comment

matejrisek commented Jul 6, 2022

annawinkler commented Jul 7, 2022

annawinkler commented Jul 7, 2022

omarismail commented Jul 7, 2022 •

edited

Loading

annawinkler commented Jul 7, 2022

annawinkler left a comment

		@@ -12,6 +12,8 @@ Provides a workspace resource.

		~> NOTE: Using `global_remote_state` or `remote_state_consumer_ids` requires using the provider with Terraform Cloud or an instance of Terraform Enterprise at least as recent as v202104-1.

		~> NOTE: Using `trigger-patterns` requires using the provider with Terraform Cloud.

Feature/add trigger patterns #502

Feature/add trigger patterns #502

Conversation

matejrisek commented May 20, 2022 • edited Loading

Description

External links

Output from acceptance tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matejrisek May 23, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

omarismail left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

annawinkler commented Jul 5, 2022

annawinkler left a comment

Choose a reason for hiding this comment

matejrisek commented Jul 6, 2022

annawinkler commented Jul 7, 2022

annawinkler commented Jul 7, 2022

omarismail commented Jul 7, 2022 • edited Loading

Testing Plan

annawinkler commented Jul 7, 2022

annawinkler left a comment

Choose a reason for hiding this comment

matejrisek commented May 20, 2022 •

edited

Loading

matejrisek May 23, 2022 •

edited

Loading

omarismail commented Jul 7, 2022 •

edited

Loading