Add find and foreach sub commands for bulk operations #3027
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,9 @@ elastic-package | |
| # IDEA | ||
| .idea | ||
|
|
||
| # VSCode | ||
| .vscode | ||
|
|
||
| # Build directory | ||
| /build | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| // Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| // or more contributor license agreements. Licensed under the Elastic License; | ||
| // you may not use this file except in compliance with the Elastic License. | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| "github.com/elastic/elastic-package/internal/cobraext" | ||
| "github.com/elastic/elastic-package/internal/filter" | ||
| "github.com/elastic/elastic-package/internal/packages" | ||
| ) | ||
|
|
||
| const findLongDescription = `[Technical Preview] | ||
| This command gives you a list of all packages based on the given query. | ||
|
|
||
| The command will search for packages in the working directory for default depth of 2 and return the list of packages that match the given criteria. | ||
|
|
||
| Use --change-directory to change the working directory and --depth to change the depth of the search.` | ||
|
|
||
| const findExample = ` elastic-package find --inputs tcp,udp --categories security --depth 3 --output json | ||
| elastic-package find --packages 'cisco_*,fortinet_*' --output yaml` | ||
|
|
||
| func setupFindCommand() *cobraext.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "find [flags]", | ||
| Short: "Find integrations based on given flags [Technical Preview]", | ||
| Long: findLongDescription, | ||
| Args: cobra.NoArgs, | ||
| RunE: findCommandAction, | ||
| Example: findExample, | ||
| } | ||
|
|
||
| // add filter flags to the command (input, code owner, kibana version, categories) | ||
| filter.SetFilterFlags(cmd) | ||
|
|
||
| // add the output package name and absolute path flags to the command | ||
| cmd.Flags().StringP(cobraext.FilterOutputFlagName, cobraext.FilterOutputFlagShorthand, "", cobraext.FilterOutputFlagDescription) | ||
| cmd.Flags().StringP(cobraext.FilterOutputInfoFlagName, "", cobraext.FilterOutputInfoFlagDefault, cobraext.FilterOutputInfoFlagDescription) | ||
|
|
||
| return cobraext.NewCommand(cmd, cobraext.ContextPackage) | ||
| } | ||
|
|
||
| func findCommandAction(cmd *cobra.Command, args []string) error { | ||
| found, err := findPackage(cmd) | ||
| if err != nil { | ||
| return fmt.Errorf("finding packages failed: %w", err) | ||
| } | ||
|
|
||
| outputFormatStr, err := cmd.Flags().GetString(cobraext.FilterOutputFlagName) | ||
| if err != nil { | ||
| return fmt.Errorf("getting output format flag failed: %w", err) | ||
| } | ||
|
|
||
| outputInfoStr, err := cmd.Flags().GetString(cobraext.FilterOutputInfoFlagName) | ||
| if err != nil { | ||
| return fmt.Errorf("getting output info flag failed: %w", err) | ||
| } | ||
|
|
||
| outputOptions, err := filter.NewOutputOptions(outputInfoStr, outputFormatStr) | ||
| if err != nil { | ||
| return fmt.Errorf("creating output options failed: %w", err) | ||
| } | ||
|
|
||
| if err = printPkgList(found, outputOptions, os.Stdout); err != nil { | ||
| return fmt.Errorf("printing JSON failed: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func findPackage(cmd *cobra.Command) ([]packages.PackageDirNameAndManifest, error) { | ||
| depth, err := cmd.Flags().GetInt(cobraext.FilterDepthFlagName) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("getting depth flag failed: %w", err) | ||
| } | ||
|
|
||
| excludeDirs, err := cmd.Flags().GetString(cobraext.FilterExcludeDirFlagName) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("getting exclude-dir flag failed: %w", err) | ||
| } | ||
|
|
||
| filters := filter.NewFilterRegistry(depth, excludeDirs) | ||
|
|
||
| if err := filters.Parse(cmd); err != nil { | ||
| return nil, fmt.Errorf("parsing filter options failed: %w", err) | ||
| } | ||
|
|
||
| if err := filters.Validate(); err != nil { | ||
| return nil, fmt.Errorf("validating filter options failed: %w", err) | ||
| } | ||
|
|
||
| currDir, err := os.Getwd() | ||
| if err != nil { | ||
| return nil, fmt.Errorf("getting current directory failed: %w", err) | ||
| } | ||
| found, errors := filters.Execute(currDir) | ||
| if errors != nil { | ||
| return nil, fmt.Errorf("finding packages failed: %s", errors.Error()) | ||
| } | ||
|
|
||
| return found, nil | ||
| } | ||
|
|
||
| func printPkgList(pkgs []packages.PackageDirNameAndManifest, outputOptions *filter.OutputOptions, w io.Writer) error { | ||
| formatted, err := outputOptions.ApplyTo(pkgs) | ||
| if err != nil { | ||
| return fmt.Errorf("applying output format failed: %w", err) | ||
| } | ||
|
|
||
| // write the formatted packages to the writer | ||
| _, err = io.WriteString(w, formatted+"\n") | ||
| return err | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,96 @@ | ||||||||
| // Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||||||||
| // or more contributor license agreements. Licensed under the Elastic License; | ||||||||
| // you may not use this file except in compliance with the Elastic License. | ||||||||
|
|
||||||||
| package cmd | ||||||||
|
|
||||||||
| import ( | ||||||||
| "fmt" | ||||||||
| "slices" | ||||||||
| "strings" | ||||||||
|
|
||||||||
| "github.com/spf13/cobra" | ||||||||
|
|
||||||||
| "github.com/elastic/elastic-package/internal/cobraext" | ||||||||
| "github.com/elastic/elastic-package/internal/filter" | ||||||||
| "github.com/elastic/elastic-package/internal/logger" | ||||||||
| "github.com/elastic/elastic-package/internal/multierror" | ||||||||
| ) | ||||||||
|
|
||||||||
| const foreachLongDescription = `[Technical Preview] | ||||||||
| Execute a command for each package matching the given query flags. | ||||||||
|
|
||||||||
| This command combines query capabilities with command execution, allowing you to run any elastic-package subcommand across multiple packages in a single operation. | ||||||||
|
|
||||||||
| The command uses the same query flags as the 'find' command to select packages, then executes the specified subcommand for each matched package.` | ||||||||
|
|
||||||||
| // getAllowedSubCommands returns the list of allowed subcommands for the foreach command. | ||||||||
| func getAllowedSubCommands() []string { | ||||||||
| return []string{ | ||||||||
| "build", | ||||||||
| "check", | ||||||||
| "changelog", | ||||||||
| "clean", | ||||||||
| "format", | ||||||||
| "install", | ||||||||
| "lint", | ||||||||
| "test", | ||||||||
| "uninstall", | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| func setupForeachCommand() *cobraext.Command { | ||||||||
| cmd := &cobra.Command{ | ||||||||
| Use: "foreach [flags] -- <SUBCOMMAND>", | ||||||||
| Short: "Execute a command for filtered packages [Technical Preview]", | ||||||||
| Long: fmt.Sprintf(foreachLongDescription+"\n\nAllowed subcommands:\n%s", strings.Join(getAllowedSubCommands(), ", ")), | ||||||||
| Example: ` # Run system tests for packages with specific inputs | ||||||||
| elastic-package foreach --input tcp,udp -- test system -g`, | ||||||||
| RunE: foreachCommandAction, | ||||||||
| Args: cobra.MinimumNArgs(1), | ||||||||
| } | ||||||||
|
|
||||||||
| // Add query flags | ||||||||
| filter.SetFilterFlags(cmd) | ||||||||
|
|
||||||||
| return cobraext.NewCommand(cmd, cobraext.ContextPackage) | ||||||||
| } | ||||||||
|
|
||||||||
| func foreachCommandAction(cmd *cobra.Command, args []string) error { | ||||||||
| if err := validateSubCommand(args[0]); err != nil { | ||||||||
| return fmt.Errorf("validating sub command failed: %w", err) | ||||||||
| } | ||||||||
|
|
||||||||
| // reuse findPackage from cmd/find.go | ||||||||
| filtered, err := findPackage(cmd) | ||||||||
| if err != nil { | ||||||||
| return fmt.Errorf("filtering packages failed: %w", err) | ||||||||
| } | ||||||||
|
|
||||||||
| errors := multierror.Error{} | ||||||||
|
|
||||||||
| for _, pkg := range filtered { | ||||||||
| rootCmd := cmd.Root() | ||||||||
|
Member
There was a problem hiding this comment. We could define another root command with the specific commands that are supported and use it here, then we could have different sets of subcommands, and maybe we could even plug it directly as subcommands of foreach. This could be left for a future refactor too. Something like this: import (
"github.com/spf13/cobra"
"github.com/elastic/elastic-package/internal/cobraext"
)
var forEachCommands = []*cobraext.Command{
setupBuildCommand(),
setupCheckCommand(),
setupCleanCommand(),
setupFormatCommand(),
setupInstallCommand(),
setupLintCommand(),
setupTestCommand(),
setupUninstallCommand(),
}
// ForEachRootCmd creates and returns root cmd for elastic-package
func ForEachRootCmd() *cobra.Command {
forEachCmd := &cobra.Command{
SilenceUsage: true,
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
return cobraext.ComposeCommandActions(cmd, args,
processPersistentFlags,
checkVersionUpdate,
)
},
}
forEachCmd.PersistentFlags().CountP(cobraext.VerboseFlagName, cobraext.VerboseFlagShorthand, cobraext.VerboseFlagDescription)
forEachCmd.PersistentFlags().StringP(cobraext.ChangeDirectoryFlagName, cobraext.ChangeDirectoryFlagShorthand, "", cobraext.ChangeDirectoryFlagDescription)
for _, cmd := range forEachCommands {
forEachCmd.AddCommand(cmd.Command)
}
return forEachCmd
}That could be used here like this:
Suggested change
Author
There was a problem hiding this comment. This is something that we need to do to add parallel execution. That's why I left it out of this PR, and would like to revisit it while I work on the other PR. With that said, we do have a list of allowed sub-commands. Here Let me know if I missed any command. - I'll also add
Member
There was a problem hiding this comment. Yes, we can leave this for a future refactor.
Yes please. |
||||||||
| rootCmd.SetArgs(append(args, "--change-directory", pkg.Path)) | ||||||||
| if err := rootCmd.Execute(); err != nil { | ||||||||
| errors = append(errors, err) | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| logger.Infof("Successfully executed command for %d packages", len(filtered)-len(errors)) | ||||||||
|
|
||||||||
| if errors.Error() != "" { | ||||||||
| logger.Errorf("Errors occurred for %d packages", len(errors)) | ||||||||
| return fmt.Errorf("errors occurred while executing command for packages: \n%s", errors.Error()) | ||||||||
| } | ||||||||
|
|
||||||||
| return nil | ||||||||
| } | ||||||||
|
|
||||||||
| func validateSubCommand(subCommand string) error { | ||||||||
| if !slices.Contains(getAllowedSubCommands(), subCommand) { | ||||||||
| return fmt.Errorf("invalid subcommand: %s. Allowed subcommands are: [%s]", subCommand, strings.Join(getAllowedSubCommands(), ", ")) | ||||||||
| } | ||||||||
|
|
||||||||
| return nil | ||||||||
| } | ||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should list somewhere what commands are available for
foreach.