feat(decl): rename declarative commands namespace to suite

cmd/root.go

@@ -31,7 +31,7 @@ import (
 	// Initialize all k8s client auth plugins.
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 
-	"github.com/falcosecurity/event-generator/cmd/declarative"
+	"github.com/falcosecurity/event-generator/cmd/suite"
 	// register event collections.
 	_ "github.com/falcosecurity/event-generator/events/k8saudit"
 	_ "github.com/falcosecurity/event-generator/events/syscall"
@@ -49,9 +49,9 @@ func init() {
 const (
 	// envKeysPrefix is used as environment variable prefix configuration for viper.
 	envKeysPrefix = "falco_event_generator"
-	// declarativeEnvKey is used to distinguish between command-line invocation of the "declarative run" subcommand and
-	// the subcommand invoking itself during process chain creation.
-	declarativeEnvKey = "DECLARATIVE"
+	// suiteEnvKey is used to distinguish between command-line invocation of the "suite run" subcommand and the
+	// subcommand invoking itself during process chain creation.
+	suiteEnvKey = "SUITE"
 )
 
 // New instantiates the root command.
@@ -108,7 +108,7 @@ func New(configOptions *ConfigOptions) *cobra.Command {
 	rootCmd.AddCommand(NewBench())
 	rootCmd.AddCommand(NewTest())
 	rootCmd.AddCommand(NewList())
-	rootCmd.AddCommand(declarative.New(declarativeEnvKey, envKeysPrefix))
+	rootCmd.AddCommand(suite.New(suiteEnvKey, envKeysPrefix))
 
 	return rootCmd
 }
@@ -117,9 +117,9 @@ func New(configOptions *ConfigOptions) *cobra.Command {
 func Execute() {
 	ctx := WithSignals(context.Background())
 	rootCmd := New(nil)
-	// declarativeEnvKey is not mapped on viper and cobra on purpose.
-	if v := os.Getenv(declarativeEnvKey); v != "" {
-		rootCmd.SetArgs([]string{"declarative", "run"})
+	// suiteEnvKey is not mapped on viper and cobra on purpose.
+	if v := os.Getenv(suiteEnvKey); v != "" {
+		rootCmd.SetArgs([]string{"suite", "run"})
 	}
 
 	if err := rootCmd.ExecuteContext(ctx); err != nil {

cmd/declarative/config/config.go → cmd/suite/config/config.go

@@ -43,11 +43,11 @@ const (
 	TimeoutFlagName = "timeout"
 )
 
-// Config represents the configuration shared among declarative commands. Among other shared settings, it also stores
-// the values of the shared flags.
+// Config represents the configuration shared among `suite` commands. Among other shared settings, it also stores the
+// values of the shared flags.
 type Config struct {
-	EnvKeysPrefix     string
-	DeclarativeEnvKey string
+	EnvKeysPrefix string
+	SuiteEnvKey   string
 	// DescriptionFileEnvKey is the environment variable key corresponding to DescriptionFileFlagName.
 	DescriptionFileEnvKey string
 	// DescriptionDirEnvKey is the environment variable key corresponding to DescriptionDirFlagName.
@@ -103,9 +103,9 @@ var containerImagePullPolicies = map[builder.ImagePullPolicy][]string{
 }
 
 // New creates a new config.
-func New(declarativeEnvKey, envKeysPrefix string) *Config {
+func New(suiteEnvKey, envKeysPrefix string) *Config {
 	commonConf := &Config{
-		DeclarativeEnvKey:     declarativeEnvKey,
+		SuiteEnvKey:           suiteEnvKey,
 		EnvKeysPrefix:         envKeysPrefix,
 		DescriptionFileEnvKey: envKeyFromFlagName(envKeysPrefix, DescriptionFileFlagName),
 		DescriptionDirEnvKey:  envKeyFromFlagName(envKeysPrefix, DescriptionDirFlagName),

cmd/declarative/config/doc.go → cmd/suite/config/doc.go

@@ -13,6 +13,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package config provides the implementation of Config, the configuration shared among declarative commands. Among
-// other shared settings, it also stores the values of the shared flags.
+// Package config provides the implementation of Config, the configuration shared among suite commands. Among other
+// shared settings, it also stores the values of the shared flags.
 package config

cmd/declarative/doc.go → cmd/suite/doc.go

@@ -13,5 +13,5 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package declarative provides the implementation of the "declarative" command.
-package declarative
+// Package suite provides the implementation of the "suite" command.
+package suite

cmd/declarative/explain/explain.go → cmd/suite/explain/explain.go

@@ -41,9 +41,9 @@ documentation for properties enabled only by the presence of that value.
 Enum requirements are evaluated in their appearing order, so order matters.
 The following examples demonstrate how to specify property path expressions:
 
-event-generator declarative explain tests.context.processes
+event-generator suite explain tests.context.processes
 
-event-generator declarative explain tests.steps{type=syscall}{syscall=openat2}.args.how
+event-generator suite explain tests.steps{type=syscall}{syscall=openat2}.args.how
 
 Enum requirements can be provided also by using the --with flag (see --with flag documentation for the syntax). It is
 not possible to specify enum requirements both with <propertyPathExpr> and the --with flag.`

cmd/declarative/run/run.go → cmd/suite/run/run.go

@@ -20,8 +20,8 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/falcosecurity/event-generator/cmd/declarative/config"
-	"github.com/falcosecurity/event-generator/cmd/declarative/test"
+	"github.com/falcosecurity/event-generator/cmd/suite/config"
+	"github.com/falcosecurity/event-generator/cmd/suite/test"
 )
 
 const (

cmd/declarative/declarative.go → cmd/suite/suite.go

@@ -13,27 +13,27 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package declarative
+package suite
 
 import (
 	"github.com/spf13/cobra"
 
-	"github.com/falcosecurity/event-generator/cmd/declarative/config"
-	"github.com/falcosecurity/event-generator/cmd/declarative/explain"
-	"github.com/falcosecurity/event-generator/cmd/declarative/run"
-	"github.com/falcosecurity/event-generator/cmd/declarative/test"
+	"github.com/falcosecurity/event-generator/cmd/suite/config"
+	"github.com/falcosecurity/event-generator/cmd/suite/explain"
+	"github.com/falcosecurity/event-generator/cmd/suite/run"
+	"github.com/falcosecurity/event-generator/cmd/suite/test"
 )
 
-// New creates a new declarative command.
-func New(declarativeEnvKey, envKeysPrefix string) *cobra.Command {
+// New creates a new suite command.
+func New(suiteEnvKey, envKeysPrefix string) *cobra.Command {
 	c := &cobra.Command{
-		Use:               "declarative",
-		Short:             "Run test(s) specified via a YAML description",
-		Long:              "Run test(s) specified via a YAML description",
+		Use:               "suite",
+		Short:             "Manage everything related to test suites",
+		Long:              "Manage everything related to test suites",
 		DisableAutoGenTag: true,
 	}
 
-	commonConf := config.New(declarativeEnvKey, envKeysPrefix)
+	commonConf := config.New(suiteEnvKey, envKeysPrefix)
 
 	runCmd := run.New(commonConf)
 	testCmd := test.New(commonConf, false).Command

cmd/declarative/test/test.go → cmd/suite/test/test.go

@@ -31,7 +31,7 @@ import (
 	"github.com/spf13/pflag"
 	"github.com/thediveo/enumflag"
 
-	"github.com/falcosecurity/event-generator/cmd/declarative/config"
+	"github.com/falcosecurity/event-generator/cmd/suite/config"
 	"github.com/falcosecurity/event-generator/pkg/alert/retriever/grpcretriever"
 	"github.com/falcosecurity/event-generator/pkg/baggage"
 	containerbuilder "github.com/falcosecurity/event-generator/pkg/container/builder"
@@ -585,7 +585,7 @@ func sendTestReport(ctx context.Context, reportCh chan<- *tester.Report, report
 func (cw *CommandWrapper) buildRunnerEnviron(cmd *cobra.Command) []string {
 	environ := os.Environ()
 	environ = cw.appendFlags(environ, cmd.PersistentFlags(), cmd.Flags())
-	environ = append(environ, fmt.Sprintf("%s=1", cw.DeclarativeEnvKey))
+	environ = append(environ, fmt.Sprintf("%s=1", cw.SuiteEnvKey))
 	return environ
 }