external-repos/pa11y-dashboard
2
0
Fork 1
mirror of https://github.com/pa11y/pa11y-dashboard.git synced 2025-09-24 14:21:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix tests, test more, support Node 16-20 (#318)

Browse Source 
* Add `.nvmrc` → 14

* Fix package.json's URLs

* Update to Pa11y CI's version (`https` etc)

* Add Node 16 to matrix, and make linter run each time

* Standardise `.editorconfig`

* Upgrade to `actions/checkout@4` and `actions/setup-node@3`

* Replace `npm install` with `npm ci`

* Replace `wait-action` with `sleep 10s`

* Rewrite to detach config, use promises, and replace `request` with `fetch` (adding `node-fetch` until Node 18)

* Delete small single-use helper

* Bump to `pa11y-webservice@4.1` and use caret from here (we control the dep)

* Return to `this.last`, fix syntax errors

* Update copyright to 2023 and remove unused ref

* Fix troubleshooting link

* Remove symbols, since they could become outdated

* Remove missing link

* Replace emoji note with GitHub Markdown note

* Fix setup link

* Replace br with double space

* Replace `sh` with `console` for terminal output

* Rename Mongo DB used in integration tests to avoid clash locally

* Remove JSCS and references to other unused tools

* Remove tooling tasks update

* Compress definitions and layout where it makes sense or brings clarity

* Rename db used in tests to `pa11y-dashboard-integration-test`, to avoid clash with `pa11y-webservice`'s own test DB

* Use briefer syntax

* Fix integration test setup & config

* Reverse function order to return early

* Update to `pa11y-lint-config@3`, update `ecmaVersion` to 2020, remove some rule overrides

* Fix linting errors, remove cruft

* Move linting and broken integration test command into npm scripts (it remains broken)

* Revert `node-fetch` to `^2.7.0` (can't do ESM right now)

* Upgrade to `pa11y-webservice@^4.2` from `^4.1`

* Upgrade to `mocha@^9.2` from `^8.4` (can't do `10` yet because it drops Node 12)

* Use backticks for property names

* Fix anchor link for 'installing MongoDB'

* Reorganise test workflow and add Node `18` and `20` to test matrix

* Fix `lockfile-version` to `2`

* Apply support policy

* Replace Travis badge with one for Actions

* Define some more links, separate code blocks

* Reflect greater confidence in support for recent versions of MongoDB

* Test against MongoDB versions 3-7

* Remove Make tasks `all`, `ci`, `clean`, `install`, `node_modules`, `lint`

* Fix integration test command in workflow

* Restore shallow Mocha command for now

* Move linting into own step `lint` to avoid duplicated warnings

* Give the `test` workflow a better name now that it uses a bigger matrix

* Drop back to ES2019 from ES2020 for Node 12, remove use of `?.`

* Reduce `--slow` to `4000`

* Remove a `describe.only` 👀

* Fix broken test for add new item → standard

* Rename availability check function

* Fix task count check when testing task creation

* Return fully to the original `new` logic

* Use `127.0.0.1` consistently to fix (possible) IPV6 issue

* Fix Cheerio call in failing test

* Add MongoDB 2, and tweak other final versions

* Lower case and shorten test name, to sit well alongside lint job

* Replace `underscore(.groupBy)` with `lodash/groupby`

* Capitalise Puppeteer

* Say we test against MongoDB 2 as well

* Document two replacements of Make with npm scripts

* Revise requirements, permitting Node 16+ and describing Ubuntu issue

* Support Node 16, 18, 20

* Install `lodash.keys` and fix Lodash mistakes

* Fix rebase autoresolution error affecting `index.js` 👀

* This is Pa11y Dashboard not Webservice

* Fix MongoDB link

* Remove unused link def for Puppeteer

* Shush markdown linter

* Actually use `pa11y-webservice@4.3`

* Improve support table

* Don't `fail-fast`

* Remove dependency `underscore`

* Fix dashboard's port definition for integration test

* Set `NODE_ENV=test` for integration tests

* Use `mocha@10`

* Extend the sleep to rule out the service not starting in time

* Wait on port `4000` instead of sleeping

* Fix `wait-on-action` to `v1.1.0`

* Fix includes of `lodash.groupby` and `lodash.keys`

* Label the port waiting action

* Fix to `pa11y-webservice@4.2.0` until dep issue resolved

* Set waiter action to start after 1s, time out after 30s, and log

* Upgrade to `pa11y-webservice@^4.3.1` from `~4.2.0`

* Remove comment about recent versions of MongoDB, since we test with them now
This commit is contained in:
Danyal Aytekin
2024-03-13 05:48:58 +00:00
committed by GitHub
parent 8145069fe9
commit e76dccef77
44 changed files with 990 additions and 1479 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.editorconfig
View File

@@ -1,5 +1,3 @@
# http://editorconfig.org
root = true
[*]
@@ -11,7 +9,7 @@ insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
indent_style = spaces
indent_style = space
trim_trailing_whitespace = false
[*.yml]

11
.eslintrc.js
View File

@@ -1,3 +1,12 @@
'use strict';
module.exports = require('pa11y-lint-config/eslint/es2017');
const pa11yConfig = require('pa11y-lint-config/eslint/es2017');
const config = {
...pa11yConfig,
parserOptions: {
ecmaVersion: 2019
}
};
module.exports = config;

66
.github/workflows/tests.yml vendored
View File

@@ -1,5 +1,3 @@
name: Build and lint
on:
push:
branches:
@@ -7,38 +5,54 @@ on:
pull_request:
jobs:
checkout_and_test:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v3
with:
node-version: 12
- run: npm ci
- run: npm run lint
test:
name: test (node ${{ matrix.node }}, mongodb ${{ matrix.mongo }})
runs-on: ubuntu-20.04
strategy:
fail-fast: false
matrix:
node: [12, 14, 16, 18, 20]
mongo: [latest]
include:
- node-version: 12.x
lint: true # Linter is run only once to shorten the total build time
- node-version: 14.x
- { node: 12, mongo: 6.0.11 }
- { node: 12, mongo: 5.0.22 }
- { node: 12, mongo: 4.4.25 }
- { node: 12, mongo: 3.6.23 }
- { node: 12, mongo: 2.6.12 }
steps:
- name: Checkout code from ${{ github.repository }}
uses: actions/checkout@v2
- name: Setup node
uses: actions/setup-node@v2
- uses: actions/checkout@v4
- uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
- name: MongoDB in GitHub Actions
uses: supercharge/mongodb-github-action@1.3.0
node-version: ${{ matrix.node }}
- run: npm ci
- name: Supply MongoDB ${{ matrix.mongo }}
uses: supercharge/mongodb-github-action@1.5.0
with:
mongodb-version: 3.4
- name: Install dependencies
run: npm i
- name: Run linter
if: ${{ matrix.lint }}
run: make lint
- name: Create test config
mongodb-version: ${{ matrix.mongo }}
- name: Supply integration test configuration file
run: cp config/test.sample.json config/test.json
- name: Start test app
- name: Make dashboard available to be integration-tested
run: NODE_ENV=test node index.js &
- name: Wait / Sleep
uses: jakejarvis/wait-action@v0.1.0
- name: Wait for dashboard to respond
uses: iFaxity/wait-on-action@v1.1.0
with:
time: '10s'
- name: Run tests
run: make ci
resource: http://localhost:4000
delay: 1000
timeout: 30000
log: true
- run: NODE_ENV=test npm test

3
.gitignore vendored
View File

@@ -1,4 +1,3 @@
# Config files
config/development.json
config/production.json
@@ -8,5 +7,5 @@ config/test.json
node_modules
npm-debug.log
# JetBrains IDE
# Editors
.idea

1
.npmrc Normal file
View File

@@ -0,0 +1 @@
lockfile-version=2

1
.nvmrc Normal file
View File

@@ -0,0 +1 @@
14

14
CONTRIBUTING.md
View File

@@ -1,6 +1,4 @@
Contributing Guide
==================
# Contributing Guide
Thanks for getting involved :tada:
@@ -14,8 +12,8 @@ Our website outlines the many ways that you can contribute to Pa11y:
[code-of-conduct]: http://pa11y.org/contributing/code-of-conduct/
[communications]: http://pa11y.org/contributing/communications/
[companies]: http://pa11y.org/contributing/companies/
[designers]: http://pa11y.org/contributing/designers/
[developers]: http://pa11y.org/contributing/developers/
[code-of-conduct]: https://pa11y.org/contributing/code-of-conduct/
[communications]: https://pa11y.org/contributing/communications/
[companies]: https://pa11y.org/contributing/companies/
[designers]: https://pa11y.org/contributing/designers/
[developers]: https://pa11y.org/contributing/developers/

15
Makefile
View File

@@ -1,25 +1,10 @@
include Makefile.node
# We need to run integration tests recursively
export INTEGRATION_FLAGS := --recursive
# Verify tasks
# ------------
# Lint alias for backwards compatibility
lint: verify
# Client-side asset tasks
# -----------------------
# Compile LESS
less:
@lessc -x ./public/less/main.less ./public/css/site.min.css
@$(TASK_DONE)
# Compile client-side JavaScript
uglify:
@uglifyjs \
public/js/vendor/jquery/jquery.min.js \

125
Makefile.node
View File

@@ -1,125 +0,0 @@
#
# Node.js Makefile
# ================
#
# Do not update this file manually – it's maintained separately on GitHub:
# https://github.com/rowanmanning/makefiles/blob/master/Makefile.node
#
# To update to the latest version, run `make update-makefile`.
#
# Meta tasks
# ----------
.PHONY: test
# Useful variables
# ----------------
NPM_BIN = ./node_modules/.bin
export PATH := $(NPM_BIN):$(PATH)
export EXPECTED_COVERAGE := 90
export INTEGRATION_TIMEOUT := 10000
export INTEGRATION_SLOW := 4000
# Output helpers
# --------------
TASK_DONE = echo "✓ $@ done"
# Group tasks
# -----------
all: install ci
ci: verify test
# Install tasks
# -------------
clean:
@git clean -fxd
@$(TASK_DONE)
install: node_modules
@$(TASK_DONE)
node_modules: package.json
@npm prune --production=false
@npm install
@$(TASK_DONE)
# Verify tasks
# ------------
verify: verify-javascript verify-dust verify-spaces
@$(TASK_DONE)
verify-javascript: verify-eslint verify-jshint verify-jscs
@$(TASK_DONE)
verify-dust:
@if [ -e .dustmiterc* ]; then dustmite --path ./view && $(TASK_DONE); fi
verify-eslint:
@if [ -e .eslintrc* ]; then eslint . && $(TASK_DONE); fi
verify-jshint:
@if [ -e .jshintrc* ]; then jshint . && $(TASK_DONE); fi
verify-jscs:
@if [ -e .jscsrc* ]; then jscs . && $(TASK_DONE); fi
verify-spaces:
@if [ -e .editorconfig* ] && [ -x $(NPM_BIN)/lintspaces ]; then \
git ls-files | xargs lintspaces -e .editorconfig && $(TASK_DONE); \
fi
verify-coverage:
@if [ -d coverage ]; then \
if [ -x $(NPM_BIN)/nyc ]; then \
nyc check-coverage --lines $(EXPECTED_COVERAGE) --functions $(EXPECTED_COVERAGE) --branches $(EXPECTED_COVERAGE) && $(TASK_DONE); \
else \
if [ -x $(NPM_BIN)/istanbul ]; then \
istanbul check-coverage --statement $(EXPECTED_COVERAGE) --branch $(EXPECTED_COVERAGE) --function $(EXPECTED_COVERAGE) && $(TASK_DONE); \
fi \
fi \
fi
# Test tasks
# ----------
test: test-unit-coverage verify-coverage test-integration
@$(TASK_DONE)
test-unit:
@if [ -d test/unit ]; then mocha test/unit --recursive && $(TASK_DONE); fi
test-unit-coverage:
@if [ -d test/unit ]; then \
if [ -x $(NPM_BIN)/nyc ]; then \
nyc --reporter=text --reporter=html $(NPM_BIN)/_mocha test/unit --recursive && $(TASK_DONE); \
else \
if [ -x $(NPM_BIN)/istanbul ]; then \
istanbul cover $(NPM_BIN)/_mocha -- test/unit --recursive && $(TASK_DONE); \
else \
make test-unit; \
fi \
fi \
fi
test-integration:
@if [ -d test/integration ]; then mocha test/integration --timeout $(INTEGRATION_TIMEOUT) --slow $(INTEGRATION_SLOW) $(INTEGRATION_FLAGS) && $(TASK_DONE); fi
# Tooling tasks
# -------------
update-makefile:
@curl -s https://raw.githubusercontent.com/rowanmanning/makefiles/master/Makefile.node > Makefile.node
@$(TASK_DONE)

94
README.md
View File

@@ -14,13 +14,14 @@ Pa11y Dashboard is a web interface to the [Pa11y][pa11y] accessibility reporter;
## Requirements
Pa11y Dashboard is a [Node.js][node] application and requires a stable or LTS version of Node, currently version 12 or 14.
- [Node.js][node]: Pa11y Dashboard 4 requires a stable (even-numbered) version of Node.js of 12 or above.
- [MongoDB][mongodb]: This project depends on Pa11y Webservice, which stores test results in a MongoDB database and expects one to be available and running.
⚠️ At the moment, Pa11y Dashboard won't work with Node.js v16. Please use Node.js 12 or 14. ⚠️
### Pally Dashboard 4 and Linux/Ubuntu
Pa11y Dashboard uses a [MongoDB][mongo] database to store the results of the tests. The database doesn't have to be in the same server or computer where Pa11y Dashboard is running from.
Pa11y (and therefore this service) uses Headless Chrome to perform accessibility testing. On Linux and other Unix-like systems, Pa11y's attempt to install it as a dependency sometimes fails since additional operating system packages will be required. Your distribution's documentation should describe how to install these.
Pa11y Dashboard uses [puppeteer](https://www.npmjs.com/package/puppeteer) to create a headless instance of the Chromium browser in order to run the tests. On certain environments this may require additional dependencies to be installed. For example, in Debian/Ubuntu systems you may need to install the `libnss3` and `libgconf-2-4` libraries in order to be able to run tests on Pa11y Dashboard. Please refer to the documentation from your provider for details on how to do this.
In addition, to use Pa11y Dashboard 4 with a version of Ubuntu above 20.04, a path to the Chrome executable must be defined in `chromeLaunchConfig`, as `chromeLaunchConfig.executablePath`. Version 5 of Pa11y Dashboard, which will use Pa11y 7 along with a more recent version of Puppeteer, will resolve this issue.
## Setting up Pa11y Dashboard
@@ -41,11 +42,11 @@ npm install
Instructions for installing and running MongoDB are outside the scope of this document. When in doubt, please refer to the [MongoDB installation instructions](https://docs.mongodb.com/manual/installation/) for details of how to install and run MongoDB on your specific operating system. An example of the installation and configuration process for macOS follows.
Pa11y Dashboard currently uses version 3 of the Node.js MongoDB driver, which means that [only MongoDB servers of versions 4.4 or older are supported](https://docs.mongodb.com/drivers/node/current/compatibility/#mongodb-compatibility). Please ensure that your MongoDB server fills the requirements before trying to run Pa11y Dashboard.
Pa11y Dashboard uses [MongoDB Node.js Driver][mongodb-package] version 3, which [may not support some features][mongodb-package-compatibility] of MongoDB versions 6 and beyond. We do however test against MongoDB versions 2 to 6, plus the latest major version, which at the time of writing is `7`.
#### Example MongoDB installation for macOS
On recent versions of macOS (10.13 or later), you can use [Homebrew](https://brew.sh/) to install MongoDB Community Edition. More recent versions of MongoDB are untested and unsupported.
On recent versions of macOS (10.13 or later), you can use [Homebrew] to install MongoDB Community Edition.
Tap the MongoDB Homebrew Tap:
@@ -67,8 +68,9 @@ brew services start mongodb/brew/mongodb-community@4.4
Check that the service has started properly:
```sh
```console
$ brew services list
Name Status User Plist
mongodb-community started pa11y /Users/pa11y/Library/LaunchAgents/homebrew.mxcl.mongodb-community.plist
```
@@ -99,43 +101,49 @@ Three example files are provided in this repository, you can copy and customise
```sh
cp config/development.sample.json config/development.json
```
```sh
cp config/production.sample.json config/production.json
```
```sh
cp config/test.sample.json config/test.json
```
The [available configurations](#configurations) are documented in the next section.
If you run into problems, check the [troubleshooting guide][#troubleshooting].
If you run into problems, check the [troubleshooting guide](#troubleshooting).
## Configurations
The boot configurations for Pa11y Dashboard are as follows. Look at the sample JSON files in the repo for example usage.
### port
### `port`
*(number)* The port to run the application on. Set via a config file or the `PORT` environment variable.
### noindex
### `noindex`
*(boolean)* If set to `true` (default), the dashboard will not be indexed by search engines. Set to `false` to allow indexing. Set via a config file or the `NOINDEX` environment variable.
### readonly
### `readonly`
*(boolean)* If set to `true`, users will not be able to add, delete or run URLs (defaults to `false`). Set via a config file or the `READONLY` environment variable.
### siteMessage
### `siteMessage`
*(string)* A message to display prominently on the site home page. Defaults to `null`.
### webservice
### `webservice`
This can either be an object containing [Pa11y Webservice configurations][pa11y-webservice-config], or a string which is the base URL of a [Pa11y Webservice][pa11y-webservice] instance you are running separately. If using environment variables, prefix the webservice vars with `WEBSERVICE_`.
This can either be an object containing [Pa11y Webservice configurations][pa11y-webservice-config], or a string which is the base URL of a Pa11y Webservice instance you are running separately. If using environment variables, prefix the webservice vars with `WEBSERVICE_`.
## Contributing
There are many ways to contribute to Pa11y Dashboard, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.
If you're ready to contribute some code, you'll need to clone the repo and get set up as outlined in the [setup guide](#setup). You'll then need to start the application in test mode with:
If you're ready to contribute some code, you'll need to clone the repo and get set up as outlined in the [setup guide](#setting-up-pa11y-dashboard). You'll then need to start the application in test mode with:
```sh
NODE_ENV=test node index.js
@@ -144,9 +152,8 @@ NODE_ENV=test node index.js
You'll now be able to run the following commands:
```sh
make verify # Verify all of the code (ESLint)
make test # Run all tests
make test-integration # Run the integration tests
npm run lint # Lint the code
npm test # Run all tests
```
To compile the client-side JavaScript and CSS, you'll need the following commands. Compiled code is committed to the repository.
@@ -158,51 +165,56 @@ make uglify # Compile and uglify the client-side JavaScript
## Useful resources
* [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitalOcean](https://una.im/pa11y-dash/)
* [Monitoring Web Accessibility Compliance With Pa11y Dashboard](https://www.lullabot.com/articles/monitoring-web-accessibility-compliance-with-pa11y-dashboard)
- [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitalOcean](https://una.im/pa11y-dash/)
- [Monitoring Web Accessibility Compliance With Pa11y Dashboard](https://www.lullabot.com/articles/monitoring-web-accessibility-compliance-with-pa11y-dashboard)
## Troubleshooting
### Common issues
* `500` errors or `Could not connect to pa11y-webservice` messages are often related to MongoDB. Ensure that you have the [appropriate version of MongoDB][#installing-mongodb] installed, and that it's running - it doesn't always start automatically.
* Error messages saying that pa11y-webservice isn't running may be due to dependency installation problems. Try deleting your `pa11y-dashboard/node_modules` directory and running `npm install` again.
- `500` errors or `Could not connect to pa11y-webservice` messages are often related to MongoDB. Ensure that you have the [appropriate version of MongoDB](#installing-mongodb) installed, and that it's running - it doesn't always start automatically.
- Error messages saying that pa11y-webservice isn't running may be due to dependency installation problems. Try deleting your `pa11y-dashboard/node_modules` directory and running `npm install` again.
### Create a new issue
Check the [issue tracker][issues] for similar issues before creating a new one. If the problem that you're experiencing is not covered by one of the existing issues, you can [create a new issue][create-issue]. Please include your node.js and MongoDB version numbers, and your operating system, as well as any information that may be useful in debugging the issue.
Check the [issue tracker][issues] for similar issues before creating a new one. If the problem that you're experiencing is not covered by one of the existing issues, you can [create a new issue][issues-create]. Please include your node.js and MongoDB version numbers, and your operating system, as well as any information that may be useful in debugging the issue.
## Support and Migration
## Support and migration
Pa11y Dashboard major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version.
> [!NOTE]
> We maintain a [migration guide](MIGRATION.md) to help you migrate between major versions.
We also maintain a [migration guide](MIGRATION.md) to help you migrate.
When we release a new major version we will continue to support the previous major version for 6 months. This support will be limited to fixes for critical bugs and security issues. If you're opening an issue related to this project, please mention the specific version that the issue affects.
| :grey_question: | Major Version | Last Minor Release | Node.js Versions | Support End Date |
| :-------------- | :------------ | :----------------- | :--------------- | :--------------- |
| :heart: | 4 | N/A | 12+ | N/A |
| :hourglass: | 3 | 3.3.0 | 8+ | 2022-05-26 |
| :skull: | 2 | 2.4.2 | 4+ | 2020-01-16 |
| :skull: | 1 | 1.12 | 0.10–6 | 2016-12-05 |
The following table lists the major versions available and, for each previous major version, its end-of-support date, and its final minor version released.
If you're opening issues related to these, please mention the version that the issue relates to.
| Major version | Last minor release | Node.js support | Support end date |
| :------------ | :----------------- | :------------------------ | :--------------- |
| `4` | Imminent | `>= 12` | ✅ Current major version |
| `3` | `3.3.0` | `8`, `10` | 2022-05-26 |
| `2` | `2.4.2` | `4`, `6` | 2020-01-16 |
| `1` | `1.12.0` | `0.10`, `0.12`, `4`, `6` | 2016-12-05 |
## License
Pa11y Dashboard is licensed under the [GNU General Public License 3.0][info-license].<br/>
Copyright &copy; 2013–2020, Team Pa11y and contributors
Pa11y Dashboard is licensed under the [GNU General Public License 3.0][info-license].
Copyright &copy; 2023, Team Pa11y and contributors
[gpl]: http://www.gnu.org/licenses/gpl-3.0.html
[mongo]: http://www.mongodb.org/
[homebrew]: https://brew.sh/
[issues]: https://github.com/pa11y/pa11y-dashboard/issues?utf8=%E2%9C%93&q=is%3Aissue
[issues-create]: https://github.com/pa11y/pa11y-dashboard/issues/new
[mongodb]: http://www.mongodb.org/
[mongodb-package]: https://www.npmjs.com/package/mongodb
[mongodb-package-compatibility]: https://docs.mongodb.com/drivers/node/current/compatibility
[node]: http://nodejs.org/
[pa11y]: https://github.com/pa11y/pa11y
[pa11y-webservice-config]: https://github.com/pa11y/webservice#configurations
[issues]: https://github.com/pa11y/pa11y-dashboard/issues?utf8=%E2%9C%93&q=is%3Aissue
[create-issue]: https://github.com/pa11y/pa11y-dashboard/issues/new
[info-node]: package.json
[info-build]: https://travis-ci.org/pa11y/pa11y-dashboard
[info-build]: https://github.com/pa11y/pa11y-dashboard/actions/workflows/tests.yml
[info-license]: LICENSE
[shield-version]: https://img.shields.io/github/package-json/v/pa11y/pa11y-dashboard.svg
[shield-node]: https://img.shields.io/node/v/pa11y/pa11y-dashboard.svg
[shield-build]: https://img.shields.io/travis/pa11y/pa11y-dashboard/master.svg
[shield-build]: https://github.com/pa11y/pa11y-dashboard/actions/workflows/tests.yml/badge.svg
[shield-license]: https://img.shields.io/badge/license-GPL%203.0-blue.svg

5
app.js
View File

@@ -17,7 +17,7 @@
const bodyParser = require('body-parser');
const compression = require('compression');
const createClient = require('pa11y-webservice-client-node');
const EventEmitter = require('events').EventEmitter;
const {EventEmitter} = require('events');
const express = require('express');
const hbs = require('express-hbs');
const morgan = require('morgan');
@@ -27,7 +27,6 @@ const pkg = require('./package.json');
module.exports = initApp;
// Initialise the application
function initApp(config, callback) {
config = defaultConfig(config);
@@ -54,7 +53,6 @@ function initApp(config, callback) {
loadErrorHandling(app, config, callback);
}
// Get default configurations
function defaultConfig(config) {
if (typeof config.noindex !== 'boolean') {
config.noindex = true;
@@ -66,7 +64,6 @@ function defaultConfig(config) {
}
function loadMiddleware(app) {
// Compression
app.express.use(compression());
// Adds an ID to every request, used later for logging

1
bower.json
View File

@@ -1,6 +1,5 @@
{
"name": "pa11y-dashboard",
"dependencies": {
"jquery": "~1.10",
"bootstrap": "~3.0",

2
config.js
View File

@@ -15,6 +15,7 @@
'use strict';
const fs = require('fs');
const environment = (process.env.NODE_ENV || 'development');
const jsonPath = `./config/${environment}.json`;
const jsPath = `./config/${environment}.js`;
@@ -28,7 +29,6 @@ if (fs.existsSync(jsonPath)) {
port: Number(env('PORT', '4000')),
noindex: env('NOINDEX', 'true') === 'true',
readonly: env('READONLY', 'false') === 'true',
webservice: env('WEBSERVICE_URL', {
database: env('WEBSERVICE_DATABASE', 'mongodb://localhost/pa11y-webservice'),
host: env('WEBSERVICE_HOST', '0.0.0.0'),

1
config/development.sample.json
View File

@@ -2,7 +2,6 @@
"port": 4000,
"noindex": true,
"readonly": false,
"webservice": {
"database": "mongodb://localhost/pa11y-webservice-dev",
"host": "0.0.0.0",

1
config/production.sample.json
View File

@@ -2,7 +2,6 @@
"port": 4000,
"noindex": true,
"readonly": false,
"webservice": {
"database": "mongodb://localhost/pa11y-webservice",
"host": "0.0.0.0",

5
config/test.sample.json
View File

@@ -2,10 +2,9 @@
"port": 4000,
"noindex": true,
"readonly": false,
"webservice": {
"database": "mongodb://localhost/pa11y-webservice-test",
"host": "0.0.0.0",
"database": "mongodb://127.0.0.1/pa11y-dashboard-integration-test",
"host": "127.0.0.1",
"port": 3000,
"cron": "0 30 0 * * *"
}

8
data/standards.js
View File

@@ -12,13 +12,9 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength
'use strict';
module.exports = getStandards;
function getStandards() {
module.exports = function getStandards() {
return [
{
title: 'WCAG2A',
@@ -1800,4 +1796,4 @@ function getStandards() {
]
}
];
}
};

8
data/techniques.js
View File

@@ -12,13 +12,9 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength
'use strict';
module.exports = getTechniques;
function getTechniques() {
module.exports = function getTechniques() {
return {
H30: {
title: 'H30: Providing link text that describes the purpose of a link for anchor elements',
@@ -713,4 +709,4 @@ function getTechniques() {
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F96'
}
};
}
};

1636
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

25
package.json
View File

@@ -15,13 +15,13 @@
],
"repository": {
"type": "git",
"url": "https://github.com/pa11y/dashboard.git"
"url": "https://github.com/pa11y/pa11y-dashboard.git"
},
"homepage": "https://github.com/pa11y/dashboard",
"bugs": "https://github.com/pa11y/dashboard/issues",
"homepage": "https://github.com/pa11y/pa11y-dashboard",
"bugs": "https://github.com/pa11y/pa11y-dashboard/issues",
"license": "GPL-3.0",
"engines": {
"node": ">=12 <16"
"node": ">=12"
},
"dependencies": {
"body-parser": "~1.19.2",
@@ -30,26 +30,29 @@
"express-hbs": "~2.4.0",
"http-headers": "~3.0.2",
"kleur": "~4.1.4",
"lodash.groupby": "~4.6.0",
"lodash.keys": "~4.2.0",
"moment": "~2.29.4",
"morgan": "~1.10.0",
"nanoid": "~3.3.2",
"pa11y-webservice": "~4.0.1",
"pa11y-webservice-client-node": "~3.0.0",
"underscore": "~1.13.2"
"pa11y-webservice": "^4.3.1",
"pa11y-webservice-client-node": "~3.0.0"
},
"devDependencies": {
"bower": "^1.8.13",
"cheerio": "^1.0.0-rc.10",
"eslint": "^7.27.0",
"less": "^3.11.1",
"mocha": "^8.4.0",
"pa11y-lint-config": "^2.0.0",
"mocha": "^10.2.0",
"node-fetch": "^2.7.0",
"pa11y-lint-config": "^3.0.0",
"proclaim": "^3.6.0",
"request": "^2.88.2",
"uglify-js": "^3.11.0"
},
"scripts": {
"start": "node index.js",
"test": "make ci"
"test": "npm run test:integration",
"test:integration": "mocha 'test/integration/**/*.js' --recursive --timeout 20000 --slow 4000",
"lint": "eslint ."
}
}

7
route/index.js
View File

@@ -16,10 +16,7 @@
const presentTask = require('../view/presenter/task');
module.exports = route;
// Route definition
function route(app) {
module.exports = function index(app) {
app.express.get('/', (request, response, next) => {
app.webservice.tasks.get({lastres: true}, (error, tasks) => {
if (error) {
@@ -32,4 +29,4 @@ function route(app) {
});
});
});
}
};

50
route/new.js
View File

@@ -18,13 +18,10 @@
const getStandards = require('../data/standards');
const httpHeaders = require('http-headers');
module.exports = route;
// Route definition
function route(app) {
module.exports = function route(app) {
app.express.get('/new', (request, response) => {
const standards = getStandards().map(standard => {
const standards = getStandards().map(
standard => {
if (standard.title === 'WCAG2AA') {
standard.selected = true;
}
@@ -37,18 +34,16 @@ function route(app) {
});
app.express.post('/new', (request, response) => {
const parsedActions = parseActions(request.body.actions);
let parsedHeaders;
if (request.body.headers) {
parsedHeaders = httpHeaders(request.body.headers, true);
}
const parsedHeaders = request.body.headers && httpHeaders(request.body.headers, true);
const newTask = createNewTask(request, parsedActions, parsedHeaders);
app.webservice.tasks.create(newTask, (error, task) => {
if (error) {
if (!error) {
return response.redirect(`/${task.id}?added`);
}
const standards = getStandards().map(standard => {
if (standard.title === newTask.standard) {
standard.selected = true;
@@ -63,17 +58,14 @@ function route(app) {
});
newTask.actions = request.body.actions;
newTask.headers = request.body.headers;
return response.render('new', {
response.render('new', {
error,
standards,
task: newTask
});
}
response.redirect(`/${task.id}?added`);
});
});
}
};
function parseActions(actions) {
if (actions) {
@@ -87,19 +79,19 @@ function parseActions(actions) {
}
}
/* eslint-disable complexity */
function createNewTask(request, actions, headers) {
function createNewTask({body}, actions, headers) {
return {
name: request.body.name,
url: request.body.url,
standard: request.body.standard,
ignore: request.body.ignore || [],
timeout: request.body.timeout || undefined,
wait: request.body.wait || undefined,
name: body.name,
url: body.url,
standard: body.standard,
ignore: body.ignore || [],
timeout: body.timeout || undefined,
wait: body.wait || undefined,
actions,
username: request.body.username || undefined,
password: request.body.password || undefined,
username: body.username || undefined,
password: body.password || undefined,
headers,
hideElements: request.body.hideElements || undefined
hideElements: body.hideElements || undefined
};
}

9
route/result/download.js
View File

@@ -16,11 +16,7 @@
const moment = require('moment');
module.exports = route;
// Route definition
function route(app) {
module.exports = function download(app) {
function getTaskAndResult(request, response, next) {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
@@ -83,5 +79,4 @@ function route(app) {
result.task = task;
response.send(result);
});
}
};

17
route/result/index.js
View File

@@ -17,19 +17,15 @@
const presentTask = require('../../view/presenter/task');
const presentResult = require('../../view/presenter/result');
module.exports = route;
// Route definition
function route(app) {
app.express.get('/:id/:rid', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
module.exports = function resultIndex(app) {
app.express.get('/:id/:rid', ({params}, response, next) => {
app.webservice.task(params.id).get({}, (error, task) => {
if (error) {
return next();
}
app.webservice
.task(request.params.id)
.result(request.params.rid)
.task(params.id)
.result(params.rid)
.get({full: true}, (webserviceError, result) => {
if (webserviceError) {
return next();
@@ -42,5 +38,4 @@ function route(app) {
});
});
});
}
};

17
route/task/delete.js
View File

@@ -16,13 +16,9 @@
const presentTask = require('../../view/presenter/task');
module.exports = route;
// Route definition
function route(app) {
app.express.get('/:id/delete', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
module.exports = function del(app) {
app.express.get('/:id/delete', ({params}, response, next) => {
app.webservice.task(params.id).get({}, (error, task) => {
if (error) {
return next();
}
@@ -33,13 +29,12 @@ function route(app) {
});
});
app.express.post('/:id/delete', (request, response, next) => {
app.webservice.task(request.params.id).remove(error => {
app.express.post('/:id/delete', ({params}, response, next) => {
app.webservice.task(params.id).remove(error => {
if (error) {
return next();
}
response.redirect('/?deleted');
});
});
}
};

9
route/task/edit.js
View File

@@ -18,11 +18,7 @@ const presentTask = require('../../view/presenter/task');
const getStandards = require('../../data/standards');
const httpHeaders = require('http-headers');
module.exports = route;
// Route definition
function route(app) {
module.exports = function edit(app) {
app.express.get('/:id/edit', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
@@ -117,5 +113,4 @@ function route(app) {
});
});
});
}
};

9
route/task/ignore.js
View File

@@ -1,10 +1,6 @@
'use strict';
module.exports = route;
// Route definition
function route(app) {
module.exports = function ignore(app) {
app.express.post('/:id/ignore', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
@@ -22,5 +18,4 @@ function route(app) {
});
});
});
}
};

9
route/task/index.js
View File

@@ -18,11 +18,7 @@ const presentTask = require('../../view/presenter/task');
const presentResult = require('../../view/presenter/result');
const presentResultList = require('../../view/presenter/result-list');
module.exports = route;
// Route definition
function route(app) {
module.exports = function taskIndex(app) {
app.express.get('/:id', (request, response, next) => {
app.webservice.task(request.params.id).get({lastres: true}, (error, task) => {
if (error) {
@@ -47,5 +43,4 @@ function route(app) {
});
});
});
}
};

9
route/task/run.js
View File

@@ -14,11 +14,7 @@
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
module.exports = route;
// Route definition
function route(app) {
module.exports = function run(app) {
app.express.get('/:id/run', (request, response, next) => {
app.webservice.task(request.params.id).run(error => {
if (error) {
@@ -27,5 +23,4 @@ function route(app) {
response.redirect(`/${request.params.id}?running`);
});
});
}
};

3
route/task/unignore.js
View File

@@ -2,9 +2,7 @@
module.exports = route;
// Route definition
function route(app) {
app.express.post('/:id/unignore', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
@@ -23,5 +21,4 @@ function route(app) {
});
});
});
}

10
test/.eslintrc.js
View File

@@ -1,15 +1,9 @@
'use strict';
// Clone the main config
const config = module.exports = JSON.parse(JSON.stringify(require('../.eslintrc')));
const config = require('../.eslintrc');
// We use `this` all over the integration tests
config.rules['no-invalid-this'] = 'off';
// Because of our use of `this`, arrow functions
// aren't really gonna work in the integration tests
config.rules['prefer-arrow-callback'] = 'off';
// Disable max line length/statements
config.rules['max-len'] = 'off';
config.rules['max-statements'] = 'off';
module.exports = config;

10
test/integration/helper/navigate.js
View File

@@ -12,19 +12,13 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable requireArrowFunctions
'use strict';
const cheerio = require('cheerio');
const request = require('request');
module.exports = createNavigator;
// Create a navigate function
function createNavigator(baseUrl, store) {
return function(opts, callback) {
store.body = null;
store.dom = null;
store.request = null;
@@ -54,8 +48,8 @@ function createNavigator(baseUrl, store) {
store.dom = cheerio.load(store.body);
}
callback();
});
};
}
module.exports = createNavigator;

30
test/integration/helper/webservice.js
View File

@@ -1,30 +0,0 @@
// This file is part of Pa11y Dashboard.
//
// Pa11y Dashboard is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Pa11y Dashboard is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable requireArrowFunctions
'use strict';
const createClient = require('pa11y-webservice-client-node');
module.exports = createWebserviceClient;
// Create a webservice client
function createWebserviceClient(config) {
let webserviceUrl = config.webservice;
if (typeof webserviceUrl === 'object') {
webserviceUrl = `http://${webserviceUrl.host}:${webserviceUrl.port}/`;
}
return createClient(webserviceUrl);
}

8
test/integration/route/index.js
View File

@@ -12,14 +12,11 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe.only('GET /', function() {
describe('GET /', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
@@ -94,7 +91,7 @@ describe.only('GET /', function() {
assert.match(tasks.eq(0).text(), /3\s*notices/i);
});
it('should display a message indicating that there are no results if the task has not been run', function() {
it('should indicate there are no results if the task has not been run', function() {
const tasks = this.last.dom('[data-test=task]');
assert.match(tasks.eq(2).text(), /no results/i);
});
@@ -102,5 +99,4 @@ describe.only('GET /', function() {
it('should not display an alert message', function() {
assert.strictEqual(this.last.dom('[data-test=alert]').length, 0);
});
});

43
test/integration/route/new.js
View File

@@ -12,20 +12,16 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /new', function() {
beforeEach(function(done) {
const request = {
this.navigate({
method: 'GET',
endpoint: '/new'
};
this.navigate(request, done);
}, done);
});
it('should send a 200 status', function() {
@@ -44,7 +40,6 @@ describe('GET /new', function() {
});
describe('"Add New URL" form', function() {
beforeEach(function() {
this.form = this.last.dom('[data-test=new-url-form]').eq(0);
});
@@ -92,7 +87,7 @@ describe('GET /new', function() {
it('should have a "standard" field', function() {
const field = this.form.find('select[name=standard]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.find('option').length, 4);
assert.greaterThanOrEqual(field.find('option').length, 1);
});
it('should have "ignore" fields', function() {
@@ -112,15 +107,11 @@ describe('GET /new', function() {
const field = this.form.find('textarea[name=headers]').eq(0);
assert.isDefined(field);
});
});
});
describe('POST /new', function() {
describe('with invalid query', function() {
beforeEach(function(done) {
const request = {
method: 'POST',
@@ -140,13 +131,10 @@ describe('POST /new', function() {
it('should display an error message', function() {
assert.strictEqual(this.last.dom('[data-test=error]').length, 1);
});
});
describe('with valid query', function() {
beforeEach(function(done) {
const request = {
const requestOptions = {
method: 'POST',
endpoint: '/new',
form: {
@@ -155,7 +143,9 @@ describe('POST /new', function() {
standard: 'WCAG2AA'
}
};
this.navigate(request, done);
beforeEach(function(done) {
this.navigate(requestOptions, done);
});
it('should send a 200 status', function() {
@@ -163,9 +153,18 @@ describe('POST /new', function() {
});
it('should create the task', function(done) {
this.webservice.tasks.get({}, function(error, tasks) {
assert.strictEqual(tasks.length, 4);
done(error);
const getTaskCount = then =>
this.webservice.tasks.get({}, (error, tasks) => {
then(tasks.length);
});
getTaskCount(firstTaskCount => {
this.navigate(requestOptions, () => {
getTaskCount(secondTaskCount => {
assert.strictEqual(secondTaskCount, firstTaskCount + 1);
done();
});
});
});
});
@@ -180,9 +179,7 @@ describe('POST /new', function() {
it('should display a success message', function() {
const alert = this.last.dom('[data-test=alert]').eq(0);
assert.isDefined(alert);
assert.match(alert.textContent, /url has been added/i);
assert.match(alert.text(), /url has been added/i);
});
});
});

6
test/integration/route/result/download.js
View File

@@ -12,14 +12,11 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /<task-id>/<result-id>.csv', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
@@ -36,11 +33,9 @@ describe('GET /<task-id>/<result-id>.csv', function() {
it('should output CSV results', function() {
assert.match(this.last.body, /^"code","message","type"/);
});
});
describe('GET /<task-id>/<result-id>.json', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
@@ -64,5 +59,4 @@ describe('GET /<task-id>/<result-id>.json', function() {
assert.strictEqual(json.count.notice, 3);
assert.isArray(json.results);
});
});

12
test/integration/route/result/index.js
View File

@@ -12,8 +12,6 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
@@ -35,13 +33,19 @@ describe('GET /<task-id>/<result-id>', function() {
it('should display a "Download CSV" button', function() {
const elem = this.last.dom('[data-test=download-csv]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem.eq(0).attr('href'), '/abc000000000000000000001/def000000000000000000001.csv');
assert.strictEqual(
elem.eq(0).attr('href'),
'/abc000000000000000000001/def000000000000000000001.csv'
);
});
it('should display a "Download JSON" button', function() {
const elem = this.last.dom('[data-test=download-json]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem.eq(0).attr('href'), '/abc000000000000000000001/def000000000000000000001.json');
assert.strictEqual(
elem.eq(0).attr('href'),
'/abc000000000000000000001/def000000000000000000001.json'
);
});
it('should display a link back to the task', function() {

2
test/integration/route/task/delete.js
View File

@@ -12,8 +12,6 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');

12
test/integration/route/task/edit.js
View File

@@ -12,20 +12,16 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /<task-id>/edit', function() {
beforeEach(function(done) {
const request = {
this.navigate({
method: 'GET',
endpoint: '/abc000000000000000000001/edit'
};
this.navigate(request, done);
}, done);
});
it('should send a 200 status', function() {
@@ -113,13 +109,10 @@ describe('GET /<task-id>/edit', function() {
assert.isDefined(fields);
assert.notStrictEqual(fields.length, 0);
});
});
});
describe('POST /<task-id>/edit', function() {
beforeEach(function(done) {
const request = {
method: 'POST',
@@ -153,5 +146,4 @@ describe('POST /<task-id>/edit', function() {
assert.isDefined(alert);
assert.match(alert.text(), /been saved/i);
});
});

13
test/integration/route/task/index.js
View File

@@ -12,22 +12,17 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /<task-id>', function() {
describe('when task has results', function() {
beforeEach(function(done) {
const request = {
this.navigate({
method: 'GET',
endpoint: '/abc000000000000000000001'
};
this.navigate(request, done);
}, done);
});
it('should send a 200 status', function() {
@@ -76,11 +71,9 @@ describe('GET /<task-id>', function() {
assert.isDefined(elem);
assert.match(elem.text(), /notices \( 3 \)/i);
});
});
describe('when task has no results', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
@@ -104,7 +97,5 @@ describe('GET /<task-id>', function() {
assert.isDefined(alert);
assert.match(alert.text(), /there are no results to show/i);
});
});
});

7
test/integration/route/task/run.js
View File

@@ -12,8 +12,6 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
@@ -21,11 +19,10 @@ const assert = require('proclaim');
describe('GET /<task-id>/run', function() {
beforeEach(function(done) {
const request = {
this.navigate({
method: 'GET',
endpoint: '/abc000000000000000000001/run'
};
this.navigate(request, done);
}, done);
});
it('should send a 200 status', function() {

69
test/integration/setup.js
View File

@@ -12,39 +12,54 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable requireArrowFunctions
'use strict';
const config = require('../../config/test.json');
const {promisify} = require('util');
const createNavigator = require('./helper/navigate');
const createWebserviceClient = require('./helper/webservice');
const loadFixtures = require('pa11y-webservice/data/fixture/load');
const request = require('request');
const createWebserviceClient = require('pa11y-webservice-client-node');
const fetch = require('node-fetch');
const loadFixtures = promisify(require('pa11y-webservice/data/fixture/load'));
const config = {
host: process.env.HOST || '0.0.0.0',
port: Number(process.env.PORT) || 4000,
noindex: true,
readonly: false
};
const webserviceConfig = {
database: process.env.WEBSERVICE_DATABASE || 'mongodb://127.0.0.1/pa11y-dashboard-integration-test',
host: process.env.WEBSERVICE_HOST || '0.0.0.0',
port: Number(process.env.WEBSERVICE_PORT) || 3000,
dbOnly: true
};
async function assertDashboardIsAvailable(baseUrl) {
try {
const response = await fetch(baseUrl);
if (!response.ok) {
console.error('Service found but returned an error. HTTP status:', response.status);
throw Error();
}
} catch (error) {
console.error('Service under test not found or returned error.');
throw error;
}
}
before(async function() {
this.baseUrl = `http://${config.host}:${config.port}`;
await assertDashboardIsAvailable(this.baseUrl);
await loadFixtures('test', webserviceConfig);
this.webservice = createWebserviceClient(`http://${webserviceConfig.host}:${webserviceConfig.port}/`);
// Run before all tests
before(function(done) {
this.baseUrl = `http://localhost:${config.port}`;
this.last = {};
this.navigate = createNavigator(this.baseUrl, this.last);
this.webservice = createWebserviceClient(config);
assertTestAppIsRunning(this.baseUrl, () => {
loadFixtures('test', config.webservice, done);
});
});
// Run after each test
afterEach(function(done) {
loadFixtures('test', config.webservice, done);
afterEach(async function() {
await loadFixtures('test', webserviceConfig);
});
// Check that the test application is running, and exit if not
function assertTestAppIsRunning(url, done) {
request(url, error => {
if (error) {
console.error('Error: Test app not started; run with `NODE_ENV=test node index.js`');
process.exit(1);
}
done();
});
}

7
view/presenter/result-list.js
View File

@@ -14,17 +14,18 @@
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
const _ = require('underscore');
const groupBy = require('lodash.groupby');
const keys = require('lodash.keys');
const moment = require('moment');
module.exports = presentResultList;
function presentResultList(results) {
const resultsByDay = _.groupBy(results, result => {
const resultsByDay = groupBy(results, result => {
return moment(result.date).format('YYYY-MM-DD');
});
const uniqueDayResults = [];
_.keys(resultsByDay).forEach(day => {
keys(resultsByDay).forEach(day => {
uniqueDayResults.push(resultsByDay[day][0]);
});
return uniqueDayResults;

9
view/presenter/result.js
View File

@@ -14,7 +14,8 @@
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
const _ = require('underscore');
const groupBy = require('lodash.groupby');
const keys = require('lodash.keys');
const presentIgnoreRules = require('./ignore');
const techs = require('../../data/techniques')();
@@ -35,12 +36,12 @@ function presentResult(result) {
// Split out message types
if (result.results) {
const groupedByType = _.groupBy(result.results, 'type');
const groupedByType = groupBy(result.results, 'type');
['error', 'warning', 'notice'].forEach(type => {
const pluralType = `${type}s`;
const results = groupedByType[type] || [];
const groupedByCode = _.groupBy(results, 'code');
result[pluralType] = _.keys(groupedByCode).map(group => {
const groupedByCode = groupBy(results, 'code');
result[pluralType] = keys(groupedByCode).map(group => {
const groupMessage = groupedByCode[group][0];
groupMessage.count = groupedByCode[group].length;
groupMessage.items = groupedByCode[group].map(plural => ({