Add Jest for JavaScript testing

.gitignore

@@ -13,4 +13,6 @@
 *.log
 *.swp
 __debug_bin
-node_modules
+node_modules
+/frontend/coverage
+/frontend/tests/coverage

README.md

@@ -44,6 +44,9 @@ gochan-migration has been a gargantuan time sink and has wasted a lot of time th
 # Theme development
 See [`sass/README.md`](sass/README.md) for information on working with Sass and stylesheets.
 
+# Javascript development
+See [`frontend/README.md`](frontend/README.md) for information about developing gochan's JavaScript frontend.
+
 # Development
 
 ## Style guide
@@ -61,15 +64,12 @@ All features that are to be realised for the near future are found in the issues
 
 ### Lower priority
 * Improve moderation tools heavily
-* Rework board creation to correctly use new fields.
 * Rework any legacy structs that uses comma separated fields to use a slice instead.
-* Replace all occurrences of “interfaceslice(items)” with []interface{}{items} notation, then remove interfaceslice.
 * Remove all references/code related to sqlite
 * RSS feeds from boards/specific threads/specific usernames+tripcodes (such as newsanon)
 * Pinning a post within a thread even if its not the OP, to prevent its deletion in a cyclical thread.
 
 ### Later down the line
-* Look into the possibility of a plugin system, preferably in go, a scripting language if that is not possible
 * Move frontend to its own git to allow easier frontend swapping
 * API support for existing chan browing phone apps
 * Social credit system to deal with tor/spam posters in a better way

frontend/README.md

@@ -0,0 +1,19 @@
+# gochan.js development
+
+## Building
+You can technically use the npm build script directly for building gochan.js, but it's more convenient to just run `./build.py js` from the gochan repo root directory.
+
+If you want to build it without minification, run `./build.py js --nominify`. If you want to have it watch the JS files for changes and rebuild them when you make any in realtime, use the `--watch` flag.
+
+To install your gochan.js after building it, run `./build.py install --js`.
+
+## Testing
+Gochan unit testing with [Jest](https://jestjs.io) is still in its early stages and can be run by calling `npm run test` from the frontend directory.
+
+Depending on your npm version, you may need to run this if you get an error saying something like "Missing required argument #1" when you run `npm install` if you have the most up to date npm version available in your distro's repo.
+```
+sudo npm install -g n
+sudo n latest
+sudo npm install -g npm
+npm install
+```

frontend/jest.config.mjs

@@ -0,0 +1,194 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // 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: "/tmp/jest_rs",
+
+  // Automatically clear mock calls, instances 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,
+
+  // 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",
+  //   "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: "tests/",
+
+  // 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: "jsdom",
+
+  // 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",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // 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,
+};

frontend/package.json

@@ -4,7 +4,7 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest --verbose",
     "build": "gulp",
     "build-minify": "gulp -m",
     "build-watch": "gulp -w",
@@ -25,14 +25,17 @@
     "@babel/core": "^7.10.2",
     "@babel/preset-env": "^7.10.2",
     "@babel/register": "^7.10.1",
+    "@jest/globals": "^27.4.6",
     "@types/jquery": "^3.3.38",
     "@types/jqueryui": "^1.12.13",
+    "babel-jest": "^27.4.6",
     "babelify": "^10.0.0",
     "browserify": "^16.5.0",
     "fancy-log": "^1.3.3",
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",
     "gulp-uglify": "^3.0.2",
+    "jest": "^27.4.7",
     "regenerator-runtime": "^0.13.9",
     "stdio": "^0.2.7",
     "vinyl-buffer": "^1.0.1",

frontend/tests/init.test.js

@@ -0,0 +1,20 @@
+import {test, expect} from "@jest/globals";
+import "./inittests";
+
+test("Checks for valid mock server timezone (serverTZ)", () => {
+	expect(isNaN(serverTZ)).toBe(false);
+});
+
+test("Checks mock themes to make sure the default one (defaultStyle) exists and is pipes.css", () => {
+	let styleName = "";
+	for(const style of styles) {
+		if(style.Filename == defaultStyle) {
+			styleName = style.Name;
+		}
+	}
+	expect(styleName).toBe("Pipes");
+});
+
+test("tests mock webroot, should be /", () => {
+	expect(webroot).toBe("/");
+});

frontend/tests/inittests.js

@@ -0,0 +1,16 @@
+// mock variables the browser would normally get from {webroot}js/consts.js
+global.styles=[
+	{Name: "Pipes", Filename: "pipes.css"},
+	{Name: "BunkerChan", Filename: "bunkerchan.css"},
+	{Name: "Burichan", Filename: "burichan.css"},
+	{Name: "Clear", Filename: "clear.css"},
+	{Name: "Dark", Filename: "dark.css"},
+	{Name: "Photon", Filename: "photon.css"},
+	{Name: "Yotsuba", Filename: "yotsuba.css"},
+	{Name: "Yotsuba B", Filename: "yotsubab.css"},
+	{Name: "Windows 9x", Filename: "win9x.css"}
+];
+
+global.defaultStyle = "pipes.css";
+global.webroot = "/";
+global.serverTZ = -8;