@argos-ci/cli 0.4.3 → 0.4.5

package/dist/index.mjs

@@ -2,545 +2,9 @@ import { readFile } from 'node:fs/promises';
 import { fileURLToPath } from 'node:url';
 import { resolve } from 'node:path';
 import { program } from 'commander';
-import convict from 'convict';
-import { execSync } from 'node:child_process';
-import { existsSync, readFileSync, createReadStream } from 'node:fs';
-import createDebug from 'debug';
-import envCi from 'env-ci';
-import glob from 'fast-glob';
-import { promisify } from 'node:util';
-import sharp from 'sharp';
-import tmp from 'tmp';
-import { createHash } from 'node:crypto';
-import axios from 'axios';
+import { upload } from '@argos-ci/core';
 import ora from 'ora';
 
-const mustBeApiBaseUrl = (value)=>{
-    const URL_REGEX = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/;
-    if (!URL_REGEX.test(value)) {
-        throw new Error("Invalid Argos API base URL");
-    }
-};
-const mustBeCommit = (value)=>{
-    const SHA1_REGEX = /^[0-9a-f]{40}$/;
-    if (!SHA1_REGEX.test(value)) {
-        const SHA1_SHORT_REGEX = /^[0-9a-f]{7}$/;
-        if (SHA1_SHORT_REGEX.test(value)) {
-            throw new Error("Short SHA1 is not allowed");
-        }
-        throw new Error("Invalid commit");
-    }
-};
-const mustBeArgosToken = (value)=>{
-    if (value && value.length !== 40) {
-        throw new Error("Must be a valid Argos repository token");
-    }
-};
-const schema = {
-    apiBaseUrl: {
-        env: "ARGOS_API_BASE_URL",
-        default: "https://api.argos-ci.com/v2/",
-        format: mustBeApiBaseUrl
-    },
-    commit: {
-        env: "ARGOS_COMMIT",
-        default: null,
-        format: mustBeCommit
-    },
-    branch: {
-        env: "ARGOS_BRANCH",
-        default: null,
-        format: String
-    },
-    token: {
-        env: "ARGOS_TOKEN",
-        default: null,
-        format: mustBeArgosToken
-    },
-    buildName: {
-        env: "ARGOS_BUILD_NAME",
-        default: null,
-        format: String,
-        nullable: true
-    },
-    prNumber: {
-        env: "ARGOS_PR_NUMBER",
-        format: Number,
-        default: null,
-        nullable: true
-    },
-    parallel: {
-        env: "ARGOS_PARALLEL",
-        default: false,
-        format: Boolean
-    },
-    parallelNonce: {
-        env: "ARGOS_PARALLEL_NONCE",
-        format: String,
-        default: null,
-        nullable: true
-    },
-    parallelTotal: {
-        env: "ARGOS_PARALLEL_TOTAL",
-        format: "nat",
-        default: null,
-        nullable: true
-    },
-    ciService: {
-        format: String,
-        default: null,
-        nullable: true
-    },
-    jobId: {
-        format: String,
-        default: null,
-        nullable: true
-    },
-    runId: {
-        format: String,
-        default: null,
-        nullable: true
-    },
-    owner: {
-        format: String,
-        default: null,
-        nullable: true
-    },
-    repository: {
-        format: String,
-        default: null,
-        nullable: true
-    }
-};
-const createConfig = ()=>{
-    return convict(schema, {
-        args: []
-    });
-};
-
-/**
- * Returns the head commit.
- */ const head = ()=>{
-    try {
-        return execSync("git rev-parse HEAD").toString().trim();
-    } catch  {
-        return null;
-    }
-};
-/**
- * Returns the current branch.
- */ const branch = ()=>{
-    try {
-        const headRef = execSync("git rev-parse --abbrev-ref HEAD").toString().trim();
-        if (headRef === "HEAD") {
-            return null;
-        }
-        return headRef;
-    } catch  {
-        return null;
-    }
-};
-
-const service$4 = {
-    name: "Buildkite",
-    detect: ({ env  })=>Boolean(env.BUILDKITE),
-    config: ({ env  })=>{
-        return {
-            // Buildkite doesn't work well so we fallback to git to ensure we have commit and branch
-            commit: env.BUILDKITE_COMMIT || head() || null,
-            branch: env.BUILDKITE_BRANCH || branch() || null,
-            owner: env.BUILDKITE_ORGANIZATION_SLUG || null,
-            repository: env.BUILDKITE_PROJECT_SLUG || null,
-            jobId: null,
-            runId: null,
-            prNumber: env.BUILDKITE_PULL_REQUEST ? Number(env.BUILDKITE_PULL_REQUEST) : null
-        };
-    }
-};
-
-const service$3 = {
-    name: "Heroku",
-    detect: ({ env  })=>Boolean(env.HEROKU_TEST_RUN_ID),
-    config: ({ env  })=>({
-            commit: env.HEROKU_TEST_RUN_COMMIT_VERSION || null,
-            branch: env.HEROKU_TEST_RUN_BRANCH || null,
-            owner: null,
-            repository: null,
-            jobId: null,
-            runId: null,
-            prNumber: null
-        })
-};
-
-const getBranch = ({ env  })=>{
-    if (env.GITHUB_HEAD_REF) {
-        return env.GITHUB_HEAD_REF;
-    }
-    const branchRegex = /refs\/heads\/(.*)/;
-    const matches = branchRegex.exec(env.GITHUB_REF || "");
-    if (matches) {
-        return matches[1];
-    }
-    return null;
-};
-const getRepository$1 = ({ env  })=>{
-    if (!env.GITHUB_REPOSITORY) return null;
-    return env.GITHUB_REPOSITORY.split("/")[1];
-};
-const readEventPayload = ({ env  })=>{
-    if (!env.GITHUB_EVENT_PATH) return null;
-    if (!existsSync(env.GITHUB_EVENT_PATH)) return null;
-    return JSON.parse(readFileSync(env.GITHUB_EVENT_PATH, "utf-8"));
-};
-const service$2 = {
-    name: "GitHub Actions",
-    detect: ({ env  })=>Boolean(env.GITHUB_ACTIONS),
-    config: ({ env  })=>{
-        const payload = readEventPayload({
-            env
-        });
-        return {
-            commit: payload?.pull_request?.head.sha || process.env.GITHUB_SHA || null,
-            branch: payload?.pull_request?.head.ref || getBranch({
-                env
-            }) || null,
-            owner: env.GITHUB_REPOSITORY_OWNER || null,
-            repository: getRepository$1({
-                env
-            }),
-            jobId: env.GITHUB_JOB || null,
-            runId: env.GITHUB_RUN_ID || null,
-            prNumber: payload?.pull_request?.number || null
-        };
-    }
-};
-
-const getPrNumber$1 = ({ env  })=>{
-    const branchRegex = /pull\/(\d+)/;
-    const matches = branchRegex.exec(env.CIRCLE_PULL_REQUEST || "");
-    if (matches) {
-        return Number(matches[1]);
-    }
-    return null;
-};
-const service$1 = {
-    name: "CircleCI",
-    detect: ({ env  })=>Boolean(env.CIRCLECI),
-    config: ({ env  })=>{
-        return {
-            commit: env.CIRCLE_SHA1 || null,
-            branch: env.CIRCLE_BRANCH || null,
-            owner: env.CIRCLE_PROJECT_USERNAME || null,
-            repository: env.CIRCLE_PROJECT_REPONAME || null,
-            jobId: null,
-            runId: null,
-            prNumber: getPrNumber$1({
-                env
-            })
-        };
-    }
-};
-
-const getOwner = ({ env  })=>{
-    if (!env.TRAVIS_REPO_SLUG) return null;
-    return env.TRAVIS_REPO_SLUG.split("/")[0] || null;
-};
-const getRepository = ({ env  })=>{
-    if (!env.TRAVIS_REPO_SLUG) return null;
-    return env.TRAVIS_REPO_SLUG.split("/")[1] || null;
-};
-const getPrNumber = ({ env  })=>{
-    if (env.TRAVIS_PULL_REQUEST) return Number(env.TRAVIS_PULL_REQUEST);
-    return null;
-};
-const service = {
-    name: "Travis CI",
-    detect: ({ env  })=>Boolean(env.TRAVIS),
-    config: (ctx)=>{
-        const { env  } = ctx;
-        return {
-            commit: env.TRAVIS_COMMIT || null,
-            branch: env.TRAVIS_BRANCH || null,
-            owner: getOwner(ctx),
-            repository: getRepository(ctx),
-            jobId: null,
-            runId: null,
-            prNumber: getPrNumber(ctx)
-        };
-    }
-};
-
-const debug = createDebug("@argos-ci/core");
-
-const getCiEnvironmentFromEnvCi = (ctx)=>{
-    const ciContext = envCi(ctx);
-    const name = ciContext.isCi ? ciContext.name ?? null : ciContext.commit ? "Git" : null;
-    const commit = ciContext.commit ?? null;
-    const branch = (ciContext.branch || ciContext.prBranch) ?? null;
-    const slug = ciContext.slug ? ciContext.slug.split("/") : null;
-    const owner = slug ? slug[0] : null;
-    const repository = slug ? slug[1] : null;
-    const jobId = ciContext.job ?? null;
-    const runId = null;
-    const prNumber = null;
-    return commit ? {
-        name,
-        commit,
-        branch,
-        owner,
-        repository,
-        jobId,
-        runId,
-        prNumber
-    } : null;
-};
-
-const services = [
-    service$3,
-    service$2,
-    service$1,
-    service,
-    service$4
-];
-const getCiEnvironment = ({ env =process.env  } = {})=>{
-    const ctx = {
-        env
-    };
-    debug("Detecting CI environment", {
-        env
-    });
-    const service = services.find((service)=>service.detect(ctx));
-    // Service matched
-    if (service) {
-        debug("Internal service matched", service.name);
-        const variables = service.config(ctx);
-        const ciEnvironment = {
-            name: service.name,
-            ...variables
-        };
-        debug("CI environment", ciEnvironment);
-        return ciEnvironment;
-    }
-    // We fallback on "env-ci" library, not very good but it's better than nothing
-    debug("Falling back on env-ci");
-    const ciEnvironment1 = getCiEnvironmentFromEnvCi(ctx);
-    debug("CI environment", ciEnvironment1);
-    return ciEnvironment1;
-};
-
-const discoverScreenshots = async (patterns, { root =process.cwd() , ignore  } = {})=>{
-    const matches = await glob(patterns, {
-        onlyFiles: true,
-        ignore,
-        cwd: root
-    });
-    return matches.map((match)=>({
-            name: match,
-            path: resolve(root, match)
-        }));
-};
-
-const tmpFile = promisify(tmp.file);
-const optimizeScreenshot = async (filepath)=>{
-    const resultFilePath = await tmpFile();
-    await sharp(filepath).resize(2048, 20480, {
-        fit: "inside",
-        withoutEnlargement: true
-    }).png({
-        force: true
-    }).toFile(resultFilePath);
-    return resultFilePath;
-};
-
-const hashFile = async (filepath)=>{
-    const fileStream = createReadStream(filepath);
-    const hash = createHash("sha256");
-    await new Promise((resolve, reject)=>{
-        fileStream.on("error", reject);
-        hash.on("error", reject);
-        hash.on("finish", resolve);
-        fileStream.pipe(hash);
-    });
-    return hash.digest("hex");
-};
-
-const base64Encode = (obj)=>Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
-const getBearerToken = ({ token , ciService , owner , repository , jobId , runId , prNumber  })=>{
-    if (token) return `Bearer ${token}`;
-    switch(ciService){
-        case "GitHub Actions":
-            {
-                if (!owner || !repository || !jobId || !runId) {
-                    throw new Error(`Automatic ${ciService} variables detection failed. Please add the 'ARGOS_TOKEN'`);
-                }
-                return `Bearer tokenless-github-${base64Encode({
-                    owner,
-                    repository,
-                    jobId,
-                    runId,
-                    prNumber
-                })}`;
-            }
-        default:
-            throw new Error("Missing Argos repository token 'ARGOS_TOKEN'");
-    }
-};
-const createArgosApiClient = (options)=>{
-    const axiosInstance = axios.create({
-        baseURL: options.baseUrl,
-        headers: {
-            Authorization: options.bearerToken,
-            "Content-Type": "application/json",
-            Accept: "application/json"
-        }
-    });
-    const call = async (method, path, data)=>{
-        try {
-            debug("Sending request", {
-                method,
-                path,
-                data
-            });
-            const response = await axiosInstance.request({
-                method,
-                url: path,
-                data
-            });
-            debug("Getting response", {
-                status: response.status,
-                data: response.data
-            });
-            return response.data;
-        } catch (error) {
-            if (error?.response?.data?.error?.message) {
-                // @ts-ignore
-                throw new Error(error.response.data.error.message, {
-                    cause: error
-                });
-            }
-            throw error;
-        }
-    };
-    return {
-        createBuild: async (input)=>{
-            return call("POST", "/builds", input);
-        },
-        updateBuild: async (input)=>{
-            const { buildId , ...body } = input;
-            return call("PUT", `/builds/${buildId}`, body);
-        }
-    };
-};
-
-const upload$1 = async (input)=>{
-    const file = await readFile(input.path);
-    await axios({
-        method: "PUT",
-        url: input.url,
-        data: file,
-        headers: {
-            "Content-Type": "image/png"
-        }
-    });
-};
-
-const getConfigFromOptions = (options)=>{
-    const config = createConfig();
-    const ciEnv = getCiEnvironment();
-    config.load({
-        apiBaseUrl: config.get("apiBaseUrl") ?? options.apiBaseUrl,
-        commit: config.get("commit") ?? options.commit ?? ciEnv?.commit ?? null,
-        branch: config.get("branch") ?? options.branch ?? ciEnv?.branch ?? null,
-        token: config.get("token") ?? options.token ?? null,
-        buildName: config.get("buildName") ?? options.buildName ?? null,
-        prNumber: config.get("prNumber") ?? options.prNumber ?? ciEnv?.prNumber ?? null,
-        ciService: ciEnv?.name ?? null,
-        owner: ciEnv?.owner ?? null,
-        repository: ciEnv?.repository ?? null,
-        jobId: ciEnv?.jobId ?? null,
-        runId: ciEnv?.runId ?? null
-    });
-    if (options.parallel) {
-        config.load({
-            parallel: Boolean(options.parallel),
-            parallelNonce: options.parallel ? options.parallel.nonce : null,
-            parallelTotal: options.parallel ? options.parallel.total : null
-        });
-    }
-    config.validate();
-    return config.get();
-};
-/**
- * Upload screenshots to argos-ci.com.
- */ const upload = async (params)=>{
-    debug("Starting upload with params", params);
-    // Read config
-    const config = getConfigFromOptions(params);
-    const files = params.files ?? [
-        "**/*.{png,jpg,jpeg}"
-    ];
-    debug("Using config and files", config, files);
-    const apiClient = createArgosApiClient({
-        baseUrl: config.apiBaseUrl,
-        bearerToken: getBearerToken(config)
-    });
-    // Collect screenshots
-    const foundScreenshots = await discoverScreenshots(files, {
-        root: params.root,
-        ignore: params.ignore
-    });
-    debug("Found screenshots", foundScreenshots);
-    // Optimize & compute hashes
-    const screenshots = await Promise.all(foundScreenshots.map(async (screenshot)=>{
-        const optimizedPath = await optimizeScreenshot(screenshot.path);
-        const hash = await hashFile(optimizedPath);
-        return {
-            ...screenshot,
-            optimizedPath,
-            hash
-        };
-    }));
-    // Create build
-    debug("Creating build");
-    const result = await apiClient.createBuild({
-        commit: config.commit,
-        branch: config.branch,
-        name: config.buildName,
-        parallel: config.parallel,
-        parallelNonce: config.parallelNonce,
-        screenshotKeys: Array.from(new Set(screenshots.map((screenshot)=>screenshot.hash))),
-        prNumber: config.prNumber
-    });
-    debug("Got screenshots", result);
-    // Upload screenshots
-    debug("Uploading screenshots");
-    await Promise.all(result.screenshots.map(async ({ key , putUrl  })=>{
-        const screenshot = screenshots.find((s)=>s.hash === key);
-        if (!screenshot) {
-            throw new Error(`Invariant: screenshot with hash ${key} not found`);
-        }
-        await upload$1({
-            url: putUrl,
-            path: screenshot.optimizedPath
-        });
-    }));
-    // Update build
-    debug("Updating build");
-    await apiClient.updateBuild({
-        buildId: result.build.id,
-        screenshots: screenshots.map((screenshot)=>({
-                key: screenshot.hash,
-                name: screenshot.name
-            })),
-        parallel: config.parallel,
-        parallelTotal: config.parallelTotal
-    });
-    return {
-        build: result.build,
-        screenshots
-    };
-};
-
 const __dirname = fileURLToPath(new URL(".", import.meta.url));
 const rawPkg = await readFile(resolve(__dirname, "..", "package.json"), "utf8");
 const pkg = JSON.parse(rawPkg);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cli",
   "description": "Visual testing solution to avoid visual regression. Argos CLI is used to interact with and upload screenshots to argos-ci.com via command line.",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "bin": {
     "argos": "./bin/argos-cli.js"
   },
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/core": "^0.7.3",
+    "@argos-ci/core": "^0.8.1",
     "commander": "^9.4.1",
     "ora": "^6.1.2",
     "update-notifier": "^6.0.2"
@@ -49,5 +49,5 @@
     "rollup": "^2.79.1",
     "rollup-plugin-swc3": "^0.6.0"
   },
-  "gitHead": "56d7e2259161c49265d8983ce0f0ecfe71910d2b"
+  "gitHead": "12cffdc1330d8e8c89db91cb87ddcc6775da34be"
 }