Add YamlModelRepository test for removal of version or element type (#4758)

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>

Author: jimtng

bundles/org.openhab.core.model.yaml/src/test/java/org/openhab/core/model/yaml/internal/YamlModelRepositoryImplTest.java

@@ -32,6 +32,8 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.junit.jupiter.api.io.TempDir;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
 import org.mockito.ArgumentCaptor;
 import org.mockito.Captor;
 import org.mockito.Mock;
@@ -120,9 +122,9 @@ public void testFileAddedAfterListeners() throws IOException {
         List<Collection<FirstTypeDTO>> firstTypeCaptorValues = firstTypeCaptor.getAllValues();
         assertThat(firstTypeCaptorValues, hasSize(2));
         List<Collection<SecondTypeDTO>> secondTypeCaptor1Values = secondTypeCaptor1.getAllValues();
-        assertThat(firstTypeCaptorValues, hasSize(2));
+        assertThat(secondTypeCaptor1Values, hasSize(2));
         List<Collection<SecondTypeDTO>> secondTypeCaptor2Values = secondTypeCaptor2.getAllValues();
-        assertThat(firstTypeCaptorValues, hasSize(2));
+        assertThat(secondTypeCaptor2Values, hasSize(2));
 
         Collection<FirstTypeDTO> firstTypeElements = firstTypeCaptorValues.getFirst();
         Collection<SecondTypeDTO> secondTypeElements1 = secondTypeCaptor1Values.getFirst();
@@ -179,9 +181,9 @@ public void testFileAddedBeforeListeners() throws IOException {
         List<Collection<FirstTypeDTO>> firstTypeCaptorValues = firstTypeCaptor.getAllValues();
         assertThat(firstTypeCaptorValues, hasSize(2));
         List<Collection<SecondTypeDTO>> secondTypeCaptor1Values = secondTypeCaptor1.getAllValues();
-        assertThat(firstTypeCaptorValues, hasSize(2));
+        assertThat(secondTypeCaptor1Values, hasSize(2));
         List<Collection<SecondTypeDTO>> secondTypeCaptor2Values = secondTypeCaptor2.getAllValues();
-        assertThat(firstTypeCaptorValues, hasSize(2));
+        assertThat(secondTypeCaptor2Values, hasSize(2));
 
         Collection<FirstTypeDTO> firstTypeElements = firstTypeCaptorValues.getFirst();
         Collection<SecondTypeDTO> secondTypeElements1 = secondTypeCaptor1Values.getFirst();
@@ -268,6 +270,50 @@ public void testFileUpdated() throws IOException {
         assertThat(firstTypeCaptorValues.get(7), contains(new FirstTypeDTO("Third", "Third original")));
     }
 
+    @ParameterizedTest
+    @CsvSource({ //
+            "modelFileUpdateRemovedElements.yaml,modelV2FileUpdateRemovedElements.yaml",
+            "modelFileUpdateRenamedElements.yaml,modelV2FileUpdateRenamedElements.yaml",
+            "modelFileUpdateRemovedVersion.yaml,modelV2FileUpdateRemovedVersion.yaml" //
+    })
+    public void testFileRemovedElements(String v1File, String v2File) throws IOException {
+        YamlModelRepositoryImpl modelRepository = new YamlModelRepositoryImpl(watchServiceMock);
+        modelRepository.addYamlModelListener(firstTypeListener);
+
+        // File in v1 format
+        Files.copy(SOURCE_PATH.resolve("modelFileUpdatePost.yaml"), fullModelPath);
+        modelRepository.processWatchEvent(WatchService.Kind.CREATE, MODEL_PATH);
+        verify(firstTypeListener).addedModel(eq(MODEL_NAME), any());
+
+        Files.copy(SOURCE_PATH.resolve(v1File), fullModelPath, StandardCopyOption.REPLACE_EXISTING);
+        modelRepository.processWatchEvent(WatchService.Kind.MODIFY, MODEL_PATH);
+        verify(firstTypeListener).removedModel(eq(MODEL_NAME), firstTypeCaptor.capture());
+
+        Collection<FirstTypeDTO> firstTypeElements = firstTypeCaptor.getAllValues().getFirst();
+
+        // Check that the elements were removed
+        assertThat(firstTypeElements, hasSize(3));
+        assertThat(firstTypeElements, containsInAnyOrder(new FirstTypeDTO("First", "First original"),
+                new FirstTypeDTO("Second", "Second original"), new FirstTypeDTO("Third", "Third original")));
+
+        // File in v2 format
+        Files.copy(SOURCE_PATH.resolve("modelV2FileUpdatePost.yaml"), fullModel2Path);
+        modelRepository.processWatchEvent(WatchService.Kind.CREATE, MODEL2_PATH);
+        verify(firstTypeListener).addedModel(eq(MODEL2_NAME), any());
+
+        Files.copy(SOURCE_PATH.resolve(v2File), fullModel2Path, StandardCopyOption.REPLACE_EXISTING);
+        modelRepository.processWatchEvent(WatchService.Kind.MODIFY, MODEL2_PATH);
+        verify(firstTypeListener).removedModel(eq(MODEL2_NAME), firstTypeCaptor.capture());
+
+        assertThat(firstTypeCaptor.getAllValues(), hasSize(2));
+        firstTypeElements = firstTypeCaptor.getAllValues().getLast();
+
+        // Check that the elements were removed
+        assertThat(firstTypeElements, hasSize(3));
+        assertThat(firstTypeElements, containsInAnyOrder(new FirstTypeDTO("First", "First original"),
+                new FirstTypeDTO("Second", "Second original"), new FirstTypeDTO("Third", "Third original")));
+    }
+
     @Test
     public void testFileRemoved() throws IOException {
         YamlModelRepositoryImpl modelRepository = new YamlModelRepositoryImpl(watchServiceMock);

bundles/org.openhab.core.model.yaml/src/test/resources/model/modelFileUpdateRemovedElements.yaml

@@ -0,0 +1,4 @@
+# A YAML test file for updating the model
+
+version: 1
+

bundles/org.openhab.core.model.yaml/src/test/resources/model/modelFileUpdateRemovedVersion.yaml

@@ -0,0 +1,11 @@
+# A YAML test file for updating the model
+
+# version: 1 => removed in this update
+
+firstType:
+  - uid: First
+    description: First original
+  - uid: Second
+    description: Second original
+  - uid: Third
+    description: Third original

bundles/org.openhab.core.model.yaml/src/test/resources/model/modelFileUpdateRenamedElements.yaml

@@ -0,0 +1,11 @@
+# A YAML test file for updating the model
+
+version: 1
+
+firstTypeRenamed:
+  - uid: First
+    description: First original
+  - uid: Second
+    description: Second original
+  - uid: Third
+    description: Third original

bundles/org.openhab.core.model.yaml/src/test/resources/model/modelV2FileUpdateRemovedElements.yaml

@@ -0,0 +1,3 @@
+# A YAML test file for updating the model
+
+version: 2

bundles/org.openhab.core.model.yaml/src/test/resources/model/modelV2FileUpdateRemovedVersion.yaml

@@ -0,0 +1,11 @@
+# A YAML test file in version 2 for updating the model
+
+# version: 2 => removed
+
+firstType:
+  First:
+    description: First original
+  Second:
+    description: Second original
+  Third:
+    description: Third original

bundles/org.openhab.core.model.yaml/src/test/resources/model/modelV2FileUpdateRenamedElements.yaml

@@ -0,0 +1,11 @@
+# A YAML test file for updating the model
+
+version: 2
+
+firstTypeRenamed:
+  First:
+    description: First original
+  Second:
+    description: Second original
+  Third:
+    description: Third original