Merge pull request #195 from Templum/develop

🔀 Preperations for next bugfix release

Author: Templum

.github/workflows/docker.yml

@@ -39,13 +39,13 @@ jobs:
         run: echo ${{ steps.buildx.outputs.platforms }}
 
       - name: Login to Docker Hub
-        uses: docker/login-action@v1.10.0
+        uses: docker/login-action@v1.12.0
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       - name: Login to GitHub Container Registry
-        uses: docker/login-action@v1.10.0
+        uses: docker/login-action@v1.12.0
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.17.3-alpine as base_builder
+FROM golang:1.17.5-alpine as base_builder
 
 RUN apk --no-cache add ca-certificates git
 
@@ -19,7 +19,7 @@ RUN VERSION=$(git describe --all --exact-match $(git rev-parse HEAD) | grep tags
   -X github.com/Templum/rabbitmq-connector/pkg/version.GitCommit=${GIT_COMMIT}" \
   -a -installsuffix cgo -o rmq-connector .
 
-FROM alpine:3.14.3
+FROM alpine:3.15.0
 
 RUN addgroup -S app \
   && adduser -S -g app app \

README.md

@@ -37,8 +37,8 @@ TLS Config:
 
 * `TLS_ENABLED`: Set this to `true` if your RabbitMQ requires a TLS connection. Default to `false` if not set.
 * `TLS_CA_CERT_PATH`: Path to your CA Cert, make sure golang process is allowed to access it.
-* `TLS_CLIENT_CERT_PATH`: Path to Client Cert, make sure golang process is allowed to access it.
-* `TLS_CLIENT_KEY_PATH`: Path to Client Key, make sure golang process is allowed to access it.
+* `TLS_SERVER_CERT_PATH`: Path to Client Cert, make sure golang process is allowed to access it.
+* `TLS_SERVER_KEY_PATH`: Path to Client Key, make sure golang process is allowed to access it.
 
 > Make sure if TLS is enabled, the provided `RMQ_HOST` matches the common name from the certificate. Otherwise the connection will yield a error
 
@@ -47,8 +47,8 @@ RabbitMQ Related:
 * `RMQ_HOST`: Hostname/ip of Rabbit MQ
 * `RMQ_PORT`: Port of Rabbit MQ
 * `RMQ_VHOST`: Used to specify the vhost for Rabbit MQ, will default to `/`
-* `RMQ_USER`: Defaults to `guest`
-* `RMQ_PASS`: Defaults to `pass`
+* `RMQ_USER`: Defaults to "", if user and pass are both "" than no credentials will be used for connecting
+* `RMQ_PASS`: Defaults to "", if user and pass are both "" than no credentials will be used for connecting
 * `PATH_TO_TOPOLOGY`: Path to the yaml describing the topology, has _no_ default and is *required*
 
 ### Topology Configuration

go.mod

@@ -5,10 +5,10 @@ require (
 	github.com/openfaas/connector-sdk v0.0.0-20201220114541-89f0ffcc5448
 	github.com/openfaas/faas-provider v0.18.6
 	github.com/pkg/errors v0.9.1
-	github.com/spf13/afero v1.6.0
+	github.com/spf13/afero v1.7.1
 	github.com/streadway/amqp v1.0.0
 	github.com/stretchr/testify v1.7.0
-	github.com/testcontainers/testcontainers-go v0.11.1
+	github.com/testcontainers/testcontainers-go v0.12.0
 	github.com/valyala/fasthttp v1.31.0
 	go.uber.org/automaxprocs v1.4.0
 	gopkg.in/yaml.v2 v2.4.0

go.sum

@@ -51,8 +51,7 @@ func NewConfig(fs afero.Fs) (*Controller, error) {
 	var tlsConfig *tls.Config = nil
 
 	if readFromEnv(envUseTLS, "false") == "true" {
-		rabbitURL, err = getRabbitMQConnectionURL(true)
-		sanitizedURL = getSanitizedRabbitMQURL(true)
+		rabbitURL, sanitizedURL, err = getRabbitMQConnectionURL(true)
 
 		if cfg, confErr := generateTlsConfig(fs); confErr == nil {
 			tlsConfig = cfg
@@ -61,8 +60,7 @@ func NewConfig(fs afero.Fs) (*Controller, error) {
 		}
 
 	} else {
-		rabbitURL, err = getRabbitMQConnectionURL(false)
-		sanitizedURL = getSanitizedRabbitMQURL(false)
+		rabbitURL, sanitizedURL, err = getRabbitMQConnectionURL(false)
 	}
 
 	if err != nil {
@@ -177,42 +175,35 @@ func generateTlsConfig(fs afero.Fs) (*tls.Config, error) {
 	return cfg, nil
 }
 
-func getRabbitMQConnectionURL(isTls bool) (string, error) {
-	user := readFromEnv(envRabbitUser, "user")
-	pass := readFromEnv(envRabbitPass, "pass")
+// getRabbitMQConnectionURL returns the fully build url and the sanitized version for usage in logging
+func getRabbitMQConnectionURL(isTls bool) (string, string, error) {
+	user := readFromEnv(envRabbitUser, "")
+	pass := readFromEnv(envRabbitPass, "")
 	host := readFromEnv(envRabbitHost, "localhost")
 	port := readFromEnv(envRabbitPort, "5672")
 	vhost := readFromEnv(envRabbitVHost, "")
+	protocol := "amqp"
+	if isTls {
+		protocol = "amqps"
+	}
 
 	parsedPort, err := strconv.Atoi(port)
 
 	if err != nil {
 		message := fmt.Sprintf("Provided port %s is not a valid port", port)
-		return "", errors.New(message)
+		return "", "", errors.New(message)
 	}
 
 	if parsedPort <= 0 || parsedPort > 65535 {
 		message := fmt.Sprintf("Provided port %s is outside of the allowed port range", port)
-		return "", errors.New(message)
-	}
-
-	if isTls {
-		return fmt.Sprintf("amqps://%s:%s/%s", host, port, vhost), nil
+		return "", "", errors.New(message)
 	}
 
-	return fmt.Sprintf("amqp://%s:%s@%s:%s/%s", user, pass, host, port, vhost), nil
-}
-
-func getSanitizedRabbitMQURL(isTls bool) string {
-	host := readFromEnv(envRabbitHost, "localhost")
-	port := readFromEnv(envRabbitPort, "5672")
-	vhost := readFromEnv(envRabbitVHost, "")
-
-	if isTls {
-		return fmt.Sprintf("amqps://%s:%s/%s", host, port, vhost)
+	if user == "" && pass == "" {
+		return fmt.Sprintf("%s://%s:%s/%s", protocol, host, port, vhost), fmt.Sprintf("%s://%s:%s/%s", protocol, host, port, vhost), nil
 	}
 
-	return fmt.Sprintf("amqp://%s:%s/%s", host, port, vhost)
+	return fmt.Sprintf("%s://%s:%s@%s:%s/%s", protocol, user, pass, host, port, vhost), fmt.Sprintf("%s://%s:%s/%s", protocol, host, port, vhost), nil
 }
 
 func getTopology(fs afero.Fs) (internal.Topology, error) {

pkg/config/config.go

@@ -244,7 +244,7 @@ data:
 		assert.Nil(t, err, "Should not throw")
 		assert.Nil(t, config.TLSConfig, "Should not have a TLS config")
 		assert.Equal(t, config.GatewayURL, "http://gateway:8080", "Expected default value")
-		assert.Equal(t, config.RabbitConnectionURL, "amqp://user:pass@localhost:5672/", "Expected default value")
+		assert.Equal(t, config.RabbitConnectionURL, "amqp://localhost:5672/", "Expected default value")
 		assert.NotContains(t, config.RabbitSanitizedURL, "user:pass", "Expected credentials not to be present")
 		assert.Equal(t, config.RabbitSanitizedURL, "amqp://localhost:5672/", "Expected default value")
 		assert.Equal(t, config.TopicRefreshTime, 30*time.Second, "Expected default value")

pkg/config/config_test.go

@@ -77,6 +77,7 @@ func (c *Client) InvokeSync(ctx context.Context, name string, invocation *intern
 		req.SetBody(nil)
 	}
 
+	req.Header.SetMethod(fasthttp.MethodPost)
 	req.Header.Set("Content-Type", invocation.ContentType)
 	req.Header.Set("Content-Encoding", invocation.ContentEncoding)
 	req.Header.SetUserAgent("OpenFaaS - Rabbit MQ Connector")
@@ -118,6 +119,7 @@ func (c *Client) InvokeAsync(ctx context.Context, name string, invocation *inter
 		req.SetBody(nil)
 	}
 
+	req.Header.SetMethod(fasthttp.MethodPost)
 	req.Header.Set("Content-Type", invocation.ContentType)
 	req.Header.Set("Content-Encoding", invocation.ContentEncoding)
 	req.Header.SetUserAgent("OpenFaaS - Rabbit MQ Connector")
@@ -154,6 +156,7 @@ func (c *Client) HasNamespaceSupport(ctx context.Context) (bool, error) {
 
 	req.SetRequestURI(getNamespaces)
 
+	req.Header.SetMethod(fasthttp.MethodGet)
 	req.Header.SetUserAgent("OpenFaaS - Rabbit MQ Connector")
 	if c.credentials != nil {
 		credentials := c.credentials.User + ":" + c.credentials.Password
@@ -190,6 +193,7 @@ func (c *Client) GetNamespaces(ctx context.Context) ([]string, error) {
 
 	req.SetRequestURI(getNamespaces)
 
+	req.Header.SetMethod(fasthttp.MethodGet)
 	req.Header.SetUserAgent("OpenFaaS - Rabbit MQ Connector")
 	if c.credentials != nil {
 		credentials := c.credentials.User + ":" + c.credentials.Password
@@ -226,6 +230,7 @@ func (c *Client) GetFunctions(ctx context.Context, namespace string) ([]types.Fu
 
 	req.SetRequestURI(getFunctions)
 
+	req.Header.SetMethod(fasthttp.MethodGet)
 	req.Header.SetUserAgent("OpenFaaS - Rabbit MQ Connector")
 	if c.credentials != nil {
 		credentials := c.credentials.User + ":" + c.credentials.Password

pkg/openfaas/client.go

@@ -43,6 +43,12 @@ func TestClient_InvokeSync(t *testing.T) {
 			return
 		}
 
+		if r.Method != fasthttp.MethodPost {
+			w.WriteHeader(400)
+			fmt.Fprint(w, "Method not supported")
+			return
+		}
+
 		switch r.URL.Path {
 		case "/function/exists":
 			w.WriteHeader(200)
@@ -127,6 +133,12 @@ func TestClient_InvokeAsync(t *testing.T) {
 			return
 		}
 
+		if r.Method != fasthttp.MethodPost {
+			w.WriteHeader(400)
+			fmt.Fprint(w, "Method not supported")
+			return
+		}
+
 		switch r.URL.Path {
 		case "/async-function/exists":
 			w.WriteHeader(202)
@@ -210,6 +222,12 @@ func TestClient_HasNamespaceSupport(t *testing.T) {
 			return
 		}
 
+		if r.Method != fasthttp.MethodGet {
+			w.WriteHeader(400)
+			fmt.Fprint(w, "Method not supported")
+			return
+		}
+
 		namespaces := []string{"one", "two"}
 		out, _ := json.Marshal(namespaces)
 
@@ -324,6 +342,12 @@ func TestClient_GetFunctions(t *testing.T) {
 			return
 		}
 
+		if r.Method != fasthttp.MethodGet {
+			w.WriteHeader(400)
+			fmt.Fprint(w, "Method not supported")
+			return
+		}
+
 		namespace := r.URL.Query().Get("namespace")
 		if len(namespace) > 0 {
 			if namespace == "special" {
@@ -410,6 +434,12 @@ func TestClient_GetNamespaces(t *testing.T) {
 			return
 		}
 
+		if r.Method != fasthttp.MethodGet {
+			w.WriteHeader(400)
+			fmt.Fprint(w, "Method not supported")
+			return
+		}
+
 		w.WriteHeader(200)
 		out, _ := json.Marshal(namespaces)
 		_, _ = w.Write(out)
@@ -450,3 +480,33 @@ func TestClient_GetNamespaces(t *testing.T) {
 		assert.Error(t, err, "OpenFaaS Credentials are invalid", "Did receive unexpected error")
 	})
 }
+
+func TestClient_Edge(t *testing.T) {
+	openfaasClient := NewClient(CreateClient(nil), nil, "ftp://localhost/")
+
+	payload := types2.OpenFaaSInvocation{
+		Topic:           "",
+		Message:         nil,
+		ContentEncoding: "gzip",
+		ContentType:     "text/plain",
+	}
+
+	t.Run("Should throw error if invalid base URL is provided", func(t *testing.T) {
+		var err error
+
+		_, err = openfaasClient.InvokeSync(context.Background(), "exists", &payload)
+		assert.Error(t, err, "unsupported protocol ftp. http and https are supported", "Did receive unexpected error")
+
+		_, err = openfaasClient.InvokeAsync(context.Background(), "exists", &payload)
+		assert.Error(t, err, "unsupported protocol ftp. http and https are supported", "Did receive unexpected error")
+
+		_, err = openfaasClient.GetNamespaces(context.Background())
+		assert.Error(t, err, "unsupported protocol ftp. http and https are supported", "Did receive unexpected error")
+
+		_, err = openfaasClient.GetFunctions(context.Background(), "")
+		assert.Error(t, err, "unsupported protocol ftp. http and https are supported", "Did receive unexpected error")
+
+		_, err = openfaasClient.HasNamespaceSupport(context.Background())
+		assert.Error(t, err, "unsupported protocol ftp. http and https are supported", "Did receive unexpected error")
+	})
+}