SlackService improvements, testing, integration configurations

2025-07-13 21:57:30 -05:00 · 2025-03-17 07:40:21 -04:00
parent d33edbdd85
commit fb7d24286d
13 changed files with 729 additions and 150 deletions
--- a/test/Core.Test/AdminConsole/Services/SlackEventHandlerTests.cs
+++ b/test/Core.Test/AdminConsole/Services/SlackEventHandlerTests.cs
@ -0,0 +1,175 @@
+using Bit.Core.Enums;
+using Bit.Core.Models.Data;
+using Bit.Core.Models.Data.Integrations;
+using Bit.Core.Repositories;
+using Bit.Core.Services;
+using Bit.Test.Common.AutoFixture;
+using Bit.Test.Common.AutoFixture.Attributes;
+using Bit.Test.Common.Helpers;
+using NSubstitute;
+using Xunit;
+
+namespace Bit.Core.Test.Services;
+
+[SutProviderCustomize]
+public class SlackEventHandlerTests
+{
+    private readonly IOrganizationIntegrationConfigurationRepository _repository = Substitute.For<IOrganizationIntegrationConfigurationRepository>();
+    private readonly ISlackService _slackService = Substitute.For<ISlackService>();
+    private readonly string _channelId = "C12345";
+    private readonly string _channelId2 = "C67890";
+    private readonly string _token = "xoxb-test-token";
+    private readonly string _token2 = "xoxb-another-test-token";
+
+    private SutProvider<SlackEventHandler> GetSutProvider(
+        List<IntegrationConfiguration<SlackConfiguration>> integrationConfigurations)
+    {
+        _repository.GetConfigurationsAsync<SlackConfiguration>(
+            IntegrationType.Slack,
+            Arg.Any<Guid>(),
+            Arg.Any<EventType>())
+        .Returns(integrationConfigurations);
+
+        return new SutProvider<SlackEventHandler>()
+            .SetDependency(_repository)
+            .SetDependency(_slackService)
+            .Create();
+    }
+
+    private List<IntegrationConfiguration<SlackConfiguration>> NoConfigurations()
+    {
+        return [];
+    }
+
+    private List<IntegrationConfiguration<SlackConfiguration>> OneConfiguration()
+    {
+        return
+        [
+            new IntegrationConfiguration<SlackConfiguration>
+            {
+                Configuration = new SlackConfiguration(channelId: _channelId, token: _token),
+                Template = "Date: #Date#, Type: #Type#, UserId: #UserId#"
+            }
+        ];
+    }
+
+    private List<IntegrationConfiguration<SlackConfiguration>> TwoConfigurations()
+    {
+        return
+        [
+            new IntegrationConfiguration<SlackConfiguration>
+            {
+                Configuration = new SlackConfiguration(channelId: _channelId, token: _token),
+                Template = "Date: #Date#, Type: #Type#, UserId: #UserId#"
+            },
+
+            new IntegrationConfiguration<SlackConfiguration>
+            {
+                Configuration = new SlackConfiguration(channelId: _channelId2, token: _token2),
+                Template = "Date: #Date#, Type: #Type#, UserId: #UserId#"
+            }
+        ];
+    }
+
+    [Theory, BitAutoData]
+    public async Task HandleEventAsync_DoesNothingWhenNoConfigurations(EventMessage eventMessage)
+    {
+        var sutProvider = GetSutProvider(NoConfigurations());
+
+        await sutProvider.Sut.HandleEventAsync(eventMessage);
+        sutProvider.GetDependency<ISlackService>().DidNotReceiveWithAnyArgs();
+    }
+
+    [Theory, BitAutoData]
+    public async Task HandleEventAsync_SendsEventViaSlackService(EventMessage eventMessage)
+    {
+        var sutProvider = GetSutProvider(OneConfiguration());
+
+        await sutProvider.Sut.HandleEventAsync(eventMessage);
+        sutProvider.GetDependency<ISlackService>().Received(1).SendSlackMessageByChannelId(
+            Arg.Is(AssertHelper.AssertPropertyEqual(_token)),
+            Arg.Is(AssertHelper.AssertPropertyEqual(
+                $"Date: {eventMessage.Date}, Type: {eventMessage.Type}, UserId: {eventMessage.UserId}")),
+            Arg.Is(AssertHelper.AssertPropertyEqual(_channelId))
+        );
+    }
+
+    [Theory, BitAutoData]
+    public async Task HandleEventAsync_SendsMultipleWhenConfigured(EventMessage eventMessage)
+    {
+        var sutProvider = GetSutProvider(TwoConfigurations());
+
+        await sutProvider.Sut.HandleEventAsync(eventMessage);
+        sutProvider.GetDependency<ISlackService>().Received(1).SendSlackMessageByChannelId(
+            Arg.Is(AssertHelper.AssertPropertyEqual(_token)),
+            Arg.Is(AssertHelper.AssertPropertyEqual(
+                $"Date: {eventMessage.Date}, Type: {eventMessage.Type}, UserId: {eventMessage.UserId}")),
+            Arg.Is(AssertHelper.AssertPropertyEqual(_channelId))
+        );
+        sutProvider.GetDependency<ISlackService>().Received(1).SendSlackMessageByChannelId(
+            Arg.Is(AssertHelper.AssertPropertyEqual(_token2)),
+            Arg.Is(AssertHelper.AssertPropertyEqual(
+                $"Date: {eventMessage.Date}, Type: {eventMessage.Type}, UserId: {eventMessage.UserId}")),
+            Arg.Is(AssertHelper.AssertPropertyEqual(_channelId2))
+        );
+    }
+
+    [Theory, BitAutoData]
+    public async Task HandleManyEventsAsync_SendsEventsViaSlackService(List<EventMessage> eventMessages)
+    {
+        var sutProvider = GetSutProvider(OneConfiguration());
+
+        await sutProvider.Sut.HandleManyEventsAsync(eventMessages);
+
+        var received = sutProvider.GetDependency<ISlackService>().ReceivedCalls();
+        using var calls = received.GetEnumerator();
+
+        Assert.Equal(eventMessages.Count, received.Count());
+
+        var index = 0;
+        foreach (var eventMessage in eventMessages)
+        {
+            Assert.True(calls.MoveNext());
+            var arguments = calls.Current.GetArguments();
+            Assert.Equal(_token, arguments[0] as string);
+            Assert.Equal($"Date: {eventMessage.Date}, Type: {eventMessage.Type}, UserId: {eventMessage.UserId}",
+                arguments[1] as string);
+            Assert.Equal(_channelId, arguments[2] as string);
+
+            index++;
+        }
+    }
+
+    [Theory, BitAutoData]
+    public async Task HandleManyEventsAsync_SendsMultipleEventsAndMultipleConfigurations(List<EventMessage> eventMessages)
+    {
+        var sutProvider = GetSutProvider(TwoConfigurations());
+
+        await sutProvider.Sut.HandleManyEventsAsync(eventMessages);
+
+        var received = sutProvider.GetDependency<ISlackService>().ReceivedCalls();
+        var calls = received.GetEnumerator();
+
+        Assert.Equal(eventMessages.Count * 2, received.Count());
+
+        var index = 0;
+        foreach (var eventMessage in eventMessages)
+        {
+            Assert.True(calls.MoveNext());
+            var arguments = calls.Current.GetArguments();
+            Assert.Equal(_token, arguments[0] as string);
+            Assert.Equal($"Date: {eventMessage.Date}, Type: {eventMessage.Type}, UserId: {eventMessage.UserId}",
+                         arguments[1] as string);
+            Assert.Equal(_channelId, arguments[2] as string);
+
+            Assert.True(calls.MoveNext());
+            var arguments2 = calls.Current.GetArguments();
+            Assert.Equal(_token2, arguments2[0] as string);
+            Assert.Equal($"Date: {eventMessage.Date}, Type: {eventMessage.Type}, UserId: {eventMessage.UserId}",
+                arguments2[1] as string);
+            Assert.Equal(_channelId2, arguments2[2] as string);
+
+            index++;
+        }
+    }
+}