Fix: have a good default for approval flow on workflows #1029

TomerHeber · 2025-03-30T14:43:59Z

Issue & Steps to Reproduce / Feature Request

Solution

During creating isWorkflow is decided based on the template type instead of the sub_environment_configuration.
When updating schema - ignore "approve_plan_automatically" if not set in schema - this is a cleaner solution.
Applied minor updates to acceptance tests.

Copilot

Pull Request Overview

This PR updates the default approval flow logic for workflows by basing the workflow decision on the template type and refactoring the environment creation logic. In addition, it updates test expectations and acceptance tests to better align with these changes.

Update test expectations for Template calls and workflow type checks.
Refactor environment creation into separate functions for template and templateless environments.
Adjust approval field update logic and payload generation based on the workflow type.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
env0/resource_environment_test.go	Revised test expectations for Template calls and workflow type constant
env0/resource_environment.go	Refactored environment creation and payload functions with updated approval flow logic

Comments suppressed due to low confidence (2)

env0/resource_environment_test.go:2442

Verify that increasing the expected Template call from 1 to 2 is intentional and that the test covers all interactions to avoid future brittle behavior.

mock.EXPECT().Template(environment.LatestDeploymentLog.BlueprintId).Times(2).Return(template, nil)

env0/resource_environment.go:1040

[nitpick] Confirm that determining the workflow status solely based on the template type covers all expected scenarios, particularly if additional types may be introduced later.

isWorkflow := templateType == client.WORKFLOW

TomerHeber · 2025-03-30T14:45:09Z

/review

Copilot

Pull Request Overview

This PR improves the default behavior for the approval flow in workflow environments by basing decisions on the template type and providing a cleaner update mechanism. Key changes include:

Using template.Type instead of sub_environment_configuration to determine workflow environments.
Ignoring "approve_plan_automatically" when not set in the schema.
Splitting environment creation logic into separate functions for templated and templateless environments, with accompanying updates to acceptance tests and CI workflows.

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

File	Description
env0/resource_environment_test.go	Updated test expectations to match new workflow logic
env0/resource_environment.go	Refactored environment creation & validation logic for workflows
env0/data_environment.go	Adjusted data reading to reflect the new approval default
.github/workflows/*.yml	Updated CI configuration to use Ubuntu 24.04

Comments suppressed due to low confidence (2)

env0/resource_environment_test.go:2442

Please confirm that the increased expectation from Times(1) to Times(2) for the Template call is intentional based on the new workflow logic, and update the test case description if necessary.

mock.EXPECT().Template(environment.LatestDeploymentLog.BlueprintId).Times(2).Return(template, nil)

env0/resource_environment.go:1044

[nitpick] Ensure that using the equality check (templateType == client.WORKFLOW) reliably distinguishes workflow environments. If there are alternative representations for workflow environments, consider normalizing the input to avoid misclassification.

isWorkflow := templateType == client.WORKFLOW

eranelbaz · 2025-04-21T08:45:45Z

.github/workflows/ci.yml

@@ -72,4 +72,4 @@ jobs:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Run Harness tests
-        run: go run tests/harness.go
+        run: go run tests/harness.go


Add empty line in the end

eranelbaz · 2025-04-21T08:46:37Z

env0/resource_environment.go

Those are a lot of changes for the approval flow, can you explain what did you do here?

yes. the change is a litte complex.

TomerHeber · 2025-04-21T12:05:53Z

env0/resource_environment.go

@@ -550,20 +550,66 @@ func createVariable(configurationVariable *client.ConfigurationVariable) any {
 }

 // Validate that the template is assigned to the "project_id".
-func validateTemplateProjectAssignment(d *schema.ResourceData, apiClient client.ApiClientInterface) error {
+func validateTemplateProjectAssignment(d *schema.ResourceData, template *client.Template) error {


need the template in one of the upper functions, so here instead of getting it we pass it here.
we get it from the upper functions.

TomerHeber · 2025-04-21T12:06:04Z

env0/resource_environment.go

+	return nil
+}
+
+func createEnvironmentWithTemplate(d *schema.ResourceData, apiClient client.ApiClientInterface) (client.Environment, client.EnvironmentCreate, diag.Diagnostics) {
 	templateId := d.Get("template_id").(string)

 	template, err := apiClient.Template(templateId)


this is why this part was removed.

TomerHeber · 2025-04-21T12:07:02Z

env0/resource_environment.go

+	return nil
+}
+
+func createEnvironmentWithTemplate(d *schema.ResourceData, apiClient client.ApiClientInterface) (client.Environment, client.EnvironmentCreate, diag.Diagnostics) {


we have two usecases.
template and envrionment seperate resources.
template + environment one resource.
previousuly it was an if-else in the code. now it's two helper functions with a if-else.

TomerHeber · 2025-04-21T12:07:46Z

env0/resource_environment.go

 	}

-	return nil
+	environmentPayload, diagError := getCreatePayload(d, apiClient, template.Type)


we pass the template.Type - with this we set a better default.

TomerHeber · 2025-04-21T12:08:32Z

env0/resource_environment.go

+	return environment, environmentPayload, nil
+}
+
+func createEnvironmentWithoutTemplate(d *schema.ResourceData, apiClient client.ApiClientInterface) (client.Environment, client.EnvironmentCreate, diag.Diagnostics) {


helper function 2 - environment + template together.

TomerHeber · 2025-04-21T12:09:28Z

env0/resource_environment.go

+	// Note: the blueprint id field of the environment is returned only during creation of a template without environment.
+	// Afterward, it will be omitted from future response.
+	// setEnvironmentSchema() sets the blueprint id in the resource (under "without_template_settings.0.id").
+	environment, err := apiClient.EnvironmentCreateWithoutTemplate(payload)


the payload contains the template details which means it contains the template Type which we need for better defaults.

TomerHeber · 2025-04-21T12:10:00Z

env0/resource_environment.go


-		environment, err = apiClient.EnvironmentCreate(environmentPayload)
+	if !isTemplateless(d) {


this is the if-else where we call the two helper functions.

TomerHeber · 2025-04-21T12:11:26Z

env0/resource_environment.go

@@ -1016,7 +1041,7 @@ func getCreatePayload(d *schema.ResourceData, apiClient client.ApiClientInterfac
 		payload.AutoDeployOnPathChangesOnly = boolPtr(val.(bool))
 	}

-	_, isWorkflow := d.GetOk("sub_environment_configuration")
+	isWorkflow := templateType == client.WORKFLOW


and finally we decide if it's a workflow based on the templateType.
if isWorkflow is True, defaults will be set as needed. This code already exist.
The change is - we decide if it's a workflow based on the template type instead of checking if sub_environment_configuration exist.

TomerHeber · 2025-04-21T12:29:40Z

env0/resource_environment.go

-	// Don't update this value for workflow environments - this value should always be 'false'.
-	if _, isWorkflow := d.GetOk("sub_environment_configuration"); !isWorkflow && environment.RequiresApproval != nil {
+	//nolint:staticcheck // https://github.com/hashicorp/terraform-plugin-sdk/issues/817
+	if _, exists := d.GetOkExists("approve_plan_automatically"); exists && environment.RequiresApproval != nil {


only make changes to approve_plan_automatically if someone has set a value for it.
it's tri-boolean value.
undefined, true, and false.

TomerHeber · 2025-04-21T12:36:23Z

env0/resource_environment.go

+	return nil
+}
+
+func createEnvironmentWithTemplate(d *schema.ResourceData, apiClient client.ApiClientInterface) (client.Environment, client.EnvironmentCreate, diag.Diagnostics) {


environemnt and template - seperate resources use-case.

eranelbaz

After talking seems ok to me
note name suggestions

env0/resource_environment.go

TomerHeber · 2025-04-28T14:54:02Z

@eranelbaz - going to merge. If you still want to make naming changes let me know and I create an additional PR. But note that I've used common naming conventions.

TomerHeber self-assigned this Mar 30, 2025

TomerHeber requested a review from Copilot March 30, 2025 14:44

github-actions bot added fix provider labels Mar 30, 2025

TomerHeber added the pending final review label Mar 30, 2025

Copilot AI reviewed Mar 30, 2025

View reviewed changes

bot-env0 requested a review from a team March 30, 2025 14:45

github-actions bot added the github-actions label Apr 1, 2025

TomerHeber requested a review from Copilot April 2, 2025 13:33

Copilot AI reviewed Apr 2, 2025

View reviewed changes

yaronya requested a review from weinguy-env0 April 16, 2025 08:40

github-actions bot added the dependency-change label Apr 17, 2025

TomerHeber added 8 commits April 16, 2025 19:53

Fix: have a good default for approval flow on workflows

bfec33b

fix linting issues

a29264b

fix bug

154bf19

update ubuntu

2da53fc

add terraform

2bb8754

add terraform

8c011fd

increase time

ecf9761

update go.mod

9705a36

TomerHeber force-pushed the fix-default-for-workflow-#1023 branch from f4782e9 to 9705a36 Compare April 17, 2025 00:54

no changes to ci

19ba1ad

weinguy-env0 requested review from yaronya and removed request for weinguy-env0 April 20, 2025 08:45

eranelbaz reviewed Apr 21, 2025

View reviewed changes

TomerHeber commented Apr 21, 2025

View reviewed changes

yaronya requested a review from eranelbaz April 28, 2025 12:10

Merge branch 'main' into fix-default-for-workflow-#1023

232e894

eranelbaz approved these changes Apr 28, 2025

View reviewed changes

env0/resource_environment.go Show resolved Hide resolved

env0/resource_environment.go Show resolved Hide resolved

env0/resource_environment.go Show resolved Hide resolved

github-actions bot added ready to merge PR approved - can be merged once the PR owner is ready and removed pending final review labels Apr 28, 2025

TomerHeber merged commit aa97a86 into main Apr 28, 2025
9 checks passed

TomerHeber deleted the fix-default-for-workflow-#1023 branch April 28, 2025 14:54


		environment, err = apiClient.EnvironmentCreate(environmentPayload)
		if !isTemplateless(d) {

Fix: have a good default for approval flow on workflows #1029

Fix: have a good default for approval flow on workflows #1029

Uh oh!

Conversation

TomerHeber commented Mar 30, 2025

Issue & Steps to Reproduce / Feature Request

Solution

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

TomerHeber commented Mar 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eranelbaz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TomerHeber commented Apr 28, 2025

Uh oh!

Uh oh!

Uh oh!