fix missing deps by removing it

Author: NobleMajo

bun.lock

@@ -1,6 +1,6 @@
 {
   "name": "hivessh",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "HiveSsh is an innovative library designed to streamline SSH2 connections and simplify task execution on Linux servers.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -61,12 +61,12 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@types/ssh2": "^1.15.0",
-    "nodemon": "^3.1.0",
-    "typescript": "^5.4.3",
-    "undici": "^7.4.0"
+    "@types/ssh2": "^1.15.5",
+    "nodemon": "^3.1.10",
+    "typescript": "^5.9.2",
+    "undici": "^7.15.0"
   },
   "dependencies": {
-    "ssh2": "^1.15.0"
+    "ssh2": "^1.17.0"
   }
-}
+}

package.json

@@ -0,0 +1,140 @@
+import { afterEach, beforeEach, describe, expect, test } from "bun:test"
+import { OsRelease } from "../../essentials/OsRelease.js"
+import { SshHost } from "../../index.js"
+import { connectTestHosts, loadEnvVars, TestHost } from "./e2eTestBase.js"
+
+const toolsToCheck: string[] = [
+    "ls",
+    "cat",
+    "neofetch",
+    "vim",
+    "nano",
+    "git",
+    "curl",
+    "wget",
+    "ssh",
+    "scp",
+    "tar",
+    "gzip",
+    "zip",
+    "unzip",
+    "7z",
+    "unrar",
+    "btop",
+    "htop",
+    "top",
+    "ufw",
+]
+
+let testSshHosts: [TestHost, SshHost][] = []
+
+describe("e2e concurrent exec", () => {
+    beforeEach(async () => {
+        const hostData = loadEnvVars()
+        if (hostData.length == 0) {
+            throw new Error("No hosts configured!")
+        }
+
+        testSshHosts = await connectTestHosts(hostData)
+    })
+
+    afterEach(async () => {
+        await Promise.all(
+            testSshHosts.map(
+                ([testHost, host]) => host.disconnect()
+            )
+        )
+    })
+
+    test("execute sleep tasks", async () => {
+        await Promise.all(
+            testSshHosts.map(
+                ([testHost, host]) => executeSleepWorkload(host)
+            )
+        )
+    }, 1000 * 20)
+
+    test("execute host info tasks", async () => {
+        for (const testHost of testSshHosts) {
+            const info = await collectHostInfo(
+                testHost[1],
+                toolsToCheck,
+            )
+
+            // osRelease
+            expect(info.osRelease.distroName.length).toBeGreaterThan(0)
+            expect(info.osRelease.distroVersion.length).toBeGreaterThan(0)
+            expect(info.toolesInstalled.length).toBeGreaterThan(0)
+
+            expect(info.homefiles.length).toBeGreaterThan(0)
+            expect(info.homedir.length).toBeGreaterThan(0)
+        }
+    }, 1000 * 20)
+})
+
+
+export interface HostInfo {
+    sshHost: SshHost,
+    osRelease: OsRelease,
+    toolesInstalled: string[],
+    neofetch: string | undefined,
+    homefiles: string[],
+    homedir: string,
+}
+
+/**
+ * Collects information about a host and returns it in the form of a HostInfo object.
+ * 
+ * The function fetches the host's OS release, checks for the presence of the given tools,
+ * lists the files in the user's home directory, and determines the user's home directory path.
+ * 
+ * @param host The SshHost object to collect information about.
+ * @param toolsToCheck An array of strings, each containing the name of a command-line tool to check for.
+ * @returns A Promise resolving to a HostInfo object containing the collected host information.
+ */
+export async function collectHostInfo(host: SshHost, toolsToCheck: string[]): Promise<HostInfo> {
+    const hostInfo: HostInfo = {
+        sshHost: host,
+        osRelease: await host.fetchOsRelease(),
+        toolesInstalled: [],
+        neofetch: undefined,
+        homefiles: [],
+        homedir: await host.homeDir(),
+    }
+
+    hostInfo.homefiles = (await host.sftp.readdir(hostInfo.homedir)).map(
+        (stat) => stat.filename,
+    )
+
+    for (const tool of toolsToCheck) {
+        if (await host.cmdExists(tool)) {
+            hostInfo.toolesInstalled.push(tool)
+        }
+
+    }
+
+    return hostInfo
+}
+
+/**
+ * Executes a series of commands on a given SSH host, alternating between
+ * listing directory contents and sleeping for increasing durations.
+ *
+ * The function runs the "ls -al" command to list all files in the current
+ * directory, then pauses execution with the "sleep" command for 1 second,
+ * 2 seconds, and 3 seconds, respectively, between each directory listing.
+ *
+ * @param host The SshHost object on which to execute the commands.
+ * @returns A Promise that resolves when all commands have been executed.
+ */
+export async function executeSleepWorkload(
+    host: SshHost,
+): Promise<void> {
+    await host.exec("ls -al")
+    await host.exec("sleep 1")
+    await host.exec("ls -al")
+    await host.exec("sleep 2")
+    await host.exec("ls -al")
+    await host.exec("sleep 3")
+    await host.exec("ls -al")
+}

src/test/e2e/concurrent-exec.test.ts

@@ -0,0 +1,93 @@
+import { SshHost } from "../../index.js"
+
+export interface TestHost {
+    id: number,
+    host: string,
+    user: string,
+    port: number,
+    privateKeyPath: string
+}
+
+/**
+ * Loads host configuration from environment variables and returns an array of TestHost objects.
+ * 
+ * The function iterates over environment variables to find host configurations following the 
+ * pattern `TEST_HOST1`, `TEST_HOST2`, etc., appending the details for each host into an array. 
+ * If any required environment variable for a host is not set, an error is thrown.
+ * 
+ * @throws Will throw an error if any of the required environment variables (_HOST, _USER, _PORT, _KEYPATH) 
+ *         for a host are not set.
+ * @returns An array of TestHost objects, each containing the host's id, hostname, username, port, 
+ *          and private key path.
+ */
+export function loadEnvVars(): TestHost[] {
+    let i = 1
+    const hosts: TestHost[] = []
+    while (true) {
+        const key = "TEST_HOST" + i
+        const host: TestHost = {
+            id: i - 1,
+            host: process.env[key + "_HOST"] ?? "",
+            user: process.env[key + "_USER"] ?? "",
+            port: Number(process.env[key + "_PORT"]),
+            privateKeyPath: process.env[key + "_KEYPATH"] ?? "",
+        }
+
+        if (
+            host.host.length == 0
+            && host.user.length == 0
+            && isNaN(host.port)
+            && host.privateKeyPath.length == 0
+        ) {
+            break
+        }
+
+        if (host.host.length == 0) {
+            throw new Error("Env var " + key + "_HOST not set: " + JSON.stringify(host))
+        } else if (host.user.length == 0) {
+            throw new Error("Env var " + key + "_USER not set: " + JSON.stringify(host))
+        } else if (isNaN(host.port)) {
+            throw new Error("Env var " + key + "_PORT not set: " + JSON.stringify(host))
+        } else if (host.privateKeyPath.length == 0) {
+            throw new Error("Env var " + key + "_KEYPATH not set: " + JSON.stringify(host))
+        }
+
+        host.privateKeyPath =
+            host.privateKeyPath
+                .split("$HOME")
+                .join(process.env.HOME)
+
+        hosts.push(host)
+
+        i++
+    }
+
+    return hosts
+}
+
+/**
+ * Connects to all hosts in the given array and returns a Promise resolving to an array of 
+ * tuples, each containing the host configuration and the connected SshHost object.
+ * 
+ * @param hostData An array of TestHost objects, each containing the host's id, hostname, 
+ *                 username, port, and private key path.
+ * 
+ * @returns A Promise resolving to an array of tuples, each containing the host configuration 
+ *          and the connected SshHost object.
+ */
+export function connectTestHosts(
+    hostData: TestHost[],
+): Promise<[TestHost, SshHost][]> {
+    return Promise.all(
+        hostData.map(async (hostData) => {
+            const host = await SshHost.connect({
+                host: hostData.host,
+                user: hostData.user,
+                port: hostData.port,
+                privateKeyPath: hostData.privateKeyPath,
+            })
+
+            return [hostData, host]
+        })
+    )
+}