Support for Multi-Assignments

hawkbit-core/src/main/java/org/eclipse/hawkbit/exception/SpServerError.java

@@ -191,6 +191,7 @@ public enum SpServerError {
      */
     SP_CONFIGURATION_VALUE_INVALID("hawkbit.server.error.configValueInvalid",
             "The given configuration value is invalid."),
+
     /**
      * 
      */
@@ -232,7 +233,14 @@ public enum SpServerError {
      * invalid.
      */
     SP_AUTO_ASSIGN_DISTRIBUTION_SET_INVALID("hawkbit.server.error.repo.invalidAutoAssignDistributionSet",
-            "The given distribution set for auto-assignment is invalid: it is either incomplete (i.e. mandatory modules are missing) or soft deleted");
+            "The given distribution set for auto-assignment is invalid: it is either incomplete (i.e. mandatory modules are missing) or soft deleted"),
+
+    /**
+     * Error message informing the user that the requested tenant configuration
+     * change is not allowed.
+     */
+    SP_CONFIGURATION_VALUE_CHANGE_NOT_ALLOWED("hawkbit.server.error.repo.tenantConfigurationValueChangeNotAllowed",
+            "The requested tenant configuration value modification is not allowed.");
 
     private final String key;
     private final String message;

hawkbit-dmf/hawkbit-dmf-amqp/src/main/java/org/eclipse/hawkbit/amqp/AmqpConfiguration.java

@@ -17,6 +17,7 @@
 import org.eclipse.hawkbit.dmf.amqp.api.AmqpSettings;
 import org.eclipse.hawkbit.repository.ArtifactManagement;
 import org.eclipse.hawkbit.repository.ControllerManagement;
+import org.eclipse.hawkbit.repository.DeploymentManagement;
 import org.eclipse.hawkbit.repository.DistributionSetManagement;
 import org.eclipse.hawkbit.repository.EntityFactory;
 import org.eclipse.hawkbit.repository.SoftwareModuleManagement;
@@ -240,9 +241,11 @@ public Binding bindDeadLetterQueueToDeadLetterExchange() {
     @Bean
     public AmqpMessageHandlerService amqpMessageHandlerService(final RabbitTemplate rabbitTemplate,
             final AmqpMessageDispatcherService amqpMessageDispatcherService,
-            final ControllerManagement controllerManagement, final EntityFactory entityFactory) {
+            final ControllerManagement controllerManagement, final EntityFactory entityFactory,
+            final SystemSecurityContext systemSecurityContext,
+            final TenantConfigurationManagement tenantConfigurationManagement) {
         return new AmqpMessageHandlerService(rabbitTemplate, amqpMessageDispatcherService, controllerManagement,
-                entityFactory);
+                entityFactory, systemSecurityContext, tenantConfigurationManagement);
     }
 
     /**
@@ -319,10 +322,10 @@ AmqpMessageDispatcherService amqpMessageDispatcherService(final RabbitTemplate r
             final AmqpMessageSenderService amqpSenderService, final ArtifactUrlHandler artifactUrlHandler,
             final SystemSecurityContext systemSecurityContext, final SystemManagement systemManagement,
             final TargetManagement targetManagement, final DistributionSetManagement distributionSetManagement,
-            final SoftwareModuleManagement softwareModuleManagement) {
+            final SoftwareModuleManagement softwareModuleManagement, final DeploymentManagement deploymentManagement) {
         return new AmqpMessageDispatcherService(rabbitTemplate, amqpSenderService, artifactUrlHandler,
                 systemSecurityContext, systemManagement, targetManagement, serviceMatcher, distributionSetManagement,
-                softwareModuleManagement);
+                softwareModuleManagement, deploymentManagement);
     }
 
     private static Map<String, Object> getTTLMaxArgsAuthenticationQueue() {

hawkbit-dmf/hawkbit-dmf-amqp/src/main/java/org/eclipse/hawkbit/amqp/AmqpMessageDispatcherService.java

@@ -8,8 +8,11 @@
  */
 package org.eclipse.hawkbit.amqp;
 
+import static org.eclipse.hawkbit.repository.RepositoryConstants.MAX_ACTION_COUNT;
+
 import java.net.URI;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -28,19 +31,23 @@
 import org.eclipse.hawkbit.dmf.json.model.DmfArtifactHash;
 import org.eclipse.hawkbit.dmf.json.model.DmfDownloadAndUpdateRequest;
 import org.eclipse.hawkbit.dmf.json.model.DmfMetadata;
+import org.eclipse.hawkbit.dmf.json.model.DmfMultiActionRequest;
 import org.eclipse.hawkbit.dmf.json.model.DmfSoftwareModule;
+import org.eclipse.hawkbit.repository.DeploymentManagement;
 import org.eclipse.hawkbit.repository.DistributionSetManagement;
 import org.eclipse.hawkbit.repository.RepositoryConstants;
 import org.eclipse.hawkbit.repository.SoftwareModuleManagement;
 import org.eclipse.hawkbit.repository.SystemManagement;
 import org.eclipse.hawkbit.repository.TargetManagement;
+import org.eclipse.hawkbit.repository.event.remote.MultiActionEvent;
 import org.eclipse.hawkbit.repository.event.remote.TargetAssignDistributionSetEvent;
 import org.eclipse.hawkbit.repository.event.remote.TargetAttributesRequestedEvent;
 import org.eclipse.hawkbit.repository.event.remote.TargetDeletedEvent;
 import org.eclipse.hawkbit.repository.event.remote.entity.CancelTargetAssignmentEvent;
 import org.eclipse.hawkbit.repository.model.Action;
 import org.eclipse.hawkbit.repository.model.ActionProperties;
 import org.eclipse.hawkbit.repository.model.Artifact;
+import org.eclipse.hawkbit.repository.model.DistributionSet;
 import org.eclipse.hawkbit.repository.model.SoftwareModule;
 import org.eclipse.hawkbit.repository.model.SoftwareModuleMetadata;
 import org.eclipse.hawkbit.repository.model.Target;
@@ -79,6 +86,7 @@ public class AmqpMessageDispatcherService extends BaseAmqpService {
     private final TargetManagement targetManagement;
     private final ServiceMatcher serviceMatcher;
     private final DistributionSetManagement distributionSetManagement;
+    private final DeploymentManagement deploymentManagement;
     private final SoftwareModuleManagement softwareModuleManagement;
 
     /**
@@ -107,7 +115,7 @@ protected AmqpMessageDispatcherService(final RabbitTemplate rabbitTemplate,
             final SystemSecurityContext systemSecurityContext, final SystemManagement systemManagement,
             final TargetManagement targetManagement, final ServiceMatcher serviceMatcher,
             final DistributionSetManagement distributionSetManagement,
-            final SoftwareModuleManagement softwareModuleManagement) {
+            final SoftwareModuleManagement softwareModuleManagement, final DeploymentManagement deploymentManagement) {
         super(rabbitTemplate);
         this.artifactUrlHandler = artifactUrlHandler;
         this.amqpSenderService = amqpSenderService;
@@ -117,6 +125,7 @@ protected AmqpMessageDispatcherService(final RabbitTemplate rabbitTemplate,
         this.serviceMatcher = serviceMatcher;
         this.distributionSetManagement = distributionSetManagement;
         this.softwareModuleManagement = softwareModuleManagement;
+        this.deploymentManagement = deploymentManagement;
     }
 
     /**
@@ -134,47 +143,145 @@ protected void targetAssignDistributionSet(final TargetAssignDistributionSetEven
 
         LOG.debug("targetAssignDistributionSet retrieved. I will forward it to DMF broker.");
 
-        distributionSetManagement.get(assignedEvent.getDistributionSetId()).ifPresent(set -> {
+        distributionSetManagement.get(assignedEvent.getDistributionSetId()).ifPresent(ds -> {
 
-            final Map<SoftwareModule, List<SoftwareModuleMetadata>> modules = Maps
-                    .newHashMapWithExpectedSize(set.getModules().size());
-            set.getModules()
-                    .forEach(
-                            module -> modules.put(module,
-                                    softwareModuleManagement.findMetaDataBySoftwareModuleIdAndTargetVisible(
-                                            PageRequest.of(0, RepositoryConstants.MAX_META_DATA_COUNT), module.getId())
-                                            .getContent()));
+            final Map<SoftwareModule, List<SoftwareModuleMetadata>> softwareModules = getSoftwareModulesWithMetadata(
+                    ds);
 
             targetManagement.getByControllerID(assignedEvent.getActions().keySet()).forEach(
                     target -> sendUpdateMessageToTarget(assignedEvent.getActions().get(target.getControllerId()),
-                            target, modules));
+                            target, softwareModules));
+
+        });
+    }
+
+    /**
+     * Listener for Multi-Action events.
+     *
+     * @param e
+     *            the Multi-Action event to be processed
+     */
+    @EventListener(classes = MultiActionEvent.class)
+    protected void onMultiAction(final MultiActionEvent e) {
+        if (isNotFromSelf(e)) {
+            return;
+        }
+        LOG.debug("MultiActionEvent received for {}", e.getControllerIds());
+        sendMultiActionRequestMessages(e.getTenant(), e.getControllerIds());
+    }
+
+    protected void sendMultiActionRequestMessages(final String tenant, final List<String> controllerIds) {
+
+        final Map<Long, Map<SoftwareModule, List<SoftwareModuleMetadata>>> softwareModuleMetadata = new HashMap<>();
+        targetManagement.getByControllerID(controllerIds).stream()
+                .filter(target -> IpUtil.isAmqpUri(target.getAddress())).forEach(target -> {
+
+                    final List<Action> activeActions = deploymentManagement
+                            .findActiveActionsByTarget(PageRequest.of(0, MAX_ACTION_COUNT), target.getControllerId())
+                            .getContent();
+
+                    activeActions.forEach(action -> {
+                        final DistributionSet distributionSet = action.getDistributionSet();
+                        softwareModuleMetadata.computeIfAbsent(distributionSet.getId(),
+                                id -> getSoftwareModulesWithMetadata(distributionSet));
+                    });
+
+                    if (!activeActions.isEmpty()) {
+                        sendMultiActionRequestToTarget(tenant, target, activeActions, softwareModuleMetadata);
+                    }
+
+                });
+
+    }
+
+    protected void sendMultiActionRequestToTarget(final String tenant, final Target target, final List<Action> actions,
+            final Map<Long, Map<SoftwareModule, List<SoftwareModuleMetadata>>> softwareModulesPerDistributionSet) {
+
+        final URI targetAdress = target.getAddress();
+        if (!IpUtil.isAmqpUri(targetAdress) || CollectionUtils.isEmpty(actions)) {
+            return;
+        }
 
+        final DmfMultiActionRequest multiActionRequest = new DmfMultiActionRequest();
+        actions.forEach(action -> {
+            final DmfActionRequest actionRequest = createDmfActionRequest(target, action,
+                    softwareModulesPerDistributionSet.get(action.getDistributionSet().getId()));
+            multiActionRequest.addElement(getEventTypeForAction(action), actionRequest);
         });
+
+        final Message message = getMessageConverter().toMessage(multiActionRequest,
+                createConnectorMessagePropertiesEvent(tenant, target.getControllerId(), EventTopic.MULTI_ACTION));
+        amqpSenderService.sendMessage(message, targetAdress);
+
+    }
+
+    private DmfActionRequest createDmfActionRequest(final Target target, final Action action,
+            final Map<SoftwareModule, List<SoftwareModuleMetadata>> softwareModules) {
+        if (action.isCancelingOrCanceled()) {
+            return createPlainActionRequest(action);
+        }
+        return createDownloadAndUpdateRequest(target, action, softwareModules);
+
+    }
+
+    private static DmfActionRequest createPlainActionRequest(final Action action) {
+        final DmfActionRequest actionRequest = new DmfActionRequest();
+        actionRequest.setActionId(action.getId());
+        return actionRequest;
+    }
+
+    private DmfDownloadAndUpdateRequest createDownloadAndUpdateRequest(final Target target, final Action action,
+            final Map<SoftwareModule, List<SoftwareModuleMetadata>> softwareModules) {
+        final DmfDownloadAndUpdateRequest request = new DmfDownloadAndUpdateRequest();
+        request.setActionId(action.getId());
+        request.setTargetSecurityToken(systemSecurityContext.runAsSystem(target::getSecurityToken));
+        if (softwareModules != null) {
+            softwareModules.entrySet()
+                    .forEach(entry -> request.addSoftwareModule(convertToAmqpSoftwareModule(target, entry)));
+        }
+        return request;
     }
 
     /**
      * Method to get the type of event depending on whether the action is a
-     * DOWNLOAD_ONLY action or if it has a valid maintenance window available
-     * or not based on defined maintenance schedule. In case of no maintenance
-     * schedule or if there is a valid window available, the topic {@link EventTopic#DOWNLOAD_AND_INSTALL} is
-     * returned else {@link EventTopic#DOWNLOAD} is returned.
+     * DOWNLOAD_ONLY action or if it has a valid maintenance window available or
+     * not based on defined maintenance schedule. In case of no maintenance
+     * schedule or if there is a valid window available, the topic
+     * {@link EventTopic#DOWNLOAD_AND_INSTALL} is returned else
+     * {@link EventTopic#DOWNLOAD} is returned.
      *
      * @param action
      *            current action properties.
      *
      * @return {@link EventTopic} to use for message.
      */
     private static EventTopic getEventTypeForTarget(final ActionProperties action) {
-        return (Action.ActionType.DOWNLOAD_ONLY.equals(action.getActionType()) ||
-                !action.isMaintenanceWindowAvailable()) ? EventTopic.DOWNLOAD : EventTopic.DOWNLOAD_AND_INSTALL;
+        return (Action.ActionType.DOWNLOAD_ONLY.equals(action.getActionType())
+                || !action.isMaintenanceWindowAvailable()) ? EventTopic.DOWNLOAD : EventTopic.DOWNLOAD_AND_INSTALL;
+    }
+
+    /**
+     * Determines the {@link EventTopic} for the given {@link Action}, depending
+     * on its action type.
+     *
+     * @param action
+     *            to obtain the corresponding {@link EventTopic} for
+     *
+     * @return the {@link EventTopic} for this action
+     */
+    private static EventTopic getEventTypeForAction(final Action action) {
+        if (action.isCancelingOrCanceled()) {
+            return EventTopic.CANCEL_DOWNLOAD;
+        }
+        return getEventTypeForTarget(new ActionProperties(action));
     }
 
     /**
      * Method to send a message to a RabbitMQ Exchange after the assignment of
      * the Distribution set to a Target has been canceled.
      *
      * @param cancelEvent
-     *            the object to be send.
+     *            that is to be converted to a DMF message
      */
     @EventListener(classes = CancelTargetAssignmentEvent.class)
     protected void targetCancelAssignmentToDistributionSet(final CancelTargetAssignmentEvent cancelEvent) {
@@ -211,7 +318,7 @@ protected void targetTriggerUpdateAttributes(final TargetAttributesRequestedEven
     protected void sendUpdateMessageToTarget(final ActionProperties action, final Target target,
             final Map<SoftwareModule, List<SoftwareModuleMetadata>> modules) {
 
-        String tenant = action.getTenant();
+        final String tenant = action.getTenant();
 
         final URI targetAdress = target.getAddress();
         if (!IpUtil.isAmqpUri(targetAdress)) {
@@ -361,4 +468,17 @@ private DmfArtifact convertArtifact(final Target target, final Artifact localArt
         return artifact;
     }
 
-}
+    private Map<SoftwareModule, List<SoftwareModuleMetadata>> getSoftwareModulesWithMetadata(
+            final DistributionSet distributionSet) {
+        final Map<SoftwareModule, List<SoftwareModuleMetadata>> moduleMetadata = Maps
+                .newHashMapWithExpectedSize(distributionSet.getModules().size());
+        distributionSet.getModules()
+                .forEach(
+                        module -> moduleMetadata.put(module,
+                                softwareModuleManagement.findMetaDataBySoftwareModuleIdAndTargetVisible(
+                                        PageRequest.of(0, RepositoryConstants.MAX_META_DATA_COUNT), module.getId())
+                                        .getContent()));
+        return moduleMetadata;
+    }
+
+}