Documentation lessons learned

.gitignore

@@ -12,3 +12,7 @@ sailpoint-cli
 
 data
 .DS_Store
+assets/demo_create.json
+assets/demo_update.json
+cmd/transform/test_data/test_create.json
+cmd/transform/test_data/test_update.json

cmd/configure/configure.go

@@ -8,6 +8,9 @@ import (
 )
 
 func NewConfigureCmd() *cobra.Command {
+	var ClientID string
+	var ClientSecret string
+	var err error
 	cmd := &cobra.Command{
 		Use:     "configure",
 		Short:   "Configure PAT Authentication for the currently active environment",
@@ -16,15 +19,30 @@ func NewConfigureCmd() *cobra.Command {
 		Args:    cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, args []string) error {
 
-			ClientID := terminal.InputPrompt("Personal Access Token Client ID:")
+			if ClientID == "" {
+				ClientID, err = terminal.PromptPassword("Personal Access Token Client ID:")
+				if err != nil {
+					return err
+				}
+			}
+
 			config.SetPatClientID(ClientID)
 
-			ClientSecret := terminal.InputPrompt("Personal Access Token Client Secret:")
+			if ClientSecret == "" {
+				ClientSecret, err = terminal.PromptPassword("Personal Access Token Client Secret:")
+				if err != nil {
+					return err
+				}
+			}
+
 			config.SetPatClientSecret(ClientSecret)
 
 			return nil
 		},
 	}
 
+	cmd.Flags().StringVarP(&ClientID, "ClientID", "id", "", "The client id to use for PAT authentication")
+	cmd.Flags().StringVarP(&ClientSecret, "ClientSecret", "secret", "", "The client secret to use for PAT authentication")
+
 	return cmd
 }

cmd/environment/environment.go

@@ -5,13 +5,17 @@ import (
 	"github.com/sailpoint-oss/sailpoint-cli/internal/log"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/terminal"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/tui"
+	"github.com/sailpoint-oss/sailpoint-cli/internal/util"
 	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
 	"golang.org/x/exp/maps"
 )
 
 func NewEnvironmentCommand() *cobra.Command {
 	var env string
 	var overwrite bool
+	var erase bool
+	var show bool
 	cmd := &cobra.Command{
 		Use:     "environment",
 		Short:   "change currently active environment",
@@ -41,9 +45,16 @@ func NewEnvironmentCommand() *cobra.Command {
 			if env != "" {
 				config.SetActiveEnvironment(env)
 
-				if _, exists := environments[env]; exists && !overwrite && config.GetTenantUrl() != "" && config.GetBaseUrl() != "" {
+				if foundEnv, exists := environments[env]; exists && !overwrite && config.GetTenantUrl() != "" && config.GetBaseUrl() != "" {
-
+					if show {
-					log.Log.Info("Environment changed", "env", env)
+						log.Log.Warn("printing env", "env", env)
+						util.PrettyPrint(foundEnv)
+					} else if erase {
+						log.Log.Warn("erasing env", "env", env)
+						viper.Set("environments."+config.GetActiveEnvironment(), config.Environment{})
+					} else {
+						log.Log.Info("Environment changed", "env", env)
+					}
 
 				} else {
 
@@ -63,6 +74,9 @@ func NewEnvironmentCommand() *cobra.Command {
 	}
 
 	cmd.Flags().BoolVarP(&overwrite, "overwrite", "o", false, "use to overwrite an existing environments configuration")
+	cmd.Flags().BoolVarP(&erase, "erase", "e", false, "use to erase an existing environments configuration")
+	cmd.Flags().BoolVarP(&show, "show", "s", false, "use to show an existing environments configuration")
+	cmd.MarkFlagsMutuallyExclusive("overwrite", "erase", "show")
 
 	return cmd
 

cmd/search/template.go

@@ -6,7 +6,6 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/fatih/color"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/config"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/log"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/search"
@@ -57,21 +56,21 @@ func newTemplateCmd() *cobra.Command {
 				return fmt.Errorf("no template specified")
 			}
 
-			color.Blue("Selected Template: %s\n", template)
+			log.Log.Info("Selected Template", "template", template)
 
 			matches := types.Filter(searchTemplates, func(st templates.SearchTemplate) bool { return st.Name == template })
 			if len(matches) < 1 {
 				return fmt.Errorf("no template matches for %s", template)
 			} else if len(matches) > 1 {
-				color.Yellow("multiple template matches for %s", template)
+				log.Log.Warn("multiple template matches, the first match will be used", "template", template)
 			}
 			selectedTemplate = matches[0]
 			varCount := len(selectedTemplate.Variables)
 			if varCount > 0 {
 				for i := 0; i < varCount; i++ {
 					varEntry := selectedTemplate.Variables[i]
-					resp := terminal.InputPrompt(fmt.Sprintf("Input %s:", varEntry.Prompt))
+					resp := terminal.InputPrompt("Input " + varEntry.Prompt + ":")
-					selectedTemplate.Raw = []byte(strings.ReplaceAll(string(selectedTemplate.Raw), fmt.Sprintf("{{%s}}", varEntry.Name), resp))
+					selectedTemplate.Raw = []byte(strings.ReplaceAll(string(selectedTemplate.Raw), "{{"+varEntry.Name+"}}", resp))
 				}
 				err := json.Unmarshal(selectedTemplate.Raw, &selectedTemplate.SearchQuery)
 				if err != nil {

cmd/spconfig/export.go

@@ -55,8 +55,8 @@ func newExportCmd() *cobra.Command {
 
 	cmd.Flags().StringVarP(&folderPath, "folderPath", "f", "spconfig-exports", "folder path to save the search results in. If the directory doesn't exist, then it will be automatically created. (default is the current working directory)")
 	cmd.Flags().StringVarP(&description, "description", "d", "", "optional description for the export job")
-	cmd.Flags().StringArrayVarP(&includeTypes, "includTypes", "i", []string{}, "types to include in export job")
+	cmd.Flags().StringArrayVarP(&includeTypes, "include", "i", []string{}, "types to include in export job")
-	cmd.Flags().StringArrayVarP(&excludeTypes, "excludeTypes", "e", []string{}, "types to exclude in export job")
+	cmd.Flags().StringArrayVarP(&excludeTypes, "exclude", "e", []string{}, "types to exclude in export job")
 	cmd.Flags().BoolVarP(&wait, "wait", "w", false, "wait for the export job to finish, and download the results")
 
 	return cmd

cmd/spconfig/status.go

@@ -50,8 +50,8 @@ func newExportStatusCmd() *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringArrayVarP(&importJobs, "import jobs", "i", []string{}, "a list of import job ids to check the status of")
+	cmd.Flags().StringArrayVarP(&importJobs, "import", "i", []string{}, "a list of import job ids to check the status of")
-	cmd.Flags().StringArrayVarP(&exportJobs, "export jobs", "e", []string{}, "a list of export job ids to check the status of")
+	cmd.Flags().StringArrayVarP(&exportJobs, "export", "e", []string{}, "a list of export job ids to check the status of")
 
 	return cmd
 }

cmd/spconfig/template.go

@@ -84,14 +84,14 @@ func newTemplateCmd() *cobra.Command {
 
 			if wait {
 				log.Log.Info("Checking Export Job", "JobID", job.JobId)
-				spconfig.DownloadExport(job.JobId, "spconfig-export-"+template+job.JobId+".json", folderPath)
+				spconfig.DownloadExport(job.JobId, "spconfig-export-"+template+"-"+job.JobId+".json", folderPath)
 			}
 
 			return nil
 		},
 	}
 
-	cmd.Flags().StringArrayVarP(&outputTypes, "output types", "o", []string{"json"}, "the sort value for the api call (examples)")
+	cmd.Flags().StringArrayVarP(&outputTypes, "outputTypes", "o", []string{"json"}, "the sort value for the api call (examples)")
 	cmd.Flags().StringVarP(&folderPath, "folderPath", "f", "spconfig-exports", "folder path to save the search results in. If the directory doesn't exist, then it will be automatically created. (default is the current working directory)")
 	cmd.Flags().BoolVarP(&wait, "wait", "w", false, "wait for the export job to finish, and download the results")
 

cmd/transform/delete.go

@@ -33,8 +33,8 @@ func newDeleteCmd() *cobra.Command {
 				}
 
 				columns := []table.Column{
-					{Title: "Name", Width: 25},
 					{Title: "ID", Width: 40},
+					{Title: "Name", Width: 25},
 					{Title: "Type", Width: 25},
 				}
 
@@ -42,7 +42,7 @@ func newDeleteCmd() *cobra.Command {
 
 				for i := 0; i < len(transforms); i++ {
 					transform := transforms[i]
-					rows = append(rows, []string{*transform.Id, transform.Name})
+					rows = append(rows, []string{*transform.Id, transform.Name, transform.Type})
 				}
 
 				t := table.New(
@@ -73,7 +73,7 @@ func newDeleteCmd() *cobra.Command {
 				tempRow := m.Retrieve()
 
 				if len(tempRow) > 0 {
-					id = append(id, m.Retrieve()[1])
+					id = append(id, m.Retrieve()[0])
 				} else {
 					return fmt.Errorf("no transform selected")
 				}
@@ -98,11 +98,6 @@ func newDeleteCmd() *cobra.Command {
 				log.Log.Info("Transform successfully deleted", "TransformID", transformID)
 			}
 
-			err := transform.ListTransforms()
-			if err != nil {
-				return err
-			}
-
 			return nil
 		},
 	}

cmd/transform/download.go

@@ -60,7 +60,7 @@ func newDownloadCmd() *cobra.Command {
 				}
 			}
 
-			log.Log.Info("Transforms downloaded successfully", "Path", destination)
+			log.Log.Info("Transforms downloaded successfully", "path", destination)
 
 			return nil
 		},

cmd/transform/test_data/test_create.json

@@ -1 +1 @@
-{"attributes":{"substring":"admin_"},"name":"gToJfU","type":"indexOf"}
+{"attributes":{"substring":"admin_"},"name":"XWwLDi","type":"indexOf"}

cmd/transform/test_data/test_update.json

@@ -1 +1 @@
-{"attributes":{"substring":"jlVDuHNDDnnAGbgTefISNwTY"},"id":"71f3d4d5-baf4-4b76-bbd3-93ee8660e9fc","name":"gToJfU","type":"indexOf"}
+{"attributes":{"substring":"WxrnOBHyejgSKnPpgnSchJpe"},"id":"a6697db7-d561-4967-a89a-9fe4ae161374","name":"XWwLDi","type":"indexOf"}

cmd/transform/update.go

@@ -9,6 +9,7 @@ import (
 
 	sailpointsdk "github.com/sailpoint-oss/golang-sdk/sdk-output/v3"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/config"
+	"github.com/sailpoint-oss/sailpoint-cli/internal/log"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/sdk"
 	"github.com/spf13/cobra"
 )
@@ -50,6 +51,8 @@ func newUpdateCmd() *cobra.Command {
 			id := data["id"].(string)
 			delete(data, "id") // ID can't be present in the update payload
 
+			log.Log.Info("Updating Transaform", "transformID", id)
+
 			transform := sailpointsdk.NewTransform(data["name"].(string), data["type"].(string), data["attributes"].(map[string]interface{}))
 
 			apiClient, err := config.InitAPIClient()

internal/config/config.go

@@ -2,7 +2,6 @@ package config
 
 import (
 	"fmt"
-	"log"
 	"os"
 	"path/filepath"
 	"strings"
@@ -10,6 +9,7 @@ import (
 
 	"github.com/fatih/color"
 	sailpoint "github.com/sailpoint-oss/golang-sdk/sdk-output"
+	"github.com/sailpoint-oss/sailpoint-cli/internal/log"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/types"
 	"github.com/spf13/viper"
 )
@@ -241,7 +241,7 @@ func SaveConfig() error {
 	if _, err := os.Stat(filepath.Join(home, configFolder)); os.IsNotExist(err) {
 		err = os.Mkdir(filepath.Join(home, configFolder), 0777)
 		if err != nil {
-			log.Printf("failed to create %s folder for config. %v", configFolder, err)
+			log.Log.Warn("failed to create %s folder for config. %v", configFolder, err)
 		}
 	}
 
@@ -260,6 +260,7 @@ func SaveConfig() error {
 }
 
 func Validate() error {
+	var errors int
 	authType := GetAuthType()
 
 	switch authType {
@@ -267,21 +268,24 @@ func Validate() error {
 	case "pat":
 
 		if GetBaseUrl() == "" {
-			return fmt.Errorf("configured environment is missing BaseURL")
+			log.Log.Error("configured environment is missing BaseURL")
+			errors++
 		}
 
 		if GetPatClientID() == "" {
-			return fmt.Errorf("configured environment is missing PAT ClientID")
+			log.Log.Error("configured environment is missing PAT ClientID")
+			errors++
 		}
 
 		if GetPatClientSecret() == "" {
-			return fmt.Errorf("configured environment is missing PAT ClientSecret")
+			log.Log.Error("configured environment is missing PAT ClientSecret")
+			errors++
 		}
 
-		return nil
-
 	case "oauth":
-		return fmt.Errorf("oauth is not currently supported")
+
+		log.Log.Error("oauth is not currently supported")
+		errors++
 
 		// if config.Environments[config.ActiveEnvironment].BaseURL == "" {
 		// 	return fmt.Errorf("configured environment is missing BaseURL")
@@ -291,11 +295,16 @@ func Validate() error {
 		// 	return fmt.Errorf("configured environment is missing TenantURL")
 		// }
 
-		// return nil
-
 	default:
 
-		return fmt.Errorf("invalid authtype '%s' configured", authType)
+		log.Log.Error("invalid authtype '%s' configured", authType)
+		errors++
 
 	}
+
+	if errors > 0 {
+		return fmt.Errorf("configuration invalid, errors: %v", errors)
+	}
+
+	return nil
 }

internal/output/output.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"os"
 	"path"
+	"path/filepath"
 
 	"github.com/gocarina/gocsv"
 )
@@ -40,7 +41,7 @@ func SaveJSONFile[T any](formattedResponse T, fileName string, folderPath string
 }
 
 func SaveCSVFile[T any](formattedResponse T, fileName string, folderPath string) error {
-	savePath := path.Join(folderPath, fileName)
+	savePath := filepath.Join(folderPath, fileName)
 
 	// Make sure the output dir exists first
 	err := os.MkdirAll(folderPath, os.ModePerm)

internal/search/search.go

@@ -6,10 +6,10 @@ import (
 	"os"
 	"path"
 
-	"github.com/fatih/color"
 	"github.com/mitchellh/mapstructure"
 	sailpoint "github.com/sailpoint-oss/golang-sdk/sdk-output"
 	sailpointsdk "github.com/sailpoint-oss/golang-sdk/sdk-output/v3"
+	"github.com/sailpoint-oss/sailpoint-cli/internal/log"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/output"
 )
 
@@ -62,7 +62,7 @@ func PerformSearch(apiClient sailpoint.APIClient, search sailpointsdk.Search) (S
 		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
 	}
 
-	color.Green("Search complete, saving results")
+	log.Log.Info("Search complete")
 
 	for i := 0; i < len(resp); i++ {
 		entry := resp[i]
@@ -123,42 +123,42 @@ func PerformSearch(apiClient sailpoint.APIClient, search sailpointsdk.Search) (S
 func IterateIndicies(SearchResults SearchResults, searchQuery string, folderPath string, outputTypes []string) error {
 	var err error
 	if len(SearchResults.AccountActivities) > 0 {
-		fileName := fmt.Sprintf("query=%s&indicie=%s", searchQuery, "AccountActivities")
+		fileName := "query=" + searchQuery + "&indicie=AccountActivities"
 		err = SaveResults(SearchResults.AccountActivities, fileName, folderPath, outputTypes)
 		if err != nil {
 			return err
 		}
 	}
 	if len(SearchResults.AccessProfiles) > 0 {
-		fileName := fmt.Sprintf("query=%s&indicie=%s", searchQuery, "AccessProfiles")
+		fileName := "query=" + searchQuery + "&indicie=AccessProfiles"
 		err = SaveResults(SearchResults.AccessProfiles, fileName, folderPath, outputTypes)
 		if err != nil {
 			return err
 		}
 	}
 	if len(SearchResults.Entitlements) > 0 {
-		fileName := fmt.Sprintf("query=%s&indicie=%s", searchQuery, "Entitlements")
+		fileName := "query=" + searchQuery + "&indicie=Entitlements"
 		err = SaveResults(SearchResults.Entitlements, fileName, folderPath, outputTypes)
 		if err != nil {
 			return err
 		}
 	}
 	if len(SearchResults.Events) > 0 {
-		fileName := fmt.Sprintf("query=%s&indicie=%s", searchQuery, "Events")
+		fileName := "query=" + searchQuery + "&indicie=Events"
 		err = SaveResults(SearchResults.Events, fileName, folderPath, outputTypes)
 		if err != nil {
 			return err
 		}
 	}
 	if len(SearchResults.Identities) > 0 {
-		fileName := fmt.Sprintf("query=%s&indicie=%s", searchQuery, "Identities")
+		fileName := "query=" + searchQuery + "&indicie=Identities"
 		err = SaveResults(SearchResults.Identities, fileName, folderPath, outputTypes)
 		if err != nil {
 			return err
 		}
 	}
 	if len(SearchResults.Roles) > 0 {
-		fileName := fmt.Sprintf("query=%s&indicie=%s", searchQuery, "Roles")
+		fileName := "query=" + searchQuery + "&indicie=Roles"
 		err = SaveResults(SearchResults.Roles, fileName, folderPath, outputTypes)
 		if err != nil {
 			return err
@@ -174,19 +174,19 @@ func SaveResults[T any](formattedResponse []T, fileName string, filePath string,
 		case "json":
 			fileName = fileName + ".json"
 			savePath := path.Join(filePath, fileName)
+			log.Log.Info("Saving Results", "file", savePath)
 			err := output.SaveJSONFile(formattedResponse, fileName, filePath)
 			if err != nil {
 				return err
 			}
-			color.Green("Saving file: %s", savePath)
 		case "csv":
 			fileName = fileName + ".csv"
 			savePath := path.Join(filePath, fileName)
+			log.Log.Info("Saving Results", "file", savePath)
 			err := output.SaveCSVFile(formattedResponse, fileName, filePath)
 			if err != nil {
 				return err
 			}
-			color.Green("Saving file: %s", savePath)
 		default:
 			return fmt.Errorf("invalid output type provided %s", outputType)
 		}

internal/spconfig/spconfig.go

@@ -3,11 +3,13 @@ package spconfig
 import (
 	"context"
 	"fmt"
+	"path"
 	"time"
 
 	"github.com/fatih/color"
 	sailpointbetasdk "github.com/sailpoint-oss/golang-sdk/sdk-output/beta"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/config"
+	"github.com/sailpoint-oss/sailpoint-cli/internal/log"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/output"
 )
 
@@ -33,11 +35,12 @@ func DownloadExport(jobId string, fileName string, folderPath string) error {
 		} else {
 			switch response.Status {
 			case "COMPLETE":
-				color.Green("Downloading Export Data")
+				log.Log.Info("Job Complete")
 				exportData, _, err := apiClient.Beta.SPConfigApi.ExportSpConfigDownload(context.TODO(), jobId).Execute()
 				if err != nil {
 					return err
 				}
+				log.Log.Info("Saving export data", "filePath", path.Join(folderPath, fileName))
 				err = output.SaveJSONFile(exportData, fileName, folderPath)
 				if err != nil {
 					return err

internal/templates/templates.go

@@ -2,13 +2,13 @@ package templates
 
 import (
 	"encoding/json"
-	"fmt"
 	"io"
 	"os"
 	"path/filepath"
 
 	"github.com/fatih/color"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/config"
+	"github.com/sailpoint-oss/sailpoint-cli/internal/log"
 	"github.com/sailpoint-oss/sailpoint-cli/internal/tui"
 )
 
@@ -33,7 +33,7 @@ func GetSearchTemplates() ([]SearchTemplate, error) {
 		file, err := os.OpenFile(templateFile, os.O_RDWR, 0777)
 		if err != nil {
 			if config.GetDebug() {
-				color.Yellow("error opening file %s", templateFile)
+				log.Log.Error("error opening file %s", templateFile)
 			}
 		} else {
 
@@ -44,7 +44,7 @@ func GetSearchTemplates() ([]SearchTemplate, error) {
 
 			err = json.Unmarshal(raw, &templates)
 			if err != nil {
-				color.Red("an error occured while parsing the file: %s", templateFile)
+				log.Log.Error("an error occured while parsing the file: %s", templateFile)
 				return nil, err
 			}
 
@@ -94,7 +94,7 @@ func GetExportTemplates() ([]ExportTemplate, error) {
 			file, err := os.OpenFile(templateFile, os.O_RDWR, 0777)
 			if err != nil {
 				if config.GetDebug() {
-					color.Yellow("error opening file %s", templateFile)
+					log.Log.Error("error opening file %s", templateFile)
 				}
 			} else {
 
@@ -105,7 +105,7 @@ func GetExportTemplates() ([]ExportTemplate, error) {
 
 				err = json.Unmarshal(raw, &templates)
 				if err != nil {
-					color.Red("an error occured while parsing the file: %s", templateFile)
+					log.Log.Error("an error occured while parsing the file: %s", templateFile)
 					return nil, err
 				}
 
@@ -115,7 +115,7 @@ func GetExportTemplates() ([]ExportTemplate, error) {
 
 		err = json.Unmarshal([]byte(builtInExportTemplates), &templates)
 		if err != nil {
-			color.Red("an error occured while parsing the built in templates")
+			log.Log.Error("an error occured while parsing the built in templates")
 			return nil, err
 		}
 
@@ -145,7 +145,7 @@ func SelectTemplate[T Template](templates []T) (string, error) {
 
 		var description string
 		if temp.GetVariableCount() > 0 {
-			description = fmt.Sprintf("%s - Accepts Input", temp.GetDescription())
+			description = temp.GetDescription() + " - Accepts Input"
 		} else {
 			description = temp.GetDescription()
 		}

internal/util/util.go

@@ -1 +1,14 @@
 package util
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+func PrettyPrint(v interface{}) {
+	b, err := json.MarshalIndent(v, "", "  ")
+	if err != nil {
+		fmt.Println("error:", err)
+	}
+	fmt.Print(string(b))
+}