diff --git a/README.md b/README.md index 4aeaaa96..6df5ad7e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# pingcli +# Ping CLI The Ping CLI is a unified command line interface for configuring and managing Ping Identity Services. @@ -15,7 +15,7 @@ Start by running the command to create a new profile and answering the prompts. ```text $ pingcli config add-profile Pingcli configuration file '/Users//.pingcli/config.yaml' does not exist. - No Action (Warning) -Creating new pingcli configuration file at: /Users//.pingcli/config.yaml +Creating new Ping CLI configuration file at: /Users//.pingcli/config.yaml New profile name: : dev New profile description: : configuration for development environment Set new profile as active: : y diff --git a/cmd/config/add_profile.go b/cmd/config/add_profile.go index 3c2e842d..a6ede486 100644 --- a/cmd/config/add_profile.go +++ b/cmd/config/add_profile.go @@ -11,9 +11,14 @@ import ( ) const ( - addProfilecommandExamples = ` pingcli config add-profile - pingcli config add-profile --name myprofile --description "My Profile desc" - pingcli config add-profile --set-active=true` + addProfilecommandExamples = ` Add a new configuration profile with a guided experience. + pingcli config add-profile + + Add a new configuration profile with a specific name and description. + pingcli config add-profile --name MyDeveloperEnv --description "My awesome new profile for my development environment" + + Add a new configuration profile with a guided experience and set it as the active profile. + pingcli config add-profile --set-active=true` ) func NewConfigAddProfileCommand() *cobra.Command { @@ -21,10 +26,12 @@ func NewConfigAddProfileCommand() *cobra.Command { Args: common.ExactArgs(0), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: addProfilecommandExamples, - Long: `Add a new configuration profile to pingcli.`, - RunE: configAddProfileRunE, - Short: "Add a new configuration profile to pingcli.", - Use: "add-profile [flags]", + Long: `Add a new custom configuration profile to the CLI. + +The new configuration profile will be stored in the CLI configuration file.`, + RunE: configAddProfileRunE, + Short: "Add a new custom configuration profile.", + Use: "add-profile [flags]", } cmd.Flags().AddFlag(options.ConfigAddProfileNameOption.Flag) diff --git a/cmd/config/config.go b/cmd/config/config.go index 9c3b3cde..2811adf7 100644 --- a/cmd/config/config.go +++ b/cmd/config/config.go @@ -15,9 +15,11 @@ func NewConfigCommand() *cobra.Command { // Args: common.ExactArgs(0), // DisableFlagsInUseLine: true, // We write our own flags in @Use attribute // Example: configCommandExamples, - Long: `A set of command for profile configuration management.`, + Long: "Manage the configuration of the CLI, including Ping product connection parameters.\n\n" + + "The Ping CLI supports the use of configuration profiles.\nConfiguration profiles can be used when connecting to multiple environments using the same Ping CLI instance, such as when managing multiple development or demonstration environments.\n\n" + + "A pre-defined default profile will be used to store the configuration of the CLI.\nAdditional custom profiles can be created using the `pingcli config add-profile` command.\nTo use a custom profile, the `--profile` flag can be used on supported commands to specify the profile to use for that command.\nTo set a custom profile as the default, use the `pingcli config set-active-profile` command.", // RunE: configRunE, - Short: "A set of command for profile configuration management.", + Short: "Manage the CLI configuration.", Use: "config", } diff --git a/cmd/config/delete_profile.go b/cmd/config/delete_profile.go index 296f1869..359197e8 100644 --- a/cmd/config/delete_profile.go +++ b/cmd/config/delete_profile.go @@ -11,8 +11,11 @@ import ( ) const ( - deleteProfileCommandExamples = ` pingcli config delete-profile - pingcli config delete-profile --profile myprofile` + deleteProfileCommandExamples = ` Delete a configuration profile by selecting from the available profiles. + pingcli config delete-profile + + Delete a configuration profile by specifying the name of an existing configured profile. + pingcli config delete-profile --profile MyDeveloperEnv` ) func NewConfigDeleteProfileCommand() *cobra.Command { @@ -20,10 +23,12 @@ func NewConfigDeleteProfileCommand() *cobra.Command { Args: common.ExactArgs(0), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: deleteProfileCommandExamples, - Long: `Delete a configuration profile from pingcli.`, - RunE: configDeleteProfileRunE, - Short: "Delete a configuration profile from pingcli.", - Use: "delete-profile [flags]", + Long: `Delete an existing custom configuration profile from the CLI. + +The profile to delete will be removed from the CLI configuration file.`, + RunE: configDeleteProfileRunE, + Short: "Delete a custom configuration profile.", + Use: "delete-profile [flags]", } cmd.Flags().AddFlag(options.ConfigDeleteProfileOption.Flag) diff --git a/cmd/config/get.go b/cmd/config/get.go index 89fc2dfe..01478e30 100644 --- a/cmd/config/get.go +++ b/cmd/config/get.go @@ -9,9 +9,14 @@ import ( ) const ( - configGetCommandExamples = ` pingcli config get pingone - pingcli config get --profile myProfile color - pingcli config get service.pingone.authentication.worker.environmentID` + configGetCommandExamples = ` Read all the configuration settings for the PingOne service in the active (or default) profile. + pingcli config get pingone + + Read the color setting for the profile named 'myProfile'. + pingcli config get --profile myProfile color + + Read the worker ID used to authenticate to the PingOne service management API. + pingcli config get service.pingone.authentication.worker.environmentID` ) func NewConfigGetCommand() *cobra.Command { @@ -19,10 +24,12 @@ func NewConfigGetCommand() *cobra.Command { Args: common.ExactArgs(1), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: configGetCommandExamples, - Long: `Get pingcli configuration settings.`, - RunE: configGetRunE, - Short: "Get pingcli configuration settings.", - Use: "get [flags] key", + Long: "Read stored configuration settings for the CLI.\n\n" + + "The `--profile` parameter can be used to read configuration settings for a specified custom configuration profile.\n" + + "Where `--profile` is not specified, configuration settings will be read for the currently active profile.", + RunE: configGetRunE, + Short: "Read stored configuration settings for the CLI.", + Use: "get [flags] key", } cmd.Flags().AddFlag(options.ConfigGetProfileOption.Flag) diff --git a/cmd/config/get_test.go b/cmd/config/get_test.go index e3b38baa..7e306552 100644 --- a/cmd/config/get_test.go +++ b/cmd/config/get_test.go @@ -23,7 +23,7 @@ func TestConfigGetCmd_TooManyArgs(t *testing.T) { // Test Config Get Command Executes when provided a full key func TestConfigGetCmd_FullKey(t *testing.T) { - err := testutils_cobra.ExecutePingcli(t, "config", "get", options.PingoneAuthenticationWorkerClientIDOption.ViperKey) + err := testutils_cobra.ExecutePingcli(t, "config", "get", options.PingOneAuthenticationWorkerClientIDOption.ViperKey) testutils.CheckExpectedError(t, err, nil) } diff --git a/cmd/config/list_profiles.go b/cmd/config/list_profiles.go index fe030cf7..7a6dad7f 100644 --- a/cmd/config/list_profiles.go +++ b/cmd/config/list_profiles.go @@ -8,7 +8,8 @@ import ( ) const ( - listProfilesCommandExamples = ` pingcli config list-profiles` + listProfilesCommandExamples = ` List all custom configuration profiles stored in the CLI configuration file. + pingcli config list-profiles` ) func NewConfigListProfilesCommand() *cobra.Command { @@ -16,9 +17,9 @@ func NewConfigListProfilesCommand() *cobra.Command { Args: common.ExactArgs(0), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: listProfilesCommandExamples, - Long: `List all configuration profiles from pingcli.`, + Long: `List all custom configuration profiles stored in the CLI configuration file.`, RunE: configListProfilesRunE, - Short: "List all configuration profiles from pingcli.", + Short: "List all custom configuration profiles.", Use: "list-profiles", } diff --git a/cmd/config/set.go b/cmd/config/set.go index 09331cc1..badd90b4 100644 --- a/cmd/config/set.go +++ b/cmd/config/set.go @@ -9,8 +9,11 @@ import ( ) const ( - configSetCommandExamples = ` pingcli config set color=true - pingcli config set --profile myProfile service.pingone.regionCode=AP` + configSetCommandExamples = ` Set the color setting to true for the currently active profile. + pingcli config set color=true + + Set the PingOne tenant region code setting to 'AP' for the profile named 'myProfile'. + pingcli config set --profile myProfile service.pingone.regionCode=AP` ) func NewConfigSetCommand() *cobra.Command { @@ -18,10 +21,12 @@ func NewConfigSetCommand() *cobra.Command { Args: common.ExactArgs(1), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: configSetCommandExamples, - Long: `Set pingcli configuration settings.`, - RunE: configSetRunE, - Short: "Set pingcli configuration settings.", - Use: "set [flags] key=value", + Long: "Set stored configuration settings for the CLI.\n\n" + + "The `--profile` parameter can be used to set configuration settings for a specified custom configuration profile.\n" + + "Where `--profile` is not specified, configuration settings will be set for the currently active profile.", + RunE: configSetRunE, + Short: "Set stored configuration settings for the CLI.", + Use: "set [flags] key=value", } cmd.Flags().AddFlag(options.ConfigSetProfileOption.Flag) diff --git a/cmd/config/set_active_profile.go b/cmd/config/set_active_profile.go index 07b21ef3..6be8fa77 100644 --- a/cmd/config/set_active_profile.go +++ b/cmd/config/set_active_profile.go @@ -11,8 +11,11 @@ import ( ) const ( - setActiveProfileCommandExamples = ` pingcli config set-active-profile - pingcli config set-active-profile --profile myprofile` + setActiveProfileCommandExamples = ` Set an active profile with an interactive prompt to select from an available profile. + pingcli config set-active-profile + + Set an active profile with a specific profile name. + pingcli config set-active-profile --profile myprofile` ) func NewConfigSetActiveProfileCommand() *cobra.Command { @@ -20,9 +23,9 @@ func NewConfigSetActiveProfileCommand() *cobra.Command { Args: common.ExactArgs(0), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: setActiveProfileCommandExamples, - Long: `Set a configuration profile as the in-use profile for pingcli.`, + Long: `Set a custom configuration profile as the in-use profile.`, RunE: configSetActiveProfileRunE, - Short: "Set a configuration profile as the in-use profile for pingcli.", + Short: "Set a custom configuration profile as the in-use profile.", Use: "set-active-profile [flags]", } diff --git a/cmd/config/set_test.go b/cmd/config/set_test.go index a3fbe95a..18c9e8ba 100644 --- a/cmd/config/set_test.go +++ b/cmd/config/set_test.go @@ -53,7 +53,7 @@ func TestConfigSetCmd_NoValueProvided(t *testing.T) { // Test Config Set Command for key 'pingone.worker.clientId' updates viper configuration func TestConfigSetCmd_CheckViperConfig(t *testing.T) { - viperKey := options.PingoneAuthenticationWorkerClientIDOption.ViperKey + viperKey := options.PingOneAuthenticationWorkerClientIDOption.ViperKey viperNewUUID := "12345678-1234-1234-1234-123456789012" err := testutils_cobra.ExecutePingcli(t, "config", "set", fmt.Sprintf("%s=%s", viperKey, viperNewUUID)) diff --git a/cmd/config/unset.go b/cmd/config/unset.go index fdd4ee3b..b94ac693 100644 --- a/cmd/config/unset.go +++ b/cmd/config/unset.go @@ -9,8 +9,11 @@ import ( ) const ( - configUnsetCommandExamples = ` pingcli config unset color - pingcli config unset --profile myProfile service.pingone.regionCode` + configUnsetCommandExamples = ` Unset the color setting for the currently active profile. + pingcli config unset color + + Unset the PingOne tenant region code setting for the profile named 'myProfile'. + pingcli config unset --profile myProfile service.pingone.regionCode` ) func NewConfigUnsetCommand() *cobra.Command { @@ -18,10 +21,12 @@ func NewConfigUnsetCommand() *cobra.Command { Args: common.ExactArgs(1), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: configUnsetCommandExamples, - Long: `Unset pingcli configuration settings.`, - RunE: configUnsetRunE, - Short: "Unset pingcli configuration settings.", - Use: "unset [flags] key", + Long: "Unset stored configuration settings for the CLI.\n\n" + + "The `--profile` parameter can be used to unset configuration settings for a specified custom configuration profile.\n" + + "Where `--profile` is not specified, configuration settings will be unset for the currently active profile.", + RunE: configUnsetRunE, + Short: "Unset stored configuration settings for the CLI.", + Use: "unset [flags] key", } cmd.Flags().AddFlag(options.ConfigUnsetProfileOption.Flag) diff --git a/cmd/config/unset_test.go b/cmd/config/unset_test.go index ba08a341..24d13eb5 100644 --- a/cmd/config/unset_test.go +++ b/cmd/config/unset_test.go @@ -39,8 +39,8 @@ func TestConfigUnsetCmd_InvalidKey(t *testing.T) { // Test Config Unset Command for key 'pingone.worker.clientId' updates viper configuration func TestConfigUnsetCmd_CheckViperConfig(t *testing.T) { - viperKey := options.PingoneAuthenticationWorkerClientIDOption.ViperKey - viperOldValue := os.Getenv(options.PingoneAuthenticationWorkerClientIDOption.EnvVar) + viperKey := options.PingOneAuthenticationWorkerClientIDOption.ViperKey + viperOldValue := os.Getenv(options.PingOneAuthenticationWorkerClientIDOption.EnvVar) err := testutils_cobra.ExecutePingcli(t, "config", "unset", viperKey) testutils.CheckExpectedError(t, err, nil) diff --git a/cmd/config/view_profile.go b/cmd/config/view_profile.go index 262c120f..a94d06a2 100644 --- a/cmd/config/view_profile.go +++ b/cmd/config/view_profile.go @@ -9,8 +9,11 @@ import ( ) const ( - viewProfileCommandExamples = ` pingcli config view-profile - pingcli config view-profile --profile myprofile` + viewProfileCommandExamples = ` View configuration for the currently active profile + pingcli config view-profile + + View configuration for a specific profile + pingcli config view-profile --profile myprofile` ) func NewConfigViewProfileCommand() *cobra.Command { @@ -18,9 +21,9 @@ func NewConfigViewProfileCommand() *cobra.Command { Args: common.ExactArgs(0), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: viewProfileCommandExamples, - Long: `View a configuration profile from pingcli.`, + Long: `View the stored configuration of a custom configuration profile.`, RunE: configViewProfileRunE, - Short: "View a configuration profile from pingcli.", + Short: "View the stored configuration of a custom configuration profile.", Use: "view-profile [flags]", } diff --git a/cmd/feedback/feedback.go b/cmd/feedback/feedback.go index e3fb281f..97f290cf 100644 --- a/cmd/feedback/feedback.go +++ b/cmd/feedback/feedback.go @@ -12,12 +12,10 @@ func NewFeedbackCommand() *cobra.Command { Args: common.ExactArgs(0), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute Example: ` pingcli feedback`, - Long: `A command to provide the user information -on how to give feedback or get help with the tool -through the use of the GitHub repository's issue tracker.`, - RunE: feedbackRunE, - Short: "Information on tool feedback", - Use: "feedback [flags]", + Long: "Provides links to report issues and provide feedback on using the CLI to Ping Identity.", + RunE: feedbackRunE, + Short: "Help us improve the CLI. Report issues or send us feedback on using the CLI tool.", + Use: "feedback [flags]", } return cmd diff --git a/cmd/platform/export.go b/cmd/platform/export.go index 76902d4c..5d2a6811 100644 --- a/cmd/platform/export.go +++ b/cmd/platform/export.go @@ -1,8 +1,6 @@ package platform import ( - "fmt" - "github.com/pingidentity/pingcli/cmd/common" platform_internal "github.com/pingidentity/pingcli/internal/commands/platform" "github.com/pingidentity/pingcli/internal/configuration/options" @@ -11,68 +9,44 @@ import ( ) const ( - commandExamples = ` pingcli platform export - pingcli platform export --output-directory dir --overwrite - pingcli platform export --export-format HCL - pingcli platform export --services pingone-platform,pingone-sso - pingcli platform export --services pingone-platform --pingone-client-environment-id envID --pingone-worker-client-id clientID --pingone-worker-client-secret clientSecret --pingone-region-code regionCode - pingcli platform export --service pingfederate --pingfederate-username user --pingfederate-password password - pingcli platform export --service pingfederate --pingfederate-client-id clientID --pingfederate-client-secret clientSecret --pingfederate-token-url tokenURL - pingcli platform export --service pingfederate --pingfederate-access-token accessToken - pingcli platform export --service pingfederate --x-bypass-external-validation=false --ca-certificate-pem-files "/path/to/cert.pem,/path/to/cert2.pem" --insecure-trust-all-tls=false` - - profileConfigurationFormat = `Profile Configuration Format: -export: - format: - services: - - - - - outputDirectory: - overwrite: - pingone: - environmentID: -service: - pingfederate: - httpsHost: - adminAPIPath: - x-bypass-external-validation: - ca-certificate-pem-files: - - - - - insecure-trust-all-tls: - authentication: - type: - basicAuth: - username: - password: - accessTokenAuth: - accessToken: - clientCredentialsAuth: - clientID: - clientSecret: - tokenURL: - scopes: - - - - - pingone: - regionCode: - authentication: - type: - worker: - clientID: - clientSecret: - environmentID: ` + commandExamples = ` Export configuration-as-code for all products configured in the configuration file, applying default options. + pingcli platform export + + Export configuration-as-code packages for all configured products to a specific directory, overwriting any previous export. + pingcli platform export --output-directory /path/to/my/directory --overwrite + + Export configuration-as-code packages for all configured products, specifying the export format as Terraform HCL. + pingcli platform export --export-format HCL + + Export configuration-as-code packages for PingOne (core platform and SSO services). + pingcli platform export --services pingone-platform,pingone-sso + + Export configuration-as-code packages for PingOne (core platform), specifying the PingOne environment connection details. + pingcli platform export --services pingone-platform --pingone-client-environment-id 3cf2... --pingone-worker-client-id a719... --pingone-worker-client-secret ey..... --pingone-region-code EU + + Export configuration-as-code packages for PingFederate, specifying the PingFederate connection details using basic authentication. + pingcli platform export --service pingfederate --pingfederate-username administrator --pingfederate-password 2FederateM0re + + Export configuration-as-code packages for PingFederate, specifying the PingFederate connection details using OAuth 2.0 client credentials. + pingcli platform export --service pingfederate --pingfederate-client-id clientID --pingfederate-client-secret clientSecret --pingfederate-token-url https://pingfederate.example.com/as/token.oauth2 + + Export configuration-as-code packages for PingFederate, specifying optional connection properties + pingcli platform export --service pingfederate --x-bypass-external-validation=false --ca-certificate-pem-files "/path/to/cert.pem,/path/to/cert2.pem" --insecure-trust-all-tls=false` ) func NewExportCommand() *cobra.Command { cmd := &cobra.Command{ Args: common.ExactArgs(0), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute - Example: fmt.Sprintf("%s\n\n%s", commandExamples, profileConfigurationFormat), - Long: `Export configuration-as-code packages for the Ping Platform.`, - Short: "Export configuration-as-code packages for the Ping Platform.", - RunE: exportRunE, - Use: "export [flags]", + Example: commandExamples, + Long: "Export configuration-as-code packages for the Ping Platform.\n\n" + + "The CLI can export Terraform HCL to use with released Terraform providers.\n" + + "The Terraform HCL option generates `import {}` block statements for resources in the target environment.\n" + + "Using Terraform `import {}` blocks, the platform's configuration can be generated and imported into state management.\n" + + "More information can be found at https://developer.hashicorp.com/terraform/language/import", + Short: "Export configuration-as-code packages for the Ping Platform.", + RunE: exportRunE, + Use: "export [flags]", } initGeneralExportFlags(cmd) @@ -98,62 +72,62 @@ func initGeneralExportFlags(cmd *cobra.Command) { cmd.Flags().AddFlag(options.PlatformExportServiceOption.Flag) cmd.Flags().AddFlag(options.PlatformExportOutputDirectoryOption.Flag) cmd.Flags().AddFlag(options.PlatformExportOverwriteOption.Flag) - cmd.Flags().AddFlag(options.PlatformExportPingoneEnvironmentIDOption.Flag) + cmd.Flags().AddFlag(options.PlatformExportPingOneEnvironmentIDOption.Flag) } func initPingOneExportFlags(cmd *cobra.Command) { - cmd.Flags().AddFlag(options.PingoneAuthenticationWorkerEnvironmentIDOption.Flag) - cmd.Flags().AddFlag(options.PingoneAuthenticationWorkerClientIDOption.Flag) - cmd.Flags().AddFlag(options.PingoneAuthenticationWorkerClientSecretOption.Flag) - cmd.Flags().AddFlag(options.PingoneRegionCodeOption.Flag) - cmd.Flags().AddFlag(options.PingoneAuthenticationTypeOption.Flag) + cmd.Flags().AddFlag(options.PingOneAuthenticationWorkerEnvironmentIDOption.Flag) + cmd.Flags().AddFlag(options.PingOneAuthenticationWorkerClientIDOption.Flag) + cmd.Flags().AddFlag(options.PingOneAuthenticationWorkerClientSecretOption.Flag) + cmd.Flags().AddFlag(options.PingOneRegionCodeOption.Flag) + cmd.Flags().AddFlag(options.PingOneAuthenticationTypeOption.Flag) cmd.MarkFlagsRequiredTogether( - options.PingoneAuthenticationWorkerEnvironmentIDOption.CobraParamName, - options.PingoneAuthenticationWorkerClientIDOption.CobraParamName, - options.PingoneAuthenticationWorkerClientSecretOption.CobraParamName, - options.PingoneRegionCodeOption.CobraParamName, + options.PingOneAuthenticationWorkerEnvironmentIDOption.CobraParamName, + options.PingOneAuthenticationWorkerClientIDOption.CobraParamName, + options.PingOneAuthenticationWorkerClientSecretOption.CobraParamName, + options.PingOneRegionCodeOption.CobraParamName, ) } func initPingFederateGeneralFlags(cmd *cobra.Command) { - cmd.Flags().AddFlag(options.PingfederateHTTPSHostOption.Flag) - cmd.Flags().AddFlag(options.PingfederateAdminAPIPathOption.Flag) + cmd.Flags().AddFlag(options.PingFederateHTTPSHostOption.Flag) + cmd.Flags().AddFlag(options.PingFederateAdminAPIPathOption.Flag) cmd.MarkFlagsRequiredTogether( - options.PingfederateHTTPSHostOption.CobraParamName, - options.PingfederateAdminAPIPathOption.CobraParamName) + options.PingFederateHTTPSHostOption.CobraParamName, + options.PingFederateAdminAPIPathOption.CobraParamName) - cmd.Flags().AddFlag(options.PingfederateXBypassExternalValidationHeaderOption.Flag) - cmd.Flags().AddFlag(options.PingfederateCACertificatePemFilesOption.Flag) - cmd.Flags().AddFlag(options.PingfederateInsecureTrustAllTLSOption.Flag) - cmd.Flags().AddFlag(options.PingfederateAuthenticationTypeOption.Flag) + cmd.Flags().AddFlag(options.PingFederateXBypassExternalValidationHeaderOption.Flag) + cmd.Flags().AddFlag(options.PingFederateCACertificatePemFilesOption.Flag) + cmd.Flags().AddFlag(options.PingFederateInsecureTrustAllTLSOption.Flag) + cmd.Flags().AddFlag(options.PingFederateAuthenticationTypeOption.Flag) } func initPingFederateBasicAuthFlags(cmd *cobra.Command) { - cmd.Flags().AddFlag(options.PingfederateBasicAuthUsernameOption.Flag) - cmd.Flags().AddFlag(options.PingfederateBasicAuthPasswordOption.Flag) + cmd.Flags().AddFlag(options.PingFederateBasicAuthUsernameOption.Flag) + cmd.Flags().AddFlag(options.PingFederateBasicAuthPasswordOption.Flag) cmd.MarkFlagsRequiredTogether( - options.PingfederateBasicAuthUsernameOption.CobraParamName, - options.PingfederateBasicAuthPasswordOption.CobraParamName, + options.PingFederateBasicAuthUsernameOption.CobraParamName, + options.PingFederateBasicAuthPasswordOption.CobraParamName, ) } func initPingFederateAccessTokenFlags(cmd *cobra.Command) { - cmd.Flags().AddFlag(options.PingfederateAccessTokenAuthAccessTokenOption.Flag) + cmd.Flags().AddFlag(options.PingFederateAccessTokenAuthAccessTokenOption.Flag) } func initPingFederateClientCredentialsFlags(cmd *cobra.Command) { - cmd.Flags().AddFlag(options.PingfederateClientCredentialsAuthClientIDOption.Flag) - cmd.Flags().AddFlag(options.PingfederateClientCredentialsAuthClientSecretOption.Flag) - cmd.Flags().AddFlag(options.PingfederateClientCredentialsAuthTokenURLOption.Flag) + cmd.Flags().AddFlag(options.PingFederateClientCredentialsAuthClientIDOption.Flag) + cmd.Flags().AddFlag(options.PingFederateClientCredentialsAuthClientSecretOption.Flag) + cmd.Flags().AddFlag(options.PingFederateClientCredentialsAuthTokenURLOption.Flag) cmd.MarkFlagsRequiredTogether( - options.PingfederateClientCredentialsAuthClientIDOption.CobraParamName, - options.PingfederateClientCredentialsAuthClientSecretOption.CobraParamName, - options.PingfederateClientCredentialsAuthTokenURLOption.CobraParamName) + options.PingFederateClientCredentialsAuthClientIDOption.CobraParamName, + options.PingFederateClientCredentialsAuthClientSecretOption.CobraParamName, + options.PingFederateClientCredentialsAuthTokenURLOption.CobraParamName) - cmd.Flags().AddFlag(options.PingfederateClientCredentialsAuthScopesOption.Flag) + cmd.Flags().AddFlag(options.PingFederateClientCredentialsAuthScopesOption.Flag) } diff --git a/cmd/platform/export_test.go b/cmd/platform/export_test.go index d72b489b..c7ca7666 100644 --- a/cmd/platform/export_test.go +++ b/cmd/platform/export_test.go @@ -158,10 +158,10 @@ func TestPlatformExportCmd_PingOneWorkerEnvironmentIdFlag(t *testing.T) { "--output-directory", outputDir, "--overwrite", "true", "--services", "pingone-protect", - "--pingone-worker-environment-id", os.Getenv(options.PingoneAuthenticationWorkerEnvironmentIDOption.EnvVar), - "--pingone-worker-client-id", os.Getenv(options.PingoneAuthenticationWorkerClientIDOption.EnvVar), - "--pingone-worker-client-secret", os.Getenv(options.PingoneAuthenticationWorkerClientSecretOption.EnvVar), - "--pingone-region-code", os.Getenv(options.PingoneRegionCodeOption.EnvVar)) + "--pingone-worker-environment-id", os.Getenv(options.PingOneAuthenticationWorkerEnvironmentIDOption.EnvVar), + "--pingone-worker-client-id", os.Getenv(options.PingOneAuthenticationWorkerClientIDOption.EnvVar), + "--pingone-worker-client-secret", os.Getenv(options.PingOneAuthenticationWorkerClientSecretOption.EnvVar), + "--pingone-region-code", os.Getenv(options.PingOneRegionCodeOption.EnvVar)) testutils.CheckExpectedError(t, err, nil) } @@ -169,7 +169,7 @@ func TestPlatformExportCmd_PingOneWorkerEnvironmentIdFlag(t *testing.T) { func TestPlatformExportCmd_PingOneWorkerEnvironmentIdFlagRequiredTogether(t *testing.T) { expectedErrorPattern := `^if any flags in the group \[pingone-worker-environment-id pingone-worker-client-id pingone-worker-client-secret pingone-region-code] are set they must all be set; missing \[pingone-region-code pingone-worker-client-id pingone-worker-client-secret]$` err := testutils_cobra.ExecutePingcli(t, "platform", "export", - "--pingone-worker-environment-id", os.Getenv(options.PingoneAuthenticationWorkerEnvironmentIDOption.EnvVar)) + "--pingone-worker-environment-id", os.Getenv(options.PingOneAuthenticationWorkerEnvironmentIDOption.EnvVar)) testutils.CheckExpectedError(t, err, &expectedErrorPattern) } @@ -181,8 +181,8 @@ func TestPlatformExportCmd_PingFederateBasicAuthFlags(t *testing.T) { "--output-directory", outputDir, "--overwrite", "true", "--services", "pingfederate", - "--pingfederate-username", os.Getenv(options.PingfederateBasicAuthUsernameOption.EnvVar), - "--pingfederate-password", os.Getenv(options.PingfederateBasicAuthPasswordOption.EnvVar), + "--pingfederate-username", os.Getenv(options.PingFederateBasicAuthUsernameOption.EnvVar), + "--pingfederate-password", os.Getenv(options.PingFederateBasicAuthPasswordOption.EnvVar), "--pingfederate-authentication-type", "basicAuth", ) testutils.CheckExpectedError(t, err, nil) @@ -220,10 +220,10 @@ func TestPlatformExportCmd_PingFederateClientCredentialsAuthFlags(t *testing.T) "--output-directory", outputDir, "--overwrite", "true", "--services", "pingfederate", - "--pingfederate-client-id", os.Getenv(options.PingfederateClientCredentialsAuthClientIDOption.EnvVar), - "--pingfederate-client-secret", os.Getenv(options.PingfederateClientCredentialsAuthClientSecretOption.EnvVar), - "--pingfederate-scopes", os.Getenv(options.PingfederateClientCredentialsAuthScopesOption.EnvVar), - "--pingfederate-token-url", os.Getenv(options.PingfederateClientCredentialsAuthTokenURLOption.EnvVar), + "--pingfederate-client-id", os.Getenv(options.PingFederateClientCredentialsAuthClientIDOption.EnvVar), + "--pingfederate-client-secret", os.Getenv(options.PingFederateClientCredentialsAuthClientSecretOption.EnvVar), + "--pingfederate-scopes", os.Getenv(options.PingFederateClientCredentialsAuthScopesOption.EnvVar), + "--pingfederate-token-url", os.Getenv(options.PingFederateClientCredentialsAuthTokenURLOption.EnvVar), "--pingfederate-authentication-type", "clientCredentialsAuth", ) testutils.CheckExpectedError(t, err, nil) @@ -263,8 +263,8 @@ func TestPlatformExportCmd_PingFederateClientCredentialsAuthFlagsInvalidTokenURL "--output-directory", outputDir, "--overwrite", "true", "--services", "pingfederate", - "--pingfederate-client-id", os.Getenv(options.PingfederateClientCredentialsAuthClientIDOption.EnvVar), - "--pingfederate-client-secret", os.Getenv(options.PingfederateClientCredentialsAuthClientSecretOption.EnvVar), + "--pingfederate-client-id", os.Getenv(options.PingFederateClientCredentialsAuthClientIDOption.EnvVar), + "--pingfederate-client-secret", os.Getenv(options.PingFederateClientCredentialsAuthClientSecretOption.EnvVar), "--pingfederate-token-url", "https://localhost:9031/as/invalid", "--pingfederate-authentication-type", "clientCredentialsAuth", ) @@ -280,8 +280,8 @@ func TestPlatformExportCmd_PingFederateXBypassHeaderFlag(t *testing.T) { "--overwrite", "true", "--services", "pingfederate", "--pingfederate-x-bypass-external-validation-header=true", - "--pingfederate-username", os.Getenv(options.PingfederateBasicAuthUsernameOption.EnvVar), - "--pingfederate-password", os.Getenv(options.PingfederateBasicAuthPasswordOption.EnvVar), + "--pingfederate-username", os.Getenv(options.PingFederateBasicAuthUsernameOption.EnvVar), + "--pingfederate-password", os.Getenv(options.PingFederateBasicAuthPasswordOption.EnvVar), "--pingfederate-authentication-type", "basicAuth", ) testutils.CheckExpectedError(t, err, nil) @@ -296,8 +296,8 @@ func TestPlatformExportCmd_PingFederateTrustAllTLSFlag(t *testing.T) { "--overwrite", "true", "--services", "pingfederate", "--pingfederate-insecure-trust-all-tls=true", - "--pingfederate-username", os.Getenv(options.PingfederateBasicAuthUsernameOption.EnvVar), - "--pingfederate-password", os.Getenv(options.PingfederateBasicAuthPasswordOption.EnvVar), + "--pingfederate-username", os.Getenv(options.PingFederateBasicAuthUsernameOption.EnvVar), + "--pingfederate-password", os.Getenv(options.PingFederateBasicAuthPasswordOption.EnvVar), "--pingfederate-authentication-type", "basicAuth", ) testutils.CheckExpectedError(t, err, nil) @@ -313,8 +313,8 @@ func TestPlatformExportCmd_PingFederateTrustAllTLSFlagFalse(t *testing.T) { "--overwrite", "true", "--services", "pingfederate", "--pingfederate-insecure-trust-all-tls=false", - "--pingfederate-username", os.Getenv(options.PingfederateBasicAuthUsernameOption.EnvVar), - "--pingfederate-password", os.Getenv(options.PingfederateBasicAuthPasswordOption.EnvVar), + "--pingfederate-username", os.Getenv(options.PingFederateBasicAuthUsernameOption.EnvVar), + "--pingfederate-password", os.Getenv(options.PingFederateBasicAuthPasswordOption.EnvVar), "--pingfederate-authentication-type", "basicAuth", ) testutils.CheckExpectedError(t, err, &expectedErrorPattern) @@ -330,8 +330,8 @@ func TestPlatformExportCmd_PingFederateCaCertificatePemFiles(t *testing.T) { "--services", "pingfederate", "--pingfederate-insecure-trust-all-tls=false", "--pingfederate-ca-certificate-pem-files", "testdata/ssl-server-crt.pem", - "--pingfederate-username", os.Getenv(options.PingfederateBasicAuthUsernameOption.EnvVar), - "--pingfederate-password", os.Getenv(options.PingfederateBasicAuthPasswordOption.EnvVar), + "--pingfederate-username", os.Getenv(options.PingFederateBasicAuthUsernameOption.EnvVar), + "--pingfederate-password", os.Getenv(options.PingFederateBasicAuthPasswordOption.EnvVar), "--pingfederate-authentication-type", "basicAuth", ) testutils.CheckExpectedError(t, err, nil) @@ -343,8 +343,8 @@ func TestPlatformExportCmd_PingFederateCaCertificatePemFilesInvalid(t *testing.T err := testutils_cobra.ExecutePingcli(t, "platform", "export", "--services", "pingfederate", "--pingfederate-ca-certificate-pem-files", "invalid/crt.pem", - "--pingfederate-username", os.Getenv(options.PingfederateBasicAuthUsernameOption.EnvVar), - "--pingfederate-password", os.Getenv(options.PingfederateBasicAuthPasswordOption.EnvVar), + "--pingfederate-username", os.Getenv(options.PingFederateBasicAuthUsernameOption.EnvVar), + "--pingfederate-password", os.Getenv(options.PingFederateBasicAuthPasswordOption.EnvVar), "--pingfederate-authentication-type", "basicAuth", ) testutils.CheckExpectedError(t, err, &expectedErrorPattern) diff --git a/cmd/platform/platform.go b/cmd/platform/platform.go index 26471555..a291a13a 100644 --- a/cmd/platform/platform.go +++ b/cmd/platform/platform.go @@ -6,8 +6,12 @@ import ( func NewPlatformCommand() *cobra.Command { cmd := &cobra.Command{ - Long: `Provides details and interactions with the connected Ping Platform.`, - Short: "Provides details and interactions with the connected Ping Platform.", + Long: `Administer and manage the Ping integrated platform. + +When multiple products are configured in the CLI, the platform command can be used to manage one or more products collectively. + +The --active-profile command switch can be used to specify the profile of Ping products to be managed.`, + Short: "Administer and manage the Ping integrated platform.", Use: "platform", } diff --git a/cmd/request/request.go b/cmd/request/request.go index d7e2d245..c131a71b 100644 --- a/cmd/request/request.go +++ b/cmd/request/request.go @@ -1,8 +1,6 @@ package request import ( - "fmt" - "github.com/pingidentity/pingcli/cmd/common" request_internal "github.com/pingidentity/pingcli/internal/commands/request" "github.com/pingidentity/pingcli/internal/configuration/options" @@ -11,37 +9,34 @@ import ( ) const ( - commandExamples = ` pingcli request --service pingone environments - pingcli request --service pingone --http-method GET environments/{{environmentID}} - pingcli request --service pingone --http-method POST --data {{raw-data}} environments - pingcli request --service pingone --http-method POST --data @{{filepath}} environments - pingcli request --service pingone --http-method DELETE environments/{{environmentID}}` - - profileConfigurationFormat = `Profile Configuration Format: -request: - data: @ OR - http-method: - service: -service: - pingone: - regionCode: - authentication: - type: - worker: - clientID: - clientSecret: - environmentID: ` + commandExamples = ` Send a custom API request to the configured PingOne tenant, making a GET request against the /environments endpoint. + pingcli request --service pingone environments + + Send a custom API request to the configured PingOne tenant, making a GET request to retrieve JSON configuration for a specific environment. + pingcli request --service pingone --http-method GET environments/$MY_ENVIRONMENT_ID + + Send a custom API request to the configured PingOne tenant, making a POST request to create a new environment with raw JSON data. + pingcli request --service pingone --http-method POST --data '{"name": "My environment"}' environments + + Send a custom API request to the configured PingOne tenant, making a POST request to create a new environment with JSON data sourced from a file. + pingcli request --service pingone --http-method POST --data @./my-environment.json environments + + Send a custom API request to the configured PingOne tenant, making a DELETE request to remove an application attribute mapping. + pingcli request --service pingone --http-method DELETE environments/$MY_ENVIRONMENT_ID/applications/$MY_APPLICATION_ID/attributes/$MY_ATTRIBUTE_MAPPING_ID` ) func NewRequestCommand() *cobra.Command { cmd := &cobra.Command{ Args: common.ExactArgs(1), DisableFlagsInUseLine: true, // We write our own flags in @Use attribute - Example: fmt.Sprintf("%s\n\n%s", commandExamples, profileConfigurationFormat), - Long: `Send a custom request to a Ping Service.`, - RunE: requestRunE, - Short: "Send a custom request to a Ping Service.", - Use: "request [flags] API_URI", + Example: commandExamples, + Long: `Send a custom REST API request to a Ping Service. + +The custom REST API request is most powerful when product connection details have been configured in the CLI configuration file. +The command offers a cURL-like experience to interact with the Ping platform services, with authentication and environment details dynamically filled by the CLI.`, + RunE: requestRunE, + Short: "Send a custom REST API request to a Ping platform service.", + Use: "request [flags] API_URI", } cmd.Flags().AddFlag(options.RequestHTTPMethodOption.Flag) diff --git a/cmd/root.go b/cmd/root.go index 0d71698d..3ddd9115 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -18,20 +18,10 @@ import ( "github.com/spf13/viper" ) -const ( - ConfigurationFileFormat = `Configuration File Format: -activeProfile: - -: - color: - outputFormat: - ...` -) - func init() { l := logger.Get() - l.Debug().Msgf("Initializing Pingcli options...") + l.Debug().Msgf("Initializing Ping CLI options...") configuration.InitAllOptions() l.Debug().Msgf("Initializing Root command...") @@ -41,9 +31,8 @@ func init() { // rootCmd represents the base command when called without any subcommands func NewRootCommand() *cobra.Command { cmd := &cobra.Command{ - Example: ConfigurationFileFormat, - Long: `A CLI tool for managing Ping Identity products.`, - Short: "A CLI tool for managing Ping Identity products.", + Long: "A CLI tool for managing the configuration of Ping Identity products.", + Short: "A CLI tool for managing the configuration of Ping Identity products.", SilenceErrors: true, // Upon error in RunE method, let output package in main.go handle error output Use: "pingcli", Version: "v2.0.0-alpha.4", @@ -114,7 +103,7 @@ func initViperProfile() { // Validate the configuration if err := profiles.Validate(); err != nil { output.Print(output.Opts{ - Message: "Failed to validate pingcli configuration", + Message: "Failed to validate Ping CLI configuration", Result: output.ENUM_RESULT_FAILURE, FatalMessage: err.Error(), }) @@ -128,7 +117,7 @@ func checkCfgFileLocation(cfgFile string) { // Only create a new configuration file if it is the default configuration file location if cfgFile == options.RootConfigOption.DefaultValue.String() { output.Print(output.Opts{ - Message: fmt.Sprintf("Pingcli configuration file '%s' does not exist.", cfgFile), + Message: fmt.Sprintf("Ping CLI configuration file '%s' does not exist.", cfgFile), Result: output.ENUM_RESULT_NOACTION_WARN, }) @@ -152,7 +141,7 @@ func checkCfgFileLocation(cfgFile string) { func createConfigFile(cfgFile string) { output.Print(output.Opts{ - Message: fmt.Sprintf("Creating new pingcli configuration file at: %s", cfgFile), + Message: fmt.Sprintf("Creating new Ping CLI configuration file at: %s", cfgFile), Result: output.ENUM_RESULT_NIL, }) @@ -160,7 +149,7 @@ func createConfigFile(cfgFile string) { err := os.MkdirAll(filepath.Dir(cfgFile), os.ModePerm) if err != nil { output.Print(output.Opts{ - Message: fmt.Sprintf("Failed to make directories needed for new pingcli configuration file: %s", cfgFile), + Message: fmt.Sprintf("Failed to make directories needed for new Ping CLI configuration file: %s", cfgFile), Result: output.ENUM_RESULT_FAILURE, FatalMessage: err.Error(), }) @@ -168,7 +157,7 @@ func createConfigFile(cfgFile string) { tempViper := viper.New() tempViper.Set(options.RootActiveProfileOption.ViperKey, options.RootActiveProfileOption.DefaultValue) - tempViper.Set(fmt.Sprintf("%s.%v", options.RootActiveProfileOption.DefaultValue.String(), options.ProfileDescriptionOption.ViperKey), "Default profile created by pingcli") + tempViper.Set(fmt.Sprintf("%s.%v", options.RootActiveProfileOption.DefaultValue.String(), options.ProfileDescriptionOption.ViperKey), "Default profile created by Ping CLI") err = tempViper.WriteConfigAs(cfgFile) if err != nil { diff --git a/internal/commands/config/set_internal.go b/internal/commands/config/set_internal.go index 53a25fd8..39b35948 100644 --- a/internal/commands/config/set_internal.go +++ b/internal/commands/config/set_internal.go @@ -130,9 +130,9 @@ func setValue(profileViper *viper.Viper, vKey, vValue string, valueType options. } profileViper.Set(vKey, outputFormat) case options.ENUM_PINGONE_REGION_CODE: - region := new(customtypes.PingoneRegionCode) + region := new(customtypes.PingOneRegionCode) if err = region.Set(vValue); err != nil { - return fmt.Errorf("value for key '%s' must be a valid Pingone Region Code. Allowed [%s]: %v", vKey, strings.Join(customtypes.PingoneRegionCodeValidValues(), ", "), err) + return fmt.Errorf("value for key '%s' must be a valid PingOne Region Code. Allowed [%s]: %v", vKey, strings.Join(customtypes.PingOneRegionCodeValidValues(), ", "), err) } profileViper.Set(vKey, region) case options.ENUM_STRING: @@ -154,15 +154,15 @@ func setValue(profileViper *viper.Viper, vKey, vValue string, valueType options. } profileViper.Set(vKey, uuid) case options.ENUM_PINGONE_AUTH_TYPE: - authType := new(customtypes.PingoneAuthenticationType) + authType := new(customtypes.PingOneAuthenticationType) if err = authType.Set(vValue); err != nil { - return fmt.Errorf("value for key '%s' must be a valid Pingone Authentication Type. Allowed [%s]: %v", vKey, strings.Join(customtypes.PingoneAuthenticationTypeValidValues(), ", "), err) + return fmt.Errorf("value for key '%s' must be a valid PingOne Authentication Type. Allowed [%s]: %v", vKey, strings.Join(customtypes.PingOneAuthenticationTypeValidValues(), ", "), err) } profileViper.Set(vKey, authType) case options.ENUM_PINGFEDERATE_AUTH_TYPE: - authType := new(customtypes.PingfederateAuthenticationType) + authType := new(customtypes.PingFederateAuthenticationType) if err = authType.Set(vValue); err != nil { - return fmt.Errorf("value for key '%s' must be a valid Pingfederate Authentication Type. Allowed [%s]: %v", vKey, strings.Join(customtypes.PingfederateAuthenticationTypeValidValues(), ", "), err) + return fmt.Errorf("value for key '%s' must be a valid PingFederate Authentication Type. Allowed [%s]: %v", vKey, strings.Join(customtypes.PingFederateAuthenticationTypeValidValues(), ", "), err) } profileViper.Set(vKey, authType) case options.ENUM_INT: diff --git a/internal/commands/feedback/feedback_internal.go b/internal/commands/feedback/feedback_internal.go index 0e28eedd..5393a6e9 100644 --- a/internal/commands/feedback/feedback_internal.go +++ b/internal/commands/feedback/feedback_internal.go @@ -4,15 +4,21 @@ import ( "github.com/pingidentity/pingcli/internal/output" ) -const FeedbackMessage string = `Thank you for participating in early adoption of the refreshed Ping Identity universal CLI! +const FeedbackMessage string = `We want to hear your feedback! -We appreciate your feedback and suggestions for improvement regarding your experiences with the CLI. +New features you'd like to see? +Things you like or dislike? +Bugs you've encountered? -Please visit the following URL in your browser to fill out a short, anonymous survey that will help guide our development efforts and improve the CLI for all users: +We're looking for your comments and suggestions regarding your experiences with the CLI to make the tool better for our developer community. + +Please visit the following URL in your browser to fill out a short, anonymous survey that will help us understand more about your experiences with the CLI. +Most fields are optional, and you can fill out the form as many times as you like, so please do provide feedback whenever you have something to share. https://forms.gle/xLz6ao4Ts86Zn2yt9 -If you encounter any bugs while using the tool, please open an issue on the project's GitHub repository's issue tracker: +If you encounter any bugs while using the tool, please report it to us. +Open an issue on the project's GitHub repository's issue tracker: https://github.com/pingidentity/pingcli/issues/new diff --git a/internal/commands/platform/export_internal.go b/internal/commands/platform/export_internal.go index 7742bc0a..c7669930 100644 --- a/internal/commands/platform/export_internal.go +++ b/internal/commands/platform/export_internal.go @@ -105,11 +105,11 @@ func initPingFederateServices(ctx context.Context, pingcliVersion string) (err e return fmt.Errorf("failed to initialize PingFederate services. context is nil") } - pfInsecureTrustAllTLS, err := profiles.GetOptionValue(options.PingfederateInsecureTrustAllTLSOption) + pfInsecureTrustAllTLS, err := profiles.GetOptionValue(options.PingFederateInsecureTrustAllTLSOption) if err != nil { return err } - caCertPemFiles, err := profiles.GetOptionValue(options.PingfederateCACertificatePemFilesOption) + caCertPemFiles, err := profiles.GetOptionValue(options.PingFederateCACertificatePemFilesOption) if err != nil { return err } @@ -148,18 +148,18 @@ func initPingFederateServices(ctx context.Context, pingcliVersion string) (err e } // Create context based on pingfederate authentication type - authType, err := profiles.GetOptionValue(options.PingfederateAuthenticationTypeOption) + authType, err := profiles.GetOptionValue(options.PingFederateAuthenticationTypeOption) if err != nil { return err } switch { case strings.EqualFold(authType, customtypes.ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC): - pfUsername, err := profiles.GetOptionValue(options.PingfederateBasicAuthUsernameOption) + pfUsername, err := profiles.GetOptionValue(options.PingFederateBasicAuthUsernameOption) if err != nil { return err } - pfPassword, err := profiles.GetOptionValue(options.PingfederateBasicAuthPasswordOption) + pfPassword, err := profiles.GetOptionValue(options.PingFederateBasicAuthPasswordOption) if err != nil { return err } @@ -173,7 +173,7 @@ func initPingFederateServices(ctx context.Context, pingcliVersion string) (err e Password: pfPassword, }) case strings.EqualFold(authType, customtypes.ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_ACCESS_TOKEN): - pfAccessToken, err := profiles.GetOptionValue(options.PingfederateAccessTokenAuthAccessTokenOption) + pfAccessToken, err := profiles.GetOptionValue(options.PingFederateAccessTokenAuthAccessTokenOption) if err != nil { return err } @@ -184,19 +184,19 @@ func initPingFederateServices(ctx context.Context, pingcliVersion string) (err e pingfederateContext = context.WithValue(ctx, pingfederateGoClient.ContextAccessToken, pfAccessToken) case strings.EqualFold(authType, customtypes.ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_CLIENT_CREDENTIALS): - pfClientID, err := profiles.GetOptionValue(options.PingfederateClientCredentialsAuthClientIDOption) + pfClientID, err := profiles.GetOptionValue(options.PingFederateClientCredentialsAuthClientIDOption) if err != nil { return err } - pfClientSecret, err := profiles.GetOptionValue(options.PingfederateClientCredentialsAuthClientSecretOption) + pfClientSecret, err := profiles.GetOptionValue(options.PingFederateClientCredentialsAuthClientSecretOption) if err != nil { return err } - pfTokenUrl, err := profiles.GetOptionValue(options.PingfederateClientCredentialsAuthTokenURLOption) + pfTokenUrl, err := profiles.GetOptionValue(options.PingFederateClientCredentialsAuthTokenURLOption) if err != nil { return err } - pfScopes, err := profiles.GetOptionValue(options.PingfederateClientCredentialsAuthScopesOption) + pfScopes, err := profiles.GetOptionValue(options.PingFederateClientCredentialsAuthScopesOption) if err != nil { return err } @@ -245,15 +245,15 @@ func initPingFederateApiClient(tr *http.Transport, pingcliVersion string) (err e return fmt.Errorf("failed to initialize pingfederate API client. http transport is nil") } - httpsHost, err := profiles.GetOptionValue(options.PingfederateHTTPSHostOption) + httpsHost, err := profiles.GetOptionValue(options.PingFederateHTTPSHostOption) if err != nil { return err } - adminApiPath, err := profiles.GetOptionValue(options.PingfederateAdminAPIPathOption) + adminApiPath, err := profiles.GetOptionValue(options.PingFederateAdminAPIPathOption) if err != nil { return err } - xBypassExternalValidationHeader, err := profiles.GetOptionValue(options.PingfederateXBypassExternalValidationHeaderOption) + xBypassExternalValidationHeader, err := profiles.GetOptionValue(options.PingFederateXBypassExternalValidationHeaderOption) if err != nil { return err } @@ -298,19 +298,19 @@ func initPingOneApiClient(ctx context.Context, pingcliVersion string) (err error return fmt.Errorf("failed to initialize pingone API client. context is nil") } - pingoneApiClientId, err = profiles.GetOptionValue(options.PingoneAuthenticationWorkerClientIDOption) + pingoneApiClientId, err = profiles.GetOptionValue(options.PingOneAuthenticationWorkerClientIDOption) if err != nil { return err } - clientSecret, err := profiles.GetOptionValue(options.PingoneAuthenticationWorkerClientSecretOption) + clientSecret, err := profiles.GetOptionValue(options.PingOneAuthenticationWorkerClientSecretOption) if err != nil { return err } - environmentID, err := profiles.GetOptionValue(options.PingoneAuthenticationWorkerEnvironmentIDOption) + environmentID, err := profiles.GetOptionValue(options.PingOneAuthenticationWorkerEnvironmentIDOption) if err != nil { return err } - regionCode, err := profiles.GetOptionValue(options.PingoneRegionCodeOption) + regionCode, err := profiles.GetOptionValue(options.PingOneRegionCodeOption) if err != nil { return err } @@ -400,13 +400,13 @@ func createOrValidateOutputDir(outputDir string, overwriteExport bool) (err erro } func getPingOneExportEnvID() (err error) { - pingoneExportEnvID, err = profiles.GetOptionValue(options.PlatformExportPingoneEnvironmentIDOption) + pingoneExportEnvID, err = profiles.GetOptionValue(options.PlatformExportPingOneEnvironmentIDOption) if err != nil { return err } if pingoneExportEnvID == "" { - pingoneExportEnvID, err = profiles.GetOptionValue(options.PingoneAuthenticationWorkerEnvironmentIDOption) + pingoneExportEnvID, err = profiles.GetOptionValue(options.PingOneAuthenticationWorkerEnvironmentIDOption) if err != nil { return err } diff --git a/internal/commands/request/request_internal.go b/internal/commands/request/request_internal.go index 499e0a92..822f2f3c 100644 --- a/internal/commands/request/request_internal.go +++ b/internal/commands/request/request_internal.go @@ -17,7 +17,7 @@ import ( "github.com/pingidentity/pingcli/internal/profiles" ) -type PingoneAuthResponse struct { +type PingOneAuthResponse struct { AccessToken string `json:"access_token"` TokenType string `json:"token_type"` ExpiresIn int64 `json:"expires_in"` @@ -120,7 +120,7 @@ func runInternalPingOneRequest(uri string) (err error) { } func getTopLevelDomain() (topLevelDomain string, err error) { - pingoneRegionCode, err := profiles.GetOptionValue(options.PingoneRegionCodeOption) + pingoneRegionCode, err := profiles.GetOptionValue(options.PingOneRegionCodeOption) if err != nil { return "", err } @@ -141,7 +141,7 @@ func getTopLevelDomain() (topLevelDomain string, err error) { case customtypes.ENUM_PINGONE_REGION_CODE_NA: topLevelDomain = customtypes.ENUM_PINGONE_TLD_NA default: - return "", fmt.Errorf("unrecognized Pingone region code: '%s'", pingoneRegionCode) + return "", fmt.Errorf("unrecognized PingOne region code: '%s'", pingoneRegionCode) } return topLevelDomain, nil @@ -194,7 +194,7 @@ func pingoneAuth() (accessToken string, err error) { return "", err } - workerEnvId, err := profiles.GetOptionValue(options.PingoneAuthenticationWorkerEnvironmentIDOption) + workerEnvId, err := profiles.GetOptionValue(options.PingOneAuthenticationWorkerEnvironmentIDOption) if err != nil { return "", err } @@ -205,11 +205,11 @@ func pingoneAuth() (accessToken string, err error) { authURL := fmt.Sprintf("https://auth.pingone.%s/%s/as/token", topLevelDomain, workerEnvId) - clientId, err := profiles.GetOptionValue(options.PingoneAuthenticationWorkerClientIDOption) + clientId, err := profiles.GetOptionValue(options.PingOneAuthenticationWorkerClientIDOption) if err != nil { return "", err } - clientSecret, err := profiles.GetOptionValue(options.PingoneAuthenticationWorkerClientSecretOption) + clientSecret, err := profiles.GetOptionValue(options.PingOneAuthenticationWorkerClientSecretOption) if err != nil { return "", err } @@ -246,7 +246,7 @@ func pingoneAuth() (accessToken string, err error) { return "", fmt.Errorf("failed to authenticate with PingOne: Response Status %s: Response Body %s", res.Status, string(responseBodyBytes)) } - pingoneAuthResponse := new(PingoneAuthResponse) + pingoneAuthResponse := new(PingOneAuthResponse) err = json.Unmarshal(responseBodyBytes, pingoneAuthResponse) if err != nil { return "", err diff --git a/internal/commands/request/request_internal_test.go b/internal/commands/request/request_internal_test.go index 628f0616..7a6702f6 100644 --- a/internal/commands/request/request_internal_test.go +++ b/internal/commands/request/request_internal_test.go @@ -74,7 +74,7 @@ func Test_runInternalPingOneRequest_InvalidURI(t *testing.T) { func Test_getTopLevelDomain(t *testing.T) { testutils_viper.InitVipers(t) - t.Setenv(options.PingoneRegionCodeOption.EnvVar, customtypes.ENUM_PINGONE_REGION_CODE_CA) + t.Setenv(options.PingOneRegionCodeOption.EnvVar, customtypes.ENUM_PINGONE_REGION_CODE_CA) domain, err := getTopLevelDomain() testutils.CheckExpectedError(t, err, nil) @@ -89,10 +89,10 @@ func Test_getTopLevelDomain(t *testing.T) { func Test_getTopLevelDomain_InvalidRegionCode(t *testing.T) { testutils_viper.InitVipers(t) - t.Setenv(options.PingoneRegionCodeOption.EnvVar, "invalid-region") + t.Setenv(options.PingOneRegionCodeOption.EnvVar, "invalid-region") _, err := getTopLevelDomain() - expectedErrorPattern := "unrecognized Pingone region code: 'invalid-region'" + expectedErrorPattern := "unrecognized PingOne region code: 'invalid-region'" testutils.CheckExpectedError(t, err, &expectedErrorPattern) } @@ -132,7 +132,7 @@ func Test_pingoneAuth(t *testing.T) { func Test_pingoneAuth_InvalidCredentials(t *testing.T) { testutils_viper.InitVipers(t) - t.Setenv(options.PingoneAuthenticationWorkerClientIDOption.EnvVar, "invalid") + t.Setenv(options.PingOneAuthenticationWorkerClientIDOption.EnvVar, "invalid") _, err := pingoneAuth() expectedErrorPattern := `(?s)^failed to authenticate with PingOne: Response Status 401 Unauthorized: Response Body .*$` diff --git a/internal/configuration/config/add_profile.go b/internal/configuration/config/add_profile.go index 9031abbc..95026b60 100644 --- a/internal/configuration/config/add_profile.go +++ b/internal/configuration/config/add_profile.go @@ -69,7 +69,7 @@ func initAddProfileSetActiveOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "s", - Usage: "Set the new configuration profile as the active profile for pingcli.", + Usage: "Set the new configuration profile as the active profile.", Value: cobraValue, DefValue: "false", }, diff --git a/internal/configuration/config/config.go b/internal/configuration/config/config.go index 8d485867..31dbb8dc 100644 --- a/internal/configuration/config/config.go +++ b/internal/configuration/config/config.go @@ -25,7 +25,7 @@ func initConfigProfileOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "p", - Usage: "The name of the profile to update.", + Usage: "The name of the profile to update. E.g. `myAwesomeProfile`", Value: cobraValue, DefValue: "The active profile", }, diff --git a/internal/configuration/config/delete_profile.go b/internal/configuration/config/delete_profile.go index f9550708..24fb66f2 100644 --- a/internal/configuration/config/delete_profile.go +++ b/internal/configuration/config/delete_profile.go @@ -23,7 +23,7 @@ func initDeleteProfileOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "p", - Usage: "The configuration profile to delete.", + Usage: "The name of the configuration profile to delete.", Value: cobraValue, DefValue: "", }, diff --git a/internal/configuration/config/get.go b/internal/configuration/config/get.go index 8a5f4de5..5e7b433d 100644 --- a/internal/configuration/config/get.go +++ b/internal/configuration/config/get.go @@ -23,7 +23,7 @@ func initGetProfileOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "p", - Usage: "The configuration profile used to get the configuration value from.", + Usage: "The name of the configuration profile used to get the configuration value from.", Value: cobraValue, DefValue: "The active profile", }, diff --git a/internal/configuration/config/set.go b/internal/configuration/config/set.go index e166e0c0..952d5fd9 100644 --- a/internal/configuration/config/set.go +++ b/internal/configuration/config/set.go @@ -23,7 +23,7 @@ func initSetProfileOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "p", - Usage: "The configuration profile used to set the configuration value.", + Usage: "The name of the configuration profile used to set the configuration value to.", Value: cobraValue, DefValue: "The active profile", }, diff --git a/internal/configuration/config/set_active_profile.go b/internal/configuration/config/set_active_profile.go index daa2bc72..4d29081b 100644 --- a/internal/configuration/config/set_active_profile.go +++ b/internal/configuration/config/set_active_profile.go @@ -23,7 +23,7 @@ func initSetActiveProfileOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "p", - Usage: "The configuration profile to set as the active profile.", + Usage: "The name of the configuration profile to set as the active profile.", Value: cobraValue, DefValue: "", }, diff --git a/internal/configuration/config/unset.go b/internal/configuration/config/unset.go index dc1b1ac0..50becd04 100644 --- a/internal/configuration/config/unset.go +++ b/internal/configuration/config/unset.go @@ -23,7 +23,7 @@ func initUnsetProfileOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "p", - Usage: "The configuration profile used to unset the configuration value.", + Usage: "The name of the configuration profile to unset a configuration value from.", Value: cobraValue, DefValue: "The active profile", }, diff --git a/internal/configuration/config/view_profile.go b/internal/configuration/config/view_profile.go index 9a67a24a..8d3f296a 100644 --- a/internal/configuration/config/view_profile.go +++ b/internal/configuration/config/view_profile.go @@ -23,7 +23,7 @@ func initViewProfileOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "p", - Usage: "The configuration profile name to view.", + Usage: "The name of configuration profile to view.", Value: cobraValue, DefValue: "The active profile", }, diff --git a/internal/configuration/configuration.go b/internal/configuration/configuration.go index 3e3e63e9..19ff6704 100644 --- a/internal/configuration/configuration.go +++ b/internal/configuration/configuration.go @@ -98,6 +98,6 @@ func InitAllOptions() { configuration_request.InitRequestOptions() - configuration_services.InitPingfederateServiceOptions() - configuration_services.InitPingoneServiceOptions() + configuration_services.InitPingFederateServiceOptions() + configuration_services.InitPingOneServiceOptions() } diff --git a/internal/configuration/options/options.go b/internal/configuration/options/options.go index b4af62f0..42e9de69 100644 --- a/internal/configuration/options/options.go +++ b/internal/configuration/options/options.go @@ -33,31 +33,31 @@ type Option struct { func Options() []Option { return []Option{ - PingoneAuthenticationTypeOption, - PingoneAuthenticationWorkerClientIDOption, - PingoneAuthenticationWorkerClientSecretOption, - PingoneAuthenticationWorkerEnvironmentIDOption, - PingoneRegionCodeOption, + PingOneAuthenticationTypeOption, + PingOneAuthenticationWorkerClientIDOption, + PingOneAuthenticationWorkerClientSecretOption, + PingOneAuthenticationWorkerEnvironmentIDOption, + PingOneRegionCodeOption, PlatformExportExportFormatOption, PlatformExportServiceOption, PlatformExportOutputDirectoryOption, PlatformExportOverwriteOption, - PlatformExportPingoneEnvironmentIDOption, - - PingfederateHTTPSHostOption, - PingfederateAdminAPIPathOption, - PingfederateXBypassExternalValidationHeaderOption, - PingfederateCACertificatePemFilesOption, - PingfederateInsecureTrustAllTLSOption, - PingfederateBasicAuthUsernameOption, - PingfederateBasicAuthPasswordOption, - PingfederateAccessTokenAuthAccessTokenOption, - PingfederateClientCredentialsAuthClientIDOption, - PingfederateClientCredentialsAuthClientSecretOption, - PingfederateClientCredentialsAuthTokenURLOption, - PingfederateClientCredentialsAuthScopesOption, - PingfederateAuthenticationTypeOption, + PlatformExportPingOneEnvironmentIDOption, + + PingFederateHTTPSHostOption, + PingFederateAdminAPIPathOption, + PingFederateXBypassExternalValidationHeaderOption, + PingFederateCACertificatePemFilesOption, + PingFederateInsecureTrustAllTLSOption, + PingFederateBasicAuthUsernameOption, + PingFederateBasicAuthPasswordOption, + PingFederateAccessTokenAuthAccessTokenOption, + PingFederateClientCredentialsAuthClientIDOption, + PingFederateClientCredentialsAuthClientSecretOption, + PingFederateClientCredentialsAuthTokenURLOption, + PingFederateClientCredentialsAuthScopesOption, + PingFederateAuthenticationTypeOption, RootActiveProfileOption, RootColorOption, @@ -89,28 +89,28 @@ func Options() []Option { // pingone service options var ( - PingoneAuthenticationTypeOption Option - PingoneAuthenticationWorkerClientIDOption Option - PingoneAuthenticationWorkerClientSecretOption Option - PingoneAuthenticationWorkerEnvironmentIDOption Option - PingoneRegionCodeOption Option + PingOneAuthenticationTypeOption Option + PingOneAuthenticationWorkerClientIDOption Option + PingOneAuthenticationWorkerClientSecretOption Option + PingOneAuthenticationWorkerEnvironmentIDOption Option + PingOneRegionCodeOption Option ) // pingfederate service options var ( - PingfederateHTTPSHostOption Option - PingfederateAdminAPIPathOption Option - PingfederateXBypassExternalValidationHeaderOption Option - PingfederateCACertificatePemFilesOption Option - PingfederateInsecureTrustAllTLSOption Option - PingfederateBasicAuthUsernameOption Option - PingfederateBasicAuthPasswordOption Option - PingfederateAccessTokenAuthAccessTokenOption Option - PingfederateClientCredentialsAuthClientIDOption Option - PingfederateClientCredentialsAuthClientSecretOption Option - PingfederateClientCredentialsAuthTokenURLOption Option - PingfederateClientCredentialsAuthScopesOption Option - PingfederateAuthenticationTypeOption Option + PingFederateHTTPSHostOption Option + PingFederateAdminAPIPathOption Option + PingFederateXBypassExternalValidationHeaderOption Option + PingFederateCACertificatePemFilesOption Option + PingFederateInsecureTrustAllTLSOption Option + PingFederateBasicAuthUsernameOption Option + PingFederateBasicAuthPasswordOption Option + PingFederateAccessTokenAuthAccessTokenOption Option + PingFederateClientCredentialsAuthClientIDOption Option + PingFederateClientCredentialsAuthClientSecretOption Option + PingFederateClientCredentialsAuthTokenURLOption Option + PingFederateClientCredentialsAuthScopesOption Option + PingFederateAuthenticationTypeOption Option ) // 'pingcli config' command options @@ -142,7 +142,7 @@ var ( PlatformExportServiceOption Option PlatformExportOutputDirectoryOption Option PlatformExportOverwriteOption Option - PlatformExportPingoneEnvironmentIDOption Option + PlatformExportPingOneEnvironmentIDOption Option ) // Generic viper profile options diff --git a/internal/configuration/platform/export.go b/internal/configuration/platform/export.go index bd6fd4c4..0e61907e 100644 --- a/internal/configuration/platform/export.go +++ b/internal/configuration/platform/export.go @@ -33,7 +33,7 @@ func initFormatOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "f", - Usage: fmt.Sprintf("Specifies export format\nAllowed: [%s]. Also configurable via environment variable %s", strings.Join(customtypes.ExportFormatValidValues(), ", "), envVar), + Usage: fmt.Sprintf("Specifies the export format. E.g. `HCL`.\nOptions are: [%s].", strings.Join(customtypes.ExportFormatValidValues(), ", ")), Value: cobraValue, DefValue: customtypes.ENUM_EXPORT_FORMAT_HCL, }, @@ -56,7 +56,7 @@ func initServicesOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "s", - Usage: fmt.Sprintf("Specifies service(s) to export. Accepts comma-separated string to delimit multiple services. Allowed: [%s]. Also configurable via environment variable %s", strings.Join(customtypes.ExportServicesValidValues(), ", "), envVar), + Usage: fmt.Sprintf("Specifies the service(s) to export. Accepts a comma-separated string to delimit multiple services. Options are: [%s].", strings.Join(customtypes.ExportServicesValidValues(), ", ")), Value: cobraValue, DefValue: strings.Join(customtypes.ExportServicesValidValues(), ", "), }, @@ -79,7 +79,7 @@ func initOutputDirectoryOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "d", - Usage: fmt.Sprintf("Specifies output directory for export. Also configurable via environment variable %s", envVar), + Usage: "Specifies the output directory for export.", Value: cobraValue, DefValue: "$(pwd)/export", }, @@ -101,7 +101,7 @@ func initOverwriteOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "o", - Usage: "Overwrite existing generated exports in output directory.", + Usage: "Overwrite the existing generated exports in output directory.", Value: cobraValue, DefValue: "false", }, @@ -135,14 +135,14 @@ func initPingOneEnvironmentIDOption() { defaultValue := customtypes.UUID("") envVar := "PINGCLI_PINGONE_EXPORT_ENVIRONMENT_ID" - options.PlatformExportPingoneEnvironmentIDOption = options.Option{ + options.PlatformExportPingOneEnvironmentIDOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The ID of the Pingone environment to export. Also configurable via environment variable %s", envVar), + Usage: "The ID of the PingOne environment to export.", Value: cobraValue, DefValue: "", }, diff --git a/internal/configuration/request/request.go b/internal/configuration/request/request.go index 9e9413b1..1aeab8ac 100644 --- a/internal/configuration/request/request.go +++ b/internal/configuration/request/request.go @@ -31,7 +31,7 @@ func initDataOption() { EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: "The data to send in the request. Use prefix '@' to specify data filepath instead of raw data.", + Usage: "The data to send in the request. Use prefix '@' to specify data file path instead of raw data. (e.g. @data.json)", Value: cobraValue, DefValue: "", }, @@ -53,7 +53,7 @@ func initHTTPMethodOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "m", - Usage: fmt.Sprintf("The HTTP method to use for the request. Allowed: %s.", strings.Join(customtypes.HTTPMethodValidValues(), ", ")), + Usage: fmt.Sprintf("The HTTP method to use for the request. Options are: %s.", strings.Join(customtypes.HTTPMethodValidValues(), ", ")), Value: cobraValue, DefValue: customtypes.ENUM_HTTP_METHOD_GET, }, @@ -76,7 +76,7 @@ func initServiceOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "s", - Usage: fmt.Sprintf("The service to send a custom request. Allowed: %s. Also configurable via environment variable %s.", strings.Join(customtypes.RequestServiceValidValues(), ", "), envVar), + Usage: fmt.Sprintf("The Ping service (configured in the active profile) to send the custom request to. Options are: %s. Also configurable via environment variable %s.", strings.Join(customtypes.RequestServiceValidValues(), ", "), envVar), Value: cobraValue, DefValue: "", }, diff --git a/internal/configuration/root/root.go b/internal/configuration/root/root.go index fb72f123..b68197af 100644 --- a/internal/configuration/root/root.go +++ b/internal/configuration/root/root.go @@ -31,7 +31,7 @@ func initActiveProfileOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "P", - Usage: "Profile to use from configuration file", + Usage: "The name of the stored custom configuration profile to use.", Value: cobraValue, DefValue: "default", }, @@ -52,7 +52,7 @@ func initColorOption() { EnvVar: "PINGCLI_COLOR", Flag: &pflag.Flag{ Name: cobraParamName, - Usage: "Use colorized output", + Usage: "Show text output in color.", Value: cobraValue, DefValue: "true", }, @@ -74,7 +74,7 @@ func initConfigOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "C", - Usage: "Configuration file location", + Usage: "The relative or full path to a custom Ping CLI configuration file.", Value: cobraValue, DefValue: "\"$HOME/.pingcli/config.yaml\"", }, @@ -96,7 +96,7 @@ func initOutputFormatOption() { Flag: &pflag.Flag{ Name: cobraParamName, Shorthand: "O", - Usage: fmt.Sprintf("Specifies pingcli's console output format. Allowed: %s", strings.Join(customtypes.OutputFormatValidValues(), ", ")), + Usage: fmt.Sprintf("Specify the console output format. Options are: %s", strings.Join(customtypes.OutputFormatValidValues(), ", ")), Value: cobraValue, DefValue: customtypes.ENUM_OUTPUT_FORMAT_TEXT, }, diff --git a/internal/configuration/services/pingfederate.go b/internal/configuration/services/pingfederate.go index 012bc608..efe3500e 100644 --- a/internal/configuration/services/pingfederate.go +++ b/internal/configuration/services/pingfederate.go @@ -9,7 +9,7 @@ import ( "github.com/spf13/pflag" ) -func InitPingfederateServiceOptions() { +func InitPingFederateServiceOptions() { initHTTPSHostOption() initAdminAPIPathOption() initXBypassExternalValidationHeaderOption() @@ -22,7 +22,7 @@ func InitPingfederateServiceOptions() { initClientSecretOption() initTokenURLOption() initScopesOption() - initPingfederateAuthenticationTypeOption() + initPingFederateAuthenticationTypeOption() } func initHTTPSHostOption() { @@ -31,14 +31,14 @@ func initHTTPSHostOption() { defaultValue := customtypes.String("") envVar := "PINGCLI_PINGFEDERATE_HTTPS_HOST" - options.PingfederateHTTPSHostOption = options.Option{ + options.PingFederateHTTPSHostOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The PingFederate HTTPS host used to communicate with PingFederate's API. Also configurable via environment variable %s", envVar), + Usage: "The PingFederate HTTPS host used to communicate with PingFederate's admin API.", Value: cobraValue, DefValue: "", }, @@ -53,14 +53,14 @@ func initAdminAPIPathOption() { defaultValue := customtypes.String("/pf-admin-api/v1") envVar := "PINGCLI_PINGFEDERATE_ADMIN_API_PATH" - options.PingfederateAdminAPIPathOption = options.Option{ + options.PingFederateAdminAPIPathOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The PingFederate API URL path used to communicate with PingFederate's API. Also configurable via environment variable %s", envVar), + Usage: "The PingFederate API URL path used to communicate with PingFederate's admin API.", Value: cobraValue, DefValue: "/pf-admin-api/v1", }, @@ -75,14 +75,14 @@ func initXBypassExternalValidationHeaderOption() { defaultValue := customtypes.Bool(false) envVar := "PINGCLI_PINGFEDERATE_X_BYPASS_EXTERNAL_VALIDATION_HEADER" - options.PingfederateXBypassExternalValidationHeaderOption = options.Option{ + options.PingFederateXBypassExternalValidationHeaderOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("Header value in request for PingFederate. PingFederate's connection tests will be bypassed when set to true. Also configurable via environment variable %s", envVar), + Usage: "Bypass connection tests when configuring PingFederate (the X-BypassExternalValidation header when using PingFederate's admin API).", Value: cobraValue, DefValue: "false", }, @@ -97,14 +97,14 @@ func initCACertificatePemFilesOption() { defaultValue := customtypes.StringSlice{} envVar := "PINGCLI_PINGFEDERATE_CA_CERTIFICATE_PEM_FILES" - options.PingfederateCACertificatePemFilesOption = options.Option{ + options.PingFederateCACertificatePemFilesOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("Paths to files containing PEM-encoded certificates to be trusted as root CAs when connecting to the PingFederate server over HTTPS. Accepts comma-separated string to delimit multiple PEM files. Also configurable via environment variable %s", envVar), + Usage: "Relative or full paths to PEM-encoded certificate files to be trusted as root CAs when connecting to the PingFederate server over HTTPS. Accepts a comma-separated string to delimit multiple PEM files.", Value: cobraValue, DefValue: "[]", }, @@ -119,14 +119,14 @@ func initInsecureTrustAllTLSOption() { defaultValue := customtypes.Bool(false) envVar := "PINGCLI_PINGFEDERATE_INSECURE_TRUST_ALL_TLS" - options.PingfederateInsecureTrustAllTLSOption = options.Option{ + options.PingFederateInsecureTrustAllTLSOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("Set to true to trust any certificate when connecting to the PingFederate server. This is insecure and should not be enabled outside of testing. Also configurable via environment variable %s", envVar), + Usage: "Trust any certificate when connecting to the PingFederate server admin API. This is insecure and should not be enabled outside of testing.", Value: cobraValue, DefValue: "false", }, @@ -141,14 +141,14 @@ func initUsernameOption() { defaultValue := customtypes.String("") envVar := "PINGCLI_PINGFEDERATE_USERNAME" - options.PingfederateBasicAuthUsernameOption = options.Option{ + options.PingFederateBasicAuthUsernameOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The PingFederate username used to authenticate. Also configurable via environment variable %s", envVar), + Usage: "The PingFederate username used to authenticate to the PingFederate admin API when using basic authentication.", Value: cobraValue, DefValue: "", }, @@ -163,14 +163,14 @@ func initPasswordOption() { defaultValue := customtypes.String("") envVar := "PINGCLI_PINGFEDERATE_PASSWORD" - options.PingfederateBasicAuthPasswordOption = options.Option{ + options.PingFederateBasicAuthPasswordOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The PingFederate password used to authenticate. Also configurable via environment variable %s", envVar), + Usage: "The PingFederate password used to authenticate to the PingFederate admin API when using basic authentication.", Value: cobraValue, DefValue: "", }, @@ -185,14 +185,14 @@ func initAccessTokenOption() { defaultValue := customtypes.String("") envVar := "PINGCLI_PINGFEDERATE_ACCESS_TOKEN" - options.PingfederateAccessTokenAuthAccessTokenOption = options.Option{ + options.PingFederateAccessTokenAuthAccessTokenOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The PingFederate access token used to authenticate. Also configurable via environment variable %s", envVar), + Usage: "The PingFederate access token used to authenticate to the PingFederate admin API when using a custom OAuth 2.0 token method.", Value: cobraValue, DefValue: "", }, @@ -207,14 +207,14 @@ func initClientIDOption() { defaultValue := customtypes.String("") envVar := "PINGCLI_PINGFEDERATE_CLIENT_ID" - options.PingfederateClientCredentialsAuthClientIDOption = options.Option{ + options.PingFederateClientCredentialsAuthClientIDOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The PingFederate OAuth client ID used to authenticate. Also configurable via environment variable %s", envVar), + Usage: "The PingFederate OAuth client ID used to authenticate to the PingFederate admin API when using the OAuth 2.0 client credentials grant type.", Value: cobraValue, DefValue: "", }, @@ -229,14 +229,14 @@ func initClientSecretOption() { defaultValue := customtypes.String("") envVar := "PINGCLI_PINGFEDERATE_CLIENT_SECRET" - options.PingfederateClientCredentialsAuthClientSecretOption = options.Option{ + options.PingFederateClientCredentialsAuthClientSecretOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The PingFederate OAuth client secret used to authenticate. Also configurable via environment variable %s", envVar), + Usage: "The PingFederate OAuth client secret used to authenticate to the PingFederate admin API when using the OAuth 2.0 client credentials grant type.", Value: cobraValue, DefValue: "", }, @@ -251,14 +251,14 @@ func initTokenURLOption() { defaultValue := customtypes.String("") envVar := "PINGCLI_PINGFEDERATE_TOKEN_URL" - options.PingfederateClientCredentialsAuthTokenURLOption = options.Option{ + options.PingFederateClientCredentialsAuthTokenURLOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The PingFederate OAuth token URL used to authenticate. Also configurable via environment variable %s", envVar), + Usage: "The PingFederate OAuth token URL used to authenticate to the PingFederate admin API when using the OAuth 2.0 client credentials grant type.", Value: cobraValue, DefValue: "", }, @@ -273,14 +273,14 @@ func initScopesOption() { defaultValue := customtypes.StringSlice{} envVar := "PINGCLI_PINGFEDERATE_SCOPES" - options.PingfederateClientCredentialsAuthScopesOption = options.Option{ + options.PingFederateClientCredentialsAuthScopesOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The PingFederate OAuth scopes used to authenticate. Accepts comma-separated string to delimit multiple scopes. Also configurable via environment variable %s", envVar), + Usage: "The PingFederate OAuth scopes used to authenticate to the PingFederate admin API when using the OAuth 2.0 client credentials grant type. Accepts a comma-separated string to delimit multiple scopes.", Value: cobraValue, DefValue: "[]", }, @@ -289,20 +289,20 @@ func initScopesOption() { } } -func initPingfederateAuthenticationTypeOption() { +func initPingFederateAuthenticationTypeOption() { cobraParamName := "pingfederate-authentication-type" - cobraValue := new(customtypes.PingfederateAuthenticationType) - defaultValue := customtypes.PingfederateAuthenticationType("") + cobraValue := new(customtypes.PingFederateAuthenticationType) + defaultValue := customtypes.PingFederateAuthenticationType("") envVar := "PINGCLI_PINGFEDERATE_AUTHENTICATION_TYPE" - options.PingfederateAuthenticationTypeOption = options.Option{ + options.PingFederateAuthenticationTypeOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The authentication type to use with the PingFederate service. Allowed: %s. Also configurable via environment variable %s", strings.Join(customtypes.PingfederateAuthenticationTypeValidValues(), ", "), envVar), + Usage: fmt.Sprintf("The authentication type to use when connecting to the PingFederate admin API. Options are: %s.", strings.Join(customtypes.PingFederateAuthenticationTypeValidValues(), ", ")), Value: cobraValue, DefValue: "", }, diff --git a/internal/configuration/services/pingone.go b/internal/configuration/services/pingone.go index 0fb48376..e74bc16a 100644 --- a/internal/configuration/services/pingone.go +++ b/internal/configuration/services/pingone.go @@ -9,8 +9,8 @@ import ( "github.com/spf13/pflag" ) -func InitPingoneServiceOptions() { - initPingoneAuthenticationTypeOption() +func InitPingOneServiceOptions() { + initPingOneAuthenticationTypeOption() initAuthenticationWorkerClientIDOption() initAuthenticationWorkerClientSecretOption() initAuthenticationWorkerEnvironmentIDOption() @@ -24,14 +24,14 @@ func initAuthenticationWorkerClientIDOption() { defaultValue := customtypes.UUID("") envVar := "PINGCLI_PINGONE_WORKER_CLIENT_ID" - options.PingoneAuthenticationWorkerClientIDOption = options.Option{ + options.PingOneAuthenticationWorkerClientIDOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The Pingone worker client ID used to authenticate. Also configurable via environment variable %s", envVar), + Usage: "The worker client ID used to authenticate to the PingOne management API.", Value: cobraValue, DefValue: "", }, @@ -46,14 +46,14 @@ func initAuthenticationWorkerClientSecretOption() { defaultValue := customtypes.String("") envVar := "PINGCLI_PINGONE_WORKER_CLIENT_SECRET" - options.PingoneAuthenticationWorkerClientSecretOption = options.Option{ + options.PingOneAuthenticationWorkerClientSecretOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The Pingone worker client secret used to authenticate. Also configurable via environment variable %s", envVar), + Usage: "The worker client secret used to authenticate to the PingOne management API.", Value: cobraValue, DefValue: "", }, @@ -68,14 +68,14 @@ func initAuthenticationWorkerEnvironmentIDOption() { defaultValue := customtypes.UUID("") envVar := "PINGCLI_PINGONE_WORKER_ENVIRONMENT_ID" - options.PingoneAuthenticationWorkerEnvironmentIDOption = options.Option{ + options.PingOneAuthenticationWorkerEnvironmentIDOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The ID of the Pingone environment that contains the worker client used to authenticate. Also configurable via environment variable %s", envVar), + Usage: "The ID of the PingOne environment that contains the worker client used to authenticate to the PingOne management API.", Value: cobraValue, DefValue: "", }, @@ -84,22 +84,22 @@ func initAuthenticationWorkerEnvironmentIDOption() { } } -func initPingoneAuthenticationTypeOption() { +func initPingOneAuthenticationTypeOption() { cobraParamName := "pingone-authentication-type" - cobraValue := new(customtypes.PingoneAuthenticationType) - defaultValue := customtypes.PingoneAuthenticationType("") + cobraValue := new(customtypes.PingOneAuthenticationType) + defaultValue := customtypes.PingOneAuthenticationType("") envVar := "PINGCLI_PINGONE_AUTHENTICATION_TYPE" - options.PingoneAuthenticationTypeOption = options.Option{ + options.PingOneAuthenticationTypeOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The authentication type to use with the Pingone service. Allowed: %s. Also configurable via environment variable %s", strings.Join(customtypes.PingoneAuthenticationTypeValidValues(), ", "), envVar), + Usage: fmt.Sprintf("The authentication type to use to authenticate to the PingOne management API. Options are: %s.", strings.Join(customtypes.PingOneAuthenticationTypeValidValues(), ", ")), Value: cobraValue, - DefValue: "", + DefValue: customtypes.ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER, }, Type: options.ENUM_PINGONE_AUTH_TYPE, ViperKey: "service.pingone.authentication.type", @@ -108,18 +108,18 @@ func initPingoneAuthenticationTypeOption() { func initRegionCodeOption() { cobraParamName := "pingone-region-code" - cobraValue := new(customtypes.PingoneRegionCode) - defaultValue := customtypes.PingoneRegionCode("") + cobraValue := new(customtypes.PingOneRegionCode) + defaultValue := customtypes.PingOneRegionCode("") envVar := "PINGCLI_PINGONE_REGION_CODE" - options.PingoneRegionCodeOption = options.Option{ + options.PingOneRegionCodeOption = options.Option{ CobraParamName: cobraParamName, CobraParamValue: cobraValue, DefaultValue: &defaultValue, EnvVar: envVar, Flag: &pflag.Flag{ Name: cobraParamName, - Usage: fmt.Sprintf("The region code of the Pingone service. Allowed: %s. Also configurable via environment variable %s", strings.Join(customtypes.PingoneRegionCodeValidValues(), ", "), envVar), + Usage: fmt.Sprintf("The region code of the PingOne tenant. Options are: %s.", strings.Join(customtypes.PingOneRegionCodeValidValues(), ", ")), Value: cobraValue, DefValue: "", }, diff --git a/internal/connector/pingfederate/pingfederate_connector.go b/internal/connector/pingfederate/pingfederate_connector.go index 72f90cde..1611c973 100644 --- a/internal/connector/pingfederate/pingfederate_connector.go +++ b/internal/connector/pingfederate/pingfederate_connector.go @@ -16,17 +16,17 @@ const ( // Verify that the connector satisfies the expected interfaces var ( - _ connector.Exportable = &PingfederateConnector{} - _ connector.Authenticatable = &PingfederateConnector{} + _ connector.Exportable = &PingFederateConnector{} + _ connector.Authenticatable = &PingFederateConnector{} ) -type PingfederateConnector struct { +type PingFederateConnector struct { clientInfo connector.PingFederateClientInfo } -// Utility method for creating a PingfederateConnector -func PFConnector(ctx context.Context, apiClient *pingfederateGoClient.APIClient) *PingfederateConnector { - return &PingfederateConnector{ +// Utility method for creating a PingFederateConnector +func PFConnector(ctx context.Context, apiClient *pingfederateGoClient.APIClient) *PingFederateConnector { + return &PingFederateConnector{ clientInfo: connector.PingFederateClientInfo{ ApiClient: apiClient, Context: ctx, @@ -34,10 +34,10 @@ func PFConnector(ctx context.Context, apiClient *pingfederateGoClient.APIClient) } } -func (c *PingfederateConnector) Export(format, outputDir string, overwriteExport bool) error { +func (c *PingFederateConnector) Export(format, outputDir string, overwriteExport bool) error { l := logger.Get() - l.Debug().Msgf("Exporting all Pingfederate Resources...") + l.Debug().Msgf("Exporting all PingFederate Resources...") exportableResources := []connector.ExportableResource{ resources.AuthenticationApiApplication(&c.clientInfo), @@ -66,7 +66,7 @@ func (c *PingfederateConnector) Export(format, outputDir string, overwriteExport resources.OpenIDConnectPolicy(&c.clientInfo), resources.OpenIDConnectSettings(&c.clientInfo), resources.PasswordCredentialValidator(&c.clientInfo), - resources.PingoneConnection(&c.clientInfo), + resources.PingOneConnection(&c.clientInfo), resources.RedirectValidation(&c.clientInfo), resources.ServerSettings(&c.clientInfo), resources.ServerSettingsGeneral(&c.clientInfo), @@ -81,14 +81,14 @@ func (c *PingfederateConnector) Export(format, outputDir string, overwriteExport return common.WriteFiles(exportableResources, format, outputDir, overwriteExport) } -func (c *PingfederateConnector) ConnectorServiceName() string { +func (c *PingFederateConnector) ConnectorServiceName() string { return serviceName } -func (c *PingfederateConnector) Login() error { +func (c *PingFederateConnector) Login() error { return nil } -func (c *PingfederateConnector) Logout() error { +func (c *PingFederateConnector) Logout() error { return nil } diff --git a/internal/connector/pingfederate/pingfederate_connector_test.go b/internal/connector/pingfederate/pingfederate_connector_test.go index 39b2136c..24535c86 100644 --- a/internal/connector/pingfederate/pingfederate_connector_test.go +++ b/internal/connector/pingfederate/pingfederate_connector_test.go @@ -165,8 +165,8 @@ func TestPingFederateTerraformPlan(t *testing.T) { }, }, { - name: "PingFederatePingoneConnection", - resource: resources.PingoneConnection(PingFederateClientInfo), + name: "PingFederatePingOneConnection", + resource: resources.PingOneConnection(PingFederateClientInfo), ignoredErrors: []string{ "Error: Missing Configuration for Required Attribute", }, diff --git a/internal/connector/pingfederate/resources/pingfederate_pingone_connection.go b/internal/connector/pingfederate/resources/pingfederate_pingone_connection.go index 24c3d689..c751e7a1 100644 --- a/internal/connector/pingfederate/resources/pingfederate_pingone_connection.go +++ b/internal/connector/pingfederate/resources/pingfederate_pingone_connection.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingFederatePingoneConnectionResource{} + _ connector.ExportableResource = &PingFederatePingOneConnectionResource{} ) -type PingFederatePingoneConnectionResource struct { +type PingFederatePingOneConnectionResource struct { clientInfo *connector.PingFederateClientInfo } -// Utility method for creating a PingFederatePingoneConnectionResource -func PingoneConnection(clientInfo *connector.PingFederateClientInfo) *PingFederatePingoneConnectionResource { - return &PingFederatePingoneConnectionResource{ +// Utility method for creating a PingFederatePingOneConnectionResource +func PingOneConnection(clientInfo *connector.PingFederateClientInfo) *PingFederatePingOneConnectionResource { + return &PingFederatePingOneConnectionResource{ clientInfo: clientInfo, } } -func (r *PingFederatePingoneConnectionResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingFederatePingOneConnectionResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -79,6 +79,6 @@ func (r *PingFederatePingoneConnectionResource) ExportAll() (*[]connector.Import return &importBlocks, nil } -func (r *PingFederatePingoneConnectionResource) ResourceType() string { +func (r *PingFederatePingOneConnectionResource) ResourceType() string { return "pingfederate_pingone_connection" } diff --git a/internal/connector/pingfederate/resources/pingfederate_pingone_connection_test.go b/internal/connector/pingfederate/resources/pingfederate_pingone_connection_test.go index 7aaa4a78..a9170ca7 100644 --- a/internal/connector/pingfederate/resources/pingfederate_pingone_connection_test.go +++ b/internal/connector/pingfederate/resources/pingfederate_pingone_connection_test.go @@ -8,10 +8,10 @@ import ( "github.com/pingidentity/pingcli/internal/testing/testutils" ) -func TestPingFederatePingoneConnectionExport(t *testing.T) { +func TestPingFederatePingOneConnectionExport(t *testing.T) { // Get initialized apiClient and resource PingFederateClientInfo := testutils.GetPingFederateClientInfo(t) - resource := resources.PingoneConnection(PingFederateClientInfo) + resource := resources.PingOneConnection(PingFederateClientInfo) // Defined the expected ImportBlocks for the resource expectedImportBlocks := []connector.ImportBlock{ diff --git a/internal/connector/pingone/mfa/pingone_mfa_connector.go b/internal/connector/pingone/mfa/pingone_mfa_connector.go index 906b98ba..efd59045 100644 --- a/internal/connector/pingone/mfa/pingone_mfa_connector.go +++ b/internal/connector/pingone/mfa/pingone_mfa_connector.go @@ -16,17 +16,17 @@ const ( // Verify that the connector satisfies the expected interfaces var ( - _ connector.Exportable = &PingoneMFAConnector{} - _ connector.Authenticatable = &PingoneMFAConnector{} + _ connector.Exportable = &PingOneMFAConnector{} + _ connector.Authenticatable = &PingOneMFAConnector{} ) -type PingoneMFAConnector struct { +type PingOneMFAConnector struct { clientInfo connector.PingOneClientInfo } -// Utility method for creating a PingoneMFAConnector -func MFAConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiClientId *string, exportEnvironmentID string) *PingoneMFAConnector { - return &PingoneMFAConnector{ +// Utility method for creating a PingOneMFAConnector +func MFAConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiClientId *string, exportEnvironmentID string) *PingOneMFAConnector { + return &PingOneMFAConnector{ clientInfo: connector.PingOneClientInfo{ Context: ctx, ApiClient: apiClient, @@ -36,7 +36,7 @@ func MFAConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiCli } } -func (c *PingoneMFAConnector) Export(format, outputDir string, overwriteExport bool) error { +func (c *PingOneMFAConnector) Export(format, outputDir string, overwriteExport bool) error { l := logger.Get() l.Debug().Msgf("Exporting all PingOne MFA Resources...") @@ -51,14 +51,14 @@ func (c *PingoneMFAConnector) Export(format, outputDir string, overwriteExport b return common.WriteFiles(exportableResources, format, outputDir, overwriteExport) } -func (c *PingoneMFAConnector) ConnectorServiceName() string { +func (c *PingOneMFAConnector) ConnectorServiceName() string { return serviceName } -func (c *PingoneMFAConnector) Login() error { +func (c *PingOneMFAConnector) Login() error { return nil } -func (c *PingoneMFAConnector) Logout() error { +func (c *PingOneMFAConnector) Logout() error { return nil } diff --git a/internal/connector/pingone/mfa/resources/pingone_mfa_application_push_credential.go b/internal/connector/pingone/mfa/resources/pingone_mfa_application_push_credential.go index d86e8b8e..610aae4b 100644 --- a/internal/connector/pingone/mfa/resources/pingone_mfa_application_push_credential.go +++ b/internal/connector/pingone/mfa/resources/pingone_mfa_application_push_credential.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneMFAApplicationPushCredentialResource{} + _ connector.ExportableResource = &PingOneMFAApplicationPushCredentialResource{} ) -type PingoneMFAApplicationPushCredentialResource struct { +type PingOneMFAApplicationPushCredentialResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneMFAApplicationPushCredentialResource -func MFAApplicationPushCredential(clientInfo *connector.PingOneClientInfo) *PingoneMFAApplicationPushCredentialResource { - return &PingoneMFAApplicationPushCredentialResource{ +// Utility method for creating a PingOneMFAApplicationPushCredentialResource +func MFAApplicationPushCredential(clientInfo *connector.PingOneClientInfo) *PingOneMFAApplicationPushCredentialResource { + return &PingOneMFAApplicationPushCredentialResource{ clientInfo: clientInfo, } } -func (r *PingoneMFAApplicationPushCredentialResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneMFAApplicationPushCredentialResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -100,6 +100,6 @@ func (r *PingoneMFAApplicationPushCredentialResource) ExportAll() (*[]connector. return &importBlocks, nil } -func (r *PingoneMFAApplicationPushCredentialResource) ResourceType() string { +func (r *PingOneMFAApplicationPushCredentialResource) ResourceType() string { return "pingone_mfa_application_push_credential" } diff --git a/internal/connector/pingone/mfa/resources/pingone_mfa_device_policy.go b/internal/connector/pingone/mfa/resources/pingone_mfa_device_policy.go index 4bc69213..c26a0b5b 100644 --- a/internal/connector/pingone/mfa/resources/pingone_mfa_device_policy.go +++ b/internal/connector/pingone/mfa/resources/pingone_mfa_device_policy.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneMFADevicePolicyResource{} + _ connector.ExportableResource = &PingOneMFADevicePolicyResource{} ) -type PingoneMFADevicePolicyResource struct { +type PingOneMFADevicePolicyResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneMFADevicePolicyResource -func MFADevicePolicy(clientInfo *connector.PingOneClientInfo) *PingoneMFADevicePolicyResource { - return &PingoneMFADevicePolicyResource{ +// Utility method for creating a PingOneMFADevicePolicyResource +func MFADevicePolicy(clientInfo *connector.PingOneClientInfo) *PingOneMFADevicePolicyResource { + return &PingOneMFADevicePolicyResource{ clientInfo: clientInfo, } } -func (r *PingoneMFADevicePolicyResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneMFADevicePolicyResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneMFADevicePolicyResource) ExportAll() (*[]connector.ImportBlock, return &importBlocks, nil } -func (r *PingoneMFADevicePolicyResource) ResourceType() string { +func (r *PingOneMFADevicePolicyResource) ResourceType() string { return "pingone_mfa_device_policy" } diff --git a/internal/connector/pingone/mfa/resources/pingone_mfa_fido2_policy.go b/internal/connector/pingone/mfa/resources/pingone_mfa_fido2_policy.go index 10f28ea3..baf14c1b 100644 --- a/internal/connector/pingone/mfa/resources/pingone_mfa_fido2_policy.go +++ b/internal/connector/pingone/mfa/resources/pingone_mfa_fido2_policy.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneMFAFido2PolicyResource{} + _ connector.ExportableResource = &PingOneMFAFido2PolicyResource{} ) -type PingoneMFAFido2PolicyResource struct { +type PingOneMFAFido2PolicyResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneMFAFido2PolicyResource -func MFAFido2Policy(clientInfo *connector.PingOneClientInfo) *PingoneMFAFido2PolicyResource { - return &PingoneMFAFido2PolicyResource{ +// Utility method for creating a PingOneMFAFido2PolicyResource +func MFAFido2Policy(clientInfo *connector.PingOneClientInfo) *PingOneMFAFido2PolicyResource { + return &PingOneMFAFido2PolicyResource{ clientInfo: clientInfo, } } -func (r *PingoneMFAFido2PolicyResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneMFAFido2PolicyResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneMFAFido2PolicyResource) ExportAll() (*[]connector.ImportBlock, e return &importBlocks, nil } -func (r *PingoneMFAFido2PolicyResource) ResourceType() string { +func (r *PingOneMFAFido2PolicyResource) ResourceType() string { return "pingone_mfa_fido2_policy" } diff --git a/internal/connector/pingone/mfa/resources/pingone_mfa_settings.go b/internal/connector/pingone/mfa/resources/pingone_mfa_settings.go index 0362207d..4979858a 100644 --- a/internal/connector/pingone/mfa/resources/pingone_mfa_settings.go +++ b/internal/connector/pingone/mfa/resources/pingone_mfa_settings.go @@ -8,21 +8,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneMFASettingsResource{} + _ connector.ExportableResource = &PingOneMFASettingsResource{} ) -type PingoneMFASettingsResource struct { +type PingOneMFASettingsResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneMFASettingsResource -func MFASettings(clientInfo *connector.PingOneClientInfo) *PingoneMFASettingsResource { - return &PingoneMFASettingsResource{ +// Utility method for creating a PingOneMFASettingsResource +func MFASettings(clientInfo *connector.PingOneClientInfo) *PingOneMFASettingsResource { + return &PingOneMFASettingsResource{ clientInfo: clientInfo, } } -func (r *PingoneMFASettingsResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneMFASettingsResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -57,6 +57,6 @@ func (r *PingoneMFASettingsResource) ExportAll() (*[]connector.ImportBlock, erro return &importBlocks, nil } -func (r *PingoneMFASettingsResource) ResourceType() string { +func (r *PingOneMFASettingsResource) ResourceType() string { return "pingone_mfa_settings" } diff --git a/internal/connector/pingone/platform/pingone_platform_connector.go b/internal/connector/pingone/platform/pingone_platform_connector.go index 7855b516..4dc30f0b 100644 --- a/internal/connector/pingone/platform/pingone_platform_connector.go +++ b/internal/connector/pingone/platform/pingone_platform_connector.go @@ -16,17 +16,17 @@ const ( // Verify that the connector satisfies the expected interfaces var ( - _ connector.Exportable = &PingonePlatformConnector{} - _ connector.Authenticatable = &PingonePlatformConnector{} + _ connector.Exportable = &PingOnePlatformConnector{} + _ connector.Authenticatable = &PingOnePlatformConnector{} ) -type PingonePlatformConnector struct { +type PingOnePlatformConnector struct { clientInfo connector.PingOneClientInfo } -// Utility method for creating a PingonePlatformConnector -func PlatformConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiClientId *string, exportEnvironmentID string) *PingonePlatformConnector { - return &PingonePlatformConnector{ +// Utility method for creating a PingOnePlatformConnector +func PlatformConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiClientId *string, exportEnvironmentID string) *PingOnePlatformConnector { + return &PingOnePlatformConnector{ clientInfo: connector.PingOneClientInfo{ Context: ctx, ApiClient: apiClient, @@ -36,7 +36,7 @@ func PlatformConnector(ctx context.Context, apiClient *pingoneGoClient.Client, a } } -func (c *PingonePlatformConnector) Export(format, outputDir string, overwriteExport bool) error { +func (c *PingOnePlatformConnector) Export(format, outputDir string, overwriteExport bool) error { l := logger.Get() l.Debug().Msgf("Exporting all PingOne Platform Resources...") @@ -77,14 +77,14 @@ func (c *PingonePlatformConnector) Export(format, outputDir string, overwriteExp return common.WriteFiles(exportableResources, format, outputDir, overwriteExport) } -func (c *PingonePlatformConnector) ConnectorServiceName() string { +func (c *PingOnePlatformConnector) ConnectorServiceName() string { return serviceName } -func (c *PingonePlatformConnector) Login() error { +func (c *PingOnePlatformConnector) Login() error { return nil } -func (c *PingonePlatformConnector) Logout() error { +func (c *PingOnePlatformConnector) Logout() error { return nil } diff --git a/internal/connector/pingone/platform/resources/pingone_agreement.go b/internal/connector/pingone/platform/resources/pingone_agreement.go index 639b143b..4066b37f 100644 --- a/internal/connector/pingone/platform/resources/pingone_agreement.go +++ b/internal/connector/pingone/platform/resources/pingone_agreement.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneAgreementResource{} + _ connector.ExportableResource = &PingOneAgreementResource{} ) -type PingoneAgreementResource struct { +type PingOneAgreementResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneAgreementResource -func Agreement(clientInfo *connector.PingOneClientInfo) *PingoneAgreementResource { - return &PingoneAgreementResource{ +// Utility method for creating a PingOneAgreementResource +func Agreement(clientInfo *connector.PingOneClientInfo) *PingOneAgreementResource { + return &PingOneAgreementResource{ clientInfo: clientInfo, } } -func (r *PingoneAgreementResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneAgreementResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -64,6 +64,6 @@ func (r *PingoneAgreementResource) ExportAll() (*[]connector.ImportBlock, error) return &importBlocks, nil } -func (r *PingoneAgreementResource) ResourceType() string { +func (r *PingOneAgreementResource) ResourceType() string { return "pingone_agreement" } diff --git a/internal/connector/pingone/platform/resources/pingone_agreement_enable.go b/internal/connector/pingone/platform/resources/pingone_agreement_enable.go index d26669a9..c72db9a2 100644 --- a/internal/connector/pingone/platform/resources/pingone_agreement_enable.go +++ b/internal/connector/pingone/platform/resources/pingone_agreement_enable.go @@ -9,21 +9,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneAgreementEnableResource{} + _ connector.ExportableResource = &PingOneAgreementEnableResource{} ) -type PingoneAgreementEnableResource struct { +type PingOneAgreementEnableResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneAgreementEnableResource -func AgreementEnable(clientInfo *connector.PingOneClientInfo) *PingoneAgreementEnableResource { - return &PingoneAgreementEnableResource{ +// Utility method for creating a PingOneAgreementEnableResource +func AgreementEnable(clientInfo *connector.PingOneClientInfo) *PingOneAgreementEnableResource { + return &PingOneAgreementEnableResource{ clientInfo: clientInfo, } } -func (r *PingoneAgreementEnableResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneAgreementEnableResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all pingone_agreement_enable resources...") @@ -49,6 +49,6 @@ func (r *PingoneAgreementEnableResource) ExportAll() (*[]connector.ImportBlock, return &importBlocks, nil } -func (r *PingoneAgreementEnableResource) ResourceType() string { +func (r *PingOneAgreementEnableResource) ResourceType() string { return "pingone_agreement_enable" } diff --git a/internal/connector/pingone/platform/resources/pingone_agreement_localization.go b/internal/connector/pingone/platform/resources/pingone_agreement_localization.go index dbe6334c..cfbfd7d1 100644 --- a/internal/connector/pingone/platform/resources/pingone_agreement_localization.go +++ b/internal/connector/pingone/platform/resources/pingone_agreement_localization.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneAgreementLocalizationResource{} + _ connector.ExportableResource = &PingOneAgreementLocalizationResource{} ) -type PingoneAgreementLocalizationResource struct { +type PingOneAgreementLocalizationResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneAgreementLocalizationResource -func AgreementLocalization(clientInfo *connector.PingOneClientInfo) *PingoneAgreementLocalizationResource { - return &PingoneAgreementLocalizationResource{ +// Utility method for creating a PingOneAgreementLocalizationResource +func AgreementLocalization(clientInfo *connector.PingOneClientInfo) *PingOneAgreementLocalizationResource { + return &PingOneAgreementLocalizationResource{ clientInfo: clientInfo, } } -func (r *PingoneAgreementLocalizationResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneAgreementLocalizationResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -86,6 +86,6 @@ func (r *PingoneAgreementLocalizationResource) ExportAll() (*[]connector.ImportB return &importBlocks, nil } -func (r *PingoneAgreementLocalizationResource) ResourceType() string { +func (r *PingOneAgreementLocalizationResource) ResourceType() string { return "pingone_agreement_localization" } diff --git a/internal/connector/pingone/platform/resources/pingone_agreement_localization_enable.go b/internal/connector/pingone/platform/resources/pingone_agreement_localization_enable.go index cefef7f6..bb97939e 100644 --- a/internal/connector/pingone/platform/resources/pingone_agreement_localization_enable.go +++ b/internal/connector/pingone/platform/resources/pingone_agreement_localization_enable.go @@ -9,21 +9,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneAgreementLocalizationEnableResource{} + _ connector.ExportableResource = &PingOneAgreementLocalizationEnableResource{} ) -type PingoneAgreementLocalizationEnableResource struct { +type PingOneAgreementLocalizationEnableResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneAgreementLocalizationEnableResource -func AgreementLocalizationEnable(clientInfo *connector.PingOneClientInfo) *PingoneAgreementLocalizationEnableResource { - return &PingoneAgreementLocalizationEnableResource{ +// Utility method for creating a PingOneAgreementLocalizationEnableResource +func AgreementLocalizationEnable(clientInfo *connector.PingOneClientInfo) *PingOneAgreementLocalizationEnableResource { + return &PingOneAgreementLocalizationEnableResource{ clientInfo: clientInfo, } } -func (r *PingoneAgreementLocalizationEnableResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneAgreementLocalizationEnableResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all pingone_agreement_localization_enable resources...") @@ -49,6 +49,6 @@ func (r *PingoneAgreementLocalizationEnableResource) ExportAll() (*[]connector.I return &importBlocks, nil } -func (r *PingoneAgreementLocalizationEnableResource) ResourceType() string { +func (r *PingOneAgreementLocalizationEnableResource) ResourceType() string { return "pingone_agreement_localization_enable" } diff --git a/internal/connector/pingone/platform/resources/pingone_agreement_localization_revision.go b/internal/connector/pingone/platform/resources/pingone_agreement_localization_revision.go index 89134875..82093bcd 100644 --- a/internal/connector/pingone/platform/resources/pingone_agreement_localization_revision.go +++ b/internal/connector/pingone/platform/resources/pingone_agreement_localization_revision.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneAgreementLocalizationRevisionResource{} + _ connector.ExportableResource = &PingOneAgreementLocalizationRevisionResource{} ) -type PingoneAgreementLocalizationRevisionResource struct { +type PingOneAgreementLocalizationRevisionResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneAgreementLocalizationRevisionResource -func AgreementLocalizationRevision(clientInfo *connector.PingOneClientInfo) *PingoneAgreementLocalizationRevisionResource { - return &PingoneAgreementLocalizationRevisionResource{ +// Utility method for creating a PingOneAgreementLocalizationRevisionResource +func AgreementLocalizationRevision(clientInfo *connector.PingOneClientInfo) *PingOneAgreementLocalizationRevisionResource { + return &PingOneAgreementLocalizationRevisionResource{ clientInfo: clientInfo, } } -func (r *PingoneAgreementLocalizationRevisionResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneAgreementLocalizationRevisionResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -100,6 +100,6 @@ func (r *PingoneAgreementLocalizationRevisionResource) ExportAll() (*[]connector return &importBlocks, nil } -func (r *PingoneAgreementLocalizationRevisionResource) ResourceType() string { +func (r *PingOneAgreementLocalizationRevisionResource) ResourceType() string { return "pingone_agreement_localization_revision" } diff --git a/internal/connector/pingone/platform/resources/pingone_branding_settings.go b/internal/connector/pingone/platform/resources/pingone_branding_settings.go index 2afe2cc1..cc2cf214 100644 --- a/internal/connector/pingone/platform/resources/pingone_branding_settings.go +++ b/internal/connector/pingone/platform/resources/pingone_branding_settings.go @@ -8,21 +8,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneBrandingSettingsResource{} + _ connector.ExportableResource = &PingOneBrandingSettingsResource{} ) -type PingoneBrandingSettingsResource struct { +type PingOneBrandingSettingsResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneBrandingSettingsResource -func BrandingSettings(clientInfo *connector.PingOneClientInfo) *PingoneBrandingSettingsResource { - return &PingoneBrandingSettingsResource{ +// Utility method for creating a PingOneBrandingSettingsResource +func BrandingSettings(clientInfo *connector.PingOneClientInfo) *PingOneBrandingSettingsResource { + return &PingOneBrandingSettingsResource{ clientInfo: clientInfo, } } -func (r *PingoneBrandingSettingsResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneBrandingSettingsResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -57,6 +57,6 @@ func (r *PingoneBrandingSettingsResource) ExportAll() (*[]connector.ImportBlock, return &importBlocks, nil } -func (r *PingoneBrandingSettingsResource) ResourceType() string { +func (r *PingOneBrandingSettingsResource) ResourceType() string { return "pingone_branding_settings" } diff --git a/internal/connector/pingone/platform/resources/pingone_branding_theme.go b/internal/connector/pingone/platform/resources/pingone_branding_theme.go index 0204924a..147cd2ae 100644 --- a/internal/connector/pingone/platform/resources/pingone_branding_theme.go +++ b/internal/connector/pingone/platform/resources/pingone_branding_theme.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneBrandingThemeResource{} + _ connector.ExportableResource = &PingOneBrandingThemeResource{} ) -type PingoneBrandingThemeResource struct { +type PingOneBrandingThemeResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneBrandingThemeResource -func BrandingTheme(clientInfo *connector.PingOneClientInfo) *PingoneBrandingThemeResource { - return &PingoneBrandingThemeResource{ +// Utility method for creating a PingOneBrandingThemeResource +func BrandingTheme(clientInfo *connector.PingOneClientInfo) *PingOneBrandingThemeResource { + return &PingOneBrandingThemeResource{ clientInfo: clientInfo, } } -func (r *PingoneBrandingThemeResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneBrandingThemeResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -70,6 +70,6 @@ func (r *PingoneBrandingThemeResource) ExportAll() (*[]connector.ImportBlock, er return &importBlocks, nil } -func (r *PingoneBrandingThemeResource) ResourceType() string { +func (r *PingOneBrandingThemeResource) ResourceType() string { return "pingone_branding_theme" } diff --git a/internal/connector/pingone/platform/resources/pingone_branding_theme_default.go b/internal/connector/pingone/platform/resources/pingone_branding_theme_default.go index 0f501d66..c3763087 100644 --- a/internal/connector/pingone/platform/resources/pingone_branding_theme_default.go +++ b/internal/connector/pingone/platform/resources/pingone_branding_theme_default.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneBrandingThemeDefaultResource{} + _ connector.ExportableResource = &PingOneBrandingThemeDefaultResource{} ) -type PingoneBrandingThemeDefaultResource struct { +type PingOneBrandingThemeDefaultResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneBrandingThemeDefaultResource -func BrandingThemeDefault(clientInfo *connector.PingOneClientInfo) *PingoneBrandingThemeDefaultResource { - return &PingoneBrandingThemeDefaultResource{ +// Utility method for creating a PingOneBrandingThemeDefaultResource +func BrandingThemeDefault(clientInfo *connector.PingOneClientInfo) *PingOneBrandingThemeDefaultResource { + return &PingOneBrandingThemeDefaultResource{ clientInfo: clientInfo, } } -func (r *PingoneBrandingThemeDefaultResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneBrandingThemeDefaultResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -84,6 +84,6 @@ func (r *PingoneBrandingThemeDefaultResource) ExportAll() (*[]connector.ImportBl return &importBlocks, nil } -func (r *PingoneBrandingThemeDefaultResource) ResourceType() string { +func (r *PingOneBrandingThemeDefaultResource) ResourceType() string { return "pingone_branding_theme_default" } diff --git a/internal/connector/pingone/platform/resources/pingone_certificate.go b/internal/connector/pingone/platform/resources/pingone_certificate.go index 33e87c33..a6022acb 100644 --- a/internal/connector/pingone/platform/resources/pingone_certificate.go +++ b/internal/connector/pingone/platform/resources/pingone_certificate.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneCertificateResource{} + _ connector.ExportableResource = &PingOneCertificateResource{} ) -type PingoneCertificateResource struct { +type PingOneCertificateResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneCertificateResource -func Certificate(clientInfo *connector.PingOneClientInfo) *PingoneCertificateResource { - return &PingoneCertificateResource{ +// Utility method for creating a PingOneCertificateResource +func Certificate(clientInfo *connector.PingOneClientInfo) *PingOneCertificateResource { + return &PingOneCertificateResource{ clientInfo: clientInfo, } } -func (r *PingoneCertificateResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneCertificateResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneCertificateResource) ExportAll() (*[]connector.ImportBlock, erro return &importBlocks, nil } -func (r *PingoneCertificateResource) ResourceType() string { +func (r *PingOneCertificateResource) ResourceType() string { return "pingone_certificate" } diff --git a/internal/connector/pingone/platform/resources/pingone_custom_domain.go b/internal/connector/pingone/platform/resources/pingone_custom_domain.go index ceed1155..2a7b98ad 100644 --- a/internal/connector/pingone/platform/resources/pingone_custom_domain.go +++ b/internal/connector/pingone/platform/resources/pingone_custom_domain.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneCustomDomainResource{} + _ connector.ExportableResource = &PingOneCustomDomainResource{} ) -type PingoneCustomDomainResource struct { +type PingOneCustomDomainResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneCustomDomainResource -func CustomDomain(clientInfo *connector.PingOneClientInfo) *PingoneCustomDomainResource { - return &PingoneCustomDomainResource{ +// Utility method for creating a PingOneCustomDomainResource +func CustomDomain(clientInfo *connector.PingOneClientInfo) *PingOneCustomDomainResource { + return &PingOneCustomDomainResource{ clientInfo: clientInfo, } } -func (r *PingoneCustomDomainResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneCustomDomainResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneCustomDomainResource) ExportAll() (*[]connector.ImportBlock, err return &importBlocks, nil } -func (r *PingoneCustomDomainResource) ResourceType() string { +func (r *PingOneCustomDomainResource) ResourceType() string { return "pingone_custom_domain" } diff --git a/internal/connector/pingone/platform/resources/pingone_environment.go b/internal/connector/pingone/platform/resources/pingone_environment.go index 23e6abb9..c5ad3e9f 100644 --- a/internal/connector/pingone/platform/resources/pingone_environment.go +++ b/internal/connector/pingone/platform/resources/pingone_environment.go @@ -8,21 +8,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneCustomDomainResource{} + _ connector.ExportableResource = &PingOneCustomDomainResource{} ) -type PingoneEnvironmentResource struct { +type PingOneEnvironmentResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneEnvironmentResource -func Environment(clientInfo *connector.PingOneClientInfo) *PingoneEnvironmentResource { - return &PingoneEnvironmentResource{ +// Utility method for creating a PingOneEnvironmentResource +func Environment(clientInfo *connector.PingOneClientInfo) *PingOneEnvironmentResource { + return &PingOneEnvironmentResource{ clientInfo: clientInfo, } } -func (r *PingoneEnvironmentResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneEnvironmentResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -46,6 +46,6 @@ func (r *PingoneEnvironmentResource) ExportAll() (*[]connector.ImportBlock, erro return &importBlocks, nil } -func (r *PingoneEnvironmentResource) ResourceType() string { +func (r *PingOneEnvironmentResource) ResourceType() string { return "pingone_environment" } diff --git a/internal/connector/pingone/platform/resources/pingone_form.go b/internal/connector/pingone/platform/resources/pingone_form.go index 9a142d11..5abeb800 100644 --- a/internal/connector/pingone/platform/resources/pingone_form.go +++ b/internal/connector/pingone/platform/resources/pingone_form.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneFormResource{} + _ connector.ExportableResource = &PingOneFormResource{} ) -type PingoneFormResource struct { +type PingOneFormResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneFormResource -func Form(clientInfo *connector.PingOneClientInfo) *PingoneFormResource { - return &PingoneFormResource{ +// Utility method for creating a PingOneFormResource +func Form(clientInfo *connector.PingOneClientInfo) *PingOneFormResource { + return &PingOneFormResource{ clientInfo: clientInfo, } } -func (r *PingoneFormResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneFormResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneFormResource) ExportAll() (*[]connector.ImportBlock, error) { return &importBlocks, nil } -func (r *PingoneFormResource) ResourceType() string { +func (r *PingOneFormResource) ResourceType() string { return "pingone_form" } diff --git a/internal/connector/pingone/platform/resources/pingone_forms_recaptcha_v2.go b/internal/connector/pingone/platform/resources/pingone_forms_recaptcha_v2.go index a8b9ccdf..febb58a1 100644 --- a/internal/connector/pingone/platform/resources/pingone_forms_recaptcha_v2.go +++ b/internal/connector/pingone/platform/resources/pingone_forms_recaptcha_v2.go @@ -8,21 +8,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneFormRecaptchaV2Resource{} + _ connector.ExportableResource = &PingOneFormRecaptchaV2Resource{} ) -type PingoneFormRecaptchaV2Resource struct { +type PingOneFormRecaptchaV2Resource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneFormRecaptchaV2Resource -func FormRecaptchaV2(clientInfo *connector.PingOneClientInfo) *PingoneFormRecaptchaV2Resource { - return &PingoneFormRecaptchaV2Resource{ +// Utility method for creating a PingOneFormRecaptchaV2Resource +func FormRecaptchaV2(clientInfo *connector.PingOneClientInfo) *PingOneFormRecaptchaV2Resource { + return &PingOneFormRecaptchaV2Resource{ clientInfo: clientInfo, } } -func (r *PingoneFormRecaptchaV2Resource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneFormRecaptchaV2Resource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -59,6 +59,6 @@ func (r *PingoneFormRecaptchaV2Resource) ExportAll() (*[]connector.ImportBlock, return &importBlocks, nil } -func (r *PingoneFormRecaptchaV2Resource) ResourceType() string { +func (r *PingOneFormRecaptchaV2Resource) ResourceType() string { return "pingone_forms_recaptcha_v2" } diff --git a/internal/connector/pingone/platform/resources/pingone_gateway.go b/internal/connector/pingone/platform/resources/pingone_gateway.go index 83d491ed..c6ad38f3 100644 --- a/internal/connector/pingone/platform/resources/pingone_gateway.go +++ b/internal/connector/pingone/platform/resources/pingone_gateway.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneGatewayResource{} + _ connector.ExportableResource = &PingOneGatewayResource{} ) -type PingoneGatewayResource struct { +type PingOneGatewayResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneGatewayResource -func Gateway(clientInfo *connector.PingOneClientInfo) *PingoneGatewayResource { - return &PingoneGatewayResource{ +// Utility method for creating a PingOneGatewayResource +func Gateway(clientInfo *connector.PingOneClientInfo) *PingOneGatewayResource { + return &PingOneGatewayResource{ clientInfo: clientInfo, } } -func (r *PingoneGatewayResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneGatewayResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -83,6 +83,6 @@ func (r *PingoneGatewayResource) ExportAll() (*[]connector.ImportBlock, error) { return &importBlocks, nil } -func (r *PingoneGatewayResource) ResourceType() string { +func (r *PingOneGatewayResource) ResourceType() string { return "pingone_gateway" } diff --git a/internal/connector/pingone/platform/resources/pingone_gateway_credential.go b/internal/connector/pingone/platform/resources/pingone_gateway_credential.go index 7c65788e..7fe3548c 100644 --- a/internal/connector/pingone/platform/resources/pingone_gateway_credential.go +++ b/internal/connector/pingone/platform/resources/pingone_gateway_credential.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneGatewayCredentialResource{} + _ connector.ExportableResource = &PingOneGatewayCredentialResource{} ) -type PingoneGatewayCredentialResource struct { +type PingOneGatewayCredentialResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneGatewayCredentialResource -func GatewayCredential(clientInfo *connector.PingOneClientInfo) *PingoneGatewayCredentialResource { - return &PingoneGatewayCredentialResource{ +// Utility method for creating a PingOneGatewayCredentialResource +func GatewayCredential(clientInfo *connector.PingOneClientInfo) *PingOneGatewayCredentialResource { + return &PingOneGatewayCredentialResource{ clientInfo: clientInfo, } } -func (r *PingoneGatewayCredentialResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneGatewayCredentialResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -98,6 +98,6 @@ func (r *PingoneGatewayCredentialResource) ExportAll() (*[]connector.ImportBlock return &importBlocks, nil } -func (r *PingoneGatewayCredentialResource) ResourceType() string { +func (r *PingOneGatewayCredentialResource) ResourceType() string { return "pingone_gateway_credential" } diff --git a/internal/connector/pingone/platform/resources/pingone_gateway_role_assignment.go b/internal/connector/pingone/platform/resources/pingone_gateway_role_assignment.go index 46a51529..dbc52ef1 100644 --- a/internal/connector/pingone/platform/resources/pingone_gateway_role_assignment.go +++ b/internal/connector/pingone/platform/resources/pingone_gateway_role_assignment.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneGatewayRoleAssignmentResource{} + _ connector.ExportableResource = &PingOneGatewayRoleAssignmentResource{} ) -type PingoneGatewayRoleAssignmentResource struct { +type PingOneGatewayRoleAssignmentResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneGatewayRoleAssignmentResource -func GatewayRoleAssignment(clientInfo *connector.PingOneClientInfo) *PingoneGatewayRoleAssignmentResource { - return &PingoneGatewayRoleAssignmentResource{ +// Utility method for creating a PingOneGatewayRoleAssignmentResource +func GatewayRoleAssignment(clientInfo *connector.PingOneClientInfo) *PingOneGatewayRoleAssignmentResource { + return &PingOneGatewayRoleAssignmentResource{ clientInfo: clientInfo, } } -func (r *PingoneGatewayRoleAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneGatewayRoleAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -101,6 +101,6 @@ func (r *PingoneGatewayRoleAssignmentResource) ExportAll() (*[]connector.ImportB return &importBlocks, nil } -func (r *PingoneGatewayRoleAssignmentResource) ResourceType() string { +func (r *PingOneGatewayRoleAssignmentResource) ResourceType() string { return "pingone_gateway_role_assignment" } diff --git a/internal/connector/pingone/platform/resources/pingone_identity_propagation_plan.go b/internal/connector/pingone/platform/resources/pingone_identity_propagation_plan.go index ecc2ba7d..164b910c 100644 --- a/internal/connector/pingone/platform/resources/pingone_identity_propagation_plan.go +++ b/internal/connector/pingone/platform/resources/pingone_identity_propagation_plan.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneIdentityPropagationPlanResource{} + _ connector.ExportableResource = &PingOneIdentityPropagationPlanResource{} ) -type PingoneIdentityPropagationPlanResource struct { +type PingOneIdentityPropagationPlanResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneIdentityPropagationPlanResource -func IdentityPropagationPlan(clientInfo *connector.PingOneClientInfo) *PingoneIdentityPropagationPlanResource { - return &PingoneIdentityPropagationPlanResource{ +// Utility method for creating a PingOneIdentityPropagationPlanResource +func IdentityPropagationPlan(clientInfo *connector.PingOneClientInfo) *PingOneIdentityPropagationPlanResource { + return &PingOneIdentityPropagationPlanResource{ clientInfo: clientInfo, } } -func (r *PingoneIdentityPropagationPlanResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneIdentityPropagationPlanResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneIdentityPropagationPlanResource) ExportAll() (*[]connector.Impor return &importBlocks, nil } -func (r *PingoneIdentityPropagationPlanResource) ResourceType() string { +func (r *PingOneIdentityPropagationPlanResource) ResourceType() string { return "pingone_identity_propagation_plan" } diff --git a/internal/connector/pingone/platform/resources/pingone_key.go b/internal/connector/pingone/platform/resources/pingone_key.go index 5c26bfd3..00018427 100644 --- a/internal/connector/pingone/platform/resources/pingone_key.go +++ b/internal/connector/pingone/platform/resources/pingone_key.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneKeyResource{} + _ connector.ExportableResource = &PingOneKeyResource{} ) -type PingoneKeyResource struct { +type PingOneKeyResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneKeyResource -func Key(clientInfo *connector.PingOneClientInfo) *PingoneKeyResource { - return &PingoneKeyResource{ +// Utility method for creating a PingOneKeyResource +func Key(clientInfo *connector.PingOneClientInfo) *PingOneKeyResource { + return &PingOneKeyResource{ clientInfo: clientInfo, } } -func (r *PingoneKeyResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneKeyResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -67,6 +67,6 @@ func (r *PingoneKeyResource) ExportAll() (*[]connector.ImportBlock, error) { return &importBlocks, nil } -func (r *PingoneKeyResource) ResourceType() string { +func (r *PingOneKeyResource) ResourceType() string { return "pingone_key" } diff --git a/internal/connector/pingone/platform/resources/pingone_key_rotation_policy.go b/internal/connector/pingone/platform/resources/pingone_key_rotation_policy.go index d52b1bf0..f88ecb4e 100644 --- a/internal/connector/pingone/platform/resources/pingone_key_rotation_policy.go +++ b/internal/connector/pingone/platform/resources/pingone_key_rotation_policy.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneKeyRotationPolicyResource{} + _ connector.ExportableResource = &PingOneKeyRotationPolicyResource{} ) -type PingoneKeyRotationPolicyResource struct { +type PingOneKeyRotationPolicyResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneKeyRotationPolicyResource -func KeyRotationPolicy(clientInfo *connector.PingOneClientInfo) *PingoneKeyRotationPolicyResource { - return &PingoneKeyRotationPolicyResource{ +// Utility method for creating a PingOneKeyRotationPolicyResource +func KeyRotationPolicy(clientInfo *connector.PingOneClientInfo) *PingOneKeyRotationPolicyResource { + return &PingOneKeyRotationPolicyResource{ clientInfo: clientInfo, } } -func (r *PingoneKeyRotationPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneKeyRotationPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneKeyRotationPolicyResource) ExportAll() (*[]connector.ImportBlock return &importBlocks, nil } -func (r *PingoneKeyRotationPolicyResource) ResourceType() string { +func (r *PingOneKeyRotationPolicyResource) ResourceType() string { return "pingone_key_rotation_policy" } diff --git a/internal/connector/pingone/platform/resources/pingone_language.go b/internal/connector/pingone/platform/resources/pingone_language.go index f8a6fc94..78adc546 100644 --- a/internal/connector/pingone/platform/resources/pingone_language.go +++ b/internal/connector/pingone/platform/resources/pingone_language.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneLanguageResource{} + _ connector.ExportableResource = &PingOneLanguageResource{} ) -type PingoneLanguageResource struct { +type PingOneLanguageResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneLanguageResource -func Language(clientInfo *connector.PingOneClientInfo) *PingoneLanguageResource { - return &PingoneLanguageResource{ +// Utility method for creating a PingOneLanguageResource +func Language(clientInfo *connector.PingOneClientInfo) *PingOneLanguageResource { + return &PingOneLanguageResource{ clientInfo: clientInfo, } } -func (r *PingoneLanguageResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneLanguageResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -75,6 +75,6 @@ func (r *PingoneLanguageResource) ExportAll() (*[]connector.ImportBlock, error) return &importBlocks, nil } -func (r *PingoneLanguageResource) ResourceType() string { +func (r *PingOneLanguageResource) ResourceType() string { return "pingone_language" } diff --git a/internal/connector/pingone/platform/resources/pingone_language_update.go b/internal/connector/pingone/platform/resources/pingone_language_update.go index 8651774a..1007e6b2 100644 --- a/internal/connector/pingone/platform/resources/pingone_language_update.go +++ b/internal/connector/pingone/platform/resources/pingone_language_update.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneLanguageUpdateResource{} + _ connector.ExportableResource = &PingOneLanguageUpdateResource{} ) -type PingoneLanguageUpdateResource struct { +type PingOneLanguageUpdateResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneLanguageUpdateResource -func LanguageUpdate(clientInfo *connector.PingOneClientInfo) *PingoneLanguageUpdateResource { - return &PingoneLanguageUpdateResource{ +// Utility method for creating a PingOneLanguageUpdateResource +func LanguageUpdate(clientInfo *connector.PingOneClientInfo) *PingOneLanguageUpdateResource { + return &PingOneLanguageUpdateResource{ clientInfo: clientInfo, } } -func (r *PingoneLanguageUpdateResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneLanguageUpdateResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -77,6 +77,6 @@ func (r *PingoneLanguageUpdateResource) ExportAll() (*[]connector.ImportBlock, e return &importBlocks, nil } -func (r *PingoneLanguageUpdateResource) ResourceType() string { +func (r *PingOneLanguageUpdateResource) ResourceType() string { return "pingone_language_update" } diff --git a/internal/connector/pingone/platform/resources/pingone_notification_policy.go b/internal/connector/pingone/platform/resources/pingone_notification_policy.go index 077b4d96..a305e141 100644 --- a/internal/connector/pingone/platform/resources/pingone_notification_policy.go +++ b/internal/connector/pingone/platform/resources/pingone_notification_policy.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneNotificationPolicyResource{} + _ connector.ExportableResource = &PingOneNotificationPolicyResource{} ) -type PingoneNotificationPolicyResource struct { +type PingOneNotificationPolicyResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneNotificationPolicyResource -func NotificationPolicy(clientInfo *connector.PingOneClientInfo) *PingoneNotificationPolicyResource { - return &PingoneNotificationPolicyResource{ +// Utility method for creating a PingOneNotificationPolicyResource +func NotificationPolicy(clientInfo *connector.PingOneClientInfo) *PingOneNotificationPolicyResource { + return &PingOneNotificationPolicyResource{ clientInfo: clientInfo, } } -func (r *PingoneNotificationPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneNotificationPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneNotificationPolicyResource) ExportAll() (*[]connector.ImportBloc return &importBlocks, nil } -func (r *PingoneNotificationPolicyResource) ResourceType() string { +func (r *PingOneNotificationPolicyResource) ResourceType() string { return "pingone_notification_policy" } diff --git a/internal/connector/pingone/platform/resources/pingone_notification_settings.go b/internal/connector/pingone/platform/resources/pingone_notification_settings.go index ad4fc3d1..bfe2242f 100644 --- a/internal/connector/pingone/platform/resources/pingone_notification_settings.go +++ b/internal/connector/pingone/platform/resources/pingone_notification_settings.go @@ -8,21 +8,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneNotificationSettingsResource{} + _ connector.ExportableResource = &PingOneNotificationSettingsResource{} ) -type PingoneNotificationSettingsResource struct { +type PingOneNotificationSettingsResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneNotificationSettingsResource -func NotificationSettings(clientInfo *connector.PingOneClientInfo) *PingoneNotificationSettingsResource { - return &PingoneNotificationSettingsResource{ +// Utility method for creating a PingOneNotificationSettingsResource +func NotificationSettings(clientInfo *connector.PingOneClientInfo) *PingOneNotificationSettingsResource { + return &PingOneNotificationSettingsResource{ clientInfo: clientInfo, } } -func (r *PingoneNotificationSettingsResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneNotificationSettingsResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -57,6 +57,6 @@ func (r *PingoneNotificationSettingsResource) ExportAll() (*[]connector.ImportBl return &importBlocks, nil } -func (r *PingoneNotificationSettingsResource) ResourceType() string { +func (r *PingOneNotificationSettingsResource) ResourceType() string { return "pingone_notification_settings" } diff --git a/internal/connector/pingone/platform/resources/pingone_notification_settings_email.go b/internal/connector/pingone/platform/resources/pingone_notification_settings_email.go index 80db2417..3bd0e2dd 100644 --- a/internal/connector/pingone/platform/resources/pingone_notification_settings_email.go +++ b/internal/connector/pingone/platform/resources/pingone_notification_settings_email.go @@ -8,21 +8,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneNotificationSettingsEmailResource{} + _ connector.ExportableResource = &PingOneNotificationSettingsEmailResource{} ) -type PingoneNotificationSettingsEmailResource struct { +type PingOneNotificationSettingsEmailResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneNotificationSettingsEmailResource -func NotificationSettingsEmail(clientInfo *connector.PingOneClientInfo) *PingoneNotificationSettingsEmailResource { - return &PingoneNotificationSettingsEmailResource{ +// Utility method for creating a PingOneNotificationSettingsEmailResource +func NotificationSettingsEmail(clientInfo *connector.PingOneClientInfo) *PingOneNotificationSettingsEmailResource { + return &PingOneNotificationSettingsEmailResource{ clientInfo: clientInfo, } } -func (r *PingoneNotificationSettingsEmailResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneNotificationSettingsEmailResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -77,6 +77,6 @@ func (r *PingoneNotificationSettingsEmailResource) ExportAll() (*[]connector.Imp return &importBlocks, nil } -func (r *PingoneNotificationSettingsEmailResource) ResourceType() string { +func (r *PingOneNotificationSettingsEmailResource) ResourceType() string { return "pingone_notification_settings_email" } diff --git a/internal/connector/pingone/platform/resources/pingone_notification_template_content.go b/internal/connector/pingone/platform/resources/pingone_notification_template_content.go index 408f6955..8bd6c12c 100644 --- a/internal/connector/pingone/platform/resources/pingone_notification_template_content.go +++ b/internal/connector/pingone/platform/resources/pingone_notification_template_content.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneNotificationTemplateContentResource{} + _ connector.ExportableResource = &PingOneNotificationTemplateContentResource{} ) -type PingoneNotificationTemplateContentResource struct { +type PingOneNotificationTemplateContentResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneNotificationTemplateContentResource -func NotificationTemplateContent(clientInfo *connector.PingOneClientInfo) *PingoneNotificationTemplateContentResource { - return &PingoneNotificationTemplateContentResource{ +// Utility method for creating a PingOneNotificationTemplateContentResource +func NotificationTemplateContent(clientInfo *connector.PingOneClientInfo) *PingOneNotificationTemplateContentResource { + return &PingOneNotificationTemplateContentResource{ clientInfo: clientInfo, } } -func (r *PingoneNotificationTemplateContentResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneNotificationTemplateContentResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -161,6 +161,6 @@ func (r *PingoneNotificationTemplateContentResource) ExportAll() (*[]connector.I return &importBlocks, nil } -func (r *PingoneNotificationTemplateContentResource) ResourceType() string { +func (r *PingOneNotificationTemplateContentResource) ResourceType() string { return "pingone_notification_template_content" } diff --git a/internal/connector/pingone/platform/resources/pingone_phone_delivery_settings.go b/internal/connector/pingone/platform/resources/pingone_phone_delivery_settings.go index 0db835ef..bb8fd405 100644 --- a/internal/connector/pingone/platform/resources/pingone_phone_delivery_settings.go +++ b/internal/connector/pingone/platform/resources/pingone_phone_delivery_settings.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingonePhoneDeliverySettingsResource{} + _ connector.ExportableResource = &PingOnePhoneDeliverySettingsResource{} ) -type PingonePhoneDeliverySettingsResource struct { +type PingOnePhoneDeliverySettingsResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingonePhoneDeliverySettingsResource -func PhoneDeliverySettings(clientInfo *connector.PingOneClientInfo) *PingonePhoneDeliverySettingsResource { - return &PingonePhoneDeliverySettingsResource{ +// Utility method for creating a PingOnePhoneDeliverySettingsResource +func PhoneDeliverySettings(clientInfo *connector.PingOneClientInfo) *PingOnePhoneDeliverySettingsResource { + return &PingOnePhoneDeliverySettingsResource{ clientInfo: clientInfo, } } -func (r *PingonePhoneDeliverySettingsResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOnePhoneDeliverySettingsResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -93,6 +93,6 @@ func (r *PingonePhoneDeliverySettingsResource) ExportAll() (*[]connector.ImportB return &importBlocks, nil } -func (r *PingonePhoneDeliverySettingsResource) ResourceType() string { +func (r *PingOnePhoneDeliverySettingsResource) ResourceType() string { return "pingone_phone_delivery_settings" } diff --git a/internal/connector/pingone/platform/resources/pingone_system_application.go b/internal/connector/pingone/platform/resources/pingone_system_application.go index 783d0931..9bda3eaf 100644 --- a/internal/connector/pingone/platform/resources/pingone_system_application.go +++ b/internal/connector/pingone/platform/resources/pingone_system_application.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneSystemApplicationResource{} + _ connector.ExportableResource = &PingOneSystemApplicationResource{} ) -type PingoneSystemApplicationResource struct { +type PingOneSystemApplicationResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneSystemApplicationResource -func SystemApplication(clientInfo *connector.PingOneClientInfo) *PingoneSystemApplicationResource { - return &PingoneSystemApplicationResource{ +// Utility method for creating a PingOneSystemApplicationResource +func SystemApplication(clientInfo *connector.PingOneClientInfo) *PingOneSystemApplicationResource { + return &PingOneSystemApplicationResource{ clientInfo: clientInfo, } } -func (r *PingoneSystemApplicationResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneSystemApplicationResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -80,6 +80,6 @@ func (r *PingoneSystemApplicationResource) ExportAll() (*[]connector.ImportBlock return &importBlocks, nil } -func (r *PingoneSystemApplicationResource) ResourceType() string { +func (r *PingOneSystemApplicationResource) ResourceType() string { return "pingone_system_application" } diff --git a/internal/connector/pingone/platform/resources/pingone_trusted_email_address.go b/internal/connector/pingone/platform/resources/pingone_trusted_email_address.go index 72193c80..27274fa2 100644 --- a/internal/connector/pingone/platform/resources/pingone_trusted_email_address.go +++ b/internal/connector/pingone/platform/resources/pingone_trusted_email_address.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneTrustedEmailAddressResource{} + _ connector.ExportableResource = &PingOneTrustedEmailAddressResource{} ) -type PingoneTrustedEmailAddressResource struct { +type PingOneTrustedEmailAddressResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneTrustedEmailAddressResource -func TrustedEmailAddress(clientInfo *connector.PingOneClientInfo) *PingoneTrustedEmailAddressResource { - return &PingoneTrustedEmailAddressResource{ +// Utility method for creating a PingOneTrustedEmailAddressResource +func TrustedEmailAddress(clientInfo *connector.PingOneClientInfo) *PingOneTrustedEmailAddressResource { + return &PingOneTrustedEmailAddressResource{ clientInfo: clientInfo, } } -func (r *PingoneTrustedEmailAddressResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneTrustedEmailAddressResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -82,6 +82,6 @@ func (r *PingoneTrustedEmailAddressResource) ExportAll() (*[]connector.ImportBlo return &importBlocks, nil } -func (r *PingoneTrustedEmailAddressResource) ResourceType() string { +func (r *PingOneTrustedEmailAddressResource) ResourceType() string { return "pingone_trusted_email_address" } diff --git a/internal/connector/pingone/platform/resources/pingone_trusted_email_domain.go b/internal/connector/pingone/platform/resources/pingone_trusted_email_domain.go index 3fc78735..9f55d1fc 100644 --- a/internal/connector/pingone/platform/resources/pingone_trusted_email_domain.go +++ b/internal/connector/pingone/platform/resources/pingone_trusted_email_domain.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneTrustedEmailDomainResource{} + _ connector.ExportableResource = &PingOneTrustedEmailDomainResource{} ) -type PingoneTrustedEmailDomainResource struct { +type PingOneTrustedEmailDomainResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a Pingone Trusted Email Domain Resource -func TrustedEmailDomain(clientInfo *connector.PingOneClientInfo) *PingoneTrustedEmailDomainResource { - return &PingoneTrustedEmailDomainResource{ +// Utility method for creating a PingOne Trusted Email Domain Resource +func TrustedEmailDomain(clientInfo *connector.PingOneClientInfo) *PingOneTrustedEmailDomainResource { + return &PingOneTrustedEmailDomainResource{ clientInfo: clientInfo, } } -func (r *PingoneTrustedEmailDomainResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneTrustedEmailDomainResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneTrustedEmailDomainResource) ExportAll() (*[]connector.ImportBloc return &importBlocks, nil } -func (r *PingoneTrustedEmailDomainResource) ResourceType() string { +func (r *PingOneTrustedEmailDomainResource) ResourceType() string { return "pingone_trusted_email_domain" } diff --git a/internal/connector/pingone/platform/resources/pingone_webhook.go b/internal/connector/pingone/platform/resources/pingone_webhook.go index 17367300..b154cbfb 100644 --- a/internal/connector/pingone/platform/resources/pingone_webhook.go +++ b/internal/connector/pingone/platform/resources/pingone_webhook.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneWebhookResource{} + _ connector.ExportableResource = &PingOneWebhookResource{} ) -type PingoneWebhookResource struct { +type PingOneWebhookResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneWebhookResource -func Webhook(clientInfo *connector.PingOneClientInfo) *PingoneWebhookResource { - return &PingoneWebhookResource{ +// Utility method for creating a PingOneWebhookResource +func Webhook(clientInfo *connector.PingOneClientInfo) *PingOneWebhookResource { + return &PingOneWebhookResource{ clientInfo: clientInfo, } } -func (r *PingoneWebhookResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneWebhookResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneWebhookResource) ExportAll() (*[]connector.ImportBlock, error) { return &importBlocks, nil } -func (r *PingoneWebhookResource) ResourceType() string { +func (r *PingOneWebhookResource) ResourceType() string { return "pingone_webhook" } diff --git a/internal/connector/pingone/protect/pingone_protect_connector.go b/internal/connector/pingone/protect/pingone_protect_connector.go index 771e190a..20d3ee25 100644 --- a/internal/connector/pingone/protect/pingone_protect_connector.go +++ b/internal/connector/pingone/protect/pingone_protect_connector.go @@ -16,17 +16,17 @@ const ( // Verify that the connector satisfies the expected interfaces var ( - _ connector.Exportable = &PingoneProtectConnector{} - _ connector.Authenticatable = &PingoneProtectConnector{} + _ connector.Exportable = &PingOneProtectConnector{} + _ connector.Authenticatable = &PingOneProtectConnector{} ) -type PingoneProtectConnector struct { +type PingOneProtectConnector struct { clientInfo connector.PingOneClientInfo } -// Utility method for creating a PingoneProtectConnector -func ProtectConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiClientId *string, exportEnvironmentID string) *PingoneProtectConnector { - return &PingoneProtectConnector{ +// Utility method for creating a PingOneProtectConnector +func ProtectConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiClientId *string, exportEnvironmentID string) *PingOneProtectConnector { + return &PingOneProtectConnector{ clientInfo: connector.PingOneClientInfo{ Context: ctx, ApiClient: apiClient, @@ -36,7 +36,7 @@ func ProtectConnector(ctx context.Context, apiClient *pingoneGoClient.Client, ap } } -func (c *PingoneProtectConnector) Export(format, outputDir string, overwriteExport bool) error { +func (c *PingOneProtectConnector) Export(format, outputDir string, overwriteExport bool) error { l := logger.Get() l.Debug().Msgf("Exporting all PingOne MFA Resources...") @@ -49,14 +49,14 @@ func (c *PingoneProtectConnector) Export(format, outputDir string, overwriteExpo return common.WriteFiles(exportableResources, format, outputDir, overwriteExport) } -func (c *PingoneProtectConnector) ConnectorServiceName() string { +func (c *PingOneProtectConnector) ConnectorServiceName() string { return serviceName } -func (c *PingoneProtectConnector) Login() error { +func (c *PingOneProtectConnector) Login() error { return nil } -func (c *PingoneProtectConnector) Logout() error { +func (c *PingOneProtectConnector) Logout() error { return nil } diff --git a/internal/connector/pingone/protect/resources/pingone_risk_policy.go b/internal/connector/pingone/protect/resources/pingone_risk_policy.go index 35f996aa..a6c114dc 100644 --- a/internal/connector/pingone/protect/resources/pingone_risk_policy.go +++ b/internal/connector/pingone/protect/resources/pingone_risk_policy.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneRiskPolicyResource{} + _ connector.ExportableResource = &PingOneRiskPolicyResource{} ) -type PingoneRiskPolicyResource struct { +type PingOneRiskPolicyResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneRiskPolicyResource -func RiskPolicy(clientInfo *connector.PingOneClientInfo) *PingoneRiskPolicyResource { - return &PingoneRiskPolicyResource{ +// Utility method for creating a PingOneRiskPolicyResource +func RiskPolicy(clientInfo *connector.PingOneClientInfo) *PingOneRiskPolicyResource { + return &PingOneRiskPolicyResource{ clientInfo: clientInfo, } } -func (r *PingoneRiskPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneRiskPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -66,6 +66,6 @@ func (r *PingoneRiskPolicyResource) ExportAll() (*[]connector.ImportBlock, error return &importBlocks, nil } -func (r *PingoneRiskPolicyResource) ResourceType() string { +func (r *PingOneRiskPolicyResource) ResourceType() string { return "pingone_risk_policy" } diff --git a/internal/connector/pingone/protect/resources/pingone_risk_predictor.go b/internal/connector/pingone/protect/resources/pingone_risk_predictor.go index 9313a2e7..c27c4501 100644 --- a/internal/connector/pingone/protect/resources/pingone_risk_predictor.go +++ b/internal/connector/pingone/protect/resources/pingone_risk_predictor.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneRiskPredictorResource{} + _ connector.ExportableResource = &PingOneRiskPredictorResource{} ) -type PingoneRiskPredictorResource struct { +type PingOneRiskPredictorResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneRiskPredictorResource -func RiskPredictor(clientInfo *connector.PingOneClientInfo) *PingoneRiskPredictorResource { - return &PingoneRiskPredictorResource{ +// Utility method for creating a PingOneRiskPredictorResource +func RiskPredictor(clientInfo *connector.PingOneClientInfo) *PingOneRiskPredictorResource { + return &PingOneRiskPredictorResource{ clientInfo: clientInfo, } } -func (r *PingoneRiskPredictorResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneRiskPredictorResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -132,6 +132,6 @@ func (r *PingoneRiskPredictorResource) ExportAll() (*[]connector.ImportBlock, er return &importBlocks, nil } -func (r *PingoneRiskPredictorResource) ResourceType() string { +func (r *PingOneRiskPredictorResource) ResourceType() string { return "pingone_risk_predictor" } diff --git a/internal/connector/pingone/sso/pingone_sso_connector.go b/internal/connector/pingone/sso/pingone_sso_connector.go index 0d715973..6fd004ce 100644 --- a/internal/connector/pingone/sso/pingone_sso_connector.go +++ b/internal/connector/pingone/sso/pingone_sso_connector.go @@ -16,17 +16,17 @@ const ( // Verify that the connector satisfies the expected interfaces var ( - _ connector.Exportable = &PingoneSSOConnector{} - _ connector.Authenticatable = &PingoneSSOConnector{} + _ connector.Exportable = &PingOneSSOConnector{} + _ connector.Authenticatable = &PingOneSSOConnector{} ) -type PingoneSSOConnector struct { +type PingOneSSOConnector struct { clientInfo connector.PingOneClientInfo } -// Utility method for creating a PingoneSSOConnector -func SSOConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiClientId *string, exportEnvironmentID string) *PingoneSSOConnector { - return &PingoneSSOConnector{ +// Utility method for creating a PingOneSSOConnector +func SSOConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiClientId *string, exportEnvironmentID string) *PingOneSSOConnector { + return &PingOneSSOConnector{ clientInfo: connector.PingOneClientInfo{ Context: ctx, ApiClient: apiClient, @@ -36,7 +36,7 @@ func SSOConnector(ctx context.Context, apiClient *pingoneGoClient.Client, apiCli } } -func (c *PingoneSSOConnector) Export(format, outputDir string, overwriteExport bool) error { +func (c *PingOneSSOConnector) Export(format, outputDir string, overwriteExport bool) error { l := logger.Get() l.Debug().Msgf("Exporting all PingOne SSO Resources...") @@ -70,14 +70,14 @@ func (c *PingoneSSOConnector) Export(format, outputDir string, overwriteExport b return common.WriteFiles(exportableResources, format, outputDir, overwriteExport) } -func (c *PingoneSSOConnector) ConnectorServiceName() string { +func (c *PingOneSSOConnector) ConnectorServiceName() string { return serviceName } -func (c *PingoneSSOConnector) Login() error { +func (c *PingOneSSOConnector) Login() error { return nil } -func (c *PingoneSSOConnector) Logout() error { +func (c *PingOneSSOConnector) Logout() error { return nil } diff --git a/internal/connector/pingone/sso/resources/pingone_application.go b/internal/connector/pingone/sso/resources/pingone_application.go index 2baa856f..8d0cebba 100644 --- a/internal/connector/pingone/sso/resources/pingone_application.go +++ b/internal/connector/pingone/sso/resources/pingone_application.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneApplicationResource{} + _ connector.ExportableResource = &PingOneApplicationResource{} ) -type PingoneApplicationResource struct { +type PingOneApplicationResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneApplicationResource -func Application(clientInfo *connector.PingOneClientInfo) *PingoneApplicationResource { - return &PingoneApplicationResource{ +// Utility method for creating a PingOneApplicationResource +func Application(clientInfo *connector.PingOneClientInfo) *PingOneApplicationResource { + return &PingOneApplicationResource{ clientInfo: clientInfo, } } -func (r *PingoneApplicationResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneApplicationResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -83,6 +83,6 @@ func (r *PingoneApplicationResource) ExportAll() (*[]connector.ImportBlock, erro return &importBlocks, nil } -func (r *PingoneApplicationResource) ResourceType() string { +func (r *PingOneApplicationResource) ResourceType() string { return "pingone_application" } diff --git a/internal/connector/pingone/sso/resources/pingone_application_attribute_mapping.go b/internal/connector/pingone/sso/resources/pingone_application_attribute_mapping.go index 65a17fdb..05494786 100644 --- a/internal/connector/pingone/sso/resources/pingone_application_attribute_mapping.go +++ b/internal/connector/pingone/sso/resources/pingone_application_attribute_mapping.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneApplicationAttributeMappingResource{} + _ connector.ExportableResource = &PingOneApplicationAttributeMappingResource{} ) -type PingoneApplicationAttributeMappingResource struct { +type PingOneApplicationAttributeMappingResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneApplicationAttributeMappingResource -func ApplicationAttributeMapping(clientInfo *connector.PingOneClientInfo) *PingoneApplicationAttributeMappingResource { - return &PingoneApplicationAttributeMappingResource{ +// Utility method for creating a PingOneApplicationAttributeMappingResource +func ApplicationAttributeMapping(clientInfo *connector.PingOneClientInfo) *PingOneApplicationAttributeMappingResource { + return &PingOneApplicationAttributeMappingResource{ clientInfo: clientInfo, } } -func (r *PingoneApplicationAttributeMappingResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneApplicationAttributeMappingResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -101,6 +101,6 @@ func (r *PingoneApplicationAttributeMappingResource) ExportAll() (*[]connector.I return &importBlocks, nil } -func (r *PingoneApplicationAttributeMappingResource) ResourceType() string { +func (r *PingOneApplicationAttributeMappingResource) ResourceType() string { return "pingone_application_attribute_mapping" } diff --git a/internal/connector/pingone/sso/resources/pingone_application_flow_policy_assignment.go b/internal/connector/pingone/sso/resources/pingone_application_flow_policy_assignment.go index 29da908a..83eb1e95 100644 --- a/internal/connector/pingone/sso/resources/pingone_application_flow_policy_assignment.go +++ b/internal/connector/pingone/sso/resources/pingone_application_flow_policy_assignment.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneApplicationFlowPolicyAssignmentResource{} + _ connector.ExportableResource = &PingOneApplicationFlowPolicyAssignmentResource{} ) -type PingoneApplicationFlowPolicyAssignmentResource struct { +type PingOneApplicationFlowPolicyAssignmentResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneApplicationFlowPolicyAssignmentResource -func ApplicationFlowPolicyAssignment(clientInfo *connector.PingOneClientInfo) *PingoneApplicationFlowPolicyAssignmentResource { - return &PingoneApplicationFlowPolicyAssignmentResource{ +// Utility method for creating a PingOneApplicationFlowPolicyAssignmentResource +func ApplicationFlowPolicyAssignment(clientInfo *connector.PingOneClientInfo) *PingOneApplicationFlowPolicyAssignmentResource { + return &PingOneApplicationFlowPolicyAssignmentResource{ clientInfo: clientInfo, } } -func (r *PingoneApplicationFlowPolicyAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneApplicationFlowPolicyAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -120,6 +120,6 @@ func (r *PingoneApplicationFlowPolicyAssignmentResource) ExportAll() (*[]connect return &importBlocks, nil } -func (r *PingoneApplicationFlowPolicyAssignmentResource) ResourceType() string { +func (r *PingOneApplicationFlowPolicyAssignmentResource) ResourceType() string { return "pingone_application_flow_policy_assignment" } diff --git a/internal/connector/pingone/sso/resources/pingone_application_resource_grant.go b/internal/connector/pingone/sso/resources/pingone_application_resource_grant.go index 97d10f1c..f5fb8b72 100644 --- a/internal/connector/pingone/sso/resources/pingone_application_resource_grant.go +++ b/internal/connector/pingone/sso/resources/pingone_application_resource_grant.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneApplicationResourceGrantResource{} + _ connector.ExportableResource = &PingOneApplicationResourceGrantResource{} ) -type PingoneApplicationResourceGrantResource struct { +type PingOneApplicationResourceGrantResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneApplicationResourceGrantResource -func ApplicationResourceGrant(clientInfo *connector.PingOneClientInfo) *PingoneApplicationResourceGrantResource { - return &PingoneApplicationResourceGrantResource{ +// Utility method for creating a PingOneApplicationResourceGrantResource +func ApplicationResourceGrant(clientInfo *connector.PingOneClientInfo) *PingOneApplicationResourceGrantResource { + return &PingOneApplicationResourceGrantResource{ clientInfo: clientInfo, } } -func (r *PingoneApplicationResourceGrantResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneApplicationResourceGrantResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -120,6 +120,6 @@ func (r *PingoneApplicationResourceGrantResource) ExportAll() (*[]connector.Impo return &importBlocks, nil } -func (r *PingoneApplicationResourceGrantResource) ResourceType() string { +func (r *PingOneApplicationResourceGrantResource) ResourceType() string { return "pingone_application_resource_grant" } diff --git a/internal/connector/pingone/sso/resources/pingone_application_role_assignment.go b/internal/connector/pingone/sso/resources/pingone_application_role_assignment.go index 0445d29c..2622cf95 100644 --- a/internal/connector/pingone/sso/resources/pingone_application_role_assignment.go +++ b/internal/connector/pingone/sso/resources/pingone_application_role_assignment.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneApplicationRoleAssignmentResource{} + _ connector.ExportableResource = &PingOneApplicationRoleAssignmentResource{} ) -type PingoneApplicationRoleAssignmentResource struct { +type PingOneApplicationRoleAssignmentResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneApplicationRoleAssignmentResource -func ApplicationRoleAssignment(clientInfo *connector.PingOneClientInfo) *PingoneApplicationRoleAssignmentResource { - return &PingoneApplicationRoleAssignmentResource{ +// Utility method for creating a PingOneApplicationRoleAssignmentResource +func ApplicationRoleAssignment(clientInfo *connector.PingOneClientInfo) *PingOneApplicationRoleAssignmentResource { + return &PingOneApplicationRoleAssignmentResource{ clientInfo: clientInfo, } } -func (r *PingoneApplicationRoleAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneApplicationRoleAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -124,6 +124,6 @@ func (r *PingoneApplicationRoleAssignmentResource) ExportAll() (*[]connector.Imp return &importBlocks, nil } -func (r *PingoneApplicationRoleAssignmentResource) ResourceType() string { +func (r *PingOneApplicationRoleAssignmentResource) ResourceType() string { return "pingone_application_role_assignment" } diff --git a/internal/connector/pingone/sso/resources/pingone_application_secret.go b/internal/connector/pingone/sso/resources/pingone_application_secret.go index 6441c86a..37742089 100644 --- a/internal/connector/pingone/sso/resources/pingone_application_secret.go +++ b/internal/connector/pingone/sso/resources/pingone_application_secret.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneApplicationSecretResource{} + _ connector.ExportableResource = &PingOneApplicationSecretResource{} ) -type PingoneApplicationSecretResource struct { +type PingOneApplicationSecretResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneApplicationSecretResource -func ApplicationSecret(clientInfo *connector.PingOneClientInfo) *PingoneApplicationSecretResource { - return &PingoneApplicationSecretResource{ +// Utility method for creating a PingOneApplicationSecretResource +func ApplicationSecret(clientInfo *connector.PingOneClientInfo) *PingOneApplicationSecretResource { + return &PingOneApplicationSecretResource{ clientInfo: clientInfo, } } -func (r *PingoneApplicationSecretResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneApplicationSecretResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -110,6 +110,6 @@ func (r *PingoneApplicationSecretResource) ExportAll() (*[]connector.ImportBlock return &importBlocks, nil } -func (r *PingoneApplicationSecretResource) ResourceType() string { +func (r *PingOneApplicationSecretResource) ResourceType() string { return "pingone_application_secret" } diff --git a/internal/connector/pingone/sso/resources/pingone_application_sign_on_policy_assignment.go b/internal/connector/pingone/sso/resources/pingone_application_sign_on_policy_assignment.go index 24d76ba6..5c04d18d 100644 --- a/internal/connector/pingone/sso/resources/pingone_application_sign_on_policy_assignment.go +++ b/internal/connector/pingone/sso/resources/pingone_application_sign_on_policy_assignment.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneApplicationSignOnPolicyAssignmentResource{} + _ connector.ExportableResource = &PingOneApplicationSignOnPolicyAssignmentResource{} ) -type PingoneApplicationSignOnPolicyAssignmentResource struct { +type PingOneApplicationSignOnPolicyAssignmentResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneApplicationSignOnPolicyAssignmentResource -func ApplicationSignOnPolicyAssignment(clientInfo *connector.PingOneClientInfo) *PingoneApplicationSignOnPolicyAssignmentResource { - return &PingoneApplicationSignOnPolicyAssignmentResource{ +// Utility method for creating a PingOneApplicationSignOnPolicyAssignmentResource +func ApplicationSignOnPolicyAssignment(clientInfo *connector.PingOneClientInfo) *PingOneApplicationSignOnPolicyAssignmentResource { + return &PingOneApplicationSignOnPolicyAssignmentResource{ clientInfo: clientInfo, } } -func (r *PingoneApplicationSignOnPolicyAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneApplicationSignOnPolicyAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -121,6 +121,6 @@ func (r *PingoneApplicationSignOnPolicyAssignmentResource) ExportAll() (*[]conne return &importBlocks, nil } -func (r *PingoneApplicationSignOnPolicyAssignmentResource) ResourceType() string { +func (r *PingOneApplicationSignOnPolicyAssignmentResource) ResourceType() string { return "pingone_application_sign_on_policy_assignment" } diff --git a/internal/connector/pingone/sso/resources/pingone_group.go b/internal/connector/pingone/sso/resources/pingone_group.go index 2701bc5b..12def755 100644 --- a/internal/connector/pingone/sso/resources/pingone_group.go +++ b/internal/connector/pingone/sso/resources/pingone_group.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneGroupResource{} + _ connector.ExportableResource = &PingOneGroupResource{} ) -type PingoneGroupResource struct { +type PingOneGroupResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneGroupResource -func Group(clientInfo *connector.PingOneClientInfo) *PingoneGroupResource { - return &PingoneGroupResource{ +// Utility method for creating a PingOneGroupResource +func Group(clientInfo *connector.PingOneClientInfo) *PingOneGroupResource { + return &PingOneGroupResource{ clientInfo: clientInfo, } } -func (r *PingoneGroupResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneGroupResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneGroupResource) ExportAll() (*[]connector.ImportBlock, error) { return &importBlocks, nil } -func (r *PingoneGroupResource) ResourceType() string { +func (r *PingOneGroupResource) ResourceType() string { return "pingone_group" } diff --git a/internal/connector/pingone/sso/resources/pingone_group_nesting.go b/internal/connector/pingone/sso/resources/pingone_group_nesting.go index a0952dba..88703517 100644 --- a/internal/connector/pingone/sso/resources/pingone_group_nesting.go +++ b/internal/connector/pingone/sso/resources/pingone_group_nesting.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneGroupNestingResource{} + _ connector.ExportableResource = &PingOneGroupNestingResource{} ) -type PingoneGroupNestingResource struct { +type PingOneGroupNestingResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneGroupNestingResource -func GroupNesting(clientInfo *connector.PingOneClientInfo) *PingoneGroupNestingResource { - return &PingoneGroupNestingResource{ +// Utility method for creating a PingOneGroupNestingResource +func GroupNesting(clientInfo *connector.PingOneClientInfo) *PingOneGroupNestingResource { + return &PingOneGroupNestingResource{ clientInfo: clientInfo, } } -func (r *PingoneGroupNestingResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneGroupNestingResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -81,6 +81,6 @@ func (r *PingoneGroupNestingResource) ExportAll() (*[]connector.ImportBlock, err return &importBlocks, nil } -func (r *PingoneGroupNestingResource) ResourceType() string { +func (r *PingOneGroupNestingResource) ResourceType() string { return "pingone_group_nesting" } diff --git a/internal/connector/pingone/sso/resources/pingone_group_role_assignment.go b/internal/connector/pingone/sso/resources/pingone_group_role_assignment.go index ca836972..a275beae 100644 --- a/internal/connector/pingone/sso/resources/pingone_group_role_assignment.go +++ b/internal/connector/pingone/sso/resources/pingone_group_role_assignment.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneGroupRoleAssignmentResource{} + _ connector.ExportableResource = &PingOneGroupRoleAssignmentResource{} ) -type PingoneGroupRoleAssignmentResource struct { +type PingOneGroupRoleAssignmentResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneGroupRoleAssignmentResource -func GroupRoleAssignment(clientInfo *connector.PingOneClientInfo) *PingoneGroupRoleAssignmentResource { - return &PingoneGroupRoleAssignmentResource{ +// Utility method for creating a PingOneGroupRoleAssignmentResource +func GroupRoleAssignment(clientInfo *connector.PingOneClientInfo) *PingOneGroupRoleAssignmentResource { + return &PingOneGroupRoleAssignmentResource{ clientInfo: clientInfo, } } -func (r *PingoneGroupRoleAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneGroupRoleAssignmentResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -103,6 +103,6 @@ func (r *PingoneGroupRoleAssignmentResource) ExportAll() (*[]connector.ImportBlo return &importBlocks, nil } -func (r *PingoneGroupRoleAssignmentResource) ResourceType() string { +func (r *PingOneGroupRoleAssignmentResource) ResourceType() string { return "pingone_group_role_assignment" } diff --git a/internal/connector/pingone/sso/resources/pingone_identity_provider.go b/internal/connector/pingone/sso/resources/pingone_identity_provider.go index c6bbb750..6469e0d1 100644 --- a/internal/connector/pingone/sso/resources/pingone_identity_provider.go +++ b/internal/connector/pingone/sso/resources/pingone_identity_provider.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneIdentityProviderResource{} + _ connector.ExportableResource = &PingOneIdentityProviderResource{} ) -type PingoneIdentityProviderResource struct { +type PingOneIdentityProviderResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneIdentityProviderResource -func IdentityProvider(clientInfo *connector.PingOneClientInfo) *PingoneIdentityProviderResource { - return &PingoneIdentityProviderResource{ +// Utility method for creating a PingOneIdentityProviderResource +func IdentityProvider(clientInfo *connector.PingOneClientInfo) *PingOneIdentityProviderResource { + return &PingOneIdentityProviderResource{ clientInfo: clientInfo, } } -func (r *PingoneIdentityProviderResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneIdentityProviderResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -92,6 +92,6 @@ func (r *PingoneIdentityProviderResource) ExportAll() (*[]connector.ImportBlock, return &importBlocks, nil } -func (r *PingoneIdentityProviderResource) ResourceType() string { +func (r *PingOneIdentityProviderResource) ResourceType() string { return "pingone_identity_provider" } diff --git a/internal/connector/pingone/sso/resources/pingone_identity_provider_attribute.go b/internal/connector/pingone/sso/resources/pingone_identity_provider_attribute.go index 06c4e364..9f6b7ad6 100644 --- a/internal/connector/pingone/sso/resources/pingone_identity_provider_attribute.go +++ b/internal/connector/pingone/sso/resources/pingone_identity_provider_attribute.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneIdentityProviderAttributeResource{} + _ connector.ExportableResource = &PingOneIdentityProviderAttributeResource{} ) -type PingoneIdentityProviderAttributeResource struct { +type PingOneIdentityProviderAttributeResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneIdentityProviderAttributeResource -func IdentityProviderAttribute(clientInfo *connector.PingOneClientInfo) *PingoneIdentityProviderAttributeResource { - return &PingoneIdentityProviderAttributeResource{ +// Utility method for creating a PingOneIdentityProviderAttributeResource +func IdentityProviderAttribute(clientInfo *connector.PingOneClientInfo) *PingOneIdentityProviderAttributeResource { + return &PingOneIdentityProviderAttributeResource{ clientInfo: clientInfo, } } -func (r *PingoneIdentityProviderAttributeResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneIdentityProviderAttributeResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -108,6 +108,6 @@ func (r *PingoneIdentityProviderAttributeResource) ExportAll() (*[]connector.Imp return &importBlocks, nil } -func (r *PingoneIdentityProviderAttributeResource) ResourceType() string { +func (r *PingOneIdentityProviderAttributeResource) ResourceType() string { return "pingone_identity_provider_attribute" } diff --git a/internal/connector/pingone/sso/resources/pingone_password_policy.go b/internal/connector/pingone/sso/resources/pingone_password_policy.go index c23f87e9..e4daf906 100644 --- a/internal/connector/pingone/sso/resources/pingone_password_policy.go +++ b/internal/connector/pingone/sso/resources/pingone_password_policy.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingonePasswordPolicyResource{} + _ connector.ExportableResource = &PingOnePasswordPolicyResource{} ) -type PingonePasswordPolicyResource struct { +type PingOnePasswordPolicyResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingonePasswordPolicyResource -func PasswordPolicy(clientInfo *connector.PingOneClientInfo) *PingonePasswordPolicyResource { - return &PingonePasswordPolicyResource{ +// Utility method for creating a PingOnePasswordPolicyResource +func PasswordPolicy(clientInfo *connector.PingOneClientInfo) *PingOnePasswordPolicyResource { + return &PingOnePasswordPolicyResource{ clientInfo: clientInfo, } } -func (r *PingonePasswordPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOnePasswordPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingonePasswordPolicyResource) ExportAll() (*[]connector.ImportBlock, e return &importBlocks, nil } -func (r *PingonePasswordPolicyResource) ResourceType() string { +func (r *PingOnePasswordPolicyResource) ResourceType() string { return "pingone_password_policy" } diff --git a/internal/connector/pingone/sso/resources/pingone_population.go b/internal/connector/pingone/sso/resources/pingone_population.go index 6e35bc13..afc0298c 100644 --- a/internal/connector/pingone/sso/resources/pingone_population.go +++ b/internal/connector/pingone/sso/resources/pingone_population.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingonePopulationResource{} + _ connector.ExportableResource = &PingOnePopulationResource{} ) -type PingonePopulationResource struct { +type PingOnePopulationResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingonePopulationResource -func Population(clientInfo *connector.PingOneClientInfo) *PingonePopulationResource { - return &PingonePopulationResource{ +// Utility method for creating a PingOnePopulationResource +func Population(clientInfo *connector.PingOneClientInfo) *PingOnePopulationResource { + return &PingOnePopulationResource{ clientInfo: clientInfo, } } -func (r *PingonePopulationResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOnePopulationResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingonePopulationResource) ExportAll() (*[]connector.ImportBlock, error return &importBlocks, nil } -func (r *PingonePopulationResource) ResourceType() string { +func (r *PingOnePopulationResource) ResourceType() string { return "pingone_population" } diff --git a/internal/connector/pingone/sso/resources/pingone_population_default.go b/internal/connector/pingone/sso/resources/pingone_population_default.go index 990416fe..53c01a63 100644 --- a/internal/connector/pingone/sso/resources/pingone_population_default.go +++ b/internal/connector/pingone/sso/resources/pingone_population_default.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingonePopulationDefaultDefaultResource{} + _ connector.ExportableResource = &PingOnePopulationDefaultDefaultResource{} ) -type PingonePopulationDefaultDefaultResource struct { +type PingOnePopulationDefaultDefaultResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingonePopulationDefaultDefaultResource -func PopulationDefault(clientInfo *connector.PingOneClientInfo) *PingonePopulationDefaultDefaultResource { - return &PingonePopulationDefaultDefaultResource{ +// Utility method for creating a PingOnePopulationDefaultDefaultResource +func PopulationDefault(clientInfo *connector.PingOneClientInfo) *PingOnePopulationDefaultDefaultResource { + return &PingOnePopulationDefaultDefaultResource{ clientInfo: clientInfo, } } -func (r *PingonePopulationDefaultDefaultResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOnePopulationDefaultDefaultResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -77,6 +77,6 @@ func (r *PingonePopulationDefaultDefaultResource) ExportAll() (*[]connector.Impo return &importBlocks, nil } -func (r *PingonePopulationDefaultDefaultResource) ResourceType() string { +func (r *PingOnePopulationDefaultDefaultResource) ResourceType() string { return "pingone_population_default" } diff --git a/internal/connector/pingone/sso/resources/pingone_resource.go b/internal/connector/pingone/sso/resources/pingone_resource.go index ceadf9e2..644ea0d0 100644 --- a/internal/connector/pingone/sso/resources/pingone_resource.go +++ b/internal/connector/pingone/sso/resources/pingone_resource.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneResourceResource{} + _ connector.ExportableResource = &PingOneResourceResource{} ) -type PingoneResourceResource struct { +type PingOneResourceResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneResourceResource -func Resource(clientInfo *connector.PingOneClientInfo) *PingoneResourceResource { - return &PingoneResourceResource{ +// Utility method for creating a PingOneResourceResource +func Resource(clientInfo *connector.PingOneClientInfo) *PingOneResourceResource { + return &PingOneResourceResource{ clientInfo: clientInfo, } } -func (r *PingoneResourceResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneResourceResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -66,6 +66,6 @@ func (r *PingoneResourceResource) ExportAll() (*[]connector.ImportBlock, error) return &importBlocks, nil } -func (r *PingoneResourceResource) ResourceType() string { +func (r *PingOneResourceResource) ResourceType() string { return "pingone_resource" } diff --git a/internal/connector/pingone/sso/resources/pingone_resource_attribute.go b/internal/connector/pingone/sso/resources/pingone_resource_attribute.go index 64f8e702..2ab6d805 100644 --- a/internal/connector/pingone/sso/resources/pingone_resource_attribute.go +++ b/internal/connector/pingone/sso/resources/pingone_resource_attribute.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneResourceAttributeResource{} + _ connector.ExportableResource = &PingOneResourceAttributeResource{} ) -type PingoneResourceAttributeResource struct { +type PingOneResourceAttributeResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneResourceAttributeResource -func ResourceAttribute(clientInfo *connector.PingOneClientInfo) *PingoneResourceAttributeResource { - return &PingoneResourceAttributeResource{ +// Utility method for creating a PingOneResourceAttributeResource +func ResourceAttribute(clientInfo *connector.PingOneClientInfo) *PingOneResourceAttributeResource { + return &PingOneResourceAttributeResource{ clientInfo: clientInfo, } } -func (r *PingoneResourceAttributeResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneResourceAttributeResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -105,6 +105,6 @@ func (r *PingoneResourceAttributeResource) ExportAll() (*[]connector.ImportBlock return &importBlocks, nil } -func (r *PingoneResourceAttributeResource) ResourceType() string { +func (r *PingOneResourceAttributeResource) ResourceType() string { return "pingone_resource_attribute" } diff --git a/internal/connector/pingone/sso/resources/pingone_resource_scope.go b/internal/connector/pingone/sso/resources/pingone_resource_scope.go index 27ecc09d..d9dc27c2 100644 --- a/internal/connector/pingone/sso/resources/pingone_resource_scope.go +++ b/internal/connector/pingone/sso/resources/pingone_resource_scope.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneResourceScopeResource{} + _ connector.ExportableResource = &PingOneResourceScopeResource{} ) -type PingoneResourceScopeResource struct { +type PingOneResourceScopeResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneResourceScopeResource -func ResourceScope(clientInfo *connector.PingOneClientInfo) *PingoneResourceScopeResource { - return &PingoneResourceScopeResource{ +// Utility method for creating a PingOneResourceScopeResource +func ResourceScope(clientInfo *connector.PingOneClientInfo) *PingOneResourceScopeResource { + return &PingOneResourceScopeResource{ clientInfo: clientInfo, } } -func (r *PingoneResourceScopeResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneResourceScopeResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -84,6 +84,6 @@ func (r *PingoneResourceScopeResource) ExportAll() (*[]connector.ImportBlock, er return &importBlocks, nil } -func (r *PingoneResourceScopeResource) ResourceType() string { +func (r *PingOneResourceScopeResource) ResourceType() string { return "pingone_resource_scope" } diff --git a/internal/connector/pingone/sso/resources/pingone_resource_scope_openid.go b/internal/connector/pingone/sso/resources/pingone_resource_scope_openid.go index c1a7c3e5..eb9ec217 100644 --- a/internal/connector/pingone/sso/resources/pingone_resource_scope_openid.go +++ b/internal/connector/pingone/sso/resources/pingone_resource_scope_openid.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneResourceScopeOpenIdResource{} + _ connector.ExportableResource = &PingOneResourceScopeOpenIdResource{} ) -type PingoneResourceScopeOpenIdResource struct { +type PingOneResourceScopeOpenIdResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneResourceScopeOpenIdResource -func ResourceScopeOpenId(clientInfo *connector.PingOneClientInfo) *PingoneResourceScopeOpenIdResource { - return &PingoneResourceScopeOpenIdResource{ +// Utility method for creating a PingOneResourceScopeOpenIdResource +func ResourceScopeOpenId(clientInfo *connector.PingOneClientInfo) *PingOneResourceScopeOpenIdResource { + return &PingOneResourceScopeOpenIdResource{ clientInfo: clientInfo, } } -func (r *PingoneResourceScopeOpenIdResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneResourceScopeOpenIdResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -83,6 +83,6 @@ func (r *PingoneResourceScopeOpenIdResource) ExportAll() (*[]connector.ImportBlo return &importBlocks, nil } -func (r *PingoneResourceScopeOpenIdResource) ResourceType() string { +func (r *PingOneResourceScopeOpenIdResource) ResourceType() string { return "pingone_resource_scope_openid" } diff --git a/internal/connector/pingone/sso/resources/pingone_resource_scope_pingone_api.go b/internal/connector/pingone/sso/resources/pingone_resource_scope_pingone_api.go index e40ed73c..173e26e0 100644 --- a/internal/connector/pingone/sso/resources/pingone_resource_scope_pingone_api.go +++ b/internal/connector/pingone/sso/resources/pingone_resource_scope_pingone_api.go @@ -12,21 +12,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneResourceScopePingOneApiResource{} + _ connector.ExportableResource = &PingOneResourceScopePingOneApiResource{} ) -type PingoneResourceScopePingOneApiResource struct { +type PingOneResourceScopePingOneApiResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneResourceScopePingOneApiResource -func ResourceScopePingOneApi(clientInfo *connector.PingOneClientInfo) *PingoneResourceScopePingOneApiResource { - return &PingoneResourceScopePingOneApiResource{ +// Utility method for creating a PingOneResourceScopePingOneApiResource +func ResourceScopePingOneApi(clientInfo *connector.PingOneClientInfo) *PingOneResourceScopePingOneApiResource { + return &PingOneResourceScopePingOneApiResource{ clientInfo: clientInfo, } } -func (r *PingoneResourceScopePingOneApiResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneResourceScopePingOneApiResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -94,6 +94,6 @@ func (r *PingoneResourceScopePingOneApiResource) ExportAll() (*[]connector.Impor return &importBlocks, nil } -func (r *PingoneResourceScopePingOneApiResource) ResourceType() string { +func (r *PingOneResourceScopePingOneApiResource) ResourceType() string { return "pingone_resource_scope_pingone_api" } diff --git a/internal/connector/pingone/sso/resources/pingone_schema_attribute.go b/internal/connector/pingone/sso/resources/pingone_schema_attribute.go index d102eb29..0b455f5b 100644 --- a/internal/connector/pingone/sso/resources/pingone_schema_attribute.go +++ b/internal/connector/pingone/sso/resources/pingone_schema_attribute.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneSchemaAttributeResource{} + _ connector.ExportableResource = &PingOneSchemaAttributeResource{} ) -type PingoneSchemaAttributeResource struct { +type PingOneSchemaAttributeResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneSchemaAttributeResource -func SchemaAttribute(clientInfo *connector.PingOneClientInfo) *PingoneSchemaAttributeResource { - return &PingoneSchemaAttributeResource{ +// Utility method for creating a PingOneSchemaAttributeResource +func SchemaAttribute(clientInfo *connector.PingOneClientInfo) *PingOneSchemaAttributeResource { + return &PingOneSchemaAttributeResource{ clientInfo: clientInfo, } } -func (r *PingoneSchemaAttributeResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneSchemaAttributeResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -80,6 +80,6 @@ func (r *PingoneSchemaAttributeResource) ExportAll() (*[]connector.ImportBlock, return &importBlocks, nil } -func (r *PingoneSchemaAttributeResource) ResourceType() string { +func (r *PingOneSchemaAttributeResource) ResourceType() string { return "pingone_schema_attribute" } diff --git a/internal/connector/pingone/sso/resources/pingone_sign_on_policy.go b/internal/connector/pingone/sso/resources/pingone_sign_on_policy.go index 48608d16..27bcfbe8 100644 --- a/internal/connector/pingone/sso/resources/pingone_sign_on_policy.go +++ b/internal/connector/pingone/sso/resources/pingone_sign_on_policy.go @@ -10,21 +10,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneSignOnPolicyResource{} + _ connector.ExportableResource = &PingOneSignOnPolicyResource{} ) -type PingoneSignOnPolicyResource struct { +type PingOneSignOnPolicyResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneSignOnPolicyResource -func SignOnPolicy(clientInfo *connector.PingOneClientInfo) *PingoneSignOnPolicyResource { - return &PingoneSignOnPolicyResource{ +// Utility method for creating a PingOneSignOnPolicyResource +func SignOnPolicy(clientInfo *connector.PingOneClientInfo) *PingOneSignOnPolicyResource { + return &PingOneSignOnPolicyResource{ clientInfo: clientInfo, } } -func (r *PingoneSignOnPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneSignOnPolicyResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -65,6 +65,6 @@ func (r *PingoneSignOnPolicyResource) ExportAll() (*[]connector.ImportBlock, err return &importBlocks, nil } -func (r *PingoneSignOnPolicyResource) ResourceType() string { +func (r *PingOneSignOnPolicyResource) ResourceType() string { return "pingone_sign_on_policy" } diff --git a/internal/connector/pingone/sso/resources/pingone_sign_on_policy_action.go b/internal/connector/pingone/sso/resources/pingone_sign_on_policy_action.go index 26e2bae0..e731fbe5 100644 --- a/internal/connector/pingone/sso/resources/pingone_sign_on_policy_action.go +++ b/internal/connector/pingone/sso/resources/pingone_sign_on_policy_action.go @@ -11,21 +11,21 @@ import ( // Verify that the resource satisfies the exportable resource interface var ( - _ connector.ExportableResource = &PingoneSignOnPolicyActionResource{} + _ connector.ExportableResource = &PingOneSignOnPolicyActionResource{} ) -type PingoneSignOnPolicyActionResource struct { +type PingOneSignOnPolicyActionResource struct { clientInfo *connector.PingOneClientInfo } -// Utility method for creating a PingoneSignOnPolicyActionResource -func SignOnPolicyAction(clientInfo *connector.PingOneClientInfo) *PingoneSignOnPolicyActionResource { - return &PingoneSignOnPolicyActionResource{ +// Utility method for creating a PingOneSignOnPolicyActionResource +func SignOnPolicyAction(clientInfo *connector.PingOneClientInfo) *PingOneSignOnPolicyActionResource { + return &PingOneSignOnPolicyActionResource{ clientInfo: clientInfo, } } -func (r *PingoneSignOnPolicyActionResource) ExportAll() (*[]connector.ImportBlock, error) { +func (r *PingOneSignOnPolicyActionResource) ExportAll() (*[]connector.ImportBlock, error) { l := logger.Get() l.Debug().Msgf("Fetching all %s resources...", r.ResourceType()) @@ -117,6 +117,6 @@ func (r *PingoneSignOnPolicyActionResource) ExportAll() (*[]connector.ImportBloc return &importBlocks, nil } -func (r *PingoneSignOnPolicyActionResource) ResourceType() string { +func (r *PingOneSignOnPolicyActionResource) ResourceType() string { return "pingone_sign_on_policy_action" } diff --git a/internal/customtypes/pingfederate_auth_type.go b/internal/customtypes/pingfederate_auth_type.go index c99e57ea..5204efbc 100644 --- a/internal/customtypes/pingfederate_auth_type.go +++ b/internal/customtypes/pingfederate_auth_type.go @@ -14,41 +14,41 @@ const ( ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_CLIENT_CREDENTIALS string = "clientCredentialsAuth" ) -type PingfederateAuthenticationType string +type PingFederateAuthenticationType string // Verify that the custom type satisfies the pflag.Value interface -var _ pflag.Value = (*PingfederateAuthenticationType)(nil) +var _ pflag.Value = (*PingFederateAuthenticationType)(nil) // Implement pflag.Value interface for custom type in cobra MultiService parameter -func (pat *PingfederateAuthenticationType) Set(authType string) error { +func (pat *PingFederateAuthenticationType) Set(authType string) error { if pat == nil { - return fmt.Errorf("failed to set Pingfederate Authentication Type value: %s. Pingfederate Authentication Type is nil", authType) + return fmt.Errorf("failed to set PingFederate Authentication Type value: %s. PingFederate Authentication Type is nil", authType) } switch { case strings.EqualFold(authType, ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC): - *pat = PingfederateAuthenticationType(ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC) + *pat = PingFederateAuthenticationType(ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC) case strings.EqualFold(authType, ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_ACCESS_TOKEN): - *pat = PingfederateAuthenticationType(ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_ACCESS_TOKEN) + *pat = PingFederateAuthenticationType(ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_ACCESS_TOKEN) case strings.EqualFold(authType, ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_CLIENT_CREDENTIALS): - *pat = PingfederateAuthenticationType(ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_CLIENT_CREDENTIALS) + *pat = PingFederateAuthenticationType(ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_CLIENT_CREDENTIALS) case strings.EqualFold(authType, ""): - *pat = PingfederateAuthenticationType("") + *pat = PingFederateAuthenticationType("") default: - return fmt.Errorf("unrecognized Pingfederate Authentication Type: '%s'. Must be one of: %s", authType, strings.Join(PingfederateAuthenticationTypeValidValues(), ", ")) + return fmt.Errorf("unrecognized PingFederate Authentication Type: '%s'. Must be one of: %s", authType, strings.Join(PingFederateAuthenticationTypeValidValues(), ", ")) } return nil } -func (pat PingfederateAuthenticationType) Type() string { +func (pat PingFederateAuthenticationType) Type() string { return "string" } -func (pat PingfederateAuthenticationType) String() string { +func (pat PingFederateAuthenticationType) String() string { return string(pat) } -func PingfederateAuthenticationTypeValidValues() []string { +func PingFederateAuthenticationTypeValidValues() []string { types := []string{ ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC, ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_ACCESS_TOKEN, diff --git a/internal/customtypes/pingfederate_auth_type_test.go b/internal/customtypes/pingfederate_auth_type_test.go index 97fb1b17..2bdc41e5 100644 --- a/internal/customtypes/pingfederate_auth_type_test.go +++ b/internal/customtypes/pingfederate_auth_type_test.go @@ -7,37 +7,37 @@ import ( "github.com/pingidentity/pingcli/internal/testing/testutils" ) -// Test PingfederateAuthType Set function -func Test_PingfederateAuthType_Set(t *testing.T) { - // Create a new PingfederateAuthType - pingAuthType := new(customtypes.PingfederateAuthenticationType) +// Test PingFederateAuthType Set function +func Test_PingFederateAuthType_Set(t *testing.T) { + // Create a new PingFederateAuthType + pingAuthType := new(customtypes.PingFederateAuthenticationType) err := pingAuthType.Set(customtypes.ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC) testutils.CheckExpectedError(t, err, nil) } // Test Set function fails with invalid value -func Test_PingfederateAuthType_Set_InvalidValue(t *testing.T) { - pingAuthType := new(customtypes.PingfederateAuthenticationType) +func Test_PingFederateAuthType_Set_InvalidValue(t *testing.T) { + pingAuthType := new(customtypes.PingFederateAuthenticationType) invalidValue := "invalid" - expectedErrorPattern := `^unrecognized Pingfederate Authentication Type: '.*'\. Must be one of: .*$` + expectedErrorPattern := `^unrecognized PingFederate Authentication Type: '.*'\. Must be one of: .*$` err := pingAuthType.Set(invalidValue) testutils.CheckExpectedError(t, err, &expectedErrorPattern) } // Test Set function fails with nil -func Test_PingfederateAuthType_Set_Nil(t *testing.T) { - var pingAuthType *customtypes.PingfederateAuthenticationType +func Test_PingFederateAuthType_Set_Nil(t *testing.T) { + var pingAuthType *customtypes.PingFederateAuthenticationType - expectedErrorPattern := `^failed to set Pingfederate Authentication Type value: .*\. Pingfederate Authentication Type is nil$` + expectedErrorPattern := `^failed to set PingFederate Authentication Type value: .*\. PingFederate Authentication Type is nil$` err := pingAuthType.Set(customtypes.ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC) testutils.CheckExpectedError(t, err, &expectedErrorPattern) } // Test String function -func Test_PingfederateAuthType_String(t *testing.T) { - pingAuthType := customtypes.PingfederateAuthenticationType(customtypes.ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC) +func Test_PingFederateAuthType_String(t *testing.T) { + pingAuthType := customtypes.PingFederateAuthenticationType(customtypes.ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC) expected := customtypes.ENUM_PINGFEDERATE_AUTHENTICATION_TYPE_BASIC actual := pingAuthType.String() diff --git a/internal/customtypes/pingone_auth_type.go b/internal/customtypes/pingone_auth_type.go index ab7d6197..b647c48d 100644 --- a/internal/customtypes/pingone_auth_type.go +++ b/internal/customtypes/pingone_auth_type.go @@ -12,37 +12,37 @@ const ( ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER string = "worker" ) -type PingoneAuthenticationType string +type PingOneAuthenticationType string // Verify that the custom type satisfies the pflag.Value interface -var _ pflag.Value = (*PingoneAuthenticationType)(nil) +var _ pflag.Value = (*PingOneAuthenticationType)(nil) // Implement pflag.Value interface for custom type in cobra MultiService parameter -func (pat *PingoneAuthenticationType) Set(authType string) error { +func (pat *PingOneAuthenticationType) Set(authType string) error { if pat == nil { - return fmt.Errorf("failed to set Pingone Authentication Type value: %s. Pingone Authentication Type is nil", authType) + return fmt.Errorf("failed to set PingOne Authentication Type value: %s. PingOne Authentication Type is nil", authType) } switch { case strings.EqualFold(authType, ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER): - *pat = PingoneAuthenticationType(ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER) + *pat = PingOneAuthenticationType(ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER) case strings.EqualFold(authType, ""): - *pat = PingoneAuthenticationType("") + *pat = PingOneAuthenticationType("") default: - return fmt.Errorf("unrecognized Pingone Authentication Type: '%s'. Must be one of: %s", authType, strings.Join(PingoneAuthenticationTypeValidValues(), ", ")) + return fmt.Errorf("unrecognized PingOne Authentication Type: '%s'. Must be one of: %s", authType, strings.Join(PingOneAuthenticationTypeValidValues(), ", ")) } return nil } -func (pat PingoneAuthenticationType) Type() string { +func (pat PingOneAuthenticationType) Type() string { return "string" } -func (pat PingoneAuthenticationType) String() string { +func (pat PingOneAuthenticationType) String() string { return string(pat) } -func PingoneAuthenticationTypeValidValues() []string { +func PingOneAuthenticationTypeValidValues() []string { types := []string{ ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER, } diff --git a/internal/customtypes/pingone_auth_type_test.go b/internal/customtypes/pingone_auth_type_test.go index 27ef2c97..6e6d7910 100644 --- a/internal/customtypes/pingone_auth_type_test.go +++ b/internal/customtypes/pingone_auth_type_test.go @@ -7,37 +7,37 @@ import ( "github.com/pingidentity/pingcli/internal/testing/testutils" ) -// Test Pingone Authentication Type Set function -func Test_PingoneAuthType_Set(t *testing.T) { - // Create a new PingoneAuthType - pingAuthType := new(customtypes.PingoneAuthenticationType) +// Test PingOne Authentication Type Set function +func Test_PingOneAuthType_Set(t *testing.T) { + // Create a new PingOneAuthType + pingAuthType := new(customtypes.PingOneAuthenticationType) err := pingAuthType.Set(customtypes.ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER) testutils.CheckExpectedError(t, err, nil) } // Test Set function fails with invalid value -func Test_PingoneAuthType_Set_InvalidValue(t *testing.T) { - pingAuthType := new(customtypes.PingoneAuthenticationType) +func Test_PingOneAuthType_Set_InvalidValue(t *testing.T) { + pingAuthType := new(customtypes.PingOneAuthenticationType) invalidValue := "invalid" - expectedErrorPattern := `^unrecognized Pingone Authentication Type: '.*'\. Must be one of: .*$` + expectedErrorPattern := `^unrecognized PingOne Authentication Type: '.*'\. Must be one of: .*$` err := pingAuthType.Set(invalidValue) testutils.CheckExpectedError(t, err, &expectedErrorPattern) } // Test Set function fails with nil -func Test_PingoneAuthType_Set_Nil(t *testing.T) { - var pingAuthType *customtypes.PingoneAuthenticationType +func Test_PingOneAuthType_Set_Nil(t *testing.T) { + var pingAuthType *customtypes.PingOneAuthenticationType - expectedErrorPattern := `^failed to set Pingone Authentication Type value: .*\. Pingone Authentication Type is nil$` + expectedErrorPattern := `^failed to set PingOne Authentication Type value: .*\. PingOne Authentication Type is nil$` err := pingAuthType.Set(customtypes.ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER) testutils.CheckExpectedError(t, err, &expectedErrorPattern) } // Test String function -func Test_PingoneAuthType_String(t *testing.T) { - pingAuthType := customtypes.PingoneAuthenticationType(customtypes.ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER) +func Test_PingOneAuthType_String(t *testing.T) { + pingAuthType := customtypes.PingOneAuthenticationType(customtypes.ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER) expected := customtypes.ENUM_PINGONE_AUTHENTICATION_TYPE_WORKER actual := pingAuthType.String() diff --git a/internal/customtypes/pingone_region_code.go b/internal/customtypes/pingone_region_code.go index 93a240db..b7463346 100644 --- a/internal/customtypes/pingone_region_code.go +++ b/internal/customtypes/pingone_region_code.go @@ -22,45 +22,45 @@ const ( ENUM_PINGONE_TLD_NA string = "com" ) -type PingoneRegionCode string +type PingOneRegionCode string // Verify that the custom type satisfies the pflag.Value interface -var _ pflag.Value = (*PingoneRegionCode)(nil) +var _ pflag.Value = (*PingOneRegionCode)(nil) // Implement pflag.Value interface for custom type in cobra pingone-region parameter -func (prc *PingoneRegionCode) Set(regionCode string) error { +func (prc *PingOneRegionCode) Set(regionCode string) error { if prc == nil { - return fmt.Errorf("failed to set Pingone Region Code value: %s. Pingone Region Code is nil", regionCode) + return fmt.Errorf("failed to set PingOne Region Code value: %s. PingOne Region Code is nil", regionCode) } switch { case strings.EqualFold(regionCode, ENUM_PINGONE_REGION_CODE_AP): - *prc = PingoneRegionCode(ENUM_PINGONE_REGION_CODE_AP) + *prc = PingOneRegionCode(ENUM_PINGONE_REGION_CODE_AP) case strings.EqualFold(regionCode, ENUM_PINGONE_REGION_CODE_AU): - *prc = PingoneRegionCode(ENUM_PINGONE_REGION_CODE_AU) + *prc = PingOneRegionCode(ENUM_PINGONE_REGION_CODE_AU) case strings.EqualFold(regionCode, ENUM_PINGONE_REGION_CODE_CA): - *prc = PingoneRegionCode(ENUM_PINGONE_REGION_CODE_CA) + *prc = PingOneRegionCode(ENUM_PINGONE_REGION_CODE_CA) case strings.EqualFold(regionCode, ENUM_PINGONE_REGION_CODE_EU): - *prc = PingoneRegionCode(ENUM_PINGONE_REGION_CODE_EU) + *prc = PingOneRegionCode(ENUM_PINGONE_REGION_CODE_EU) case strings.EqualFold(regionCode, ENUM_PINGONE_REGION_CODE_NA): - *prc = PingoneRegionCode(ENUM_PINGONE_REGION_CODE_NA) + *prc = PingOneRegionCode(ENUM_PINGONE_REGION_CODE_NA) case strings.EqualFold(regionCode, ""): - *prc = PingoneRegionCode("") + *prc = PingOneRegionCode("") default: - return fmt.Errorf("unrecognized Pingone Region Code: '%s'. Must be one of: %s", regionCode, strings.Join(PingoneRegionCodeValidValues(), ", ")) + return fmt.Errorf("unrecognized PingOne Region Code: '%s'. Must be one of: %s", regionCode, strings.Join(PingOneRegionCodeValidValues(), ", ")) } return nil } -func (prc PingoneRegionCode) Type() string { +func (prc PingOneRegionCode) Type() string { return "string" } -func (prc PingoneRegionCode) String() string { +func (prc PingOneRegionCode) String() string { return string(prc) } -func PingoneRegionCodeValidValues() []string { +func PingOneRegionCodeValidValues() []string { pingoneRegionCodes := []string{ ENUM_PINGONE_REGION_CODE_AP, ENUM_PINGONE_REGION_CODE_AU, diff --git a/internal/customtypes/pingone_region_code_test.go b/internal/customtypes/pingone_region_code_test.go index f59e12c6..e9957d8a 100644 --- a/internal/customtypes/pingone_region_code_test.go +++ b/internal/customtypes/pingone_region_code_test.go @@ -9,7 +9,7 @@ import ( // Test PingOneRegion Set function func Test_PingOneRegion_Set(t *testing.T) { - prc := new(customtypes.PingoneRegionCode) + prc := new(customtypes.PingOneRegionCode) err := prc.Set(customtypes.ENUM_PINGONE_REGION_CODE_AP) if err != nil { @@ -19,29 +19,29 @@ func Test_PingOneRegion_Set(t *testing.T) { // Test Set function fails with invalid value func Test_PingOneRegion_Set_InvalidValue(t *testing.T) { - prc := new(customtypes.PingoneRegionCode) + prc := new(customtypes.PingOneRegionCode) invalidValue := "invalid" - expectedErrorPattern := `^unrecognized Pingone Region Code: '.*'\. Must be one of: .*$` + expectedErrorPattern := `^unrecognized PingOne Region Code: '.*'\. Must be one of: .*$` err := prc.Set(invalidValue) testutils.CheckExpectedError(t, err, &expectedErrorPattern) } // Test Set function fails with nil func Test_PingOneRegion_Set_Nil(t *testing.T) { - var prc *customtypes.PingoneRegionCode + var prc *customtypes.PingOneRegionCode val := customtypes.ENUM_PINGONE_REGION_CODE_AP - expectedErrorPattern := `^failed to set Pingone Region Code value: .* Pingone Region Code is nil$` + expectedErrorPattern := `^failed to set PingOne Region Code value: .* PingOne Region Code is nil$` err := prc.Set(val) testutils.CheckExpectedError(t, err, &expectedErrorPattern) } // Test String function func Test_PingOneRegion_String(t *testing.T) { - pingoneRegion := customtypes.PingoneRegionCode(customtypes.ENUM_PINGONE_REGION_CODE_CA) + pingoneRegion := customtypes.PingOneRegionCode(customtypes.ENUM_PINGONE_REGION_CODE_CA) expected := customtypes.ENUM_PINGONE_REGION_CODE_CA actual := pingoneRegion.String() diff --git a/internal/profiles/validate.go b/internal/profiles/validate.go index a712a13b..4d56bab7 100644 --- a/internal/profiles/validate.go +++ b/internal/profiles/validate.go @@ -23,7 +23,7 @@ func Validate() error { // Make sure selected active profile is in the configuration file activeProfile := GetMainConfig().ActiveProfile().Name() if !slices.Contains(profileNames, activeProfile) { - return fmt.Errorf("failed to validate pingcli configuration: active profile '%s' not found in configuration file %s", activeProfile, GetMainConfig().ViperInstance().ConfigFileUsed()) + return fmt.Errorf("failed to validate Ping CLI configuration: active profile '%s' not found in configuration file %s", activeProfile, GetMainConfig().ViperInstance().ConfigFileUsed()) } // for each profile key, set the profile based on mainViper.Sub() and validate the profile @@ -31,11 +31,11 @@ func Validate() error { subViper := GetMainConfig().ViperInstance().Sub(pName) if err := validateProfileKeys(pName, subViper); err != nil { - return fmt.Errorf("failed to validate pingcli configuration: %v", err) + return fmt.Errorf("failed to validate Ping CLI configuration: %v", err) } if err := validateProfileValues(pName, subViper); err != nil { - return fmt.Errorf("failed to validate pingcli configuration: %v", err) + return fmt.Errorf("failed to validate Ping CLI configuration: %v", err) } } @@ -124,15 +124,15 @@ func validateProfileValues(pName string, profileViper *viper.Viper) (err error) } case options.ENUM_PINGONE_REGION_CODE: switch typedValue := vValue.(type) { - case *customtypes.PingoneRegionCode: + case *customtypes.PingOneRegionCode: continue case string: - prc := new(customtypes.PingoneRegionCode) + prc := new(customtypes.PingOneRegionCode) if err = prc.Set(typedValue); err != nil { - return fmt.Errorf("profile '%s': variable type '%T' for key '%s' is not a Pingone Region Code value: %v", pName, typedValue, key, err) + return fmt.Errorf("profile '%s': variable type '%T' for key '%s' is not a PingOne Region Code value: %v", pName, typedValue, key, err) } default: - return fmt.Errorf("profile '%s': variable type %T for key '%s' is not a Pingone Region Code value", pName, typedValue, key) + return fmt.Errorf("profile '%s': variable type %T for key '%s' is not a PingOne Region Code value", pName, typedValue, key) } case options.ENUM_STRING: switch typedValue := vValue.(type) { @@ -249,10 +249,10 @@ func validateProfileValues(pName string, profileViper *viper.Viper) (err error) } case options.ENUM_PINGFEDERATE_AUTH_TYPE: switch typedValue := vValue.(type) { - case *customtypes.PingfederateAuthenticationType: + case *customtypes.PingFederateAuthenticationType: continue case string: - pfa := new(customtypes.PingfederateAuthenticationType) + pfa := new(customtypes.PingFederateAuthenticationType) if err = pfa.Set(typedValue); err != nil { return fmt.Errorf("profile '%s': variable type '%T' for key '%s' is not a PingFederate Authentication Type value: %v", pName, typedValue, key, err) } @@ -261,10 +261,10 @@ func validateProfileValues(pName string, profileViper *viper.Viper) (err error) } case options.ENUM_PINGONE_AUTH_TYPE: switch typedValue := vValue.(type) { - case *customtypes.PingoneAuthenticationType: + case *customtypes.PingOneAuthenticationType: continue case string: - pat := new(customtypes.PingoneAuthenticationType) + pat := new(customtypes.PingOneAuthenticationType) if err = pat.Set(typedValue); err != nil { return fmt.Errorf("profile '%s': variable type '%T' for key '%s' is not a PingOne Authentication Type value: %v", pName, typedValue, key, err) } diff --git a/internal/testing/testutils/utils.go b/internal/testing/testutils/utils.go index 013d5ed1..2b6f3bac 100644 --- a/internal/testing/testutils/utils.go +++ b/internal/testing/testutils/utils.go @@ -26,7 +26,7 @@ var ( func GetEnvironmentID() string { envIdOnce.Do(func() { - environmentId = os.Getenv(options.PlatformExportPingoneEnvironmentIDOption.EnvVar) + environmentId = os.Getenv(options.PlatformExportPingOneEnvironmentIDOption.EnvVar) }) return environmentId @@ -40,10 +40,10 @@ func GetPingOneClientInfo(t *testing.T) *connector.PingOneClientInfo { configuration.InitAllOptions() // Grab environment vars for initializing the API client. // These are set in GitHub Actions. - clientID := os.Getenv(options.PingoneAuthenticationWorkerClientIDOption.EnvVar) - clientSecret := os.Getenv(options.PingoneAuthenticationWorkerClientSecretOption.EnvVar) + clientID := os.Getenv(options.PingOneAuthenticationWorkerClientIDOption.EnvVar) + clientSecret := os.Getenv(options.PingOneAuthenticationWorkerClientSecretOption.EnvVar) environmentId := GetEnvironmentID() - regionCode := os.Getenv(options.PingoneRegionCodeOption.EnvVar) + regionCode := os.Getenv(options.PingOneRegionCodeOption.EnvVar) sdkRegionCode := management.EnumRegionCode(regionCode) if clientID == "" || clientSecret == "" || environmentId == "" || regionCode == "" { @@ -82,10 +82,10 @@ func GetPingFederateClientInfo(t *testing.T) *connector.PingFederateClientInfo { configuration.InitAllOptions() - httpsHost := os.Getenv(options.PingfederateHTTPSHostOption.EnvVar) - adminApiPath := os.Getenv(options.PingfederateAdminAPIPathOption.EnvVar) - pfUsername := os.Getenv(options.PingfederateBasicAuthUsernameOption.EnvVar) - pfPassword := os.Getenv(options.PingfederateBasicAuthPasswordOption.EnvVar) + httpsHost := os.Getenv(options.PingFederateHTTPSHostOption.EnvVar) + adminApiPath := os.Getenv(options.PingFederateAdminAPIPathOption.EnvVar) + pfUsername := os.Getenv(options.PingFederateBasicAuthUsernameOption.EnvVar) + pfPassword := os.Getenv(options.PingFederateBasicAuthPasswordOption.EnvVar) if httpsHost == "" || adminApiPath == "" || pfUsername == "" || pfPassword == "" { t.Fatalf("Unable to retrieve env var value for one or more of httpsHost, adminApiPath, pfUsername, pfPassword.") diff --git a/internal/testing/testutils_viper/viper_utils.go b/internal/testing/testutils_viper/viper_utils.go index 94878cb2..18922b9e 100644 --- a/internal/testing/testutils_viper/viper_utils.go +++ b/internal/testing/testutils_viper/viper_utils.go @@ -109,14 +109,14 @@ func InitVipersCustomFile(t *testing.T, fileContents string) { func getDefaultConfigFileContents() string { return fmt.Sprintf(defaultConfigFileContentsPattern, outputDirectoryReplacement, - os.Getenv(options.PingoneRegionCodeOption.EnvVar), - os.Getenv(options.PingoneAuthenticationWorkerClientIDOption.EnvVar), - os.Getenv(options.PingoneAuthenticationWorkerClientSecretOption.EnvVar), - os.Getenv(options.PingoneAuthenticationWorkerEnvironmentIDOption.EnvVar), - os.Getenv(options.PingfederateAdminAPIPathOption.EnvVar), - os.Getenv(options.PingfederateClientCredentialsAuthClientIDOption.EnvVar), - os.Getenv(options.PingfederateClientCredentialsAuthClientSecretOption.EnvVar), - os.Getenv(options.PingfederateClientCredentialsAuthScopesOption.EnvVar), - os.Getenv(options.PingfederateClientCredentialsAuthTokenURLOption.EnvVar), - os.Getenv(options.PingfederateHTTPSHostOption.EnvVar)) + os.Getenv(options.PingOneRegionCodeOption.EnvVar), + os.Getenv(options.PingOneAuthenticationWorkerClientIDOption.EnvVar), + os.Getenv(options.PingOneAuthenticationWorkerClientSecretOption.EnvVar), + os.Getenv(options.PingOneAuthenticationWorkerEnvironmentIDOption.EnvVar), + os.Getenv(options.PingFederateAdminAPIPathOption.EnvVar), + os.Getenv(options.PingFederateClientCredentialsAuthClientIDOption.EnvVar), + os.Getenv(options.PingFederateClientCredentialsAuthClientSecretOption.EnvVar), + os.Getenv(options.PingFederateClientCredentialsAuthScopesOption.EnvVar), + os.Getenv(options.PingFederateClientCredentialsAuthTokenURLOption.EnvVar), + os.Getenv(options.PingFederateHTTPSHostOption.EnvVar)) }