@milaboratories/pl-deployments 1.1.0 → 1.1.2

package/src/ssh/__tests__/ssh-docker.test.ts

@@ -1,3 +1,4 @@
+import type { StartedTestContainer } from 'testcontainers';
 import { describe, it, beforeAll, afterAll, expect } from 'vitest';
 import { writeFileSync, readFileSync } from 'fs';
 import { SshClient } from '../ssh';
@@ -6,9 +7,10 @@ import { downloadsFolder, cleanUp, getConnectionForSsh, getContainerHostAndPort,
 import { ConsoleLoggerAdapter } from '@milaboratories/ts-helpers';
 
 let client: SshClient;
-const testContainer = await initContainer('ssh');
+let testContainer: StartedTestContainer;
 
 beforeAll(async () => {
+  testContainer = await initContainer('ssh');
   client = await SshClient.init(new ConsoleLoggerAdapter(), getConnectionForSsh(testContainer));
 });
 
@@ -143,7 +145,58 @@ describe('sshConnect', () => {
   });
 
   it('should fail with invalid credentials', async () => {
-    await expect(SshClient.init(new ConsoleLoggerAdapter(), { ...getConnectionForSsh(testContainer), privateKey: '123' })).rejects.toThrow();
+    await expect(SshClient.init(new ConsoleLoggerAdapter(), { ...getConnectionForSsh(testContainer), username: 'dfasdfa' })).rejects.toThrow();
+  });
+
+  it('should fail with invalid passphrase', async () => {
+    let catched = false;
+    try {
+      await SshClient.init(new ConsoleLoggerAdapter(), { ...getConnectionForSsh(testContainer), passphrase: 'dfasdfa' });
+    } catch (e) {
+      console.log(e);
+      expect((e as Error).message.includes('Cannot parse privateKey: OpenSSH key integrity check failed')).toBe(true);
+      catched = true;
+    }
+    expect(catched).toBe(true);
+  });
+
+  it('should fail with invalid username', async () => {
+    let catched = false;
+    try {
+      await SshClient.init(new ConsoleLoggerAdapter(), { ...getConnectionForSsh(testContainer), username: 'dfasdfa' });
+    } catch (e) {
+      console.log(e);
+      expect((e as Error).message.includes('All configured authentication methods failed')).toBe(true);
+      catched = true;
+    }
+    expect(catched).toBe(true);
+  });
+
+  it('should fail with invalid host', async () => {
+    let catched = false;
+    try {
+      await SshClient.init(new ConsoleLoggerAdapter(), { ...getConnectionForSsh(testContainer), host: '192.100.100.100' });
+    } catch (e) {
+      console.log(e);
+      expect((e as Error).message.includes('Timed out while waiting for handshake')).toBe(true);
+      catched = true;
+    }
+    expect(catched).toBe(true);
+  });
+
+  it('should fail with invalid private key', async () => {
+    let catched = false;
+
+    const invalidPk = ssh.utils.generateKeyPairSync('ecdsa', { bits: 256, comment: 'node.js rules!', passphrase: 'password', cipher: 'aes256-cbc' });
+
+    try {
+      await SshClient.init(new ConsoleLoggerAdapter(), { ...getConnectionForSsh(testContainer), privateKey: invalidPk.private, passphrase: 'password' });
+    } catch (e) {
+      console.log(e);
+      expect((e as Error).message.includes('All configured authentication methods failed')).toBe(true);
+      catched = true;
+    }
+    expect(catched).toBe(true);
   });
 
   it('should timeout if the server is unreachable', async () => {

package/src/ssh/ssh.ts

@@ -6,7 +6,11 @@ import fs from 'fs';
 import { readFile } from 'fs/promises';
 import upath from 'upath';
 import type { MiLogger } from '@milaboratories/ts-helpers';
-import { fileExists } from '@milaboratories/ts-helpers';
+
+const defaultConfig: ConnectConfig = {
+  keepaliveInterval: 60000,
+  keepaliveCountMax: 10,
+}
 
 export type SshAuthMethods = 'publickey' | 'password';
 export type SshAuthMethodsResult = SshAuthMethods[];
@@ -26,8 +30,13 @@ export class SshClient {
    * @returns A new instance of SshClient with an active connection.
    */
   public static async init(logger: MiLogger, config: ConnectConfig): Promise<SshClient> {
+    const withDefaults = {
+      ...defaultConfig,
+      ...config
+    };
+
     const client = new SshClient(logger, new Client());
-    await client.connect(config);
+    await client.connect(withDefaults);
 
     return client;
   }
@@ -178,13 +187,13 @@ export class SshClient {
       });
 
       conn.on('error', (err) => {
-        console.error('[SSH] SSH connection error', 'ports', ports, err.message);
+        this.logger.error(`[SSH] SSH connection error, ports: ${JSON.stringify(ports)}, err: ${err.message}`);
         server?.close();
         reject(`ssh.forwardPort: conn.err: ${err}`);
       });
 
       conn.on('close', () => {
-        this.logger.info(`[SSH] Connection closed, ports: ${ports}`);
+        this.logger.info(`[SSH] Connection closed, ports: ${JSON.stringify(ports)}`);
       });
 
       conn.connect(config);

package/src/ssh/Dockerfile

@@ -1,29 +0,0 @@
-FROM node:20
-
-RUN apt-get update && \
-    apt-get install -y openssh-server && \
-    mkdir /var/run/sshd
-
-# RUN echo 'root:rootpassword' | chpasswd
-
-RUN useradd 'pl-doctor'
-RUN echo 'pl-doctor:pl-doctor-password' | chpasswd
-
-RUN sed -i 's/^#PasswordAuthentication yes/PasswordAuthentication no/' /etc/ssh/sshd_config && \
-    sed -i 's/^#PubkeyAuthentication yes/PubkeyAuthentication yes/' /etc/ssh/sshd_config
-
-RUN apt-get install -y locales && \
-    locale-gen en_US.UTF-8
-ENV LANG en_US.UTF-8
-
-EXPOSE 22 3001
-
-COPY ./test-assets/pub-key.pub /home/pl-doctor/.ssh/authorized_keys
-COPY ./test-assets/simple-server.js /home/pl-doctor/simple-server.js
-
-RUN chmod 755 /home/pl-doctor
-RUN chown pl-doctor:pl-doctor /home/pl-doctor
-
-RUN chmod +x /home/pl-doctor/simple-server.js
-
-CMD ["/bin/bash", "-c", "/usr/sbin/sshd -D & node /home/pl-doctor/simple-server.js"]

package/src/ssh/test-assets/simple-server.js

@@ -1,10 +0,0 @@
-const http = require('http');
-const PORT = 3001;
-const MESSAGE = "Hello, this is a simple Node.js server!";
-const server = http.createServer((req, res) => {
-  res.writeHead(200, { 'Content-Type': 'text/plain' });
-  res.end(MESSAGE);
-});
-server.listen(PORT, () => {
-  console.log(`Server is running on port ${PORT}`);
-});