feat: Add a parameter to consume additional runtime variables for docker run (#113)

* Add a flag for function_concurrency and pass it down to docker run

* whitespaces

* Use a custom type for runtime env variables

* remove logging

* Fixing some errors

* addressing changes

* fixing an error

* fixing tabs

* address comments

* go fmt changes

Author: kappratiksha

client/buildpacks.go

@@ -47,6 +47,7 @@ type buildpacksFunctionServer struct {
 	logStderr          *os.File
 	stdoutFile         string
 	stderrFile         string
+	envs               []string
 }
 
 func (b *buildpacksFunctionServer) Start(stdoutFile, stderrFile, functionOutputFile string) (func(), error) {
@@ -125,16 +126,8 @@ func (b *buildpacksFunctionServer) run() (func(), error) {
 	if err != nil {
 		return nil, err
 	}
-
-	args := []string{"docker", "run",
-		"--network=host",
-		// TODO: figure out why these aren't getting set in the buildpack.
-		"--env=FUNCTION_TARGET=" + b.target,
-		"--env=FUNCTION_SIGNATURE_TYPE=" + b.funcType,
-		image,
-	}
+	var args = b.getDockerRunCommand()
 	cmd := exec.Command(args[0], args[1:]...)
-
 	err = cmd.Start()
 
 	// TODO: figure out why this isn't picking up errors.
@@ -161,6 +154,23 @@ func (b *buildpacksFunctionServer) run() (func(), error) {
 	}, nil
 }
 
+func (b *buildpacksFunctionServer) getDockerRunCommand() []string {
+	runtimeVars := []string{"docker",
+		"run",
+		"--network=host",
+		// TODO: figure out why these aren't getting set in the buildpack.
+		"--env=FUNCTION_TARGET=" + b.target,
+		"--env=FUNCTION_SIGNATURE_TYPE=" + b.funcType}
+
+	for _, s := range b.envs {
+		if s != "" {
+			runtimeVars = append(runtimeVars, fmt.Sprintf("--env=%s", s))
+		}
+	}
+
+	return append(runtimeVars, image)
+}
+
 func (b *buildpacksFunctionServer) containerID() string {
 	if b.ctID != "" {
 		return b.ctID

client/local.go

@@ -27,6 +27,7 @@ type localFunctionServer struct {
 	cmd                string
 	stdoutFile         string
 	stderrFile         string
+	envs               []string
 }
 
 func (l *localFunctionServer) Start(stdoutFile, stderrFile, functionOutputFile string) (func(), error) {
@@ -47,6 +48,12 @@ func (l *localFunctionServer) Start(stdoutFile, stderrFile, functionOutputFile s
 		return nil, err
 	}
 	cmd.Stderr = stderr
+	cmd.Env = os.Environ()
+	for _, s := range l.envs {
+		if s != "" {
+			cmd.Env = append(cmd.Env, s)
+		}
+	}
 	err = cmd.Start()
 	if err != nil {
 		return nil, err

client/main.go

@@ -18,20 +18,22 @@ package main
 import (
 	"flag"
 	"log"
+	"strings"
 )
 
 var (
-	runCmd              = flag.String("cmd", "", "string with command to run a Functions Framework server at localhost:8080. Ignored if -buildpacks=true.")
-	functionType        = flag.String("type", "http", "type of function to validate (must be 'http', 'cloudevent', or 'legacyevent'")
-	validateMapping     = flag.Bool("validate-mapping", true, "whether to validate mapping from legacy->cloud events and vice versa (as applicable)")
-	outputFile          = flag.String("output-file", "function_output.json", "name of file output by function")
-	useBuildpacks       = flag.Bool("buildpacks", true, "whether to use the current release of buildpacks to run the validation. If true, -cmd is ignored and --builder-* flags must be set.")
-	source              = flag.String("builder-source", "", "function source directory to use in building. Required if -buildpacks=true")
-	target              = flag.String("builder-target", "", "function target to use in building. Required if -buildpacks=true")
-	runtime             = flag.String("builder-runtime", "", "runtime to use in building. Required if -buildpacks=true")
-	tag                 = flag.String("builder-tag", "latest", "builder image tag to use in building")
-	startDelay          = flag.Uint("start-delay", 1, "Seconds to wait before sending HTTP request to command process")
+	runCmd                  = flag.String("cmd", "", "string with command to run a Functions Framework server at localhost:8080. Ignored if -buildpacks=true.")
+	functionType            = flag.String("type", "http", "type of function to validate (must be 'http', 'cloudevent', or 'legacyevent'")
+	validateMapping         = flag.Bool("validate-mapping", true, "whether to validate mapping from legacy->cloud events and vice versa (as applicable)")
+	outputFile              = flag.String("output-file", "function_output.json", "name of file output by function")
+	useBuildpacks           = flag.Bool("buildpacks", true, "whether to use the current release of buildpacks to run the validation. If true, -cmd is ignored and --builder-* flags must be set.")
+	source                  = flag.String("builder-source", "", "function source directory to use in building. Required if -buildpacks=true")
+	target                  = flag.String("builder-target", "", "function target to use in building. Required if -buildpacks=true")
+	runtime                 = flag.String("builder-runtime", "", "runtime to use in building. Required if -buildpacks=true")
+	tag                     = flag.String("builder-tag", "latest", "builder image tag to use in building")
+	startDelay              = flag.Uint("start-delay", 1, "Seconds to wait before sending HTTP request to command process")
 	validateConcurrencyFlag = flag.Bool("validate-concurrency", false, "whether to validate concurrent requests can be handled, requires a function that sleeps for 1 second ")
+	envs                    = flag.String("envs", "", "a comma separated string of additional runtime environment variables")
 )
 
 func main() {
@@ -54,6 +56,7 @@ func main() {
 		functionType:        *functionType,
 		tag:                 *tag,
 		validateConcurrency: *validateConcurrencyFlag,
+		envs:                strings.Split(*envs, ","),
 	})
 
 	if err := v.runValidation(); err != nil {

client/validate.go

@@ -35,6 +35,7 @@ type validatorParams struct {
 	tag                 string
 	functionType        string
 	validateConcurrency bool
+	envs                []string
 }
 
 type validator struct {
@@ -59,7 +60,8 @@ func newValidator(params validatorParams) *validator {
 
 	if !params.useBuildpacks {
 		v.funcServer = &localFunctionServer{
-			cmd: params.runCmd,
+			cmd:  params.runCmd,
+			envs: params.envs,
 		}
 		return &v
 	}
@@ -74,6 +76,7 @@ func newValidator(params validatorParams) *validator {
 		runtime:  params.runtime,
 		tag:      params.tag,
 		funcType: params.functionType,
+		envs:     params.envs,
 	}
 	return &v
 }