feat: add node refresh subcommand (#211)

Signed-off-by: Jeromy Cannon <[email protected]>

Author: jeromy-cannon

.github/workflows/flow-update-readme.yaml

@@ -93,7 +93,7 @@ jobs:
           export SOLO_NAMESPACE=solo
           export SOLO_CLUSTER_SETUP_NAMESPACE=solo-cluster
            
-          echo "Perform the followng kind and solo commands and save output to environment variables"
+          echo "Perform the following kind and solo commands and save output to environment variables"
           
           export KIND_CREATE_CLUSTER_OUTPUT=$( kind create cluster -n "${SOLO_CLUSTER_NAME}" 2>&1 | tee test.log )
           

README.md

@@ -579,6 +579,6 @@ Contributions are welcome. Please see the [contributing guide](https://github.co
 This project is governed by the [Contributor Covenant Code of Conduct](https://github.com/hashgraph/.github/blob/main/CODE_OF_CONDUCT.md). By participating, you are
 expected to uphold this code of conduct.
 
-## License
+## License 
 
 [Apache License 2.0](LICENSE)

jest.config.mjs

@@ -21,7 +21,7 @@ const config = {
   testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(mjs?)$',
   moduleFileExtensions: ['js', 'mjs'],
   verbose: true,
-  reporters: ['default', 'jest-junit'],
+  reporters: [['default', { summaryThreshold: 1 }], 'jest-junit'],
   testSequencer: './test/testSequencer.mjs'
 }
 

src/commands/node.mjs

@@ -170,3 +170,10 @@ export function isNumeric (str) {
   return !isNaN(str) && // use type coercion to parse the _entirety_ of the string (`parseFloat` alone does not do this)...
     !isNaN(parseFloat(str)) // ...and ensure strings of whitespace fail
 }
+
+export function validatePath (input) {
+  if (input.indexOf('\0') !== -1) {
+    throw new FullstackTestingError(`access denied for path: ${input}`)
+  }
+  return input
+}

src/core/helpers.mjs

@@ -397,27 +397,34 @@ export class K8 {
     const parentDir = path.dirname(destPath)
     const fileName = path.basename(destPath)
     const filterMap = new Map(Object.entries(filters))
-    const entries = await this.listDir(podName, containerName, parentDir)
-
-    for (const item of entries) {
-      if (item.name === fileName && !item.directory) {
-        let found = true
-
-        for (const entry of filterMap.entries()) {
-          const field = entry[0]
-          const value = entry[1]
-          this.logger.debug(`Checking file ${podName}:${containerName} ${destPath}; ${field} expected ${value}, found ${item[field]}`, { filters })
-          if (`${value}` !== `${item[field]}`) {
-            found = false
-            break
+
+    try {
+      const entries = await this.listDir(podName, containerName, parentDir)
+
+      for (const item of entries) {
+        if (item.name === fileName && !item.directory) {
+          let found = true
+
+          for (const entry of filterMap.entries()) {
+            const field = entry[0]
+            const value = entry[1]
+            this.logger.debug(`Checking file ${podName}:${containerName} ${destPath}; ${field} expected ${value}, found ${item[field]}`, { filters })
+            if (`${value}` !== `${item[field]}`) {
+              found = false
+              break
+            }
           }
-        }
 
-        if (found) {
-          this.logger.debug(`File check succeeded ${podName}:${containerName} ${destPath}`, { filters })
-          return true
+          if (found) {
+            this.logger.debug(`File check succeeded ${podName}:${containerName} ${destPath}`, { filters })
+            return true
+          }
         }
       }
+    } catch (e) {
+      const error = new FullstackTestingError(`unable to check file in '${podName}':${containerName}' - ${destPath}: ${e.message}`, e)
+      this.logger.error(error.message, error)
+      throw error
     }
 
     return false
@@ -674,6 +681,7 @@ export class K8 {
 
     // add info for logging
     server.info = `${podName}:${podPort} -> ${constants.LOCAL_HOST}:${localPort}`
+    server.localPort = localPort
     this.logger.debug(`Starting port-forwarder [${server.info}]`)
     return server.listen(localPort, constants.LOCAL_HOST)
   }
@@ -706,21 +714,74 @@ export class K8 {
    * Stop the port forwarder server
    *
    * @param server an instance of server returned by portForward method
+   * @param maxAttempts the maximum number of attempts to check if the server is stopped
+   * @param timeout the delay between checks in milliseconds
    * @return {Promise<void>}
    */
-  stopPortForward (server) {
+  async stopPortForward (server, maxAttempts = 20, timeout = 500) {
+    if (!server) {
+      return
+    }
+
     this.logger.debug(`Stopping port-forwarder [${server.info}]`)
-    return new Promise((resolve, reject) => {
+
+    // try to close the websocket server
+    await new Promise((resolve, reject) => {
       server.close((e) => {
         if (e) {
-          this.logger.debug(`Failed to stop port-forwarder [${server.info}]: ${e.message}`)
-          reject(e)
+          if (e.message.contains('Server is not running')) {
+            this.logger.debug(`Server not running, port-forwarder [${server.info}]`)
+            resolve()
+          } else {
+            this.logger.debug(`Failed to stop port-forwarder [${server.info}]: ${e.message}`)
+            reject(e)
+          }
         } else {
           this.logger.debug(`Stopped port-forwarder [${server.info}]`)
           resolve()
         }
       })
     })
+
+    // test to see if the port has been closed or if it is still open
+    let attempts = 0
+    while (attempts < maxAttempts) {
+      let hasError = 0
+      attempts++
+
+      try {
+        const isPortOpen = await new Promise((resolve, reject) => {
+          const testServer = net.createServer()
+            .once('error', err => {
+              if (err) {
+                resolve(false)
+              }
+            })
+            .once('listening', () => {
+              testServer
+                .once('close', () => {
+                  hasError++
+                  if (hasError > 1) {
+                    resolve(false)
+                  } else {
+                    resolve(true)
+                  }
+                })
+                .close()
+            })
+            .listen(server.localPort, '0.0.0.0')
+        })
+        if (isPortOpen) {
+          return
+        }
+      } catch (e) {
+        return
+      }
+      await sleep(timeout)
+    }
+    if (attempts >= maxAttempts) {
+      throw new FullstackTestingError(`failed to stop port-forwarder [${server.info}]`)
+    }
   }
 
   async recyclePodByLabels (podLabels, maxAttempts = 50) {

src/core/k8.mjs

@@ -22,17 +22,25 @@ import * as semver from 'semver'
 import { FullstackTestingError, IllegalArgumentError, MissingArgumentError } from './errors.mjs'
 import { constants } from './index.mjs'
 import { Templates } from './templates.mjs'
+import { flags } from '../commands/index.mjs'
 
 /**
  * PlatformInstaller install platform code in the root-container of a network pod
  */
 export class PlatformInstaller {
-  constructor (logger, k8) {
+  constructor (logger, k8, configManager) {
     if (!logger) throw new MissingArgumentError('an instance of core/Logger is required')
     if (!k8) throw new MissingArgumentError('an instance of core/K8 is required')
 
     this.logger = logger
     this.k8 = k8
+    this.configManager = configManager
+  }
+
+  _getNamespace () {
+    const ns = this.configManager.getFlag(flags.namespace)
+    if (!ns) throw new MissingArgumentError('namespace is not set')
+    return ns
   }
 
   async validatePlatformReleaseDir (releaseDir) {
@@ -262,8 +270,6 @@ export class PlatformInstaller {
    * @returns {Promise<unknown>}
    */
   async prepareConfigTxt (nodeIDs, destPath, releaseTag, chainId = constants.HEDERA_CHAIN_ID, template = `${constants.RESOURCES_DIR}/templates/config.template`) {
-    const self = this
-
     if (!nodeIDs || nodeIDs.length === 0) throw new MissingArgumentError('list of node IDs is required')
     if (!destPath) throw new MissingArgumentError('destPath is required')
     if (!template) throw new MissingArgumentError('config templatePath is required')
@@ -290,14 +296,11 @@ export class PlatformInstaller {
       let nodeSeq = 0
       let accountIdSeq = parseInt(startAccountId.num.toString(), 10)
       for (const nodeId of nodeIDs) {
-        const podName = Templates.renderNetworkPodName(nodeId)
-        const svcName = Templates.renderNetworkSvcName(nodeId)
-
         const nodeName = nodeId
         const nodeNickName = nodeId
 
-        const internalIP = await self.k8.getPodIP(podName)
-        const externalIP = await self.k8.getClusterIP(svcName)
+        const internalIP = Templates.renderFullyQualifiedNetworkPodName(this._getNamespace(), nodeId)
+        const externalIP = Templates.renderFullyQualifiedNetworkSvcName(this._getNamespace(), nodeId)
 
         const account = `${accountIdPrefix}.${accountIdSeq}`
         if (releaseVersion.minor >= 40) {

src/core/platform_installer.mjs

@@ -159,4 +159,12 @@ export class Templates {
         throw new FullstackTestingError(`unknown dep: ${dep}`)
     }
   }
+
+  static renderFullyQualifiedNetworkPodName (namespace, nodeId) {
+    return `${Templates.renderNetworkPodName(nodeId)}.${Templates.renderNetworkSvcName(nodeId)}.${namespace}.svc.cluster.local`
+  }
+
+  static renderFullyQualifiedNetworkSvcName (namespace, nodeId) {
+    return `${Templates.renderNetworkSvcName(nodeId)}.${namespace}.svc.cluster.local`
+  }
 }

src/core/templates.mjs

@@ -51,7 +51,7 @@ export function main (argv) {
     const chartManager = new ChartManager(helm, logger)
     const configManager = new ConfigManager(logger)
     const k8 = new K8(configManager, logger)
-    const platformInstaller = new PlatformInstaller(logger, k8)
+    const platformInstaller = new PlatformInstaller(logger, k8, configManager)
     const keyManager = new KeyManager(logger)
     const accountManager = new AccountManager(logger, k8)
     const profileManager = new ProfileManager(logger, configManager)

src/index.mjs

@@ -58,6 +58,7 @@ describe('AccountCommand', () => {
   afterAll(async () => {
     await k8.deleteNamespace(namespace)
     await accountManager.close()
+    await nodeCmd.close()
   })
 
   describe('node proxies should be UP', () => {
@@ -73,7 +74,7 @@ describe('AccountCommand', () => {
     it('should succeed with init command', async () => {
       const status = await accountCmd.init(argv)
       expect(status).toBeTruthy()
-    }, 120000)
+    }, 180000)
 
     describe('special accounts should have new keys', () => {
       const genesisKey = PrivateKey.fromStringED25519(constants.GENESIS_KEY)
@@ -121,7 +122,7 @@ describe('AccountCommand', () => {
         testLogger.showUserError(e)
         expect(e).toBeNull()
       }
-    }, defaultTimeout)
+    }, 40000)
 
     it('should create account with private key and hbar amount options', async () => {
       try {

test/e2e/commands/account.test.mjs

@@ -81,7 +81,7 @@ describe('NetworkCommand', () => {
       networkCmd.logger.showUserError(e)
       expect(e).toBeNull()
     }
-  }, 60000)
+  }, 120000)
 
   it('network destroy should success', async () => {
     argv[flags.deletePvcs.name] = true