core/ConfigUtil: Do not normalize objectClass, component.name, component.id configuration values

bundles/config/org.eclipse.smarthome.config.core.test/src/test/java/org/eclipse/smarthome/config/core/ConfigUtilTest.java

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) 2014-2017 by the respective copyright holders.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.smarthome.config.core;
+
+import static org.hamcrest.CoreMatchers.*;
+import static org.junit.Assert.assertThat;
+
+import java.math.BigDecimal;
+import java.net.*;
+import java.util.*;
+
+import org.eclipse.smarthome.config.core.ConfigDescriptionParameter.Type;
+import org.junit.Test;
+
+/**
+ *
+ * @author Simon Kaufmann - initial contribution and API.
+ *
+ */
+class ConfigUtilTest {
+    private Map<String, Object> m(String a, Object b) {
+        Map<String, Object> m = new HashMap<>();
+        m.put(a, b);
+        return m;
+    }
+
+    private static class L<T> extends ArrayList<T> {
+        L(T... args) {
+            for (T arg : args) {
+                add(arg);
+            }
+        }
+    };
+
+    @Test
+    public void firstDesciptionWinsForNormalization() throws URISyntaxException {
+        ConfigDescription configDescriptionInteger = new ConfigDescription(new URI("thing:fooThing"),
+                new L<>(new ConfigDescriptionParameter("foo", Type.INTEGER)));
+
+        ConfigDescription configDescriptionString = new ConfigDescription(new URI("thingType:fooThing"),
+                new L<>(new ConfigDescriptionParameter("foo", Type.TEXT)));
+
+        assertThat(ConfigUtil.normalizeTypes(m("foo", "1"), new L<>(configDescriptionInteger)).get("foo"),
+                is(instanceOf(BigDecimal.class)));
+        assertThat(ConfigUtil.normalizeTypes(m("foo", "1"), new L<>(configDescriptionString)).get("foo"),
+                is(instanceOf(String.class)));
+        assertThat(ConfigUtil.normalizeTypes(m("foo", "1"), new L<>(configDescriptionInteger, configDescriptionString))
+                .get("foo"), is(instanceOf(BigDecimal.class)));
+        assertThat(ConfigUtil.normalizeTypes(m("foo", "1"), new L<>(configDescriptionString, configDescriptionInteger))
+                .get("foo"), is(instanceOf(String.class)));
+    }
+}

bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/ConfigUtil.java

@@ -27,6 +27,14 @@
  * @author Thomas Höfer - Minor changes for type normalization based on config description
  */
 public class ConfigUtil {
+    /**
+     * We do not want to handle or try to normalize OSGi provided configuration parameters
+     *
+     * @param name The configuration parameter name
+     */
+    private static boolean isOSGiConfigParameter(String name) {
+        return name.equals("objectClass") || name.equals("component.name") || name.equals("component.id");
+    }
 
     /**
      * Normalizes the types to the ones allowed for configurations.
@@ -35,11 +43,13 @@ public class ConfigUtil {
      * @return normalized configuration
      */
     public static Map<String, Object> normalizeTypes(Map<String, Object> configuration) {
-        Map<String, Object> convertedConfiguration = new HashMap<String, Object>(configuration.size());
+        Map<String, Object> convertedConfiguration = new HashMap<>(configuration.size());
         for (Entry<String, Object> parameter : configuration.entrySet()) {
             String name = parameter.getKey();
             Object value = parameter.getValue();
-            convertedConfiguration.put(name, normalizeType(value));
+            if (!isOSGiConfigParameter(name)) {
+                convertedConfiguration.put(name, normalizeType(value));
+            }
         }
         return convertedConfiguration;
     }
@@ -129,7 +139,7 @@ public static Map<String, Object> normalizeTypes(Map<String, Object> configurati
             return null;
         }
 
-        Map<String, Object> convertedConfiguration = new HashMap<String, Object>(configuration.size());
+        Map<String, Object> convertedConfiguration = new HashMap<>();
 
         Map<String, ConfigDescriptionParameter> configParams = new HashMap<>();
         for (int i = configDescriptions.size() - 1; i >= 0; i--) {
@@ -138,8 +148,10 @@ public static Map<String, Object> normalizeTypes(Map<String, Object> configurati
         for (Entry<String, ?> parameter : configuration.entrySet()) {
             String name = parameter.getKey();
             Object value = parameter.getValue();
-            ConfigDescriptionParameter configDescriptionParameter = configParams.get(name);
-            convertedConfiguration.put(name, normalizeType(value, configDescriptionParameter));
+            if (!isOSGiConfigParameter(name)) {
+                ConfigDescriptionParameter configDescriptionParameter = configParams.get(name);
+                convertedConfiguration.put(name, normalizeType(value, configDescriptionParameter));
+            }
         }
         return convertedConfiguration;
     }