MQTTnet/Source/MQTTnet.Tests/Server/MqttSubscriptionsManager_Tests.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using MQTTnet.Packets;
using MQTTnet.Protocol;
using MQTTnet.Server;
using MQTTnet.Tests.Mockups;

namespace MQTTnet.Tests.Server
{
    [TestClass]
    public sealed class MqttSubscriptionsManager_Tests : BaseTestClass
    {
        MqttClientSubscriptionsManager _subscriptionsManager;

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeAndUnsubscribeSingle()
        {
            var sp = new MqttSubscribePacket
            {
                TopicFilters = new List<MqttTopicFilter>
                {
                    new MqttTopicFilterBuilder().WithTopic("A/B/C").Build()
                }
            };

            await _subscriptionsManager.Subscribe(sp, CancellationToken.None);

            Assert.IsTrue(CheckSubscriptions("A/B/C", MqttQualityOfServiceLevel.AtMostOnce, "").IsSubscribed);

            var up = new MqttUnsubscribePacket();
            up.TopicFilters.Add("A/B/C");
            await _subscriptionsManager.Unsubscribe(up, CancellationToken.None);

            Assert.IsFalse(CheckSubscriptions("A/B/C", MqttQualityOfServiceLevel.AtMostOnce, "").IsSubscribed);
        }

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeDifferentQoSSuccess()
        {
            var sp = new MqttSubscribePacket
            {
                TopicFilters = new List<MqttTopicFilter>
                {
                    new MqttTopicFilter { Topic = "A/B/C", QualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce }
                }
            };

            await _subscriptionsManager.Subscribe(sp, CancellationToken.None);

            var result = CheckSubscriptions("A/B/C", MqttQualityOfServiceLevel.ExactlyOnce, "");
            Assert.IsTrue(result.IsSubscribed);
            Assert.AreEqual(result.QualityOfServiceLevel, MqttQualityOfServiceLevel.AtMostOnce);
        }

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeSingleNoSuccess()
        {
            var sp = new MqttSubscribePacket
            {
                TopicFilters = new List<MqttTopicFilter>
                {
                    new MqttTopicFilterBuilder().WithTopic("A/B/C").Build()
                }
            };

            await _subscriptionsManager.Subscribe(sp, CancellationToken.None);

            Assert.IsFalse(CheckSubscriptions("A/B/X", MqttQualityOfServiceLevel.AtMostOnce, "").IsSubscribed);
        }

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeSingleSuccess()
        {
            var sp = new MqttSubscribePacket
            {
                TopicFilters = new List<MqttTopicFilter>
                {
                    new MqttTopicFilterBuilder().WithTopic("A/B/C").Build()
                }
            };

            await _subscriptionsManager.Subscribe(sp, CancellationToken.None);

            var result = CheckSubscriptions("A/B/C", MqttQualityOfServiceLevel.AtMostOnce, "");

            Assert.IsTrue(result.IsSubscribed);
            Assert.AreEqual(result.QualityOfServiceLevel, MqttQualityOfServiceLevel.AtMostOnce);
        }

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeTwoTimesSuccess()
        {
            var sp = new MqttSubscribePacket
            {
                TopicFilters = new List<MqttTopicFilter>
                {
                    new MqttTopicFilter { Topic = "#", QualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce },
                    new MqttTopicFilter { Topic = "A/B/C", QualityOfServiceLevel = MqttQualityOfServiceLevel.AtLeastOnce }
                }
            };

            await _subscriptionsManager.Subscribe(sp, CancellationToken.None);

            var result = CheckSubscriptions("A/B/C", MqttQualityOfServiceLevel.ExactlyOnce, "");

            Assert.IsTrue(result.IsSubscribed);
            Assert.AreEqual(result.QualityOfServiceLevel, MqttQualityOfServiceLevel.AtLeastOnce);
        }

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeWildcard1()
        {
            await SubscribeToTopic("house/+/room");
            await SubscribeToTopic("house/+/room/+");

            CheckIsSubscribed("house/1/room");
            CheckIsSubscribed("house/1/room/bed");
            CheckIsSubscribed("house/1/room/chair");
            CheckIsSubscribed("house/2/room/bed");
            CheckIsSubscribed("house/2/room/chair");

            CheckIsNotSubscribed("house/1/room/bed/cover");
            CheckIsNotSubscribed("house/1/study/bed");
        }

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeWildcard2()
        {
            await SubscribeToTopic("house/+/room");
            await SubscribeToTopic("house/+/room/#");

            CheckIsSubscribed("house/1/room");
            CheckIsSubscribed("house/1/room/bed");
            CheckIsSubscribed("house/2/room");
            CheckIsSubscribed("house/2/room/bed");
            CheckIsSubscribed("house/2/room/bed/cover");

            CheckIsNotSubscribed("house/1/level");
            CheckIsNotSubscribed("house/1/level/door");
        }

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeWildcard3()
        {
            await SubscribeToTopic("house/1/room");
            await SubscribeToTopic("house/1/room/+");

            CheckIsSubscribed("house/1/room");
            CheckIsSubscribed("house/1/room/bed");
            CheckIsSubscribed("house/1/room/chair");

            CheckIsNotSubscribed("house/2/room");
            CheckIsNotSubscribed("house/2/room/bed/cover");
        }

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeWildcard4()
        {
            await SubscribeToTopic("house/1/+/+");

            CheckIsSubscribed("house/1/room/bed");
            CheckIsSubscribed("house/1/room/chair");

            CheckIsNotSubscribed("house/1/room");
            CheckIsNotSubscribed("house/1/room/bed/cover");
        }

        [TestMethod]
        public async Task MqttSubscriptionsManager_SubscribeWildcard5()
        {
            await SubscribeToTopic("house/1/+/#");

            CheckIsSubscribed("house/1/room/bed");
            CheckIsSubscribed("house/1/room/chair");
            CheckIsSubscribed("house/1/room/chair/leg");
            CheckIsSubscribed("house/1/level/window");
            CheckIsSubscribed("house/1/level/door");

            CheckIsNotSubscribed("house/2/room/bed");
        }

        async Task SubscribeToTopic(string topic)
        {
            var sp = new MqttSubscribePacket
            {
                TopicFilters = new List<MqttTopicFilter>
                {
                    new MqttTopicFilter { Topic = topic, QualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce },
                }
            };

            await _subscriptionsManager.Subscribe(sp, CancellationToken.None);
        }

        void CheckIsSubscribed(string topic)
        {
            var result = CheckSubscriptions(topic, MqttQualityOfServiceLevel.AtMostOnce, "");
            Assert.IsTrue(result.IsSubscribed);
            Assert.AreEqual(result.QualityOfServiceLevel, MqttQualityOfServiceLevel.AtMostOnce);
        }

        void CheckIsNotSubscribed(string topic)
        {
            var result = CheckSubscriptions(topic, MqttQualityOfServiceLevel.AtMostOnce, "");
            Assert.IsFalse(result.IsSubscribed);
        }

        [TestInitialize]
        public void TestInitialize()
        {
            var logger = new TestLogger();
            var options = new MqttServerOptions();
            var retainedMessagesManager = new MqttRetainedMessagesManager(new MqttServerEventContainer(), logger);
            var eventContainer = new MqttServerEventContainer();
            var clientSessionManager = new MqttClientSessionsManager(options, retainedMessagesManager, eventContainer, logger);

            var session = new MqttSession(new MqttConnectPacket
            {
                ClientId = ""
            }, new ConcurrentDictionary<object, object>(), options, eventContainer, retainedMessagesManager, clientSessionManager);

            _subscriptionsManager = new MqttClientSubscriptionsManager(session, new MqttServerEventContainer(), retainedMessagesManager, clientSessionManager);
        }

        CheckSubscriptionsResult CheckSubscriptions(string topic, MqttQualityOfServiceLevel applicationMessageQoSLevel, string senderClientId)
        {
            MqttTopicHash.Calculate(topic, out var topicHash, out _, out _);
            return _subscriptionsManager.CheckSubscriptions(topic, topicHash, applicationMessageQoSLevel, senderClientId);
        }
    }
}