Removed percentage from the event. Moved event into the repo API.

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

hawkbit-cache-redis/pom.xml

@@ -45,6 +45,12 @@
 
 
       <!-- Test -->
+      <dependency>
+         <groupId>org.eclipse.hawkbit</groupId>
+         <artifactId>hawkbit-repository-api</artifactId>
+         <version>${project.version}</version>
+         <scope>test</scope>
+      </dependency>
       <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>

hawkbit-cache-redis/src/test/java/org/eclipse/hawkbit/cache/eventbus/EventDistributorTest.java

@@ -16,8 +16,8 @@ import static org.mockito.Mockito.verify;
 
 import java.util.Collection;
 
-import org.eclipse.hawkbit.eventbus.event.DownloadProgressEvent;
 import org.eclipse.hawkbit.eventbus.event.EntityEvent;
+import org.eclipse.hawkbit.repository.eventbus.event.DownloadProgressEvent;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -56,7 +56,7 @@ public class EventDistributorTest {
     @Test
     public void distributeDistributedEventSendsToRedis() {
 
-        final DownloadProgressEvent event = new DownloadProgressEvent("tenant", 123L, 10, 100L, 200L);
+        final DownloadProgressEvent event = new DownloadProgressEvent("tenant", 123L, 500L, 100L, 200L);
         underTest.distribute(event);
 
         // origin node ID should be set by distributing the event
@@ -67,7 +67,7 @@ public class EventDistributorTest {
     @Test
     public void dontDistributeDistributedEventIfSameNode() {
         final String knownNodeId = EventDistributor.getNodeId();
-        final DownloadProgressEvent event = new DownloadProgressEvent("tenant", 123L, 10, 100L, 200L);
+        final DownloadProgressEvent event = new DownloadProgressEvent("tenant", 123L, 500L, 100L, 200L);
         event.setNodeId(knownNodeId);
 
         // test
@@ -79,7 +79,7 @@ public class EventDistributorTest {
 
     @Test
     public void handleDistributedMessageFromRedis() {
-        final DownloadProgressEvent event = new DownloadProgressEvent("tenant", 123L, 10, 100L, 200L);
+        final DownloadProgressEvent event = new DownloadProgressEvent("tenant", 123L, 500L, 100L, 200L);
         final String knownChannel = "someChannel";
 
         underTest.handleMessage(event, knownChannel);
@@ -90,7 +90,7 @@ public class EventDistributorTest {
 
     @Test
     public void handleDistributedMessageFilteredIfSameNodeId() {
-        final DownloadProgressEvent event = new DownloadProgressEvent("tenant", 123L, 10, 100L, 200L);
+        final DownloadProgressEvent event = new DownloadProgressEvent("tenant", 123L, 500L, 100L, 200L);
         final String knownChannel = "someChannel";
         event.setOriginNodeId(EventDistributor.getNodeId());
 

hawkbit-ddi-resource/src/test/java/org/eclipse/hawkbit/ddi/rest/resource/DdiArtifactDownloadTest.java

@@ -26,7 +26,7 @@ import java.util.Arrays;
 import java.util.List;
 
 import org.apache.commons.lang3.RandomUtils;
-import org.eclipse.hawkbit.eventbus.event.DownloadProgressEvent;
+import org.eclipse.hawkbit.repository.eventbus.event.DownloadProgressEvent;
 import org.eclipse.hawkbit.repository.model.Action;
 import org.eclipse.hawkbit.repository.model.Action.Status;
 import org.eclipse.hawkbit.repository.model.Artifact;

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ControllerManagement.java

@@ -14,8 +14,8 @@ import java.util.Map;
 
 import javax.validation.constraints.NotNull;
 
-import org.eclipse.hawkbit.eventbus.event.DownloadProgressEvent;
 import org.eclipse.hawkbit.im.authentication.SpPermission.SpringEvalExpressions;
+import org.eclipse.hawkbit.repository.eventbus.event.DownloadProgressEvent;
 import org.eclipse.hawkbit.repository.exception.EntityAlreadyExistsException;
 import org.eclipse.hawkbit.repository.exception.EntityNotFoundException;
 import org.eclipse.hawkbit.repository.exception.ToManyAttributeEntriesException;
@@ -58,21 +58,20 @@ public interface ControllerManagement {
     Action addCancelActionStatus(@NotNull ActionStatus actionStatus);
 
     /**
-     * Sends the download progress in percentage and notifies the
+     * Sends the download progress and notifies the {@link EventBus} with a
-     * {@link EventBus} with a {@link DownloadProgressEvent}.
+     * {@link DownloadProgressEvent}.
      * 
      * @param statusId
      *            the ID of the {@link ActionStatus}
-     * @param progressPercent
+     * @param requestedBytes
-     *            the progress in percentage which must be between 0-100
+     *            requested bytes of the request
      * @param shippedBytesSinceLast
      *            since the last report
      * @param shippedBytesOverall
      *            for the {@link ActionStatus}
      */
     @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER)
-    void downloadProgressPercent(long statusId, int progressPercent, long shippedBytesSinceLast,
+    void downloadProgress(Long statusId, Long requestedBytes, Long shippedBytesSinceLast, Long shippedBytesOverall);
-            long shippedBytesOverall);
 
     /**
      * Simple addition of a new {@link ActionStatus} entry to the {@link Action}

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TenantStatsManagement.java

@@ -16,10 +16,11 @@ import org.springframework.security.access.prepost.PreAuthorize;
  * Management service for statistics of a single tenant.
  *
  */
+@FunctionalInterface
 public interface TenantStatsManagement {
 
     /**
-     * Service for stats of a single tenant.
+     * Service for stats of the current tenant.
      *
      * @return collected statistics
      */

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/eventbus/event/DownloadProgressEvent.java

@@ -6,13 +6,13 @@
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  */
-package org.eclipse.hawkbit.eventbus.event;
+package org.eclipse.hawkbit.repository.eventbus.event;
+
+import org.eclipse.hawkbit.eventbus.event.AbstractDistributedEvent;
 
 /**
- * Event that contains an updated download progress for a given Action.
+ * Event that contains an updated download progress for a given ActionStatus
- *
+ * that was written for a download request.
- *
- *
  *
  */
 public class DownloadProgressEvent extends AbstractDistributedEvent {
@@ -20,7 +20,7 @@ public class DownloadProgressEvent extends AbstractDistributedEvent {
     private static final long serialVersionUID = 1L;
 
     private final Long statusId;
-    private final int progressPercent;
+    private final long requestedBytes;
     private final long shippedBytesSinceLast;
     private final long shippedBytesOverall;
 
@@ -30,22 +30,21 @@ public class DownloadProgressEvent extends AbstractDistributedEvent {
      * @param tenant
      *            the tenant for this event
      * @param statusId
-     *            of {@link ActionStatus}
+     *            of ActionStatus that was written for the download request
-     * @param progressPercent
+     * @param requestedBytes
-     *            number (1-100)
+     *            bytes requested
      * @param shippedBytesSinceLast
      *            bytes since last event
      * @param shippedBytesOverall
      *            on the download request
      */
-    public DownloadProgressEvent(final String tenant, final Long statusId, final int progressPercent,
+    public DownloadProgressEvent(final String tenant, final Long statusId, final Long requestedBytes,
-            final long shippedBytesSinceLast, final long shippedBytesOverall) {
+            final Long shippedBytesSinceLast, final Long shippedBytesOverall) {
         // the revision of the DownloadProgressEvent is just equal the
-        // progressPercentage due the
+        // shippedBytesOverall as this is a growing number.
-        // percentage is going from 0 to 100.
+        super(shippedBytesOverall, tenant);
-        super(statusId, tenant);
         this.statusId = statusId;
-        this.progressPercent = progressPercent;
+        this.requestedBytes = requestedBytes;
         this.shippedBytesSinceLast = shippedBytesSinceLast;
         this.shippedBytesOverall = shippedBytesOverall;
     }
@@ -54,8 +53,8 @@ public class DownloadProgressEvent extends AbstractDistributedEvent {
         return statusId;
     }
 
-    public int getProgressPercent() {
+    public long getRequestedBytes() {
-        return progressPercent;
+        return requestedBytes;
     }
 
     public long getShippedBytesSinceLast() {

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Action.java

@@ -39,12 +39,6 @@ public interface Action extends TenantAwareBaseEntity {
         return Status.CANCELING.equals(getStatus()) || Status.CANCELED.equals(getStatus());
     }
 
-    /**
-     * @return current {@link Status#DOWNLOAD} progress if known by the update
-     *         server.
-     */
-    int getDownloadProgressPercent();
-
     /**
      * @return current {@link Status} of the {@link Action}.
      */

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionStatus.java

@@ -43,6 +43,12 @@ public interface ActionStatus extends TenantAwareBaseEntity {
      */
     void addMessage(String message);
 
+    /**
+     * @return current {@link Status#DOWNLOAD} progress if known by the update
+     *         server.
+     */
+    int getDownloadProgressPercent();
+
     /**
      * @return list of message entries that can be added to the
      *         {@link ActionStatus}.

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

@@ -469,9 +469,9 @@ public class JpaControllerManagement implements ControllerManagement {
     }
 
     @Override
-    public void downloadProgressPercent(final long statusId, final int progressPercent,
+    public void downloadProgress(final Long statusId, final Long requestedBytes, final Long shippedBytesSinceLast,
-            final long shippedBytesSinceLast, final long shippedBytesOverall) {
+            final Long shippedBytesOverall) {
-        cacheWriteNotify.downloadProgressPercent(statusId, progressPercent, shippedBytesSinceLast, shippedBytesOverall);
+        cacheWriteNotify.downloadProgress(statusId, requestedBytes, shippedBytesSinceLast, shippedBytesOverall);
     }
 
 }

hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/cache/CacheWriteNotify.java

@@ -8,7 +8,9 @@
  */
 package org.eclipse.hawkbit.repository.jpa.cache;
 
-import org.eclipse.hawkbit.eventbus.event.DownloadProgressEvent;
+import java.math.RoundingMode;
+
+import org.eclipse.hawkbit.repository.eventbus.event.DownloadProgressEvent;
 import org.eclipse.hawkbit.repository.eventbus.event.RolloutGroupCreatedEvent;
 import org.eclipse.hawkbit.repository.model.ActionStatus;
 import org.eclipse.hawkbit.repository.model.Rollout;
@@ -19,6 +21,7 @@ import org.springframework.cache.CacheManager;
 import org.springframework.stereotype.Service;
 
 import com.google.common.eventbus.EventBus;
+import com.google.common.math.DoubleMath;
 
 /**
  * An service which combines the functionality for functional use cases to write
@@ -29,10 +32,6 @@ import com.google.common.eventbus.EventBus;
  */
 @Service
 public class CacheWriteNotify {
-
-    /**
-    *
-    */
     private static final int DOWNLOAD_PROGRESS_MAX = 100;
 
     @Autowired
@@ -45,25 +44,29 @@ public class CacheWriteNotify {
     private TenantAware tenantAware;
 
     /**
-     * writes the download progress in percentage into the cache
+     * writes the download progress into the cache
      * {@link CacheKeys#DOWNLOAD_PROGRESS_PERCENT} and notifies the
      * {@link EventBus} with a {@link DownloadProgressEvent}.
      * 
      * @param statusId
      *            the ID of the {@link ActionStatus}
-     * @param progressPercent
+     * @param requestedBytes
-     *            the progress in percentage which must be between 0-100
+     *            requested bytes of the request
      * @param shippedBytesSinceLast
      *            since last event
      * @param shippedBytesOverall
      *            for the download request
      */
-    public void downloadProgressPercent(final long statusId, final int progressPercent,
+    public void downloadProgress(final Long statusId, final Long requestedBytes, final Long shippedBytesSinceLast,
-            final long shippedBytesSinceLast, final long shippedBytesOverall) {
+            final Long shippedBytesOverall) {
 
         final Cache cache = cacheManager.getCache(ActionStatus.class.getName());
         final String cacheKey = CacheKeys.entitySpecificCacheKey(String.valueOf(statusId),
                 CacheKeys.DOWNLOAD_PROGRESS_PERCENT);
+
+        final int progressPercent = DoubleMath.roundToInt(shippedBytesOverall * 100.0 / requestedBytes,
+                RoundingMode.DOWN);
+
         if (progressPercent < DOWNLOAD_PROGRESS_MAX) {
             cache.put(cacheKey, progressPercent);
         } else {
@@ -73,7 +76,7 @@ public class CacheWriteNotify {
             cache.evict(cacheKey);
         }
 
-        eventBus.post(new DownloadProgressEvent(tenantAware.getCurrentTenant(), statusId, progressPercent,
+        eventBus.post(new DownloadProgressEvent(tenantAware.getCurrentTenant(), statusId, requestedBytes,
                 shippedBytesSinceLast, shippedBytesOverall));
     }
 

hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/model/JpaAction.java

@@ -27,10 +27,7 @@ import javax.persistence.NamedEntityGraphs;
 import javax.persistence.NamedSubgraph;
 import javax.persistence.OneToMany;
 import javax.persistence.Table;
-import javax.persistence.Transient;
 
-import org.eclipse.hawkbit.repository.jpa.cache.CacheField;
-import org.eclipse.hawkbit.repository.jpa.cache.CacheKeys;
 import org.eclipse.hawkbit.repository.model.Action;
 import org.eclipse.hawkbit.repository.model.ActionStatus;
 import org.eclipse.hawkbit.repository.model.DistributionSet;
@@ -89,13 +86,6 @@ public class JpaAction extends AbstractJpaTenantAwareBaseEntity implements Actio
     @JoinColumn(name = "rollout", foreignKey = @ForeignKey(value = ConstraintMode.CONSTRAINT, name = "fk_action_rollout"))
     private JpaRollout rollout;
 
-    /**
-     * Note: filled only in {@link Status#DOWNLOAD}.
-     */
-    @Transient
-    @CacheField(key = CacheKeys.DOWNLOAD_PROGRESS_PERCENT)
-    private int downloadProgressPercent;
-
     @Override
     public DistributionSet getDistributionSet() {
         return distributionSet;
@@ -120,15 +110,6 @@ public class JpaAction extends AbstractJpaTenantAwareBaseEntity implements Actio
         this.status = status;
     }
 
-    @Override
-    public int getDownloadProgressPercent() {
-        return downloadProgressPercent;
-    }
-
-    public void setDownloadProgressPercent(final int downloadProgressPercent) {
-        this.downloadProgressPercent = downloadProgressPercent;
-    }
-
     @Override
     public boolean isActive() {
         return active;

hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/model/JpaActionStatus.java

@@ -24,7 +24,10 @@ import javax.persistence.ManyToOne;
 import javax.persistence.NamedAttributeNode;
 import javax.persistence.NamedEntityGraph;
 import javax.persistence.Table;
+import javax.persistence.Transient;
 
+import org.eclipse.hawkbit.repository.jpa.cache.CacheField;
+import org.eclipse.hawkbit.repository.jpa.cache.CacheKeys;
 import org.eclipse.hawkbit.repository.model.Action;
 import org.eclipse.hawkbit.repository.model.Action.Status;
 import org.eclipse.hawkbit.repository.model.ActionStatus;
@@ -63,6 +66,13 @@ public class JpaActionStatus extends AbstractJpaTenantAwareBaseEntity implements
     @Column(name = "detail_message", length = 512)
     private final List<String> messages = new ArrayList<>();
 
+    /**
+     * Note: filled only in {@link Status#DOWNLOAD}.
+     */
+    @Transient
+    @CacheField(key = CacheKeys.DOWNLOAD_PROGRESS_PERCENT)
+    private int downloadProgressPercent;
+
     /**
      * Creates a new {@link ActionStatus} object.
      *
@@ -105,6 +115,11 @@ public class JpaActionStatus extends AbstractJpaTenantAwareBaseEntity implements
         // JPA default constructor.
     }
 
+    @Override
+    public int getDownloadProgressPercent() {
+        return downloadProgressPercent;
+    }
+
     @Override
     public Long getOccurredAt() {
         return occurredAt;

hawkbit-repository/hawkbit-repository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/cache/CacheWriteNotifyTest.java

@@ -13,7 +13,7 @@ import static org.mockito.Matchers.eq;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-import org.eclipse.hawkbit.eventbus.event.DownloadProgressEvent;
+import org.eclipse.hawkbit.repository.eventbus.event.DownloadProgressEvent;
 import org.eclipse.hawkbit.repository.model.ActionStatus;
 import org.eclipse.hawkbit.tenancy.TenantAware;
 import org.junit.Before;
@@ -59,15 +59,14 @@ public class CacheWriteNotifyTest {
     @Test
     public void downloadgProgressIsCachedAndEventSent() {
         final long knownStatusId = 1;
-        final int knownPercentage = 23;
 
         when(cacheManagerMock.getCache(ActionStatus.class.getName())).thenReturn(cacheMock);
         when(tenantAwareMock.getCurrentTenant()).thenReturn("default");
 
-        underTest.downloadProgressPercent(knownStatusId, knownPercentage, 100L, 500L);
+        underTest.downloadProgress(knownStatusId, 500L, 100L, 100L);
 
         verify(cacheManagerMock).getCache(eq(ActionStatus.class.getName()));
-        verify(cacheMock).put(knownStatusId + "." + CacheKeys.DOWNLOAD_PROGRESS_PERCENT, knownPercentage);
+        verify(cacheMock).put(knownStatusId + "." + CacheKeys.DOWNLOAD_PROGRESS_PERCENT, 20);
         verify(eventBusMock).post(any(DownloadProgressEvent.class));
     }
 

hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/AbstractIntegrationTest.java

@@ -23,7 +23,6 @@ import org.eclipse.hawkbit.repository.TagManagement;
 import org.eclipse.hawkbit.repository.TargetFilterQueryManagement;
 import org.eclipse.hawkbit.repository.TargetManagement;
 import org.eclipse.hawkbit.repository.TenantConfigurationManagement;
-import org.eclipse.hawkbit.repository.TenantStatsManagement;
 import org.eclipse.hawkbit.repository.model.DistributionSetType;
 import org.eclipse.hawkbit.repository.model.SoftwareModuleType;
 import org.eclipse.hawkbit.security.DosFilter;
@@ -94,9 +93,6 @@ public abstract class AbstractIntegrationTest implements EnvironmentAware {
     @Autowired
     protected TargetManagement targetManagement;
 
-    @Autowired
-    protected TenantStatsManagement tenantStatsManagement;
-
     @Autowired
     protected TargetFilterQueryManagement targetFilterQueryManagement;
 

hawkbit-rest-core/src/main/java/org/eclipse/hawkbit/rest/util/RestResourceConversionHelper.java

@@ -320,8 +320,7 @@ public final class RestResourceConversionHelper {
                 // every 10 percent an event
                 if (newPercent == 100 || newPercent > progressPercent + 10) {
                     progressPercent = newPercent;
-                    controllerManagement.downloadProgressPercent(statusId, progressPercent, shippedSinceLastEvent,
+                    controllerManagement.downloadProgress(statusId, length, shippedSinceLastEvent, total);
-                            total);
                     shippedSinceLastEvent = 0;
                 }
             }