Add manufacturerSpecificId to Device model and tests (#29)

* Add manufacturerSpecificId to Device model and tests Updated the Device model to include the 'manufacturerSpecificId' field and modified all the 'DeviceIntegrationService*' and 'DroneDeviceMeasurementIntegrationService' integration tests to include the 'manufacturerSpecificId' in their respective Device builder. This change ensures more detailed device identification and improved traceability in device-related operations in the system. * Modify FiwareIdGenerator to be a utility class FiwareIdGenerator has been updated to a final class with a private constructor that cannot be instantiated. This transformation ensures the class can only contain static methods, making it a utility class which is with respect to Java best practices.
vitrum-connect · Nov 25, 2023 · 49d5bed · 49d5bed
1 parent 079f4ee
commit 49d5bed
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 18 deletions.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>de.app.5gla</groupId>
     <artifactId>fiware-integration-layer</artifactId>
-    <version>6.2.0</version>
+    <version>6.3.0</version>
 
     <name>5gLa FIWARE integration layer</name>
     <url>https://github.com/vitrum-connect/5gla-fiware-integration-layer</url>

diff --git a/src/main/java/de/app/fivegla/fiware/api/FiwareIdGenerator.java b/src/main/java/de/app/fivegla/fiware/api/FiwareIdGenerator.java
@@ -0,0 +1,47 @@
+package de.app.fivegla.fiware.api;
+
+import lombok.extern.slf4j.Slf4j;
+
+import java.util.UUID;
+
+/**
+ * This class provides methods for generating FIWARE IDs.
+ * FIWARE IDs are used to uniquely identify entities in the FIWARE ecosystem.
+ */
+@Slf4j
+public final class FiwareIdGenerator {
+
+    private FiwareIdGenerator() {
+        // private constructor to prevent instantiation
+    }
+
+    /**
+     * Generates a unique identifier with the given prefix.
+     * The generated identifier is a combination of the prefix and two parts of a randomly generated UUID string.
+     * If the length of the generated identifier exceeds 62 characters, a FiwareIntegrationLayerException will be thrown.
+     *
+     * @param prefix the prefix to be appended to the randomly generated UUID parts
+     * @return a unique identifier generated by combining the prefix and two parts of a randomly generated UUID string
+     * @throws FiwareIntegrationLayerException if the length of the generated identifier exceeds 62 characters
+     */
+    public static String id(String prefix) {
+        var randomUUIDParts = UUID.randomUUID().toString().split("-");
+        var fiwareId = prefix + randomUUIDParts[0] + randomUUIDParts[1];
+        if (fiwareId.length() > 62) {
+            throw new FiwareIntegrationLayerException("The generated id is too long. Please choose a shorter prefix.");
+        } else {
+            log.debug("Generated id: " + fiwareId);
+            return fiwareId;
+        }
+    }
+
+    /**
+     * Generates a unique ID.
+     *
+     * @return a unique ID string
+     */
+    public static String id() {
+        return id("");
+    }
+
+}
diff --git a/src/test/java/de/app/fivegla/fiware/DeviceIntegrationServiceBasedOnTenantIT.java b/src/test/java/de/app/fivegla/fiware/DeviceIntegrationServiceBasedOnTenantIT.java
@@ -1,5 +1,6 @@
 package de.app.fivegla.fiware;
 
+import de.app.fivegla.fiware.api.FiwareIdGenerator;
 import de.app.fivegla.fiware.api.enums.DeviceCategoryValues;
 import de.app.fivegla.fiware.model.Device;
 import de.app.fivegla.fiware.model.DeviceCategory;
@@ -8,16 +9,15 @@
 import org.junit.jupiter.api.Test;
 
 import java.util.List;
-import java.util.UUID;
 
 class DeviceIntegrationServiceBasedOnTenantIT extends AbstractIT {
 
     @Test
     void givenExistingPackagePropertiesWhenFetchingTheVersionTheServiceShouldReturnTheCurrentVersion() {
         var fiwareIntegrationServiceForFoo = new DeviceIntegrationService(contextBrokerUrl, "foo");
         var fiwareIntegrationServiceForBar = new DeviceIntegrationService(contextBrokerUrl, "bar");
-        var manufacturerSpecificIdForFoo = UUID.randomUUID().toString();
-        var manufacturerSpecificIdForBar = UUID.randomUUID().toString();
+        var manufacturerSpecificIdForFoo = FiwareIdGenerator.id();
+        var manufacturerSpecificIdForBar = FiwareIdGenerator.id();
 
         var deviceForFoo = Device.builder()
                 .id("integration-test:" + manufacturerSpecificIdForFoo)

diff --git a/src/test/java/de/app/fivegla/fiware/DeviceIntegrationServiceIT.java b/src/test/java/de/app/fivegla/fiware/DeviceIntegrationServiceIT.java
@@ -1,5 +1,6 @@
 package de.app.fivegla.fiware;
 
+import de.app.fivegla.fiware.api.FiwareIdGenerator;
 import de.app.fivegla.fiware.api.FiwareIntegrationLayerException;
 import de.app.fivegla.fiware.api.enums.DeviceCategoryValues;
 import de.app.fivegla.fiware.model.Device;
@@ -9,14 +10,13 @@
 import org.junit.jupiter.api.Test;
 
 import java.util.List;
-import java.util.UUID;
 
 class DeviceIntegrationServiceIT extends AbstractIT {
 
     @Test
     void givenExistingPackagePropertiesWhenFetchingTheVersionTheServiceShouldReturnTheCurrentVersion() {
         var fiwareIntegrationService = new DeviceIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var id = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(id)
@@ -35,7 +35,7 @@ void givenExistingPackagePropertiesWhenFetchingTheVersionTheServiceShouldReturnT
     @Test
     void givenAlreadyExistingDeviceWhenCreatingNewDevicesTheServiceShouldNotThrowAnException() {
         var fiwareIntegrationService = new DeviceIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var id = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(id)
@@ -56,7 +56,7 @@ void givenAlreadyExistingDeviceWhenCreatingNewDevicesTheServiceShouldNotThrowAnE
     @Test
     void givenAlreadyExistingDeviceWhenUpdatingTheDeviceTheServiceShouldUpdateTheValuesForTheDevice() {
         var fiwareIntegrationService = new DeviceIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var id = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(id)
@@ -85,7 +85,7 @@ void givenAlreadyExistingDeviceWhenUpdatingTheDeviceTheServiceShouldUpdateTheVal
     @Test
     void givenExistingDeviceWhenCheckingIfTheDeviceDoesExistTheServiceShouldReturnTrue() {
         var fiwareIntegrationService = new DeviceIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var id = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(id)
@@ -105,7 +105,7 @@ void givenExistingDeviceWhenCheckingIfTheDeviceDoesExistTheServiceShouldReturnTr
     @Test
     void givenExistingDeviceWhenDeletingIfTheDeviceDoesExistTheServiceShouldReturnTrue() {
         var fiwareIntegrationService = new DeviceIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var id = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(id)

diff --git a/src/test/java/de/app/fivegla/fiware/DeviceMeasurementIntegrationServiceIT.java b/src/test/java/de/app/fivegla/fiware/DeviceMeasurementIntegrationServiceIT.java
@@ -1,5 +1,6 @@
 package de.app.fivegla.fiware;
 
+import de.app.fivegla.fiware.api.FiwareIdGenerator;
 import de.app.fivegla.fiware.api.enums.DeviceCategoryValues;
 import de.app.fivegla.fiware.model.Device;
 import de.app.fivegla.fiware.model.DeviceCategory;
@@ -16,7 +17,7 @@ class DeviceMeasurementIntegrationServiceIT extends AbstractIT {
     @Test
     void givenExistingPackagePropertiesWhenFetchingTheVersionTheServiceShouldReturnTheCurrentVersion() {
         var deviceMeasurementIntegrationService = new DeviceMeasurementIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var deviceId = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(deviceId)
@@ -37,7 +38,7 @@ void givenExistingPackagePropertiesWhenFetchingTheVersionTheServiceShouldReturnT
     @Test
     void givenAlreadyExistingDeviceWhenCreatingNewDevicesTheServiceShouldNotThrowAnException() {
         var deviceMeasurementIntegrationService = new DeviceMeasurementIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var deviceId = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(deviceId)
@@ -61,7 +62,7 @@ void givenAlreadyExistingDeviceWhenCreatingNewDevicesTheServiceShouldNotThrowAnE
     @Test
     void givenAlreadyExistingDeviceWhenUpdatingTheDeviceTheServiceShouldUpdateTheValuesForTheDevice() {
         var deviceMeasurementIntegrationService = new DeviceMeasurementIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var deviceId = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(deviceId)
@@ -95,7 +96,7 @@ void givenAlreadyExistingDeviceWhenUpdatingTheDeviceTheServiceShouldUpdateTheVal
     @Test
     void givenExistingDeviceWhenCheckingIfTheDeviceDoesExistTheServiceShouldReturnTrue() {
         var deviceMeasurementIntegrationService = new DeviceMeasurementIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var deviceId = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(deviceId)

diff --git a/src/test/java/de/app/fivegla/fiware/DroneDeviceMeasurementIntegrationServiceIT.java b/src/test/java/de/app/fivegla/fiware/DroneDeviceMeasurementIntegrationServiceIT.java
@@ -1,5 +1,6 @@
 package de.app.fivegla.fiware;
 
+import de.app.fivegla.fiware.api.FiwareIdGenerator;
 import de.app.fivegla.fiware.api.enums.DeviceCategoryValues;
 import de.app.fivegla.fiware.model.*;
 import org.junit.jupiter.api.Assertions;
@@ -13,7 +14,7 @@ class DroneDeviceMeasurementIntegrationServiceIT extends AbstractIT {
     @Test
     void givenExistingPackagePropertiesWhenFetchingTheVersionTheServiceShouldReturnTheCurrentVersion() {
         var deviceMeasurementIntegrationService = new DroneDeviceMeasurementIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var deviceId = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(deviceId)
@@ -35,7 +36,7 @@ void givenExistingPackagePropertiesWhenFetchingTheVersionTheServiceShouldReturnT
     @Test
     void givenAlreadyExistingDeviceWhenCreatingNewDevicesTheServiceShouldNotThrowAnException() {
         var deviceMeasurementIntegrationService = new DroneDeviceMeasurementIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var deviceId = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(deviceId)
@@ -61,7 +62,7 @@ void givenAlreadyExistingDeviceWhenCreatingNewDevicesTheServiceShouldNotThrowAnE
     @Test
     void givenAlreadyExistingDeviceWhenUpdatingTheDeviceTheServiceShouldUpdateTheValuesForTheDevice() {
         var deviceMeasurementIntegrationService = new DroneDeviceMeasurementIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var deviceId = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(deviceId)
@@ -93,7 +94,7 @@ void givenAlreadyExistingDeviceWhenUpdatingTheDeviceTheServiceShouldUpdateTheVal
     @Test
     void givenExistingDeviceWhenCheckingIfTheDeviceDoesExistTheServiceShouldReturnTrue() {
         var deviceMeasurementIntegrationService = new DroneDeviceMeasurementIntegrationService(contextBrokerUrl, tenant);
-        var manufacturerSpecificId = UUID.randomUUID().toString();
+        var manufacturerSpecificId = FiwareIdGenerator.id();
         var deviceId = "integration-test:" + manufacturerSpecificId;
         var device = Device.builder()
                 .id(deviceId)