Merge pull request #4744 from kersten/chore/wrap-errors-cli-external-plugins

🌱 (chore): improve error wrapping for external plugin discovery and config loading

Author: k8s-ci-robot

pkg/cli/cli.go

@@ -216,7 +216,7 @@ func (c *CLI) getInfoFromConfigFile() error {
 	// Read the project configuration file
 	cfg := yamlstore.New(c.fs)
 	if err := cfg.Load(); err != nil {
-		return err
+		return fmt.Errorf("error loading configuration: %w", err)
 	}
 
 	return c.getInfoFromConfig(cfg.Config())
@@ -260,12 +260,12 @@ func (c *CLI) getInfoFromFlags(hasConfigFile bool) error {
 
 	// Parse the arguments
 	if err := fs.Parse(os.Args[1:]); err != nil {
-		return err
+		return fmt.Errorf("could not parse flags: %w", err)
 	}
 
 	// If any plugin key was provided, replace those from the project configuration file
 	if pluginKeys, err := fs.GetStringSlice(pluginsFlag); err != nil {
-		return err
+		return fmt.Errorf("invalid flag %q: %w", pluginsFlag, err)
 	} else if len(pluginKeys) != 0 {
 		// Remove leading and trailing spaces and validate the plugin keys
 		for i, key := range pluginKeys {
@@ -468,7 +468,11 @@ func (c CLI) metadata() plugin.CLIMetadata {
 //
 // If an error is found, command help and examples will be printed.
 func (c CLI) Run() error {
-	return c.cmd.Execute()
+	if err := c.cmd.Execute(); err != nil {
+		return fmt.Errorf("error executing command: %w", err)
+	}
+
+	return nil
 }
 
 // Command returns the underlying root command.

pkg/cli/options.go

@@ -244,7 +244,7 @@ func DiscoverExternalPlugins(filesystem afero.Fs) (ps []plugin.Plugin, err error
 	pluginsRoot, err := retrievePluginsRoot(runtime.GOOS)
 	if err != nil {
 		logrus.Errorf("could not get plugins root: %v", err)
-		return nil, err
+		return nil, fmt.Errorf("could not get plugins root: %w", err)
 	}
 
 	rootInfo, err := filesystem.Stat(pluginsRoot)
@@ -253,7 +253,7 @@ func DiscoverExternalPlugins(filesystem afero.Fs) (ps []plugin.Plugin, err error
 			logrus.Debugf("External plugins dir %q does not exist, skipping external plugin parsing", pluginsRoot)
 			return nil, nil
 		}
-		return nil, err
+		return nil, fmt.Errorf("error getting stats for plugins %s: %w", pluginsRoot, err)
 	}
 	if !rootInfo.IsDir() {
 		logrus.Debugf("External plugins path %q is not a directory, skipping external plugin parsing", pluginsRoot)
@@ -262,7 +262,7 @@ func DiscoverExternalPlugins(filesystem afero.Fs) (ps []plugin.Plugin, err error
 
 	pluginInfos, err := afero.ReadDir(filesystem, pluginsRoot)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("error reading plugins directory %q: %w", pluginsRoot, err)
 	}
 
 	for _, pluginInfo := range pluginInfos {
@@ -273,7 +273,8 @@ func DiscoverExternalPlugins(filesystem afero.Fs) (ps []plugin.Plugin, err error
 
 		versions, err := afero.ReadDir(filesystem, filepath.Join(pluginsRoot, pluginInfo.Name()))
 		if err != nil {
-			return nil, err
+			return nil, fmt.Errorf("error reading plugin directory %s: %w",
+				filepath.Join(pluginsRoot, pluginInfo.Name()), err)
 		}
 
 		for _, version := range versions {
@@ -284,7 +285,8 @@ func DiscoverExternalPlugins(filesystem afero.Fs) (ps []plugin.Plugin, err error
 
 			pluginFiles, err := afero.ReadDir(filesystem, filepath.Join(pluginsRoot, pluginInfo.Name(), version.Name()))
 			if err != nil {
-				return nil, err
+				return nil, fmt.Errorf("error reading plugion version directory %q: %w",
+					filepath.Join(pluginsRoot, pluginInfo.Name(), version.Name()), err)
 			}
 
 			for _, pluginFile := range pluginFiles {
@@ -310,8 +312,8 @@ func DiscoverExternalPlugins(filesystem afero.Fs) (ps []plugin.Plugin, err error
 						Args:                      parseExternalPluginArgs(),
 					}
 
-					if err := ep.PVersion.Parse(version.Name()); err != nil {
-						return nil, err
+					if err = ep.PVersion.Parse(version.Name()); err != nil {
+						return nil, fmt.Errorf("error parsing external plugin version %q: %w", version.Name(), err)
 					}
 
 					logrus.Printf("Adding external plugin: %s", ep.Name())

pkg/cli/options_test.go

@@ -400,7 +400,7 @@ var _ = Describe("Discover external plugins", func() {
 				_, err = DiscoverExternalPlugins(filesystem.FS)
 				Expect(err).To(HaveOccurred())
 
-				Expect(err).To(Equal(errPluginsRoot))
+				Expect(errors.Unwrap(err)).To(MatchError(errPluginsRoot))
 			})
 
 			It("should skip parsing of directories if plugins root is not a directory", func() {