feat: As a Security Server Administrator I want the diagnostics information available for global configuration and TSA to be improved so that I can more easily figure out issues with it

tests

refs: XRDDEV-2921

Author: Mikk Bachmann

src/addons/messagelog/messagelog-addon/src/test/java/org/niis/xroad/proxy/core/messagelog/AbstractMessageLogTest.java

@@ -185,7 +185,7 @@ static void assertMessageRecord(Object o, String queryId) {
     static Object waitForMessageInTaskQueue() throws Exception {
         assertTrue(TestTaskQueue.waitForMessage());
 
-        Object message = TestTaskQueue.getLastMessage();
+        Object message = TestTaskQueue.getLastTimestampResult();
         assertNotNull("Did not get message from task queue", message);
 
         return message;

src/addons/messagelog/messagelog-addon/src/test/java/org/niis/xroad/proxy/core/messagelog/DummyTSP.java

@@ -31,12 +31,13 @@
 
 final class DummyTSP {
 
+    public static final String URL = "src/test/resources/tsp.response";
+
     private DummyTSP() {
     }
 
     static AbstractTimestampRequest.TsRequest makeRequest(TimeStampRequest req) throws Exception {
-        return new AbstractTimestampRequest.TsRequest(new FileInputStream("src/test/resources/tsp.response"),
-                "src/test/resources/tsp.response");
+        return new AbstractTimestampRequest.TsRequest(new FileInputStream(URL), URL);
     }
 
 }

src/addons/messagelog/messagelog-addon/src/test/java/org/niis/xroad/proxy/core/messagelog/MessageLogTest.java

@@ -63,6 +63,7 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.Parameterized;
+import org.niis.xroad.common.core.exception.ErrorCode;
 import org.niis.xroad.proxy.core.messagelog.Timestamper.TimestampFailed;
 import org.niis.xroad.proxy.core.messagelog.Timestamper.TimestampSucceeded;
 
@@ -469,7 +470,7 @@ public void timestampNoTspUrls() throws Exception {
         log.trace("timestampNoTspUrls()");
 
         serverConfProvider.setServerConfProvider(new EmptyServerConf());
-        thrown.expectError(X_MLOG_TIMESTAMPER_FAILED);
+        thrown.expectError(ErrorCode.NO_TIMESTAMPING_PROVIDER_FOUND.code());
 
         log(createMessage(), createSignature());
     }

src/addons/messagelog/messagelog-addon/src/test/java/org/niis/xroad/proxy/core/messagelog/TestTaskQueue.java

@@ -41,7 +41,7 @@ class TestTaskQueue extends TaskQueue {
     static List<Integer> successfulMessageSizes = new ArrayList<>();
 
     private static CountDownLatch gate = new CountDownLatch(1);
-    private static Object lastMessage;
+    private static Timestamper.TimestampResult lastTimestampResult;
 
     // Countdownlatch for waiting for next timestamp record save.
     private static CountDownLatch timestampSavedLatch = new CountDownLatch(1);
@@ -74,8 +74,8 @@ static boolean waitForMessage() throws Exception {
         }
     }
 
-    static Object getLastMessage() {
-        return lastMessage;
+    static Object getLastTimestampResult() {
+        return lastTimestampResult;
     }
 
     /**
@@ -109,24 +109,24 @@ protected void saveTimestampRecord(TimestampSucceeded message) {
     }
 
     @Override
-    protected void handleTimestampSucceeded(TimestampSucceeded message) {
+    protected void handleTimestampSucceeded(TimestampSucceeded timestampSucceededResult) {
         log.trace("handleTimestampSucceeded()");
 
         try {
-            lastMessage = message;
-            super.handleTimestampSucceeded(message);
+            lastTimestampResult = timestampSucceededResult;
+            super.handleTimestampSucceeded(timestampSucceededResult);
         } finally {
             gate.countDown();
         }
     }
 
     @Override
-    protected void handleTimestampFailed(TimestampFailed message) {
+    protected void handleTimestampFailed(TimestampFailed timestampFailedResult) {
         log.info("handleTimestampFailed");
 
         try {
-            lastMessage = message;
-            super.handleTimestampFailed(message);
+            lastTimestampResult = timestampFailedResult;
+            super.handleTimestampFailed(timestampFailedResult);
         } finally {
             gate.countDown();
         }

src/addons/messagelog/messagelog-addon/src/test/java/org/niis/xroad/proxy/core/messagelog/TestTimestamperWorker.java

@@ -26,17 +26,15 @@
 package org.niis.xroad.proxy.core.messagelog;
 
 import lombok.SneakyThrows;
-import org.bouncycastle.cms.CMSException;
-import org.bouncycastle.operator.OperatorCreationException;
 import org.bouncycastle.tsp.TimeStampRequest;
 import org.bouncycastle.tsp.TimeStampResponse;
 import org.bouncycastle.tsp.TimeStampToken;
 import org.niis.xroad.globalconf.GlobalConfProvider;
 import org.niis.xroad.globalconf.impl.signature.TimestampVerifier;
 
-import java.io.IOException;
-import java.security.cert.CertificateEncodingException;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 import static org.niis.xroad.proxy.core.messagelog.TimestamperUtil.getTimestampResponse;
 
@@ -65,6 +63,7 @@ protected AbstractTimestampRequest createSingleTimestampRequest(Long logRecord)
             @Override
             @SneakyThrows
             protected Timestamper.TimestampResult makeTsRequest(TimeStampRequest tsRequest, List<String> tspUrls) {
+                Map<String, Exception> errorsByUrl = new HashMap<>();
                 synchronized (lock()) {
                     if (shouldFail) {
                         shouldFail = false;
@@ -77,12 +76,13 @@ protected Timestamper.TimestampResult makeTsRequest(TimeStampRequest tsRequest,
                 TimeStampResponse tsResponse = getTimestampResponse(req.getInputStream());
                 verify(tsRequest, tsResponse);
 
-                return result(tsResponse, req.getUrl());
+                Timestamper.TimestampResult result = result(tsResponse, req.getUrl());
+                result.setErrorsByUrl(errorsByUrl);
+                return result;
             }
 
             @Override
-            protected void verify(TimeStampRequest request, TimeStampResponse response)
-                    throws CertificateEncodingException, IOException, OperatorCreationException, CMSException {
+            protected void verify(TimeStampRequest request, TimeStampResponse response) {
                 // do not validate against request
 
                 TimeStampToken token = response.getTimeStampToken();
@@ -97,6 +97,7 @@ protected AbstractTimestampRequest createBatchTimestampRequest(Long[] logRecords
             @Override
             @SneakyThrows
             protected Timestamper.TimestampResult makeTsRequest(TimeStampRequest tsRequest, List<String> tspUrls) {
+                Map<String, Exception> errorsByUrl = new HashMap<>();
                 synchronized (lock()) {
                     if (shouldFail) {
                         shouldFail = false;
@@ -109,12 +110,13 @@ protected Timestamper.TimestampResult makeTsRequest(TimeStampRequest tsRequest,
                 TimeStampResponse tsResponse = getTimestampResponse(req.getInputStream());
                 verify(tsRequest, tsResponse);
 
-                return result(tsResponse, req.getUrl());
+                Timestamper.TimestampResult result = result(tsResponse, req.getUrl());
+                result.setErrorsByUrl(errorsByUrl);
+                return result;
             }
 
             @Override
-            protected void verify(TimeStampRequest request, TimeStampResponse response)
-                    throws CertificateEncodingException, IOException, OperatorCreationException, CMSException {
+            protected void verify(TimeStampRequest request, TimeStampResponse response) {
                 // do not validate against request
 
                 TimeStampToken token = response.getTimeStampToken();

src/common/common-core/src/test/java/org/niis/xroad/common/core/exception/XrdRuntimeExceptionTest.java

@@ -31,6 +31,7 @@
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
+import java.net.MalformedURLException;
 import java.net.UnknownHostException;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -345,11 +346,24 @@ void shouldTranslateIOExceptionToIoError() {
     }
 
     @Test
-    void shouldTranslateNetworkExceptionToNetworkError() {
+    void shouldTranslateUnknownHostExceptionToUnknownHost() {
         UnknownHostException networkException = new UnknownHostException("host not found");
 
         XrdRuntimeException result = XrdRuntimeException.systemException(networkException);
 
+        assertNotNull(result);
+        assertEquals(ExceptionCategory.SYSTEM, result.getCategory());
+        assertEquals(ErrorCode.UNKNOWN_HOST.code(), result.getCode());
+        assertEquals(networkException, result.getCause());
+        assertTrue(result.toString().contains("unknown_host"));
+    }
+
+    @Test
+    void shouldTranslateNetworkExceptionToNetworkError() {
+        MalformedURLException networkException = new MalformedURLException("Malformed URL");
+
+        XrdRuntimeException result = XrdRuntimeException.systemException(networkException);
+
         assertNotNull(result);
         assertEquals(ExceptionCategory.SYSTEM, result.getCategory());
         assertEquals(ErrorCode.NETWORK_ERROR.code(), result.getCode());

src/common/common-test/src/main/java/ee/ria/xroad/common/ExpectedCodedException.java

@@ -29,6 +29,7 @@
 import org.junit.rules.TestRule;
 import org.junit.runner.Description;
 import org.junit.runners.model.Statement;
+import org.niis.xroad.common.core.exception.XrdRuntimeException;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
@@ -101,6 +102,20 @@ private class ExpectedStatement extends Statement {
         public void evaluate() throws Throwable {
             try {
                 statement.evaluate();
+            } catch (XrdRuntimeException e) {
+                if (expected == null) {
+                    throw e;
+                }
+
+                if (expectedSuffix) {
+                    assertTrue("XrdRuntimeException with error code suffix "
+                            + expected, e.getCode().endsWith(expected));
+                } else {
+                    assertEquals("XrdRuntimeException with error code",
+                            expected, e.getCode());
+                }
+
+                return;
             } catch (CodedException e) {
                 if (expected == null) {
                     throw e;

src/lib/globalconf-core/src/test/java/org/niis/xroad/globalconf/status/OcspResponderStatusSerializationTest.java

@@ -26,6 +26,8 @@
  */
 package org.niis.xroad.globalconf.status;
 
+import ee.ria.xroad.common.DiagnosticStatus;
+import ee.ria.xroad.common.DiagnosticsStatus;
 import ee.ria.xroad.common.util.JsonUtils;
 
 import lombok.extern.slf4j.Slf4j;
@@ -42,7 +44,7 @@ void serializeAndDeserializeCertificationServiceDiagnostics() throws IOException
         CertificationServiceDiagnostics certificationServiceDiagnostics = new CertificationServiceDiagnostics();
         String name = "name";
         String url = "url";
-        OcspResponderStatus ocspResponderStatus = new OcspResponderStatus(0, url, null, null);
+        OcspResponderStatus ocspResponderStatus = new OcspResponderStatus(DiagnosticStatus.OK, url, null, null);
         CertificationServiceStatus certificationServiceStatus = new CertificationServiceStatus(name);
         certificationServiceStatus.getOcspResponderStatusMap().put(url, ocspResponderStatus);
         certificationServiceDiagnostics.getCertificationServiceStatusMap().put(name, certificationServiceStatus);
@@ -59,7 +61,7 @@ void serializeAndDeserializeCertificationServiceDiagnostics() throws IOException
 
     @Test
     void serializeAndDeserializeDiagnosticsStatus() throws IOException {
-        DiagnosticsStatus diagnosticsStatus = new DiagnosticsStatus(0, null, null, "desc");
+        DiagnosticsStatus diagnosticsStatus = new DiagnosticsStatus(DiagnosticStatus.OK, null, "desc");
 
         byte[] bytesOut = JsonUtils.getObjectWriter().writeValueAsBytes(diagnosticsStatus);
 

src/lib/globalconf-impl/src/test/java/org/niis/xroad/globalconf/impl/signature/TimestampVerifierTest.java

@@ -37,6 +37,7 @@
 import org.junit.BeforeClass;
 import org.junit.Rule;
 import org.junit.Test;
+import org.niis.xroad.common.core.exception.ErrorCode;
 import org.niis.xroad.globalconf.GlobalConfProvider;
 import org.niis.xroad.test.globalconf.TestGlobalConfImpl;
 
@@ -105,7 +106,7 @@ public void hashMismatch() throws Exception {
      */
     @Test
     public void wrongCertificate() throws Exception {
-        thrown.expectError(ErrorCodes.X_INTERNAL_ERROR);
+        thrown.expectError(ErrorCode.TSP_CERTIFICATE_NOT_FOUND.code());
         TimeStampToken token = getTimestampFromFile("valid");
         byte[] stampedData = getBytesFromFile("stamped-data");
         List<X509Certificate> tspCerts =
@@ -120,7 +121,7 @@ public void wrongCertificate() throws Exception {
      */
     @Test
     public void invalidSignature() throws Exception {
-        thrown.expectError(ErrorCodes.X_TIMESTAMP_VALIDATION);
+        thrown.expectError(ErrorCode.TIMESTAMP_SIGNER_VERIFICATION_FAILED.code());
         TimeStampToken token = getTimestampFromFile("invalid-signature");
         byte[] stampedData = getBytesFromFile("stamped-data");
         List<X509Certificate> tspCerts = globalConfProvider.getTspCertificates();

src/security-server/admin-service/application/src/test/java/org/niis/xroad/securityserver/restapi/converter/GlobalConfDiagnosticConverterTest.java

@@ -26,12 +26,11 @@
  */
 package org.niis.xroad.securityserver.restapi.converter;
 
-import ee.ria.xroad.common.DiagnosticsErrorCodes;
+import ee.ria.xroad.common.DiagnosticStatus;
+import ee.ria.xroad.common.DiagnosticsStatus;
 
 import org.junit.Before;
 import org.junit.Test;
-import org.niis.xroad.globalconf.status.DiagnosticsStatus;
-import org.niis.xroad.securityserver.restapi.openapi.model.ConfigurationStatusDto;
 import org.niis.xroad.securityserver.restapi.openapi.model.DiagnosticStatusClassDto;
 import org.niis.xroad.securityserver.restapi.openapi.model.GlobalConfDiagnosticsDto;
 
@@ -56,9 +55,8 @@ public void setup() {
     @Test
     public void convertSingleGlobalConfDiagnostics() {
         GlobalConfDiagnosticsDto globalConfDiagnostics = globalConfDiagnosticConverter.convert(new DiagnosticsStatus(
-                DiagnosticsErrorCodes.RETURN_SUCCESS, PREVIOUS_UPDATE, NEXT_UPDATE));
+                DiagnosticStatus.OK, PREVIOUS_UPDATE, NEXT_UPDATE));
 
-        assertEquals(ConfigurationStatusDto.SUCCESS, globalConfDiagnostics.getStatusCode());
         assertEquals(DiagnosticStatusClassDto.OK, globalConfDiagnostics.getStatusClass());
         assertEquals(PREVIOUS_UPDATE, globalConfDiagnostics.getPrevUpdateAt());
         assertEquals(NEXT_UPDATE, globalConfDiagnostics.getNextUpdateAt());