feat: use temp directory for client server logs (#85)

Testing the client locally typically means testing from the root of an
FF repo, so this prevents the FF repo from needing to .gitignore the
server logs files that are produced by the client.

Also, eliminate the cross-binary dependency of the GitHub Action and the
conformance test client on knowing the logs file name by having the
client itself print the server logs on error.

Author: anniefu

action/dist/index.js

@@ -3,19 +3,6 @@ import * as childProcess from 'child_process';
 import * as fs from 'fs';
 import * as process from 'process';
 
-/**
- * writeFileToConsole contents of file to console.
- * @param {string} path - filepath to write to the console
- */
-function writeFileToConsole(path: string) {
-  try {
-    const data = fs.readFileSync(path, 'utf8');
-    console.log(`${path}: ${data}`);
-  } catch (e) {
-    console.log(`$unable to read {path}, skipping: ${e}`);
-  }
-}
-
 /**
  * Run a specified command.
  * @param {string} cmd - command to run
@@ -25,9 +12,6 @@ function runCmd(cmd: string) {
     console.log(`RUNNING: "${cmd}"`)
     childProcess.execSync(cmd);
   } catch (error) {
-    writeFileToConsole('serverlog_stdout.txt');
-    writeFileToConsole('serverlog_stderr.txt');
-    writeFileToConsole('function_output.json');
     core.setFailed(error.message);
   }
 }
@@ -58,7 +42,7 @@ async function run() {
     runCmd(`git fetch origin refs/tags/${version} && git checkout ${version}`);
   } else {
     // Checkout latest release tag.
-    runCmd(`git fetch --tags && git checkout $(git describe --tags 'git rev-list --tags --max-count=1')`)
+    runCmd('git fetch --tags && git checkout $(git describe --tags $(git rev-list --tags --max-count=1))')
   }
   runCmd(`go build -o ~/client`);
 

action/dist/index.js.map

@@ -33,18 +33,22 @@ const (
 )
 
 type buildpacksFunctionServer struct {
-	output    string
-	source    string
-	target    string
-	funcType  string
-	runtime   string
-	tag       string
-	ctID      string
-	logStdout *os.File
-	logStderr *os.File
+	output     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() (func(), error) {
+func (b *buildpacksFunctionServer) Start(stdoutFile, stderrFile string) (func(), error) {
+	b.stdoutFile = stdoutFile
+	b.stderrFile = stderrFile
 	typ := *functionType
 	if typ == "legacyevent" {
 		typ = "event"
@@ -105,12 +109,12 @@ func (b *buildpacksFunctionServer) build(ctx context.Context) error {
 func (b *buildpacksFunctionServer) run() (func(), error) {
 	// Create logs output files.
 	var err error
-	b.logStdout, err = os.Create(stdoutFile)
+	b.logStdout, err = os.Create(b.stdoutFile)
 	if err != nil {
 		return nil, err
 	}
 
-	b.logStderr, err = os.Create(stderrFile)
+	b.logStderr, err = os.Create(b.stderrFile)
 	if err != nil {
 		return nil, err
 	}
@@ -146,7 +150,7 @@ func (b *buildpacksFunctionServer) run() (func(), error) {
 		if err := b.killContainer(); err != nil {
 			log.Fatalf("failed to kill container: %v", err)
 		}
-		log.Printf("Framework server shut down. Wrote logs to %v and %v.", stdoutFile, stderrFile)
+		log.Printf("Framework server shut down. Wrote logs to %v and %v.", b.stdoutFile, b.stderrFile)
 	}, nil
 }
 

action/src/index.ts

@@ -23,21 +23,25 @@ import (
 )
 
 type localFunctionServer struct {
-	output string
-	cmd    string
+	output     string
+	cmd        string
+	stdoutFile string
+	stderrFile string
 }
 
-func (l *localFunctionServer) Start() (func(), error) {
+func (l *localFunctionServer) Start(stdoutFile, stderrFile string) (func(), error) {
+	l.stdoutFile = stdoutFile
+	l.stderrFile = stderrFile
 	args := strings.Fields(l.cmd)
 	cmd := newCmd(args)
 
-	stdout, err := os.Create(stdoutFile)
+	stdout, err := os.Create(l.stdoutFile)
 	if err != nil {
 		return nil, err
 	}
 	cmd.Stdout = stdout
 
-	stderr, err := os.Create(stderrFile)
+	stderr, err := os.Create(l.stderrFile)
 	if err != nil {
 		return nil, err
 	}
@@ -59,7 +63,7 @@ func (l *localFunctionServer) Start() (func(), error) {
 			log.Fatalf("Failed to shut down framework server: %v", err)
 		}
 
-		log.Printf("Framework server shut down. Wrote logs to %v and %v.", stdoutFile, stderrFile)
+		log.Printf("Framework server shut down. Wrote logs to %v and %v.", l.stdoutFile, l.stderrFile)
 	}
 	return shutdown, nil
 }

client/buildpacks.go

@@ -49,7 +49,7 @@ func TestStartAndShutdown(t *testing.T) {
 		cmd: fmt.Sprintf("go run %s", f),
 	}
 
-	shutdown, err := server.Start()
+	shutdown, err := server.Start(defaultStdoutFile, defaultStderrFile)
 	if shutdown != nil {
 		defer shutdown()
 	}

client/local.go

@@ -57,4 +57,6 @@ func main() {
 	if err := v.runValidation(); err != nil {
 		log.Fatalf("%v", err)
 	}
+
+	log.Printf("All validation passed!")
 }

client/local_test.go

@@ -20,18 +20,20 @@ import (
 	"fmt"
 	"io/ioutil"
 	"net/http"
+	"os"
+	"path"
 
 	"github.com/GoogleCloudPlatform/functions-framework-conformance/events"
 	cloudevents "github.com/cloudevents/sdk-go/v2"
 )
 
-const (
-	stdoutFile = "serverlog_stdout.txt"
-	stderrFile = "serverlog_stderr.txt"
+var (
+	defaultStdoutFile = path.Join(os.TempDir(), "serverlog_stdout.txt")
+	defaultStderrFile = path.Join(os.TempDir(), "serverlog_stderr.txt")
 )
 
 type functionServer interface {
-	Start() (func(), error)
+	Start(stdoutFile, stderrFile string) (func(), error)
 	OutputFile() ([]byte, error)
 }
 

client/main.go

@@ -17,6 +17,7 @@ package main
 import (
 	"encoding/json"
 	"fmt"
+	"io/ioutil"
 	"log"
 
 	"github.com/GoogleCloudPlatform/functions-framework-conformance/events"
@@ -39,12 +40,16 @@ type validator struct {
 	funcServer      functionServer
 	validateMapping bool
 	functionType    string
+	stdoutFile      string
+	stderrFile      string
 }
 
 func newValidator(params validatorParams) *validator {
 	v := validator{
 		validateMapping: params.validateMapping,
 		functionType:    params.functionType,
+		stdoutFile:      defaultStdoutFile,
+		stderrFile:      defaultStderrFile,
 	}
 
 	if !params.useBuildpacks {
@@ -73,23 +78,43 @@ func newValidator(params validatorParams) *validator {
 func (v validator) runValidation() error {
 	log.Printf("Validating for %s...", *functionType)
 
-	shutdown, err := v.funcServer.Start()
+	shutdown, err := v.funcServer.Start(v.stdoutFile, v.stderrFile)
 	if shutdown != nil {
 		defer shutdown()
 	}
 
 	if err != nil {
-		return fmt.Errorf("unable to start server: %v", err)
+		return v.errorWithLogsf("unable to start server: %v", err)
 	}
 
 	if err := v.validate("http://localhost:8080"); err != nil {
-		return fmt.Errorf("Validation failure: %v", err)
+		return v.errorWithLogsf("validation failure: %v", err)
 	}
-
-	log.Printf("All validation passed!")
 	return nil
 }
 
+func (v validator) errorWithLogsf(errorFmt string, paramsFmts ...interface{}) error {
+	logs, readErr := v.readLogs()
+	if readErr != nil {
+		logs = readErr.Error()
+	}
+	return fmt.Errorf("%s, server logs: %s", fmt.Sprintf(errorFmt, paramsFmts...), logs)
+}
+
+func (v validator) readLogs() (string, error) {
+	stdout, err := ioutil.ReadFile(v.stdoutFile)
+	if err != nil {
+		return "", fmt.Errorf("could not read stdout file %q: %w", v.stdoutFile, err)
+	}
+
+	stderr, err := ioutil.ReadFile(v.stderrFile)
+	if err != nil {
+		return "", fmt.Errorf("could not read stderr file %q: %w", v.stdoutFile, err)
+	}
+
+	return fmt.Sprintf("\n[%s]: '%s'\n[%s]: '%s'", v.stdoutFile, stdout, v.stderrFile, stderr), nil
+}
+
 // The HTTP function should copy the contents of the request into the response.
 func (v validator) validateHTTP(url string) error {
 	want := map[string]string{
@@ -146,7 +171,7 @@ func (v validator) validateEvents(url string, inputType, outputType events.Event
 	}
 
 	logStr, err := events.PrintValidationInfos(vis)
-	log.Printf(logStr)
+	log.Println(logStr)
 	return err
 }
 
@@ -189,5 +214,5 @@ func (v validator) validate(url string) error {
 		log.Printf("Legacy event validation passed!")
 		return nil
 	}
-	return fmt.Errorf("Expected type to be one of 'http', 'cloudevent', or 'legacyevent', got %s", v.functionType)
+	return fmt.Errorf("expected type to be one of 'http', 'cloudevent', or 'legacyevent', got %s", v.functionType)
 }