Add missing prompt custom text and implement prompt screen partial in terraform generator (#1426)

* feat(prompt): update custom text prompt types to add missing items

- Reformatted the `customTextPromptTypes` array for better readability.
- Added new prompt types: `email_identifier_challenge` and `passkeys`.
- This change enhances the prompt handling capabilities in the `terraform_fetcher.go` file.

* feat(prompt): add support for screen partial prompts

- Introduced `promptScreenPartialResourceFetcher` to handle fetching data for screen partial prompts.
- Updated `parseResourceFetchers` method in `terraform.go` to include the new fetcher for "auth0_prompt_screen_partial".
- Added a mapping for screen partial prompt types to their corresponding screens in `terraform_fetcher.go`.
- This enhancement allows for better management and retrieval of screen partial prompts in the CLI.

* feat(prompt): update custom text prompt types and clean up code

- Added missing custom text prompt types including "login-passwordless", "phone-identifier-enrollment", and others to enhance prompt coverage.
- Removed outdated TODO comments to improve code clarity.
- Updated references in comments for better documentation and accuracy.

* feat(prompt): enhance custom text prompts and add screen partial support

- Refactored the promptTypes array in TestPromptCustomTextResourceFetcher to improve readability and added new prompt types.
- Introduced Test_promptScreenPartialResourceFetcher to validate the retrieval of screen partial prompts data.
- Ensured that the new tests cover various scenarios for screen partial prompts, enhancing overall test coverage.

* feat(prompt): add support for screen partial prompts in Terraform config

- Updated the default resources list to include `auth0_prompt_screen_partial`.
- This change allows users to generate Terraform configurations for screen partial prompts, enhancing the flexibility of the `auth0 terraform generate` command.

* feat(prompt): remove unused custom text prompt types

- Eliminated "async-approval-flow" from the customTextPromptTypes slice in terraform_fetcher.go.
- This prompt type is not supported in go-auth0 and terraform provider.

* feat(prompt): streamline custom text prompt types in code

- Consolidated the definition of `customTextPromptTypes` in `terraform_fetcher.go` and `terraform_fetcher_test.go` to a single line for improved readability.
- This change reduces visual clutter and maintains consistency across the codebase.
- No functional changes were made; the prompt types remain the same.

* fix(prompt): update assertion in Test_promptScreenPartialResourceFetcher_FetchData

- Changed assertion from assert.Equal to assert.ElementsMatch to ensure
  that the order of elements in the fetched data does not affect the test
  outcome.

* feat(auth): add new required scopes for organization and user profiles

- Added "read:organization_discovery_domains", "read:self_service_profiles", and "read:user_attribute_profiles" to the RequiredScopes variable.
- This change enhances the authentication flow by allowing access to additional user and organization-related resources.

* fix(tests): uncomment and restore Terraform test cases

- Restored the previously commented-out test cases for Terraform integration.
- Comment out failing quickstart integration test

* fix(tests): rename quickstart test cases to disabled file

- Renamed quickstart test cases from `quickstarts-test-cases.yaml` to `quickstarts-test-cases.yaml.disabled`.
- This change skips running quickstarts-test-cases.
- Commenting out tests led to `could not find test with pattern: ` error, hence renamed the file.

* fix(tests): add dummy test case to quickstarts

* fix(terraform): improve error message for terraform plan failure

- Enhanced the warning message in the generateTerraformCmdRun function to include the error details when terraform plan fails.
- This change provides clearer feedback to users, aiding in troubleshooting by specifying the nature of the error encountered.

* fix(tests): Skip only download quickstart test

* chore(terraform): address review comments

- Renamed `customTextPromptTypes` to `customTextPrompts` for clarity.
- Updated `customTextPromptOptions` to use the new prompt variable.
- Enhanced error message in `generateTerraformCmdRun`.
- Adjusted test cases in `terraform_fetcher_test.go` to reflect prompt name changes.

* fix(tests): re-enable download quickstart test case

- Restored the previously commented-out download quickstart test case.

* fix(cli): add pre-login organization picker to prompt screen map

- Updated the PromptScreenMap in universal_login_customize.go to include
  "pre-login-organization-picker" under the "organizations" key.

* fix(go.mod): update go-auth0 dependency to v1.33.0

- Updated the version of the `github.com/auth0/go-auth0` dependency from v1.32.1 to v1.33.0 in `go.mod`.
- The corresponding entries in `go.sum` have been added to reflect the updated version.

Author: bkiran6398

docs/auth0_terraform_generate.md

@@ -33,7 +33,7 @@ auth0 terraform generate [flags]
 ```
       --force               Skip confirmation.
   -o, --output-dir string   Output directory for the generated Terraform config files. If not provided, the files will be saved in the current working directory. (default "./")
-  -r, --resources strings   Resource types to generate Terraform config for. If not provided, config files for all available resources will be generated. (default [auth0_action,auth0_attack_protection,auth0_branding,auth0_branding_theme,auth0_phone_provider,auth0_client,auth0_client_grant,auth0_connection,auth0_custom_domain,auth0_flow,auth0_flow_vault_connection,auth0_form,auth0_email_provider,auth0_email_template,auth0_guardian,auth0_log_stream,auth0_network_acl,auth0_organization,auth0_pages,auth0_prompt,auth0_prompt_custom_text,auth0_prompt_screen_renderer,auth0_resource_server,auth0_role,auth0_self_service_profile,auth0_tenant,auth0_trigger_actions,auth0_user_attribute_profile])
+  -r, --resources strings   Resource types to generate Terraform config for. If not provided, config files for all available resources will be generated. (default [auth0_action,auth0_attack_protection,auth0_branding,auth0_branding_theme,auth0_phone_provider,auth0_client,auth0_client_grant,auth0_connection,auth0_custom_domain,auth0_flow,auth0_flow_vault_connection,auth0_form,auth0_email_provider,auth0_email_template,auth0_guardian,auth0_log_stream,auth0_network_acl,auth0_organization,auth0_pages,auth0_prompt,auth0_prompt_custom_text,auth0_prompt_screen_renderer,auth0_resource_server,auth0_role,auth0_self_service_profile,auth0_tenant,auth0_trigger_actions,auth0_user_attribute_profile,auth0_prompt_screen_partial])
   -v, --tf-version string   Terraform version that ought to be used while generating the terraform files for resources. If not provided, 1.5.0 is used by default (default "1.5.0")
 ```
 

go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/AlecAivazis/survey/v2 v2.3.7
 	github.com/PuerkitoBio/rehttp v1.4.0
 	github.com/atotto/clipboard v0.1.4
-	github.com/auth0/go-auth0 v1.32.1
+	github.com/auth0/go-auth0 v1.33.0
 	github.com/briandowns/spinner v1.23.2
 	github.com/charmbracelet/glamour v0.10.0
 	github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e

go.sum

@@ -24,6 +24,8 @@ github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z
 github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
 github.com/auth0/go-auth0 v1.32.1 h1:AAXQqaNaFZWkRm2bg5mVVXpqDLmusv7v238uIaxuFpo=
 github.com/auth0/go-auth0 v1.32.1/go.mod h1:32sQB1uAn+99fJo6N819EniKq8h785p0ag0lMWhiTaE=
+github.com/auth0/go-auth0 v1.33.0 h1:7qx0UCA6Tn2udnEVA35xzKsseh/R9559f+nnGcUI0Ss=
+github.com/auth0/go-auth0 v1.33.0/go.mod h1:32sQB1uAn+99fJo6N819EniKq8h785p0ag0lMWhiTaE=
 github.com/aybabtme/iocontrol v0.0.0-20150809002002-ad15bcfc95a0 h1:0NmehRCgyk5rljDQLKUO+cRJCnduDyn11+zGZIc9Z48=
 github.com/aybabtme/iocontrol v0.0.0-20150809002002-ad15bcfc95a0/go.mod h1:6L7zgvqo0idzI7IO8de6ZC051AfXb5ipkIJ7bIA2tGA=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=

internal/auth/auth.go

@@ -149,6 +149,7 @@ var RequiredScopes = []string{
 	"read:event_streams", "create:event_streams", "update:event_streams", "delete:event_streams",
 	"read:network_acls", "create:network_acls", "update:network_acls", "delete:network_acls",
 	"read:token_exchange_profiles", "create:token_exchange_profiles", "update:token_exchange_profiles", "delete:token_exchange_profiles",
+	"read:organization_discovery_domains", "read:self_service_profiles", "read:user_attribute_profiles",
 }
 
 // GetDeviceCode kicks-off the device authentication flow by requesting

internal/cli/acul_config.go

@@ -158,6 +158,7 @@ var (
 		"accept-invitation":                              "invitation",
 		"organization-picker":                            "organizations",
 		"organization-selection":                         "organizations",
+		"pre-login-organization-picker":                  "organizations",
 		"device-code-activation":                         "device-flow",
 		"device-code-activation-allowed":                 "device-flow",
 		"device-code-activation-denied":                  "device-flow",

internal/cli/prompts_custom_text.go

@@ -66,8 +66,8 @@ func universalLoginPromptsTextCmd(cli *cli) *cobra.Command {
 
 func customTextPromptOptions(_ context.Context) (pickerOptions, error) {
 	var opts pickerOptions
-	for _, promptType := range customTextPromptTypes {
-		opts = append(opts, pickerOption{value: promptType, label: promptType})
+	for _, prompt := range customTextPrompts {
+		opts = append(opts, pickerOption{value: prompt, label: prompt})
 	}
 	return opts, nil
 }

internal/cli/terraform.go

@@ -109,6 +109,8 @@ func (i *terraformInputs) parseResourceFetchers(api *auth0.API) ([]resourceDataF
 			fetchers = append(fetchers, &promptResourceFetcher{})
 		case "auth0_prompt_custom_text":
 			fetchers = append(fetchers, &promptCustomTextResourceFetcherResourceFetcher{api})
+		case "auth0_prompt_screen_partial":
+			fetchers = append(fetchers, &promptScreenPartialResourceFetcher{})
 		case "auth0_prompt_screen_renderer":
 			fetchers = append(fetchers, &promptScreenRendererResourceFetcher{api})
 		case "auth0_resource_server", "auth0_resource_server_scopes":

internal/cli/terraform_fetcher.go

@@ -12,7 +12,7 @@ import (
 )
 
 var (
-	defaultResources = []string{"auth0_action", "auth0_attack_protection", "auth0_branding", "auth0_branding_theme", "auth0_phone_provider", "auth0_client", "auth0_client_grant", "auth0_connection", "auth0_custom_domain", "auth0_flow", "auth0_flow_vault_connection", "auth0_form", "auth0_email_provider", "auth0_email_template", "auth0_guardian", "auth0_log_stream", "auth0_network_acl", "auth0_organization", "auth0_pages", "auth0_prompt", "auth0_prompt_custom_text", "auth0_prompt_screen_renderer", "auth0_resource_server", "auth0_role", "auth0_self_service_profile", "auth0_tenant", "auth0_trigger_actions", "auth0_user_attribute_profile"}
+	defaultResources = []string{"auth0_action", "auth0_attack_protection", "auth0_branding", "auth0_branding_theme", "auth0_phone_provider", "auth0_client", "auth0_client_grant", "auth0_connection", "auth0_custom_domain", "auth0_flow", "auth0_flow_vault_connection", "auth0_form", "auth0_email_provider", "auth0_email_template", "auth0_guardian", "auth0_log_stream", "auth0_network_acl", "auth0_organization", "auth0_pages", "auth0_prompt", "auth0_prompt_custom_text", "auth0_prompt_screen_renderer", "auth0_resource_server", "auth0_role", "auth0_self_service_profile", "auth0_tenant", "auth0_trigger_actions", "auth0_user_attribute_profile", "auth0_prompt_screen_partial"}
 )
 
 type (
@@ -107,6 +107,8 @@ type (
 		api *auth0.API
 	}
 
+	promptScreenPartialResourceFetcher struct{}
+
 	roleResourceFetcher struct {
 		api *auth0.API
 	}
@@ -528,7 +530,8 @@ func (f *promptResourceFetcher) FetchData(_ context.Context) (importDataList, er
 	}, nil
 }
 
-var customTextPromptTypes = []string{"login", "login-id", "login-password", "login-email-verification", "signup", "signup-id", "signup-password", "reset-password", "consent", "mfa-push", "mfa-otp", "mfa-voice", "mfa-phone", "mfa-webauthn", "mfa-sms", "mfa-email", "mfa-recovery-code", "mfa", "status", "device-flow", "email-verification", "email-otp-challenge", "organizations", "invitation", "common"}
+// Referred from 'prompt' path options in: https://auth0.com/docs/api/management/v2/prompts/get-custom-text-by-language
+var customTextPrompts = []string{"login", "login-id", "login-password", "login-email-verification", "signup", "signup-id", "signup-password", "reset-password", "consent", "mfa-push", "mfa-otp", "mfa-voice", "mfa-phone", "mfa-webauthn", "mfa-sms", "mfa-email", "mfa-recovery-code", "mfa", "status", "device-flow", "email-verification", "email-otp-challenge", "organizations", "invitation", "common", "email-identifier-challenge", "passkeys", "login-passwordless", "phone-identifier-enrollment", "phone-identifier-challenge", "custom-form", "customized-consent", "logout", "captcha", "brute-force-protection"}
 
 func (f *promptCustomTextResourceFetcherResourceFetcher) FetchData(ctx context.Context) (importDataList, error) {
 	tenant, err := f.api.Tenant.Read(ctx)
@@ -538,10 +541,37 @@ func (f *promptCustomTextResourceFetcherResourceFetcher) FetchData(ctx context.C
 
 	var data importDataList
 	for _, language := range tenant.GetEnabledLocales() {
-		for _, promptType := range customTextPromptTypes {
+		for _, prompt := range customTextPrompts {
+			data = append(data, importDataItem{
+				ResourceName: "auth0_prompt_custom_text." + sanitizeResourceName(language+"_"+prompt),
+				ImportID:     prompt + "::" + language,
+			})
+		}
+	}
+
+	return data, nil
+}
+
+// Referred from prompt 'path' options in: https://auth0.com/docs/api/management/v2/prompts/get-partials
+var screenPartialPromptToScreenMap = map[string][]string{
+	"login":              {"login"},
+	"login-id":           {"login-id"},
+	"login-password":     {"login-password"},
+	"login-passwordless": {"login-passwordless-sms-otp", "login-passwordless-email-code"},
+	"signup":             {"signup"},
+	"signup-id":          {"signup-id"},
+	"signup-password":    {"signup-password"},
+	"customized-consent": {"customized-consent"},
+}
+
+func (f *promptScreenPartialResourceFetcher) FetchData(ctx context.Context) (importDataList, error) {
+	var data importDataList
+
+	for prompt, screens := range screenPartialPromptToScreenMap {
+		for _, screen := range screens {
 			data = append(data, importDataItem{
-				ResourceName: "auth0_prompt_custom_text." + sanitizeResourceName(language+"_"+promptType),
-				ImportID:     promptType + "::" + language,
+				ResourceName: "auth0_prompt_screen_partial." + sanitizeResourceName(prompt+"_"+screen),
+				ImportID:     prompt + ":" + screen,
 			})
 		}
 	}

internal/cli/terraform_fetcher_test.go

@@ -1694,7 +1694,7 @@ func TestPromptCustomTextResourceFetcher_FetchData(t *testing.T) {
 			},
 		}
 
-		promptTypes := []string{"login", "login-id", "login-password", "login-email-verification", "signup", "signup-id", "signup-password", "reset-password", "consent", "mfa-push", "mfa-otp", "mfa-voice", "mfa-phone", "mfa-webauthn", "mfa-sms", "mfa-email", "mfa-recovery-code", "mfa", "status", "device-flow", "email-verification", "email-otp-challenge", "organizations", "invitation", "common"}
+		promptTypes := []string{"login", "login-id", "login-password", "login-email-verification", "signup", "signup-id", "signup-password", "reset-password", "consent", "mfa-push", "mfa-otp", "mfa-voice", "mfa-phone", "mfa-webauthn", "mfa-sms", "mfa-email", "mfa-recovery-code", "mfa", "status", "device-flow", "email-verification", "email-otp-challenge", "organizations", "invitation", "common", "email-identifier-challenge", "passkeys", "login-passwordless", "phone-identifier-enrollment", "phone-identifier-challenge", "custom-form", "customized-consent", "logout", "captcha", "brute-force-protection"}
 
 		expectedData := importDataList{}
 		for _, enabledLocale := range mockEnabledLocales {
@@ -2206,3 +2206,36 @@ func TestUserAttributeProfileResourceFetcher(t *testing.T) {
 		assert.Greater(t, len(data[0].ImportID), 0)
 	})
 }
+
+func Test_promptScreenPartialResourceFetcher_FetchData(t *testing.T) {
+	t.Run("it successfully retrieves screen partial prompts data", func(t *testing.T) {
+		fetcher := promptScreenPartialResourceFetcher{}
+
+		original := screenPartialPromptToScreenMap
+		defer func() { screenPartialPromptToScreenMap = original }()
+
+		screenPartialPromptToScreenMap = map[string][]string{
+			"login":              {"login"},
+			"login-passwordless": {"login-passwordless-sms-otp", "login-passwordless-email-code"},
+		}
+
+		expectedData := importDataList{
+			{
+				ResourceName: "auth0_prompt_screen_partial.login_login",
+				ImportID:     "login:login",
+			},
+			{
+				ResourceName: "auth0_prompt_screen_partial.login_passwordless_login_passwordless_sms_otp",
+				ImportID:     "login-passwordless:login-passwordless-sms-otp",
+			},
+			{
+				ResourceName: "auth0_prompt_screen_partial.login_passwordless_login_passwordless_email_code",
+				ImportID:     "login-passwordless:login-passwordless-email-code",
+			},
+		}
+
+		data, err := fetcher.FetchData(context.Background())
+		assert.NoError(t, err)
+		assert.ElementsMatch(t, expectedData, data)
+	})
+}

internal/cli/universal_login_customize.go

@@ -120,7 +120,7 @@ var PromptScreenMap = map[string][]string{
 	"mfa-voice":                   {"mfa-voice-challenge", "mfa-voice-enrollment"},
 	"mfa-recovery-code":           {"mfa-recovery-code-challenge", "mfa-recovery-code-enrollment", "mfa-recovery-code-challenge-new-code"},
 	"invitation":                  {"accept-invitation"},
-	"organizations":               {"organization-picker", "organization-selection"},
+	"organizations":               {"organization-picker", "organization-selection", "pre-login-organization-picker"},
 	"device-flow":                 {"device-code-activation", "device-code-activation-allowed", "device-code-activation-denied", "device-code-confirmation"},
 	"common":                      {"redeem-ticket"},
 	"email-verification":          {"email-verification-result"},