Merge pull request #2 from codiga/feat/more-tests

feat/more tests

Author: dastrong-codiga

.gitignore

@@ -1,2 +1,4 @@
 node_modules
-coverage
+coverage
+.vscode
+codiga-cli*.tgz

.npmignore

@@ -0,0 +1,8 @@
+DEVELOPMENT.md
+tests
+coverage
+babel.config.js
+jest.config.js
+.github
+.vscode
+codiga-cli*.tgz

.vscode/settings.json

@@ -22,9 +22,32 @@
 
 ### Running the tests
 
-```bash
-npm run test
-```
+- Install and symlink the package as described in the Getting Started
+
+  ```bash
+  npm i
+  npm link
+  ```
+
+- Run the test script
+
+  ```bash
+  npm run test
+  ```
+
+> We'll automatically run the tests on `push` and `merge-request` actions. You can see past workflow runs [here](https://github.com/codiga/codiga-cli/actions/workflows/main.yml).
+
+### Release a new version
+
+- Open a MR with your new changes
+  - Bump the version in `package.json` and `package-lock.json` and commit it as well
+- Once that's merged, go to [releases](https://github.com/codiga/codiga-cli/releases) and draft a new release
+  - Choose a tag > Create a new tag > `vX.X.X` (should match your new version above)
+  - Generate release notes
+  - Publish release
+- Verify the following:
+  - The [Release Github Action](https://github.com/codiga/codiga-cli/actions/workflows/release.yml) is successful
+  - The [NPM package](https://www.npmjs.com/package/@codiga/cli) was updated
 
 ### Notes
 

DEVELOPMENT.md

@@ -1,6 +1,6 @@
 {
   "name": "@codiga/cli",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A Codiga CLI used to integrate Codiga easily in your projects",
   "homepage": "https://github.com/codiga/codiga-cli",
   "repository": {

package-lock.json

@@ -145,6 +145,17 @@ export async function checkPush(remoteShaArg, localShaArg) {
   if (violations.length === 0 && errors.length === 0) {
     process.exit(0);
   } else {
+    printEmptyLine();
+    printInfo("Do you consider these violations as false positives?");
+    printSuggestion(
+      " ↳ You can add the following flag to your `git push` to bypass this check:",
+      "--no-verify"
+    );
+    printSuggestion(
+      " ↳ Consider commenting on those rules in the Codiga Hub, so the maintainer can improve them:",
+      "https://app.codiga.io/hub/rulesets"
+    );
+    printEmptyLine();
     process.exit(1);
   }
 }

package.json

@@ -1,6 +1,5 @@
 import { ACTION_GIT_PUSH_HOOK, BLANK_SHA } from "../utils/constants";
-import { setToken } from "../utils/store";
-import { executeCommand, SAMPLE_TOKEN } from "./test-utils";
+import { executeCommand } from "./test-utils";
 
 describe("codiga git-push-hook", () => {
   test("check for same SHAs", async () => {

src/checkPush.js

@@ -0,0 +1,41 @@
+export function getRulesetsWithRulesMock(rulesets) {
+  return mockedRulesets.filter((ruleset) => rulesets.includes(ruleset.name));
+}
+
+export const mockedRulesets = [
+  {
+    id: 1,
+    name: "testing-ruleset-1",
+    rules: [
+      {
+        id: 11,
+        name: "testing-rule-11",
+        content: "ZnVuY3Rpb24gdmlzaXQobm9kZSl7CiAgaWYoIW5vZGUpIHJldHVybiAKfQ==",
+        ruleType: "Ast",
+        language: "Javascript",
+        pattern: null,
+        elementChecked: "HtmlElement",
+      },
+    ],
+  },
+  {
+    id: 2,
+    name: "testing-ruleset-2",
+    rules: [
+      {
+        id: 12,
+        name: "testing-rule-22",
+        content: "ZnVuY3Rpb24gdmlzaXQobm9kZSl7CiAgaWYoIW5vZGUpIHJldHVybiAKfQ==",
+        ruleType: "Ast",
+        language: "Javascript",
+        pattern: null,
+        elementChecked: "Assignment",
+      },
+    ],
+  },
+  {
+    id: 3,
+    name: "testing-ruleset-3",
+    rules: [],
+  },
+];

tests/check-push.test.js

@@ -0,0 +1,46 @@
+import {
+  LANGUAGE_JAVASCRIPT,
+  LANGUAGE_PYTHON,
+  LANGUAGE_TYPESCRIPT,
+} from "../utils/constants";
+import { managePathsBySupportAndLanguage } from "../utils/rosie";
+
+const notSupportedPaths = [
+  "config.json",
+  "README.md",
+  "LICENSE",
+  "index.html",
+  "picture.png",
+];
+
+const pythonPaths = [
+  "index.py3",
+  "/python.py3",
+  "/some-folder/nested/index.py",
+];
+
+const javascriptPaths = [
+  "index.js",
+  "/javascript.jsx",
+  "/some-folder/nested/index.js",
+];
+
+const typescriptPaths = [
+  "index.ts",
+  "/typescript.tsx",
+  "/some-folder/nested/index.ts",
+];
+
+test("path files are split correctly", async () => {
+  const files = managePathsBySupportAndLanguage([
+    ...notSupportedPaths,
+    ...pythonPaths,
+    ...javascriptPaths,
+    ...typescriptPaths,
+  ]);
+
+  expect(files.notSupported.length).toBe(5);
+  expect(files[LANGUAGE_PYTHON].length).toBe(3);
+  expect(files[LANGUAGE_JAVASCRIPT].length).toBe(3);
+  expect(files[LANGUAGE_TYPESCRIPT].length).toBe(3);
+});