Merge pull request #1110 from OSGP/feature/SMHE-1818_update_firmware_no_file

Method without connection should be implemented

Author: kroesctrl

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

@@ -239,7 +239,7 @@ protected Serializable handleMessage(
       final MessageMetadata messageMetadata)
       throws OsgpException {
     throw new UnsupportedOperationException(
-        "handleMessage(Serializable) should be overriden by a subclass, or usesDeviceConnection should return"
+        "handleMessage(Serializable) should be overridden by a subclass, or usesDeviceConnection should return"
             + " true.");
   }
 

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

@@ -54,13 +54,46 @@ protected boolean usesDeviceConnection(final Serializable messageObject) {
     return super.usesDeviceConnection(messageObject);
   }
 
+  @Override
+  protected Serializable handleMessage(
+      final DlmsDevice device,
+      final Serializable requestObject,
+      final MessageMetadata messageMetadata)
+      throws OsgpException {
+    // This method will be invoked when usesDeviceConnection returns false (firmwareFile is not
+    // available)
+    final String deviceIdentification = messageMetadata.getDeviceIdentification();
+    final String organisationIdentification = messageMetadata.getOrganisationIdentification();
+    final String correlationUid = messageMetadata.getCorrelationUid();
+
+    final UpdateFirmwareRequestDto updateFirmwareRequestDto =
+        (UpdateFirmwareRequestDto) requestObject;
+    final String firmwareIdentification = updateFirmwareRequestDto.getFirmwareIdentification();
+
+    LOGGER.info(
+        "[{}] - Firmware file [{}] not available. Sending GetFirmwareFile request to core.",
+        correlationUid,
+        firmwareIdentification);
+    final RequestMessage message =
+        new RequestMessage(
+            correlationUid,
+            organisationIdentification,
+            deviceIdentification,
+            updateFirmwareRequestDto);
+    this.osgpRequestMessageSender.sendWithReplyToThisInstance(
+        message, MessageType.GET_FIRMWARE_FILE.name(), messageMetadata);
+    return NO_RESPONSE;
+  }
+
   @Override
   protected Serializable handleMessage(
       final DlmsConnectionManager conn,
       final DlmsDevice device,
       final Serializable requestObject,
       final MessageMetadata messageMetadata)
       throws OsgpException {
+    // This method will be invoked when usesDeviceConnection returns true (firmwareFile is
+    // available)
     final String deviceIdentification = messageMetadata.getDeviceIdentification();
     final String organisationIdentification = messageMetadata.getOrganisationIdentification();
     final String correlationUid = messageMetadata.getCorrelationUid();
@@ -78,28 +111,12 @@ protected Serializable handleMessage(
         (UpdateFirmwareRequestDto) requestObject;
     final String firmwareIdentification = updateFirmwareRequestDto.getFirmwareIdentification();
 
-    if (this.firmwareService.isFirmwareFileAvailable(firmwareIdentification)) {
-      LOGGER.info(
-          "[{}] - Firmware file [{}] available. Updating firmware on device [{}]",
-          correlationUid,
-          firmwareIdentification,
-          deviceIdentification);
-      return this.configurationService.updateFirmware(
-          conn, device, updateFirmwareRequestDto, messageMetadata);
-    } else {
-      LOGGER.info(
-          "[{}] - Firmware file [{}] not available. Sending GetFirmwareFile request to core.",
-          correlationUid,
-          firmwareIdentification);
-      final RequestMessage message =
-          new RequestMessage(
-              correlationUid,
-              organisationIdentification,
-              deviceIdentification,
-              updateFirmwareRequestDto);
-      this.osgpRequestMessageSender.sendWithReplyToThisInstance(
-          message, MessageType.GET_FIRMWARE_FILE.name(), messageMetadata);
-      return NO_RESPONSE;
-    }
+    LOGGER.info(
+        "[{}] - Firmware file [{}] available. Updating firmware on device [{}]",
+        correlationUid,
+        firmwareIdentification,
+        deviceIdentification);
+    return this.configurationService.updateFirmware(
+        conn, device, updateFirmwareRequestDto, messageMetadata);
   }
 }

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

@@ -112,8 +112,7 @@ void processMessageTaskShouldSendFirmwareFileRequestWhenFirmwareFileNotAvailable
     when(this.firmwareService.isFirmwareFileAvailable(firmwareIdentification)).thenReturn(false);
 
     // Act
-    this.processor.processMessageTasks(
-        message.getObject(), messageMetadata, this.dlmsConnectionManagerMock, this.device);
+    this.processor.processMessageTasks(message.getObject(), messageMetadata, null, this.device);
 
     // Assert
     verify(this.osgpRequestMessageSender, times(1))
@@ -219,4 +218,23 @@ void testUsesDeviceConnection(final boolean isFirmwareFileAvailable) {
     assertThat(this.processor.usesDeviceConnection(updateFirmwareRequestDto))
         .isEqualTo(isFirmwareFileAvailable);
   }
+
+  @ParameterizedTest
+  @ValueSource(booleans = {true, false})
+  void testProcessMessage(final boolean isFirmwareFileAvailable) throws JMSException {
+    final String firmwareIdentification = "unavailable";
+    final String deviceIdentification = "unavailableEither";
+    final UpdateFirmwareRequestDto updateFirmwareRequestDto =
+        new UpdateFirmwareRequestDto(firmwareIdentification, deviceIdentification);
+    final ObjectMessage message =
+        new ObjectMessageBuilder()
+            .withObject(updateFirmwareRequestDto)
+            .withCorrelationUid("123456")
+            .build();
+
+    when(this.firmwareService.isFirmwareFileAvailable(firmwareIdentification))
+        .thenReturn(isFirmwareFileAvailable);
+
+    this.processor.processMessage(message);
+  }
 }