@argos-ci/core 0.4.0 → 0.4.2-alpha.3

package/dist/index.mjs

@@ -29,7 +29,7 @@ const mustBeCommit = (value)=>{
     }
 };
 const mustBeArgosToken = (value)=>{
-    if (value.length !== 40) {
+    if (value && value.length !== 40) {
         throw new Error("Must be a valid Argos repository token");
     }
 };
@@ -52,7 +52,7 @@ const schema = {
     },
     token: {
         env: "ARGOS_TOKEN",
-        default: "",
+        default: null,
         format: mustBeArgosToken
     },
     buildName: {
@@ -82,6 +82,21 @@ const schema = {
         format: String,
         default: null,
         nullable: true
+    },
+    jobId: {
+        format: String,
+        default: null,
+        nullable: true
+    },
+    owner: {
+        format: String,
+        default: null,
+        nullable: true
+    },
+    repository: {
+        format: String,
+        default: null,
+        nullable: true
     }
 };
 const createConfig = ()=>{
@@ -107,7 +122,10 @@ const service$1 = {
     config: ({ env  })=>({
             name: "Heroku",
             commit: env.HEROKU_TEST_RUN_COMMIT_VERSION || null,
-            branch: env.HEROKU_TEST_RUN_BRANCH || null
+            branch: env.HEROKU_TEST_RUN_BRANCH || null,
+            owner: null,
+            repository: null,
+            jobId: env.HEROKU_TEST_RUN_ID || null
         })
 };
 
@@ -116,20 +134,26 @@ const getSha = ({ env  })=>{
     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.`);
+        // 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}`);
+            // console.log(
+            //   `Fixing merge commit SHA ${process.env.GITHUB_SHA} -> ${mergeCommit}`
+            // );
             return mergeCommit;
         } else if (mergeCommitMessage === "") {
-            console.error(`
-Issue detecting commit SHA. Please run actions/checkout with "fetch-depth: 2":
+            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
-`.trim());
+    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`);
@@ -152,13 +176,16 @@ function getBranch({ env  }) {
 const service = {
     detect: ({ env  })=>Boolean(env.GITHUB_ACTIONS),
     config: ({ env  })=>({
-            name: "GiHub Actions",
+            name: "GitHub Actions",
             commit: getSha({
                 env
             }),
             branch: getBranch({
                 env
-            })
+            }),
+            owner: env.GITHUB_REPOSITORY_OWNER || null,
+            repository: env.GITHUB_REPOSITORY || null,
+            jobId: env.GITHUB_JOB || null
         })
 };
 
@@ -179,11 +206,18 @@ const getCiEnvironment = ({ env =process.env  } = {})=>{
     const ciContext = envCi(ctx);
     const name = ciContext.isCi ? ciContext.name ?? null : ciContext.commit ? "Git" : null;
     const commit = ciContext.commit ?? null;
-    const branch = ciContext.branch ?? 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;
     return commit ? {
         name,
         commit,
-        branch
+        branch,
+        owner,
+        repository,
+        jobId
     } : null;
 };
 
@@ -242,11 +276,30 @@ const hashFile = async (filepath)=>{
     return hash.read().toString("hex");
 };
 
+const base64Encode = (obj)=>Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
+const getBearerToken = ({ token , ciService , owner , repository , jobId  })=>{
+    if (token) return `Bearer ${token}`;
+    switch(ciService){
+        case "GitHub Actions":
+            {
+                if (!owner || !repository || !jobId) {
+                    throw new Error(`Automatic ${ciService} variables detection failed. Please add the 'ARGOS_TOKEN'`);
+                }
+                return `Bearer tokenless-github-${base64Encode({
+                    owner,
+                    repository,
+                    jobId
+                })}`;
+            }
+        default:
+            throw new Error("Missing Argos repository token 'ARGOS_TOKEN'");
+    }
+};
 const createArgosApiClient = (options)=>{
     const axiosInstance = axios.create({
         baseURL: options.baseUrl,
         headers: {
-            Authorization: `Bearer ${options.token}`,
+            Authorization: options.bearerToken,
             "Content-Type": "application/json",
             Accept: "application/json"
         }
@@ -324,7 +377,10 @@ const getConfigFromOptions = (options)=>{
             config.load(omitUndefined({
                 commit: ciEnv.commit,
                 branch: ciEnv.branch,
-                ciService: ciEnv.name
+                ciService: ciEnv.name,
+                owner: ciEnv.owner,
+                repository: ciEnv.repository,
+                jobId: ciEnv.jobId
             }));
         }
     }
@@ -339,6 +395,10 @@ const getConfigFromOptions = (options)=>{
     const files = params.files ?? [
         "**/*.{png,jpg,jpeg}"
     ];
+    const apiClient = createArgosApiClient({
+        baseUrl: config.apiBaseUrl,
+        bearerToken: getBearerToken(config)
+    });
     // Collect screenshots
     const foundScreenshots = await discoverScreenshots(files, {
         root: params.root,
@@ -356,10 +416,6 @@ const getConfigFromOptions = (options)=>{
             hash
         };
     }));
-    const apiClient = createArgosApiClient({
-        baseUrl: config.apiBaseUrl,
-        token: config.token
-    });
     // Create build
     debug("Creating build");
     const result = await apiClient.createBuild({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Visual testing solution to avoid visual regression. The core component of Argos SDK that handles build creation.",
-  "version": "0.4.0",
+  "version": "0.4.2-alpha.3+1c181d8",
   "scripts": {
     "prebuild": "rm -rf dist",
     "build": "rollup -c",
@@ -60,5 +60,5 @@
     "rollup-plugin-dts": "^4.2.2",
     "rollup-plugin-swc3": "^0.3.0"
   },
-  "gitHead": "e0f6d67663b59b5f00180988ccbb0736a8755aa4"
+  "gitHead": "1c181d8e4e5258b2749840a3790cabda30b9a24e"
 }