feat: add output file parameter to buildpack integration test workflow (#108)

* feat: add output file parameter to buildpack integration test workflow

Plus some refactoring and additional error logging of the output file
when things fail.

* fix tests

Author: anniefu

.github/workflows/buildpack-integration-test.yml

@@ -39,6 +39,10 @@ on:
         type: number
         required: false
         default: 1
+      output-file:
+        description: The output file conformance test files should write to for verification; relative to the source code directory
+        type: string
+        required: false
       builder-tag:
         description: GCF builder image tag
         type: string
@@ -151,4 +155,5 @@ jobs:
           -builder-runtime=${{ inputs.builder-runtime }} \
           -builder-tag=${{ inputs.builder-tag }} \
           -start-delay=${{ inputs.start-delay }} \
+          -output-file=${{ inputs.output-file }} \
           -validate-mapping=false

client/buildpacks.go

@@ -35,20 +35,21 @@ const (
 )
 
 type buildpacksFunctionServer struct {
-	output     string
-	source     string
-	target     string
-	funcType   string
-	runtime    string
-	tag        string
-	ctID       string
-	logStdout  *os.File
-	logStderr  *os.File
-	stdoutFile string
-	stderrFile string
+	functionOutputFile string
+	source             string
+	target             string
+	funcType           string
+	runtime            string
+	tag                string
+	ctID               string
+	logStdout          *os.File
+	logStderr          *os.File
+	stdoutFile         string
+	stderrFile         string
 }
 
-func (b *buildpacksFunctionServer) Start(stdoutFile, stderrFile string) (func(), error) {
+func (b *buildpacksFunctionServer) Start(stdoutFile, stderrFile, functionOutputFile string) (func(), error) {
+	b.functionOutputFile = functionOutputFile
 	b.stdoutFile = stdoutFile
 	b.stderrFile = stderrFile
 	typ := *functionType
@@ -70,12 +71,12 @@ func (b *buildpacksFunctionServer) Start(stdoutFile, stderrFile string) (func(),
 }
 
 func (b *buildpacksFunctionServer) OutputFile() ([]byte, error) {
-	cmd := exec.Command("docker", "cp", fmt.Sprintf("%s:/workspace/%s", b.containerID(), b.output), ".")
+	cmd := exec.Command("docker", "cp", fmt.Sprintf("%s:/workspace/%s", b.containerID(), b.functionOutputFile), ".")
 	output, err := cmd.CombinedOutput()
 	if err != nil {
 		return nil, fmt.Errorf("failed to copy output file from the container: %v: %s", err, string(output))
 	}
-	return ioutil.ReadFile(b.output)
+	return ioutil.ReadFile(b.functionOutputFile)
 }
 
 func (b *buildpacksFunctionServer) build(ctx context.Context) error {

client/local.go

@@ -23,15 +23,16 @@ import (
 )
 
 type localFunctionServer struct {
-	output     string
-	cmd        string
-	stdoutFile string
-	stderrFile string
+	functionOutputFile string
+	cmd                string
+	stdoutFile         string
+	stderrFile         string
 }
 
-func (l *localFunctionServer) Start(stdoutFile, stderrFile string) (func(), error) {
+func (l *localFunctionServer) Start(stdoutFile, stderrFile, functionOutputFile string) (func(), error) {
 	l.stdoutFile = stdoutFile
 	l.stderrFile = stderrFile
+	l.functionOutputFile = functionOutputFile
 	args := strings.Fields(l.cmd)
 	cmd := newCmd(args)
 
@@ -69,5 +70,5 @@ func (l *localFunctionServer) Start(stdoutFile, stderrFile string) (func(), erro
 }
 
 func (l *localFunctionServer) OutputFile() ([]byte, error) {
-	return ioutil.ReadFile(l.output)
+	return ioutil.ReadFile(l.functionOutputFile)
 }

client/local_test.go

@@ -41,6 +41,7 @@ func TestStartAndShutdown(t *testing.T) {
 	if err := ioutil.WriteFile(f, []byte(testProgram), 0644); err != nil {
 		t.Fatalf("Failed to write file: %v", err)
 	}
+	outputFile := filepath.Join(dir, "function_output.json")
 
 	server := localFunctionServer{
 		// `go run` compiles the program and then execs it, which allows us to test that
@@ -49,7 +50,7 @@ func TestStartAndShutdown(t *testing.T) {
 		cmd: fmt.Sprintf("go run %s", f),
 	}
 
-	shutdown, err := server.Start(defaultStdoutFile, defaultStderrFile)
+	shutdown, err := server.Start(defaultStdoutFile, defaultStderrFile, outputFile)
 	if shutdown != nil {
 		defer shutdown()
 	}

client/start.go

@@ -33,7 +33,7 @@ var (
 )
 
 type functionServer interface {
-	Start(stdoutFile, stderrFile string) (func(), error)
+	Start(stdoutFile, stderrFile, functionOutputFile string) (func(), error)
 	OutputFile() ([]byte, error)
 }
 

client/validate.go

@@ -42,6 +42,7 @@ type validator struct {
 	validateMapping     bool
 	validateConcurrency bool
 	functionType        string
+	functionOutputFile  string
 	stdoutFile          string
 	stderrFile          string
 }
@@ -51,14 +52,14 @@ func newValidator(params validatorParams) *validator {
 		validateMapping:     params.validateMapping,
 		validateConcurrency: params.validateConcurrency,
 		functionType:        params.functionType,
+		functionOutputFile:  params.outputFile,
 		stdoutFile:          defaultStdoutFile,
 		stderrFile:          defaultStderrFile,
 	}
 
 	if !params.useBuildpacks {
 		v.funcServer = &localFunctionServer{
-			output: params.outputFile,
-			cmd:    params.runCmd,
+			cmd: params.runCmd,
 		}
 		return &v
 	}
@@ -68,7 +69,6 @@ func newValidator(params validatorParams) *validator {
 	}
 
 	v.funcServer = &buildpacksFunctionServer{
-		output:   params.outputFile,
 		source:   params.source,
 		target:   params.target,
 		runtime:  params.runtime,
@@ -81,7 +81,7 @@ func newValidator(params validatorParams) *validator {
 func (v validator) runValidation() error {
 	log.Printf("Validating for %s...", *functionType)
 
-	shutdown, err := v.funcServer.Start(v.stdoutFile, v.stderrFile)
+	shutdown, err := v.funcServer.Start(v.stdoutFile, v.stderrFile, v.functionOutputFile)
 	if shutdown != nil {
 		defer shutdown()
 	}
@@ -101,7 +101,7 @@ func (v validator) errorWithLogsf(errorFmt string, paramsFmts ...interface{}) er
 	if readErr != nil {
 		logs = readErr.Error()
 	}
-	return fmt.Errorf("%s, server logs: %s", fmt.Sprintf(errorFmt, paramsFmts...), logs)
+	return fmt.Errorf("%s\nServer logs: %s", fmt.Sprintf(errorFmt, paramsFmts...), logs)
 }
 
 func (v validator) readLogs() (string, error) {
@@ -120,9 +120,10 @@ func (v validator) readLogs() (string, error) {
 
 // The HTTP function should copy the contents of the request into the response.
 func (v validator) validateHTTP(url string) error {
-	want := map[string]string{
-		"res": "PASS",
+	type test struct {
+		Res string `json:"res"`
 	}
+	want := test{Res: "PASS"}
 
 	req, err := json.Marshal(want)
 	if err != nil {
@@ -138,13 +139,13 @@ func (v validator) validateHTTP(url string) error {
 		return fmt.Errorf("reading output file from HTTP function: %v", err)
 	}
 
-	got := make(map[string]string)
+	got := test{}
 	if err = json.Unmarshal(output, &got); err != nil {
-		return fmt.Errorf("failed to unmarshal json: %v", err)
+		return fmt.Errorf("failed to unmarshal function output JSON: %v, function output: %q", err, output)
 	}
 
 	if !cmp.Equal(got, want) {
-		return fmt.Errorf("unexpected HTTP output data: got %v, want %v", got, want)
+		return fmt.Errorf("unexpected HTTP output data (format does not matter), got: %s, want: %s", output, req)
 	}
 	return nil
 }