@rocketmakers/shell-tests 0.1.0

package/README.md

@@ -0,0 +1,3 @@
+## Overview
+
+Contains functions for running integration tests against the various `@rocketmakers/shell-*` packages.

package/lib/suite.d.ts

@@ -0,0 +1,39 @@
+import { Logger } from '@rocketmakers/log';
+import { IShellExecutor } from '@rocketmakers/shell/executor';
+export interface ITestSuite {
+    suiteName: string;
+    sandboxRootPath: string;
+}
+/**
+ * Runs a sandboxed test suite.
+ *
+ * This utility function ensures that a sandbox testing directory exists and is empty before each test.
+ * It provides a clean environment for every test run by automatically creating and cleaning up the sandbox directory.
+ *
+ * @param suiteConfig - Configuration for the test suite.
+ * @param suiteConfig.suiteName - The name of the test suite, used for logging and test descriptions.
+ * @param suiteConfig.sandboxRootPath - The root path of the sandbox directory to be used for testing.
+ * @param runSuite - A callback function that contains the test suite logic. It receives a logger and shell executor as arguments.
+ *
+ * ### Example Usage:
+ * ```typescript
+ * sandboxedTestSuite(
+ *   { suiteName: 'My Test Suite', sandboxRootPath: '/tmp/my-sandbox' },
+ *   (logger, shell) => {
+ *     it('should perform a test', async () => {
+ *       logger.info('Running test...');
+ *       await shell.exec(['echo', 'Hello, World!']);
+ *     });
+ *   }
+ * );
+ * ```
+ *
+ * @remarks
+ * - The `logger` is created using the suite name and can be used for logging within the test suite.
+ * - The `shell` is an instance of `IShellExecutor` and can be used to execute shell commands.
+ *
+ * @throws
+ * - Errors from `Prerequisites.check` if prerequisites are not met.
+ * - Errors from `mkdir` or `rm` commands if the sandbox directory cannot be managed.
+ */
+export declare function sandboxedTestSuite({ suiteName, sandboxRootPath }: ITestSuite, runSuite: (logger: Logger, shell: IShellExecutor) => void): void;

package/lib/suite.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sandboxedTestSuite = sandboxedTestSuite;
+const tslib_1 = require("tslib");
+const logger_1 = require("@rocketmakers/shell/logger");
+const Prerequisites = tslib_1.__importStar(require("@rocketmakers/shell/prerequisites"));
+const shell_executor_1 = require("@rocketmakers/shell-executor");
+const promises_1 = require("fs/promises");
+/**
+ * Runs a sandboxed test suite.
+ *
+ * This utility function ensures that a sandbox testing directory exists and is empty before each test.
+ * It provides a clean environment for every test run by automatically creating and cleaning up the sandbox directory.
+ *
+ * @param suiteConfig - Configuration for the test suite.
+ * @param suiteConfig.suiteName - The name of the test suite, used for logging and test descriptions.
+ * @param suiteConfig.sandboxRootPath - The root path of the sandbox directory to be used for testing.
+ * @param runSuite - A callback function that contains the test suite logic. It receives a logger and shell executor as arguments.
+ *
+ * ### Example Usage:
+ * ```typescript
+ * sandboxedTestSuite(
+ *   { suiteName: 'My Test Suite', sandboxRootPath: '/tmp/my-sandbox' },
+ *   (logger, shell) => {
+ *     it('should perform a test', async () => {
+ *       logger.info('Running test...');
+ *       await shell.exec(['echo', 'Hello, World!']);
+ *     });
+ *   }
+ * );
+ * ```
+ *
+ * @remarks
+ * - The `logger` is created using the suite name and can be used for logging within the test suite.
+ * - The `shell` is an instance of `IShellExecutor` and can be used to execute shell commands.
+ *
+ * @throws
+ * - Errors from `Prerequisites.check` if prerequisites are not met.
+ * - Errors from `mkdir` or `rm` commands if the sandbox directory cannot be managed.
+ */
+function sandboxedTestSuite({ suiteName, sandboxRootPath }, runSuite) {
+    const logger = (0, logger_1.createLogger)(suiteName);
+    const shell = new shell_executor_1.ShellExecutor();
+    (0, logger_1.setDefaultLoggerLevel)(process.env.LOG_LEVEL || 'error');
+    const deleteSandboxDir = () => shell.exec(['rm', '-rf', sandboxRootPath]);
+    describe(`${suiteName}`, () => {
+        beforeAll(async () => {
+            await Prerequisites.check(shell);
+        });
+        beforeEach(async () => {
+            await deleteSandboxDir();
+            await (0, promises_1.mkdir)(sandboxRootPath);
+        });
+        afterEach(async () => {
+            await deleteSandboxDir();
+        });
+        runSuite(logger, shell);
+    });
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@rocketmakers/shell-tests",
+  "version": "0.1.0",
+  "exports": {
+    "./suite": {
+      "types": "./lib/suite.d.ts",
+      "default": "./lib/suite.js"
+    }
+  },
+  "dependencies": {
+    "@rocketmakers/log": "0.1.0",
+    "@rocketmakers/shell": "0.1.0",
+    "@rocketmakers/shell-executor": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/jest": "29.5.14",
+    "@types/node": "22.13.9",
+    "eslint": "8.57.1",
+    "jest": "29.7.0",
+    "jest-junit": "16.0.0",
+    "ts-jest": "29.3.0",
+    "typescript": "5.8.2",
+    "tslib": "2.8.1",
+    "eslint-config-shell": "0.1.0",
+    "tsconfig-shell": "0.1.0"
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "engines": {
+    "node": "^20 || ^22"
+  },
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.d.ts",
+    "!lib/index.js",
+    "!lib/index.d.ts"
+  ],
+  "keywords": [],
+  "license": "MIT",
+  "repository": "Rocketmakers/rocketmakers-packages",
+  "scripts": {
+    "build": "tsc -p .",
+    "lint": "eslint . --ext .ts",
+    "lint-fix": "pnpm lint --fix"
+  }
+}