strict env format (#2641)

Author: pPrecel

docs/user/gen-docs/kyma_app_push.md

@@ -28,6 +28,7 @@ kyma app push [flags]
 
 ## Push an application and set environment variables:
 # This flag overrides existing environment variables with the same name from other sources (file, ConfigMap, Secret).
+# To set an environment variable, use the format 'NAME=VALUE' or 'name=<NAME>,value=<VALUE>'.
   kyma app push --name my-app --code-path . --env NAME1=VALUE --env NAME2=VALUE2
 
 ## Push an application and set environment variables from different sources:

internal/cmd/app/push.go

@@ -32,7 +32,7 @@ type appPushConfig struct {
 	packAppPath          string
 	containerPort        types.NullableInt64
 	istioInject          types.NullableBool
-	envs                 types.Map
+	envs                 types.EnvMap
 	fileEnvs             types.SourcedEnvArray
 	configmapEnvs        types.SourcedEnvArray
 	secretEnvs           types.SourcedEnvArray
@@ -45,7 +45,7 @@ type appPushConfig struct {
 func NewAppPushCMD(kymaConfig *cmdcommon.KymaConfig) *cobra.Command {
 	config := appPushConfig{
 		KymaConfig: kymaConfig,
-		envs:       types.Map{Values: map[string]interface{}{}},
+		envs:       types.EnvMap{Map: &types.Map{Values: map[string]interface{}{}}},
 	}
 
 	cmd := &cobra.Command{
@@ -67,6 +67,7 @@ func NewAppPushCMD(kymaConfig *cmdcommon.KymaConfig) *cobra.Command {
 
 ## Push an application and set environment variables:
 # This flag overrides existing environment variables with the same name from other sources (file, ConfigMap, Secret).
+# To set an environment variable, use the format 'NAME=VALUE' or 'name=<NAME>,value=<VALUE>'.
   kyma app push --name my-app --code-path . --env NAME1=VALUE --env NAME2=VALUE2
 
 ## Push an application and set environment variables from different sources:

internal/cmdcommon/envs/env.go

@@ -7,7 +7,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 )
 
-func Build(envs types.Map) []corev1.EnvVar {
+func Build(envs types.EnvMap) []corev1.EnvVar {
 	var result []corev1.EnvVar
 	for k, v := range envs.Values {
 		result = append(result, corev1.EnvVar{

internal/cmdcommon/types/env.go

@@ -0,0 +1,85 @@
+package types
+
+import (
+	"errors"
+	"fmt"
+	"strings"
+)
+
+var (
+	ErrInvalidEnvFormat = errors.New("invalid env format, should be in format 'name=<NAME>,value=<VALUE>' or <NAME>=<VALUE>")
+	ErrUnknownEnvField  = errors.New("unknown env field, supported fields are 'name' or 'value'")
+)
+
+type EnvMap struct {
+	*Map
+}
+
+// SetValue sets the value of the NullableString from a string
+func (e *EnvMap) SetValue(value *string) error {
+	if value == nil {
+		return nil
+	}
+
+	if e.Map == nil || e.Values == nil {
+		e.Map = &Map{Values: map[string]interface{}{}}
+	}
+
+	if *value == "" {
+		// input is empty, do nothing
+		return nil
+	}
+
+	fields := strings.SplitN(*value, ",", 2)
+	if len(fields) == 2 {
+		// input is in the format name=NAME,key=KEY
+		envName, envValue, err := parseStrictEnv(fields)
+		if err != nil {
+			return fmt.Errorf("failed to parse value '%s', %w", *value, err)
+		}
+		e.Values[envName] = envValue
+		return nil
+	}
+
+	// input is in the format NAME=VALUE
+	envElems := strings.Split(fields[0], "=")
+	if len(envElems) != 2 {
+		return fmt.Errorf("failed to parse value '%s': %w", *value, ErrInvalidEnvFormat)
+	}
+	e.Values[envElems[0]] = envElems[1]
+	return nil
+}
+
+// parseStrictEnv parses env in strict format (like 'name=<NAME>,path=<PATH>')
+// returns env name on first elem and its value on second elem
+func parseStrictEnv(fields []string) (string, string, error) {
+	envName := ""
+	envValue := ""
+	for _, v := range fields {
+		elems := strings.SplitN(v, "=", 2)
+		if len(elems) != 2 {
+			// invalid format, '=' not found
+			return "", "", ErrInvalidEnvFormat
+		}
+
+		switch elems[0] {
+		case "name":
+			envName = elems[1]
+		case "value":
+			envValue = elems[1]
+		default:
+			return "", "", ErrUnknownEnvField
+		}
+	}
+
+	return envName, envValue, nil
+}
+
+// Set implements the flag.Value interface
+func (e *EnvMap) Set(value string) error {
+	if value == "" {
+		return nil
+	}
+
+	return e.SetValue(&value)
+}

internal/cmdcommon/types/env_test.go

@@ -0,0 +1,55 @@
+package types_test
+
+import (
+	"testing"
+
+	"github.com/kyma-project/cli.v3/internal/cmdcommon/types"
+	"github.com/stretchr/testify/require"
+)
+
+func TestEnvMap_Set(t *testing.T) {
+	t.Run("should set env map value", func(t *testing.T) {
+		envMap := &types.EnvMap{}
+		err := envMap.Set("MY_ENV=my_value")
+		require.NoError(t, err)
+		err = envMap.Set("name=ANOTHER_ENV,value=another_value")
+		require.NoError(t, err)
+
+		require.Equal(t, map[string]interface{}{
+			"MY_ENV":      "my_value",
+			"ANOTHER_ENV": "another_value",
+		}, envMap.Values)
+	})
+
+	t.Run("should return error on invalid format", func(t *testing.T) {
+		envMap := &types.EnvMap{Map: &types.Map{Values: map[string]interface{}{}}}
+		err := envMap.Set("invalid_format")
+		require.ErrorIs(t, err, types.ErrInvalidEnvFormat)
+	})
+
+	t.Run("should return error on unknown field", func(t *testing.T) {
+		envMap := &types.EnvMap{Map: &types.Map{Values: map[string]interface{}{}}}
+		err := envMap.Set("name=MY_ENV,unknown_field=value")
+		require.ErrorIs(t, err, types.ErrUnknownEnvField)
+	})
+
+	t.Run("should return error on empty name", func(t *testing.T) {
+		envMap := &types.EnvMap{Map: &types.Map{Values: map[string]interface{}{}}}
+		err := envMap.Set("value=my_value,name")
+		require.ErrorIs(t, err, types.ErrInvalidEnvFormat)
+	})
+
+	t.Run("should ignore empty value", func(t *testing.T) {
+		envMap := &types.EnvMap{Map: &types.Map{Values: map[string]interface{}{}}}
+		err := envMap.Set("")
+		require.NoError(t, err)
+		require.Empty(t, envMap.Values)
+	})
+
+	t.Run("should ignore nil value", func(t *testing.T) {
+		envMap := &types.EnvMap{Map: &types.Map{Values: map[string]interface{}{}}}
+		err := envMap.SetValue(nil)
+		require.NoError(t, err)
+		require.Empty(t, envMap.Values)
+	})
+}

internal/cmdcommon/types/sourced/env.go

@@ -39,7 +39,9 @@ func (e *Env) String() string {
 
 func ParseEnv(value string) (Env, error) {
 	values := strings.Split(value, ",")
-	if len(values) > 1 || strings.HasPrefix(values[0], "path=") {
+	if len(values) > 1 ||
+		strings.HasPrefix(values[0], "resource=") ||
+		strings.HasPrefix(values[0], "path=") {
 		// strict format (like 'name=<NAME>,path=<PATH>')
 		return parseStrictEnv(values)
 	}