feat: add token testing

Author: dastrong-codiga

package-lock.json

@@ -15,7 +15,7 @@
     "access": "public"
   },
   "scripts": {
-    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules npx jest"
+    "test": "cross-env NODE_ENV=test NODE_OPTIONS=--experimental-vm-modules npx jest"
   },
   "keywords": [
     "Codiga",
@@ -33,7 +33,7 @@
     "graphql-request": "^5.1.0",
     "inquirer": "8.2.3",
     "listr2": "^5.0.6",
-    "node-fetch": "^3.3.0",
+    "node-fetch": "^2.6.7",
     "yaml": "1.10.2",
     "yargs": "^17.6.2"
   },

package.json

@@ -1,5 +1,6 @@
 import inquirer from "inquirer";
 import { CHECK_USER } from "../graphql/queries";
+import { isTestMode, SAMPLE_TOKEN, TEST_USER } from "../tests/test-utils";
 import { codigaApiFetch } from "../utils/api";
 import { ACTION_TOKEN_ADD } from "../utils/constants";
 import {
@@ -16,7 +17,12 @@ import { setToken, getToken, deleteToken, store } from "../utils/store";
  * @param {string} apiToken the token string to check
  * @returns {Promise<{id: string, accountType: string, username: string}?>} the user if a valid token
  */
-async function getUserInfoFromToken(apiToken) {
+export async function getUserInfoFromToken(apiToken) {
+  // handle test case
+  if (isTestMode && apiToken === SAMPLE_TOKEN) {
+    return TEST_USER;
+  }
+  // complete the real action
   try {
     const resp = await codigaApiFetch(CHECK_USER, null, apiToken);
     if (resp?.user?.id) {
@@ -54,7 +60,7 @@ export async function checkCodigaToken() {
         " ↳ To override it, run one of the following commands:",
         ACTION_TOKEN_ADD
       );
-      process.exit(0);
+      process.exit(1);
     }
   } else {
     printInfo("No token was found.");
@@ -66,6 +72,27 @@ export async function checkCodigaToken() {
   }
 }
 
+/**
+ * Handles the answers given for the token-add command
+ * @param {{apiToken: string}} params
+ */
+export async function handleAnswers({ apiToken }) {
+  const user = await getUserInfoFromToken(apiToken);
+  if (!!user) {
+    setToken(apiToken);
+    printSuccess(
+      `Codiga API token added for ${user.username} (${user.accountType})`
+    );
+    printSuggestion(`Tokens can be found here:`, store.path);
+  } else {
+    printFailure("That token is not valid");
+    printSuggestion(
+      " ↳ Go to Codiga and create a new token:",
+      "https://app.codiga.io/api-tokens"
+    );
+  }
+}
+
 /**
  * Handles asking, verifying, setting and the messaging
  * when the `token-add` command action is run
@@ -75,7 +102,7 @@ export async function addCodigaToken() {
     "Create a Codiga API token:",
     "https://app.codiga.io/api-tokens"
   );
-  inquirer
+  await inquirer
     .prompt([
       {
         type: "input",
@@ -84,26 +111,8 @@ export async function addCodigaToken() {
       },
     ])
     .then(async ({ apiToken }) => {
-      const user = await getUserInfoFromToken(apiToken);
-      if (!!user) {
-        setToken(apiToken);
-        printSuccess(
-          `Codiga API token added for ${user.username} (${user.accountType})`
-        );
-        printSuggestion(`Tokens can be found here:`, store.path);
-        process.exit(0);
-      } else {
-        printFailure("That token is not valid");
-        printSuggestion(
-          " ↳ Go to Codiga and create a new token:",
-          "https://app.codiga.io/api-tokens"
-        );
-        process.exit(1);
-      }
-    })
-    .catch((err) => {
-      printFailure(err.message);
-      process.exit(1);
+      await handleAnswers({ apiToken });
+      process.exit(0);
     });
 }
 

src/codigaToken.js

@@ -0,0 +1,88 @@
+// place this file in __mocks__
+
+let pendingAssertions;
+
+exports.prompt = (prompts) => {
+  if (!pendingAssertions) {
+    throw new Error(
+      `inquirer was mocked and used without pending assertions: ${prompts}`
+    );
+  }
+
+  const answers = {};
+  let skipped = 0;
+  prompts.forEach((prompt, i) => {
+    if (prompt.when && !prompt.when(answers)) {
+      skipped++;
+      return;
+    }
+
+    const setValue = (val) => {
+      if (prompt.validate) {
+        const res = prompt.validate(val);
+        if (res !== true) {
+          throw new Error(`validation failed for prompt: ${prompt}`);
+        }
+      }
+      answers[prompt.name] = prompt.filter ? prompt.filter(val) : val;
+    };
+
+    const a = pendingAssertions[i - skipped];
+
+    if (a.message) {
+      const message =
+        typeof prompt.message === "function"
+          ? prompt.message(answers)
+          : prompt.message;
+      expect(message).toContain(a.message);
+    }
+
+    if (a.choices) {
+      expect(prompt.choices.length).toBe(a.choices.length);
+      a.choices.forEach((c, i) => {
+        const expected = a.choices[i];
+        if (expected) {
+          expect(prompt.choices[i].name).toContain(expected);
+        }
+      });
+    }
+
+    if (a.input != null) {
+      expect(prompt.type).toBe("input");
+      setValue(a.input);
+    }
+
+    if (a.choose != null) {
+      expect(prompt.type).toBe("list");
+      setValue(prompt.choices[a.choose].value);
+    }
+
+    if (a.check != null) {
+      expect(prompt.type).toBe("checkbox");
+      setValue(a.check.map((i) => prompt.choices[i].value));
+    }
+
+    if (a.confirm != null) {
+      expect(prompt.type).toBe("confirm");
+      setValue(a.confirm);
+    }
+
+    if (a.useDefault) {
+      expect("default" in prompt).toBe(true);
+      setValue(
+        typeof prompt.default === "function"
+          ? prompt.default(answers)
+          : prompt.default
+      );
+    }
+  });
+
+  expect(prompts.length).toBe(pendingAssertions.length + skipped);
+  pendingAssertions = null;
+
+  return Promise.resolve(answers);
+};
+
+exports.expectPrompts = (assertions) => {
+  pendingAssertions = assertions;
+};

tests/__mocks__/inquirer.js

@@ -1,14 +1,12 @@
 import { encodeToBase64, decodeFromBase64 } from "../utils/encoding";
 
-describe("Encoding", () => {
-  const decodedCode = "const valid = true;";
-  const encodedCode = "Y29uc3QgdmFsaWQgPSB0cnVlOw==";
+const decodedCode = "const valid = true;";
+const encodedCode = "Y29uc3QgdmFsaWQgPSB0cnVlOw==";
 
-  test("code is encoded in base64", () => {
-    expect(encodeToBase64(decodedCode)).toBe(encodedCode);
-  });
+test("code is encoded in base64", () => {
+  expect(encodeToBase64(decodedCode)).toBe(encodedCode);
+});
 
-  test("code is decoded in base64", () => {
-    expect(decodeFromBase64(encodedCode)).toBe(decodedCode);
-  });
+test("code is decoded in base64", () => {
+  expect(decodeFromBase64(encodedCode)).toBe(decodedCode);
 });