feat(store-types): Add ability to use integration-manifest.json from custom Keyfactor git repo, default to kfutil repo.

Signed-off-by: spbsoluble <[email protected]>

Author: spbsoluble

cmd/constants.go

@@ -21,11 +21,14 @@ const (
 	DefaultAPIPath            = "KeyfactorAPI"
 	DefaultConfigFileName     = "command_config.json"
 	DefaultStoreTypesFileName = "store_types.json"
+	DefaultGitRepo            = "kfutil"
+	DefaultGitRef             = "main"
 	FailedAuthMsg             = "Login failed!"
 	SuccessfulAuthMsg         = "Login successful!"
 	XKeyfactorRequestedWith   = "APIClient"
 	XKeyfactorApiVersion      = "1"
 	FlagGitRef                = "git-ref"
+	FlagGitRepo               = "repo"
 	FlagFromFile              = "from-file"
 	DebugFuncEnter            = "entered: %s"
 	DebugFuncExit             = "exiting: %s"

cmd/storeTypes.go

@@ -91,8 +91,9 @@ var storesTypeCreateCmd = &cobra.Command{
 		cmd.SilenceUsage = true
 		// Specific flags
 		gitRef, _ := cmd.Flags().GetString(FlagGitRef)
+		gitRepo, _ := cmd.Flags().GetString(FlagGitRepo)
 		creatAll, _ := cmd.Flags().GetBool("all")
-		validStoreTypes := getValidStoreTypes("", gitRef)
+		validStoreTypes := getValidStoreTypes("", gitRef, gitRepo)
 		storeType, _ := cmd.Flags().GetString("name")
 		listTypes, _ := cmd.Flags().GetBool("list")
 		storeTypeConfigFile, _ := cmd.Flags().GetString("from-file")
@@ -110,7 +111,10 @@ var storesTypeCreateCmd = &cobra.Command{
 
 		// CLI Logic
 		if gitRef == "" {
-			gitRef = "main"
+			gitRef = DefaultGitRef
+		}
+		if gitRepo == "" {
+			gitRepo = DefaultGitRepo
 		}
 		storeTypeIsValid := false
 
@@ -119,6 +123,7 @@ var storesTypeCreateCmd = &cobra.Command{
 			Str("storeTypeConfigFile", storeTypeConfigFile).
 			Bool("creatAll", creatAll).
 			Str("gitRef", gitRef).
+			Str("gitRepo", gitRepo).
 			Strs("validStoreTypes", validStoreTypes).
 			Msg("create command flags")
 
@@ -183,7 +188,7 @@ var storesTypeCreateCmd = &cobra.Command{
 		} else {
 			typesToCreate = validStoreTypes
 		}
-		storeTypeConfig, stErr := readStoreTypesConfig("", gitRef, offline)
+		storeTypeConfig, stErr := readStoreTypesConfig("", gitRef, gitRepo, offline)
 		if stErr != nil {
 			log.Error().Err(stErr).Send()
 			return stErr
@@ -263,7 +268,7 @@ var storesTypeDeleteCmd = &cobra.Command{
 			validStoreTypesResp, vstErr := kfClient.ListCertificateStoreTypes()
 			if vstErr != nil {
 				log.Error().Err(vstErr).Msg("unable to list certificate store types")
-				validStoreTypes = getValidStoreTypes("", gitRef)
+				validStoreTypes = getValidStoreTypes("", gitRef, DefaultGitRepo)
 			} else {
 				for _, v := range *validStoreTypesResp {
 					validStoreTypes = append(validStoreTypes, v.ShortName)
@@ -360,6 +365,7 @@ var fetchStoreTypesCmd = &cobra.Command{
 		cmd.SilenceUsage = true
 		// Specific flags
 		gitRef, _ := cmd.Flags().GetString(FlagGitRef)
+		gitRepo, _ := cmd.Flags().GetString(FlagGitRepo)
 
 		// Debug + expEnabled checks
 		isExperimental := false
@@ -372,7 +378,7 @@ var fetchStoreTypesCmd = &cobra.Command{
 		if gitRef == "" {
 			gitRef = "main"
 		}
-		templates, err := readStoreTypesConfig("", gitRef, offline)
+		templates, err := readStoreTypesConfig("", gitRef, gitRepo, offline)
 		if err != nil {
 			log.Error().Err(err).Send()
 			return err
@@ -480,15 +486,26 @@ func formatStoreTypes(sTypesList *[]interface{}) (map[string]interface{}, error)
 	return output, nil
 }
 
-func getStoreTypesInternet(gitRef string) (map[string]interface{}, error) {
+func getStoreTypesInternet(gitRef string, repo string) (map[string]interface{}, error) {
 	//resp, err := http.Get("https://raw.githubusercontent.com/keyfactor/kfutil/main/store_types.json")
 	//resp, err := http.Get("https://raw.githubusercontent.com/keyfactor/kfctl/master/storetypes/storetypes.json")
 
-	baseUrl := "https://raw.githubusercontent.com/Keyfactor/kfutil/%s/store_types.json"
+	baseUrl := "https://raw.githubusercontent.com/Keyfactor/%s/%s/%s"
 	if gitRef == "" {
-		gitRef = "main"
+		gitRef = DefaultGitRef
+	}
+	if repo == "" {
+		repo = DefaultGitRepo
+	}
+
+	var fileName string
+	if repo == "kfutil" {
+		fileName = "store_types.json"
+	} else {
+		fileName = "integration-manifest.json"
 	}
-	url := fmt.Sprintf(baseUrl, gitRef)
+
+	url := fmt.Sprintf(baseUrl, repo, gitRef, fileName)
 	log.Debug().
 		Str("url", url).
 		Msg("Getting store types from internet")
@@ -513,7 +530,23 @@ func getStoreTypesInternet(gitRef string) (map[string]interface{}, error) {
 	var result []interface{}
 	jErr := json.Unmarshal(body, &result)
 	if jErr != nil {
-		return nil, jErr
+		log.Warn().Err(jErr).Msg("Unable to decode JSON file, attempting to parse an integration manifest")
+		// Attempt to parse as an integration manifest
+		var manifest IntegrationManifest
+		log.Debug().Msg("Decoding JSON file as integration manifest")
+		// Reset the file pointer
+
+		mErr := json.Unmarshal(body, &manifest)
+		if mErr != nil {
+			return nil, jErr
+		}
+		log.Debug().Msg("Decoded JSON file as integration manifest")
+		sTypes := manifest.About.Orchestrator.StoreTypes
+		output := make(map[string]interface{})
+		for _, st := range sTypes {
+			output[st.ShortName] = st
+		}
+		return output, nil
 	}
 	output, sErr := formatStoreTypes(&result)
 	if sErr != nil {
@@ -525,18 +558,20 @@ func getStoreTypesInternet(gitRef string) (map[string]interface{}, error) {
 
 }
 
-func getValidStoreTypes(fp string, gitRef string) []string {
+func getValidStoreTypes(fp string, gitRef string, gitRepo string) []string {
 	log.Debug().
 		Str("file", fp).
 		Str("gitRef", gitRef).
+		Str("gitRepo", gitRepo).
 		Bool("offline", offline).
 		Msg(DebugFuncEnter)
 
 	log.Debug().
 		Str("file", fp).
 		Str("gitRef", gitRef).
+		Str("gitRepo", gitRepo).
 		Msg("Reading store types config.")
-	validStoreTypes, rErr := readStoreTypesConfig(fp, gitRef, offline)
+	validStoreTypes, rErr := readStoreTypesConfig(fp, gitRef, gitRepo, offline)
 	if rErr != nil {
 		log.Error().Err(rErr).Msg("unable to read store types")
 		return nil
@@ -549,7 +584,7 @@ func getValidStoreTypes(fp string, gitRef string) []string {
 	return validStoreTypesList
 }
 
-func readStoreTypesConfig(fp, gitRef string, offline bool) (map[string]interface{}, error) {
+func readStoreTypesConfig(fp, gitRef string, gitRepo string, offline bool) (map[string]interface{}, error) {
 	log.Debug().Str("file", fp).Str("gitRef", gitRef).Msg("Entering readStoreTypesConfig")
 
 	var (
@@ -560,7 +595,7 @@ func readStoreTypesConfig(fp, gitRef string, offline bool) (map[string]interface
 		log.Debug().Msg("Reading store types config from file")
 	} else {
 		log.Debug().Msg("Reading store types config from internet")
-		sTypes, stErr = getStoreTypesInternet(gitRef)
+		sTypes, stErr = getStoreTypesInternet(gitRef, gitRepo)
 	}
 
 	if stErr != nil || sTypes == nil || len(sTypes) == 0 {
@@ -600,11 +635,11 @@ func readStoreTypesConfig(fp, gitRef string, offline bool) (map[string]interface
 }
 
 func init() {
-	defaultGitRef := "main"
 	offline = true    // temporarily set to true as it runs before the flag is set
 	debugFlag = false // temporarily set to false as it runs before the flag is set
 	var gitRef string
-	validTypesString := strings.Join(getValidStoreTypes("", defaultGitRef), ", ")
+	var gitRepo string
+	validTypesString := strings.Join(getValidStoreTypes("", DefaultGitRef, DefaultGitRepo), ", ")
 	offline = false //revert this so that flag is not set to true by default
 	RootCmd.AddCommand(storeTypesCmd)
 
@@ -618,6 +653,14 @@ func init() {
 		"The git branch or tag to reference when pulling store-types from the internet.",
 	)
 
+	fetchStoreTypesCmd.Flags().StringVarP(
+		&gitRepo,
+		FlagGitRepo,
+		"r",
+		DefaultGitRepo,
+		"The repository to pull store-type definitions from.",
+	)
+
 	// LIST command
 	storeTypesCmd.AddCommand(storesTypesListCmd)
 
@@ -653,6 +696,14 @@ func init() {
 		"main",
 		"The git branch or tag to reference when pulling store-types from the internet.",
 	)
+	storesTypeCreateCmd.Flags().StringVarP(
+		&gitRepo,
+		FlagGitRepo,
+		"r",
+		DefaultGitRepo,
+		"The repository to pull store-types definitions from.",
+	)
+
 	storesTypeCreateCmd.Flags().BoolVarP(&createAll, "all", "a", false, "Create all store types.")
 
 	// UPDATE command

cmd/storeTypes_get.go

@@ -187,6 +187,7 @@ type StoreTypesGetOptions struct {
 	storeTypeName               string
 	genericFormat               bool
 	gitRef                      string
+	gitRepo                     string
 	storeTypeInterface          interface{}
 	outputType                  string
 	outputToIntegrationManifest bool
@@ -243,7 +244,7 @@ func (f *StoreTypesGetOptions) Validate() error {
 	// Check inputs and prompt if necessary
 	// The f.storeTypeInterface is used to pass the store type to the API
 	if f.storeTypeID < 0 && f.storeTypeName == "" {
-		validStoreTypes := getValidStoreTypes("", f.gitRef)
+		validStoreTypes := getValidStoreTypes("", f.gitRef, DefaultGitRepo)
 		prompt := &survey.Select{
 			Message: "Choose a store type:",
 			Options: validStoreTypes,

cmd/storesBulkOperations.go

@@ -77,7 +77,7 @@ func formatProperties(json *gabs.Container, reqPropertiesForStoreType []string)
 
 func serializeStoreFromTypeDef(storeTypeName string, input string) (string, error) {
 	// check if storetypename is an integer
-	storeTypes, _ := readStoreTypesConfig("", "", offline)
+	storeTypes, _ := readStoreTypesConfig("", DefaultGitRef, DefaultGitRepo, offline)
 	log.Debug().
 		Str("storeTypeName", storeTypeName).
 		Msg("checking if storeTypeName is an integer")
@@ -399,7 +399,7 @@ Store type IDs can be found by running the "store-types" command.`,
 			validStoreTypesResp, vstErr := kfClient.ListCertificateStoreTypes()
 			if vstErr != nil {
 				log.Error().Err(vstErr).Msg("unable to list certificate store types")
-				validStoreTypes = getValidStoreTypes("", "main")
+				validStoreTypes = getValidStoreTypes("", DefaultGitRef, DefaultGitRepo)
 			} else {
 				for _, v := range *validStoreTypesResp {
 					validStoreTypes = append(validStoreTypes, v.ShortName)

docs/kfutil.md

@@ -45,4 +45,4 @@ A CLI wrapper around the Keyfactor Platform API.
 * [kfutil stores](kfutil_stores.md)	 - Keyfactor certificate stores APIs and utilities.
 * [kfutil version](kfutil_version.md)	 - Shows version of kfutil
 
-###### Auto generated by spf13/cobra on 20-Nov-2024
+###### Auto generated by spf13/cobra on 9-Dec-2024

docs/kfutil_completion.md

@@ -44,4 +44,4 @@ See each sub-command's help for details on how to use the generated script.
 * [kfutil completion powershell](kfutil_completion_powershell.md)	 - Generate the autocompletion script for powershell
 * [kfutil completion zsh](kfutil_completion_zsh.md)	 - Generate the autocompletion script for zsh
 
-###### Auto generated by spf13/cobra on 20-Nov-2024
+###### Auto generated by spf13/cobra on 9-Dec-2024

docs/kfutil_completion_bash.md

@@ -63,4 +63,4 @@ kfutil completion bash
 
 * [kfutil completion](kfutil_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 20-Nov-2024
+###### Auto generated by spf13/cobra on 9-Dec-2024

docs/kfutil_completion_fish.md

@@ -54,4 +54,4 @@ kfutil completion fish [flags]
 
 * [kfutil completion](kfutil_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 20-Nov-2024
+###### Auto generated by spf13/cobra on 9-Dec-2024

docs/kfutil_completion_powershell.md

@@ -51,4 +51,4 @@ kfutil completion powershell [flags]
 
 * [kfutil completion](kfutil_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 20-Nov-2024
+###### Auto generated by spf13/cobra on 9-Dec-2024

docs/kfutil_completion_zsh.md

@@ -65,4 +65,4 @@ kfutil completion zsh [flags]
 
 * [kfutil completion](kfutil_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 20-Nov-2024
+###### Auto generated by spf13/cobra on 9-Dec-2024