FDK testkit

.gitignore

@@ -1,7 +1,6 @@
 .idea/
 *.sublime*
 *.swp
-functions
 iron.json
 dj.config.json
 dj.cluster.*.json
@@ -30,3 +29,4 @@ fnlb/fnlb
 /fn
 .DS_Store
 /fnserver
+fdk-test-kit.test

test.sh

@@ -47,7 +47,7 @@ export POSTGRES_URL="postgres://postgres:root@${POSTGRES_HOST}:${POSTGRES_PORT}/
 export MYSQL_URL="mysql://root:root@tcp(${MYSQL_HOST}:${MYSQL_PORT})/funcs"
 export MINIO_URL="s3://admin:password@${MINIO_HOST}:${MINIO_PORT}/us-east-1/fnlogs"
 
-go test -v $(go list ./... | grep -v vendor | grep -v examples | grep -v test/fn-api-tests)
+go test -v $(go list ./... | grep -v vendor | grep -v examples | grep -v test/fn-api-tests | grep -v test/fdk-test-kit)
 go vet -v $(go list ./... | grep -v vendor)
 docker rm --force func-postgres-test
 docker rm --force func-mysql-test

test/fn-api-tests/apps_api.go → test/apps_api.go

@@ -1,4 +1,4 @@
-package tests
+package test
 
 import (
 	"context"

test/fdk-test-kit/README.md

@@ -0,0 +1,77 @@
+Testing FDK-based functions
+===========================
+
+Function development kit (FDK) as a piece of software that helps to write hot functions by encapsulating logic of processing incoming requests with respect to defined protocol (HTTP, JSON).
+Particular testing framework help developers to identify if any programming language-specific FDK compatible with Fn hot formats.
+
+
+Prerequisites
+-------------
+
+This testing framework allows to run FDK tests against live Fn service, to let tests know of where Fn service is hosted please set following environment variable:
+```bash
+    export API_URL=http://fn.io:8080
+```
+
+As an alternative test suite capable to bootstrap its own copy of Fn service locally, for this particular case following environment variables must be set:
+```bash
+    export DOCKER_HOST=/var/run/docker.sock
+```
+or wherever Docker Remote API daemon listens.
+
+Test suite requires general purpose programming language-specific FDK-based function image that must be developed specifically for this test suite, following environment variable must be set:
+```bash
+    export FDK_FUNCTION_IMAGE="..."
+```
+This environment variable should contain a reference to the particular docker image.
+
+
+Test suite details
+------------------
+
+Test suite contains following tests:
+
+1. `TestFDKFormatSmallBody`
+
+`TestFDKFormatSmallBody` test
+--------------------------
+
+FDK should support following formats:
+
+ - HTTP (subtest: `test-fdk-http-small-body`)
+ - JSON (subtest: `test-fdk-json-small-body`)
+
+Request input body:
+```json
+{
+  "name": "John"
+}
+```
+
+Response output body:
+```text
+Hello John
+```
+
+How to run tests?
+-----------------
+
+There are couple options: from source code, from release binary
+
+From source code:
+```bash
+    go test -v ./...
+```
+
+How to build test binary executable?
+------------------------------------
+
+Regular `go build` does not work with tests, so following command will create a binary executable for this particular test suite:
+```bash
+    go test -c -i
+```
+
+Sample FDK-based functions
+--------------------------
+
+As an example test suite supplied with general purpose test [function written with FDK Python](./functions/python).

test/fdk-test-kit/formats_test.go

@@ -0,0 +1,104 @@
+package fdk_test_kit
+
+import (
+	"bytes"
+	"encoding/json"
+	"net/url"
+	"path"
+	"strconv"
+	"strings"
+	"testing"
+
+	"fmt"
+	fnTest "github.com/fnproject/fn/test"
+	"net/http"
+	"os"
+)
+
+type JSONResponse struct {
+	Message string `json:"message"`
+}
+
+func runAndAssert(t *testing.T, s *fnTest.SuiteSetup, fnRoute, fnImage,
+	fnFormat string, requestPayload interface{}, responsePayload interface{}) (*bytes.Buffer, *http.Response) {
+
+	fnTest.CreateApp(t, s.Context, s.Client, s.AppName, map[string]string{})
+	fnTest.CreateRoute(t, s.Context, s.Client, s.AppName, fnRoute, fnImage, "sync",
+		fnFormat, s.RouteConfig, s.RouteHeaders)
+
+	u := url.URL{
+		Scheme: "http",
+		Host:   fnTest.Host(),
+	}
+	u.Path = path.Join(u.Path, "r", s.AppName, fnRoute)
+
+	b, _ := json.Marshal(requestPayload)
+	content := bytes.NewBuffer(b)
+	output := &bytes.Buffer{}
+
+	response, err := fnTest.CallFN(u.String(), content, output, "POST", []string{})
+
+	if err != nil {
+		t.Errorf("Got unexpected error: %v", err)
+	}
+	json.Unmarshal(output.Bytes(), responsePayload)
+
+	fnTest.DeleteApp(t, s.Context, s.Client, s.AppName)
+
+	return output, response
+
+}
+
+func TestFDKFormatSmallBody(t *testing.T) {
+
+	FDKImage := os.Getenv("FDK_FUNCTION_IMAGE")
+	if FDKImage == "" {
+		t.Error("Please set FDK-based function image to test")
+	}
+	formats := []string{"http", "json"}
+
+	helloJohnPayload := &struct {
+		Name string `json:"name"`
+	}{
+		Name: "Jimmy",
+	}
+	helloJohnExpectedOutput := "Hello Jimmy"
+	for _, format := range formats {
+
+		// echo function:
+		// payload:
+		//    {
+		//        "name": "John"
+		//    }
+		// response:
+		//    "Hello John"
+		t.Run(fmt.Sprintf("test-fdk-%v-small-body", format), func(t *testing.T) {
+
+			t.Parallel()
+			s := fnTest.SetupDefaultSuite()
+			route := fmt.Sprintf("/test-fdk-%v-format-small-body", format)
+
+			responsePayload := &JSONResponse{}
+			output, response := runAndAssert(t, s, route, FDKImage, format, helloJohnPayload, responsePayload)
+
+			if !strings.Contains(helloJohnExpectedOutput, responsePayload.Message) {
+				t.Errorf("Output assertion error.\n\tExpected: %v\n\tActual: %v", helloJohnExpectedOutput, output.String())
+			}
+			if response.StatusCode != 200 {
+				t.Errorf("Status code assertion error.\n\tExpected: %v\n\tActual: %v", 200, response.StatusCode)
+			}
+
+			expectedHeaderNames := []string{"Content-Type", "Content-Length"}
+			expectedHeaderValues := []string{"text/plain; charset=utf-8", strconv.Itoa(output.Len())}
+			for i, name := range expectedHeaderNames {
+				actual := response.Header.Get(name)
+				expected := expectedHeaderValues[i]
+				if !strings.Contains(expected, actual) {
+					t.Errorf("HTTP header assertion error for %v."+
+						"\n\tExpected: %v\n\tActual: %v", name, expected, actual)
+				}
+			}
+
+		})
+	}
+}

test/fdk-test-kit/functions/python/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.6.2
+
+
+RUN mkdir /code
+ADD . /code/
+WORKDIR /code/
+RUN pip install -r requirements.txt
+WORKDIR /code/
+
+ENTRYPOINT ["python3", "func.py"]

test/fdk-test-kit/functions/python/func.py

@@ -0,0 +1,44 @@
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import fdk
+import ujson
+
+from fdk.http import request as http_request
+
+
+def handler(context, data=None, loop=None):
+
+    # specifically for http protocol
+    if isinstance(data, (http_request.ChunkedStream,
+                         http_request.ContentLengthStream)):
+        data = data.readall()
+
+    # specifically for json protocol
+    if isinstance(data, (bytes, str)):
+        if isinstance(data, bytes):
+            data = data.decode("utf-8")
+        try:
+            data = ujson.loads(data)
+        except Exception:
+            data = {}
+
+    name = data.get("name")
+    if not len(name):
+        name = "World"
+    return "Hello {}".format(name)
+
+
+if __name__ == "__main__":
+    fdk.handle(handler)

test/fdk-test-kit/functions/python/func.yaml

@@ -0,0 +1,6 @@
+name: fnproject/test-fdk-python
+version: 0.0.1
+runtime: python
+format: http
+timeout: 100
+path: /test-fdk-python

test/fdk-test-kit/functions/python/requirements.txt

@@ -0,0 +1 @@
+fdk==0.0.4

test/fdk-test-kit/init_test.go

@@ -0,0 +1,21 @@
+package fdk_test_kit
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	fnTest "github.com/fnproject/fn/test"
+)
+
+func TestMain(m *testing.M) {
+	// call flag.Parse() here if TestMain uses flags
+	s := fnTest.SetupDefaultSuite()
+	result := m.Run()
+	fnTest.Cleanup()
+	s.Cancel()
+	if result == 0 {
+		fmt.Fprintln(os.Stdout, "😀  👍  🎗")
+	}
+	os.Exit(result)
+}