Merge pull request #1 from codiga/chore/workflow-test

feat: tests and workflows

Author: dastrong-codiga

.github/.workflows/main.yml .github/workflows/main.yml.github/.workflows/main.yml renamed to .github/workflows/main.yml

@@ -14,7 +14,6 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
-      - name: Install modules
-        run: npm install
-      - name: Run tests
-        run: npm run test
+      - run: npm install
+      - run: npm link
+      - run: npm run test

.github/.workflows/release.yml .github/workflows/release.yml.github/.workflows/release.yml renamed to .github/workflows/release.yml

@@ -12,11 +12,9 @@ jobs:
         with:
           node-version: '16.x'
           registry-url: 'https://registry.npmjs.org'
-      - name: Install modules
-        run: npm install
-      - name: Run tests
-        run: npm run test
-      - name: Publish the package
-        run: npm publish
+      - run: npm install
+      - run: npm link
+      - run: npm run test
+      - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

src/checkPush.js

@@ -19,6 +19,7 @@ import {
   printViolation,
 } from "../utils/print";
 import { BLANK_SHA } from "../utils/constants";
+import { isTestMode } from "../tests/test-utils";
 
 /**
  * Gets the changed file paths between two SHAs
@@ -43,7 +44,7 @@ function getChangedFilePaths(remoteSHA, localSHA) {
  * @param {string} localShaArg
  * @returns {{ remoteSha: string, localSha: string }} updated SHAs strings
  */
-function checkSHAs(remoteShaArg, localShaArg) {
+export function checkSHAs(remoteShaArg, localShaArg) {
   let remoteSha = remoteShaArg;
   let localSha = localShaArg;
 
@@ -69,6 +70,13 @@ function checkSHAs(remoteShaArg, localShaArg) {
     process.exit(0);
   }
 
+  if (isTestMode) {
+    return {
+      remoteSha: remoteShaArg,
+      localSha: localShaArg,
+    };
+  }
+
   return {
     remoteSha,
     localSha,

tests/check-push.test.js

@@ -0,0 +1,42 @@
+import { ACTION_GIT_PUSH_HOOK, BLANK_SHA } from "../utils/constants";
+import { setToken } from "../utils/store";
+import { executeCommand, SAMPLE_TOKEN } from "./test-utils";
+
+describe("codiga git-push-hook", () => {
+  test("check for same SHAs", async () => {
+    // run the command
+    await executeCommand([ACTION_GIT_PUSH_HOOK, "1234", "1234"]).then(
+      (output) => {
+        expect(output).toMatch(/Remote and local SHA are the same/);
+      }
+    );
+  });
+
+  test("check for closest SHA", async () => {
+    // run the command
+    await executeCommand([
+      ACTION_GIT_PUSH_HOOK,
+      "--remote-sha",
+      BLANK_SHA,
+      "--local-sha",
+      "5678",
+    ]).then((output) => {
+      expect(output).toMatch(
+        /Tried to find closest SHA but did not find any; exiting with code 0/
+      );
+    });
+  });
+
+  test("unable to fetch rulesets when no API token is set", async () => {
+    // run the command
+    await executeCommand([
+      ACTION_GIT_PUSH_HOOK,
+      "--remote-sha",
+      "1234",
+      "--local-sha",
+      "5678",
+    ]).catch(({ stdout }) => {
+      expect(stdout).toMatch(/We were unable to fetch your rulesets/);
+    });
+  });
+});

tests/fixtures/codiga.yml

@@ -0,0 +1,3 @@
+rulesets:
+  - react-best-practices
+  - jsx-a11y

tests/test-utils.js

@@ -12,6 +12,19 @@ export const TEST_USER = {
   accountType: "Github",
 };
 
+export const CODIGA_CONFIG_MISSING_RULESETS = `
+`;
+
+export const CODIGA_CONFIG_MISSING_RULESETS_LIST = `
+rulesets:
+`;
+
+export const CODIGA_CONFIG_MISSING_RULESETS_VALID = `
+rulesets:
+  - react-best-practices
+  - jsx-a11y
+`;
+
 export const executeCommand = async (args) => {
   try {
     return child_process.execSync(`codiga ${args.join(" ")}`, {

tests/token.test.js

@@ -10,16 +10,29 @@ import { executeCommand, deleteFile, SAMPLE_TOKEN } from "./test-utils";
 jest.mock("inquirer");
 const { prompt, expectPrompts } = require("inquirer");
 
-beforeEach(async () => {
-  // delete our testing config file before starting
-  deleteFile(store.path);
-});
+function setup() {
+  beforeEach(() => {
+    // delete our testing config file before starting
+    deleteFile(store.path);
+    // suppress logs
+    global.console = {
+      log: jest.fn(),
+    };
+  });
+  afterEach(() => {
+    global.console = {
+      log: console.log,
+    };
+  });
+}
 
 test("ensure we're using a temp store folder", () => {
-  expect(store.path).toMatch(/@codiga\/cli-testing/);
+  expect(store.path).toMatch(/cli-testing/);
 });
 
 describe("codiga token-add", () => {
+  setup();
+
   test("first notice shows", async () => {
     // run the command
     await executeCommand([ACTION_TOKEN_ADD]).catch(({ stdout }) => {
@@ -101,6 +114,8 @@ describe("codiga token-add", () => {
 });
 
 describe("codiga token-check", () => {
+  setup();
+
   test("no token", async () => {
     // run the command
     await executeCommand([ACTION_TOKEN_CHECK]).catch(({ stdout }) => {
@@ -130,6 +145,8 @@ describe("codiga token-check", () => {
 });
 
 describe("codiga token-delete", () => {
+  setup();
+
   test("no token found", async () => {
     // run the command
     await executeCommand([ACTION_TOKEN_DELETE]).catch(({ stdout }) => {

tests/yaml.test.js

@@ -0,0 +1,22 @@
+import { parseYamlFile } from "../utils/file";
+import {
+  CODIGA_CONFIG_MISSING_RULESETS,
+  CODIGA_CONFIG_MISSING_RULESETS_LIST,
+  CODIGA_CONFIG_MISSING_RULESETS_VALID,
+} from "./test-utils";
+
+test("parse missing `rulesets:` correctly", async () => {
+  expect(parseYamlFile(CODIGA_CONFIG_MISSING_RULESETS)).toBe(null);
+});
+
+test("parse missing rulesets list correctly", async () => {
+  expect(parseYamlFile(CODIGA_CONFIG_MISSING_RULESETS_LIST)).toEqual({
+    rulesets: null,
+  });
+});
+
+test("parse a valid file accurately", async () => {
+  expect(parseYamlFile(CODIGA_CONFIG_MISSING_RULESETS_VALID)).toEqual({
+    rulesets: ["react-best-practices", "jsx-a11y"],
+  });
+});

utils/git.js

@@ -1,5 +1,6 @@
 import child_process from "child_process";
 import { printFailure } from "./print";
+import { isTestMode } from "../tests/test-utils";
 
 /**
  * Executes a git command with the given args in that order
@@ -22,6 +23,10 @@ export function executeGitCommand(args) {
  * @returns the directory string or exits if there isn't one
  */
 export function getRootDirectory() {
+  // if we're in test mode we'll skip this check
+  if (isTestMode) return "./tests/fixtures";
+
+  // now look for a git repository
   const rootDirectory = executeGitCommand(["rev-parse", "--show-toplevel"]);
   if (rootDirectory) {
     return rootDirectory.split("\n").join("");
@@ -74,6 +79,7 @@ export function getMainBranch() {
 }
 
 export function findClosestSha() {
+  if (isTestMode) return null;
   const currentBranch = getCurrentBranch();
   const mainBranch = getMainBranch();
   let closestSha = null;

utils/rulesets.js

@@ -59,7 +59,7 @@ export function getRulesetsFromCodigaFile() {
   // if there aren't any ruleset items under `rulesets:` in the codiga.yml file, throw an error
   if (!parsedFile.rulesets) {
     printFailure(
-      "We can't look for violations is there are no rulesets listed in your `codiga.yml` file"
+      "We can't look for violations if there are no rulesets listed in your `codiga.yml` file"
     );
     printSuggestion(
       " ↳ Ensure you have rulesets listed in: ",