Merge branch 'uiux' of github.com:ctrlo/GADS into uiux

jest.config.js

@@ -0,0 +1,202 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+/** @type {import('jest').Config} */
+const config = {
+  // 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_rt",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // 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: undefined,
+
+  // 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: {
+    "^component$": "<rootDir>/src/frontend/test/component",
+    "^validation$": "<rootDir>/src/frontend/test/validation",
+    "^logging$": "<rootDir>/src/frontend/test/logging",
+  },
+
+  // 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: "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",
+
+  // 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,
+};
+
+module.exports = config;

package.json

@@ -50,14 +50,18 @@
   },
   "devDependencies": {
     "@babel/core": "^7.14.6",
+    "@babel/plugin-transform-react-jsx": "^7.22.15",
     "@babel/preset-env": "^7.14.7",
     "@babel/preset-react": "^7.16.7",
     "@babel/preset-typescript": "^7.16.7",
     "@babel/runtime-corejs3": "^7.14.7",
+    "@types/jest": "^29.5.6",
+    "@types/jquery": "^3.5.24",
     "@types/react": "^17.0.41",
     "@types/react-dom": "^17.0.14",
     "@types/react-grid-layout": "^1.3.2",
     "@webpack-cli/serve": "^2.0.1",
+    "babel-jest": "^29.7.0",
     "babel-loader": "^8.2.2",
     "buffer": "^6.0.3",
     "clean-webpack-plugin": "^4.0.0",
@@ -69,6 +73,7 @@
     "eslint-plugin-jsdoc": "^46.8.1",
     "eslint-plugin-prettier": "^5.0.0",
     "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "jshint": "^2.11.0",
     "mini-css-extract-plugin": "^2.7.2",
     "npm-watch": "^0.6.0",

src/frontend/test/README.md

@@ -0,0 +1,3 @@
+# Test folder
+This folder contains stubs and/or copies of functionality used within the system. It is felt that (at this time), this is a "necessary" thing for unit testing - this is here because Jest (the JS unit testing framework) uses Babel behind the scenes; the `/src/frontend/lib` directory is ignored by Babel - when this ignore is removed (in order for components to build properly on testing) the JS _does not build_ - as such, the stubs and copies were created with the relevant mapping being put in place within the Jest config.
+This will change once unit testing of components (i.e. regression testing) is implemented and the config will be updated as required to use Jest environments. It was felt that at this point, rather than edit files that are integral to the running of the site, copies were the safer option.

src/frontend/test/component.js

@@ -0,0 +1,100 @@
+/**
+* Attribute that's set on a component that's initialized
+*/
+const componentInitializedAttr = 'data-component-initialized'
+
+/**
+ * Default component class.
+ * Components should inherit this class.
+ */
+class Component {
+  constructor(element) {
+    if (!(element instanceof HTMLElement)) {
+      throw new Error(
+        'Components can only be initialized with an HTMLElement as argument to the constructor'
+      )
+    }
+
+    this.element = element
+    this.element.setAttribute(componentInitializedAttr, true)
+  }
+}
+
+/**
+ * All registered component
+ */
+const registeredComponents = []
+
+/**
+ * Register a component that can be initialized
+ *
+ * @export
+ * @param { Function } componentInitializer Function that will be called when component initializes
+ */
+const registerComponent = (componentInitializer) => {
+  registeredComponents.push(componentInitializer)
+}
+
+/**
+ * Initialize all registered components in the defined scope
+ *
+ * @export
+ * @param {HTMLElement} scope The scope to initialize the components in.
+ */
+const initializeRegisteredComponents = (scope) => {
+  registeredComponents.forEach((componentInitializer) => {
+    componentInitializer(scope)
+  })
+}
+
+/**
+ * Get an Array of elements matching `selector` within `scope`
+ *
+ * @export
+ * @param {HTMLElement} scope The scope to select elements
+ * @param {String} selector The selector to select elements
+ * @returns {Array[HTMLElement]} An array of elements
+ */
+const getComponentElements = (scope, selector) => {
+  const elements = scope.querySelectorAll(selector)
+  if (!elements.length) {
+    return []
+  }
+
+  return Array.from(elements)
+}
+
+/**
+ * Initialize component `Component` on all elements matching `selector` within `scope`
+ * Will only initialize elements that have not been initialized.
+ *
+ * @export
+ * @param {HTMLElement} scope The scope to initialize the objects on
+ * @param {String|Function} selector The selector to select elements
+ * @param {Component} ComponentClass The Component class to initialize
+ * @returns {Array[Component]} An array of initialized components
+ */
+const initializeComponent = (scope, selector, ComponentClass) => {
+  if (!(ComponentClass.prototype instanceof Component)) {
+    throw new Error(
+      'Components can only be initialized when they inherit the basecomponent'
+    )
+  }
+
+  const elements = typeof (selector) === 'function' ? selector(scope) : getComponentElements(scope, selector)
+  if (!elements.length) {
+    return []
+  }
+
+  return elements
+    .filter((el) => !el.getAttribute(componentInitializedAttr))
+    .map((el) => new ComponentClass(el))
+}
+
+export {
+  Component,
+  initializeComponent,
+  initializeRegisteredComponents,
+  getComponentElements,
+  registerComponent
+}

src/frontend/test/logging.js

@@ -0,0 +1,34 @@
+// Fake logging class for testing
+class Logging {
+  constructor() {
+    this.allowLogging = true
+  }
+
+  log(message) {
+    if (this.allowLogging) {
+      console.log(message)
+    }
+  }
+
+  info(message) {
+    if (this.allowLogging) {
+      console.info(message)
+    }
+  }
+
+  warn(message) {
+    if (this.allowLogging) {
+      console.warn(message)
+    }
+  }
+
+  error(message) {
+    if (this.allowLogging) {
+      console.error(message)
+    }
+  }
+}
+
+const logging = new Logging
+
+export { logging }