feat: tests for modules

package.json

@@ -30,7 +30,7 @@
     "@octokit/rest": "20.1.0",
     "@sinclair/typebox": "0.32.20",
     "@supabase/supabase-js": "2.42.0",
-    "@ubiquibot/permit-generation": "1.2.1",
+    "@ubiquibot/permit-generation": "1.2.2",
     "commander": "12.0.0",
     "decimal.js": "10.4.3",
     "dotenv": "16.4.5",
@@ -50,6 +50,7 @@
     "@cspell/dict-node": "4.0.3",
     "@cspell/dict-software-terms": "3.3.18",
     "@cspell/dict-typescript": "3.1.2",
+    "@mswjs/data": "0.16.1",
     "@types/jest": "29.5.12",
     "@types/jsdom": "21.1.6",
     "@types/markdown-it": "13.0.7",

src/parser/command-line.ts

@@ -12,7 +12,7 @@ if (process.env.NODE_ENV === "test") {
   process.argv.push("-n");
   process.argv.push("100");
   process.argv.push("-e");
-  process.argv.push("privateKey");
+  process.argv.push(`${process.env.EVM_PRIVATE_ENCRYPTED}`);
 }
 
 const program = new Command()

src/parser/permit-generation-module.ts

@@ -50,18 +50,14 @@ export class PermitGenerationModule implements Module {
     const eventName = context.eventName as SupportedEvents;
     const octokit = getOctokitInstance();
     const logger = {
-      debug(message: unknown, optionalParams: unknown) {
-        console.log(message, optionalParams);
-      },
+      debug() {},
       error(message: unknown, optionalParams: unknown) {
         console.error(message, optionalParams);
       },
       fatal(message: unknown, optionalParams: unknown) {
         console.error(message, optionalParams);
       },
-      info(message: unknown, optionalParams: unknown) {
-        console.log(message, optionalParams);
-      },
+      info() {},
       warn(message: unknown, optionalParams: unknown) {
         console.warn(message, optionalParams);
       },

tests/__mocks__/db-seed.json

@@ -0,0 +1,123 @@
+{
+  "users": [
+    {
+      "login": "molecula451",
+      "id": 41552663,
+      "node_id": "MDQ6VXNlcjQxNTUyNjYz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/41552663?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/molecula451",
+      "html_url": "https://github.com/molecula451",
+      "followers_url": "https://api.github.com/users/molecula451/followers",
+      "following_url": "https://api.github.com/users/molecula451/following{/other_user}",
+      "gists_url": "https://api.github.com/users/molecula451/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/molecula451/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/molecula451/subscriptions",
+      "organizations_url": "https://api.github.com/users/molecula451/orgs",
+      "repos_url": "https://api.github.com/users/molecula451/repos",
+      "events_url": "https://api.github.com/users/molecula451/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/molecula451/received_events",
+      "type": "User",
+      "site_admin": false,
+      "name": "Paul",
+      "company": null,
+      "blog": "https://molecula451.github.io/molecula451dev/",
+      "location": "Night City",
+      "email": null,
+      "hireable": true,
+      "bio": "Wizard of the Electronic Age",
+      "twitter_username": null,
+      "public_repos": 188,
+      "public_gists": 1,
+      "followers": 29,
+      "following": 18,
+      "created_at": "2018-07-22T20:57:16Z",
+      "updated_at": "2024-04-05T03:53:30Z"
+    },
+    {
+      "login": "0x4007",
+      "id": 4975670,
+      "node_id": "MDQ6VXNlcjQ5NzU2NzA=",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4975670?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/0x4007",
+      "html_url": "https://github.com/0x4007",
+      "followers_url": "https://api.github.com/users/0x4007/followers",
+      "following_url": "https://api.github.com/users/0x4007/following{/other_user}",
+      "gists_url": "https://api.github.com/users/0x4007/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/0x4007/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/0x4007/subscriptions",
+      "organizations_url": "https://api.github.com/users/0x4007/orgs",
+      "repos_url": "https://api.github.com/users/0x4007/repos",
+      "events_url": "https://api.github.com/users/0x4007/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/0x4007/received_events",
+      "type": "User",
+      "site_admin": false,
+      "name": "アレクサンダー.eth",
+      "company": "@ubiquity",
+      "blog": "",
+      "location": "Mainnet",
+      "email": null,
+      "hireable": null,
+      "bio": "Philomath. \r\nDigital media and technology pioneer.",
+      "twitter_username": "0x4007",
+      "public_repos": 53,
+      "public_gists": 14,
+      "followers": 60,
+      "following": 108,
+      "created_at": "2013-07-09T18:20:01Z",
+      "updated_at": "2024-04-20T14:30:52Z"
+    },
+    {
+      "login": "gitcoindev",
+      "id": 88761781,
+      "node_id": "MDQ6VXNlcjg4NzYxNzgx",
+      "avatar_url": "https://avatars.githubusercontent.com/u/88761781?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/gitcoindev",
+      "html_url": "https://github.com/gitcoindev",
+      "followers_url": "https://api.github.com/users/gitcoindev/followers",
+      "following_url": "https://api.github.com/users/gitcoindev/following{/other_user}",
+      "gists_url": "https://api.github.com/users/gitcoindev/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/gitcoindev/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/gitcoindev/subscriptions",
+      "organizations_url": "https://api.github.com/users/gitcoindev/orgs",
+      "repos_url": "https://api.github.com/users/gitcoindev/repos",
+      "events_url": "https://api.github.com/users/gitcoindev/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/gitcoindev/received_events",
+      "type": "User",
+      "site_admin": false,
+      "name": "korrrba",
+      "company": null,
+      "blog": "",
+      "location": "Web3 / Europe",
+      "email": null,
+      "hireable": null,
+      "bio": null,
+      "twitter_username": null,
+      "public_repos": 44,
+      "public_gists": 0,
+      "followers": 3,
+      "following": 5,
+      "created_at": "2021-08-11T05:22:33Z",
+      "updated_at": "2024-02-05T14:11:36Z"
+    }
+  ],
+  "wallets": [
+    {
+      "id": 1,
+      "userId": 41552663,
+      "address": "0x4D0704f400D57Ba93eEa88765C3FcDBD826dCFc4"
+    },
+    {
+      "id": 2,
+      "userId": 4975670,
+      "address": "0x4D0704f400D57Ba93eEa88765C3FcDBD826dCFc4"
+    },
+    {
+      "id": 3,
+      "userId": 88761781,
+      "address": "0x4D0704f400D57Ba93eEa88765C3FcDBD826dCFc4"
+    }
+  ]
+}

tests/__mocks__/db.ts

@@ -0,0 +1,17 @@
+// cSpell:disable
+import { factory, primaryKey } from "@mswjs/data";
+
+/**
+ * Creates an object that can be used as a db to persist data within tests
+ */
+export const db = factory({
+  users: {
+    id: primaryKey(Number),
+    login: String,
+  },
+  wallets: {
+    id: primaryKey(Number),
+    userId: Number,
+    address: String,
+  },
+});

tests/__mocks__/handlers.ts

@@ -6,6 +6,7 @@ import issueTimelineGet from "./routes/issue-timeline-get.json";
 import pullsGet from "./routes/pulls-get.json";
 import pullsReviewsGet from "./routes/pulls-reviews-get.json";
 import pullsCommentsGet from "./routes/pulls-comments-get.json";
+import { db } from "./db";
 
 /**
  * Intercepts the routes and returns a custom payload
@@ -32,4 +33,17 @@ export const handlers = [
   http.get("https://api.github.com/repos/ubiquibot/comment-incentives/pulls/25/comments", () => {
     return HttpResponse.json(pullsCommentsGet);
   }),
+  http.get("https://api.github.com/users/:login", ({ params: { login } }) => {
+    const user = db.users.findFirst({
+      where: {
+        login: {
+          equals: login.toString(),
+        },
+      },
+    });
+    if (!user) {
+      return HttpResponse.json("User was not found", { status: 404 });
+    }
+    return HttpResponse.json(user);
+  }),
 ];