From 09cff6e726f6fa22d05a9f73139f2f9dee92b0d6 Mon Sep 17 00:00:00 2001 From: Brant DeBow Date: Thu, 3 Apr 2025 11:04:19 -0400 Subject: [PATCH] Adjust URL structure; add delete for Slack, add tests --- ...oller.cs => SlackIntegrationController.cs} | 48 +++++++--- ....cs => SlackIntegrationControllerTests.cs} | 88 +++++++++++++++---- 2 files changed, 107 insertions(+), 29 deletions(-) rename src/Api/AdminConsole/Controllers/{SlackOAuthController.cs => SlackIntegrationController.cs} (50%) rename test/Api.Test/AdminConsole/Controllers/{SlackOAuthControllerTests.cs => SlackIntegrationControllerTests.cs} (50%) diff --git a/src/Api/AdminConsole/Controllers/SlackOAuthController.cs b/src/Api/AdminConsole/Controllers/SlackIntegrationController.cs similarity index 50% rename from src/Api/AdminConsole/Controllers/SlackOAuthController.cs rename to src/Api/AdminConsole/Controllers/SlackIntegrationController.cs index 7a1fd36e0c..8f10ae96e7 100644 --- a/src/Api/AdminConsole/Controllers/SlackOAuthController.cs +++ b/src/Api/AdminConsole/Controllers/SlackIntegrationController.cs @@ -11,21 +11,24 @@ using Microsoft.AspNetCore.Mvc; namespace Bit.Api.AdminConsole.Controllers; -[Route("slack/oauth")] +[Route("organizations/{organizationId:guid}/integrations/slack/")] [Authorize("Application")] -public class SlackOAuthController( +public class SlackIntegrationController( ICurrentContext currentContext, IOrganizationIntegrationRepository integrationRepository, ISlackService slackService) : Controller { - [HttpGet("redirect/{id:guid}")] - public async Task RedirectToSlack(Guid id) + [HttpGet("redirect/")] + public async Task RedirectAsync(Guid organizationId) { - if (!await currentContext.OrganizationOwner(id)) + if (!await currentContext.OrganizationOwner(organizationId)) { throw new NotFoundException(); } - string callbackUrl = Url.RouteUrl(nameof(OAuthCallback), new { id = id }, currentContext.HttpContext.Request.Scheme); + string callbackUrl = Url.RouteUrl( + nameof(CreateAsync), + new { id = organizationId }, + currentContext.HttpContext.Request.Scheme); var redirectUrl = slackService.GetRedirectUrl(callbackUrl); if (string.IsNullOrEmpty(redirectUrl)) @@ -36,10 +39,10 @@ public class SlackOAuthController( return Redirect(redirectUrl); } - [HttpGet("callback/{id:guid}", Name = nameof(OAuthCallback))] - public async Task OAuthCallback(Guid id, [FromQuery] string code) + [HttpGet("create", Name = nameof(CreateAsync))] + public async Task CreateAsync(Guid organizationId, [FromQuery] string code) { - if (!await currentContext.OrganizationOwner(id)) + if (!await currentContext.OrganizationOwner(organizationId)) { throw new NotFoundException(); } @@ -49,7 +52,10 @@ public class SlackOAuthController( throw new BadRequestException("Missing code from Slack."); } - string callbackUrl = Url.RouteUrl(nameof(OAuthCallback), new { id = id }, currentContext.HttpContext.Request.Scheme); + string callbackUrl = Url.RouteUrl( + nameof(CreateAsync), + new { id = organizationId }, + currentContext.HttpContext.Request.Scheme); var token = await slackService.ObtainTokenViaOAuth(code, callbackUrl); if (string.IsNullOrEmpty(token)) @@ -59,10 +65,28 @@ public class SlackOAuthController( var integration = await integrationRepository.CreateAsync(new OrganizationIntegration { - OrganizationId = id, + OrganizationId = organizationId, Type = IntegrationType.Slack, Configuration = JsonSerializer.Serialize(new SlackIntegration(token)), }); - return Ok(integration.Id); + return Ok(new { id = integration.Id } ); + } + + [HttpDelete("{integrationId:guid}")] + [HttpPost("{integrationId:guid}/delete")] + public async Task DeleteAsync(Guid organizationId, Guid integrationId) + { + if (!await currentContext.OrganizationOwner(organizationId)) + { + throw new NotFoundException(); + } + + var integration = await integrationRepository.GetByIdAsync(integrationId); + if (integration is null) + { + throw new NotFoundException(); + } + + await integrationRepository.DeleteAsync(integration); } } diff --git a/test/Api.Test/AdminConsole/Controllers/SlackOAuthControllerTests.cs b/test/Api.Test/AdminConsole/Controllers/SlackIntegrationControllerTests.cs similarity index 50% rename from test/Api.Test/AdminConsole/Controllers/SlackOAuthControllerTests.cs rename to test/Api.Test/AdminConsole/Controllers/SlackIntegrationControllerTests.cs index 11111eb261..58991f112d 100644 --- a/test/Api.Test/AdminConsole/Controllers/SlackOAuthControllerTests.cs +++ b/test/Api.Test/AdminConsole/Controllers/SlackIntegrationControllerTests.cs @@ -8,16 +8,17 @@ using Bit.Test.Common.AutoFixture; using Bit.Test.Common.AutoFixture.Attributes; using Microsoft.AspNetCore.Mvc; using NSubstitute; +using NSubstitute.ReturnsExtensions; using Xunit; namespace Bit.Api.Test.AdminConsole.Controllers; -[ControllerCustomize(typeof(SlackOAuthController))] +[ControllerCustomize(typeof(SlackIntegrationController))] [SutProviderCustomize] -public class SlackOAuthControllerTests +public class SlackIntegrationControllerTests { [Theory, BitAutoData] - public async Task OAuthCallback_AllParamsProvided_Succeeds(SutProvider sutProvider, Guid organizationId) + public async Task CreateAsync_AllParamsProvided_Succeeds(SutProvider sutProvider, Guid organizationId) { var token = "xoxb-test-token"; sutProvider.Sut.Url = Substitute.For(); @@ -27,8 +28,10 @@ public class SlackOAuthControllerTests sutProvider.GetDependency() .ObtainTokenViaOAuth(Arg.Any(), Arg.Any()) .Returns(token); - - var requestAction = await sutProvider.Sut.OAuthCallback(organizationId, "A_test_code"); + sutProvider.GetDependency() + .CreateAsync(Arg.Any()) + .Returns(callInfo => callInfo.Arg()); + var requestAction = await sutProvider.Sut.CreateAsync(organizationId, "A_test_code"); await sutProvider.GetDependency().Received(1) .CreateAsync(Arg.Any()); @@ -36,18 +39,18 @@ public class SlackOAuthControllerTests } [Theory, BitAutoData] - public async Task OAuthCallback_CodeIsEmpty_ThrowsBadRequest(SutProvider sutProvider, Guid organizationId) + public async Task CreateAsync_CodeIsEmpty_ThrowsBadRequest(SutProvider sutProvider, Guid organizationId) { sutProvider.Sut.Url = Substitute.For(); sutProvider.GetDependency() .OrganizationOwner(organizationId) .Returns(true); - await Assert.ThrowsAsync(async () => await sutProvider.Sut.OAuthCallback(organizationId, string.Empty)); + await Assert.ThrowsAsync(async () => await sutProvider.Sut.CreateAsync(organizationId, string.Empty)); } [Theory, BitAutoData] - public async Task OAuthCallback_SlackServiceReturnsEmpty_ThrowsBadRequest(SutProvider sutProvider, Guid organizationId) + public async Task CreateAsync_SlackServiceReturnsEmpty_ThrowsBadRequest(SutProvider sutProvider, Guid organizationId) { sutProvider.Sut.Url = Substitute.For(); sutProvider.GetDependency() @@ -57,11 +60,11 @@ public class SlackOAuthControllerTests .ObtainTokenViaOAuth(Arg.Any(), Arg.Any()) .Returns(string.Empty); - await Assert.ThrowsAsync(async () => await sutProvider.Sut.OAuthCallback(organizationId, "A_test_code")); + await Assert.ThrowsAsync(async () => await sutProvider.Sut.CreateAsync(organizationId, "A_test_code")); } [Theory, BitAutoData] - public async Task OAuthCallback_UserIsNotOrganizationAdmin_ThrowsNotFound(SutProvider sutProvider, Guid organizationId) + public async Task CreateAsync_UserIsNotOrganizationAdmin_ThrowsNotFound(SutProvider sutProvider, Guid organizationId) { var token = "xoxb-test-token"; sutProvider.Sut.Url = Substitute.For(); @@ -72,11 +75,62 @@ public class SlackOAuthControllerTests .ObtainTokenViaOAuth(Arg.Any(), Arg.Any()) .Returns(token); - await Assert.ThrowsAsync(async () => await sutProvider.Sut.OAuthCallback(organizationId, "A_test_code")); + await Assert.ThrowsAsync(async () => await sutProvider.Sut.CreateAsync(organizationId, "A_test_code")); } [Theory, BitAutoData] - public async Task Redirect_Success(SutProvider sutProvider, Guid organizationId) + public async Task DeleteAsync_AllParamsProvided_Succeeds( + SutProvider sutProvider, + Guid organizationId, + OrganizationIntegration organizationIntegration) + { + sutProvider.Sut.Url = Substitute.For(); + sutProvider.GetDependency() + .OrganizationOwner(organizationId) + .Returns(true); + sutProvider.GetDependency() + .GetByIdAsync(Arg.Any()) + .Returns(organizationIntegration); + + await sutProvider.Sut.DeleteAsync(organizationId, organizationIntegration.Id); + + await sutProvider.GetDependency().Received(1) + .GetByIdAsync(organizationIntegration.Id); + await sutProvider.GetDependency().Received(1) + .DeleteAsync(organizationIntegration); + } + + [Theory, BitAutoData] + public async Task DeleteAsync_IntegrationDoesNotExist_ThrowsNotFound( + SutProvider sutProvider, + Guid organizationId) + { + sutProvider.Sut.Url = Substitute.For(); + sutProvider.GetDependency() + .OrganizationOwner(organizationId) + .Returns(true); + sutProvider.GetDependency() + .GetByIdAsync(Arg.Any()) + .ReturnsNull(); + + await Assert.ThrowsAsync(async () => await sutProvider.Sut.DeleteAsync(organizationId, Guid.Empty)); + } + + [Theory, BitAutoData] + public async Task DeleteAsync_UserIsNotOrganizationAdmin_ThrowsNotFound( + SutProvider sutProvider, + Guid organizationId) + { + sutProvider.Sut.Url = Substitute.For(); + sutProvider.GetDependency() + .OrganizationOwner(organizationId) + .Returns(false); + + await Assert.ThrowsAsync(async () => await sutProvider.Sut.DeleteAsync(organizationId, Guid.Empty)); + } + + [Theory, BitAutoData] + public async Task RedirectAsync_Success(SutProvider sutProvider, Guid organizationId) { var expectedUrl = $"https://localhost/{organizationId}"; @@ -89,14 +143,14 @@ public class SlackOAuthControllerTests .HttpContext.Request.Scheme .Returns("https"); - var requestAction = await sutProvider.Sut.RedirectToSlack(organizationId); + var requestAction = await sutProvider.Sut.RedirectAsync(organizationId); var redirectResult = Assert.IsType(requestAction); Assert.Equal(expectedUrl, redirectResult.Url); } [Theory, BitAutoData] - public async Task Redirect_SlackServiceReturnsEmpty_ThrowsNotFound(SutProvider sutProvider, Guid organizationId) + public async Task RedirectAsync_SlackServiceReturnsEmpty_ThrowsNotFound(SutProvider sutProvider, Guid organizationId) { sutProvider.Sut.Url = Substitute.For(); sutProvider.GetDependency().GetRedirectUrl(Arg.Any()).Returns(string.Empty); @@ -107,11 +161,11 @@ public class SlackOAuthControllerTests .HttpContext.Request.Scheme .Returns("https"); - await Assert.ThrowsAsync(async () => await sutProvider.Sut.RedirectToSlack(organizationId)); + await Assert.ThrowsAsync(async () => await sutProvider.Sut.RedirectAsync(organizationId)); } [Theory, BitAutoData] - public async Task Redirect_UserIsNotOrganizationAdmin_ThrowsNotFound(SutProvider sutProvider, + public async Task RedirectAsync_UserIsNotOrganizationAdmin_ThrowsNotFound(SutProvider sutProvider, Guid organizationId) { sutProvider.Sut.Url = Substitute.For(); @@ -123,6 +177,6 @@ public class SlackOAuthControllerTests .HttpContext.Request.Scheme .Returns("https"); - await Assert.ThrowsAsync(async () => await sutProvider.Sut.RedirectToSlack(organizationId)); + await Assert.ThrowsAsync(async () => await sutProvider.Sut.RedirectAsync(organizationId)); } }