Improve tests (#48)

.github/ISSUE_TEMPLATE/having-a-question-.md

@@ -7,4 +7,4 @@ assignees: ''
 
 ---
 
-Please ask questions in the [Discussions](https://github.com/UnlyEd/github-action-await-vercel/discussions)! :)
+Please ask questions in the [Discussions](https://github.com/UnlyEd/github-action-store-variable/discussions)! :)

.github/workflows/auto-git-release-production.yml

@@ -70,6 +70,8 @@ jobs:
           files: |
             CHANGELOG.md
 
+# TODO les versions majeures ne sont pas màj
+      # la version dans GHA marketplace est pas màj
       - name: Updating Git release tag for the major "v${{steps.next_semantic_version.outputs.major}}" version
         uses: softprops/action-gh-release@v1
         with: # See https://github.com/softprops/action-gh-release#-customizing

.github/workflows/check-build.yml

@@ -20,3 +20,6 @@ jobs:
       - run: |
           yarn
           yarn build:once
+          yarn test:once
+          yarn lint
+          yarn format:preview

__tests__/main.test.ts

@@ -33,7 +33,7 @@ function exec_lib(options: cp.ExecFileSyncOptions): string {
   /**
    * Path of the compiled version of the Action file entrypoint.
    *
-   * @example .../github-action-await-vercel/lib/main.js
+   * @example .../github-action-store-variable/lib/main.js
    */
   const mainFilePath = path.join(__dirname, '..', BUILD_DIR, BUILD_MAIN_FILENAME);
 
@@ -48,26 +48,55 @@ function exec_lib(options: cp.ExecFileSyncOptions): string {
 }
 
 describe('Functional test', () => {
-  const CORRECT_DOMAIN = `${process.env.VERCEL_DOMAIN}`;
-  const WRONG_DOMAIN = 'i-am-wrong.vercel.app';
-
   describe('should pass when', () => {
     beforeEach(() => {
       // @ts-ignore
       global.console = global.unmuteConsole();
     });
 
-    describe('using special delimiter', () => {
+    describe('when storing variables using a special delimiter', () => {
       const options: cp.ExecFileSyncOptions = {
         env: {
-          INPUT_VARIABLES: 'VAR=TEST,OTHER_VAR=OTHER_TEST,RETRIEVE',
+          INPUT_VARIABLES: 'VAR=TEST,OTHER_VAR=OTHER_TEST,UNKNOWN_VAR',
           INPUT_DELIMITER: ',',
         },
       };
-      const filteredContent = exec_lib(options);
-      test('test', () => {
-        expect(filteredContent.includes(',')).toBe(true);
-        console.log(filteredContent);
+      const output = exec_lib(options);
+      console.log('output:\n', output);
+
+      test('output should display all received variables', () => {
+        expect(output.includes('::debug::Received variables: VAR=TEST,OTHER_VAR=OTHER_TEST,UNKNOWN_VAR')).toBe(true);
+      });
+
+      test('output should display used delimiter', () => {
+        expect(output.includes('::debug::Using delimiter: ","')).toBe(true);
+      });
+
+      test('output should display warning about UNKNOWN_VAR not being found', () => {
+        expect(output.includes('::warning::Cannot retrieve variable UNKNOWN_VAR')).toBe(true);
+      });
+    });
+
+    describe('when storing variables', () => {
+      const options: cp.ExecFileSyncOptions = {
+        env: {
+          INPUT_VARIABLES: 'VAR1=1,VAR2=SOME_STRING',
+          INPUT_DELIMITER: ',',
+        },
+      };
+      const output = exec_lib(options);
+      console.log('output:\n', output);
+
+      test('output should display all received variables', () => {
+        expect(output.includes('::debug::Received variables: VAR1=1,VAR2=SOME_STRING')).toBe(true);
+      });
+
+      test('output should display used delimiter', () => {
+        expect(output.includes('::debug::Using delimiter: ","')).toBe(true);
+      });
+
+      test('output should NOT display warning about UNKNOWN_VAR not being found (because we did not try to read it)', () => {
+        expect(output.includes('::warning::Cannot retrieve variable UNKNOWN_VAR')).toBe(false);
       });
     });
   });

lib/main.js

@@ -37,32 +37,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const core = __importStar(require("@actions/core"));
 const manageArtifacts_1 = __importDefault(require("./manageArtifacts"));
-/**
- * Runs configuration checks to make sure everything is properly configured.
- * If anything isn't properly configured, will stop the workflow.
- */
-const runConfigChecks = () => {
-    if (!process.env.VERCEL_TOKEN) {
-        const message = process.env.NODE_ENV === 'test'
-            ? `VERCEL_TOKEN environment variable is not defined. Please define it in the ".env.test" file. See https://vercel.com/account/tokens`
-            : `VERCEL_TOKEN environment variable is not defined. Please create a GitHub "VERCEL_TOKEN" secret. See https://vercel.com/account/tokens`;
-        core.setFailed(message);
-        throw new Error(message);
-    }
-};
 /**
  * Runs the GitHub Action.
  */
 const run = () => __awaiter(void 0, void 0, void 0, function* () {
     if (!core.isDebug()) {
-        core.info('Debug mode is disabled. Read more at https://github.com/UnlyEd/github-action-await-vercel#how-to-enable-debug-logs');
+        core.info('Debug mode is disabled. Read more at https://github.com/UnlyEd/github-action-store-variable#how-to-enable-debug-logs');
     }
     try {
         const variables = core.getInput('variables');
         const delimiter = core.getInput('delimiter');
         const failIfNotFound = core.getInput('failIfNotFound') == 'true';
         core.debug(`Received variables: ${variables}`); // debug is only output if you set the secret `ACTIONS_RUNNER_DEBUG` to true https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#how-to-access-step-debug-logs
         core.debug(`Using delimiter: "${delimiter}"`);
+        core.debug(`Using failIfNotFound: "${failIfNotFound}"`);
         yield (0, manageArtifacts_1.default)(variables, delimiter, failIfNotFound);
     }
     catch (error) {

lib/manageArtifacts.js

@@ -46,7 +46,9 @@ const fs_1 = require("fs");
 const core = __importStar(require("@actions/core"));
 const config_1 = require("./config");
 const rimraf_1 = __importDefault(require("rimraf"));
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const artifact = require('@actions/artifact');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const io = require('@actions/io');
 const defineVariableOperation = (variable) => {
     try {
@@ -138,8 +140,17 @@ const manageArtifacts = (variables, delimiter, failIfNotFound) => __awaiter(void
             console.log(error);
         }
     }
-    yield storeArtifact(variablesDetail.filter((variable) => variable.operationToProceed === 0).map((variable) => variable.detail), failIfNotFound);
-    yield retrieveArtifact(variablesDetail.filter((variable) => variable.operationToProceed === 1).map((variable) => variable.detail), failIfNotFound);
-    const variablesResult = variablesDetail.reduce((variablesObject, variableToExport) => (Object.assign(Object.assign({}, variablesObject), { [variableToExport.detail.key]: variableToExport.detail.value })), {});
+    const artifactToStore = variablesDetail
+        .filter((variable) => variable.operationToProceed === 0)
+        .map((variable) => variable.detail);
+    core.debug(`Artifact to store: ${JSON.stringify(artifactToStore)}`);
+    yield storeArtifact(artifactToStore, failIfNotFound);
+    const artifactToRetrieve = variablesDetail
+        .filter((variable) => variable.operationToProceed === 1)
+        .map((variable) => variable.detail);
+    core.debug(`Artifact to retrieve: ${JSON.stringify(artifactToStore)}`);
+    yield retrieveArtifact(artifactToRetrieve, failIfNotFound);
+    const result = variablesDetail.reduce((variablesObject, variableToExport) => (Object.assign(Object.assign({}, variablesObject), { [variableToExport.detail.key]: variableToExport.detail.value })), {});
+    core.debug(`result: ${JSON.stringify(result)}`);
 });
 exports.default = manageArtifacts;

src/main.ts

@@ -1,27 +1,12 @@
 import * as core from '@actions/core';
 import manageArtifacts from './manageArtifacts';
 
-/**
- * Runs configuration checks to make sure everything is properly configured.
- * If anything isn't properly configured, will stop the workflow.
- */
-const runConfigChecks = () => {
-  if (!process.env.VERCEL_TOKEN) {
-    const message =
-      process.env.NODE_ENV === 'test'
-        ? `VERCEL_TOKEN environment variable is not defined. Please define it in the ".env.test" file. See https://vercel.com/account/tokens`
-        : `VERCEL_TOKEN environment variable is not defined. Please create a GitHub "VERCEL_TOKEN" secret. See https://vercel.com/account/tokens`;
-    core.setFailed(message);
-    throw new Error(message);
-  }
-};
-
 /**
  * Runs the GitHub Action.
  */
 const run = async (): Promise<void> => {
   if (!core.isDebug()) {
-    core.info('Debug mode is disabled. Read more at https://github.com/UnlyEd/github-action-await-vercel#how-to-enable-debug-logs');
+    core.info('Debug mode is disabled. Read more at https://github.com/UnlyEd/github-action-store-variable#how-to-enable-debug-logs');
   }
 
   try {
@@ -30,6 +15,8 @@ const run = async (): Promise<void> => {
     const failIfNotFound: boolean = core.getInput('failIfNotFound') == 'true';
     core.debug(`Received variables: ${variables}`); // debug is only output if you set the secret `ACTIONS_RUNNER_DEBUG` to true https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#how-to-access-step-debug-logs
     core.debug(`Using delimiter: "${delimiter}"`);
+    core.debug(`Using failIfNotFound: "${failIfNotFound}"`);
+
     await manageArtifacts(variables, delimiter, failIfNotFound);
   } catch (error) {
     core.setFailed(error.message);

src/manageArtifacts.ts

@@ -13,7 +13,9 @@ import rimraf from 'rimraf';
 import { ArtifactClient, UploadOptions } from '@actions/artifact';
 import { UploadResponse } from '@actions/artifact/lib/internal/upload-response';
 
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const artifact = require('@actions/artifact');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const io = require('@actions/io');
 
 const defineVariableOperation = (variable: string): VariableStatus => {
@@ -64,7 +66,7 @@ const storeArtifact = async (variables: VariableDetail[], failIfNotFound: boolea
       core.debug(`Imported ${variable.key}=${variable.value} and exported it back as ENV var`);
     }
   } catch (error) {
-    const message: string = `Error while uploading artifact: ${error?.message}`;
+    const message = `Error while uploading artifact: ${error?.message}`;
     if (failIfNotFound) {
       core.setFailed(message);
     } else {
@@ -86,7 +88,7 @@ const retrieveArtifact = async (variables: VariableDetail[], failIfNotFound: boo
       core.exportVariable(variable.key, variable.value);
       core.debug(`Exported ${variable.key}=${variable.value} as ENV var`);
     } catch (error) {
-      const message: string = `Cannot retrieve variable ${variable.key}`;
+      const message = `Cannot retrieve variable ${variable.key}`;
       if (failIfNotFound) {
         core.setFailed(message);
       } else {
@@ -106,22 +108,27 @@ const manageArtifacts = async (variables: string, delimiter: string, failIfNotFo
       console.log(error);
     }
   }
-  await storeArtifact(
-    variablesDetail.filter((variable: VariableStatus) => variable.operationToProceed === 0).map((variable: VariableStatus) => variable.detail),
-    failIfNotFound,
-  );
-  await retrieveArtifact(
-    variablesDetail.filter((variable: VariableStatus) => variable.operationToProceed === 1).map((variable: VariableStatus) => variable.detail),
-    failIfNotFound,
-  );
 
-  const variablesResult = variablesDetail.reduce(
+  const artifactToStore = variablesDetail
+    .filter((variable: VariableStatus) => variable.operationToProceed === 0)
+    .map((variable: VariableStatus) => variable.detail);
+  core.debug(`Artifact to store: ${JSON.stringify(artifactToStore)}`);
+  await storeArtifact(artifactToStore, failIfNotFound);
+
+  const artifactToRetrieve = variablesDetail
+    .filter((variable: VariableStatus) => variable.operationToProceed === 1)
+    .map((variable: VariableStatus) => variable.detail);
+  core.debug(`Artifact to retrieve: ${JSON.stringify(artifactToStore)}`);
+  await retrieveArtifact(artifactToRetrieve, failIfNotFound);
+
+  const result = variablesDetail.reduce(
     (variablesObject, variableToExport) => ({
       ...variablesObject,
       [variableToExport.detail.key]: variableToExport.detail.value,
     }),
     {},
   );
+  core.debug(`result: ${JSON.stringify(result)}`);
 };
 
 export default manageArtifacts;