[4/X] [DXCDT-175] Add recovery code to guardian resource and refactor #216

sergiught · 2022-07-05T19:47:32Z

Description

Add recovery code to guardian resource and refactor.

Checklist

Note: Checklist required to be completed before a PR is considered to be reviewable.

Auth0 Code of Conduct

I have read and agreed to the terms within the Auth0 Code of Conduct

Auth0 General Contribution Guidelines

I have read the Auth0 General Contribution Guidelines

Changes include test coverage?

Yes
Not needed

Does the description provide the correct amount of context?

Yes, the description provides enough context for the reviewer to understand what these changes accomplish

Have you updated the documentation?

Yes, I've updated the appropriate docs
Not needed

Is this code ready for production?

Yes, all code changes are intentional and no debugging calls are left over

codecov-commenter · 2022-07-06T16:41:23Z

Codecov Report

Merging #216 (abf36b2) into feature/DXCDT-175-guardian++-part3 (dc34f25) will increase coverage by 0.54%.
The diff coverage is 89.58%.

@@                          Coverage Diff                           @@
##           feature/DXCDT-175-guardian++-part3     #216      +/-   ##
======================================================================
+ Coverage                               82.98%   83.52%   +0.54%     
======================================================================
  Files                                      36       36              
  Lines                                    6541     6537       -4     
======================================================================
+ Hits                                     5428     5460      +32     
+ Misses                                    882      858      -24     
+ Partials                                  231      219      -12

Impacted Files	Coverage Δ
auth0/structure_auth0_guardian.go	`64.41% <81.25%> (+0.83%)`	⬆️
auth0/resource_auth0_guardian.go	`90.46% <93.75%> (+10.13%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dc34f25...abf36b2. Read the comment docs.

sergiught · 2022-07-06T16:40:22Z

auth0/resource_auth0_guardian.go

@@ -37,7 +37,6 @@ func newGuardian() *schema.Resource {
 				Type:     schema.TypeList,
 				Optional: true,
 				MaxItems: 1,
-				MinItems: 0,


This gets ignored completely if optional is true.

sergiught · 2022-07-06T16:40:51Z

auth0/resource_auth0_guardian.go

-	multiFactorPolicies, err := api.Guardian.MultiFactor.Policy()
+	flattenedPolicy, err := flattenMultiFactorPolicy(api)
 	if err != nil {
 		return diag.FromErr(err)
 	}

-	result := multierror.Append(d.Set("policy", "never"))
-	if len(*multiFactorPolicies) > 0 {
-		result = multierror.Append(result, d.Set("policy", (*multiFactorPolicies)[0]))
-	}
+	result := multierror.Append(d.Set("policy", flattenedPolicy))


Extracting this logic somewhere else so it's easier to read through the readGuardian steps.

sergiught · 2022-07-06T16:41:23Z

auth0/resource_auth0_guardian.go

+	result := multierror.Append(
+		updatePolicy(d, api),
+		updateEmailFactor(d, api),
+		updateOTPFactor(d, api),
+		updateRecoveryCodeFactor(d, api),
+		updatePhoneFactor(d, api),
+		updateWebAuthnRoaming(d, api),
+		updateWebAuthnPlatform(d, api),
+		updateDUO(d, api),
+		updatePush(d, api),
+	)


It's better if we try al of these updates and report on any accumulated errors instead of failing at the first and not doing any of the others.

sergiught · 2022-07-06T16:41:31Z

auth0/resource_auth0_guardian.go

+	result := multierror.Append(
+		api.Guardian.MultiFactor.Phone.Enable(false),
+		api.Guardian.MultiFactor.Email.Enable(false),
+		api.Guardian.MultiFactor.OTP.Enable(false),
+		api.Guardian.MultiFactor.RecoveryCode.Enable(false),
+		api.Guardian.MultiFactor.WebAuthnRoaming.Enable(false),
+		api.Guardian.MultiFactor.WebAuthnPlatform.Enable(false),
+		api.Guardian.MultiFactor.DUO.Enable(false),
+		api.Guardian.MultiFactor.Push.Enable(false),


It's better if we try al of these updates and report on any accumulated errors instead of failing at the first and not doing any of the others.

sergiught · 2022-07-06T16:42:29Z

auth0/resource_auth0_guardian_test.go

+					resource.TestCheckResourceAttr("auth0_guardian.foo", "email", "true"),
+					resource.TestCheckResourceAttr("auth0_guardian.foo", "otp", "false"),
 					resource.TestCheckResourceAttr("auth0_guardian.foo", "phone.#", "0"),
+					resource.TestCheckResourceAttr("auth0_guardian.foo", "duo.#", "0"),
+					resource.TestCheckResourceAttr("auth0_guardian.foo", "webauthn_platform.#", "0"),
+					resource.TestCheckResourceAttr("auth0_guardian.foo", "webauthn_roaming.#", "0"),
+					resource.TestCheckResourceAttr("auth0_guardian.foo", "push.#", "0"),
+					resource.TestCheckResourceAttr("auth0_guardian.foo", "recovery_code", "false"),


We're splitting the 1 big test into multiple ones that focus on distinct MFA types. Also we're now checking the full state for all the possible parameters for a thorough inspection.

sergiught self-assigned this Jul 5, 2022

sergiught changed the base branch from feature/DXCDT-175-guardian++part1 to feature/DXCDT-175-guardian++-part3 July 5, 2022 20:00

sergiught force-pushed the feature/DXCDT-175-guardian++-part3 branch from 82ac5fb to dc34f25 Compare July 6, 2022 13:41

sergiught added 6 commits July 6, 2022 15:42

Add webauthn support to guardian resource

5af64bc

Add duo support to guardian resource

5ffb793

Refactor guardian tests

b462924

Add recovery code to guardian resource

81b2151

Refactor auth0 guardian resource

8100199

Update guardian docs

c9716d3

sergiught force-pushed the feature/DXCDT-175-guardian-final-refactor branch from 6bdbca8 to 393aaaa Compare July 6, 2022 13:44

sergiught marked this pull request as ready for review July 6, 2022 13:45

sergiught requested a review from a team as a code owner July 6, 2022 13:45

sergiught requested a review from Widcket July 6, 2022 13:46

sergiught marked this pull request as draft July 6, 2022 13:47

sergiught removed request for a team and Widcket July 6, 2022 13:47

Update guardian recordings

abf36b2

sergiught force-pushed the feature/DXCDT-175-guardian-final-refactor branch from 393aaaa to abf36b2 Compare July 6, 2022 16:37

sergiught commented Jul 6, 2022

View reviewed changes

sergiught marked this pull request as ready for review July 6, 2022 16:42

Widcket approved these changes Jul 6, 2022

View reviewed changes

Base automatically changed from feature/DXCDT-175-guardian++-part3 to main July 7, 2022 07:51

sergiught merged commit 2702f6e into main Jul 7, 2022

sergiught deleted the feature/DXCDT-175-guardian-final-refactor branch July 7, 2022 07:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[4/X] [DXCDT-175] Add recovery code to guardian resource and refactor #216

[4/X] [DXCDT-175] Add recovery code to guardian resource and refactor #216

sergiught commented Jul 5, 2022 •

edited

Loading

codecov-commenter commented Jul 6, 2022

sergiught Jul 6, 2022

sergiught Jul 6, 2022

sergiught Jul 6, 2022

sergiught Jul 6, 2022

sergiught Jul 6, 2022 •

edited

Loading

[4/X] [DXCDT-175] Add recovery code to guardian resource and refactor #216

[4/X] [DXCDT-175] Add recovery code to guardian resource and refactor #216

Conversation

sergiught commented Jul 5, 2022 • edited Loading

Description

Checklist

Auth0 Code of Conduct

Auth0 General Contribution Guidelines

Changes include test coverage?

Does the description provide the correct amount of context?

Have you updated the documentation?

Is this code ready for production?

codecov-commenter commented Jul 6, 2022

Codecov Report

sergiught Jul 6, 2022

Choose a reason for hiding this comment

sergiught Jul 6, 2022

Choose a reason for hiding this comment

sergiught Jul 6, 2022

Choose a reason for hiding this comment

sergiught Jul 6, 2022

Choose a reason for hiding this comment

sergiught Jul 6, 2022 • edited Loading

Choose a reason for hiding this comment

sergiught commented Jul 5, 2022 •

edited

Loading

sergiught Jul 6, 2022 •

edited

Loading