add TODOs

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

Author: jeromy-cannon

src/commands/network.mjs

@@ -221,6 +221,7 @@ export class NetworkCommand extends BaseCommand {
           ctx.config = /** @type {NetworkDeployConfigClass} **/ await self.prepareConfig(task, argv)
         }
       },
+      // TODO create node keys and secrets
       {
         title: `Install chart '${constants.FULLSTACK_DEPLOYMENT_CHART}'`,
         task: async (ctx, _) => {

src/commands/node.mjs

@@ -329,6 +329,7 @@ export class NodeCommand extends BaseCommand {
    * @return a list of subtasks
    * @private
    */
+  // TODO: move to KeyManager and remove List2 functionality
   _nodeGossipKeysTaskList (keyFormat, nodeIds, keysDir, curDate = new Date(), allNodeIds = null) {
     allNodeIds = allNodeIds || nodeIds
     if (!Array.isArray(nodeIds) || !nodeIds.every((nodeId) => typeof nodeId === 'string')) {
@@ -358,6 +359,7 @@ export class NodeCommand extends BaseCommand {
             title: `Generate ${Templates.renderGossipPfxPrivateKeyFile(nodeId)} for node: ${chalk.yellow(nodeId)}`,
             task: async () => {
               const privatePfxFile = await self.keyManager.generatePrivatePfxKeys(keytool, nodeId, keysDir, tmpDir)
+              // TODO: move this validation logic into keyManager.generatePrivatePfxKeys
               const output = await keytool.list(`-storetype pkcs12 -storepass password -keystore ${privatePfxFile}`)
               if (!output.includes('Your keystore contains 3 entries')) {
                 throw new FullstackTestingError(`malformed private pfx file: ${privatePfxFile}`)
@@ -370,6 +372,7 @@ export class NodeCommand extends BaseCommand {
           title: `Generate ${constants.PUBLIC_PFX} file`,
           task: async () => {
             const publicPfxFile = await self.keyManager.updatePublicPfxKey(self.keytoolDepManager.getKeytool(), allNodeIds, keysDir, tmpDir)
+            // TODO: move this validation into the keyManager.updatePublicPfxKey function
             const output = await keytool.list(`-storetype pkcs12 -storepass password -keystore ${publicPfxFile}`)
             if (!output.includes(`Your keystore contains ${allNodeIds.length * 3} entries`)) {
               throw new FullstackTestingError(`malformed public.pfx file: ${publicPfxFile}`)
@@ -431,6 +434,7 @@ export class NodeCommand extends BaseCommand {
    * @return return a list of subtasks
    * @private
    */
+  // TODO move to KeyManager and remove List2 functionality
   _nodeTlsKeyTaskList (nodeIds, keysDir, curDate = new Date()) {
     // check if nodeIds is an array of strings
     if (!Array.isArray(nodeIds) || !nodeIds.every((nodeId) => typeof nodeId === 'string')) {
@@ -462,6 +466,7 @@ export class NodeCommand extends BaseCommand {
     return subTasks
   }
 
+  // TODO: move to KeyManager, rename copyNodeKeysToStaging
   async _copyNodeKeys (nodeKey, destDir) {
     for (const keyFile of [nodeKey.privateKeyFile, nodeKey.certificateFile]) {
       if (!fs.existsSync(keyFile)) {
@@ -788,6 +793,7 @@ export class NodeCommand extends BaseCommand {
         },
         skip: (ctx, _) => !ctx.config.generateTlsKeys
       },
+      // TODO: moves to `network deploy`
       {
         title: 'Prepare staging directory',
         task: async (ctx, parentTask) => {
@@ -1825,6 +1831,7 @@ export class NodeCommand extends BaseCommand {
             valuesArg += this.prepareValuesFiles(this.profileValuesFile)
           }
 
+          // TODO: update the secrets with the new/updated key(s)
           await self.chartManager.upgrade(
             config.namespace,
             constants.FULLSTACK_DEPLOYMENT_CHART,
@@ -2147,6 +2154,7 @@ export class NodeCommand extends BaseCommand {
     }
   }
 
+  // TODO: move to KeyManager
   async copyGossipKeysToStaging (keyFormat, keysDir, stagingKeysDir, nodeIds) {
     // copy gossip keys to the staging
     for (const nodeId of nodeIds) {

src/core/helpers.mjs

@@ -127,6 +127,7 @@ export function makeBackup (fileMap = new Map(), removeOld = true) {
   }
 }
 
+// TODO: now we will pull the secret and then write the backup file
 export function backupOldPfxKeys (nodeIds, keysDir, curDate = new Date(), dirPrefix = 'gossip-pfx') {
   const backupDir = createBackupDir(keysDir, `unused-${dirPrefix}`, curDate)
   const fileMap = new Map()
@@ -144,6 +145,7 @@ export function backupOldPfxKeys (nodeIds, keysDir, curDate = new Date(), dirPre
   return backupDir
 }
 
+// TODO: now we will pull the secret and then write the backup file
 export function backupOldTlsKeys (nodeIds, keysDir, curDate = new Date(), dirPrefix = 'tls') {
   const backupDir = createBackupDir(keysDir, `unused-${dirPrefix}`, curDate)
   const fileMap = new Map()
@@ -158,6 +160,7 @@ export function backupOldTlsKeys (nodeIds, keysDir, curDate = new Date(), dirPre
   return backupDir
 }
 
+// TODO: now we will pull the secret and then write the backup file
 export function backupOldPemKeys (nodeIds, keysDir, curDate = new Date(), dirPrefix = 'gossip-pem') {
   const backupDir = createBackupDir(keysDir, `unused-${dirPrefix}`, curDate)
   const fileMap = new Map()

src/core/platform_installer.mjs

@@ -138,6 +138,7 @@ export class PlatformInstaller {
     }
   }
 
+  // TODO: update to copy the keys to the k8s secrets
   async copyGossipKeys (podName, stagingDir, nodeIds, keyFormat = constants.KEY_FORMAT_PEM) {
     const self = this
 
@@ -176,6 +177,7 @@ export class PlatformInstaller {
     }
   }
 
+  // TODO: update to copy the keys to the k8s secrets
   async copyTLSKeys (podName, stagingDir) {
     if (!podName) throw new MissingArgumentError('podName is required')
     if (!stagingDir) throw new MissingArgumentError('stagingDir is required')
@@ -256,15 +258,16 @@ export class PlatformInstaller {
    * @param force force flag
    * @returns {Listr<ListrContext, ListrPrimaryRendererValue, ListrSecondaryRendererValue>}
    */
+  // TODO: rename to taskSetup
   taskInstall (podName, stagingDir, nodeIds, keyFormat = constants.KEY_FORMAT_PEM, force = false) {
     const self = this
     return new Listr([
-      {
+      { // TODO: remove
         title: 'Copy Gossip keys',
         task: (_, task) =>
           self.copyGossipKeys(podName, stagingDir, nodeIds, keyFormat)
       },
-      {
+      { // TODO: remove
         title: 'Copy TLS keys',
         task: (_, task) =>
           self.copyTLSKeys(podName, stagingDir, keyFormat)