From c6dfe382d13a8ea2e9b59a7c643809dbf2f724f8 Mon Sep 17 00:00:00 2001
From: Ringo Frischmann <ringo.frischmann@kiwigrid.com>
Date: Thu, 9 Dec 2021 14:15:33 +0100
Subject: [PATCH] Skip standard properties from
 org.eclipse.smarthome.core.thing.Thing

The `org.eclipse.smarthome.core.thing.Thing` predefines some standard property names, so they are not needed in the generated constants. On the other hand, standard values for properties maybe defined in the XML.

This commit introduces these constants as a set so that the generator can skip them.

Signed-off-by: Ringo Frischmann <ringo.frischmann@kiwigrid.com>
---
 .../maven/plugin/GenerateConstantsMojo.java   | 31 ++++++++++++++++++-
 .../resources/ESH-INF/thing/thing-types.xml   | 11 +++++++
 src/test/resources/expected.java              |  2 --
 3 files changed, 41 insertions(+), 3 deletions(-)

diff --git a/src/main/java/io/kokuwa/edge/esh/constants/maven/plugin/GenerateConstantsMojo.java b/src/main/java/io/kokuwa/edge/esh/constants/maven/plugin/GenerateConstantsMojo.java
index da6b6a2..915b799 100644
--- a/src/main/java/io/kokuwa/edge/esh/constants/maven/plugin/GenerateConstantsMojo.java
+++ b/src/main/java/io/kokuwa/edge/esh/constants/maven/plugin/GenerateConstantsMojo.java
@@ -40,6 +40,24 @@
 @Mojo(name = "generate-esh-constants", defaultPhase = LifecyclePhase.GENERATE_SOURCES)
 public class GenerateConstantsMojo extends AbstractMojo {
 
+	/**
+	 * property names which are already defined in org.eclipse.smarthome.core.thing.Thing
+	 */
+	private static final Set<String> STANDARD_PROPERTIES = Set.of(
+		/* the key for the vendor property */
+		"vendor",
+		/* the key for the model ID property */
+		"modelId",
+		/* the key for the serial number property */
+		"serialNumber",
+		/* the key for the hardware version property */
+		"hardwareVersion",
+		/* the key for the firmware version property */
+		"firmwareVersion",
+		/* the key for the MAC address property */
+		"macAddress"
+	);
+
 	@Parameter(property = "esh-constants.inputDirectory",
 			defaultValue = "${project.basedir}/src/main/resources/ESH-INF")
 	private String inputDirectory;
@@ -66,7 +84,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
 		final Map<String, String> constants = new LinkedHashMap<>();
 
 		Set<String> bindingIDs = scanDocuments(inputFiles, "//thing-descriptions/@bindingId");
-		Set<String> properties = scanDocuments(inputFiles, "//property/@name");
+		Set<String> properties = exclude(STANDARD_PROPERTIES, scanDocuments(inputFiles, "//property/@name"));
 		Set<String> thingTypeIDs = scanDocuments(inputFiles, "//thing-type/@id");
 		Set<String> bridgeTypeIDs = scanDocuments(inputFiles, "//bridge-type/@id");
 		Set<String> channelIDs = scanDocuments(inputFiles, "//channel/@id");
@@ -267,4 +285,15 @@ private void writeFile(Path path, String content) throws MojoExecutionException
 			throw new MojoExecutionException("Unable to write file: " + path, e);
 		}
 	}
+
+	/**
+	 * @param exclude the set of values to exclude
+	 * @param candidates the origin value set
+	 * @return a copy of candidates with all values from exclude removed
+	 */
+	private static Set<String> exclude(Set<String> exclude, Set<String> candidates) {
+		return candidates.stream()
+			.filter(candidate -> !exclude.contains(candidate))
+			.collect(Collectors.toSet());
+	}
 }
diff --git a/src/test/resources/ESH-INF/thing/thing-types.xml b/src/test/resources/ESH-INF/thing/thing-types.xml
index 6e2012e..bbcfaf9 100644
--- a/src/test/resources/ESH-INF/thing/thing-types.xml
+++ b/src/test/resources/ESH-INF/thing/thing-types.xml
@@ -32,6 +32,17 @@
                 <unitLabel>minutes</unitLabel>
             </parameter>
         </config-description>
+
+        <!-- standard properties from org.eclipse.smarthome.core.thing.Thing, should be skipped -->
+        <properties>
+            <property name="vendor">N/A</property>
+            <property name="modelId">N/A</property>
+            <property name="serialNumber">N/A</property>
+            <property name="hardwareVersion">N/A</property>
+            <property name="firmwareVersion">N/A</property>
+            <property name="macAddress">N/A</property>
+        </properties>
+
     </thing-type>
 
     <!-- thing definition for encrypted, but still standard meter -->
diff --git a/src/test/resources/expected.java b/src/test/resources/expected.java
index cff219d..9a5af7b 100644
--- a/src/test/resources/expected.java
+++ b/src/test/resources/expected.java
@@ -16,8 +16,6 @@ private Constants() {
 	public static final String BINDING_ID = "wmbus";
 
 	// Constants
-	public static final String PROPERTY_VENDOR = "vendor";
-	public static final String PROPERTY_MODELID = "modelId";
 	public static final String PROPERTY_SERIAL = "serial";
 	public static final String THING_TYPE_ID_ITRON_SMOKE_DETECTOR = "itron_smoke_detector";
 	public static final String THING_TYPE_ID_TECHEM_HKV45 = "techem_hkv45";