Abstract RepositoryManagement test (#2631)

* Abstract RepositoryManagement  test

* mvn_in

* Small management interface cleanup

Author: avgustinmm

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

@@ -239,11 +239,10 @@ public interface ControllerManagement {
      *
      * @param actionId to the handle status for
      * @param message for the status
-     * @return the update action in case the status has been changed to {@link Status#RETRIEVED}
      * @throws EntityNotFoundException if action with given ID does not exist
      */
     @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER)
-    Action registerRetrieved(long actionId, String message);
+    void registerRetrieved(long actionId, String message);
 
     /**
      * Updates attributes of the controller according to the given {@link UpdateMode}.
@@ -260,8 +259,7 @@ public interface ControllerManagement {
     Target updateControllerAttributes(@NotEmpty String controllerId, @NotNull Map<String, String> attributes, UpdateMode mode);
 
     /**
-     * Finds {@link Target} based on given controller ID returns found Target without details, i.e.
-     * NO {@link Target#getTags()} and {@link Target#getActions()} possible.
+     * Finds {@link Target} based on given controller ID returns found Target without details
      *
      * @param controllerId to look for.
      * @return {@link Target} or {@code null} if it does not exist
@@ -271,9 +269,7 @@ public interface ControllerManagement {
     Optional<Target> findByControllerId(@NotEmpty String controllerId);
 
     /**
-     * Finds {@link Target} based on given ID returns found Target without details, i.e.
-     * NO {@link Target#getTags()} and {@link Target#getActions()}
-     * possible.
+     * Finds {@link Target} based on given ID returns found Target without details
      *
      * @param targetId to look for.
      * @return {@link Target} or {@code null} if it does not exist

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

@@ -242,16 +242,6 @@ List<DistributionSetAssignmentResult> assignDistributionSets(
     @PreAuthorize(SpringEvalExpressions.HAS_READ_REPOSITORY)
     Page<ActionStatus> findActionStatusByAction(long actionId, @NotNull Pageable pageable);
 
-    /**
-     * Counts all the {@link ActionStatus} entries of the given {@link Action}.
-     *
-     * @param actionId to be filtered on
-     * @return count of {@link ActionStatus} entries
-     * @throws EntityNotFoundException if action with given ID does not exist
-     */
-    @PreAuthorize(SpringEvalExpressions.HAS_READ_REPOSITORY)
-    long countActionStatusByAction(long actionId);
-
     /**
      * Retrieves all messages for an {@link ActionStatus}.<p/>
      * No entity based access control applied.

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

@@ -13,7 +13,6 @@
 import org.eclipse.hawkbit.im.authentication.SpringEvalExpressions;
 import org.eclipse.hawkbit.repository.model.DistributionSet;
 import org.eclipse.hawkbit.repository.model.DistributionSetInvalidation;
-import org.eclipse.hawkbit.repository.model.DistributionSetInvalidationCount;
 import org.springframework.security.access.prepost.PreAuthorize;
 
 /**

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

@@ -9,9 +9,6 @@
  */
 package org.eclipse.hawkbit.repository;
 
-import java.util.Optional;
-
-import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
 
@@ -20,17 +17,9 @@
 import lombok.ToString;
 import lombok.experimental.SuperBuilder;
 import org.eclipse.hawkbit.im.authentication.SpPermission;
-import org.eclipse.hawkbit.im.authentication.SpringEvalExpressions;
-import org.eclipse.hawkbit.repository.exception.EntityNotFoundException;
-import org.eclipse.hawkbit.repository.model.DistributionSet;
 import org.eclipse.hawkbit.repository.model.DistributionSetTag;
 import org.eclipse.hawkbit.repository.model.NamedEntity;
 import org.eclipse.hawkbit.repository.model.Tag;
-import org.eclipse.hawkbit.repository.model.Target;
-import org.eclipse.hawkbit.repository.model.TargetTag;
-import org.springframework.data.domain.Page;
-import org.springframework.data.domain.Pageable;
-import org.springframework.security.access.prepost.PreAuthorize;
 
 /**
  * Management service for {@link DistributionSetTag}s.

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

@@ -88,11 +88,9 @@ public static void validateMaintenanceSchedule(final String cronSchedule, final
         if (allNotEmpty(cronSchedule, duration, timezone)) {
             validateCronSchedule(cronSchedule);
             validateDuration(duration);
-            // check if there is a window currently active or available in
-            // future.
-            if (!getNextMaintenanceWindow(cronSchedule, duration, timezone).isPresent()) {
-                throw new InvalidMaintenanceScheduleException(
-                        "No valid maintenance window available after current time");
+            // check if there is a window currently active or available in the future.
+            if (getNextMaintenanceWindow(cronSchedule, duration, timezone).isEmpty()) {
+                throw new InvalidMaintenanceScheduleException("No valid maintenance window available after current time");
             }
         } else if (atLeastOneNotEmpty(cronSchedule, duration, timezone)) {
             throw new InvalidMaintenanceScheduleException("All of schedule, duration and timezone should either be null or non empty.");

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

@@ -18,11 +18,9 @@
 import org.springframework.data.domain.Sort;
 
 /**
- * An implementation of the {@link PageRequest} which is offset based by means
- * the offset is given and not the page number as in the original
- * {@link PageRequest} implementation where the offset is generated. Due that
- * the REST-API is working with {@code offset} and {@code limit} parameter we
- * need an offset based page request.
+ * An implementation of the {@link PageRequest} which is offset based by means the offset is given and not the page number as in the original
+ * {@link PageRequest} implementation where the offset is generated. Due to the REST-API is working with {@code offset} and {@code limit}
+ * parameter we need an offset based page request.
  */
 @Getter
 @EqualsAndHashCode(callSuper = true)

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

@@ -20,8 +20,7 @@
 public interface QuotaManagement {
 
     /**
-     * @return maximum number of {@link ActionStatus} entries that the
-     *         controller can report for an {@link Action}.
+     * @return maximum number of {@link ActionStatus} entries that the controller can report for an {@link Action}.
      */
     int getMaxStatusEntriesPerAction();
 
@@ -31,15 +30,12 @@ public interface QuotaManagement {
     int getMaxAttributeEntriesPerTarget();
 
     /**
-     * @return maximum number of allowed {@link RolloutGroup}s per
-     *         {@link Rollout}.
+     * @return maximum number of allowed {@link RolloutGroup}s per {@link Rollout}.
      */
     int getMaxRolloutGroupsPerRollout();
 
     /**
-     * @return maximum number of
-     *         {@link ControllerManagement#getActionHistoryMessages(Long, int)}
-     *         for an individual {@link ActionStatus}.
+     * @return maximum number of action (history) messages per actions status.
      */
     int getMaxMessagesPerActionStatus();
 
@@ -49,7 +45,7 @@ public interface QuotaManagement {
     int getMaxMetaDataEntriesPerSoftwareModule();
 
     /**
-     * @return maximum number of meta data entries per distribution set
+     * @return maximum number of metadata entries per distribution set
      */
     int getMaxMetaDataEntriesPerDistributionSet();
 
@@ -80,14 +76,12 @@ public interface QuotaManagement {
     int getMaxTargetsPerRolloutGroup();
 
     /**
-     * @return the maximum number of target distribution set assignments
-     *         resulting from a manual assignment
+     * @return the maximum number of target distribution set assignments resulting from a manual assignment
      */
     int getMaxTargetDistributionSetAssignmentsPerManualAssignment();
 
     /**
-     * @return the maximum number of targets for an automatic distribution set
-     *         assignment
+     * @return the maximum number of targets for an automatic distribution set assignment
      */
     int getMaxTargetsPerAutoAssignment();
 
@@ -110,5 +104,4 @@ public interface QuotaManagement {
      * @return the maximum number of distribution set types per target type
      */
     int getMaxDistributionSetTypesPerTargetType();
-
-}
+}

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

@@ -12,7 +12,6 @@
 import lombok.AccessLevel;
 import lombok.NoArgsConstructor;
 import org.eclipse.hawkbit.repository.model.Action;
-import org.eclipse.hawkbit.repository.model.ActionStatus;
 import org.eclipse.hawkbit.repository.model.DistributionSetType;
 import org.eclipse.hawkbit.repository.model.SoftwareModule;
 
@@ -23,15 +22,12 @@
 public final class RepositoryConstants {
 
     /**
-     * Prefix that the server puts in front of
-     * {@link ActionStatus#getMessages()} if the message is generated by the
-     * server.
+     * Prefix that the server puts in front of action status messages if the message is generated by the server.
      */
     public static final String SERVER_MESSAGE_PREFIX = "Update Server: ";
 
     /**
-     * Number of {@link DistributionSetType}s that are generated as part of
-     * default tenant setup.
+     * Number of {@link DistributionSetType}s that are generated as part of default tenant setup.
      */
     public static final int DEFAULT_DS_TYPES_IN_TENANT = 3;
 
@@ -41,8 +37,7 @@ public final class RepositoryConstants {
     public static final int MAX_ACTION_COUNT = 100;
 
     /**
-     * Maximum number of messages that can be retrieved by a controller for an
-     * {@link Action}.
+     * Maximum number of messages that can be retrieved by a controller for an {@link Action}.
      */
     public static final int MAX_ACTION_HISTORY_MSG_COUNT = 100;
 

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

@@ -10,8 +10,9 @@
 package org.eclipse.hawkbit.repository;
 
 import org.eclipse.hawkbit.im.authentication.SpringEvalExpressions;
-
 import org.eclipse.hawkbit.repository.model.Rollout;
+import org.eclipse.hawkbit.repository.model.Rollout.RolloutStatus;
+import org.eclipse.hawkbit.repository.model.RolloutGroup;
 import org.eclipse.hawkbit.repository.model.Target;
 import org.springframework.security.access.prepost.PreAuthorize;
 
@@ -22,32 +23,25 @@
 public interface RolloutExecutor {
 
     /**
-     * This execution should only be triggered by the system as a background job and
-     * not available via API.
-     *
+     * This execution should only be triggered by the system as a background job and not available via API.
+     * <p/>
      * Process rollout based on its current {@link Rollout#getStatus()}.
-     *
-     * For {@link RolloutStatus#CREATING} that means creating the
-     * {@link RolloutGroup}s with {@link Target}s and when finished switch to
-     * {@link RolloutStatus#READY}.
-     *
-     * For {@link RolloutStatus#READY} that means switching to
-     * {@link RolloutStatus#STARTING} if the {@link Rollout#getStartAt()} is set and
-     * time of calling this method is beyond this point in time. This auto start
-     * mechanism is optional. Call {@link #start(Long)} otherwise.
-     *
-     * For {@link RolloutStatus#STARTING} that means starting the first
-     * {@link RolloutGroup}s in line and when finished switch to
+     * <p/>
+     * For {@link RolloutStatus#CREATING} that means creating the {@link org.eclipse.hawkbit.repository.model.RolloutGroup}s
+     * with {@link Target}s and when finished switch to {@link RolloutStatus#READY}.
+     * <p/>
+     * For {@link RolloutStatus#READY} that means switching to {@link RolloutStatus#STARTING} if the {@link Rollout#getStartAt()} is set and
+     * time of calling this method is beyond this point in time. This auto start mechanism is optional.
+     * Call {@link RolloutManagement#start(long)} otherwise.
+     * <p/>
+     * For {@link RolloutStatus#STARTING} that means starting the first {@link RolloutGroup}s in line and when finished switch to
      * {@link RolloutStatus#RUNNING}.
-     *
-     * For {@link RolloutStatus#RUNNING} that means checking to activate further
-     * groups based on the defined thresholds. Switched to
+     * <p/>
+     * For {@link RolloutStatus#RUNNING} that means checking to activate further groups based on the defined thresholds. Switched to
      * {@link RolloutStatus#FINISHED} is all groups are finished.
-     *
-     * For {@link RolloutStatus#DELETING} that means either soft delete in case
-     * rollout was already {@link RolloutStatus#RUNNING} which results in status
-     * change {@link RolloutStatus#DELETED} or hard delete from the persistence
-     * otherwise.
+     * <p/>
+     * For {@link RolloutStatus#DELETING} that means either soft delete in case rollout was already {@link RolloutStatus#RUNNING}
+     * which results in status change {@link RolloutStatus#DELETED} or hard delete from the persistence otherwise.
      */
     @PreAuthorize(SpringEvalExpressions.IS_SYSTEM_CODE)
     void execute(Rollout rollout);