components-contrib/pubsub/jetstream/metadata_test.go

/*
Copyright 2021 The Dapr Authors
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.
*/

package jetstream

import (
	"reflect"
	"testing"
	"time"

	"github.com/nats-io/nats.go"

	mdata "github.com/dapr/components-contrib/metadata"
	"github.com/dapr/components-contrib/pubsub"
	"github.com/dapr/kit/ptr"
)

func TestParseMetadata(t *testing.T) {
	testCases := []struct {
		desc      string
		input     pubsub.Metadata
		want      metadata
		expectErr bool
	}{
		{
			desc: "Valid Metadata",
			input: pubsub.Metadata{Base: mdata.Base{
				Properties: map[string]string{
					"natsURL":        "nats://localhost:4222",
					"name":           "myName",
					"durableName":    "myDurable",
					"queueGroupName": "myQueue",
					"startSequence":  "1",
					"startTime":      "1629328511",
					"flowControl":    "true",
					"ackWait":        "2s",
					"maxDeliver":     "10",
					"backOff":        "500ms, 2s, 10s",
					"maxAckPending":  "5000",
					"replicas":       "3",
					"memoryStorage":  "true",
					"rateLimit":      "20000",
					"heartbeat":      "1s",
					"domain":         "hub",
				},
			}},
			want: metadata{
				NatsURL:               "nats://localhost:4222",
				Name:                  "myName",
				DurableName:           "myDurable",
				QueueGroupName:        "myQueue",
				StartSequence:         1,
				StartTime:             ptr.Of(uint64(1629328511)),
				internalStartTime:     time.Unix(1629328511, 0),
				FlowControl:           true,
				AckWait:               2 * time.Second,
				MaxDeliver:            10,
				BackOff:               []time.Duration{time.Millisecond * 500, time.Second * 2, time.Second * 10},
				MaxAckPending:         5000,
				Replicas:              3,
				MemoryStorage:         true,
				RateLimit:             20000,
				Heartbeat:             time.Second * 1,
				internalDeliverPolicy: nats.DeliverAllPolicy,
				internalAckPolicy:     nats.AckExplicitPolicy,
				Domain:                "hub",
				Concurrency:           pubsub.Single,
			},
			expectErr: false,
		},
		{
			desc: "Valid Metadata with token",
			input: pubsub.Metadata{Base: mdata.Base{
				Properties: map[string]string{
					"natsURL":         "nats://localhost:4222",
					"name":            "myName",
					"durableName":     "myDurable",
					"queueGroupName":  "myQueue",
					"startTime":       "1629328511",
					"flowControl":     "true",
					"ackWait":         "2s",
					"maxDeliver":      "10",
					"backOff":         "500ms, 2s, 10s",
					"maxAckPending":   "5000",
					"replicas":        "3",
					"memoryStorage":   "true",
					"rateLimit":       "20000",
					"heartbeat":       "1s",
					"token":           "myToken",
					"deliverPolicy":   "sequence",
					"startSequence":   "5",
					"ackPolicy":       "all",
					"apiPrefix":       "HUB",
					"concurrencyMode": "parallel",
				},
			}},
			want: metadata{
				NatsURL:               "nats://localhost:4222",
				Name:                  "myName",
				DurableName:           "myDurable",
				QueueGroupName:        "myQueue",
				StartSequence:         5,
				StartTime:             ptr.Of(uint64(1629328511)),
				internalStartTime:     time.Unix(1629328511, 0),
				FlowControl:           true,
				AckWait:               2 * time.Second,
				MaxDeliver:            10,
				BackOff:               []time.Duration{time.Millisecond * 500, time.Second * 2, time.Second * 10},
				MaxAckPending:         5000,
				Replicas:              3,
				MemoryStorage:         true,
				RateLimit:             20000,
				Heartbeat:             time.Second * 1,
				Token:                 "myToken",
				DeliverPolicy:         "sequence",
				AckPolicy:             "all",
				internalDeliverPolicy: nats.DeliverByStartSequencePolicy,
				internalAckPolicy:     nats.AckAllPolicy,
				APIPrefix:             "HUB",
				Concurrency:           pubsub.Parallel,
			},
			expectErr: false,
		},
		{
			desc: "Invalid metadata with missing seed key",
			input: pubsub.Metadata{Base: mdata.Base{
				Properties: map[string]string{
					"natsURL":        "nats://localhost:4222",
					"name":           "myName",
					"durableName":    "myDurable",
					"queueGroupName": "myQueue",
					"startSequence":  "1",
					"startTime":      "1629328511",
					"flowControl":    "true",
					"jwt":            "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
				},
			}},
			want:      metadata{},
			expectErr: true,
		},
		{
			desc: "Invalid metadata with missing jwt",
			input: pubsub.Metadata{Base: mdata.Base{
				Properties: map[string]string{
					"natsURL":        "nats://localhost:4222",
					"name":           "myName",
					"durableName":    "myDurable",
					"queueGroupName": "myQueue",
					"startSequence":  "1",
					"startTime":      "1629328511",
					"flowControl":    "true",
					"seedKey":        "SUACS34K232OKPRDOMKC6QEWXWUDJTT6R6RZM2WPMURUS5Z3POU7BNIL4Y",
				},
			}},
			want:      metadata{},
			expectErr: true,
		},
		{
			desc: "Invalid metadata with missing tls client key",
			input: pubsub.Metadata{Base: mdata.Base{
				Properties: map[string]string{
					"natsURL":         "nats://localhost:4222",
					"name":            "myName",
					"durableName":     "myDurable",
					"queueGroupName":  "myQueue",
					"startSequence":   "1",
					"startTime":       "1629328511",
					"flowControl":     "true",
					"tls_client_cert": "/path/to/tls.pem",
				},
			}},
			want:      metadata{},
			expectErr: true,
		},
		{
			desc: "Invalid metadata with missing tls client",
			input: pubsub.Metadata{Base: mdata.Base{
				Properties: map[string]string{
					"natsURL":        "nats://localhost:4222",
					"name":           "myName",
					"durableName":    "myDurable",
					"queueGroupName": "myQueue",
					"startSequence":  "1",
					"startTime":      "1629328511",
					"flowControl":    "true",
					"tls_client_key": "/path/to/tls.key",
				},
			}},
			want:      metadata{},
			expectErr: true,
		},
	}
	for _, tC := range testCases {
		t.Run(tC.desc, func(t *testing.T) {
			got, err := parseMetadata(tC.input)
			if !tC.expectErr && err != nil {
				t.Fatal(err)
			}
			if tC.expectErr && err == nil {
				t.Fatal(err)
			}
			if !reflect.DeepEqual(got, tC.want) {
				t.Fatalf("unexpected metadata: got=%v, want=%v", got, tC.want)
			}
		})
	}
}