Feature offline deployments #563

kaizimmerm · 2017-07-18T15:21:28Z

Support for offline deployment in repository and Management API.

That comes in handy for several scenarios, e.g.

Import existing installation history in migration scenarios to rollouts.
Complete action history in case installations on a rollouts managed device have not been executed by rollouts itself (e.g. manual offline flashing).

Feature overview:

DS assignments on to a target through Management API can be executed including an successful installation result in one request.
installed DS is set accordingly.
The server checks that currently no installation is running and refuses the request if so.
Actions of such a request are put on top of the list as it is today with regular actions.

While at it I fixed a bug as well where assign DS response worked different on target and DS resources.

Reviewers: @schabdo @Jonkno

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

schabdo · 2017-07-24T08:23:21Z

...awkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DeploymentManagement.java

+     * Method registers an "offline" assignment, i.e. adds a completed action
+     * for the given {@link DistributionSet} to the given {@link Target}s.
+     * 
+     * The handling differs to hawkBit manged updates my means that:<br/>


Typo: manged => managed

schabdo · 2017-07-24T08:25:04Z

...awkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DeploymentManagement.java

+     * 
+     * @throws IncompleteDistributionSetException
+     *             if mandatory {@link SoftwareModuleType} are not assigned as
+     *             define by the {@link DistributionSetType}.


Typo: define => defined

schabdo · 2017-07-24T08:33:21Z

...awkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DeploymentManagement.java

+     * for the given {@link DistributionSet} to the given {@link Target}s.
+     * 
+     * The handling differs to hawkBit manged updates my means that:<br/>
+     * A. it ignores targets completely that are in


If you use a ordered list, you do not have to format it manually:

<ol type="A"> <li>it ignores targets completely that are in {@link TargetUpdateStatus#PENDING}</li> <li>it creates completed actions</li> .... </ol>

schabdo · 2017-07-24T08:56:02Z

...awkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/TargetRepository.java

@@ -59,6 +59,29 @@ void setAssignedDistributionSetAndUpdateStatus(@Param("status") TargetUpdateStat
            @Param("lastModifiedBy") String modifiedBy, @Param("targets") Collection<Long> targets);

    /**
+     * Sets {@link JpaTarget#getAssignedDistributionSet()} and


Better:

Sets {@link JpaTarget#getAssignedDistributionSet()}, {@link JpaTarget#getInstalledDistributionSet()} and {@link JpaTarget#getInstallationDate()}.

schabdo · 2017-07-24T08:57:42Z

...epository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/DeploymentManagementTest.java

@@ -428,6 +428,38 @@ private JpaAction assignSet(final Target target, final DistributionSet ds) {
        return action;
    }

+    @Test
+    @Description("Simple offline deployment of a distribution set to a list of targets. Verifies that offline assigment "
+            + "is correctly executed for targets that do not have a runnign update already. Those are ignored.")


Typo: runnign => running

schabdo · 2017-07-24T09:40:54Z

...repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/JpaDeploymentManagement.java

-                        .findAll(TargetSpecifications.hasControllerIdAndAssignedDistributionSetIdNot(ids, set.getId())))
-                .flatMap(List::stream).collect(Collectors.toList());
+        final List<JpaTarget> targets;
+        if (offline) {


Due to the offline capability there are a lot of branches within the code now. This makes it hard to maintain and you'll get at lot of duplications. Have a look only at the public methods: All of them pass through a boolean to state whether it is an offline or online update (indicator for violating SRP). I suggest to either split this class into two internal classes (e.g. JpaOnlineDeploymentManagement and JpaOfflineDeploymentManagement) or make use of the strategy-pattern for online/offline case e.g.:

interface UpdateStrategy { // maybe there is a better name for it List<JpaTarget> findTarget(final List<String> controllerIDs, final long setId); void updateTargetStatus(final JpaDistributionSet set, final List<List<Long>> targetIds, final String currentUser); Set<Long> findTargetIdToCancel(List<List<Long>> targetIds); Status getActionStatus(); } class OnlineUpdate implements UpdateStrategy{} class OfflineUpdate implements UpdateStrategy{}

Later on in the implementation you won't have an if/else statement and only call:

strategy.findTarget(ids, set.getId());

Instead of:

final List<JpaTarget> targets; if (offline) { targets = Lists.partition(controllerIDs, Constants.MAX_ENTRIES_IN_STATEMENT).stream() .map(ids -> targetRepository.findAll(SpecificationsBuilder.combineWithAnd(Arrays.asList( TargetSpecifications.hasControllerIdAndAssignedDistributionSetIdNot(ids, set.getId()), TargetSpecifications.notEqualToTargetUpdateStatus(TargetUpdateStatus.PENDING))))) .flatMap(List::stream).collect(Collectors.toList()); } else { targets = Lists.partition(controllerIDs, Constants.MAX_ENTRIES_IN_STATEMENT).stream() .map(ids -> targetRepository.findAll( TargetSpecifications.hasControllerIdAndAssignedDistributionSetIdNot(ids, set.getId()))) .flatMap(List::stream).collect(Collectors.toList()); }

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Jonkno · 2017-07-24T11:46:13Z

...source/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtDistributionSetResource.java

+        return ResponseEntity
+                .ok(MgmtDistributionSetMapper.toResponse(this.deployManagament.assignDistributionSet(distributionSetId,
+                        targetIds.stream()
+                                .map(t -> new TargetWithActionType(t.getId(),


It's better to use a descriptive value for the the parameter t (e.g. targetId)

Jonkno · 2017-07-24T13:03:30Z