Pivotal ID # 182595703: Submission Suppressing Workflow (#718)

Change wording from "un-releasing" to "suppress"
EBIBioStudies · Jun 2, 2023 · 290ca9b · 290ca9b
1 parent 594585b
commit 290ca9b
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 25 deletions.
diff --git a/...urity/src/main/kotlin/ebi/ac/uk/security/integration/components/IUserPrivilegesService.kt b/...urity/src/main/kotlin/ebi/ac/uk/security/integration/components/IUserPrivilegesService.kt
@@ -19,5 +19,5 @@ interface IUserPrivilegesService {
 
     fun canRelease(email: String): Boolean
 
-    fun canUnrelease(email: String): Boolean
+    fun canSuppress(email: String): Boolean
 }
diff --git a/...n/submission-security/src/main/kotlin/ebi/ac/uk/security/service/UserPrivilegesService.kt b/...n/submission-security/src/main/kotlin/ebi/ac/uk/security/service/UserPrivilegesService.kt
@@ -52,7 +52,7 @@ internal class UserPrivilegesService(
 
     override fun canRelease(email: String): Boolean = isSuperUser(email)
 
-    override fun canUnrelease(email: String): Boolean = isSuperUser(email)
+    override fun canSuppress(email: String): Boolean = isSuperUser(email)
 
     private fun hasPermissions(user: String, accessTags: List<String>, accessType: AccessType): Boolean {
         val tags = accessTags.filter { it != PUBLIC_ACCESS_TAG.value }

diff --git a/...bmission-security/src/test/kotlin/ebi/ac/uk/security/service/UserPrivilegesServiceTest.kt b/...bmission-security/src/test/kotlin/ebi/ac/uk/security/service/UserPrivilegesServiceTest.kt
@@ -171,14 +171,14 @@ class UserPrivilegesServiceTest(
     }
 
     @Test
-    fun `super user unrelease`() {
-        assertThat(testInstance.canUnrelease("superuser@mail.com")).isTrue
+    fun `super user suppress`() {
+        assertThat(testInstance.canSuppress("superuser@mail.com")).isTrue
     }
 
     @Test
-    fun `regular user unrelease`() {
+    fun `regular user suppress`() {
         every { superuser.superuser } returns false
-        assertThat(testInstance.canUnrelease("superuser@mail.com")).isFalse
+        assertThat(testInstance.canSuppress("superuser@mail.com")).isFalse
     }
 
     private fun initUsers() {

diff --git a/...app/src/itest/kotlin/ac/uk/ebi/biostd/itest/test/submission/submit/ResubmissionApiTest.kt b/...app/src/itest/kotlin/ac/uk/ebi/biostd/itest/test/submission/submit/ResubmissionApiTest.kt
@@ -189,7 +189,7 @@ class ResubmissionApiTest(
     }
 
     @Test
-    fun `5-4 regular user un-releases own submission`() {
+    fun `5-4 regular user suppresses own submission`() {
         val version1 = tsv {
             line("Submission", "S-RSTST4")
             line("Title", "Public Submission")
@@ -208,7 +208,7 @@ class ResubmissionApiTest(
 
         val version2 = tsv {
             line("Submission", "S-RSTST4")
-            line("Title", "Unreleased Submission")
+            line("Title", "Suppressed Submission")
             line("ReleaseDate", "2050-05-22")
             line()
             line("Study")
@@ -217,11 +217,11 @@ class ResubmissionApiTest(
 
         assertThatExceptionOfType(WebClientException::class.java)
             .isThrownBy { getWebClient(serverPort, RegularUser).submitSingle(version2, TSV) }
-            .withMessageContaining("The user {$regularUser} is not allowed to un-release the submission S-RSTST4")
+            .withMessageContaining("The user {$regularUser} is not allowed to suppress the submission S-RSTST4")
     }
 
     @Test
-    fun `5-5 super user un-releases submission from another user`() {
+    fun `5-5 super user suppresses submission from another user`() {
         val version1 = tsv {
             line("Submission", "S-RSTST5")
             line("Title", "Public Submission")
@@ -239,7 +239,7 @@ class ResubmissionApiTest(
 
         val version2 = tsv {
             line("Submission", "S-RSTST5")
-            line("Title", "Unreleased Submission")
+            line("Title", "Suppressed Submission")
             line("ReleaseDate", "2050-05-22")
             line()
             line("Study")

diff --git a/...ission/submission-webapp/src/itest/resources/itestsInventory/itestsInventory.md b/...ission/submission-webapp/src/itest/resources/itestsInventory/itestsInventory.md
@@ -25,8 +25,8 @@
 | ResubmissionApiTest             | 5-1     | resubmit existing submission                                          | Shows the system behaves when resubmissions occurs                                                              |
 | ResubmissionApiTest             | 5-2     | resubmit existing submission with the same files                      |                                                                                                                 |
 | ResubmissionApiTest             | 5-3     | re submit a submission with rootPath                                  |                                                                                                                 |
-| ResubmissionApiTest             | 5-4     | regular user un-releases own submission                               | Verifies that a regular user can't un-release (become private) a submission that's already released             |
-| ResubmissionApiTest             | 5-5     | super user un-releases submission from another user                   | Verifies that a super user ca un-release (become private) a submission that's already released                  |
+| ResubmissionApiTest             | 5-4     | regular user suppresses own submission                                | Verifies that a regular user can't suppress (become private) a submission that's already released               |
+| ResubmissionApiTest             | 5-5     | super user suppresses submission from another user                    | Verifies that a super user ca suppress (become private) a submission that's already released                    |
 | SubmissionFileSourceTest        | 6-1     | resubmission with SUBMISSION file source as priority over USER\_SPACE | Considers submission with different source files, user space, fire, bypassing files with fire                   |
 | SubmissionFileSourceTest        | 6-2     | submission with FIRE source only                                      |                                                                                                                 |
 | SubmissionFileSourceTest        | 6-3     | submission with directory with files on FIRE                          |                                                                                                                 |

diff --git a/...ter/src/main/kotlin/ac/uk/ebi/biostd/submission/exceptions/InvalidPermissionsException.kt b/...ter/src/main/kotlin/ac/uk/ebi/biostd/submission/exceptions/InvalidPermissionsException.kt
@@ -33,7 +33,7 @@ class UserCanNotRelease(
     user: String
 ) : InvalidPermissionsException("The user {$user} is not allowed to release the submission $accNo")
 
-class UserCanNotUnrelease(
+class UserCanNotSuppress(
     accNo: String,
     user: String
-) : InvalidPermissionsException("The user {$user} is not allowed to un-release the submission $accNo")
+) : InvalidPermissionsException("The user {$user} is not allowed to suppress the submission $accNo")
diff --git a/submission/submitter/src/main/kotlin/ac/uk/ebi/biostd/submission/service/TimesService.kt b/submission/submitter/src/main/kotlin/ac/uk/ebi/biostd/submission/service/TimesService.kt
@@ -2,7 +2,7 @@ package ac.uk.ebi.biostd.submission.service
 
 import ac.uk.ebi.biostd.submission.exceptions.InvalidDateFormatException
 import ac.uk.ebi.biostd.submission.exceptions.PastReleaseDateException
-import ac.uk.ebi.biostd.submission.exceptions.UserCanNotUnrelease
+import ac.uk.ebi.biostd.submission.exceptions.UserCanNotSuppress
 import ac.uk.ebi.biostd.submission.model.SubmitRequest
 import ebi.ac.uk.base.orFalse
 import ebi.ac.uk.model.extensions.releaseDate
@@ -43,12 +43,12 @@ class TimesService(
 
         return when {
             releaseTime.isBefore(today) -> throw PastReleaseDateException()
-            releaseTime.isAfter(today) && isReleased && cantUnrelease(user) -> throw UserCanNotUnrelease(accNo, user)
+            releaseTime.isAfter(today) && isReleased && cantSuppress(user) -> throw UserCanNotSuppress(accNo, user)
             else -> releaseTime
         }
     }
 
-    private fun cantUnrelease(user: String) = privilegesService.canUnrelease(user).not()
+    private fun cantSuppress(user: String) = privilegesService.canSuppress(user).not()
 
     private fun parseDate(date: String): OffsetDateTime =
         runCatching { LocalDate.parse(date) }

diff --git a/submission/submitter/src/test/kotlin/ac/uk/ebi/biostd/submission/service/TimesServiceTest.kt b/submission/submitter/src/test/kotlin/ac/uk/ebi/biostd/submission/service/TimesServiceTest.kt
@@ -2,7 +2,7 @@ package ac.uk.ebi.biostd.submission.service
 
 import ac.uk.ebi.biostd.submission.exceptions.InvalidDateFormatException
 import ac.uk.ebi.biostd.submission.exceptions.PastReleaseDateException
-import ac.uk.ebi.biostd.submission.exceptions.UserCanNotUnrelease
+import ac.uk.ebi.biostd.submission.exceptions.UserCanNotSuppress
 import ac.uk.ebi.biostd.submission.model.SubmitRequest
 import ebi.ac.uk.model.extensions.releaseDate
 import ebi.ac.uk.security.integration.components.IUserPrivilegesService
@@ -118,22 +118,22 @@ class TimesServiceTest(
         }
 
         @Test
-        fun `when submitter cant unrelease`() {
+        fun `when submitter cant suppress`() {
             every { request.previousVersion?.released } returns true
-            every { privilegesService.canUnrelease("user@test.org") } returns false
+            every { privilegesService.canSuppress("user@test.org") } returns false
             every { request.submission.releaseDate } returns "2020-10-10T09:27:04.000Z"
 
-            val error = assertThrows<UserCanNotUnrelease> { testInstance.getTimes(request) }
+            val error = assertThrows<UserCanNotSuppress> { testInstance.getTimes(request) }
             assertThat(error.message)
-                .isEqualTo("The user {user@test.org} is not allowed to un-release the submission S-BSST1")
+                .isEqualTo("The user {user@test.org} is not allowed to suppress the submission S-BSST1")
         }
 
         @Test
-        fun `when submitter can unrelease`() {
+        fun `when submitter can suppress`() {
             val releaseTime = OffsetDateTime.of(2020, 10, 10, 0, 0, 0, 0, UTC)
 
             every { request.previousVersion?.released } returns true
-            every { privilegesService.canUnrelease("user@test.org") } returns true
+            every { privilegesService.canSuppress("user@test.org") } returns true
             every { request.submission.releaseDate } returns "2020-10-10T09:27:04.000Z"
 
             val times = testInstance.getTimes(request)