feat: user can set envvars

Author: matejvasek

cmd/create.go

@@ -60,7 +60,7 @@ project configuration file faas.yaml.
 }
 
 func runCreate(cmd *cobra.Command, args []string) (err error) {
-	config := newCreateConfig(args).Prompt()
+	config := newCreateConfig(cmd, args).Prompt()
 
 	function := faas.Function{
 		Name:    config.initConfig.Name,
@@ -114,10 +114,11 @@ type createConfig struct {
 	// Note that ambiguous references set to assume .initConfig
 }
 
-func newCreateConfig(args []string) createConfig {
+func newCreateConfig(cmd *cobra.Command, args []string) createConfig {
+
 	return createConfig{
 		initConfig:   newInitConfig(args),
-		deployConfig: newDeployConfig(),
+		deployConfig: newDeployConfig(cmd),
 	}
 }
 

cmd/deploy.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"fmt"
-
 	"github.com/ory/viper"
 	"github.com/spf13/cobra"
 
@@ -17,6 +16,7 @@ import (
 func init() {
 	root.AddCommand(deployCmd)
 	deployCmd.Flags().BoolP("confirm", "c", false, "Prompt to confirm all configuration options - $FAAS_CONFIRM")
+	deployCmd.Flags().StringArrayP("env", "e", []string{}, "Sets environment variables for the Function.")
 	deployCmd.Flags().StringP("image", "i", "", "Optional full image name, in form [registry]/[namespace]/[name]:[tag] for example quay.io/myrepo/project.name:latest (overrides --registry) - $FAAS_IMAGE")
 	deployCmd.Flags().StringP("namespace", "n", "", "Override namespace into which the Function is deployed (on supported platforms).  Default is to use currently active underlying platform setting - $FAAS_NAMESPACE")
 	deployCmd.Flags().StringP("path", "p", cwd(), "Path to the function project directory - $FAAS_PATH")
@@ -52,13 +52,15 @@ or -n flag, and if so this will overwrite the value in the faas.yaml file.
 
 func runDeploy(cmd *cobra.Command, _ []string) (err error) {
 
-	config := newDeployConfig().Prompt()
+	config := newDeployConfig(cmd).Prompt()
 
 	function, err := functionWithOverrides(config.Path, functionOverrides{Namespace: config.Namespace, Image: config.Image})
 	if err != nil {
 		return
 	}
 
+	function.EnvVars = mergeEnvVarsMaps(function.EnvVars, config.EnvVars)
+
 	// Check if the Function has been initialized
 	if !function.Initialized() {
 		return fmt.Errorf("the given path '%v' does not contain an initialized Function. Please create one at this path before deploying.", config.Path)
@@ -138,17 +140,20 @@ type deployConfig struct {
 	// Confirm: confirm values arrived upon from environment plus flags plus defaults,
 	// with interactive prompting (only applicable when attached to a TTY).
 	Confirm bool
+
+	EnvVars map[string]string
 }
 
 // newDeployConfig creates a buildConfig populated from command flags and
 // environment variables; in that precedence.
-func newDeployConfig() deployConfig {
+func newDeployConfig(cmd *cobra.Command) deployConfig {
 	return deployConfig{
 		buildConfig: newBuildConfig(),
 		Namespace:   viper.GetString("namespace"),
 		Path:        viper.GetString("path"),
 		Verbose:     viper.GetBool("verbose"), // defined on root
 		Confirm:     viper.GetBool("confirm"),
+		EnvVars:     envVarsFromCmd(cmd),
 	}
 }
 

cmd/root.go

@@ -235,3 +235,43 @@ func deriveImage(explicitImage, defaultRegistry, path string) string {
 	derivedValue, _ := faas.DerivedImage(path, defaultRegistry)
 	return derivedValue // Use the faas system's derivation logic.
 }
+
+func envVarsFromCmd(cmd *cobra.Command) map[string]string {
+	envVarsM := make(map[string]string)
+	if cmd.Flags().Changed("env") {
+		envVarsA, err := cmd.Flags().GetStringArray("env")
+		if err == nil {
+			for _, s := range envVarsA {
+				kvp := strings.Split(s, "=")
+				if len(kvp) == 2 && kvp[0] != "" {
+					envVarsM[kvp[0]] = kvp[1]
+				} else if len(kvp) == 1 && kvp[0] != "" {
+					envVarsM[kvp[0]] = ""
+				}
+			}
+		}
+	}
+	return envVarsM
+}
+
+func mergeEnvVarsMaps(dest, src map[string]string) map[string]string {
+	result := make(map[string]string, len(dest) +len(src))
+
+	for name, value := range dest {
+		if strings.HasSuffix(name, "-") {
+			if _, ok := src[strings.TrimSuffix(name, "-")]; !ok {
+				result[name] = value
+			}
+		} else {
+			if _, ok := src[name+"-"]; !ok {
+				result[name] = value
+			}
+		}
+	}
+
+	for name, value := range src {
+		result[name] = value
+	}
+
+	return result
+}

cmd/run.go

@@ -13,6 +13,7 @@ import (
 func init() {
 	// Add the run command as a subcommand of root.
 	root.AddCommand(runCmd)
+	runCmd.Flags().StringArrayP("env", "e", []string{}, "Sets environment variables for the Function.")
 	runCmd.Flags().StringP("path", "p", cwd(), "Path to the Function project directory - $FAAS_PATH")
 }
 
@@ -31,13 +32,20 @@ already have been built as an OCI container image using the 'build' command.
 }
 
 func runRun(cmd *cobra.Command, args []string) (err error) {
-	config := newRunConfig()
+	config := newRunConfig(cmd)
 
 	function, err := faas.NewFunction(config.Path)
 	if err != nil {
 		return
 	}
 
+	function.EnvVars = mergeEnvVarsMaps(function.EnvVars, config.EnvVars)
+
+	err = function.WriteConfig()
+	if err != nil {
+		return 
+	}
+
 	// Check if the Function has been initialized
 	if !function.Initialized() {
 		return fmt.Errorf("the given path '%v' does not contain an initialized Function.", config.Path)
@@ -60,11 +68,14 @@ type runConfig struct {
 
 	// Verbose logging.
 	Verbose bool
+
+	EnvVars map[string]string
 }
 
-func newRunConfig() runConfig {
+func newRunConfig(cmd *cobra.Command) runConfig {
 	return runConfig{
 		Path:    viper.GetString("path"),
 		Verbose: viper.GetBool("verbose"), // defined on root
+		EnvVars: envVarsFromCmd(cmd),
 	}
 }

config.go

@@ -21,6 +21,7 @@ type config struct {
 	Trigger    string            `yaml:"trigger"`
 	Builder    string            `yaml:"builder"`
 	BuilderMap map[string]string `yaml:"builderMap"`
+	EnvVars    map[string]string `yaml:"envVars"`
 	// Add new values to the toConfig/fromConfig functions.
 }
 
@@ -57,6 +58,7 @@ func fromConfig(c config) (f Function) {
 		Trigger:    c.Trigger,
 		Builder:    c.Builder,
 		BuilderMap: c.BuilderMap,
+		EnvVars:    c.EnvVars,
 	}
 }
 
@@ -70,6 +72,7 @@ func toConfig(f Function) config {
 		Trigger:    f.Trigger,
 		Builder:    f.Builder,
 		BuilderMap: f.BuilderMap,
+		EnvVars:    f.EnvVars,
 	}
 }
 

docker/runner.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"os"
 	"os/exec"
+	"strings"
 
 	"github.com/boson-project/faas"
 )
@@ -36,9 +37,15 @@ func (n *Runner) Run(f faas.Function) error {
 	// Extra arguments to docker
 	args := []string{"run", "--rm", "-t", "-p=8080:8080"}
 
+	for name, value := range f.EnvVars {
+		if !strings.HasSuffix(name,"-") {
+			args = append(args, fmt.Sprintf("-e%s=%s", name, value))
+		}
+	}
+
 	// If verbosity is enabled, pass along as an environment variable to the Function.
 	if n.Verbose {
-		args = append(args, []string{"-e VERBOSE=true"}...)
+		args = append(args, "-e VERBOSE=true")
 	}
 	args = append(args, f.Image)
 

function.go

@@ -48,6 +48,8 @@ type Function struct {
 	// Map containing known builders.
 	// e.g. { "jvm": "docker.io/example/quarkus-jvm-builder" }
 	BuilderMap map[string]string
+
+	EnvVars map[string]string
 }
 
 // NewFunction loads a Function from a path on disk. use .Initialized() to determine if

knative/deployer.go

@@ -3,12 +3,13 @@ package knative
 import (
 	"bytes"
 	"fmt"
-	"sort"
+	"strings"
 	"time"
 
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	servinglib "knative.dev/client/pkg/serving"
 	"knative.dev/client/pkg/wait"
 	servingv1 "knative.dev/serving/pkg/apis/serving/v1"
 	v1 "knative.dev/serving/pkg/apis/serving/v1"
@@ -97,7 +98,7 @@ func (d *Deployer) Deploy(f faas.Function) (err error) {
 		}
 	} else {
 		// Update the existing Service
-		err = client.UpdateServiceWithRetry(encodedName, updateBuiltTimeStampEnvVar, 3)
+		err = client.UpdateServiceWithRetry(encodedName, updateEnvVars(f.EnvVars), 3)
 		if err != nil {
 			if !d.Verbose {
 				err = fmt.Errorf("deployer failed to update the service: %v.\nStdOut: %s", err, output.(*bytes.Buffer).String())
@@ -142,34 +143,25 @@ func generateNewService(name, image string) *servingv1.Service {
 	}
 }
 
-func updateBuiltTimeStampEnvVar(service *servingv1.Service) (*servingv1.Service, error) {
-	envs := service.Spec.Template.Spec.Containers[0].Env
+func updateEnvVars(envVars map[string]string) func(service *servingv1.Service) (*servingv1.Service, error) {
+	return func(service *servingv1.Service) (*servingv1.Service, error) {
+		builtEnvVarName := "BUILT"
+		builtEnvVarValue := time.Now().Format("20060102T150405")
 
-	builtEnvVarName := "BUILT"
+		toUpdate := make(map[string]string, len(envVars)+1)
+		toRemove := make([]string, 0)
 
-	builtEnvVar := findEnvVar(builtEnvVarName, envs)
-	if builtEnvVar == nil {
-		envs = append(envs, corev1.EnvVar{Name: "VERBOSE", Value: "true"})
-		builtEnvVar = &envs[len(envs)-1]
-	}
-
-	builtEnvVar.Value = time.Now().Format("20060102T150405")
-
-	sort.SliceStable(envs, func(i, j int) bool {
-		return envs[i].Name <= envs[j].Name
-	})
-	service.Spec.Template.Spec.Containers[0].Env = envs
+		for name, value := range envVars {
+			if strings.HasSuffix(name, "-") {
+				toRemove = append(toRemove, strings.TrimSuffix(name, "-"))
+			} else {
+				toUpdate[name] = value
+			}
+		}
 
-	return service, nil
-}
+		toUpdate[builtEnvVarName] = builtEnvVarValue
 
-func findEnvVar(name string, envs []corev1.EnvVar) *corev1.EnvVar {
-	var result *corev1.EnvVar = nil
-	for i, envVar := range envs {
-		if envVar.Name == name {
-			result = &envs[i]
-			break
-		}
+		return service, servinglib.UpdateEnvVars(&service.Spec.Template, toUpdate, toRemove)
 	}
-	return result
+
 }