mirror of
https://github.com/bitwarden/server.git
synced 2025-04-24 06:25:09 -05:00
90d831d9ef
* [PM-17562] Slack Event Investigation * Refactored Slack and Webhook integrations to pull configurations dynamically from a new Repository * Added new TemplateProcessor and added/updated unit tests * SlackService improvements, testing, integration configurations * Refactor SlackService to use a dedicated model to parse responses * Refactored SlackOAuthController to use SlackService as an injected dependency; added tests for SlackService * Remove unnecessary methods from the IOrganizationIntegrationConfigurationRepository * Moved Slack OAuth to take into account the Organization it's being stored for. Added methods to store the top level integration for Slack * Organization integrations and configuration database schemas * Format EF files * Initial buildout of basic repositories * [PM-17562] Add Dapper Repositories For Organization Integrations and Configurations * Update Slack and Webhook handlers to use new Repositories * Update SlackOAuth tests to new signatures * Added EF Repositories * Update handlers to use latest repositories * [PM-17562] Add Dapper and EF Repositories For Ogranization Integrations and Configurations * Updated with changes from PR comments * Adjusted Handlers to new repository method names; updated tests to naming convention * Adjust URL structure; add delete for Slack, add tests * Added Webhook Integration Controller * Add tests for WebhookIntegrationController * Added Create/Delete for OrganizationIntegrationConfigurations * Prepend ConnectionTypes into IntegrationType so we don't run into issues later * Added Update to OrganizationIntegrationConfigurtionController * Moved Webhook-specific integration code to being a generic controller for everything but Slack * Removed delete from SlackController - Deletes should happen through the normal Integration controller * Fixed SlackController, reworked OIC Controller to use ids from URL and update the returned object * Added parse/type checking for integration and integration configuration JSONs, Cleaned up GlobalSettings to remove old values * Cleanup and fixes for Azure Service Bus support * Clean up naming on TemplateProcessorTests * Address SonarQube warnings/suggestions * Expanded test coverage; Cleaned up tests * Respond to PR Feedback * Rename TemplateProcessor to IntegrationTemplateProcessor --------- Co-authored-by: Matt Bishop <mbishop@bitwarden.com>
236 lines
8.8 KiB
C#
236 lines
8.8 KiB
C#
using System.Net;
|
|
using System.Net.Http.Json;
|
|
using System.Text.Json;
|
|
using Bit.Core.Enums;
|
|
using Bit.Core.Models.Data;
|
|
using Bit.Core.Models.Data.Organizations;
|
|
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 Bit.Test.Common.MockedHttpClient;
|
|
using NSubstitute;
|
|
using Xunit;
|
|
|
|
namespace Bit.Core.Test.Services;
|
|
|
|
[SutProviderCustomize]
|
|
public class WebhookEventHandlerTests
|
|
{
|
|
private readonly MockedHttpMessageHandler _handler;
|
|
private readonly HttpClient _httpClient;
|
|
|
|
private const string _template =
|
|
"""
|
|
{
|
|
"Date": "#Date#",
|
|
"Type": "#Type#",
|
|
"UserId": "#UserId#"
|
|
}
|
|
""";
|
|
private const string _webhookUrl = "http://localhost/test/event";
|
|
private const string _webhookUrl2 = "http://localhost/another/event";
|
|
|
|
public WebhookEventHandlerTests()
|
|
{
|
|
_handler = new MockedHttpMessageHandler();
|
|
_handler.Fallback
|
|
.WithStatusCode(HttpStatusCode.OK)
|
|
.WithContent(new StringContent("<html><head><title>test</title></head><body>test</body></html>"));
|
|
_httpClient = _handler.ToHttpClient();
|
|
}
|
|
|
|
private SutProvider<WebhookEventHandler> GetSutProvider(
|
|
List<OrganizationIntegrationConfigurationDetails> configurations)
|
|
{
|
|
var clientFactory = Substitute.For<IHttpClientFactory>();
|
|
clientFactory.CreateClient(WebhookEventHandler.HttpClientName).Returns(_httpClient);
|
|
|
|
var repository = Substitute.For<IOrganizationIntegrationConfigurationRepository>();
|
|
repository.GetConfigurationDetailsAsync(Arg.Any<Guid>(),
|
|
IntegrationType.Webhook, Arg.Any<EventType>()).Returns(configurations);
|
|
|
|
return new SutProvider<WebhookEventHandler>()
|
|
.SetDependency(repository)
|
|
.SetDependency(clientFactory)
|
|
.Create();
|
|
}
|
|
|
|
private static List<OrganizationIntegrationConfigurationDetails> NoConfigurations()
|
|
{
|
|
return [];
|
|
}
|
|
|
|
private static List<OrganizationIntegrationConfigurationDetails> OneConfiguration()
|
|
{
|
|
var config = Substitute.For<OrganizationIntegrationConfigurationDetails>();
|
|
config.Configuration = null;
|
|
config.IntegrationConfiguration = JsonSerializer.Serialize(new { url = _webhookUrl });
|
|
config.Template = _template;
|
|
|
|
return [config];
|
|
}
|
|
|
|
private static List<OrganizationIntegrationConfigurationDetails> TwoConfigurations()
|
|
{
|
|
var config = Substitute.For<OrganizationIntegrationConfigurationDetails>();
|
|
config.Configuration = null;
|
|
config.IntegrationConfiguration = JsonSerializer.Serialize(new { url = _webhookUrl });
|
|
config.Template = _template;
|
|
var config2 = Substitute.For<OrganizationIntegrationConfigurationDetails>();
|
|
config2.Configuration = null;
|
|
config2.IntegrationConfiguration = JsonSerializer.Serialize(new { url = _webhookUrl2 });
|
|
config2.Template = _template;
|
|
|
|
return [config, config2];
|
|
}
|
|
|
|
private static List<OrganizationIntegrationConfigurationDetails> WrongConfiguration()
|
|
{
|
|
var config = Substitute.For<OrganizationIntegrationConfigurationDetails>();
|
|
config.Configuration = null;
|
|
config.IntegrationConfiguration = JsonSerializer.Serialize(new { error = string.Empty });
|
|
config.Template = _template;
|
|
|
|
return [config];
|
|
}
|
|
|
|
[Theory, BitAutoData]
|
|
public async Task HandleEventAsync_NoConfigurations_DoesNothing(EventMessage eventMessage)
|
|
{
|
|
var sutProvider = GetSutProvider(NoConfigurations());
|
|
|
|
await sutProvider.Sut.HandleEventAsync(eventMessage);
|
|
sutProvider.GetDependency<IHttpClientFactory>().Received(1).CreateClient(
|
|
Arg.Is(AssertHelper.AssertPropertyEqual(WebhookEventHandler.HttpClientName))
|
|
);
|
|
|
|
Assert.Empty(_handler.CapturedRequests);
|
|
}
|
|
|
|
[Theory, BitAutoData]
|
|
public async Task HandleEventAsync_OneConfiguration_PostsEventToUrl(EventMessage eventMessage)
|
|
{
|
|
var sutProvider = GetSutProvider(OneConfiguration());
|
|
|
|
await sutProvider.Sut.HandleEventAsync(eventMessage);
|
|
sutProvider.GetDependency<IHttpClientFactory>().Received(1).CreateClient(
|
|
Arg.Is(AssertHelper.AssertPropertyEqual(WebhookEventHandler.HttpClientName))
|
|
);
|
|
|
|
Assert.Single(_handler.CapturedRequests);
|
|
var request = _handler.CapturedRequests[0];
|
|
Assert.NotNull(request);
|
|
var returned = await request.Content.ReadFromJsonAsync<MockEvent>();
|
|
var expected = MockEvent.From(eventMessage);
|
|
|
|
Assert.Equal(HttpMethod.Post, request.Method);
|
|
Assert.Equal(_webhookUrl, request.RequestUri.ToString());
|
|
AssertHelper.AssertPropertyEqual(expected, returned);
|
|
}
|
|
|
|
[Theory, BitAutoData]
|
|
public async Task HandleEventAsync_WrongConfigurations_DoesNothing(EventMessage eventMessage)
|
|
{
|
|
var sutProvider = GetSutProvider(WrongConfiguration());
|
|
|
|
await sutProvider.Sut.HandleEventAsync(eventMessage);
|
|
sutProvider.GetDependency<IHttpClientFactory>().Received(1).CreateClient(
|
|
Arg.Is(AssertHelper.AssertPropertyEqual(WebhookEventHandler.HttpClientName))
|
|
);
|
|
|
|
Assert.Empty(_handler.CapturedRequests);
|
|
}
|
|
|
|
[Theory, BitAutoData]
|
|
public async Task HandleManyEventsAsync_NoConfigurations_DoesNothing(List<EventMessage> eventMessages)
|
|
{
|
|
var sutProvider = GetSutProvider(NoConfigurations());
|
|
|
|
await sutProvider.Sut.HandleManyEventsAsync(eventMessages);
|
|
sutProvider.GetDependency<IHttpClientFactory>().Received(1).CreateClient(
|
|
Arg.Is(AssertHelper.AssertPropertyEqual(WebhookEventHandler.HttpClientName))
|
|
);
|
|
|
|
Assert.Empty(_handler.CapturedRequests);
|
|
}
|
|
|
|
|
|
[Theory, BitAutoData]
|
|
public async Task HandleManyEventsAsync_OneConfiguration_PostsEventsToUrl(List<EventMessage> eventMessages)
|
|
{
|
|
var sutProvider = GetSutProvider(OneConfiguration());
|
|
|
|
await sutProvider.Sut.HandleManyEventsAsync(eventMessages);
|
|
sutProvider.GetDependency<IHttpClientFactory>().Received(1).CreateClient(
|
|
Arg.Is(AssertHelper.AssertPropertyEqual(WebhookEventHandler.HttpClientName))
|
|
);
|
|
|
|
Assert.Equal(eventMessages.Count, _handler.CapturedRequests.Count);
|
|
var index = 0;
|
|
foreach (var request in _handler.CapturedRequests)
|
|
{
|
|
Assert.NotNull(request);
|
|
var returned = await request.Content.ReadFromJsonAsync<MockEvent>();
|
|
var expected = MockEvent.From(eventMessages[index]);
|
|
|
|
Assert.Equal(HttpMethod.Post, request.Method);
|
|
Assert.Equal(_webhookUrl, request.RequestUri.ToString());
|
|
AssertHelper.AssertPropertyEqual(expected, returned);
|
|
index++;
|
|
}
|
|
}
|
|
|
|
[Theory, BitAutoData]
|
|
public async Task HandleManyEventsAsync_TwoConfigurations_PostsEventsToMultipleUrls(List<EventMessage> eventMessages)
|
|
{
|
|
var sutProvider = GetSutProvider(TwoConfigurations());
|
|
|
|
await sutProvider.Sut.HandleManyEventsAsync(eventMessages);
|
|
sutProvider.GetDependency<IHttpClientFactory>().Received(1).CreateClient(
|
|
Arg.Is(AssertHelper.AssertPropertyEqual(WebhookEventHandler.HttpClientName))
|
|
);
|
|
|
|
using var capturedRequests = _handler.CapturedRequests.GetEnumerator();
|
|
Assert.Equal(eventMessages.Count * 2, _handler.CapturedRequests.Count);
|
|
|
|
foreach (var eventMessage in eventMessages)
|
|
{
|
|
var expected = MockEvent.From(eventMessage);
|
|
|
|
Assert.True(capturedRequests.MoveNext());
|
|
var request = capturedRequests.Current;
|
|
Assert.NotNull(request);
|
|
Assert.Equal(HttpMethod.Post, request.Method);
|
|
Assert.Equal(_webhookUrl, request.RequestUri.ToString());
|
|
var returned = await request.Content.ReadFromJsonAsync<MockEvent>();
|
|
AssertHelper.AssertPropertyEqual(expected, returned);
|
|
|
|
Assert.True(capturedRequests.MoveNext());
|
|
request = capturedRequests.Current;
|
|
Assert.NotNull(request);
|
|
Assert.Equal(HttpMethod.Post, request.Method);
|
|
Assert.Equal(_webhookUrl2, request.RequestUri.ToString());
|
|
returned = await request.Content.ReadFromJsonAsync<MockEvent>();
|
|
AssertHelper.AssertPropertyEqual(expected, returned);
|
|
}
|
|
}
|
|
}
|
|
|
|
public class MockEvent(string date, string type, string userId)
|
|
{
|
|
public string Date { get; set; } = date;
|
|
public string Type { get; set; } = type;
|
|
public string UserId { get; set; } = userId;
|
|
|
|
public static MockEvent From(EventMessage eventMessage)
|
|
{
|
|
return new MockEvent(
|
|
eventMessage.Date.ToString(),
|
|
eventMessage.Type.ToString(),
|
|
eventMessage.UserId.ToString()
|
|
);
|
|
}
|
|
}
|