Merge pull request #166 from cainthebest/impl/unit-tests

Author: ghostdevv

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/tests.yml

@@ -3,39 +3,55 @@ name: Tests
 on: [push, pull_request]
 
 jobs:
-  test:
-    strategy:
-      matrix:
-        node-version: [16.x, 18.x]
-        # platform: [ubuntu-latest, windows-latest]
-        platform: [ubuntu-latest]
-
-    name: Test on ${{ matrix.platform }} with NodeJS v${{ matrix.node-version }}
-
-    runs-on: ${{ matrix.platform }}
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Setup PNPM
-        uses: pnpm/[email protected]
-        with:
-          version: 7.0.0
-
-      - name: Install Dependancies
-        run: pnpm i
-
-      - name: Build Packages
-        run: pnpm build
-
-      - name: Run Tests
-        run: pnpm test
-
-      - name: Lint
-        run: pnpm lint
+    test:
+        name: Test on ${{ matrix.platform }} with NodeJS v${{ matrix.node-version }}
+
+        runs-on: ${{ matrix.platform }}
+
+        strategy:
+            matrix:
+                node-version: [16.x, 18.x]
+                platform: [ubuntu-latest, windows-latest]
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v3
+
+            - name: Setup Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v3
+              with:
+                  node-version: ${{ matrix.node-version }}
+
+            - name: Install pnpm
+              uses: pnpm/[email protected]
+              id: pnpm-install
+              with:
+                  version: 7
+                  run_install: false
+
+            - name: Get pnpm store directory
+              id: pnpm-cache
+              shell: bash
+              run: |
+                  echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+            - name: Setup pnpm cache
+              uses: actions/cache@v3
+              with:
+                  path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+                  key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+                  restore-keys: |
+                      ${{ runner.os }}-pnpm-store-
+
+            - name: Install dependencies
+              # No frozen lockfile because windows doesn't like it (Theres a issue for it somewhere in PNPM's repo)
+              run: pnpm install --no-frozen-lockfile
+
+            - name: Build
+              run: pnpm build
+
+            - name: Run Tests
+              run: pnpm test
+
+            - name: Lint
+              run: pnpm lint

package.json

@@ -16,7 +16,7 @@
         "release": "changeset publish",
         "lint": "pnpm -r lint",
         "fix": "pnpm -r fix",
-        "test": "echo \"no tests yet\"",
+        "test": "pnpm -r test",
         "docs:dev": "vitepress dev docs",
         "docs:build": "vitepress build docs",
         "test-create": "node packages/create-jellycommands/src/bin.js"

packages/jellycommands/package.json

@@ -24,6 +24,7 @@
   "scripts": {
     "dev": "tsup-node --watch src",
     "build": "tsup-node",
+    "test": "tsm node_modules/uvu/bin.js tests \".*\\.test\\.ts\"",
     "lint": "run-s lint:*",
     "lint:prettier": "prettier --check --plugin-search-dir=. src",
     "lint:eslint": "eslint src",
@@ -39,8 +40,10 @@
     "nodemon": "^2.0.20",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.8.4",
+    "tsm": "^2.3.0",
     "tsup": "^6.6.3",
-    "typescript": "^4.9.5"
+    "typescript": "^4.9.5",
+    "uvu": "^0.5.6"
   },
   "peerDependencies": {
     "discord.js": "^14.0.0"

packages/jellycommands/tests/common.ts

@@ -0,0 +1,20 @@
+import type { Client } from 'discord.js';
+
+export const rawToken = 'ImAToken';
+export const rawClientId = 'ImAClientId';
+
+export const encodedToken = Buffer.from(rawToken).toString('base64');
+export const encodedClientId = Buffer.from(rawClientId).toString('base64');
+
+export const mockToken = `${encodedClientId}.${encodedToken}`;
+export function mockClient() {
+    return {
+        token: mockToken,
+        user: {
+            id: rawClientId,
+        },
+    } as Client;
+}
+
+export { test } from 'uvu';
+export { strictEqual as equal, deepStrictEqual as deepEqual, throws } from 'assert';

packages/jellycommands/tests/token/cleanToken.test.ts

@@ -0,0 +1,24 @@
+import { cleanToken } from '../../src/utils/token';
+import { test, equal, mockToken } from '../common';
+
+test('Strip Bot prefix', () => {
+    const result = cleanToken(`Bot ${mockToken}`);
+    equal(result, mockToken);
+});
+
+test('Strip Bearer prefix', () => {
+    const result = cleanToken(`Bearer ${mockToken}`);
+    equal(result, mockToken);
+});
+
+test('No prefix', () => {
+    const result = cleanToken(mockToken);
+    equal(result, mockToken);
+});
+
+test('No token', () => {
+    const result = cleanToken();
+    equal(result, null);
+});
+
+test.run();

packages/jellycommands/tests/token/clientIdFromToken.test.ts

@@ -0,0 +1,9 @@
+import { test, equal, mockToken, rawClientId } from '../common';
+import { clientIdFromToken } from '../../src/utils/token';
+
+test('With a valid token', () => {
+    const result = clientIdFromToken(mockToken);
+    equal(result, rawClientId);
+});
+
+test.run();

packages/jellycommands/tests/token/getAuthData.test.ts

@@ -0,0 +1,61 @@
+import { test, deepEqual, throws, mockClient, mockToken, rawClientId } from '../common';
+import { getAuthData, AuthData } from '../../src/utils/token';
+
+test('Get the token from the client', () => {
+    const result = getAuthData(mockClient());
+    const expected: AuthData = {
+        clientId: rawClientId,
+        token: mockToken,
+    };
+
+    deepEqual(result, expected);
+});
+
+test('Get the token from the env', () => {
+    const modifiedMockClient = mockClient();
+
+    modifiedMockClient.token = null;
+
+    process.env.DISCORD_TOKEN = mockToken;
+
+    const result = getAuthData(modifiedMockClient);
+    const expected: AuthData = {
+        clientId: rawClientId,
+        token: mockToken,
+    };
+
+    deepEqual(result, expected);
+
+    // Clean up
+    delete process.env.DISCORD_TOKEN;
+});
+
+test('No env token or no client.token to get the token from', () => {
+    const modifiedMockClient = mockClient();
+
+    modifiedMockClient.token = null;
+
+    throws(
+        () => {
+            getAuthData(modifiedMockClient);
+        },
+        { name: 'Error', message: 'No token found' },
+    );
+});
+
+//! client ID error is out of reach and cant be tested
+//  test('No client.user or token get the client ID from', () => {
+//    const modifiedMockClient = mockClient();
+//
+//    modifiedMockClient.user = null;
+//    modifiedMockClient.token = null;
+//
+//    throws(
+//        () => {
+//            getAuthData(modifiedMockClient);
+//        },
+//        { name: 'Error', message: 'Invalid token provided' },
+//    );
+//  });
+
+test.run();

packages/jellycommands/tests/token/resolveClientId.test.ts

@@ -0,0 +1,28 @@
+import { test, equal, mockClient, rawClientId } from '../common';
+import { resolveClientId } from '../../src/utils/token';
+
+test('Get the ID from the client', () => {
+    const result = resolveClientId(mockClient());
+    equal(result, rawClientId);
+});
+
+test('Get the ID from the token', () => {
+    const modifiedMockClient = mockClient();
+
+    modifiedMockClient.user = null;
+
+    const result = resolveClientId(modifiedMockClient);
+    equal(result, rawClientId);
+});
+
+test('No token or no client.user to get the ID from', () => {
+    const modifiedMockClient = mockClient();
+
+    modifiedMockClient.user = null;
+    modifiedMockClient.token = null;
+
+    const result = resolveClientId(modifiedMockClient);
+    equal(result, null);
+});
+
+test.run();

packages/jellycommands/tests/token/resolveToken.test.ts

@@ -0,0 +1,32 @@
+import { test, equal, mockClient, mockToken } from '../common';
+import { resolveToken } from '../../src/utils/token';
+
+test('Get token from client', () => {
+    const result = resolveToken(mockClient());
+    equal(result, mockToken);
+});
+
+test('Get token from env', () => {
+    const modifiedMockClient = mockClient();
+
+    modifiedMockClient.token = null;
+
+    process.env.DISCORD_TOKEN = mockToken;
+
+    const result = resolveToken(modifiedMockClient);
+    equal(result, mockToken);
+
+    // Clean up
+    delete process.env.DISCORD_TOKEN;
+});
+
+test('No env token or no client.token to get the token from', () => {
+    const modifiedMockClient = mockClient();
+
+    modifiedMockClient.token = null;
+
+    const result = resolveToken(modifiedMockClient);
+    equal(result, null);
+});
+
+test.run();