fix: Fixed bug with ssh config resource not handling comments

Author: kevinwang5658

package.json

@@ -23,7 +23,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "semver": "^7.6.0",
-    "codify-plugin-lib": "1.0.174",
+    "codify-plugin-lib": "1.0.175",
     "codify-schemas": "1.0.63",
     "chalk": "^5.3.0",
     "debug": "^4.3.4",

src/resources/ssh/ssh-config-hosts-parameter.ts

@@ -61,7 +61,7 @@ export class SshConfigHostsParameter extends StatefulParameter<SshConfig, SshCon
   async refresh(): Promise<SshConfigOptions[] | null> {
     const filePath = path.resolve(os.homedir(), '.ssh', 'config');
 
-    const sshConfigFile = await fs.readFile(filePath, 'utf8');
+    const sshConfigFile = await fs.readFile(filePath, 'utf8')
     const hostBlocks = this.parseHostBlocks(sshConfigFile);
 
     return this.parseHostObjects(hostBlocks);
@@ -171,7 +171,9 @@ export class SshConfigHostsParameter extends StatefulParameter<SshConfig, SshCon
   }
 
   private parseHostBlocks(sshConfigFile: string): string[] {
-    return sshConfigFile.split(SSH_CONFIG_REGEX)
+    return sshConfigFile
+      .replaceAll(/#(.*)[\n\r]/g, '') // Remove all comments
+      .split(SSH_CONFIG_REGEX)
       .filter(Boolean)
   }
 

src/resources/ssh/ssh-config.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
-import { SshKeyResource } from './ssh-key.js';
 import { SshConfigFileResource } from './ssh-config.js';
+import { SshConfigHostsParameter } from './ssh-config-hosts-parameter';
 
 describe('Ssh config unit test', () => {
   it('Can parse a ssh config file', async () => {
@@ -11,35 +11,32 @@ describe('Ssh config unit test', () => {
   })
 
   it('Can remap the input hosts objects', async () => {
-    const resource = new SshConfigFileResource();
-    const transformedInput = resource.getSettings().transformation?.to({
-      hosts: [
-        {
-          Host: '*',
-          HostName: 'test',
-          IdentityFile: '~/.ssh/id_ed25519',
-          AddKeysToAgent: true
-        },
-        {
-          Host: '192.168.0.1',
-          User: 'pi'
-        }
-      ]
-    })
+    const resource = new SshConfigHostsParameter();
+    const transformedInput = resource.getSettings().transformation?.to([
+      {
+        Host: '*',
+        HostName: 'test',
+        IdentityFile: '~/.ssh/id_ed25519',
+        AddKeysToAgent: true
+      },
+      {
+        Host: '192.168.0.1',
+        User: 'pi'
+      }
+    ])
 
-    expect(transformedInput).toMatchObject({
-      "hosts": [
+    expect(transformedInput).toMatchObject([
         {
-          "Host": "*",
-          "HostName": "test",
-          "IdentityFile": "~/.ssh/id_ed25519",
-          "AddKeysToAgent": "yes"
+          'Host': '*',
+          'HostName': 'test',
+          'IdentityFile': '~/.ssh/id_ed25519',
+          'AddKeysToAgent': 'yes'
         },
         {
-          "Host": "192.168.0.1",
-          "User": "pi"
+          'Host': '192.168.0.1',
+          'User': 'pi'
         }
       ]
-    })
+    )
   })
 })

test/ssh/ssh-config.test.ts

@@ -3,6 +3,8 @@ import { PluginTester } from 'codify-plugin-test';
 import * as path from 'node:path';
 import * as fs from 'node:fs/promises';
 import * as os from 'node:os';
+import { PluginProcess } from 'codify-plugin-test/dist/plugin-process';
+import { ResourceOperation } from 'codify-schemas';
 
 describe('Ssh config tests', () => {
   const pluginPath = path.resolve('./src/index.ts');
@@ -92,6 +94,42 @@ Host github.com
     })
   })
 
+  it('Can handle a file with comments', { timeout: 300000 }, async () => {
+    const configPath = path.join(os.homedir(), '.ssh', 'config');
+
+    const existingFile = await fs.readFile(configPath, 'utf8')
+    await fs.writeFile(configPath, '# This is a comment\n' + existingFile, 'utf8');
+
+    const plugin = new PluginProcess(pluginPath);
+    const plan = await plugin.plan({
+      core: {
+        type: 'ssh-config'
+      },
+      desired: {
+        hosts: [
+          {
+            Host: 'new.com',
+            AddKeysToAgent: true,
+            IdentityFile: 'id_ed25519'
+          },
+          {
+            Host: 'github.com',
+            AddKeysToAgent: true,
+            UseKeychain: true,
+          },
+          {
+            Match: 'User bob,joe,phil',
+            PasswordAuthentication: true,
+          }
+        ],
+      },
+      state: undefined,
+      isStateful: false
+    })
+
+    expect(plan.operation).to.eq(ResourceOperation.NOOP)
+  })
+
   it('Can match similar host names + destroy a .ssh/config file by renaming it', { timeout: 300000 }, async () => {
     await PluginTester.fullTest(pluginPath, [
       {