@argos-ci/cli 0.4.1 → 0.4.3

package/dist/index.mjs

@@ -3,14 +3,14 @@ import { fileURLToPath } from 'node:url';
 import { resolve } from 'node:path';
 import { program } from 'commander';
 import convict from 'convict';
-import envCi from 'env-ci';
-import { execSync } from 'child_process';
+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 { createReadStream } from 'node:fs';
 import { createHash } from 'node:crypto';
 import axios from 'axios';
 import ora from 'ora';
@@ -118,20 +118,41 @@ const createConfig = ()=>{
     });
 };
 
+/**
+ * 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  })=>{
-        const ciProps = envCiDetection({
-            env
-        });
         return {
-            commit: ciProps?.commit || null,
-            branch: env.BUILDKITE_BRANCH || null,
+            // 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: env.BUILDKITE_JOB_ID || null,
-            runId: ciProps?.runId || null,
+            jobId: null,
+            runId: null,
             prNumber: env.BUILDKITE_PULL_REQUEST ? Number(env.BUILDKITE_PULL_REQUEST) : null
         };
     }
@@ -145,95 +166,60 @@ const service$3 = {
             branch: env.HEROKU_TEST_RUN_BRANCH || null,
             owner: null,
             repository: null,
-            jobId: env.HEROKU_TEST_RUN_ID || null,
+            jobId: null,
             runId: null,
             prNumber: null
         })
 };
 
-const getSha = ({ env  })=>{
-    const isPr = env.GITHUB_EVENT_NAME === "pull_request" || env.GITHUB_EVENT_NAME === "pull_request_target";
-    if (isPr) {
-        const mergeCommitRegex = /^[a-z0-9]{40} [a-z0-9]{40}$/;
-        const mergeCommitMessage = execSync("git show --no-patch --format=%P").toString().trim();
-        // console.log(
-        //   `Handling PR with parent hash(es) '${mergeCommitMessage}' of current commit.`
-        // );
-        if (mergeCommitRegex.exec(mergeCommitMessage)) {
-            const mergeCommit = mergeCommitMessage.split(" ")[1];
-            // console.log(
-            //   `Fixing merge commit SHA ${process.env.GITHUB_SHA} -> ${mergeCommit}`
-            // );
-            return mergeCommit;
-        } else if (mergeCommitMessage === "") {
-            console.error(`Error: automatic detection of commit SHA failed.
-
-Please run "actions/checkout" with "fetch-depth: 2". Example:
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 2
-
-`);
-            process.exit(1);
-        } else {
-            console.error(`Commit with SHA ${process.env.GITHUB_SHA} is not a valid commit`);
-            process.exit(1);
-        }
-    }
-    return process.env.GITHUB_SHA ?? null;
-};
-function getBranch({ env  }) {
+const getBranch = ({ env  })=>{
     if (env.GITHUB_HEAD_REF) {
         return env.GITHUB_HEAD_REF;
     }
     const branchRegex = /refs\/heads\/(.*)/;
-    const branchMatches = branchRegex.exec(env.GITHUB_REF || "");
-    if (branchMatches) {
-        return branchMatches[1];
+    const matches = branchRegex.exec(env.GITHUB_REF || "");
+    if (matches) {
+        return matches[1];
     }
     return null;
-}
-function getRepository({ env  }) {
+};
+const getRepository$1 = ({ env  })=>{
     if (!env.GITHUB_REPOSITORY) return null;
     return env.GITHUB_REPOSITORY.split("/")[1];
-}
-const getPrNumber$1 = ({ env  })=>{
-    const branchRegex = /refs\/pull\/(\d+)/;
-    const branchMatches = branchRegex.exec(env.GITHUB_REF || "");
-    if (branchMatches) {
-        return Number(branchMatches[1]);
-    }
-    return null;
+};
+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  })=>({
-            commit: getSha({
-                env
-            }),
-            branch: getBranch({
+    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({
+            repository: getRepository$1({
                 env
             }),
             jobId: env.GITHUB_JOB || null,
             runId: env.GITHUB_RUN_ID || null,
-            prNumber: getPrNumber$1({
-                env
-            })
-        })
+            prNumber: payload?.pull_request?.number || null
+        };
+    }
 };
 
-const getPrNumber = ({ env  })=>{
+const getPrNumber$1 = ({ env  })=>{
     const branchRegex = /pull\/(\d+)/;
-    const branchMatches = branchRegex.exec(env.CIRCLE_PULL_REQUEST || "");
-    if (branchMatches) {
-        return Number(branchMatches[1]);
+    const matches = branchRegex.exec(env.CIRCLE_PULL_REQUEST || "");
+    if (matches) {
+        return Number(matches[1]);
     }
     return null;
 };
@@ -241,52 +227,52 @@ const service$1 = {
     name: "CircleCI",
     detect: ({ env  })=>Boolean(env.CIRCLECI),
     config: ({ env  })=>{
-        const ciProps = envCiDetection({
-            env
-        });
         return {
-            commit: ciProps?.commit || null,
-            branch: ciProps?.branch || null,
-            owner: ciProps?.owner || null,
-            repository: ciProps?.repository || null,
-            jobId: ciProps?.jobId || null,
-            runId: ciProps?.runId || null,
-            prNumber: getPrNumber({
+            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: ({ env  })=>{
-        const ciProps = envCiDetection({
-            env
-        });
+    config: (ctx)=>{
+        const { env  } = ctx;
         return {
-            commit: ciProps?.commit || null,
-            branch: ciProps?.branch || null,
-            owner: ciProps?.owner || null,
-            repository: ciProps?.repository || null,
-            jobId: ciProps?.jobId || null,
-            runId: ciProps?.runId || null,
-            prNumber: env.TRAVIS_PULL_REQUEST ? Number(env.TRAVIS_PULL_REQUEST) : null
+            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 services = [
-    service$3,
-    service$2,
-    service$1,
-    service,
-    service$4
-];
-const envCiDetection = (ctx)=>{
+const getCiEnvironmentFromEnvCi = (ctx)=>{
     const ciContext = envCi(ctx);
     const name = ciContext.isCi ? ciContext.name ?? null : ciContext.commit ? "Git" : null;
     const commit = ciContext.commit ?? null;
@@ -308,6 +294,14 @@ const envCiDetection = (ctx)=>{
         prNumber
     } : null;
 };
+
+const services = [
+    service$3,
+    service$2,
+    service$1,
+    service,
+    service$4
+];
 const getCiEnvironment = ({ env =process.env  } = {})=>{
     const ctx = {
         env
@@ -316,7 +310,7 @@ const getCiEnvironment = ({ env =process.env  } = {})=>{
         env
     });
     const service = services.find((service)=>service.detect(ctx));
-    // Internal service matched
+    // Service matched
     if (service) {
         debug("Internal service matched", service.name);
         const variables = service.config(ctx);
@@ -327,8 +321,9 @@ const getCiEnvironment = ({ env =process.env  } = {})=>{
         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 = envCiDetection(ctx);
+    const ciEnvironment1 = getCiEnvironmentFromEnvCi(ctx);
     debug("CI environment", ciEnvironment1);
     return ciEnvironment1;
 };

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.1",
+  "version": "0.4.3",
   "bin": {
     "argos": "./bin/argos-cli.js"
   },
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/core": "^0.7.1",
+    "@argos-ci/core": "^0.7.3",
     "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": "0ae6b18c7728deb14beb7ffee85e9faf104c4365"
+  "gitHead": "56d7e2259161c49265d8983ce0f0ecfe71910d2b"
 }