Merge pull request #2135 from beyonnex-io/fix-definition-migration-test

fix migrateExistingThing test using mock

Author: thjaeckle

things/service/src/test/java/org/eclipse/ditto/things/service/persistence/actors/strategies/commands/MigrateThingDefinitionStrategyTest.java

@@ -14,7 +14,10 @@
 
 import static org.eclipse.ditto.things.model.TestConstants.Thing.THING_V2;
 
+import java.lang.reflect.Field;
 import java.util.Collections;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
 
 import org.apache.pekko.actor.ActorSystem;
 import org.eclipse.ditto.base.model.headers.DittoHeaders;
@@ -29,22 +32,29 @@
 import org.eclipse.ditto.things.model.signals.commands.modify.MigrateThingDefinitionResponse;
 import org.eclipse.ditto.things.model.signals.events.ThingDefinitionMigrated;
 import org.eclipse.ditto.things.service.persistence.actors.ETagTestUtils;
+import org.eclipse.ditto.wot.api.generator.WotThingSkeletonGenerator;
 import org.junit.Before;
 import org.junit.Test;
 
 import com.typesafe.config.ConfigFactory;
 
+import org.mockito.Mockito;
+
 /**
- * Unit test for {@link MigrateThingDefinitionStrategy} with injected mock of WotThingSkeletonGenerator.
+ * Unit test for {@link MigrateThingDefinitionStrategy}, verifying correct behavior when using a mocked {@link WotThingSkeletonGenerator}.
  */
 public final class MigrateThingDefinitionStrategyTest extends AbstractCommandStrategyTest {
 
+    private static final String TEST_THING_DEFINITION_URL = "https://mock-model-1.0.0.tm.jsonld";
+
     private MigrateThingDefinitionStrategy underTest;
+    private final WotThingSkeletonGenerator skeletonGeneratorMock = Mockito.mock(WotThingSkeletonGenerator.class);
 
     @Before
-    public void setUp() {
+    public void setUp() throws Exception {
         final ActorSystem actorSystem = ActorSystem.create("test", ConfigFactory.load("test"));
         underTest = new MigrateThingDefinitionStrategy(actorSystem);
+        injectSkeletonGeneratorMock(underTest, skeletonGeneratorMock);
     }
 
     @Test
@@ -53,36 +63,50 @@ public void migrateExistingThing() {
         final ThingId thingId = context.getState();
         final Thing existingThing = THING_V2.toBuilder().setRevision(NEXT_REVISION - 1).build();
 
-        final JsonObject migrationPayload = JsonFactory.newObjectBuilder()
-                .set("attributes", JsonFactory.newObjectBuilder().set("manufacturer", "New Corp").build())
-                .build();
+        final Thing skeletonThing = ThingsModelFactory.newThing(getExpectedThingJson());
 
-        final String thingDefinitionUrl =
-                "https://eclipse.dev/ditto/wot/example-models/dimmable-colored-lamp-1.0.0.tm.jsonld";
+        Mockito.when(skeletonGeneratorMock.provideThingSkeletonForCreation(Mockito.any(), Mockito.any(), Mockito.any()))
+                .thenReturn(CompletableFuture.completedFuture(Optional.of(skeletonThing)));
 
         final MigrateThingDefinition command = MigrateThingDefinition.of(
                 thingId,
-                thingDefinitionUrl,
-                migrationPayload,
+                TEST_THING_DEFINITION_URL,
+                JsonObject.empty(),
                 Collections.emptyMap(),
                 true,
                 DittoHeaders.empty()
         );
 
-        final MigrateThingDefinitionResponse expectedResponse = ETagTestUtils.migrateThingDefinitionResponse(thingId,
-                getThingJson(thingDefinitionUrl),
-                getMergedThing(thingDefinitionUrl),
-                command.getDittoHeaders());
+        final MigrateThingDefinitionResponse expectedResponse = ETagTestUtils.migrateThingDefinitionResponse(
+                thingId,
+                getExpectedThingJson(),
+                getExpectedMergedThing(),
+                command.getDittoHeaders()
+        );
+
+        assertStagedModificationResult(underTest, existingThing, command, ThingDefinitionMigrated.class, expectedResponse);
+    }
 
-        assertStagedModificationResult(underTest, existingThing, command, ThingDefinitionMigrated.class,
-                expectedResponse);
+    private void injectSkeletonGeneratorMock(final MigrateThingDefinitionStrategy strategy,
+            final WotThingSkeletonGenerator skeletonGeneratorMock) throws Exception {
+        Class<?> clazz = strategy.getClass();
+        while (clazz != null && !clazz.equals(Object.class)) {
+            try {
+                final Field field = clazz.getDeclaredField("wotThingSkeletonGenerator");
+                field.setAccessible(true);
+                field.set(strategy, skeletonGeneratorMock);
+                return;
+            } catch (final NoSuchFieldException e) {
+                clazz = clazz.getSuperclass();
+            }
+        }
+        throw new NoSuchFieldException("wotThingSkeletonGenerator not found in class hierarchy");
     }
 
-    private static JsonObject getThingJson(String thingDefinitionUrl) {
+    private static JsonObject getExpectedThingJson() {
         return JsonFactory.newObjectBuilder()
-                .set("definition", thingDefinitionUrl)
+                .set("definition", TEST_THING_DEFINITION_URL)
                 .set("attributes", JsonFactory.newObjectBuilder()
-                        .set("manufacturer", "New Corp")
                         .set("on", false)
                         .set("color", JsonFactory.newObjectBuilder()
                                 .set("r", 0)
@@ -94,9 +118,8 @@ private static JsonObject getThingJson(String thingDefinitionUrl) {
                 .build();
     }
 
-
-    private Thing getMergedThing(final String thingDefinitionUrl) {
-        return ThingsModelFactory.newThingBuilder(getThingJson(thingDefinitionUrl))
+    private Thing getExpectedMergedThing() {
+        return ThingsModelFactory.newThingBuilder(getExpectedThingJson())
                 .setRevision(ThingRevision.newInstance(NEXT_REVISION))
                 .build();
     }