[MergeController] Add ProducesResponseType attributes, tests (#3844)

Author: imnasnainaec

Backend.Tests/Controllers/MergeControllerTests.cs

@@ -49,7 +49,31 @@ public void Setup()
         }
 
         [Test]
-        public void BlacklistAddTest()
+        public void TestMergeWordsNoPermission()
+        {
+            _mergeController.ControllerContext.HttpContext = PermissionServiceMock.UnauthorizedHttpContext();
+            var result = _mergeController.MergeWords("projId", []).Result;
+            Assert.That(result, Is.InstanceOf<ForbidResult>());
+        }
+
+        [Test]
+        public void TestUndoMergeNoPermission()
+        {
+            _mergeController.ControllerContext.HttpContext = PermissionServiceMock.UnauthorizedHttpContext();
+            var result = _mergeController.UndoMerge("projId", new()).Result;
+            Assert.That(result, Is.InstanceOf<ForbidResult>());
+        }
+
+        [Test]
+        public void TestBlacklistAddNoPermission()
+        {
+            _mergeController.ControllerContext.HttpContext = PermissionServiceMock.UnauthorizedHttpContext();
+            var result = _mergeController.BlacklistAdd("projId", []).Result;
+            Assert.That(result, Is.InstanceOf<ForbidResult>());
+        }
+
+        [Test]
+        public void TestBlacklistAdd()
         {
             var wordIdsA = new List<string> { "1", "2" };
             var wordIdsB = new List<string> { "3", "1" };
@@ -72,7 +96,15 @@ public void BlacklistAddTest()
         }
 
         [Test]
-        public void GraylistAddTest()
+        public void TestGraylistAddNoPermission()
+        {
+            _mergeController.ControllerContext.HttpContext = PermissionServiceMock.UnauthorizedHttpContext();
+            var result = _mergeController.GraylistAdd("projId", []).Result;
+            Assert.That(result, Is.InstanceOf<ForbidResult>());
+        }
+
+        [Test]
+        public void TestGraylistAdd()
         {
             var wordIdsA = new List<string> { "1", "2" };
             var wordIdsB = new List<string> { "3", "1" };
@@ -95,15 +127,30 @@ public void GraylistAddTest()
         }
 
         [Test]
-        public void HasGraylistEntriesNoPermissionTest()
+        public void TestFindPotentialDuplicatesNoPermission()
+        {
+            _mergeController.ControllerContext.HttpContext = PermissionServiceMock.UnauthorizedHttpContext();
+            var result = _mergeController.FindPotentialDuplicates("projId", 2, 1).Result;
+            Assert.That(result, Is.InstanceOf<ForbidResult>());
+        }
+
+        [Test]
+        public void TestRetrievePotentialDuplicatesNoDuplicates()
+        {
+            var result = _mergeController.RetrievePotentialDuplicates();
+            Assert.That(result, Is.InstanceOf<BadRequestResult>());
+        }
+
+        [Test]
+        public void TestHasGraylistEntriesNoPermission()
         {
             _mergeController.ControllerContext.HttpContext = PermissionServiceMock.UnauthorizedHttpContext();
             var result = _mergeController.HasGraylistEntries("projId", "userId").Result;
             Assert.That(result, Is.InstanceOf<ForbidResult>());
         }
 
         [Test]
-        public void GetGraylistEntriesNoPermissionTest()
+        public void TestGetGraylistEntriesNoPermission()
         {
             _mergeController.ControllerContext.HttpContext = PermissionServiceMock.UnauthorizedHttpContext();
             var result = _mergeController.GetGraylistEntries("projId", 3, "userId").Result;

Backend/Controllers/MergeController.cs

@@ -33,6 +33,8 @@ public MergeController(
         /// <returns> List of ids of new words </returns>
         [HttpPut(Name = "MergeWords")]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(List<string>))]
+        [ProducesResponseType(StatusCodes.Status400BadRequest, Type = typeof(string))]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
         public async Task<IActionResult> MergeWords(
             string projectId, [FromBody, BindRequired] List<MergeWords> mergeWordsList)
         {
@@ -58,6 +60,7 @@ public async Task<IActionResult> MergeWords(
         /// <returns> True if merge was successfully undone </returns>
         [HttpPut("undo", Name = "UndoMerge")]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(bool))]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
         public async Task<IActionResult> UndoMerge(string projectId, [FromBody, BindRequired] MergeUndoIds merge)
         {
             if (!await _permissionService.HasProjectPermission(
@@ -75,6 +78,7 @@ public async Task<IActionResult> UndoMerge(string projectId, [FromBody, BindRequ
         /// <returns> List of word ids added to blacklist. </returns>
         [HttpPut("blacklist/add", Name = "BlacklistAdd")]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(List<string>))]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
         public async Task<IActionResult> BlacklistAdd(string projectId, [FromBody, BindRequired] List<string> wordIds)
         {
             if (!await _permissionService.HasProjectPermission(
@@ -92,6 +96,7 @@ public async Task<IActionResult> BlacklistAdd(string projectId, [FromBody, BindR
         /// <returns> List of word ids added to graylist. </returns>
         [HttpPut("graylist/add", Name = "graylistAdd")]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(List<string>))]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
         public async Task<IActionResult> GraylistAdd(string projectId, [FromBody, BindRequired] List<string> wordIds)
         {
             if (!await _permissionService.HasProjectPermission(
@@ -111,6 +116,7 @@ public async Task<IActionResult> GraylistAdd(string projectId, [FromBody, BindRe
         /// <param name="maxLists"> Max number of lists of potential duplicates. </param>
         [HttpGet("finddups/{maxInList:int}/{maxLists:int}", Name = "FindPotentialDuplicates")]
         [ProducesResponseType(StatusCodes.Status200OK)]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
         public async Task<IActionResult> FindPotentialDuplicates(string projectId, int maxInList, int maxLists)
         {
             if (!await _permissionService.HasProjectPermission(
@@ -145,6 +151,7 @@ internal async Task<bool> GetDuplicatesThenSignal(string projectId, int maxInLis
         /// <returns> List of Lists of <see cref="Word"/>s, each sublist a set of potential duplicates. </returns>
         [HttpGet("retrievedups", Name = "RetrievePotentialDuplicates")]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(List<List<Word>>))]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
         public IActionResult RetrievePotentialDuplicates()
         {
             var userId = _permissionService.GetUserId(HttpContext);
@@ -157,6 +164,7 @@ public IActionResult RetrievePotentialDuplicates()
         /// <param name="userId"> Id of user whose merge graylist is to be used. </param>
         [HttpGet("hasgraylist/{userId}", Name = "HasGraylistEntries")]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(bool))]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
         public async Task<IActionResult> HasGraylistEntries(string projectId, string userId)
         {
             if (!await _permissionService.HasProjectPermission(
@@ -174,6 +182,7 @@ public async Task<IActionResult> HasGraylistEntries(string projectId, string use
         /// <returns> List of Lists of <see cref="Word"/>s. </returns>
         [HttpGet("getgraylist/{maxLists}/{userId}", Name = "GetGraylistEntries")]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(List<List<Word>>))]
+        [ProducesResponseType(StatusCodes.Status403Forbidden)]
         public async Task<IActionResult> GetGraylistEntries(
             string projectId, int maxLists, string userId)
         {