DXCDT-340: Refactor API for test commands, fix bugs and improve DX #629

sergiught · 2023-01-24T17:00:12Z

🔧 Changes

In this PR we're aiming at offering a more cohesive experience for the auth0 test login and auth0 test token commands.

Summary of changes:

Renamed --connection to --connection-name in auth0 test login command (d1ac562)
Changed --client-id from a flag to an argument in auth0 test token command (e958077)
Added an option in the client ID argument picker to create a test client in case of need (b2a91c3, e958077)
Added checks and better error messages for when the selected client isn't authorized to get access token for the desired audience 6fa8628
Added checks and better error messages for when the selected client is a machine to machine type and we want to test the universal login 28fa77c

📚 References

🔬 Testing

📝 Checklist

All new/changed/fixed functionality is covered by tests (or N/A)
I have added documentation for all new/changed functionality (or N/A)

sergiught · 2023-01-24T18:18:18Z

internal/cli/apps.go

-		// empty type means the default client that we shouldn't display.
+		// Empty type means the default client that we shouldn't display.
+		// TODO(sergiught): We only need to exclude generic app types for
+		// the auth0 qs download command. Fix this in separate PR.


This needs to be fixed in a follow up PR after this one, so that we can select Generic type apps as well across the various commands and only discard Generic types for the quickstart download command.

sergiught · 2023-01-24T18:19:42Z

internal/cli/test.go

-			client, err := cli.api.Client.Read(inputs.ClientID)
-			if err != nil {
-				return fmt.Errorf("Unable to find client %s; if you specified a client, please verify it exists, otherwise re-run the command", inputs.ClientID)
+			if client.GetAppType() == appTypeNonInteractive {


We shouldn't try to run a login for M2M app types but use the auth0 test token command instead for those.

sergiught · 2023-01-24T18:20:19Z

internal/cli/test.go

@@ -157,46 +123,63 @@ func testLoginCmd(cli *cli) *cobra.Command {
 				return nil
 			}

+			if inputs.Audience != "" {


Regular Web Apps could be authorized to request access tokens for a specific API so if we do pass an audience we wanna make sure the application is authorized.

sergiught · 2023-01-24T18:20:48Z

internal/cli/test.go

-			cli.renderer.Infof("Domain:   " + tenant.Domain)
-			cli.renderer.Infof("ClientID: " + inputs.ClientID)
-			cli.renderer.Infof("Type:     " + appType + "\n")
+			cli.renderer.Infof("Domain    : " + ansi.Blue(tenant.Domain))


Adding a bit of color into our lives.

sergiught · 2023-01-24T18:21:12Z

internal/cli/test.go

 			tokenResponse, err := runLoginFlow(
 				cli,
 				tenant,
 				client,
 				inputs.ConnectionName,
-				inputs.Audience, // audience is only supported for the test token command


The message that audience wasn't supported was flawed.

sergiught · 2023-01-24T18:21:34Z

internal/cli/test.go

-	if isTemp {
-		if err := cli.api.Client.Delete(id); err != nil {
-			cli.renderer.Errorf("unable to remove the default test application", err.Error())
+func selectClientToUseForTestsAndValidateExistence(cli *cli, cmd *cobra.Command, args []string, inputs *testCmdInputs) (*management.Client, error) {


Shared logic between both test commands, we select an existing client ID or choose to create one for the test.

internal/cli/test.go

internal/display/test.go

internal/cli/test.go

willvedd

Solid DX upgrade 👍

sergiught added 13 commits January 23, 2023 17:44

Reduce scope of variables within the auth0 test login cmd

7dd230f

Surface to the user the option to create a test client

b2a91c3

Stop skipping generic apps in app option picker

fc61092

Remove redundant domain flag in test cmd

53d38ea

Update error messages in auth0 test login cmd

04a6b18

Update info messages for auth0 test login cmd

a4af611

Rename connection flag to connection-name

d1ac562

Reduce scope of variables within the auth0 test token cmd

53f721b

Surface to the user the option to create a client in auth0 test token

e958077

Refactor how we select the client id within the test cmds

ff2dc23

Fix app type and apply color in test token cmd

bbf3381

Improve how we display the output from the test cmds

1ee9066

Add check to ensure client is authorized on api in test cmds

6fa8628

sergiught force-pushed the patch/DXCDT-340-refactor-test-cmd branch from 064dc22 to 8516dc8 Compare January 24, 2023 17:02

sergiught added 2 commits January 24, 2023 18:06

Add TODO to fix issue with app picker

8646ccf

Cleanup unused funcs and fix error messages

127111c

sergiught force-pushed the patch/DXCDT-340-refactor-test-cmd branch from 1b31632 to 127111c Compare January 24, 2023 17:08

sergiught added 2 commits January 24, 2023 18:30

Add check for m2m apps in test login cmd

28fa77c

Update docs

7cd6681

sergiught changed the title ~~DXCDT-340:~~ DXCDT-340: Refactor API for test commands, fix bugs and improve DX Jan 24, 2023

sergiught commented Jan 24, 2023

View reviewed changes

sergiught marked this pull request as ready for review January 24, 2023 18:22

sergiught requested a review from a team as a code owner January 24, 2023 18:22

Merge branch 'main' into patch/DXCDT-340-refactor-test-cmd

48daa25

sergiught force-pushed the patch/DXCDT-340-refactor-test-cmd branch from 2b6d317 to 48daa25 Compare January 25, 2023 08:59

Merge branch 'main' into patch/DXCDT-340-refactor-test-cmd

93be298

sergiught self-assigned this Jan 25, 2023

Merge branch 'main' into patch/DXCDT-340-refactor-test-cmd

f51fe24

Widcket reviewed Jan 25, 2023

View reviewed changes

internal/cli/test.go Outdated Show resolved Hide resolved

Widcket reviewed Jan 25, 2023

View reviewed changes

internal/cli/test.go Outdated Show resolved Hide resolved

Widcket reviewed Jan 25, 2023

View reviewed changes

internal/cli/test.go Show resolved Hide resolved

Widcket reviewed Jan 25, 2023

View reviewed changes

internal/cli/test.go Outdated Show resolved Hide resolved

Widcket reviewed Jan 25, 2023

View reviewed changes

internal/display/test.go Show resolved Hide resolved

sergiught added 3 commits January 25, 2023 20:25

Add read:client_grants scope to RequiredScopes

9138183

Apply feedback

03fac70

Fix tests

be3bbfc

Widcket approved these changes Jan 26, 2023

View reviewed changes

Add new client constant

eae18c8

sergiught requested a review from a team January 26, 2023 08:43

Widcket approved these changes Jan 26, 2023

View reviewed changes

willvedd reviewed Jan 26, 2023

View reviewed changes

internal/cli/test.go Outdated Show resolved Hide resolved

willvedd reviewed Jan 26, 2023

View reviewed changes

internal/cli/test.go Outdated Show resolved Hide resolved

willvedd reviewed Jan 26, 2023

View reviewed changes

internal/cli/test.go Outdated Show resolved Hide resolved

sergiught added 2 commits January 26, 2023 19:40

Update docs

2890b03

Ensure audience is required in auth0 test token cmd

2a59a69

willvedd approved these changes Jan 26, 2023

View reviewed changes

willvedd merged commit fc0f515 into main Jan 26, 2023

willvedd deleted the patch/DXCDT-340-refactor-test-cmd branch January 26, 2023 21:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DXCDT-340: Refactor API for test commands, fix bugs and improve DX #629

DXCDT-340: Refactor API for test commands, fix bugs and improve DX #629

sergiught commented Jan 24, 2023 •

edited

Loading

sergiught Jan 24, 2023

sergiught Jan 24, 2023

sergiught Jan 24, 2023

sergiught Jan 24, 2023

sergiught Jan 24, 2023

sergiught Jan 24, 2023

willvedd left a comment

DXCDT-340: Refactor API for test commands, fix bugs and improve DX #629

DXCDT-340: Refactor API for test commands, fix bugs and improve DX #629

Conversation

sergiught commented Jan 24, 2023 • edited Loading

🔧 Changes

📚 References

🔬 Testing

📝 Checklist

sergiught Jan 24, 2023

Choose a reason for hiding this comment

sergiught Jan 24, 2023

Choose a reason for hiding this comment

sergiught Jan 24, 2023

Choose a reason for hiding this comment

sergiught Jan 24, 2023

Choose a reason for hiding this comment

sergiught Jan 24, 2023

Choose a reason for hiding this comment

sergiught Jan 24, 2023

Choose a reason for hiding this comment

willvedd left a comment

Choose a reason for hiding this comment

sergiught commented Jan 24, 2023 •

edited

Loading