chore(cli): Adding support for Variable Sets

cli/cmd/middleware.go

@@ -1,11 +1,9 @@
 package cmd
 
 import (
-	"errors"
 	"fmt"
 	"os"
 
-	"github.com/kubeshop/tracetest/cli/pkg/resourcemanager"
 	"github.com/spf13/cobra"
 )
 
@@ -84,8 +82,8 @@ func (p *resourceParameters) Validate(cmd *cobra.Command, args []string) []error
 
 	p.ResourceName = args[0]
 
-	_, err := resources.Get(p.ResourceName)
-	if errors.Is(err, resourcemanager.ErrResourceNotFound) {
+	exists := resources.Exists(p.ResourceName)
+	if !exists {
 		suggestion := resources.Suggest(p.ResourceName)
 		if suggestion != "" {
 			return []error{

cli/cmd/resource_run_cmd.go

@@ -38,6 +38,10 @@ func init() {
 				variableSetClient,
 			)
 
+			if runParams.EnvID != "" {
+				runParams.VarsID = runParams.EnvID
+			}
+
 			runParams := runner.RunOptions{
 				ID:              runParams.ID,
 				DefinitionFile:  runParams.DefinitionFile,
@@ -67,6 +71,12 @@ func init() {
 	runCmd.Flags().BoolVarP(&runParams.SkipResultWait, "skip-result-wait", "W", false, "do not wait for results. exit immediately after test run started")
 	runCmd.Flags().StringVarP(&runParams.JUnitOuptutFile, "junit", "j", "", "file path to save test results in junit format")
 	runCmd.Flags().StringSliceVar(&runParams.RequriedGates, "required-gates", []string{}, "override default required gate. "+validRequiredGatesMsg())
+
+	//deprecated
+	runCmd.Flags().StringVarP(&runParams.EnvID, "env", "e", "", "environment file or ID to be used")
+	runCmd.Flags().MarkDeprecated("env", "use --vars instead")
+	runCmd.Flags().MarkShorthandDeprecated("e", "use --vars instead")
+
 	rootCmd.AddCommand(runCmd)
 }
 
@@ -83,6 +93,7 @@ type runParameters struct {
 	ID              string
 	DefinitionFile  string
 	VarsID          string
+	EnvID           string
 	SkipResultWait  bool
 	JUnitOuptutFile string
 	RequriedGates   []string

cli/cmd/resources.go

@@ -35,7 +35,8 @@ var (
 var (
 	httpClient = &resourcemanager.HTTPClient{}
 
-	variableSetClient = resourcemanager.NewClient(
+	variableSetPreprocessor = preprocessor.VariableSet(cliLogger)
+	variableSetClient       = resourcemanager.NewClient(
 		httpClient, cliLogger,
 		"variableset", "variablesets",
 		resourcemanager.WithTableConfig(resourcemanager.TableConfig{
@@ -46,6 +47,8 @@ var (
 			},
 		}),
 		resourcemanager.WithResourceType("VariableSet"),
+		resourcemanager.WithApplyPreProcessor(variableSetPreprocessor.Preprocess),
+		resourcemanager.WithDeprecatedAlias("Environment"),
 	)
 
 	testPreprocessor = preprocessor.Test(cliLogger)
@@ -121,6 +124,13 @@ var (
 		resourcemanager.WithApplyPreProcessor(transactionPreprocessor.Preprocess),
 	)
 
+	// deprecated resources
+	deprecatedEnvironmentClient = resourcemanager.NewClient(
+		httpClient, cliLogger,
+		"environment", "environments",
+		resourcemanager.WithProxyResource("variableset"),
+	)
+
 	resources = resourcemanager.NewRegistry().
 			Register(
 			resourcemanager.NewClient(
@@ -231,7 +241,10 @@ var (
 		).
 		Register(variableSetClient).
 		Register(transactionClient).
-		Register(testClient)
+		Register(testClient).
+
+		// deprecated resources
+		Register(deprecatedEnvironmentClient)
 )
 
 func resourceList() string {

cli/pkg/resourcemanager/apply.go

@@ -39,7 +39,7 @@ func (c Client) validType(inputFile fileutil.File) error {
 	}
 	c.logger.Debug("Parsed type", zap.String("type", t))
 
-	if t != c.resourceType() {
+	if t != c.resourceType() && t != c.options.deprecatedAlias {
 		return fmt.Errorf("cannot apply %s to %s resource", t, c.resourceType())
 	}
 

cli/pkg/resourcemanager/client.go

@@ -86,6 +86,7 @@ func (c Client) resourceType() string {
 	if c.options.resourceType != "" {
 		return c.options.resourceType
 	}
+
 	// language.Und means Undefined
 	caser := cases.Title(language.Und, cases.NoLower)
 	return caser.String(c.resourceName)

cli/pkg/resourcemanager/options.go

@@ -5,6 +5,8 @@ type options struct {
 	tableConfig       TableConfig
 	deleteSuccessMsg  string
 	resourceType      string
+	deprecatedAlias   string
+	proxyResource     string
 }
 
 type option func(*options)
@@ -32,3 +34,15 @@ func WithResourceType(resourceType string) option {
 		o.resourceType = resourceType
 	}
 }
+
+func WithDeprecatedAlias(resourceType string) option {
+	return func(o *options) {
+		o.deprecatedAlias = resourceType
+	}
+}
+
+func WithProxyResource(proxyResource string) option {
+	return func(o *options) {
+		o.proxyResource = proxyResource
+	}
+}

cli/pkg/resourcemanager/registry.go

@@ -2,6 +2,7 @@ package resourcemanager
 
 import (
 	"errors"
+	"fmt"
 	"sort"
 
 	"github.com/agnivade/levenshtein"
@@ -30,13 +31,33 @@ func (r *Registry) Get(resourceName string) (Client, error) {
 		return Client{}, ErrResourceNotFound
 	}
 
+	if c.options.proxyResource != "" {
+		c.logger.Warn(fmt.Sprintf("The resource `%s` is deprecated and will be removed in a future version. Please use `%s` instead.", c.resourceName, c.options.proxyResource))
+		return r.Get(c.options.proxyResource)
+	}
+
 	return c, nil
 }
 
+func (r *Registry) Exists(resourceName string) bool {
+	c, ok := r.resources[resourceName]
+	if !ok {
+		return false
+	}
+
+	if c.options.proxyResource != "" {
+		return r.Exists(c.options.proxyResource)
+	}
+
+	return true
+}
+
 func (r *Registry) List() []string {
 	var resources []string
-	for k := range r.resources {
-		resources = append(resources, k)
+	for k, c := range r.resources {
+		if c.options.proxyResource == "" {
+			resources = append(resources, k)
+		}
 	}
 
 	sort.Strings(resources)

cli/preprocessor/variableset.go

@@ -0,0 +1,45 @@
+package preprocessor
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/goccy/go-yaml"
+	"github.com/kubeshop/tracetest/cli/pkg/fileutil"
+	"go.uber.org/zap"
+)
+
+type variableSet struct {
+	logger *zap.Logger
+}
+
+type generic struct {
+	Type string      `yaml:"type"`
+	Spec interface{} `yaml:"spec"`
+}
+
+func VariableSet(logger *zap.Logger) variableSet {
+	return variableSet{
+		logger: logger,
+	}
+}
+
+func (vs variableSet) Preprocess(ctx context.Context, input fileutil.File) (fileutil.File, error) {
+	var resource generic
+	err := yaml.Unmarshal(input.Contents(), &resource)
+	if err != nil {
+		vs.logger.Error("error parsing test", zap.String("content", string(input.Contents())), zap.Error(err))
+		return input, fmt.Errorf("could not unmarshal test yaml: %w", err)
+	}
+
+	if resource.Type == "Environment" {
+		resource.Type = "VariableSet"
+	}
+
+	marshalled, err := yaml.Marshal(resource)
+	if err != nil {
+		return input, fmt.Errorf("could not marshal test yaml: %w", err)
+	}
+
+	return fileutil.New(input.AbsPath(), marshalled), nil
+}

testing/cli-e2etest/Makefile

@@ -3,6 +3,7 @@ TRACETEST_CLI?="${PROJECT_ROOT}/../../dist/tracetest"
 TEST_ENVIRONMENT?="jaeger"
 TAG?="dev"
 ENABLE_CLI_DEBUG?="false"
+TEST_SCENARIO?=test
 
 help: Makefile ## show list of commands
 	@echo "Choose a command run:"
@@ -17,6 +18,14 @@ test: # run tests for this application
 	go clean -testcache; \
 	go test -v -timeout 300s -p 1 ./...;
 
+test/scenario: # run tests for this application
+	export TRACETEST_CLI=$(TRACETEST_CLI); \
+	export TEST_ENVIRONMENT=$(TEST_ENVIRONMENT); \
+	export TAG=$(TAG); \
+	export ENABLE_CLI_DEBUG=$(ENABLE_CLI_DEBUG); \
+	go clean -testcache; \
+	go test -v -timeout 300s -p 1 "$(PROJECT_ROOT)/testscenarios/$(TEST_SCENARIO)";
+
 test/debug: # run tests for this application with debug mode enabled
 	export ENABLE_CLI_DEBUG="true"; \
 	make test;

testing/cli-e2etest/README.md

@@ -31,11 +31,11 @@ The main idea is to test every CLI command against the Tracetest server with dif
 | CLI Command                                                        | Test scenarios |
 | ------------------------------------------------------------------ | -------------- |
 | `run test -f [test-definition]`                                    | [RunTestWithGrpcTrigger](./testscenarios/test/run_test_with_grpc_trigger_test.go) |
-| `run test -f [test-definition] -e [environment-id]`                | [RunTestWithHttpTriggerAndEnvironmentFile](./testscenarios/test/run_test_with_http_trigger_and_environment_file_test.go) |
-| `run test -f [test-definition] -e [environment-definition]`        | [RunTestWithHttpTriggerAndEnvironmentFile](./testscenarios/test/run_test_with_http_trigger_and_environment_file_test.go) |
+| `run test -f [test-definition] --vars [variableset-id]`                | [RunTestWithHttpTriggerAndVariableSetFile](./testscenarios/test/run_test_with_http_trigger_and_variableset_file_test.go) |
+| `run test -f [test-definition] --vars [variableset-definition]`        | [RunTestWithHttpTriggerAndVariableSetFile](./testscenarios/test/run_test_with_http_trigger_and_variableset_file_test.go) |
 | `run transaction -f [transaction-definition]`                             | [RunTransaction](./testscenarios/transaction//run_transaction_test.go) |
-| `run transaction -f [transaction-definition] -e [environment-id]`         | |
-| `run transaction -f [transaction-definition] -e [environment-definition]` | |
+| `run transaction -f [transaction-definition] --vars [variableset-id]`         | |
+| `run transaction -f [transaction-definition] --vars [variableset-definition]` | |
 
 ### Resources: Config
 
@@ -81,23 +81,23 @@ The main idea is to test every CLI command against the Tracetest server with dif
 | `list demo --skip 1 --take 1`                        | [ListDemo](./testscenarios/demo/list_demos_test.go) |
 | `list demo --sortBy name --sortDirection asc`        | [ListDemo](./testscenarios/demo/list_demos_test.go) |
 
-### Resources: Environment
+### Resources: VariableSet
 
 | CLI Command                                                 | Test scenarios |
 | ----------------------------------------------------------- | -------------- |
-| `apply environment -f [new-environment-file]`               | [ApplyEnvironment](./testscenarios/environment/apply_environment_test.go) |
-| `apply environment -f [existing-environment-file]`          | [ApplyEnvironment](./testscenarios/environment/apply_environment_test.go) |
-| `delete environment --id [existing-id]`                     | [DeleteEnvironment](./testscenarios/environment/delete_environment_test.go) |
-| `delete environment --id [non-existing-id]`                 | [DeleteEnvironment](./testscenarios/environment/delete_environment_test.go) |
-| `get environment --id [non-existing-id]`                    | [GetEnvironment](./testscenarios/environment/get_environment_test.go), [DeleteEnvironment](./testscenarios/environment/delete_environment_test.go) |
-| `get environment --id [existing-id] --output pretty`        | [GetEnvironment](./testscenarios/environment/get_environment_test.go) |
-| `get environment --id [existing-id] --output json`          | [GetEnvironment](./testscenarios/environment/get_environment_test.go) |
-| `get environment --id [existing-id] --output yaml`          | [GetEnvironment](./testscenarios/environment/get_environment_test.go) |
-| `list environment --output pretty`                          | [ListEnvironment](./testscenarios/environment/list_environments_test.go) |
-| `list environment --output json`                            | [ListEnvironment](./testscenarios/environment/list_environments_test.go) |
-| `list environment --output yaml`                            | [ListEnvironment](./testscenarios/environment/list_environments_test.go) |
-| `list environment --skip 1 --take 2`                        | [ListEnvironment](./testscenarios/environment/list_environments_test.go) |
-| `list environment --sortBy name --sortDirection asc`        | [ListEnvironment](./testscenarios/environment/list_environments_test.go) |
+| `apply variableset -f [new-variableset-file]`               | [ApplyVariableSet](./testscenarios/variableset/apply_variableset_test.go) |
+| `apply variableset -f [existing-variableset-file]`          | [ApplyVariableSet](./testscenarios/variableset/apply_variableset_test.go) |
+| `delete variableset --id [existing-id]`                     | [DeleteVariableSet](./testscenarios/variableset/delete_variableset_test.go) |
+| `delete variableset --id [non-existing-id]`                 | [DeleteVariableSet](./testscenarios/variableset/delete_variableset_test.go) |
+| `get variableset --id [non-existing-id]`                    | [GetVariableSet](./testscenarios/variableset/get_variableset_test.go), [DeleteVariableSet](./testscenarios/variableset/delete_variableset_test.go) |
+| `get variableset --id [existing-id] --output pretty`        | [GetVariableSet](./testscenarios/variableset/get_variableset_test.go) |
+| `get variableset --id [existing-id] --output json`          | [GetVariableSet](./testscenarios/variableset/get_variableset_test.go) |
+| `get variableset --id [existing-id] --output yaml`          | [GetVariableSet](./testscenarios/variableset/get_variableset_test.go) |
+| `list variableset --output pretty`                          | [ListVariableSet](./testscenarios/variableset/list_variableset_test.go) |
+| `list variableset --output json`                            | [ListVariableSet](./testscenarios/variableset/list_variableset_test.go) |
+| `list variableset --output yaml`                            | [ListVariableSet](./testscenarios/variableset/list_variableset_test.go) |
+| `list variableset --skip 1 --take 2`                        | [ListVariableSet](./testscenarios/variableset/list_variableset_test.go) |
+| `list variableset --sortBy name --sortDirection asc`        | [ListVariableSet](./testscenarios/variableset/list_variableset_test.go) |
 
 ### Resources: PollingProfile
 

testing/cli-e2etest/testscenarios/test/resources/deprecated-environment.yaml

@@ -0,0 +1,9 @@
+type: Environment
+spec:
+  id: deprecated-pokeapi-env
+  name: deprecated-pokeapi-env
+  values:
+    - key: POKEMON_NAME
+      value: snorlax
+    - key: POKEMON_URL
+      value: https://assets.pokemon.com/assets/cms2/img/pokedex/full/143.png

testing/cli-e2etest/testscenarios/test/run_test_test.go

@@ -85,6 +85,33 @@ func TestRunTestWithHttpTriggerAndVariableSetFile(t *testing.T) {
 		require.Equal("https://assets.pokemon.com/assets/cms2/img/pokedex/full/143.png", environmentVars.Spec.Values[1].Value)
 	})
 
+	t.Run("should pass when using the deprecated environment definition file", func(t *testing.T) {
+		result := tracetestcli.Exec(t, "get environment --id deprecated-pokeapi-env", tracetestcli.WithCLIConfig(cliConfig))
+		helpers.RequireExitCodeEqual(t, result, 0)
+		require.Contains(result.StdOut, "The resource `environment` is deprecated and will be removed in a future version. Please use `variableset` instead.")
+		require.Contains(result.StdOut, "Resource variableset with ID deprecated-pokeapi-env not found")
+
+		// When I try to run a test with a http trigger and a variable set file
+		// Then it should pass
+		environmentFile := env.GetTestResourcePath(t, "deprecated-environment")
+		testFile := env.GetTestResourcePath(t, "http-trigger-with-environment-file")
+
+		command := fmt.Sprintf("run test -f %s --env %s", testFile, environmentFile)
+		result = tracetestcli.Exec(t, command, tracetestcli.WithCLIConfig(cliConfig))
+		helpers.RequireExitCodeEqual(t, result, 0)
+		require.Contains(result.StdOut, "✔ It should add a Pokemon correctly")
+		require.Contains(result.StdOut, "✔ It should save the correct data")
+
+		// When I try to get the variable set created on the previous step
+		// Then it should retrieve it correctly
+		result = tracetestcli.Exec(t, "get environment --id deprecated-pokeapi-env", tracetestcli.WithCLIConfig(cliConfig))
+		helpers.RequireExitCodeEqual(t, result, 0)
+
+		require.Contains(result.StdOut, "The resource `environment` is deprecated and will be removed in a future version. Please use `variableset` instead.")
+		require.Contains(result.StdOut, "VariableSet")
+		require.Contains(result.StdOut, "https://assets.pokemon.com/assets/cms2/img/pokedex/full/143.png")
+	})
+
 	t.Run("should pass when using variable set id", func(t *testing.T) {
 		// Given I am a Tracetest CLI user
 		// And I have my server recently created