Fix sonar issues and add DMF tests for maintenance window feature (#655)

* Fix sonar issues. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * POM cleanup and more sonar issues fixed. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Remove unneeded JavaDocs. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * More sonar issues. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * More issues. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Adapt maintenance window to naming. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add DMF tests. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Readibility. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Typos fixed. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>
2018-03-08 10:42:25 +01:00
parent f4278c45ef
commit b4414438b0
32 changed files with 411 additions and 364 deletions
--- a/hawkbit-ddi-resource/src/main/java/org/eclipse/hawkbit/ddi/rest/resource/DdiRootController.java
+++ b/hawkbit-ddi-resource/src/main/java/org/eclipse/hawkbit/ddi/rest/resource/DdiRootController.java
@@ -146,8 +146,12 @@ public class DdiRootController implements DdiRootControllerRestApi {

        checkAndCancelExpiredAction(action);

-        return new ResponseEntity<>(DataConversionHelper.fromTarget(target, action,
-                controllerManagement.getPollingTimeForAction(action), tenantAware), HttpStatus.OK);
+        return new ResponseEntity<>(
+                DataConversionHelper.fromTarget(target, action,
+                        action == null ? controllerManagement.getPollingTime()
+                                : controllerManagement.getPollingTimeForAction(action.getId()),
+                        tenantAware),
+                HttpStatus.OK);
    }

    @Override
@@ -288,13 +292,9 @@ public class DdiRootController implements DdiRootControllerRestApi {
                    : new DdiActionHistory(action.getStatus().name(), actionHistoryMsgs);

            final HandlingType downloadType = action.isForce() ? HandlingType.FORCED : HandlingType.ATTEMPT;
-            final HandlingType updateType = action.hasMaintenanceSchedule()
-                    ? (action.isMaintenanceWindowAvailable() ? downloadType : HandlingType.SKIP) : downloadType;
+            final HandlingType updateType = calculateUpdateType(action, downloadType);

-            MaintenanceWindowStatus maintenanceWindow = action.hasMaintenanceSchedule()
-                    ? (action.isMaintenanceWindowAvailable() ? MaintenanceWindowStatus.AVAILABLE
-                            : MaintenanceWindowStatus.UNAVAILABLE)
-                    : null;
+            final MaintenanceWindowStatus maintenanceWindow = calculateMaintenanceWindow(action);

            final DdiDeploymentBase base = new DdiDeploymentBase(Long.toString(action.getId()),
                    new DdiDeployment(downloadType, updateType, chunks, maintenanceWindow), actionHistory);
@@ -310,6 +310,21 @@ public class DdiRootController implements DdiRootControllerRestApi {
        return ResponseEntity.notFound().build();
    }

+    private static MaintenanceWindowStatus calculateMaintenanceWindow(final Action action) {
+        if (action.hasMaintenanceSchedule()) {
+            return action.isMaintenanceWindowAvailable() ? MaintenanceWindowStatus.AVAILABLE
+                    : MaintenanceWindowStatus.UNAVAILABLE;
+        }
+        return null;
+    }
+
+    private static HandlingType calculateUpdateType(final Action action, final HandlingType downloadType) {
+        if (action.hasMaintenanceSchedule()) {
+            return action.isMaintenanceWindowAvailable() ? downloadType : HandlingType.SKIP;
+        }
+        return downloadType;
+    }
+
    @Override
    public ResponseEntity<Void> postBasedeploymentActionFeedback(@Valid @RequestBody final DdiActionFeedback feedback,
            @PathVariable("tenant") final String tenant, @PathVariable("controllerId") final String controllerId,
@@ -366,9 +381,8 @@ public class DdiRootController implements DdiRootControllerRestApi {
            status = handleClosedCase(feedback, controllerId, actionid, messages);
            break;
        case DOWNLOADED:
-            LOG.debug(
-                    "Controller confirmed download of distribution set (actionId: {}, controllerId: {}) as we got {} report.",
-                    actionid, controllerId, feedback.getStatus().getExecution());
+            LOG.debug("Controller confirmed download (actionId: {}, controllerId: {}) as we got {} report.", actionid,
+                    controllerId, feedback.getStatus().getExecution());
            status = Status.DOWNLOADED;
            messages.add(RepositoryConstants.SERVER_MESSAGE_PREFIX + "Target confirmed download of distribution set.");
            break;
--- a/hawkbit-ddi-resource/src/test/java/org/eclipse/hawkbit/ddi/rest/resource/DdiRootControllerTest.java
+++ b/hawkbit-ddi-resource/src/test/java/org/eclipse/hawkbit/ddi/rest/resource/DdiRootControllerTest.java
@@ -15,9 +15,8 @@ import static org.eclipse.hawkbit.im.authentication.SpPermission.SpringEvalExpre
 import static org.eclipse.hawkbit.im.authentication.SpPermission.SpringEvalExpressions.SYSTEM_ROLE;
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.Matchers.containsString;
-import static org.hamcrest.Matchers.hasItem;
-import static org.hamcrest.Matchers.greaterThan;
 import static org.hamcrest.Matchers.greaterThanOrEqualTo;
+import static org.hamcrest.Matchers.hasItem;
 import static org.hamcrest.Matchers.lessThan;
 import static org.hamcrest.Matchers.startsWith;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
@@ -45,7 +44,6 @@ import org.eclipse.hawkbit.repository.model.Target;
 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.AbstractIntegrationTest;
 import org.eclipse.hawkbit.repository.test.util.WithSpringAuthorityRule;
 import org.eclipse.hawkbit.repository.test.util.WithUser;
 import org.eclipse.hawkbit.rest.util.JsonBuilder;
@@ -505,7 +503,7 @@ public class DdiRootControllerTest extends AbstractDDiApiIntegrationTest {

    @Test
    @Description("Test the polling time based on different maintenance window start and end time.")
-    public void testSleepTimeResponseForDifferentMaintenanceWindowParameters() throws Exception {
+    public void sleepTimeResponseForDifferentMaintenanceWindowParameters() throws Exception {
        final DistributionSet ds = testdataFactory.createDistributionSet("");

        securityRule.runAs(WithSpringAuthorityRule.withUser("tenantadmin", HAS_AUTH_TENANT_CONFIGURATION), () -> {
@@ -516,38 +514,34 @@ public class DdiRootControllerTest extends AbstractDDiApiIntegrationTest {
            return null;
        });

-        Target savedTarget = testdataFactory.createTarget("1911");
-        assignDistributionSetWithMaintenanceWindow(ds.getId(), savedTarget.getControllerId(),
-                AbstractIntegrationTest.getTestSchedule(16), AbstractIntegrationTest.getTestDuration(10),
-                AbstractIntegrationTest.getTestTimeZone()).getAssignedEntity().iterator().next();
+        final Target savedTarget = testdataFactory.createTarget("1911");
+        assignDistributionSetWithMaintenanceWindow(ds.getId(), savedTarget.getControllerId(), getTestSchedule(16),
+                getTestDuration(10), getTestTimeZone()).getAssignedEntity().iterator().next();

        mvc.perform(get("/default-tenant/controller/v1/1911/")).andExpect(status().isOk())
                .andExpect(jsonPath("$.config.polling.sleep", greaterThanOrEqualTo("00:05:00")));

-        Target savedTarget1 = testdataFactory.createTarget("2911");
+        final Target savedTarget1 = testdataFactory.createTarget("2911");
        final DistributionSet ds1 = testdataFactory.createDistributionSet("1");
-        assignDistributionSetWithMaintenanceWindow(ds1.getId(), savedTarget1.getControllerId(),
-                AbstractIntegrationTest.getTestSchedule(10), AbstractIntegrationTest.getTestDuration(10),
-                AbstractIntegrationTest.getTestTimeZone()).getAssignedEntity().iterator().next();
+        assignDistributionSetWithMaintenanceWindow(ds1.getId(), savedTarget1.getControllerId(), getTestSchedule(10),
+                getTestDuration(10), getTestTimeZone()).getAssignedEntity().iterator().next();

        mvc.perform(get("/default-tenant/controller/v1/2911/")).andExpect(status().isOk())
                .andExpect(jsonPath("$.config.polling.sleep", lessThan("00:05:00")))
                .andExpect(jsonPath("$.config.polling.sleep", greaterThanOrEqualTo("00:03:00")));

-        Target savedTarget2 = testdataFactory.createTarget("3911");
+        final Target savedTarget2 = testdataFactory.createTarget("3911");
        final DistributionSet ds2 = testdataFactory.createDistributionSet("2");
-        assignDistributionSetWithMaintenanceWindow(ds2.getId(), savedTarget2.getControllerId(),
-                AbstractIntegrationTest.getTestSchedule(5), AbstractIntegrationTest.getTestDuration(5),
-                AbstractIntegrationTest.getTestTimeZone()).getAssignedEntity().iterator().next();
+        assignDistributionSetWithMaintenanceWindow(ds2.getId(), savedTarget2.getControllerId(), getTestSchedule(5),
+                getTestDuration(5), getTestTimeZone()).getAssignedEntity().iterator().next();

        mvc.perform(get("/default-tenant/controller/v1/3911/")).andExpect(status().isOk())
                .andExpect(jsonPath("$.config.polling.sleep", lessThan("00:02:00")));

-        Target savedTarget3 = testdataFactory.createTarget("4911");
+        final Target savedTarget3 = testdataFactory.createTarget("4911");
        final DistributionSet ds3 = testdataFactory.createDistributionSet("3");
-        assignDistributionSetWithMaintenanceWindow(ds3.getId(), savedTarget3.getControllerId(),
-                AbstractIntegrationTest.getTestSchedule(-5), AbstractIntegrationTest.getTestDuration(15),
-                AbstractIntegrationTest.getTestTimeZone()).getAssignedEntity().iterator().next();
+        assignDistributionSetWithMaintenanceWindow(ds3.getId(), savedTarget3.getControllerId(), getTestSchedule(-5),
+                getTestDuration(15), getTestTimeZone()).getAssignedEntity().iterator().next();

        mvc.perform(get("/default-tenant/controller/v1/4911/")).andExpect(status().isOk())
                .andExpect(jsonPath("$.config.polling.sleep", equalTo("00:05:00")));
@@ -556,12 +550,11 @@ public class DdiRootControllerTest extends AbstractDDiApiIntegrationTest {

    @Test
    @Description("Test download and update values before maintenance window start time.")
-    public void testDownloadAndUpdateStatusBeforeMaintenaceWindowStartTime() throws Exception {
+    public void downloadAndUpdateStatusBeforeMaintenanceWindowStartTime() throws Exception {
        Target savedTarget = testdataFactory.createTarget("1911");
        final DistributionSet ds = testdataFactory.createDistributionSet("");
        savedTarget = assignDistributionSetWithMaintenanceWindow(ds.getId(), savedTarget.getControllerId(),
-                AbstractIntegrationTest.getTestSchedule(2), AbstractIntegrationTest.getTestDuration(1),
-                AbstractIntegrationTest.getTestTimeZone()).getAssignedEntity().iterator().next();
+                getTestSchedule(2), getTestDuration(1), getTestTimeZone()).getAssignedEntity().iterator().next();

        mvc.perform(get("/default-tenant/controller/v1/1911/")).andExpect(status().isOk());

@@ -576,12 +569,11 @@ public class DdiRootControllerTest extends AbstractDDiApiIntegrationTest {

    @Test
    @Description("Test download and update values after maintenance window start time.")
-    public void testDownloadAndUpdateStatusDuringMaintenaceWindow() throws Exception {
+    public void downloadAndUpdateStatusDuringMaintenanceWindow() throws Exception {
        Target savedTarget = testdataFactory.createTarget("1911");
        final DistributionSet ds = testdataFactory.createDistributionSet("");
        savedTarget = assignDistributionSetWithMaintenanceWindow(ds.getId(), savedTarget.getControllerId(),
-                AbstractIntegrationTest.getTestSchedule(-5), AbstractIntegrationTest.getTestDuration(10),
-                AbstractIntegrationTest.getTestTimeZone()).getAssignedEntity().iterator().next();
+                getTestSchedule(-5), getTestDuration(10), getTestTimeZone()).getAssignedEntity().iterator().next();

        mvc.perform(get("/default-tenant/controller/v1/1911/")).andExpect(status().isOk());