feat(decl): add test command support

cmd/declarative/config/config.go

@@ -0,0 +1,122 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright (C) 2024 The Falco Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package config
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/spf13/cobra"
+)
+
+const (
+	// DescriptionFileFlagName is the name of the flag allowing to specify the path of the file containing the YAML
+	// tests description.
+	DescriptionFileFlagName = "description-file"
+	// DescriptionFlagName is the name of the flag allowing to specify the YAML tests description.
+	DescriptionFlagName = "description"
+	// TestIDFlagName is the name of the flag allowing to specify the test identifier.
+	TestIDFlagName = "test-id"
+	// ProcLabelFlagName is the name of the flag allowing to specify a process label.
+	ProcLabelFlagName = "proc-label"
+	// TimeoutFlagName is the name of the flag allowing to specify the test timeout.
+	TimeoutFlagName = "timeout"
+)
+
+// Config represents the configuration shared among declarative commands. Among other shared settings, it also stores
+// the values of the shared flags.
+type Config struct {
+	EnvKeysPrefix     string
+	DeclarativeEnvKey string
+	// DescriptionFileEnvKey is the environment variable key corresponding to DescriptionFileFlagName.
+	DescriptionFileEnvKey string
+	// DescriptionEnvKey is the environment variable key corresponding to DescriptionFlagName.
+	DescriptionEnvKey string
+	// TestIDEnvKey is the environment variable key corresponding to TestIDFlagName.
+	TestIDEnvKey string
+	// ProcLabelEnvKey is the environment variable key corresponding to ProcLabelFlagName.
+	ProcLabelEnvKey string
+	// TimeoutEnvKey is the environment variable key corresponding to TimeoutFlagName.
+	TimeoutEnvKey string
+
+	// Flags
+	//
+	// TestsDescriptionFile is the path of the file containing the YAML tests description. If testsDescription is
+	// provided, this is empty.
+	TestsDescriptionFile string
+	// TestsDescription is the YAML tests description. If TestsDescriptionFile is provided, this is empty.
+	TestsDescription string
+	// TestID is the test identifier in the form [testIDIgnorePrefix]<testUID>. It is used to propagate the test UID to
+	// child processes in the process chain. The following invariants hold:
+	// - the root process has no test ID
+	// - the processes in the process chain but the last have the test ID in the form testIDIgnorePrefix<testUID>
+	// - the last process in the process chain has the test ID in the form <testUID>
+	// A process having a test ID in the form <testUID> (i.e.: the leaf process) is the only one that is monitored.
+	TestID string
+	//  ProcLabel is the process label in the form test<testIndex>.child<childIndex>. It is used for logging purposes
+	// and to potentially generate the child process label.
+	ProcLabel string
+	// TestsTimeout is the maximal duration of the tests. If running tests lasts more than TestsTimeout, the execution
+	// of all pending tasks is canceled.
+	TestsTimeout time.Duration
+}
+
+// New creates a new config linked to the provided command.
+func New(cmd *cobra.Command, declarativeEnvKey, envKeysPrefix string) *Config {
+	commonConf := &Config{
+		DeclarativeEnvKey:     declarativeEnvKey,
+		EnvKeysPrefix:         envKeysPrefix,
+		DescriptionFileEnvKey: envKeyFromFlagName(envKeysPrefix, DescriptionFileFlagName),
+		DescriptionEnvKey:     envKeyFromFlagName(envKeysPrefix, DescriptionFlagName),
+		TestIDEnvKey:          envKeyFromFlagName(envKeysPrefix, TestIDFlagName),
+		ProcLabelEnvKey:       envKeyFromFlagName(envKeysPrefix, ProcLabelFlagName),
+		TimeoutEnvKey:         envKeyFromFlagName(envKeysPrefix, TimeoutFlagName),
+	}
+	commonConf.initFlags(cmd)
+	return commonConf
+}
+
+// initFlags initializes the provided command's flags and uses the config instance to store the flag bound values.
+func (c *Config) initFlags(cmd *cobra.Command) {
+	flags := cmd.PersistentFlags()
+
+	flags.StringVarP(&c.TestsDescriptionFile, DescriptionFileFlagName, "f", "",
+		"The tests description YAML file specifying the tests to be run")
+	flags.StringVarP(&c.TestsDescription, DescriptionFlagName, "d", "",
+		"The YAML-formatted tests description string specifying the tests to be run")
+	cmd.MarkFlagsMutuallyExclusive(DescriptionFileFlagName, DescriptionFlagName)
+
+	flags.StringVar(&c.TestID, TestIDFlagName, "",
+		"(used during process chain building) The test identifier in the form <ignorePrefix><testUID>. It is "+
+			"used to propagate the test UID to child processes in the process chain")
+	flags.StringVar(&c.ProcLabel, ProcLabelFlagName, "",
+		"(used during process chain building) The process label in the form test<testIndex>,child<childIndex>. "+
+			"It is used for logging purposes and to potentially generate the child process label")
+	_ = flags.MarkHidden(TestIDFlagName)
+	_ = flags.MarkHidden(ProcLabelFlagName)
+
+	flags.DurationVarP(&c.TestsTimeout, TimeoutFlagName, "t", time.Minute,
+		"The maximal duration of the tests. If running tests lasts more than testsTimeout, the execution of "+
+			"all pending tasks is canceled")
+}
+
+// envKeyFromFlagName converts the provided flag name into the corresponding environment variable key.
+func envKeyFromFlagName(envKeysPrefix, flagName string) string {
+	s := fmt.Sprintf("%s_%s", envKeysPrefix, strings.ToUpper(flagName))
+	s = strings.ToUpper(s)
+	return strings.ReplaceAll(s, "-", "_")
+}

cmd/declarative/config/doc.go

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright (C) 2024 The Falco Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// 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

cmd/declarative/declarative.go

@@ -18,7 +18,9 @@ package declarative
 import (
 	"github.com/spf13/cobra"
 
+	"github.com/falcosecurity/event-generator/cmd/declarative/config"
 	"github.com/falcosecurity/event-generator/cmd/declarative/run"
+	"github.com/falcosecurity/event-generator/cmd/declarative/test"
 )
 
 // New creates a new declarative command.
@@ -30,7 +32,11 @@ func New(declarativeEnvKey, envKeysPrefix string) *cobra.Command {
 		DisableAutoGenTag: true,
 	}
 
-	c.AddCommand(run.New(declarativeEnvKey, envKeysPrefix).Command)
+	commonConf := config.New(c, declarativeEnvKey, envKeysPrefix)
 
+	runCmd := run.New(commonConf)
+	testCmd := test.New(commonConf, false).Command
+	c.AddCommand(runCmd)
+	c.AddCommand(testCmd)
 	return c
 }