feat: add node logs command (#337)

Signed-off-by: Jeffrey Tang <[email protected]>

Author: JeffreyDallas

.github/workflows/zxc-e2e-test.yaml

@@ -182,7 +182,7 @@ jobs:
         uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
         with:
           name: solo-${{ inputs.npm-test-script }}.log
-          path: ~/.solo/logs/solo.log
+          path: ~/.solo/logs/*
           overwrite: true
           if-no-files-found: error
 

src/commands/node.mjs

@@ -21,7 +21,7 @@ import { Listr } from 'listr2'
 import path from 'path'
 import { FullstackTestingError, IllegalArgumentError } from '../core/errors.mjs'
 import * as helpers from '../core/helpers.mjs'
-import { getTmpDir, sleep, validatePath } from '../core/helpers.mjs'
+import { getNodeLogs, getTmpDir, sleep, validatePath } from '../core/helpers.mjs'
 import { constants, Templates } from '../core/index.mjs'
 import { BaseCommand } from './base.mjs'
 import * as flags from './flags.mjs'
@@ -1072,6 +1072,45 @@ export class NodeCommand extends BaseCommand {
     return true
   }
 
+  async logs (argv) {
+    const self = this
+
+    const tasks = new Listr([
+      {
+        title: 'Initialize',
+        task: async (ctx, task) => {
+          await prompts.execute(task, self.configManager, [
+            flags.nodeIDs
+          ])
+
+          ctx.config = {
+            nodeIds: helpers.parseNodeIds(self.configManager.getFlag(flags.nodeIDs))
+          }
+          self.logger.debug('Initialized config', { config: ctx.config })
+        }
+      },
+      {
+        title: 'Copy logs from all nodes',
+        task: (ctx, _) => {
+          getNodeLogs(this.k8, flags.namespace)
+        }
+      }
+    ], {
+      concurrent: false,
+      rendererOptions: constants.LISTR_DEFAULT_RENDERER_OPTION
+    })
+
+    try {
+      await tasks.run()
+    } catch (e) {
+      throw new FullstackTestingError(`Error in downloading log from nodes: ${e.message}`, e)
+    } finally {
+      await self.close()
+    }
+
+    return true
+  }
+
   async add (argv) {
     const self = this
 
@@ -1652,6 +1691,25 @@ export class NodeCommand extends BaseCommand {
               })
             }
           })
+          .command({
+            command: 'logs',
+            desc: 'Download application logs from the network nodes and stores them in <SOLO_LOGS_DIR>/<namespace>/<podName>/ directory',
+            builder: y => flags.setCommandFlags(y,
+              flags.nodeIDs
+            ),
+            handler: argv => {
+              nodeCmd.logger.debug('==== Running \'node logs\' ===')
+              nodeCmd.logger.debug(argv)
+
+              nodeCmd.logs(argv).then(r => {
+                nodeCmd.logger.debug('==== Finished running `node logs`====')
+                if (!r) process.exit(1)
+              }).catch(err => {
+                nodeCmd.logger.showUserError(err)
+                process.exit(1)
+              })
+            }
+          })
           .command({
             command: 'add',
             desc: 'Adds a node with a specific version of Hedera platform',

src/core/helpers.mjs

@@ -23,6 +23,7 @@ import * as paths from 'path'
 import { fileURLToPath } from 'url'
 import * as semver from 'semver'
 import { Templates } from './templates.mjs'
+import { HEDERA_HAPI_PATH, ROOT_CONTAINER, SOLO_LOGS_DIR } from './constants.mjs'
 
 // cache current directory
 const CUR_FILE_DIR = paths.dirname(fileURLToPath(import.meta.url))
@@ -182,3 +183,30 @@ export function validatePath (input) {
   }
   return input
 }
+
+/**
+ * Download logs files from all network pods and save to local solo log directory
+ * @param {k8}
+ *    an instance of core/K8
+ * @returns {Promise<void>} A promise that resolves when the logs are downloaded
+ */
+export async function getNodeLogs (k8, namespace) {
+  const pods = await k8.getPodsByLabel(['fullstack.hedera.com/type=network-node'])
+
+  for (const pod of pods) {
+    const podName = pod.metadata.name
+    const targetDir = `${SOLO_LOGS_DIR}/${namespace}/${podName}`
+    try {
+      if (fs.existsSync(targetDir)) {
+        fs.rmdirSync(targetDir, { recursive: true })
+      }
+      fs.mkdirSync(targetDir, { recursive: true })
+      await k8.copyFrom(podName, ROOT_CONTAINER, `${HEDERA_HAPI_PATH}/output/swirlds.log`, targetDir)
+      await k8.copyFrom(podName, ROOT_CONTAINER, `${HEDERA_HAPI_PATH}/output/hgcaa.log`, targetDir)
+    } catch (e) {
+      // not throw error here, so we can continue to finish downloading logs from other pods
+      // and also delete namespace in the end
+      k8.logger.error(`failed to download logs from pod ${podName}`, e)
+    }
+  }
+}

test/e2e/commands/account.test.mjs

@@ -37,6 +37,7 @@ import {
 } from '../../test_util.js'
 import { AccountCommand } from '../../../src/commands/account.mjs'
 import { flags } from '../../../src/commands/index.mjs'
+import { getNodeLogs } from '../../../src/core/helpers.mjs'
 
 describe('AccountCommand', () => {
   const testName = 'account-cmd-e2e'
@@ -62,6 +63,7 @@ describe('AccountCommand', () => {
   const accountCmd = new AccountCommand(bootstrapResp.opts, testSystemAccounts)
 
   afterAll(async () => {
+    await getNodeLogs(k8, namespace)
     await k8.deleteNamespace(namespace)
     await accountManager.close()
     await nodeCmd.close()

test/e2e/commands/cluster.test.mjs

@@ -34,7 +34,7 @@ import {
   logging
 } from '../../../src/core/index.mjs'
 import { flags } from '../../../src/commands/index.mjs'
-import { sleep } from '../../../src/core/helpers.mjs'
+import { getNodeLogs, sleep } from '../../../src/core/helpers.mjs'
 import * as version from '../../../version.mjs'
 
 describe('ClusterCommand', () => {
@@ -66,6 +66,7 @@ describe('ClusterCommand', () => {
   const clusterCmd = bootstrapResp.cmd.clusterCmd
 
   afterAll(async () => {
+    await getNodeLogs(k8, namespace)
     await k8.deleteNamespace(namespace)
     await accountManager.close()
   })

test/e2e/commands/mirror_node.test.mjs

@@ -36,7 +36,7 @@ import {
   TEST_CLUSTER
 } from '../../test_util.js'
 import * as version from '../../../version.mjs'
-import { sleep } from '../../../src/core/helpers.mjs'
+import { getNodeLogs, sleep } from '../../../src/core/helpers.mjs'
 import { MirrorNodeCommand } from '../../../src/commands/mirror_node.mjs'
 import * as core from '../../../src/core/index.mjs'
 import { Status, TopicCreateTransaction, TopicMessageSubmitTransaction } from '@hashgraph/sdk'
@@ -75,6 +75,7 @@ describe('MirrorNodeCommand', () => {
   })
 
   afterAll(async () => {
+    await getNodeLogs(k8, namespace)
     await k8.deleteNamespace(namespace)
     await accountManager.close()
 

test/e2e/commands/network.test.mjs

@@ -34,7 +34,7 @@ import {
 } from '../../../src/core/index.mjs'
 import { flags } from '../../../src/commands/index.mjs'
 import * as version from '../../../version.mjs'
-import { sleep } from '../../../src/core/helpers.mjs'
+import { getNodeLogs, sleep } from '../../../src/core/helpers.mjs'
 import path from 'path'
 import fs from 'fs'
 
@@ -67,6 +67,7 @@ describe('NetworkCommand', () => {
   const clusterCmd = bootstrapResp.cmd.clusterCmd
 
   afterAll(async () => {
+    await getNodeLogs(k8, namespace)
     await k8.deleteNamespace(namespace)
     await accountManager.close()
   })

test/e2e/commands/node-local-hedera.test.mjs

@@ -27,6 +27,7 @@ import {
   getDefaultArgv,
   TEST_CLUSTER
 } from '../../test_util.js'
+import { getNodeLogs } from '../../../src/core/helpers.mjs'
 
 describe('Node local build', () => {
   const LOCAL_HEDERA = 'local-hedera-app'
@@ -41,6 +42,7 @@ describe('Node local build', () => {
 
   let hederaK8
   afterAll(async () => {
+    await getNodeLogs(hederaK8, LOCAL_HEDERA)
     await hederaK8.deleteNamespace(LOCAL_HEDERA)
   }, 120000)
 

test/e2e/commands/node-local-ptt.test.mjs

@@ -27,6 +27,7 @@ import {
   getDefaultArgv,
   TEST_CLUSTER
 } from '../../test_util.js'
+import { getNodeLogs } from '../../../src/core/helpers.mjs'
 
 describe('Node local build', () => {
   const LOCAL_PTT = 'local-ptt-app'
@@ -41,6 +42,7 @@ describe('Node local build', () => {
 
   let pttK8
   afterAll(async () => {
+    await getNodeLogs(pttK8, LOCAL_PTT)
     await pttK8.deleteNamespace(LOCAL_PTT)
   }, 120000)
 

test/e2e/commands/relay.test.mjs

@@ -33,7 +33,7 @@ import {
   TEST_CLUSTER
 } from '../../test_util.js'
 import * as version from '../../../version.mjs'
-import { sleep } from '../../../src/core/helpers.mjs'
+import { getNodeLogs, sleep } from '../../../src/core/helpers.mjs'
 import { RelayCommand } from '../../../src/commands/relay.mjs'
 
 describe('RelayCommand', () => {
@@ -58,6 +58,7 @@ describe('RelayCommand', () => {
   const relayCmd = new RelayCommand(bootstrapResp.opts)
 
   afterAll(async () => {
+    await getNodeLogs(k8, namespace)
     await k8.deleteNamespace(namespace)
   })
 

test/e2e/e2e_node_util.js

@@ -43,10 +43,11 @@ import {
   HEDERA_PLATFORM_VERSION_TAG,
   TEST_CLUSTER
 } from '../test_util.js'
-import { sleep } from '../../src/core/helpers.mjs'
+import { getNodeLogs, sleep } from '../../src/core/helpers.mjs'
 import path from 'path'
 import fs from 'fs'
 import crypto from 'crypto'
+import { ROOT_CONTAINER } from '../../src/core/constants.mjs'
 
 export function e2eNodeKeyRefreshAddTest (keyFormat, testName, mode, releaseTag = HEDERA_PLATFORM_VERSION_TAG) {
   const defaultTimeout = 120000
@@ -75,6 +76,7 @@ export function e2eNodeKeyRefreshAddTest (keyFormat, testName, mode, releaseTag
     }, defaultTimeout)
 
     afterAll(async () => {
+      await getNodeLogs(k8, namespace)
       await k8.deleteNamespace(namespace)
     }, defaultTimeout)
 
@@ -308,7 +310,7 @@ export function e2eNodeKeyRefreshAddTest (keyFormat, testName, mode, releaseTag
   async function addKeyHashToMap (k8, nodeId, keyDir, uniqueNodeDestDir, keyHashMap, privateKeyFileName) {
     await k8.copyFrom(
       Templates.renderNetworkPodName(nodeId),
-      'root-container',
+      ROOT_CONTAINER,
       path.join(keyDir, privateKeyFileName),
       uniqueNodeDestDir)
     const keyBytes = await fs.readFileSync(path.join(uniqueNodeDestDir, privateKeyFileName))