Support lists for metadata properties in items files

Signed-off-by: Cody Cutrer <cody@cutrer.us>
openhab · Jul 25, 2024 · c3fdd86 · c3fdd86
1 parent e157448
commit c3fdd86
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 2 deletions.
diff --git a/bundles/org.openhab.core.model.item/src/org/openhab/core/model/Items.xtext b/bundles/org.openhab.core.model.item/src/org/openhab/core/model/Items.xtext
@@ -49,7 +49,7 @@ ModelBinding:
 ;
 
 ModelProperty:
-    key=ID '=' value=ValueType
+    key=ID '=' value+=ValueType (',' value+=ValueType)*
 ;
 
 ValueType returns ecore::EJavaObject:

diff --git a/...openhab.core.model.item/src/org/openhab/core/model/item/internal/GenericItemProvider.java b/...openhab.core.model.item/src/org/openhab/core/model/item/internal/GenericItemProvider.java
@@ -349,7 +349,15 @@ private void internalDispatchBindings(@Nullable BindingConfigReader reader, Stri
             String config = binding.getConfiguration();
 
             Configuration configuration = new Configuration();
-            binding.getProperties().forEach(p -> configuration.put(p.getKey(), p.getValue()));
+            binding.getProperties().forEach(p -> {
+                Object value = p.getValue();
+                // Single valued lists get unwrapped to just their one value for
+                // backwards compatibility
+                if (value instanceof List listValue && listValue.size() == 1) {
+                    value = listValue.get(0);
+                }
+                configuration.put(p.getKey(), value);
+            });
 
             BindingConfigReader localReader = reader;
             if (reader == null) {

diff --git a/...tem.tests/src/main/java/org/openhab/core/model/item/internal/GenericItemProviderTest.java b/...tem.tests/src/main/java/org/openhab/core/model/item/internal/GenericItemProviderTest.java
@@ -623,6 +623,41 @@ public void testMetadataUpdate() {
         assertThat(metadata3, is(nullValue()));
     }
 
+    @Test
+    public void testMetadataPropertyTypes() {
+        String model = "Switch simple { namespace=\"value\"[string=\"string\", bool=false, int=2, stringList=\"string1\",\"string2\", boolList=false,true] } ";
+
+        modelRepository.addOrRefreshModel(TESTMODEL_NAME, new ByteArrayInputStream(model.getBytes()));
+        Item item = itemRegistry.get("simple");
+        assertThat(item, is(notNullValue()));
+
+        Metadata res = metadataRegistry.get(new MetadataKey("namespace", "simple"));
+        assertThat(res, is(notNullValue()));
+        assertThat(res.getValue(), is("value"));
+        assertThat(res.getConfiguration(), is(notNullValue()));
+        var config = res.getConfiguration();
+        assertThat(config.size(), is(5));
+        assertThat(config.get("string"), is("string"));
+        assertThat(config.get("bool"), is(false));
+        assertThat(config.get("int"), is(new BigDecimal("2")));
+
+        var list = config.get("stringList");
+        assertThat(list, is(notNullValue()));
+        assertThat(list, instanceOf(List.class));
+        List<Object> values = (List<Object>) list;
+        assertThat(values.size(), is(2));
+        assertThat(values.get(0), is("string1"));
+        assertThat(values.get(1), is("string2"));
+
+        list = config.get("boolList");
+        assertThat(list, is(notNullValue()));
+        assertThat(list, instanceOf(List.class));
+        values = (List<Object>) list;
+        assertThat(values.size(), is(2));
+        assertThat(values.get(0), is(false));
+        assertThat(values.get(1), is(true));
+    }
+
     @Test
     public void testTagUpdate() {
         modelRepository.addOrRefreshModel(TESTMODEL_NAME, new ByteArrayInputStream("Switch s [foo]".getBytes()));