test: add tests

Author: ReenigneArcher

.github/workflows/ci-tests.yml

@@ -0,0 +1,96 @@
+---
+name: CI Tests
+permissions: {}
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    permissions:
+      contents: write  # write is required for release_setup
+    runs-on: ${{ matrix.runner }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+
+      - name: Set up Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
+        with:
+          python-version: '3.12'
+
+      - name: Set up Node
+        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238  # v6.2.0
+        with:
+          node-version: latest
+
+      - name: Install Python Dependencies
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          python -m pip install -e .[dev]
+
+      - name: Install Node Dependencies
+        shell: bash
+        run: npm install --ignore-scripts
+
+      - name: Test with pytest
+        id: pytest
+        shell: bash
+        run: python -m pytest
+
+      - name: Test with Jest
+        id: jest
+        if: always()
+        env:
+          FORCE_COLOR: true
+        shell: bash
+        run: npm test
+
+      - name: Upload coverage
+        # any except canceled or skipped
+        if: >-
+          always() &&
+          (
+            steps.pytest.outcome == 'success' ||
+            steps.pytest.outcome == 'failure' ||
+            steps.jest.outcome == 'success' ||
+            steps.jest.outcome == 'failure'
+          ) &&
+          startsWith(github.repository, 'LizardByte/')
+        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de  # v5.5.2
+        with:
+          fail_ci_if_error: true
+          files: ./coverage/python-coverage.xml,./coverage/coverage-final.json
+          flags: ${{ runner.os }}
+          report_type: coverage
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true
+
+      - name: Upload test results
+        # any except canceled or skipped
+        if: >-
+          always() &&
+          (
+            steps.pytest.outcome == 'success' ||
+            steps.pytest.outcome == 'failure' ||
+            steps.jest.outcome == 'success' ||
+            steps.jest.outcome == 'failure'
+          ) &&
+          startsWith(github.repository, 'LizardByte/')
+        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de  # v5.5.2
+        with:
+          fail_ci_if_error: true
+          files: ./junit-python.xml,./junit.xml
+          flags: ${{ runner.os }}
+          report_type: test_results
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true

.github/workflows/update-db.yml

@@ -39,14 +39,14 @@ jobs:
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r requirements.txt
+          python -m pip install -e .
 
       - name: Update
         env:
           TWITCH_CLIENT_ID: ${{ secrets.TWITCH_CLIENT_ID }}
           TWITCH_CLIENT_SECRET: ${{ secrets.TWITCH_CLIENT_SECRET }}
           YOUTUBE_API_KEY: ${{ secrets.YOUTUBE_API_KEY }}
-        run: python -u src/update_db.py ${{ github.event_name == 'pull_request' && '-t' || '' }}
+        run: python -u update-db ${{ github.event_name == 'pull_request' && '-t' || '' }}
 
       - name: Prepare Artifacts  # uploading artifacts will fail if not zipped due to very large quantity of files
         shell: bash

.gitignore

@@ -159,6 +159,18 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
+# Node.js
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+package-lock.json
+
+# Jest
+.jest-cache/
+coverage/
+junit*.xml
+
 # Project specific
 gh-pages/
 cache/

README.md

@@ -5,11 +5,3 @@
 This repository clones IGDB to gh-pages to be consumed by LizardByte projects, such as LizardByte/Sunshine.
 
 Information from YouTube API is also added to the database for videos.
-
-## Plans
-
-- [x] Build with Jekyll
-  - [ ] Revamp index page
-  - [x] Provide an item page for each API item
-- [ ] Add unit tests
-- [ ] Add code coverage

babel.config.js

@@ -0,0 +1,2 @@
+// this allows jest to use ES6 module imports
+module.exports = {presets: ['@babel/preset-env']}

codecov.yml

@@ -0,0 +1,15 @@
+---
+codecov:
+  branch: master
+
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 10%
+
+comment:
+  layout: "header, reach, diff, flags, files, footer"
+  behavior: default
+  require_changes: false

eslint.config.mjs

@@ -0,0 +1,32 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+
+export default [
+    pluginJs.configs.recommended,
+    {
+        ignores: [
+            "coverage/**",
+            "node_modules/**",
+            "gh-pages/**",
+        ],
+    },
+    {
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.node,
+                ...globals.jquery,
+                // cross-file globals injected by item_detail.js into the browser scope
+                "base_url": "readonly",
+                "base_path": "readonly",
+                "igdbImageUrl": "readonly",
+                "makeBadge": "readonly",
+                "addDlRow": "readonly",
+                "loadItemDetail": "readonly",
+                "renderGameList": "readonly",
+                "splitString": "readonly",
+                "require": "readonly",
+            },
+        },
+    },
+];

gh-pages-template/assets/js/character_detail.js

@@ -44,3 +44,10 @@ function renderCharacter(data) {
 document.addEventListener("DOMContentLoaded", () => {
     loadItemDetail("characters", renderCharacter);
 });
+
+/* istanbul ignore next */
+if (typeof module !== "undefined") {
+    module.exports = {
+        renderCharacter,
+    };
+}

gh-pages-template/assets/js/collection_detail.js

@@ -26,3 +26,10 @@ function renderCollection(data) {
 document.addEventListener("DOMContentLoaded", () => {
     loadItemDetail("collections", renderCollection);
 });
+
+/* istanbul ignore next */
+if (typeof module !== "undefined") {
+    module.exports = {
+        renderCollection,
+    };
+}

gh-pages-template/assets/js/franchise_detail.js

@@ -26,3 +26,10 @@ function renderFranchise(data) {
 document.addEventListener("DOMContentLoaded", () => {
     loadItemDetail("franchises", renderFranchise);
 });
+
+/* istanbul ignore next */
+if (typeof module !== "undefined") {
+    module.exports = {
+        renderFranchise,
+    };
+}