fix: Add missing fields in error response (#2118)

* Add action field to error rest response

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Include message reason

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Fix order of arguments

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Fix arguments order in message class

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

Author: taban03

common-service-core/src/main/java/org/zowe/apiml/message/api/ApiMessage.java

@@ -36,11 +36,13 @@ public class ApiMessage {
     private String messageSource;
 
 
-    public ApiMessage(String messageKey, MessageType messageType, String messageNumber, String messageContent) {
+    public ApiMessage(String messageKey, MessageType messageType, String messageNumber, String messageContent, String messageAction, String messageReason) {
         this.messageKey = messageKey;
         this.messageType = messageType;
         this.messageNumber = messageNumber;
         this.messageContent = messageContent;
+        this.messageAction = messageAction;
+        this.messageReason = messageReason;
     }
 
     /**

common-service-core/src/main/java/org/zowe/apiml/message/core/Message.java

@@ -130,7 +130,9 @@ public ApiMessage mapToApiMessage() {
             requestedKey,
             messageTemplate.getType(),
             messageTemplate.getNumber() + messageTemplate.getType().toChar(),
-            getConvertedText());
+            getConvertedText(),
+            messageTemplate.getAction(),
+            messageTemplate.getReason());
     }
 
     /**

common-service-core/src/test/java/org/zowe/apiml/message/core/MessageTest.java

@@ -108,8 +108,7 @@ void testMapToView() {
 
         String expectedReadableText = "No response received within the allowed time: 3000";
         ApiMessageView expectedApiMessageView = new ApiMessageView(Collections.singletonList(
-            new ApiMessage("org.zowe.apiml.common.serviceTimeout", MessageType.ERROR, "ZWEAM700E", expectedReadableText)
-        ));
+            new ApiMessage("org.zowe.apiml.common.serviceTimeout", MessageType.ERROR, "ZWEAM700E", expectedReadableText, null, null)));
 
         assertEquals(expectedApiMessageView, actualApiMessageView, "ApiMessageView is different");
     }
@@ -120,7 +119,7 @@ void testMapToApiMessage() {
         ApiMessage actualApiMessage = message.mapToApiMessage();
 
         String expectedReadableText = "No response received within the allowed time: 3000";
-        ApiMessage expectedApiMessage = new ApiMessage("org.zowe.apiml.common.serviceTimeout", MessageType.ERROR, "ZWEAM700E", expectedReadableText);
+        ApiMessage expectedApiMessage = new ApiMessage("org.zowe.apiml.common.serviceTimeout", MessageType.ERROR, "ZWEAM700E", expectedReadableText, null, null);
 
         assertEquals(expectedApiMessage, actualApiMessage, "ApiMessage is different");
     }

gateway-service/src/test/java/org/zowe/apiml/gateway/error/check/SecurityErrorCheckTest.java

@@ -73,7 +73,7 @@ void shouldReturnCauseMessageWhenTokenExpireException() {
         assertNotNull(actualResponse);
         assertEquals(HttpStatus.UNAUTHORIZED, actualResponse.getStatusCode());
         List<ApiMessage> actualMessageList = actualResponse.getBody().getMessages();
-        assertThat(actualMessageList, hasItem(new ApiMessage("org.zowe.apiml.gateway.security.expiredToken", MessageType.ERROR, "ZWEAG103E", "The token has expired")));
+        assertThat(actualMessageList, hasItem(new ApiMessage("org.zowe.apiml.gateway.security.expiredToken", MessageType.ERROR, "ZWEAG103E", "The token has expired","Obtain new token by performing an authentication request.", "The JWT token has expired.")));
     }
 
     @Test
@@ -93,7 +93,7 @@ void shouldReturnCauseMessageWhenTokenNotValidException() {
 
         assertNotNull(actualResponse.getBody());
         List<ApiMessage> actualMessageList = actualResponse.getBody().getMessages();
-        assertThat(actualMessageList, hasItem(new ApiMessage("org.zowe.apiml.gateway.security.invalidToken", MessageType.ERROR, "ZWEAG102E", "Token is not valid")));
+        assertThat(actualMessageList, hasItem(new ApiMessage("org.zowe.apiml.gateway.security.invalidToken", MessageType.ERROR, "ZWEAG102E", "Token is not valid", "Provide a valid token.", "The JWT token is not valid.")));
     }
 
     @Test
@@ -114,7 +114,7 @@ void shouldReturnCauseMessageWhenBadCredentialsException() {
         assertNotNull(actualResponse.getBody());
         List<ApiMessage> actualMessageList = actualResponse.getBody().getMessages();
         assertThat(actualMessageList, hasItem(new ApiMessage("org.zowe.apiml.security.login.invalidCredentials",
-            MessageType.ERROR, "ZWEAG120E", "Invalid username or password for URL 'null'")));
+            MessageType.ERROR, "ZWEAG120E", "Invalid username or password for URL 'null'", "Provide a valid username and password.", "The username and/or password are invalid.")));
     }
 }
 

gateway-service/src/test/java/org/zowe/apiml/gateway/error/check/ServiceErrorCheckTest.java

@@ -62,7 +62,7 @@ void givenNotFoundZuulException_whenTheRequestIsProcessed_then404IsReturned() {
         assertEquals(HttpStatus.NOT_FOUND, actualResponse.getStatusCode());
         List<ApiMessage> actualMessageList = actualResponse.getBody().getMessages();
         assertThat(actualMessageList, hasItem(new ApiMessage("org.zowe.apiml.common.endPointNotFound",
-            MessageType.ERROR, "ZWEAM104E", "The endpoint you are looking for 'serviceId' could not be located")));
+            MessageType.ERROR, "ZWEAM104E", "The endpoint you are looking for 'serviceId' could not be located", "Verify that the URL of the endpoint you are trying to reach is correct.", "The endpoint you are looking for could not be located.")));
     }
 
     @Test
@@ -77,6 +77,6 @@ void givenServiceNotAccessibleException_whenTheRequestIsProcessed_then404IsRetur
         assertEquals(HttpStatus.NOT_FOUND, actualResponse.getStatusCode());
         List<ApiMessage> actualMessageList = actualResponse.getBody().getMessages();
         assertThat(actualMessageList, hasItem(new ApiMessage("org.zowe.apiml.gateway.serviceUnavailable",
-            MessageType.ERROR, "ZWEAG709E", "Service is not available at URL 'null'. Error returned: 'null'")));
+            MessageType.ERROR, "ZWEAG709E", "Service is not available at URL 'null'. Error returned: 'null'", "Make sure that the service is running and is accessible by the URL provided in the message.", "The service is not available.")));
     }
 }