Connector example

cmd/tester/.gitignore

@@ -1 +1,2 @@
 tester
+tester.exe

cmd/tester/Dockerfile

@@ -0,0 +1,29 @@
+FROM golang:1.10.4 as builder
+RUN mkdir -p /go/src/github.com/openfaas-incubator/connector-sdk
+WORKDIR /go/src/github.com/openfaas-incubator/connector-sdk
+
+COPY vendor     vendor
+COPY main.go    .
+
+# Run a gofmt and exclude all vendored code.
+RUN test -z "$(gofmt -l $(find . -type f -name '*.go' -not -path "./vendor/*"))"
+
+RUN go test -v ./...
+
+# Stripping via -ldflags "-s -w" 
+RUN CGO_ENABLED=0 GOOS=linux go build -a -ldflags "-s -w" -installsuffix cgo -o ./connector
+
+FROM alpine:3.8
+
+RUN addgroup -S app \
+    && adduser -S -g app app
+
+WORKDIR /home/app
+
+COPY --from=builder /go/src/github.com/openfaas-incubator/connector-sdk/    .
+
+RUN chown -R app:app ./
+
+USER app
+
+CMD ["./connector"]

cmd/tester/Dockerfile.armhf

@@ -0,0 +1,20 @@
+FROM golang:1.10.4 as builder
+RUN mkdir -p /go/src/github.com/openfaas-incubator/connector-sdk
+WORKDIR /go/src/github.com/openfaas-incubator/connector-sdk
+
+COPY vendor     vendor
+COPY main.go    .
+
+# Run a gofmt and exclude all vendored code.
+RUN test -z "$(gofmt -l $(find . -type f -name '*.go' -not -path "./vendor/*"))"
+
+RUN go test -v ./...
+
+# Stripping via -ldflags "-s -w" 
+RUN GOARM=7 CGO_ENABLED=0 GOOS=linux go build -a -ldflags "-s -w" -installsuffix cgo -o ./connector
+
+FROM alpine:3.8
+
+COPY --from=builder /go/src/github.com/openfaas-incubator/connector-sdk/    .
+
+CMD ["./connector"]

cmd/tester/Gopkg.toml

@@ -0,0 +1,34 @@
+# Gopkg.toml example
+#
+# Refer to https://golang.github.io/dep/docs/Gopkg.toml.html
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#   name = "github.com/x/y"
+#   version = "2.4.0"
+#
+# [prune]
+#   non-go = false
+#   go-tests = true
+#   unused-packages = true
+
+
+[[constraint]]
+  name = "github.com/openfaas-incubator/connector-sdk"
+  version = "0.3.1"
+
+[prune]
+  go-tests = true
+  unused-packages = true

cmd/tester/README.md

@@ -0,0 +1,18 @@
+# OpenFaas Sample Connector
+
+This folder contains a sample OpenFaas connector. You can use this as a base for creating your own connectors.
+For a more complex example checkout [kafka-connector](https://github.com/openfaas-incubator/kafka-connector)
+
+## How to Use
+
+1. Clone this repository: `git clone https://github.com/openfaas-incubator/connector-sdk.git`
+2. Go into the directory: `cd ./connector-sdk/cmd/tester/yaml`
+3. For OpenFaas deployed on Docker Swarm do: `docker stack deploy func -c ./docker-compose.yml`
+4. For OpenFaas deployed on kubernetes do: `kubectl create -f ./kubernetes --namespace openfaas`
+
+To check if it actually works and triggers a function, deploy any function with annotation `topic=faas-request`.
+You can also run this command to deploy a sample function and see `trigger-func` invocation count growing in ui.
+
+```bash
+faas-cli deploy --image=functions/nodeinfo --name=trigger-func --annotation topic=vm.powered.on
+```

cmd/tester/main.go

@@ -5,19 +5,19 @@
 package main
 
 import (
+	"errors"
 	"log"
+	"os"
 	"time"
 
 	"github.com/openfaas-incubator/connector-sdk/types"
 )
 
 func main() {
 	creds := types.GetCredentials()
-	config := &types.ControllerConfig{
-		RebuildInterval:   time.Millisecond * 1000,
-		GatewayURL:        "http://127.0.0.1:8080",
-		PrintResponse:     true,
-		PrintResponseBody: true,
+	config, err := getControllerConfig()
+	if err != nil {
+		panic(err)
 	}
 
 	controller := types.NewController(creds, config)
@@ -27,11 +27,16 @@ func main() {
 
 	controller.BeginMapBuilder()
 
+	topic, err := getTopic()
+	if err != nil {
+		panic(err)
+	}
+
 	// Simulate events emitting from queue/pub-sub
 	for {
 		time.Sleep(2 * time.Second)
 		data := []byte("test " + time.Now().String())
-		controller.Invoke("vm.powered.on", &data)
+		controller.Invoke(topic, &data)
 	}
 
 }
@@ -50,3 +55,26 @@ func (ResponseReceiver) Response(res types.InvokerResponse) {
 		log.Printf("tester got result: [%d] %s => %s (%d) bytes", res.Status, res.Topic, res.Function, len(*res.Body))
 	}
 }
+
+func getControllerConfig() (*types.ControllerConfig, error) {
+	gatewayURL, ok := os.LookupEnv("gateway_url")
+	if !ok {
+		return nil, errors.New("Gateway URL not set")
+	}
+
+	return &types.ControllerConfig{
+		RebuildInterval:   time.Millisecond * 1000,
+		GatewayURL:        gatewayURL,
+		PrintResponse:     true,
+		PrintResponseBody: true,
+	}, nil
+}
+
+func getTopic() (string, error) {
+	topic, ok := os.LookupEnv("topic")
+	if !ok {
+		return "", errors.New("topic not provided")
+	}
+
+	return topic, nil
+}