From 1b543a566adf7e751fcb3a36199a1a76f1a7406d Mon Sep 17 00:00:00 2001
From: Alberto Codutti <alberto.codutti@eurotech.com>
Date: Wed, 20 Dec 2023 17:56:48 +0100
Subject: [PATCH] fix(deviceManagement): fixed validation of
 DeviceManagementBundle id validation

Signed-off-by: Alberto Codutti <alberto.codutti@eurotech.com>
---
 .../deviceInventory/deviceInventory.yaml      |  1 +
 .../DeviceInventoryManagementServiceImpl.java | 29 +++++++++++++++++++
 2 files changed, 30 insertions(+)

diff --git a/rest-api/resources/src/main/resources/openapi/deviceInventory/deviceInventory.yaml b/rest-api/resources/src/main/resources/openapi/deviceInventory/deviceInventory.yaml
index 643a03e14b3..7829fac2f8b 100644
--- a/rest-api/resources/src/main/resources/openapi/deviceInventory/deviceInventory.yaml
+++ b/rest-api/resources/src/main/resources/openapi/deviceInventory/deviceInventory.yaml
@@ -49,6 +49,7 @@ components:
       properties:
         id:
           type: string
+          description: This is the ID of the bundle. Even if type is String, it must be a number!
         name:
           type: string
         version:
diff --git a/service/device/management/inventory/internal/src/main/java/org/eclipse/kapua/service/device/management/inventory/internal/DeviceInventoryManagementServiceImpl.java b/service/device/management/inventory/internal/src/main/java/org/eclipse/kapua/service/device/management/inventory/internal/DeviceInventoryManagementServiceImpl.java
index 9930100b579..88e730c313f 100644
--- a/service/device/management/inventory/internal/src/main/java/org/eclipse/kapua/service/device/management/inventory/internal/DeviceInventoryManagementServiceImpl.java
+++ b/service/device/management/inventory/internal/src/main/java/org/eclipse/kapua/service/device/management/inventory/internal/DeviceInventoryManagementServiceImpl.java
@@ -13,6 +13,7 @@
 package org.eclipse.kapua.service.device.management.inventory.internal;
 
 import org.eclipse.kapua.KapuaException;
+import org.eclipse.kapua.KapuaIllegalArgumentException;
 import org.eclipse.kapua.commons.util.ArgumentValidator;
 import org.eclipse.kapua.model.domain.Actions;
 import org.eclipse.kapua.model.id.KapuaId;
@@ -192,8 +193,12 @@ public void execBundle(KapuaId scopeId, KapuaId deviceId, DeviceInventoryBundle
         ArgumentValidator.notNull(scopeId, SCOPE_ID);
         ArgumentValidator.notNull(deviceId, DEVICE_ID);
         ArgumentValidator.notNull(deviceInventoryBundle, "deviceInventoryBundle");
+        ArgumentValidator.notNull(deviceInventoryBundle.getId(), "deviceInventoryBundle.id");
         ArgumentValidator.notNull(deviceInventoryBundle.getName(), "deviceInventoryBundle.name");
         ArgumentValidator.notNull(deviceInventoryBundleAction, "deviceInventoryBundleAction");
+
+        performAdditionalValidationOnDeviceInventoryBundleId(deviceInventoryBundle.getId());
+
         // Check Access
         authorizationService.checkPermission(permissionFactory.newPermission(DeviceManagementDomains.DEVICE_MANAGEMENT_DOMAIN, Actions.write, scopeId));
         // Prepare the request
@@ -462,4 +467,28 @@ public Class<InventoryPackagesResponseMessage> getResponseClass() {
         // Check response
         return checkResponseAcceptedOrThrowError(responseMessage, () -> responseMessage.getPayload().getDeviceInventoryPackages());
     }
+
+
+    /**
+     * Performs an additional check on {@link DeviceInventoryBundle#getId()} to verify that it can be converted to a {@link Integer}.
+     * <p>
+     * This check is required because initially the property was created as a {@link String} even if in Kura it is a {@link Integer}.
+     * See Kura documentation on Device Inventory Bundle <a href="https://eclipse.github.io/kura/docs-release-5.4/administration/system-component-inventory/">here</a>
+     * <p>
+     * We cannot change the type of {@link DeviceInventoryBundle#getId()} from {@link String} to {@link Integer} because it would be an API breaking change.
+     * We can add a validation to improve the error returned in case a non-integer value is provided, since the current error returned is {@link NumberFormatException} (at line
+     * TranslatorAppInventoryBundleExecKapuaKura:74).
+     *
+     * @param deviceInventoryBundleId The {@link DeviceInventoryBundle#getId()} to check
+     * @throws KapuaIllegalArgumentException If {@link DeviceInventoryBundle#getId()} cannot be converted to a {@link Integer}.
+     * @since 2.0.0
+     */
+    private void performAdditionalValidationOnDeviceInventoryBundleId(String deviceInventoryBundleId) throws KapuaIllegalArgumentException {
+        try {
+            Integer.parseInt(deviceInventoryBundleId);
+        } catch (NumberFormatException nfe) {
+            throw new KapuaIllegalArgumentException("deviceInventoryBundle.id", deviceInventoryBundleId);
+        }
+    }
+
 }