[#1580] Software Module & Distribution Set lock: apply (#1648)

forbid software modules / artifacts modification for locked distribution
sets / software modules respectively

Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>

hawkbit-repository/hawkbit-repository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/management/DistributionSetManagementTest.java

@@ -43,6 +43,7 @@ import org.eclipse.hawkbit.repository.exception.EntityNotFoundException;
 import org.eclipse.hawkbit.repository.exception.EntityReadOnlyException;
 import org.eclipse.hawkbit.repository.exception.IncompleteDistributionSetException;
 import org.eclipse.hawkbit.repository.exception.InvalidDistributionSetException;
+import org.eclipse.hawkbit.repository.exception.LockedException;
 import org.eclipse.hawkbit.repository.exception.UnsupportedSoftwareModuleForThisDistributionSetException;
 import org.eclipse.hawkbit.repository.jpa.AbstractJpaIntegrationTest;
 import org.eclipse.hawkbit.repository.jpa.model.JpaDistributionSet;
@@ -1010,7 +1011,39 @@ class DistributionSetManagementTest extends AbstractJpaIntegrationTest {
     }
 
     @Test
-    @Description("Locks an incomplete DS. Expected behaviour is to throw exception and to do not lock it.")
+    @Description("Software modules of a locked DS can't be modified. Expected behaviour is to throw an exception and to do not modify them.")
+    void lockDistributionSetApplied() {
+        final DistributionSet distributionSet = testdataFactory.createDistributionSet("ds-1");
+        final int softwareModuleCount = distributionSet.getModules().size();
+        assertThat(softwareModuleCount).isNotEqualTo(0);
+        distributionSetManagement.lock(distributionSet.getId());
+        assertThat(
+                distributionSetManagement.get(distributionSet.getId()).map(DistributionSet::isLocked)
+                        .orElse(false))
+                .isTrue();
+
+
+        // try add
+        assertThatExceptionOfType(LockedException.class)
+                .as("Attempt to modify a locked DS software modules should throw an exception")
+                .isThrownBy(() -> distributionSetManagement.assignSoftwareModules(
+                        distributionSet.getId(), List.of(testdataFactory.createSoftwareModule("sm-1").getId())));
+        assertThat(distributionSetManagement.get(distributionSet.getId()).get().getModules().size())
+                .as("Software module shall not be added to a locked DS.")
+                .isEqualTo(softwareModuleCount);
+
+        // try remove
+        assertThatExceptionOfType(LockedException.class)
+                .as("Attempt to modify a locked DS software modules should throw an exception")
+                .isThrownBy(() -> distributionSetManagement.unassignSoftwareModule(
+                        distributionSet.getId(), distributionSet.getModules().stream().findFirst().get().getId()));
+        assertThat(distributionSetManagement.get(distributionSet.getId()).get().getModules().size())
+                .as("Software module shall not be removed from a locked DS.")
+                .isEqualTo(softwareModuleCount);
+    }
+
+    @Test
+    @Description("Locks an incomplete DS. Expected behaviour is to throw an exception and to do not lock it.")
     void lockIncompleteDistributionSetFails() {
         final DistributionSet incompleteDistributionSet = testdataFactory.createIncompleteDistributionSet();
         assertThatExceptionOfType(IncompleteDistributionSetException.class)

hawkbit-repository/hawkbit-repository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/management/SoftwareModuleManagementTest.java

@@ -28,6 +28,7 @@ import org.eclipse.hawkbit.repository.builder.SoftwareModuleMetadataCreate;
 import org.eclipse.hawkbit.repository.event.remote.entity.SoftwareModuleCreatedEvent;
 import org.eclipse.hawkbit.repository.exception.AssignmentQuotaExceededException;
 import org.eclipse.hawkbit.repository.exception.EntityAlreadyExistsException;
+import org.eclipse.hawkbit.repository.exception.LockedException;
 import org.eclipse.hawkbit.repository.jpa.AbstractJpaIntegrationTest;
 import org.eclipse.hawkbit.repository.jpa.RandomGeneratedInputStream;
 import org.eclipse.hawkbit.repository.jpa.model.JpaAction_;
@@ -824,7 +825,7 @@ public class SoftwareModuleManagementTest extends AbstractJpaIntegrationTest {
     @Test
     @Description("Locks a SM.")
     void lockSoftwareModule() {
-        final SoftwareModule softwareModule = testdataFactory.createSoftwareModule("ds-1");
+        final SoftwareModule softwareModule = testdataFactory.createSoftwareModule("sm-1");
         assertThat(
                 softwareModuleManagement.get(softwareModule.getId()).map(SoftwareModule::isLocked).orElse(true))
                 .isFalse();
@@ -834,6 +835,43 @@ public class SoftwareModuleManagementTest extends AbstractJpaIntegrationTest {
                 .isTrue();
     }
 
+    @Test
+    @Description("Artifacts of a locked SM can't be modified. Expected behaviour is to throw an exception and to do not modify them.")
+    void lockSoftwareModuleApplied() {
+        final SoftwareModule softwareModule = testdataFactory.createSoftwareModule("sm-1");
+        artifactManagement.create(
+                new ArtifactUpload(new ByteArrayInputStream(new byte[] {1}), softwareModule.getId(),
+                        "artifact1", false, 1));
+        final int artifactCount = softwareModuleManagement.get(softwareModule.getId()).get().getArtifacts().size();
+        assertThat(artifactCount).isNotEqualTo(0);
+        softwareModuleManagement.lock(softwareModule.getId());
+        assertThat(
+                softwareModuleManagement.get(softwareModule.getId()).map(SoftwareModule::isLocked).orElse(false))
+                .isTrue();
+
+
+        // try add
+        assertThatExceptionOfType(LockedException.class)
+                .as("Attempt to modify a locked SM artifacts should throw an exception")
+                .isThrownBy(() -> artifactManagement.create(
+                        new ArtifactUpload(new ByteArrayInputStream(new byte[] {2}), softwareModule.getId(),
+                                "artifact2", false, 1)));
+        assertThat(softwareModuleManagement.get(softwareModule.getId()).get().getArtifacts().size())
+                .as("Artifacts shall not be added to a locked SM.")
+                .isEqualTo(artifactCount);
+
+        // try remove
+        final long artifactId = softwareModuleManagement.get(softwareModule.getId()).get()
+                .getArtifacts().stream().findFirst().get().getId();
+        assertThatExceptionOfType(LockedException.class)
+                .as("Attempt to modify a locked DS software modules should throw an exception")
+                .isThrownBy(() -> artifactManagement.delete(artifactId));
+        assertThat(softwareModuleManagement.get(softwareModule.getId()).get().getArtifacts().size())
+                .as("Software module shall not be removed from a locked DS.")
+                .isEqualTo(artifactCount);
+        assertThat(artifactManagement.get(artifactId)).isPresent();
+    }
+
     @Test
     @Description("Verifies that non existing metadata find results in exception.")
     public void findSoftwareModuleMetadataFailsIfEntryDoesNotExist() {