Remove WithSpringContextRule (#1505)

Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
eclipse-hawkbit · Dec 7, 2023 · 1ae72d4 · 1ae72d4
1 parent aa1bad9
commit 1ae72d4
Show file tree

Hide file tree

Showing 16 changed files with 69 additions and 103 deletions.
diff --git a/...mqp/src/test/java/org/eclipse/hawkbit/integration/AbstractAmqpServiceIntegrationTest.java b/...mqp/src/test/java/org/eclipse/hawkbit/integration/AbstractAmqpServiceIntegrationTest.java
@@ -50,7 +50,7 @@
 import org.eclipse.hawkbit.repository.model.TargetUpdateStatus;
 import org.eclipse.hawkbit.repository.test.TestConfiguration;
 import org.eclipse.hawkbit.repository.test.util.TestdataFactory;
-import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
+import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.eclipse.hawkbit.util.IpUtil;
 import org.junit.jupiter.api.BeforeEach;
 import org.mockito.Mockito;
@@ -102,10 +102,10 @@ public void initListener() {
     protected <T> T waitUntilIsPresent(final Callable<Optional<T>> callable) {
 
         createConditionFactory()
-                .until(() -> WithSpringAuthorityRule.runAsPrivileged(() -> callable.call().isPresent()));
+                .until(() -> SecurityContextSwitch.runAsPrivileged(() -> callable.call().isPresent()));
 
         try {
-            return WithSpringAuthorityRule.runAsPrivileged(() -> callable.call().get());
+            return SecurityContextSwitch.runAsPrivileged(() -> callable.call().get());
         } catch (final Exception e) {
             return null;
         }
@@ -429,7 +429,7 @@ protected void assertUpdateAttributes(final String controllerId, final Map<Strin
 
         createConditionFactory().untilAsserted(() -> {
             try {
-                final Map<String, String> controllerAttributes = WithSpringAuthorityRule
+                final Map<String, String> controllerAttributes = SecurityContextSwitch
                         .runAsPrivileged(() -> targetManagement.getControllerAttributes(controllerId));
                 assertThat(controllerAttributes.size()).isEqualTo(attributes.size());
                 assertThat(controllerAttributes).containsAllEntriesOf(attributes);

diff --git a/...est/java/org/eclipse/hawkbit/integration/AmqpMessageDispatcherServiceIntegrationTest.java b/...est/java/org/eclipse/hawkbit/integration/AmqpMessageDispatcherServiceIntegrationTest.java
@@ -72,7 +72,7 @@
 import org.eclipse.hawkbit.repository.model.TargetUpdateStatus;
 import org.eclipse.hawkbit.repository.test.matcher.Expect;
 import org.eclipse.hawkbit.repository.test.matcher.ExpectEvents;
-import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
+import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.EnumSource;
@@ -565,7 +565,7 @@ private void waitUntilTargetHasStatus(final String controllerId, final TargetUpd
     }
 
     private void waitUntil(final Callable<Boolean> callable) {
-        createConditionFactory().until(() -> WithSpringAuthorityRule.runAsPrivileged(callable));
+        createConditionFactory().until(() -> SecurityContextSwitch.runAsPrivileged(callable));
     }
 
     private void assertLatestMultiActionMessageContainsInstallMessages(final String controllerId,

diff --git a/...c/test/java/org/eclipse/hawkbit/integration/AmqpMessageHandlerServiceIntegrationTest.java b/...c/test/java/org/eclipse/hawkbit/integration/AmqpMessageHandlerServiceIntegrationTest.java
@@ -63,7 +63,7 @@
 import org.eclipse.hawkbit.repository.test.matcher.Expect;
 import org.eclipse.hawkbit.repository.test.matcher.ExpectEvents;
 import org.eclipse.hawkbit.repository.test.util.TargetTestData;
-import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
+import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.NullSource;
@@ -941,7 +941,7 @@ private void registerTargetAndSendAndAssertUpdateActionStatus(final DmfActionSta
     private void assertAction(final Long actionId, final int messages, final Status... expectedActionStates) {
         createConditionFactory().await().untilAsserted(() -> {
             try {
-                WithSpringAuthorityRule.runAsPrivileged(() -> {
+                SecurityContextSwitch.runAsPrivileged(() -> {
                     final List<ActionStatus> actionStatusList = deploymentManagement
                             .findActionStatusByAction(PAGE, actionId).getContent();
 
@@ -979,7 +979,7 @@ private void assertActionStatusList(final Long actionId, final int statusListCou
             final Status... expectedActionStates) {
         createConditionFactory().await().untilAsserted(() -> {
             try {
-                WithSpringAuthorityRule.runAsPrivileged(() -> {
+                SecurityContextSwitch.runAsPrivileged(() -> {
                     final List<ActionStatus> actionStatusList = deploymentManagement
                             .findActionStatusByAction(PAGE, actionId).getContent();
                     assertThat(actionStatusList).hasSize(statusListCount);

diff --git a/...a/src/test/java/org/eclipse/hawkbit/repository/jpa/management/ArtifactManagementTest.java b/...a/src/test/java/org/eclipse/hawkbit/repository/jpa/management/ArtifactManagementTest.java
@@ -50,7 +50,7 @@
 import org.eclipse.hawkbit.repository.test.matcher.Expect;
 import org.eclipse.hawkbit.repository.test.matcher.ExpectEvents;
 import org.eclipse.hawkbit.repository.test.util.HashGeneratorUtils;
-import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
+import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.eclipse.hawkbit.repository.test.util.WithUser;
 import org.junit.jupiter.api.Test;
 
@@ -612,7 +612,7 @@ private static byte[] randomBytes(final int len) {
     }
 
     private <T> T runAsTenant(final String tenant, final Callable<T> callable) throws Exception {
-        return WithSpringAuthorityRule.runAs(WithSpringAuthorityRule.withUserAndTenant("user", tenant), callable);
+        return SecurityContextSwitch.runAs(SecurityContextSwitch.withUserAndTenant("user", tenant), callable);
     }
 
     private SoftwareModule createSoftwareModuleForTenant(final String tenant) throws Exception {

diff --git a/...src/test/java/org/eclipse/hawkbit/repository/jpa/management/ControllerManagementTest.java b/...src/test/java/org/eclipse/hawkbit/repository/jpa/management/ControllerManagementTest.java
@@ -76,7 +76,7 @@
 import org.eclipse.hawkbit.repository.test.matcher.Expect;
 import org.eclipse.hawkbit.repository.test.matcher.ExpectEvents;
 import org.eclipse.hawkbit.repository.test.util.TargetTestData;
-import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
+import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -844,7 +844,7 @@ void updateTargetAttributes() throws Exception {
         final String controllerId = "test123";
         final Target target = testdataFactory.createTarget(controllerId);
 
-        WithSpringAuthorityRule.runAs(WithSpringAuthorityRule.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
+        SecurityContextSwitch.runAs(SecurityContextSwitch.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
             addAttributeAndVerify(controllerId);
             addSecondAttributeAndVerify(controllerId);
             updateAttributeAndVerify(controllerId);
@@ -999,8 +999,8 @@ public void updateTargetAttributesFailsIfTooManyEntries() throws Exception {
         final int allowedAttributes = quotaManagement.getMaxAttributeEntriesPerTarget();
         testdataFactory.createTarget(controllerId);
 
-        assertThatExceptionOfType(AssignmentQuotaExceededException.class).isThrownBy(() -> WithSpringAuthorityRule
-                .runAs(WithSpringAuthorityRule.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
+        assertThatExceptionOfType(AssignmentQuotaExceededException.class).isThrownBy(() -> SecurityContextSwitch
+                .runAs(SecurityContextSwitch.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
                     writeAttributes(controllerId, allowedAttributes + 1, "key", "value");
                     return null;
                 })).withMessageContaining("" + allowedAttributes);
@@ -1010,16 +1010,16 @@ public void updateTargetAttributesFailsIfTooManyEntries() throws Exception {
 
         // Write allowed number of attributes twice with same key should result
         // in update but work
-        WithSpringAuthorityRule.runAs(WithSpringAuthorityRule.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
+        SecurityContextSwitch.runAs(SecurityContextSwitch.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
             writeAttributes(controllerId, allowedAttributes, "key", "value1");
             writeAttributes(controllerId, allowedAttributes, "key", "value2");
             return null;
         });
         assertThat(targetManagement.getControllerAttributes(controllerId)).hasSize(10);
 
         // Now rite one more
-        assertThatExceptionOfType(AssignmentQuotaExceededException.class).isThrownBy(() -> WithSpringAuthorityRule
-                .runAs(WithSpringAuthorityRule.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
+        assertThatExceptionOfType(AssignmentQuotaExceededException.class).isThrownBy(() -> SecurityContextSwitch
+                .runAs(SecurityContextSwitch.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
                     writeAttributes(controllerId, 1, "additional", "value1");
                     return null;
                 })).withMessageContaining("" + allowedAttributes);
@@ -1075,8 +1075,8 @@ public void controllerProvidesIntermediateFeedbackFailsIfQuotaHit() {
         final Long actionId = createTargetAndAssignDs();
 
         // Fails as one entry is already in there from the assignment
-        assertThatExceptionOfType(AssignmentQuotaExceededException.class).isThrownBy(() -> WithSpringAuthorityRule
-                .runAs(WithSpringAuthorityRule.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
+        assertThatExceptionOfType(AssignmentQuotaExceededException.class).isThrownBy(() -> SecurityContextSwitch
+                .runAs(SecurityContextSwitch.withController("controller", CONTROLLER_ROLE_ANONYMOUS), () -> {
                     writeStatus(actionId, allowStatusEntries);
                     return null;
                 })).withMessageContaining("" + allowStatusEntries);

diff --git a/...pa/src/test/java/org/eclipse/hawkbit/repository/jpa/management/RolloutManagementTest.java b/...pa/src/test/java/org/eclipse/hawkbit/repository/jpa/management/RolloutManagementTest.java
@@ -81,7 +81,7 @@
 import org.eclipse.hawkbit.repository.model.TotalTargetCountStatus;
 import org.eclipse.hawkbit.repository.test.matcher.Expect;
 import org.eclipse.hawkbit.repository.test.matcher.ExpectEvents;
-import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
+import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.eclipse.hawkbit.tenancy.configuration.TenantConfigurationProperties.TenantConfigurationKey;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -2224,7 +2224,7 @@ private static Map<TotalTargetCountStatus.Status, Long> createInitStatusMap() {
 
     private void awaitRunningState(final Long myRolloutId) {
         Awaitility.await().atMost(Duration.ofSeconds(10)).pollInterval(Duration.ofMillis(500)).with()
-                .until(() -> WithSpringAuthorityRule
+                .until(() -> SecurityContextSwitch
                         .runAsPrivileged(
                                 () -> rolloutManagement.get(myRolloutId).orElseThrow(NoSuchElementException::new))
                         .getStatus().equals(RolloutStatus.RUNNING));

diff --git a/...jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/management/SystemManagementTest.java b/...jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/management/SystemManagementTest.java
@@ -23,7 +23,7 @@
 import org.eclipse.hawkbit.repository.model.Target;
 import org.eclipse.hawkbit.repository.report.model.TenantUsage;
 import org.eclipse.hawkbit.repository.test.util.DisposableSqlTestDatabaseExtension;
-import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
+import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 
@@ -117,7 +117,7 @@ private byte[] createTestTenantsForSystemStatistics(final int tenants, final int
 
         for (int i = 0; i < tenants; i++) {
             final String tenantname = "tenant" + i;
-            WithSpringAuthorityRule.runAs(WithSpringAuthorityRule.withUserAndTenant("bumlux", tenantname, true, true, false,
+            SecurityContextSwitch.runAs(SecurityContextSwitch.withUserAndTenant("bumlux", tenantname, true, true, false,
                     SpringEvalExpressions.SYSTEM_ROLE), () -> {
                         systemManagement.getTenantMetadata(tenantname);
                         if (artifactSize > 0) {

diff --git a/...jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/management/TargetManagementTest.java b/...jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/management/TargetManagementTest.java
@@ -68,7 +68,7 @@
 import org.eclipse.hawkbit.repository.model.TargetTypeAssignmentResult;
 import org.eclipse.hawkbit.repository.test.matcher.Expect;
 import org.eclipse.hawkbit.repository.test.matcher.ExpectEvents;
-import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
+import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.eclipse.hawkbit.repository.test.util.WithUser;
 import org.junit.jupiter.api.Test;
 import org.springframework.data.domain.Page;
@@ -183,16 +183,16 @@ void getTargetSecurityTokenOnlyWithCorrectPermission() throws Exception {
                 .create(entityFactory.target().create().controllerId("targetWithSecurityToken").securityToken("token"));
 
         // retrieve security token only with READ_TARGET_SEC_TOKEN permission
-        final String securityTokenWithReadPermission = WithSpringAuthorityRule.runAs(
-                WithSpringAuthorityRule.withUser("OnlyTargetReadPermission", false, SpPermission.READ_TARGET_SEC_TOKEN),
+        final String securityTokenWithReadPermission = SecurityContextSwitch.runAs(
+                SecurityContextSwitch.withUser("OnlyTargetReadPermission", false, SpPermission.READ_TARGET_SEC_TOKEN),
                 createdTarget::getSecurityToken);
 
         // retrieve security token as system code execution
         final String securityTokenAsSystemCode = systemSecurityContext.runAsSystem(createdTarget::getSecurityToken);
 
         // retrieve security token without any permissions
-        final String securityTokenWithoutPermission = WithSpringAuthorityRule
-                .runAs(WithSpringAuthorityRule.withUser("NoPermission", false), createdTarget::getSecurityToken);
+        final String securityTokenWithoutPermission = SecurityContextSwitch
+                .runAs(SecurityContextSwitch.withUser("NoPermission", false), createdTarget::getSecurityToken);
 
         assertThat(createdTarget.getSecurityToken()).isEqualTo("token");
         assertThat(securityTokenWithReadPermission).isNotNull();
@@ -871,7 +871,7 @@ void targetCanBeReadWithOnlyReadTargetPermission() throws Exception {
         final String knownTargetControllerId = "readTarget";
         controllerManagement.findOrRegisterTargetIfItDoesNotExist(knownTargetControllerId, new URI("http://127.0.0.1"));
 
-        WithSpringAuthorityRule.runAs(WithSpringAuthorityRule.withUser("bumlux", "READ_TARGET"), () -> {
+        SecurityContextSwitch.runAs(SecurityContextSwitch.withUser("bumlux", "READ_TARGET"), () -> {
             final Target findTargetByControllerID = targetManagement.getByControllerID(knownTargetControllerId)
                     .orElseThrow(IllegalStateException::new);
             assertThat(findTargetByControllerID).isNotNull();

diff --git a/...-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/tenancy/MultiTenancyEntityTest.java b/...-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/tenancy/MultiTenancyEntityTest.java
@@ -21,7 +21,7 @@
 import org.eclipse.hawkbit.repository.model.DistributionSet;
 import org.eclipse.hawkbit.repository.model.Target;
 import org.eclipse.hawkbit.repository.test.util.DisposableSqlTestDatabaseExtension;
-import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
+import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.eclipse.hawkbit.repository.test.util.WithUser;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -115,7 +115,7 @@ public void getTenanatMetdata() throws Exception {
         // check that the cache is not getting in the way, i.e. "bumlux" results
         // in bumlux and not
         // mytenant
-        assertThat(WithSpringAuthorityRule.runAs(WithSpringAuthorityRule.withUserAndTenant("user", "bumlux"),
+        assertThat(SecurityContextSwitch.runAs(SecurityContextSwitch.withUserAndTenant("user", "bumlux"),
                 () -> systemManagement.getTenantMetadata().getTenant().toUpperCase()))
                         .isEqualTo("bumlux".toUpperCase());
     }
@@ -169,7 +169,7 @@ public void createMultipleDistributionSetsWithSameNameForDifferentTenants() thro
     }
 
     private <T> T runAsTenant(final String tenant, final Callable<T> callable) throws Exception {
-        return WithSpringAuthorityRule.runAs(WithSpringAuthorityRule.withUserAndTenant("user", tenant), callable);
+        return SecurityContextSwitch.runAs(SecurityContextSwitch.withUserAndTenant("user", tenant), callable);
     }
 
     private Target createTargetForTenant(final String controllerId, final String tenant) throws Exception {

diff --git a/...-test/src/main/java/org/eclipse/hawkbit/repository/test/util/AbstractIntegrationTest.java b/...-test/src/main/java/org/eclipse/hawkbit/repository/test/util/AbstractIntegrationTest.java
@@ -92,7 +92,7 @@
 import org.springframework.test.context.TestPropertySource;
 
 @ActiveProfiles({ "test" })
-@ExtendWith({ JUnitTestLoggerExtension.class, WithSpringAuthorityRule.class , SharedSqlTestDatabaseExtension.class })
+@ExtendWith({ JUnitTestLoggerExtension.class , SharedSqlTestDatabaseExtension.class })
 @WithUser(principal = "bumlux", allSpPermissions = true, authorities = { CONTROLLER_ROLE, SYSTEM_ROLE })
 @SpringBootTest
 @ContextConfiguration(classes = { TestConfiguration.class, TestSupportBinderAutoConfiguration.class })
@@ -391,22 +391,22 @@ public void beforeAll() throws Exception {
 
         final String description = "Updated description.";
 
-        osType = WithSpringAuthorityRule
+        osType = SecurityContextSwitch
                 .runAsPrivileged(() -> testdataFactory.findOrCreateSoftwareModuleType(TestdataFactory.SM_TYPE_OS));
-        osType = WithSpringAuthorityRule.runAsPrivileged(() -> softwareModuleTypeManagement
+        osType = SecurityContextSwitch.runAsPrivileged(() -> softwareModuleTypeManagement
                 .update(entityFactory.softwareModuleType().update(osType.getId()).description(description)));
 
-        appType = WithSpringAuthorityRule.runAsPrivileged(
+        appType = SecurityContextSwitch.runAsPrivileged(
                 () -> testdataFactory.findOrCreateSoftwareModuleType(TestdataFactory.SM_TYPE_APP, Integer.MAX_VALUE));
-        appType = WithSpringAuthorityRule.runAsPrivileged(() -> softwareModuleTypeManagement
+        appType = SecurityContextSwitch.runAsPrivileged(() -> softwareModuleTypeManagement
                 .update(entityFactory.softwareModuleType().update(appType.getId()).description(description)));
 
-        runtimeType = WithSpringAuthorityRule
+        runtimeType = SecurityContextSwitch
                 .runAsPrivileged(() -> testdataFactory.findOrCreateSoftwareModuleType(TestdataFactory.SM_TYPE_RT));
-        runtimeType = WithSpringAuthorityRule.runAsPrivileged(() -> softwareModuleTypeManagement
+        runtimeType = SecurityContextSwitch.runAsPrivileged(() -> softwareModuleTypeManagement
                 .update(entityFactory.softwareModuleType().update(runtimeType.getId()).description(description)));
 
-        standardDsType = WithSpringAuthorityRule.runAsPrivileged(() -> testdataFactory.findOrCreateDefaultTestDsType());
+        standardDsType = SecurityContextSwitch.runAsPrivileged(() -> testdataFactory.findOrCreateDefaultTestDsType());
 
         // publish the reset counter market event to reset the counters after
         // setup. The setup is transparent by the test and its @ExpectedEvent

diff --git a/.../src/main/java/org/eclipse/hawkbit/repository/test/util/CleanupTestExecutionListener.java b/.../src/main/java/org/eclipse/hawkbit/repository/test/util/CleanupTestExecutionListener.java
@@ -25,7 +25,7 @@ public class CleanupTestExecutionListener extends AbstractTestExecutionListener
 
     @Override
     public void afterTestMethod(final TestContext testContext) throws Exception {
-        WithSpringAuthorityRule.runAsPrivileged(() -> {
+        SecurityContextSwitch.runAsPrivileged(() -> {
             final ApplicationContext applicationContext = testContext.getApplicationContext();
             new JpaTestRepositoryManagement(applicationContext.getBean(TenantAwareCacheManager.class),
                     applicationContext.getBean(SystemSecurityContext.class),