Mainflux.mainflux/mqtt/handler_test.go

397 lines
9.1 KiB
Go

package mqtt_test
import (
"bytes"
"fmt"
"log"
"testing"
"github.com/mainflux/mainflux/logger"
"github.com/mainflux/mainflux/mqtt"
"github.com/mainflux/mainflux/mqtt/mocks"
"github.com/mainflux/mainflux/pkg/errors"
"github.com/mainflux/mainflux/pkg/messaging"
"github.com/mainflux/mproxy/pkg/session"
"github.com/stretchr/testify/assert"
)
const (
thingID = "513d02d2-16c1-4f23-98be-9e12f8fee898"
chanID = "123e4567-e89b-12d3-a456-000000000001"
invalidID = "invalidID"
clientID = "clientID"
password = "password"
subtopic = "testSubtopic"
invalidChannelIDTopic = "channels/**/messages"
)
var (
topicMsg = "channels/%s/messages"
topic = fmt.Sprintf(topicMsg, chanID)
invalidTopic = "invalidTopic"
payload = []byte("[{'n':'test-name', 'v': 1.2}]")
topics = []string{topic}
invalidTopics = []string{invalidTopic}
invalidChanIDTopics = []string{fmt.Sprintf(topicMsg, invalidTopic)}
//Test log messages for cases the handler does not provide a return value.
logBuffer = bytes.Buffer{}
sessionClient = session.Client{
ID: clientID,
Username: thingID,
Password: []byte(password),
}
invalidThingSessionClient = session.Client{
ID: clientID,
Username: invalidID,
Password: []byte(password),
}
)
func TestAuthConnect(t *testing.T) {
handler := newHandler()
cases := []struct {
desc string
err error
session *session.Client
}{
{
desc: "connect without active session",
err: mqtt.ErrClientNotInitialized,
session: nil,
},
{
desc: "connect without clientID",
err: mqtt.ErrMissingClientID,
session: &session.Client{
ID: "",
Username: thingID,
Password: []byte(password),
},
},
{
desc: "connect with invalid password",
err: errors.ErrAuthentication,
session: &session.Client{
ID: clientID,
Username: thingID,
Password: []byte(""),
},
},
{
desc: "connect with valid password and invalid username",
err: errors.ErrAuthentication,
session: &invalidThingSessionClient,
},
{
desc: "connect with valid username and password",
err: nil,
session: &sessionClient,
},
}
for _, tc := range cases {
err := handler.AuthConnect(tc.session)
assert.True(t, errors.Contains(err, tc.err), fmt.Sprintf("%s: expected %s got %s\n", tc.desc, tc.err, err))
}
}
func TestAuthPublish(t *testing.T) {
handler := newHandler()
cases := []struct {
desc string
client *session.Client
err error
topic *string
payload []byte
}{
{
desc: "publish with inactive client",
client: nil,
err: mqtt.ErrClientNotInitialized,
topic: &topic,
payload: payload,
},
{
desc: "publish without topic",
client: &sessionClient,
err: mqtt.ErrMissingTopicPub,
topic: nil,
payload: payload,
},
{
desc: "publish with malformed topic",
client: &sessionClient,
err: mqtt.ErrMalformedTopic,
topic: &invalidTopic,
payload: payload,
},
{
desc: "publish successfully",
client: &sessionClient,
err: nil,
topic: &topic,
payload: payload,
},
}
for _, tc := range cases {
err := handler.AuthPublish(tc.client, tc.topic, &tc.payload)
assert.True(t, errors.Contains(err, tc.err), fmt.Sprintf("%s: expected %s got %s\n", tc.desc, tc.err, err))
}
}
func TestAuthSubscribe(t *testing.T) {
handler := newHandler()
cases := []struct {
desc string
client *session.Client
err error
topic *[]string
}{
{
desc: "subscribe without active session",
client: nil,
err: mqtt.ErrClientNotInitialized,
topic: &topics,
},
{
desc: "subscribe without topics",
client: &sessionClient,
err: mqtt.ErrMissingTopicSub,
topic: nil,
},
{
desc: "subscribe with invalid topics",
client: &sessionClient,
err: mqtt.ErrMalformedTopic,
topic: &invalidTopics,
},
{
desc: "subscribe with invalid channel ID",
client: &sessionClient,
err: mqtt.ErrAuthentication,
topic: &invalidChanIDTopics,
},
{
desc: "subscribe with invalid thing ID",
client: &invalidThingSessionClient,
err: mqtt.ErrAuthentication,
topic: &topics,
},
{
desc: "subscribe with active session and valid topics",
client: &sessionClient,
err: nil,
topic: &topics,
},
}
for _, tc := range cases {
err := handler.AuthSubscribe(tc.client, tc.topic)
assert.True(t, errors.Contains(err, tc.err), fmt.Sprintf("%s: expected %s got %s\n", tc.desc, tc.err, err))
}
}
func TestConnect(t *testing.T) {
handler := newHandler()
logBuffer.Reset()
cases := []struct {
desc string
client *session.Client
logMsg string
}{
{
desc: "connect without active session",
client: nil,
logMsg: mqtt.LogErrFailedConnect + mqtt.ErrClientNotInitialized.Error(),
},
{
desc: "connect with active session",
client: &sessionClient,
logMsg: fmt.Sprintf(mqtt.LogInfoConnected, clientID),
},
}
for _, tc := range cases {
handler.Connect(tc.client)
assert.Contains(t, logBuffer.String(), tc.logMsg)
}
}
func TestPublish(t *testing.T) {
handler := newHandler()
logBuffer.Reset()
malformedSubtopics := topic + "/" + subtopic + "%"
wrongCharSubtopics := topic + "/" + subtopic + ">"
validSubtopic := topic + "/" + subtopic
cases := []struct {
desc string
client *session.Client
topic string
payload []byte
logMsg string
}{
{
desc: "publish without active session",
client: nil,
topic: topic,
payload: payload,
logMsg: mqtt.ErrClientNotInitialized.Error(),
},
{
desc: "publish with invalid topic",
client: &sessionClient,
topic: invalidTopic,
payload: payload,
logMsg: fmt.Sprintf(mqtt.LogInfoPublished, clientID, invalidTopic),
},
{
desc: "publish with invalid channel ID",
client: &sessionClient,
topic: invalidChannelIDTopic,
payload: payload,
logMsg: mqtt.LogErrFailedPublish + mqtt.ErrMalformedTopic.Error(),
},
{
desc: "publish with malformed subtopic",
client: &sessionClient,
topic: malformedSubtopics,
payload: payload,
logMsg: mqtt.ErrMalformedSubtopic.Error(),
},
{
desc: "publish with subtopic containing wrong character",
client: &sessionClient,
topic: wrongCharSubtopics,
payload: payload,
logMsg: mqtt.ErrMalformedSubtopic.Error(),
},
{
desc: "publish with subtopic",
client: &sessionClient,
topic: validSubtopic,
payload: payload,
logMsg: subtopic,
},
{
desc: "publish without subtopic",
client: &sessionClient,
topic: topic,
payload: payload,
logMsg: "",
},
}
for _, tc := range cases {
handler.Publish(tc.client, &tc.topic, &tc.payload)
assert.Contains(t, logBuffer.String(), tc.logMsg)
}
}
func TestSubscribe(t *testing.T) {
handler := newHandler()
logBuffer.Reset()
cases := []struct {
desc string
client *session.Client
topic []string
logMsg string
}{
{
desc: "subscribe without active session",
client: nil,
topic: topics,
logMsg: mqtt.LogErrFailedSubscribe + mqtt.ErrClientNotInitialized.Error(),
},
{
desc: "subscribe with valid session and topics",
client: &sessionClient,
topic: topics,
logMsg: fmt.Sprintf(mqtt.LogInfoSubscribed, clientID, topics[0]),
},
}
for _, tc := range cases {
handler.Subscribe(tc.client, &tc.topic)
assert.Contains(t, logBuffer.String(), tc.logMsg)
}
}
func TestUnsubscribe(t *testing.T) {
handler := newHandler()
logBuffer.Reset()
cases := []struct {
desc string
client *session.Client
topic []string
logMsg string
}{
{
desc: "unsubscribe without active session",
client: nil,
topic: topics,
logMsg: mqtt.LogErrFailedUnsubscribe + mqtt.ErrClientNotInitialized.Error(),
},
{
desc: "unsubscribe with valid session and topics",
client: &sessionClient,
topic: topics,
logMsg: fmt.Sprintf(mqtt.LogInfoUnsubscribed, clientID, topics[0]),
},
}
for _, tc := range cases {
handler.Unsubscribe(tc.client, &tc.topic)
assert.Contains(t, logBuffer.String(), tc.logMsg)
}
}
func TestDisconnect(t *testing.T) {
handler := newHandler()
logBuffer.Reset()
cases := []struct {
desc string
client *session.Client
topic []string
logMsg string
}{
{
desc: "disconnect without active session",
client: nil,
topic: topics,
logMsg: mqtt.LogErrFailedDisconnect + mqtt.ErrClientNotInitialized.Error(),
},
{
desc: "disconnect with valid session",
client: &sessionClient,
topic: topics,
logMsg: fmt.Sprintf(mqtt.LogInfoDisconnected, clientID, thingID),
},
}
for _, tc := range cases {
handler.Disconnect(tc.client)
assert.Contains(t, logBuffer.String(), tc.logMsg)
}
}
func newHandler() session.Handler {
logger, err := logger.New(&logBuffer, "debug")
if err != nil {
log.Fatalf("failed to create logger: %s", err)
}
authClient := mocks.NewClient(map[string]string{password: thingID}, map[string]interface{}{chanID: thingID})
eventStore := mocks.NewEventStore()
return mqtt.NewHandler([]messaging.Publisher{mocks.NewPublisher()}, eventStore, logger, authClient)
}