Add drift handling #226

samuel-br · 2022-02-17T08:29:50Z

Issue & Steps to Reproduce / Feature Request

fixes #225

Solution

Add check if deleted in read function to determine if drift happened , and invoke destroy that remove the resource from the state, instead of throwing error

yaronya

Nice work @samuel-br
Left some comments/questions

Please also see my comments about the missing test case. It looks like you're missing this tests in all relevant resources

env0/resource_cloud_credentials_project_assignment.go

env0/resource_environment.go

env0/resource_team_project_assignment.go

env0/resource_cloud_credentials_project_assignment_test.go

Raz has some additional comments

razbensimon · 2022-02-21T10:14:50Z

#219 (comment)
according to that comment, I am wondering why we don't have any call to d.IsNewResource ?
general behavior IIUC that drift flow - is when d.IsNewResource is true, we should fail/error when exists.
if d.IsNewResource is false AND we got some relevant Http Code (eg. NotFound) we should understand it as drift and call SetId("").

I'm not 100% sure about what I said, and just raise a flag for you, because that's what I understood from the TF Read examples over the web (eg AWS).
also I saw that maybe it can help.

@samuel-br just validate that please, and QA your changes by running the provider after drift changes (in env0).
don't hesitate to ask for help if needed.

samuel-br · 2022-02-21T12:14:16Z

I think you right but as you said i want to validate it, the explenation i think, its because the d.isnewresource is true when we plan a resource its pushing it to TF state, but its not yet created on the "real world" and then every read will get exeption, but what i dont understand is how we dont use this for now and there is still no error when apply a new resource.

…into fix-handle_drift_withIsDeleted-#225

razbensimon

@samuel-br I am not sure i understood your comment.
also please write a propper description of that PR.

@yaronya @eranelbaz please revisit my comments here.
I am not sure about it...

razbensimon · 2022-03-07T10:02:56Z

env0/resource_team_project_assignment.go

+	if !found {
+		if !d.IsNewResource() {
+			d.SetId("")
+		}
+	}


if !d.IsNewResource() && !found { log.Printf("[WARN] Project (%s) not found, removing from state", d.Id()) d.SetId("") return nil }

Looks better to me. I took it from S3 bucket provider as example / reference.
Please do the same for others if can.

I am still not sure about this one.
IIUC we should still throw on d.IsNewResource()==true && someErrorOrBadCodeExists.
I don't see any error returned on that case. @yaronya maybe you can revisit my thoughts here?

i don't think we need to throw something, but we do need to return nil here

Yes, @eranelbaz is correct - we don't need to throw anything. This is what we wanted to avoid in first place.
We should be removing the resource from state.

@samuel-br haven't we previously discussed it and said that we don't really need to check whether IsNewResource because TF doesn't read the resource before create (only before update/delete) so this would always return false?

@yaronya i think read is invoked on create too..

read invokes on terraform refresh IIRC

@razbensimon did you mean to fix the if or for the log?

the if is good now, just suggested adding logs to the user as I saw in the S3 bucket example.
for your decision @samuel-br

"drift detected: TerraForm will remove {this resource} from state" is that good wording?

"[WARN] Drift Detected: Terraform will remove {this resource} from state"

razbensimon · 2022-03-07T10:15:00Z

client/model.go

@@ -286,6 +286,7 @@ type Environment struct {
 	LifespanEndAt               string        `json:"lifespanEndAt"`
 	LatestDeploymentLogId       string        `json:"latestDeploymentLogId"`
 	LatestDeploymentLog         DeploymentLog `json:"latestDeploymentLog"`
+	IsArchived                  bool          `json:"isArchived"`


don't we need to use it on the logic somewhere?
just wondering

The PR handled also environment resource at start but since it isn't so trivial to re-create an environment on some drift and there's a deeper product decision to make before implementing it, we've decided to ditch it for now and create a separate issue for environment and project resources.
This looks like a leftover tho.

@samuel-br did you create that seperate issue btw?

@yaronya #225?

I'm not so sure. I expect to see an issue that includes environment and project resources in its description, but couldn't find it.

If I get that correctly:

Handle drift - general #205 talks about our drift issues in general

Handle drift - specific resources #225 tries to tackle specific resources, such as template for e.g

We're missing another issue that tackles environment and project

nope, Ill do it later today, but I want to summary this before on channel, cause for now there is three or for types of resources in this contexts of problem

@samuel-br maybe just change their title?
Handle drift - general
Handle drift - specific resources
etc

~~and link them~~

i am confused with all of those issues.
I just asked to make the PR with a good description (copy-paste the issue if needed to the PR).

anyways, if that line of code is related to this PR keep it.
if not - remove it

@samuel-br
cc @eranelbaz

I've changed the title for #250 already FYI.
And yes, prefer not having multiple issues with the same name.

@samuel-br can you please share on the main issue (i.e #205) what's needed to be done basically and why it differs from the other issues (parsing the error codes from http client layer and etc.)

@yaronya @eranelbaz I changed the issues names (@yaronya thanks on #250 ) and add #205 (comment) on the main issue, please take a look on that comment to ensure its clear enough

…into fix-handle_drift_withIsDeleted-#225

add drift handling

e3f4b72

samuel-br self-assigned this Feb 17, 2022

samuel-br added the work in progress label Feb 17, 2022

add unit test to resource_template

79fd80d

samuel-br changed the title ~~add drift handling~~ Add drift handling #225 Feb 17, 2022

samuel-br added pending final review and removed work in progress labels Feb 17, 2022

samuel-br requested a review from eranelbaz February 17, 2022 09:22

eranelbaz requested a review from a team February 17, 2022 11:16

yaronya reviewed Feb 17, 2022

View reviewed changes

yaronya added reviewed - awaiting author and removed pending final review labels Feb 17, 2022

samuel-br added 2 commits February 17, 2022 15:51

fix cloud credentials project assignment

3868f81

fix team project assignment

234334f

yaronya changed the title ~~Add drift handling #225~~ Add drift handling Feb 17, 2022

samuel-br added 2 commits February 17, 2022 17:55

delete refrences to project and environment

0003acd

fix

d1d60de

samuel-br added pending final review and removed reviewed - awaiting author labels Feb 17, 2022

fix fmt

357054e

eranelbaz requested a review from yaronya February 20, 2022 14:30

yaronya previously approved these changes Feb 20, 2022

View reviewed changes

eranelbaz removed their request for review February 21, 2022 09:52

samuel-br added 3 commits March 2, 2022 20:33

Merge branch 'main' of https://github.com/env0/terraform-provider-env0 …

85267ae

…into fix-handle_drift_withIsDeleted-#225

add check for new resource

696d15c

Merge branch 'main' of https://github.com/env0/terraform-provider-env0 …

d388c31

…into fix-handle_drift_withIsDeleted-#225

samuel-br requested a review from yaronya March 6, 2022 19:26

razbensimon reviewed Mar 7, 2022

View reviewed changes

eranelbaz added reviewed - awaiting author and removed pending final review labels Mar 7, 2022

samuel-br added 2 commits March 7, 2022 22:16

Merge branch 'main' of https://github.com/env0/terraform-provider-env0 …

4649799

…into fix-handle_drift_withIsDeleted-#225

fix team project assignment

443bf24

github-actions bot added api-client provider labels Mar 8, 2022

Merge branch 'main' of https://github.com/env0/terraform-provider-env0 …

b89584f

…into fix-handle_drift_withIsDeleted-#225

github-actions bot added the fix label Mar 8, 2022

update

8b20dc4

samuel-br added pending final review and removed reviewed - awaiting author labels Mar 8, 2022

samuel-br requested review from razbensimon and eranelbaz March 9, 2022 09:33

razbensimon approved these changes Mar 9, 2022

View reviewed changes

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

samuel-br added 2 commits March 9, 2022 12:59

Merge branch 'main' of https://github.com/env0/terraform-provider-env0 …

8f87942

…into fix-handle_drift_withIsDeleted-#225

add logs when drift detected

c2ec119

samuel-br merged commit f735547 into main Mar 9, 2022

samuel-br deleted the fix-handle_drift_withIsDeleted-#225 branch March 9, 2022 11:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add drift handling #226

Add drift handling #226

samuel-br commented Feb 17, 2022 •

edited

Loading

yaronya left a comment

razbensimon commented Feb 21, 2022

samuel-br commented Feb 21, 2022

razbensimon left a comment •

edited

Loading

razbensimon Mar 7, 2022

eranelbaz Mar 7, 2022

yaronya Mar 7, 2022

razbensimon Mar 7, 2022

eranelbaz Mar 7, 2022

eranelbaz Mar 8, 2022

razbensimon Mar 9, 2022

samuel-br Mar 9, 2022

razbensimon Mar 9, 2022

samuel-br Mar 9, 2022

razbensimon Mar 7, 2022

yaronya Mar 7, 2022

eranelbaz Mar 7, 2022 •

edited

Loading

yaronya Mar 7, 2022

samuel-br Mar 8, 2022

eranelbaz Mar 9, 2022 •

edited

Loading

razbensimon Mar 9, 2022

yaronya Mar 9, 2022

yaronya Mar 9, 2022

samuel-br Mar 9, 2022

Add drift handling #226

Add drift handling #226

Conversation

samuel-br commented Feb 17, 2022 • edited Loading

Issue & Steps to Reproduce / Feature Request

Solution

yaronya left a comment

Choose a reason for hiding this comment

razbensimon commented Feb 21, 2022

samuel-br commented Feb 21, 2022

razbensimon left a comment • edited Loading

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

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

Choose a reason for hiding this comment

eranelbaz Mar 7, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eranelbaz Mar 9, 2022 • edited Loading

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

samuel-br commented Feb 17, 2022 •

edited

Loading

razbensimon left a comment •

edited

Loading

eranelbaz Mar 7, 2022 •

edited

Loading

eranelbaz Mar 9, 2022 •

edited

Loading