@sifurai/cli 0.1.0 → 0.1.1

package/dist/workspace.js

@@ -0,0 +1,142 @@
+import { execFileSync } from 'node:child_process';
+import { existsSync, mkdirSync, readFileSync, rmdirSync, rmSync, statSync, writeFileSync } from 'node:fs';
+import { basename, dirname, isAbsolute, posix, relative, resolve, win32 } from 'node:path';
+import { CliError } from './api.js';
+export function gitTopLevel(cwd) {
+    try {
+        const top = execFileSync('git', ['rev-parse', '--show-toplevel'], { cwd, encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] }).trim();
+        return top ? resolve(top) : null;
+    }
+    catch {
+        return null;
+    }
+}
+function sameRepository(folder, repository) {
+    const name = repository.split('/').pop() ?? repository;
+    return folder.toLowerCase() === name.toLowerCase();
+}
+/**
+ * The checkout the CLI was run from, for the first repository in `needing` that's clearly its: the
+ * repositories named are only that one, or the folder has its name.
+ */
+export function defaultWorkdirFor(named, needing, workdirs, topLevel) {
+    if (!topLevel)
+        return { workdirs, chosen: null };
+    const repository = needing.find((r) => !workdirs[r] && (named.size === 1 || sameRepository(basename(topLevel), r)));
+    if (!repository)
+        return { workdirs, chosen: null };
+    return { workdirs: { ...workdirs, [repository]: topLevel }, chosen: { repository, dir: topLevel } };
+}
+/** For a repository whose automated cases have no --workdir. */
+export function defaultWorkdirs(cases, workdirs, topLevel) {
+    const named = new Set(cases.map((c) => c.repository).filter((r) => Boolean(r)));
+    const needing = cases.filter((c) => c.check !== 'ui' && c.automatedTestRef && c.repository).map((c) => c.repository);
+    return defaultWorkdirFor(named, needing, workdirs, topLevel);
+}
+export function shellQuote(value, platform = process.platform) {
+    if (/^[A-Za-z0-9_\-./:@%+,=~]+$/.test(value))
+        return value;
+    if (platform === 'win32')
+        return `"${value.replaceAll('"', '""')}"`;
+    return `'${value.replaceAll("'", `'\\''`)}'`;
+}
+const LEADING_CD = /^\s*cd\s+(["']?)\/workspace(?:\/[^\s"';&|]*)?\1\s*&&\s*/;
+const SANDBOX_PATH = /(^|[^\w./-])(["']?)\/workspace\/[^\s/"';&|]+/g;
+/** Sifur's sandbox checks a repository out at /workspace/<name>; here it's the engineer's own checkout. */
+export function localizeCommand(command, workdir, platform = process.platform) {
+    return command.replace(LEADING_CD, '').replace(SANDBOX_PATH, (_match, before, quote) => {
+        if (quote === '"')
+            return `${before}"${workdir.replace(/["$`\\]/g, '\\$&')}`;
+        if (quote === "'")
+            return `${before}'${workdir.replaceAll("'", `'\\''`)}`;
+        return `${before}${shellQuote(workdir, platform)}`;
+    });
+}
+/** Refuses, before anything is written, a path that would land outside its repository. */
+export function checkFilePaths(files) {
+    for (const file of files) {
+        const outside = !file.path ||
+            posix.isAbsolute(file.path) ||
+            win32.isAbsolute(file.path) ||
+            file.path.split(/[\\/]/).includes('..');
+        if (outside)
+            throw new CliError(`Sifur sent a test file to put at "${file.path}", outside the ${file.repository} repository. Refusing to write it.`);
+    }
+}
+/**
+ * Writes the test files Sifur keeps out of the repository into the checkout for the run. `remove` puts
+ * the checkout back as it was: created files and the folders made for them go, replaced files come back.
+ */
+export function placeTestFiles(workdir, files) {
+    checkFilePaths(files);
+    const root = resolve(workdir);
+    const undo = [];
+    let removed = false;
+    const remove = () => {
+        if (removed)
+            return;
+        removed = true;
+        for (const step of undo.reverse()) {
+            try {
+                step();
+            }
+            catch {
+                // A folder that isn't empty any more, or a file already gone, is left as it is.
+            }
+        }
+    };
+    try {
+        for (const file of files) {
+            const target = resolve(root, file.path);
+            const inside = relative(root, target);
+            if (!inside || inside.startsWith('..') || isAbsolute(inside)) {
+                throw new CliError(`Sifur sent a test file to put at "${file.path}", outside ${root}. Refusing to write it.`);
+            }
+            const missing = [];
+            for (let dir = dirname(target); dir !== root && !existsSync(dir); dir = dirname(dir))
+                missing.unshift(dir);
+            for (const dir of missing) {
+                mkdirSync(dir);
+                undo.push(() => rmdirSync(dir));
+            }
+            const content = Buffer.from(file.content, 'utf8');
+            if (existsSync(target)) {
+                if (!statSync(target).isFile())
+                    throw new CliError(`Can't put a test file at ${target}: something else is there.`);
+                const before = readFileSync(target);
+                if (before.equals(content))
+                    continue;
+                writeFileSync(target, content);
+                undo.push(() => writeFileSync(target, before));
+            }
+            else {
+                writeFileSync(target, content);
+                undo.push(() => rmSync(target, { force: true }));
+            }
+        }
+    }
+    catch (error) {
+        remove();
+        throw error;
+    }
+    return { workdir: root, count: files.length, remove };
+}
+/** Removes the placed files however the run ends: normally, on Ctrl-C or SIGTERM, or through process.exit. */
+export function removeOnExit(placed) {
+    const removeAll = () => {
+        for (const files of placed())
+            files.remove();
+    };
+    const onSignal = (signal) => {
+        removeAll();
+        process.exit(signal === 'SIGINT' ? 130 : 143);
+    };
+    process.on('exit', removeAll);
+    process.on('SIGINT', onSignal);
+    process.on('SIGTERM', onSignal);
+    return () => {
+        process.off('exit', removeAll);
+        process.off('SIGINT', onSignal);
+        process.off('SIGTERM', onSignal);
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sifurai/cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Run a Sifur ticket's acceptance cases against your own test server and upload the results.",
   "license": "UNLICENSED",
   "homepage": "https://sifur.ai",