Merge pull request #1109 from OSGP/feature/SMHE-1818_update_firnware

When firmware file is not available device connection is not required.

Author: kroesctrl

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/infra/messaging/DeviceRequestMessageProcessor.java

@@ -91,7 +91,7 @@ public void processMessage(final ObjectMessage message) throws JMSException {
       } else {
         device = null;
       }
-      if (this.usesDeviceConnection()) {
+      if (this.usesDeviceConnection(messageObject)) {
         /*
          * Set up a consumer to be called back with a DlmsConnectionManager for which the connection
          * with the device has been created. Note that when usesDeviceConnection is true, in this
@@ -249,7 +249,7 @@ protected Serializable handleMessage(
    *
    * @return Use device connection in handleMessage.
    */
-  protected boolean usesDeviceConnection() {
+  protected boolean usesDeviceConnection(final Serializable messageObject) {
     return true;
   }
 

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/infra/messaging/processors/AddMeterRequestMessageProcessor.java

@@ -26,7 +26,7 @@ public AddMeterRequestMessageProcessor() {
   }
 
   @Override
-  protected boolean usesDeviceConnection() {
+  protected boolean usesDeviceConnection(final Serializable messageObject) {
     return false;
   }
 

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/infra/messaging/processors/DisableDebuggingRequestMessageProcessor.java

@@ -24,7 +24,7 @@ public DisableDebuggingRequestMessageProcessor() {
   }
 
   @Override
-  protected boolean usesDeviceConnection() {
+  protected boolean usesDeviceConnection(final Serializable messageObject) {
     return false;
   }
 

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/infra/messaging/processors/EnableDebuggingRequestMessageProcessor.java

@@ -24,7 +24,7 @@ public EnableDebuggingRequestMessageProcessor() {
   }
 
   @Override
-  protected boolean usesDeviceConnection() {
+  protected boolean usesDeviceConnection(final Serializable messageObject) {
     return false;
   }
 

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/infra/messaging/processors/GetKeysRequestMessageProcessor.java

@@ -25,7 +25,7 @@ protected GetKeysRequestMessageProcessor() {
   }
 
   @Override
-  protected boolean usesDeviceConnection() {
+  protected boolean usesDeviceConnection(final Serializable messageObject) {
     return false;
   }
 

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/infra/messaging/processors/SetDeviceCommunicationSettingsRequestMessageProcessor.java

@@ -26,7 +26,7 @@ public SetDeviceCommunicationSettingsRequestMessageProcessor() {
   }
 
   @Override
-  protected boolean usesDeviceConnection() {
+  protected boolean usesDeviceConnection(final Serializable messageObject) {
     return false;
   }
 

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/infra/messaging/processors/UpdateFirmwareRequestMessageProcessor.java

@@ -37,6 +37,23 @@ protected UpdateFirmwareRequestMessageProcessor() {
     super(MessageType.UPDATE_FIRMWARE);
   }
 
+  @Override
+  protected boolean usesDeviceConnection(final Serializable messageObject) {
+    if (messageObject instanceof final UpdateFirmwareRequestDto requestDto) {
+      final String firmwareIdentification = requestDto.getFirmwareIdentification();
+      final boolean usesDeviceConnection =
+          this.firmwareService.isFirmwareFileAvailable(firmwareIdentification);
+      if (!usesDeviceConnection) {
+        LOGGER.info(
+            "Firmware file [{}] not available for device {}. So no device connection required for sending GetFirmwareFile request to core.",
+            firmwareIdentification,
+            requestDto.getDeviceIdentification());
+      }
+      return usesDeviceConnection;
+    }
+    return super.usesDeviceConnection(messageObject);
+  }
+
   @Override
   protected Serializable handleMessage(
       final DlmsConnectionManager conn,

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/main/java/org/opensmartgridplatform/adapter/protocol/dlms/infra/messaging/processors/UpdateProtocolRequestMessageProcessor.java

@@ -25,7 +25,7 @@ public UpdateProtocolRequestMessageProcessor() {
   }
 
   @Override
-  protected boolean usesDeviceConnection() {
+  protected boolean usesDeviceConnection(final Serializable messageObject) {
     return false;
   }
 

osgp/protocol-adapter-dlms/osgp-protocol-adapter-dlms/src/test/java/org/opensmartgridplatform/adapter/protocol/dlms/infra/messaging/processors/UpdateFirmwareRequestMessageProcessorTest.java

@@ -4,6 +4,7 @@
 
 package org.opensmartgridplatform.adapter.protocol.dlms.infra.messaging.processors;
 
+import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.nullable;
 import static org.mockito.ArgumentMatchers.same;
@@ -19,6 +20,8 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
@@ -201,4 +204,19 @@ void processMessageTaskShouldNotUpdateFirmwareWhenFirmwareFileNotAvailable()
             same(updateFirmwareRequestDto),
             any(MessageMetadata.class));
   }
+
+  @ParameterizedTest
+  @ValueSource(booleans = {true, false})
+  void testUsesDeviceConnection(final boolean isFirmwareFileAvailable) {
+    final String firmwareIdentification = "unavailable";
+    final String deviceIdentification = "unavailableEither";
+    final UpdateFirmwareRequestDto updateFirmwareRequestDto =
+        new UpdateFirmwareRequestDto(firmwareIdentification, deviceIdentification);
+
+    when(this.firmwareService.isFirmwareFileAvailable(firmwareIdentification))
+        .thenReturn(isFirmwareFileAvailable);
+
+    assertThat(this.processor.usesDeviceConnection(updateFirmwareRequestDto))
+        .isEqualTo(isFirmwareFileAvailable);
+  }
 }