chore: Improves Integration CI logs (#577)

Author: tuliomir

README.md

@@ -23,7 +23,7 @@ If you observe an incorrect behavior while using Hathor headless wallet, see [th
 The Hathor headless wallet is tested automatically with unit tests and integration tests. See the following documentation for more information:
 - [Testing guidelines](/docs/testing.md)
 
-Eventually, some changes to plugins or scripts may require specific testing not covered by those automated tests, but those should be analysed case by case on each PR.
+Eventually, some changes to plugins or scripts may require specific testing not covered by those automated tests, but those should be analyzed case by case on each PR.
 
 ## Contributing
 

__tests__/integration/configuration/settings-fixture.js

@@ -18,8 +18,18 @@ const defaultConfig = {
 
   multisig: {},
 
+  // File logging for tests - captures verbose app logs for CI artifacts
+  // This uses the existing config.logging mechanism in src/logger.js
+  logging: {
+    app: {
+      filename: 'tmp/app.log',
+      level: 'silly',
+    },
+  },
+
   httpLogFormat: null,
-  consoleLevel: 'silly',
+  // Use TEST_CONSOLE_LEVEL=silly for verbose debugging
+  consoleLevel: process.env.TEST_CONSOLE_LEVEL || 'warn',
   tokenUid: '',
   gapLimit: null,
 

__tests__/integration/configuration/test.config.js

@@ -7,8 +7,11 @@ module.exports = {
   // On CI, should match .github/workflows/integration-test.yml -> upload-artifact
   logOutputFolder: process.env.TEST_LOG_OUTPUT_FOLDER || 'tmp/',
 
-  // Console level used on winston
-  consoleLevel: process.env.TEST_CONSOLE_LEVEL || 'silly',
+  // Console level used on winston (defaults to 'warn' for quieter CI output)
+  consoleLevel: process.env.TEST_CONSOLE_LEVEL || 'warn',
+
+  // File level used on winston (defaults to 'silly' for complete debugging in artifacts)
+  fileLevel: process.env.TEST_FILE_LEVEL || 'silly',
 
   // Defines how long tests should wait before consulting balances after transactions
   wsUpdateDelay: process.env.TEST_WS_UPDATE_DELAY || 2000,

__tests__/integration/plugins/integration_test_plugin.js

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import _ from 'lodash';
+import { loggers } from '../utils/logger.util';
 
 /**
  * This plugin is used for testing purposes, storing all events received and allowing their easy
@@ -32,12 +33,15 @@ export const init = async bus => {
   busObject = bus;
 
   messageListener = data => {
-    console.log(`[${receivedEvents.length}] ${data.type} message added on ${data.walletId}.`);
+    loggers.test?.insertLineToLog(
+      `[${receivedEvents.length}] ${data.type} message added`,
+      { walletId: data.walletId }
+    );
     receivedEvents.push(data);
   };
   busObject.on('message', messageListener);
 
-  console.log('plugin[test custom]: loaded');
+  loggers.test?.insertLineToLog('plugin[test custom]: loaded');
 };
 
 /**
@@ -46,7 +50,7 @@ export const init = async bus => {
 export const close = () => {
   busObject.off('message', messageListener);
   busObject = null;
-  console.log('plugin[test custom]: closed');
+  loggers.test?.insertLineToLog('plugin[test custom]: closed');
 };
 
 /**

__tests__/integration/utils/benchmark/wallet-benchmark.util.js

@@ -95,7 +95,7 @@ export class WalletBenchmarkUtil {
         walletObj.hasFailed = true;
         break;
       default:
-        console.warn(`Unknown wallet event: ${event}`);
+        loggers.walletBenchmark?.insertWarnToLog(`Unknown wallet event: ${event}`);
     }
   }
 

__tests__/integration/utils/logger.util.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-console */
-
 import winston from 'winston';
 import testConfig from '../configuration/test.config';
 
@@ -73,7 +71,7 @@ export class LoggerUtil {
         winston.format.timestamp(),
         winston.format.colorize(),
       ),
-      level: testConfig.consoleLevel || 'silly',
+      level: testConfig.consoleLevel,
     };
     const fileOptions = {
       format: options.filePrettyPrint
@@ -86,7 +84,7 @@ export class LoggerUtil {
           winston.format.json(),
         ),
       filename: `${testConfig.logOutputFolder}${this.#instanceFilename}`,
-      level: testConfig.consoleLevel || 'silly',
+      level: testConfig.fileLevel,
     };
 
     this.#logger = winston.createLogger({

__tests__/integration/utils/test-utils-integration.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-console */
-
 import supertest from 'supertest';
 import superagent from 'superagent';
 import { txApi, walletApi, HathorWallet, walletUtils, bigIntUtils } from '@hathor/wallet-lib';
@@ -186,7 +184,7 @@ export class TestUtils {
    * @param {string} message Custom error message
    */
   static logError(message) {
-    console.error(message);
+    loggers.test.insertErrorToLog(message);
   }
 
   /**
@@ -257,7 +255,7 @@ export class TestUtils {
       throw new Error(`Unable to start the wallet: ${walletObj.walletId}`);
     }
     if (!response.body.success) {
-      console.error(`Failure starting the wallet: ${response.body.message}`);
+      loggers.test.insertErrorToLog(`Failure starting the wallet: ${response.body.message}`);
       throw new Error(response.body.message);
     }
     const start = response.body;

docs/testing.md

@@ -47,6 +47,20 @@ On the [`./setupTests-integration.js` file](https://github.com/HathorNetwork/hat
 - All benchmarks files are handled to measure test times
 - The precalculated wallets persistent file is handled between test suites
 
+### Log and debug outputs
+
+All the logs generated by the integration tests are stored in the `tmp/` folder.
+- Each test suite has its own log file named after the suite file name
+- The application logs are stored on the `tmp/app.log` file
+- Other helper logs are stored in their respective files
+
+On the CI context, all logs inside the `tmp` folder are collected and attached to the test run as _artifacts_ for further investigation. On the CI console, only `warn` and `error` logs are printed to avoid cluttering the output.
+
+To find this artifact:
+- Open the GitHub Actions run page
+- Scroll to the bottom and find the `Upload debug transaction logs` section
+- Find the `Artifact download URL` and click it
+
 ### Sequential running
 
 Currently the integration tests must be executed in sequence using the `--runInBand` jest feature. This means many of the tests expects the previous ones to have been run sucessfully and put the network state in a specific condition.

src/logger.js

@@ -86,8 +86,8 @@ function buildAppLogger(config) {
   // create a stream object with a 'write' function that will be used by `morgan`
   appLogger.stream = {
     write(message, _encoding) {
-      // use the 'info' log level so the output will be picked up by
-      // both transports (file + console)
+      // Log HTTP requests at 'info' level. These will appear on transports
+      // configured with level 'info' or more verbose (debug, silly, etc.)
       appLogger.info(message.trim(), {
         service: 'http',
       });