tests, default avatar

.drone.yml

@@ -3,8 +3,13 @@ type: docker
 name: compliance
 
 steps:
-- name: deps
+- name: lint
   image: node
   commands:
   - yarn install
-  - yarn lint
+  - yarn lint
+- name: test
+  image: node
+  commands:
+  - yarn install
+  - yarn test

.eslintrc.json

@@ -1,7 +1,9 @@
 {
+    "plugins": ["jest"],
     "env": {
         "es6": true,
-        "node": true
+        "node": true,
+        "jest/globals": true
     },
     "extends": "eslint:recommended",
     "globals": {

.gitignore

@@ -2,5 +2,9 @@ node_modules
 logs
 .env
 
-# Files is a symlink to the build directory of the frontend
-files
+coverage
+
+# files/build is a symlink to the build directory of the frontend
+files/build
+files/avatars/*
+!files/avatars/default.png

README.md

@@ -30,7 +30,12 @@ Any all endpoints should go in the `/endpoints` directory and are expected to in
 Endpoints have a loadOrder property that can be adjusted, lower values are loaded first.  
 
 **Serving files**
-By default the framework looks for files to serve under the `/files` directory, it also tries to satisfy requests to `/` with an `index.html` from `/files/site`. This is with the frontend in mind.  
+By default the framework looks for files to serve under the `/files` directory, it also tries to satisfy requests to `/` with an `index.html` from `/files/build`. This is with the frontend in mind.  
+
+To easily serve a frontend I typically use a symbolic link between the built frontend files and the `files/build` directory.  
+E.g.  
+Linux: `ln -s /path/to/frontend/build /path/to/backend/files/build`  
+Windows (admin cmd) `mklink /D C:\Path\To\Backend\files\build C:\Path\To\Frontend\build`  
 
 ## TODO  
 - Dependency injection for structures, such as User.

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+    presets: [[ '@babel/preset-env', { targets: { node: 'current' } }]]
+};

jest.config.js

@@ -0,0 +1,195 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+    // All imported modules in your tests should be mocked automatically
+    // automock: false,
+
+    // Stop running tests after `n` failures
+    // bail: 0,
+
+    // The directory where Jest should store its cached dependency information
+    // cacheDirectory: "C:\\Users\\<User>\\AppData\\Local\\Temp\\jest",
+
+    // Automatically clear mock calls, instances, contexts and results before every test
+    clearMocks: true,
+
+    // Indicates whether the coverage information should be collected while executing the test
+    collectCoverage: true,
+
+    // An array of glob patterns indicating a set of files for which coverage information should be collected
+    // collectCoverageFrom: undefined,
+
+    // The directory where Jest should output its coverage files
+    coverageDirectory: "coverage",
+
+    // An array of regexp pattern strings used to skip coverage collection
+    // coveragePathIgnorePatterns: [
+    //   "\\\\node_modules\\\\"
+    // ],
+
+    // Indicates which provider should be used to instrument code for coverage
+    // coverageProvider: "babel",
+
+    // A list of reporter names that Jest uses when writing coverage reports
+    // coverageReporters: [
+    //   "json",
+    //   "text",
+    //   "lcov",
+    //   "clover"
+    // ],
+
+    // An object that configures minimum threshold enforcement for coverage results
+    // coverageThreshold: undefined,
+
+    // A path to a custom dependency extractor
+    // dependencyExtractor: undefined,
+
+    // Make calling deprecated APIs throw helpful error messages
+    // errorOnDeprecated: false,
+
+    // The default configuration for fake timers
+    // fakeTimers: {
+    //   "enableGlobally": false
+    // },
+
+    // Force coverage collection from ignored files using an array of glob patterns
+    // forceCoverageMatch: [],
+
+    // A path to a module which exports an async function that is triggered once before all test suites
+    // globalSetup: undefined,
+
+    // A path to a module which exports an async function that is triggered once after all test suites
+    // globalTeardown: undefined,
+
+    // A set of global variables that need to be available in all test environments
+    // globals: {},
+
+    // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+    // maxWorkers: "50%",
+
+    // An array of directory names to be searched recursively up from the requiring module's location
+    // moduleDirectories: [
+    //   "node_modules"
+    // ],
+
+    // An array of file extensions your modules use
+    // moduleFileExtensions: [
+    //   "js",
+    //   "mjs",
+    //   "cjs",
+    //   "jsx",
+    //   "ts",
+    //   "tsx",
+    //   "json",
+    //   "node"
+    // ],
+
+    // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+    // moduleNameMapper: {},
+
+    // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+    // modulePathIgnorePatterns: [],
+
+    // Activates notifications for test results
+    // notify: false,
+
+    // An enum that specifies notification mode. Requires { notify: true }
+    // notifyMode: "failure-change",
+
+    // A preset that is used as a base for Jest's configuration
+    // preset: undefined,
+
+    // Run tests from one or more projects
+    // projects: undefined,
+
+    // Use this configuration option to add custom reporters to Jest
+    // reporters: undefined,
+
+    // Automatically reset mock state before every test
+    // resetMocks: false,
+
+    // Reset the module registry before running each individual test
+    // resetModules: false,
+
+    // A path to a custom resolver
+    // resolver: undefined,
+
+    // Automatically restore mock state and implementation before every test
+    // restoreMocks: false,
+
+    // The root directory that Jest should scan for tests and modules within
+    // rootDir: undefined,
+
+    // A list of paths to directories that Jest should use to search for files in
+    // roots: [
+    //   "<rootDir>"
+    // ],
+
+    // Allows you to use a custom runner instead of Jest's default test runner
+    // runner: "jest-runner",
+
+    // The paths to modules that run some code to configure or set up the testing environment before each test
+    // setupFiles: [],
+
+    // A list of paths to modules that run some code to configure or set up the testing framework before each test
+    // setupFilesAfterEnv: [],
+
+    // The number of seconds after which a test is considered as slow and reported as such in the results.
+    // slowTestThreshold: 5,
+
+    // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+    // snapshotSerializers: [],
+
+    // The test environment that will be used for testing
+    // testEnvironment: "jest-environment-node",
+
+    // Options that will be passed to the testEnvironment
+    // testEnvironmentOptions: {},
+
+    // Adds a location field to test results
+    // testLocationInResults: false,
+
+    // The glob patterns Jest uses to detect test files
+    // testMatch: [
+    //   "**/__tests__/**/*.[jt]s?(x)",
+    //   "**/?(*.)+(spec|test).[tj]s?(x)"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+    // testPathIgnorePatterns: [
+    //   "\\\\node_modules\\\\"
+    // ],
+
+    // The regexp pattern or array of patterns that Jest uses to detect test files
+    // testRegex: [],
+
+    // This option allows the use of a custom results processor
+    // testResultsProcessor: undefined,
+
+    // This option allows use of a custom test runner
+    // testRunner: "jest-circus/runner",
+
+    // A map from regular expressions to paths to transformers
+    // transform: undefined,
+
+    // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+    // transformIgnorePatterns: [
+    //   "\\\\node_modules\\\\",
+    //   "\\.pnp\\.[^\\\\]+$"
+    // ],
+
+    // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+    // unmockedModulePathPatterns: undefined,
+
+    // Indicates whether each individual test should be reported during the run
+    // verbose: undefined,
+
+    // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+    // watchPathIgnorePatterns: [],
+
+    // Whether to use watchman for file crawling
+    // watchman: true,
+};

package.json

@@ -30,12 +30,18 @@
     "qrcode": "^1.5.1"
   },
   "devDependencies": {
+    "@babel/core": "^7.20.12",
+    "@babel/preset-env": "^7.20.2",
+    "babel-jest": "^29.4.2",
     "eslint": "^8.26.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "jest": "^29.4.2",
     "nodemon": "^2.0.20"
   },
   "scripts": {
     "start": "node index.js",
-    "lint": "eslint src/ --fix"
+    "lint": "eslint src/ --fix",
+    "test": "jest"
   },
   "engines": {
     "node": ">=18.0.0"

src/server/endpoints/api/test.js

@@ -1,22 +0,0 @@
-const { ApiEndpoint } = require('../../interfaces');
-
-class TestEndpoint extends ApiEndpoint {
-
-    constructor (server) {
-        super(server, {
-            name: 'test',
-            path: '/test'
-        });
-
-        this.methods = [
-            [ 'get', this.get.bind(this) ]
-        ];
-    }
-
-    get (req, res) {
-        return res.redirect('/users');
-    }
-
-}
-
-module.exports = TestEndpoint;

test/PermissionManager.test.js

@@ -1,17 +0,0 @@
-/* eslint-disable no-console */
-const { PermissionManager } = require('../src/util');
-const { inspect } = require('node:util');
-
-const log = (obj) => {
-    console.log(inspect(obj, { depth: 10 }));
-};
-// PermissionManager.ensurePermission('administrator');
-PermissionManager.ensurePermission('administrator:removeuser:force:bruh:moment:broo');
-PermissionManager.ensurePermission('developer:toggledebug');
-PermissionManager.ensurePermission('developer');
-
-// log(PermissionManager);
-
-const perms = { developer: { default: 10 }, administrator: 10 };
-log(PermissionManager.merge(perms, PermissionManager.DefaultPermissions));
-// log(perms);

tests/PermissionManager.test.js

@@ -0,0 +1,46 @@
+const { PermissionManager } = require('../src/util');
+let perms = null; 
+
+beforeEach(() => {
+    perms = { developer: { default: 5 }, administrator: 10 };
+});
+
+test('Constructor', () => {
+    expect(() => new PermissionManager()).toThrow();
+});
+
+test('Ensure permission', () => {
+
+    expect(() => PermissionManager.ensurePermission()).toThrow();
+
+    expect(PermissionManager.DefaultPermissions).toEqual({});
+
+    PermissionManager.ensurePermission('administrator:removeuser:force:bruh:moment:broo');
+    PermissionManager.ensurePermission('developer:toggledebug');
+    PermissionManager.ensurePermission('developer');
+
+    expect(PermissionManager.DefaultPermissions).toHaveProperty('administrator.removeuser.force');
+    expect(PermissionManager.DefaultPermissions).toHaveProperty('developer.toggledebug');
+    expect(PermissionManager.DefaultPermissions).not.toHaveProperty('developer.removeuser.force');
+
+});
+
+test('Test permission merge', () => {
+    
+    expect(perms).toHaveProperty('administrator', 10);
+    PermissionManager.ensurePermission('administrator:removeuser:force');
+    PermissionManager.merge(perms, PermissionManager.DefaultPermissions);
+    expect(perms).toHaveProperty('administrator.removeuser.force');
+    expect(perms).toHaveProperty('administrator.default', 10);
+
+});
+
+test('Check for permission', () => {
+
+    expect(() => PermissionManager.checkPermissions()).toThrow();
+    expect(() => PermissionManager.checkPermissions(perms)).toThrow();
+
+    expect(PermissionManager.checkPermissions(perms, 'administrator', 10)).toBe(true);
+    expect(PermissionManager.checkPermissions(perms, 'developer', 5)).toBe(true);
+    expect(PermissionManager.checkPermissions(perms, 'developer', 10)).toBe(false);
+});