Add REST method for update rollout (#1749)

* adds PUT method for updating name and description of a rollout * restrict RolloutUpdate to changing only name and description * small refactoring Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
2024-06-24 09:16:39 +03:00
parent 297775f539
commit 40f99962d2
20 changed files with 321 additions and 343 deletions
--- a/hawkbit-rest/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtRolloutMapper.java
+++ b/hawkbit-rest/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtRolloutMapper.java
@@ -22,7 +22,8 @@ import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutCondition.Conditio
 import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutErrorAction;
 import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutErrorAction.ErrorAction;
 import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutResponseBody;
-import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutRestRequestBody;
+import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutRestRequestBodyPost;
+import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutRestRequestBodyPut;
 import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutSuccessAction;
 import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutSuccessAction.SuccessAction;
 import org.eclipse.hawkbit.mgmt.json.model.rolloutgroup.MgmtRolloutGroup;
@@ -33,6 +34,7 @@ import org.eclipse.hawkbit.mgmt.rest.api.MgmtRolloutRestApi;
 import org.eclipse.hawkbit.repository.EntityFactory;
 import org.eclipse.hawkbit.repository.builder.RolloutCreate;
 import org.eclipse.hawkbit.repository.builder.RolloutGroupCreate;
+import org.eclipse.hawkbit.repository.builder.RolloutUpdate;
 import org.eclipse.hawkbit.repository.model.DistributionSet;
 import org.eclipse.hawkbit.repository.model.Rollout;
 import org.eclipse.hawkbit.repository.model.RolloutGroup;
@@ -123,22 +125,30 @@ final class MgmtRolloutMapper {
        return body;
    }

-    static RolloutCreate fromRequest(final EntityFactory entityFactory, final MgmtRolloutRestRequestBody restRequest,
+    static RolloutCreate fromRequest(final EntityFactory entityFactory, final MgmtRolloutRestRequestBodyPost restRequest,
            final DistributionSet distributionSet) {
-
-        return entityFactory.rollout().create().name(restRequest.getName()).description(restRequest.getDescription())
-                .dynamic(restRequest.isDynamic())
-                .set(distributionSet).targetFilterQuery(restRequest.getTargetFilterQuery())
+        return entityFactory.rollout().create()
+                .name(restRequest.getName())
+                .description(restRequest.getDescription())
+                .distributionSetId(distributionSet)
+                .targetFilterQuery(restRequest.getTargetFilterQuery())
                .actionType(MgmtRestModelMapper.convertActionType(restRequest.getType()))
                .forcedTime(restRequest.getForcetime()).startAt(restRequest.getStartAt())
-                .weight(restRequest.getWeight());
+                .weight(restRequest.getWeight())
+                .dynamic(restRequest.isDynamic());
+    }
+
+    static RolloutUpdate fromRequest(final EntityFactory entityFactory, final MgmtRolloutRestRequestBodyPut restRequest, final long rolloutId) {
+        return entityFactory.rollout().update(rolloutId)
+                .name(restRequest.getName())
+                .description(restRequest.getDescription());
    }

    static RolloutCreate fromRetriedRollout(final EntityFactory entityFactory, final Rollout rollout) {
        return entityFactory.rollout().create()
                .name(rollout.getName().concat("_retry"))
                .description(rollout.getDescription())
-                .set(rollout.getDistributionSet())
+                .distributionSetId(rollout.getDistributionSet())
                .targetFilterQuery("failedrollout==".concat(String.valueOf(rollout.getId())))
                .actionType(rollout.getActionType())
                .forcedTime(rollout.getForcedTime())
--- a/hawkbit-rest/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtRolloutResource.java
+++ b/hawkbit-rest/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtRolloutResource.java
@@ -19,7 +19,8 @@ import jakarta.validation.ValidationException;
 import lombok.extern.slf4j.Slf4j;
 import org.eclipse.hawkbit.mgmt.json.model.PagedList;
 import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutResponseBody;
-import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutRestRequestBody;
+import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutRestRequestBodyPost;
+import org.eclipse.hawkbit.mgmt.json.model.rollout.MgmtRolloutRestRequestBodyPut;
 import org.eclipse.hawkbit.mgmt.json.model.rolloutgroup.MgmtRolloutGroup;
 import org.eclipse.hawkbit.mgmt.json.model.rolloutgroup.MgmtRolloutGroupResponseBody;
 import org.eclipse.hawkbit.mgmt.json.model.target.MgmtTarget;
@@ -130,9 +131,8 @@ public class MgmtRolloutResource implements MgmtRolloutRestApi {

    @Override
    public ResponseEntity<MgmtRolloutResponseBody> create(
-            @RequestBody final MgmtRolloutRestRequestBody rolloutRequestBody) {
-
-        // first check the given RSQL query if it's well formed, otherwise and
+            @RequestBody final MgmtRolloutRestRequestBodyPost rolloutRequestBody) {
+        // first check the given RSQL query if it's well-formed, otherwise and
        // exception is thrown
        final String targetFilterQuery = rolloutRequestBody.getTargetFilterQuery();
        if (targetFilterQuery == null) {
@@ -170,9 +170,8 @@ public class MgmtRolloutResource implements MgmtRolloutRestApi {

        return ResponseEntity.status(HttpStatus.CREATED).body(MgmtRolloutMapper.toResponseRollout(rollout, true));
    }
-
    private Optional<Boolean> isConfirmationRequiredForGroup(final MgmtRolloutGroup group,
-            final MgmtRolloutRestRequestBody request) {
+            final MgmtRolloutRestRequestBodyPost request) {
        if (group.getConfirmationRequired() != null) {
            return Optional.of(group.getConfirmationRequired());
        } else if (request.getConfirmationRequired() != null) {
@@ -181,6 +180,15 @@ public class MgmtRolloutResource implements MgmtRolloutRestApi {
        return Optional.empty();
    }

+    @Override
+    public ResponseEntity<MgmtRolloutResponseBody> update(
+            @PathVariable("rolloutId") final Long rolloutId,
+            @RequestBody final MgmtRolloutRestRequestBodyPut rolloutUpdateBody) {
+        final Rollout updated =
+                rolloutManagement.update(MgmtRolloutMapper.fromRequest(entityFactory, rolloutUpdateBody, rolloutId));
+        return ResponseEntity.ok(MgmtRolloutMapper.toResponseRollout(updated, true));
+    }
+
    @Override
    public ResponseEntity<Void> approve(@PathVariable("rolloutId") final Long rolloutId, final String remark) {
        rolloutManagement.approveOrDeny(rolloutId, Rollout.ApprovalDecision.APPROVED, remark);
--- a/hawkbit-rest/hawkbit-mgmt-resource/src/test/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtRolloutResourceTest.java
+++ b/hawkbit-rest/hawkbit-mgmt-resource/src/test/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtRolloutResourceTest.java
@@ -20,6 +20,7 @@ import static org.hamcrest.Matchers.hasSize;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@@ -56,6 +57,7 @@ import org.eclipse.hawkbit.repository.test.util.SecurityContextSwitch;
 import org.eclipse.hawkbit.repository.test.util.WithUser;
 import org.eclipse.hawkbit.rest.util.JsonBuilder;
 import org.eclipse.hawkbit.rest.util.MockMvcResultPrinter;
+import org.json.JSONObject;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -270,6 +272,31 @@ class MgmtRolloutResourceTest extends AbstractManagementApiIntegrationTest {

    }

+    @Test
+    @Description("Testing that rollout can be updated")
+    void updateRollout() throws Exception {
+        testdataFactory.createTargets(4, "rollout", "description");
+        final DistributionSet dsA = testdataFactory.createDistributionSet("");
+        // create a running rollout for the created targets
+        final Rollout rollout = rolloutManagement.create(
+                entityFactory
+                        .rollout()
+                        .create()
+                        .name("rollout1")
+                        .distributionSetId(dsA.getId())
+                        .targetFilterQuery("controllerId==rollout*"),
+                4, false, new RolloutGroupConditionBuilder().withDefaults()
+                        .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());
+
+
+        mvc.perform(put("/rest/v1/rollouts/" + rollout.getId()).content(
+                                new JSONObject().put("name", "newName").put("description", "newDesc").toString()
+                        ).contentType(MediaType.APPLICATION_JSON)
+                        .accept(MediaType.APPLICATION_JSON)).andDo(MockMvcResultPrinter.print()).andExpect(status().isOk())
+                .andExpect(jsonPath("$.name", equalTo("newName")))
+                .andExpect(jsonPath("$.description", equalTo("newDesc")));
+    }
+
    @Test
    @Description("Testing the empty list is returned if no rollout exists")
    void noRolloutReturnsEmptyList() throws Exception {
@@ -286,7 +313,7 @@ class MgmtRolloutResourceTest extends AbstractManagementApiIntegrationTest {

        // create rollout including the created targets with prefix 'rollout'
        final Rollout rollout = rolloutManagement.create(
-                entityFactory.rollout().create().name("rollout1").set(dsA.getId())
+                entityFactory.rollout().create().name("rollout1").distributionSetId(dsA.getId())
                        .targetFilterQuery("controllerId==rollout*"),
                4, false, new RolloutGroupConditionBuilder().withDefaults()
                        .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());
@@ -305,7 +332,7 @@ class MgmtRolloutResourceTest extends AbstractManagementApiIntegrationTest {

        // create a running rollout for the created targets
        final Rollout rollout = rolloutManagement.create(
-                entityFactory.rollout().create().name("rollout1").set(dsA.getId())
+                entityFactory.rollout().create().name("rollout1").distributionSetId(dsA.getId())
                        .targetFilterQuery("controllerId==rollout*"),
                4, false, new RolloutGroupConditionBuilder().withDefaults()
                        .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());
@@ -345,13 +372,13 @@ class MgmtRolloutResourceTest extends AbstractManagementApiIntegrationTest {

        // create a running rollout for the created targets
        final Rollout rollout = rolloutManagement.create(
-                entityFactory.rollout().create().name("rollout1").set(dsA.getId())
+                entityFactory.rollout().create().name("rollout1").distributionSetId(dsA.getId())
                        .targetFilterQuery("controllerId==rollout*"),
                4, false, new RolloutGroupConditionBuilder().withDefaults()
                        .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());

        rolloutManagement.create(
-                entityFactory.rollout().create().name("rollout2").set(dsA.getId())
+                entityFactory.rollout().create().name("rollout2").distributionSetId(dsA.getId())
                        .targetFilterQuery("controllerId==rollout*"),
                4, false, new RolloutGroupConditionBuilder().withDefaults()
                        .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());
@@ -399,7 +426,7 @@ class MgmtRolloutResourceTest extends AbstractManagementApiIntegrationTest {
                            .rollout()
                            .create()
                            .name("rollout1")
-                            .set(dsA.getId())
+                            .distributionSetId(dsA.getId())
                            .targetFilterQuery("controllerId==rollout*"),
                    4, false, new RolloutGroupConditionBuilder().withDefaults()
                            .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());
@@ -431,7 +458,7 @@ class MgmtRolloutResourceTest extends AbstractManagementApiIntegrationTest {

        // create rollout including the created targets with prefix 'rollout'
        final Rollout rollout = rolloutManagement.create(
-                entityFactory.rollout().create().name("rollout1").set(dsA.getId())
+                entityFactory.rollout().create().name("rollout1").distributionSetId(dsA.getId())
                        .targetFilterQuery("controllerId==rollout*"),
                4, false, new RolloutGroupConditionBuilder().withDefaults()
                        .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());
@@ -982,7 +1009,7 @@ class MgmtRolloutResourceTest extends AbstractManagementApiIntegrationTest {

        // create rollout including the created targets with prefix 'rollout'
        final Rollout rollout = rolloutManagement.create(
-                entityFactory.rollout().create().name("rollout1").set(dsA.getId())
+                entityFactory.rollout().create().name("rollout1").distributionSetId(dsA.getId())
                        .targetFilterQuery("controllerId==rollout*"),
                4, confirmationRequired, new RolloutGroupConditionBuilder().withDefaults()
                        .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());
@@ -1328,7 +1355,7 @@ class MgmtRolloutResourceTest extends AbstractManagementApiIntegrationTest {

        // create a running rollout for the created targets
        final Rollout rollout = rolloutManagement.create(
-                entityFactory.rollout().create().name("rollout1").set(dsA.getId())
+                entityFactory.rollout().create().name("rollout1").distributionSetId(dsA.getId())
                        .targetFilterQuery("controllerId==rollout*"),
                4, false, new RolloutGroupConditionBuilder().withDefaults()
                        .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());
@@ -1509,7 +1536,7 @@ class MgmtRolloutResourceTest extends AbstractManagementApiIntegrationTest {
    private Rollout createRollout(final String name, final int amountGroups, final long distributionSetId,
            final String targetFilterQuery, final boolean confirmationRequired) {
        final Rollout rollout = rolloutManagement.create(
-                entityFactory.rollout().create().name(name).set(distributionSetId).targetFilterQuery(targetFilterQuery),
+                entityFactory.rollout().create().name(name).distributionSetId(distributionSetId).targetFilterQuery(targetFilterQuery),
                amountGroups, confirmationRequired, new RolloutGroupConditionBuilder().withDefaults()
                        .successCondition(RolloutGroupSuccessCondition.THRESHOLD, "100").build());