Compare commits

..

46 Commits
2.0.0 ... 2.2.2

Author SHA1 Message Date
Jose Bolos
defb044f19 Version 2.2.2 2017-03-23 09:06:29 +00:00
Snyk bot
8f6ef9f204 fix: package.json to reduce vulnerabilities (#185)
The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/npm:qs:20170213
- https://snyk.io/vuln/npm:qs:20170213

Latest report for pa11y/dashboard:
https://snyk.io/test/github/pa11y/dashboard
2017-03-23 09:00:24 +00:00
Rowan Manning
b24076abf1 Tooling update (#184)
* Use a common Makefile/build process

* Use ESLint with the pa11y lint config
2017-03-21 13:41:46 +00:00
Snyk bot
e27e129677 fix: package.json to reduce vulnerabilities (#179)
The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/npm:moment:20161019

Latest report for pa11y/dashboard:
https://snyk.io/test/github/pa11y/dashboard
2017-02-20 15:16:48 +00:00
Rowan Manning
f7c3b5e99a Version 2.2.1 2017-02-07 13:21:23 +00:00
Rowan Manning
2ec9139ab0 Fix task editing when no actions are specified (#178) 2017-02-07 13:20:36 +00:00
Rowan Manning
ce9219c01e Version 2.2.0 2017-01-27 11:14:26 +00:00
Rowan Manning
28a0a861f3 Add support for Pa11y actions (#176) 2017-01-27 10:58:48 +00:00
Rowan Manning
acba762a66 Update missed copyright reference (#174) 2017-01-19 13:45:25 +00:00
Rowan Manning
9b80bfa6ab Update the copyright notice and author (#173) 2017-01-19 13:32:17 +00:00
Jose Bolos
926cb5af3b Change support details for v1 of dashboard (#172) 2017-01-18 14:46:30 +00:00
Hollie Kay
503ed16265 Remove phantom reference (#170) 2017-01-10 11:36:19 +00:00
Rowan Manning
6d0c6e821b Version 2.1.2 2016-12-12 11:49:01 +00:00
Usman Iqbal
cc5b3f19e5 Remove Add new URL button when readonly is true (#166) 2016-12-12 11:47:04 +00:00
Rowan Manning
11e64e27c4 Add a contributing guide (#163) 2016-12-01 15:04:30 +00:00
Rowan Manning
ff4a9fa7b0 Use two spaces in package.json (#162) 2016-11-25 13:25:47 +00:00
Rowan Manning
5bc32fc68e Version 2.1.1 2016-11-20 18:56:21 +00:00
Frank van Gemeren
c2fbcf4fa1 Use arrows instead of plus and minus for collapsibles/expanders (#153) 2016-11-19 00:18:24 +00:00
Una Kravets
f60d1ca0ce more detailed 500 message (#159) 2016-11-19 00:17:34 +00:00
Rowan Manning
227de3638a Version 2.1.0 2016-11-07 15:03:19 +00:00
Rowan Manning
79c849d42b Use the latest Pa11y webservice 2016-11-07 14:58:15 +00:00
Rowan Manning
8195c5d2c5 Fix lint errors 2016-11-07 14:58:15 +00:00
Rowan Manning
568e068613 Parse task headers as HTTP headers rather than JSON 2016-11-07 14:58:15 +00:00
Rowan Manning
ee729d1d55 Write integration tests for hideElements and headers 2016-11-07 14:58:15 +00:00
Rowan Manning
509914d19a Fix the hideElements option
I broke this with my incorrect advice :D
2016-11-07 14:58:15 +00:00
Laura Carvajal
9df456c7c1 hide-elements and placeholders 2016-11-07 14:58:15 +00:00
Laura Carvajal
36dad55bb8 restore config filename 2016-11-07 14:58:15 +00:00
Laura Carvajal
39435f37e4 header and hide fields 2016-11-07 14:58:15 +00:00
Rowan Manning
c562bb07f3 Make optional fields optional (#154)
This fixes an issue that required people to manually specify a timeout
and wait for their tasks when they're created.
2016-11-07 14:06:12 +00:00
Frank van Gemeren
2976d5e391 Better client-side validation (#152) 2016-11-07 13:36:20 +00:00
Laura Carvajal
344efb9da3 allow for .js config 2016-10-20 14:15:55 +01:00
Hollie Kay
c2b1b1d1a1 Merge pull request #148 from pa11y/troubleshooting
add troubleshooting guide and link on the index page
2016-10-06 17:00:44 +01:00
hollsk
8c4517c830 put the links and refs the right way around 2016-10-06 17:12:50 +01:00
hollsk
40b6e79f81 add troubleshooting guide and link on the index page 2016-10-06 16:40:22 +01:00
Jose Bolos
02ce731e83 Version 2.0.1 2016-09-12 14:09:38 +01:00
Jose Bolos
4f46351d68 Merge pull request #143 from pa11y/secfixes
Update several packages in order to fix several vulns
2016-09-12 13:58:30 +01:00
Jose Bolos
ee7795a7a9 Merge pull request #144 from pa11y/license
Add license field to package.json
2016-09-09 14:09:43 +01:00
Jose Bolos
3a3cca881a Add license field to package.json 2016-09-09 12:58:55 +01:00
Jose Bolos
fa0c523e3f Require webservice-client-node 1.2.1 or greater
Fixes https://nodesecurity.io/advisories/130
2016-09-09 12:52:11 +01:00
Jose Bolos
36a677948b Upgrade mocha to version 3 2016-09-09 12:27:42 +01:00
Jose Bolos
22aab6bee2 Require request 2.74 or greater
Fixes https://nodesecurity.io/advisories/130
2016-09-09 12:27:09 +01:00
Jose Bolos
a30e82d5be Require webservice 2.0.1 or greater
Addresses the following vulns present on 2.0.0:
* https://nodesecurity.io/advisories/45
* https://nodesecurity.io/advisories/63
* https://nodesecurity.io/advisories/65
* https://nodesecurity.io/advisories/121
2016-09-09 12:22:34 +01:00
Jose Bolos
71432a3063 Upgrade express to 4.14 or greater
Prevents https://nodesecurity.io/advisories/106
2016-09-09 12:19:28 +01:00
Rowan Manning
6cd7630049 Merge pull request #141 from pa11y/digitial
Fix a typo in link text
2016-08-15 09:09:32 +01:00
Jose Bolos
979f7f244b Fix a typo in link text 2016-08-15 08:02:48 +01:00
Rowan Manning
e431fefbd8 Use the ES6 linting rules from the website (#138) 2016-07-22 14:34:10 +01:00
52 changed files with 857 additions and 587 deletions

View File

@@ -1,3 +1,2 @@
coverage
node_modules
public/js

3
.eslintrc.js Normal file
View File

@@ -0,0 +1,3 @@
'use strict';
module.exports = require('pa11y-lint-config/eslint/es6');

88
.jscsrc
View File

@@ -1,88 +0,0 @@
{
"disallowEmptyBlocks": true,
"disallowImplicitTypeConversion": [
"binary",
"numeric",
"string"
],
"disallowKeywordsOnNewLine": [
"catch",
"else"
],
"disallowMixedSpacesAndTabs": true,
"disallowMultipleSpaces": true,
"disallowMultipleVarDecl": true,
"disallowNewlineBeforeBlockStatements": true,
"disallowQuotedKeysInObjects": true,
"disallowSpaceAfterObjectKeys": true,
"disallowSpaceAfterPrefixUnaryOperators": true,
"disallowSpaceBeforeComma": true,
"disallowSpaceBeforeSemicolon": true,
"disallowSpacesInCallExpression": true,
"disallowSpacesInFunction": {
"beforeOpeningRoundBrace": true
},
"disallowSpacesInsideArrayBrackets": true,
"disallowSpacesInsideBrackets": true,
"disallowSpacesInsideObjectBrackets": true,
"disallowSpacesInsideParentheses": true,
"disallowTrailingComma": true,
"disallowTrailingWhitespace": true,
"disallowYodaConditions": true,
"maximumLineLength": 200,
"requireBlocksOnNewline": true,
"requireCapitalizedConstructors": true,
"requireCommaBeforeLineBreak": true,
"requireCurlyBraces": [
"if",
"else",
"for",
"while",
"do",
"switch",
"try",
"catch"
],
"requireDotNotation": true,
"requireLineBreakAfterVariableAssignment": true,
"requireLineFeedAtFileEnd": true,
"requireObjectKeysOnNewLine": true,
"requireParenthesesAroundIIFE": true,
"requireSemicolons": true,
"requireSpaceAfterBinaryOperators": true,
"requireSpaceAfterKeywords": [
"if",
"else",
"for",
"while",
"do",
"switch",
"try",
"catch"
],
"requireSpaceAfterLineComment": {
"allExcept": [
"="
]
},
"requireSpaceBeforeBinaryOperators": true,
"requireSpaceBeforeBlockStatements": true,
"requireSpaceBeforeObjectValues": true,
"requireSpaceBetweenArguments": true,
"requireSpacesInConditionalExpression": true,
"requireSpacesInForStatement": true,
"requireSpacesInFunction": {
"beforeOpeningCurlyBrace": true
},
"validateIndentation": "\t",
"validateLineBreaks": "LF",
"validateNewlineAfterArrayElements": true,
"validateParameterSeparator": ", ",
"validateQuoteMarks": "'",
"excludeFiles": [
"coverage",
"node_modules",
"public/js"
]
}

View File

@@ -1,29 +0,0 @@
{
"browser": true,
"curly": true,
"eqeqeq": true,
"forin": true,
"globals": {
"after": true,
"afterEach": true,
"before": true,
"beforeEach": true,
"describe": true,
"it": true
},
"latedef": "nofunc",
"maxcomplexity": 6,
"maxdepth": 2,
"maxparams": 4,
"noarg": true,
"node": true,
"nonew": true,
"nonstandard": true,
"regexp": true,
"shadow": true,
"strict": true,
"sub": true,
"trailing": true,
"undef": true,
"unused": true
}

View File

@@ -1,6 +1,55 @@
# Changelog
## 2.2.2 (2017-03-23)
* Upgrades `body-parser` and `express`. Fixes a vulnerability in `qs`: https://snyk.io/vuln/npm:qs:20170213
## 2.2.1 (2017-02-07)
* Fix task editing when no actions are specified
## 2.2.0 (2017-01-27)
* Add support for Pa11y actions
* Update dependencies
* pa11y-webservice: ~2.1.2 to ^2.3.0
## 2.1.2 (2016-12-12)
* Hide the "add" button in readonly mode
* Add a contributing guide
## 2.1.1 (2016-11-20)
* Use arrows instead of plus and minus for collapsibles/expanders
* Supply more detailed 500 messages
## 2.1.0 (2016-11-07)
* Allow for configuration files to be JavaScript rather than JSON
* Allow setting of HTTP headers for task runs
* Allow hiding/ignoring elements for task runs
* Update dependencies and devDependencies
* pa11y-webservice: ~2.0.1 to ^2.1.2
* mocha: ^3 to ^2 (temporary tests weren't running)
## 2.0.1 (2016-09-12)
* Update dependencies and devDependencies
* express: ~4.13 to ~4.14
* pa11y-webservice: ~2.0 to ^2.0.1
* request: ^2 to ^2.74
* mocha: ^2 to ^3
* pa11y-webservice-client-node: ~1.2 to ^1.2.1
This fixes the following vulnerabilities:
* https://nodesecurity.io/advisories/45
* https://nodesecurity.io/advisories/63
* https://nodesecurity.io/advisories/65
* https://nodesecurity.io/advisories/106
* https://nodesecurity.io/advisories/121
* https://nodesecurity.io/advisories/130
## 2.0.0 (2016-06-05)
* Drop Node.js 0.100.12 support

21
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,21 @@
Contributing Guide
==================
Thanks for getting involved :tada:
The Pa11y team loves to see new contributors, and we strive to provide a welcoming and inclusive environment. We ask that all contributors read and follow [our code of conduct][code-of-conduct] before joining. If you represent an organisation, then you might find our [guide for companies][companies] helpful.
Our website outlines the many ways that you can contribute to Pa11y:
- [Help us to talk to our users][communications]
- [Help us out with design][designers]
- [Help us with our code][developers]
[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/

View File

@@ -1,47 +1,27 @@
include Makefile.node
# Color helpers
C_CYAN=\x1b[34;01m
C_RESET=\x1b[0m
# We need to run integration tests recursively
export INTEGRATION_FLAGS := --recursive
# Group targets
all: deps lint test
ci: lint test
# Install dependencies
deps:
@echo "$(C_CYAN)> installing dependencies$(C_RESET)"
@npm install
# Verify tasks
# ------------
# Lint JavaScript
lint: jshint jscs
# Lint alias for backwards compatibility
lint: verify
# Run JSHint
jshint:
@echo "$(C_CYAN)> linting javascript$(C_RESET)"
@./node_modules/.bin/jshint .
# Run JavaScript Code Style
jscs:
@echo "$(C_CYAN)> checking javascript code style$(C_RESET)"
@./node_modules/.bin/jscs .
# Run all tests
test: test-integration
# Run integration tests
test-integration:
@echo "$(C_CYAN)> running integration tests$(C_RESET)"
@./node_modules/.bin/mocha ./test/integration --reporter spec --recursive --timeout 5000 --slow 50
# Client-side asset tasks
# -----------------------
# Compile LESS
less:
@echo "$(C_CYAN)> compiling less$(C_RESET)"
@./node_modules/.bin/lessc -x ./public/less/main.less ./public/css/site.min.css
@lessc -x ./public/less/main.less ./public/css/site.min.css
@$(TASK_DONE)
# Compile client-side JavaScript
uglify:
@echo "$(C_CYAN)> compiling client-side JavaScript$(C_RESET)"
@./node_modules/.bin/uglifyjs \
@uglifyjs \
public/js/vendor/jquery/jquery.min.js \
public/js/vendor/bootstrap/js/alert.js \
public/js/vendor/bootstrap/js/dropdown.js \
@@ -55,5 +35,4 @@ uglify:
public/js/vendor/flot/jquery.flot.resize.js \
public/js/site.js \
-o ./public/js/site.min.js
.PHONY: test
@$(TASK_DONE)

125
Makefile.node Normal file
View File

@@ -0,0 +1,125 @@
#
# 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 := 5000
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)

View File

@@ -22,7 +22,7 @@ Pa11y Dashboard is a web interface to the [Pa11y][pa11y] accessibility reporter;
Setup
-----
Pa11y Dashboard requires [Node.js][node] 4+ and [PhantomJS][phantom]. See the [Pa11y][pa11y] documentation for detailed instructions on how to install these dependencies on your operating system.
Pa11y Dashboard requires [Node.js][node] 4+. See the [Pa11y][pa11y] documentation for detailed instructions on how to install this on your operating system.
You'll also need to have [MongoDB][mongo] installed and running. See the [MongoDB install guide][mongo-install] for more information on this.
@@ -58,6 +58,8 @@ NODE_ENV=development node index.js
See [development instructions](#development) for more information about running locally (and restarting automatically when files change).
If you run into problems, check the [troubleshooting guide][troubleshooting].
Configurations
--------------
@@ -80,27 +82,25 @@ The boot configurations for Pa11y Dashboard are as follows. Look at the sample J
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_`.
Development
-----------
Contributing
------------
To develop Pa11y Dashboard, you'll need to clone the repo and get set up as outlined in the [setup guide](#setup).
There are many ways to contribute to Pa11y Dashboard, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.
You'll 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](#setup). You'll then need to start the application in test mode with:
```sh
NODE_ENV=test node index.js
```
Now you'll be able to run the following commands:
You'll now be able to run the following commands:
```sh
make # Run the lint and test tasks together
make lint # Run linters with the correct config
make test # Run integration tests
make verify # Verify all of the code (ESLint)
make test # Run all tests
make test-integration # Run the integration tests
```
Code with lint errors or failing tests will not be accepted, please use the build tools outlined above.
To compile the client-side JavaScript and CSS, you'll need the following commands. Compiled code is committed to the repository.
```sh
@@ -111,7 +111,7 @@ make uglify # Compile and uglify the client-side JavaScript
Useful Resources
-------
* [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitialOcean][resource-una-k]
* [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitalOcean][resource-una-k]
Support and Migration
@@ -124,7 +124,7 @@ We also maintain a [migration guide](MIGRATION.md) to help you migrate.
| :grey_question: | Major Version | Last Minor Release | Node.js Versions | Support End Date |
| :-------------- | :------------ | :----------------- | :--------------- | :--------------- |
| :heart: | 2 | N/A | 4+ | N/A |
| :hourglass: | 1 | 1.12 | 0.106 | 2016-12-05 |
| :skull: | 1 | 1.12 | 0.106 | 2016-12-05 |
If you're opening issues related to these, please mention the version that the issue relates to.
@@ -132,8 +132,8 @@ If you're opening issues related to these, please mention the version that the i
License
-------
Pa11y Dashboard is licensed under the [GNU General Public License 3.0][info-license].
Copyright © 20132016, Springer Nature
Pa11y Dashboard is licensed under the [GNU General Public License 3.0][info-license].<br/>
Copyright &copy; 20132017, Team Pa11y
@@ -148,11 +148,12 @@ Copyright &copy; 20132016, Springer Nature
[sidekick-proposal]: https://github.com/pa11y/sidekick/blob/master/PROPOSAL.md
[travis]: https://travis-ci.org/pa11y/dashboard
[travis-img]: https://travis-ci.org/pa11y/dashboard.png?branch=master
[troubleshooting]: https://github.com/pa11y/dashboard/blob/master/TROUBLESHOOTING.md
[info-license]: LICENSE
[info-node]: package.json
[info-build]: https://travis-ci.org/pa11y/dashboard
[shield-license]: https://img.shields.io/badge/license-GPL%203.0-blue.svg
[shield-node]: https://img.shields.io/badge/node.js%20support-46-brightgreen.svg
[shield-version]: https://img.shields.io/badge/version-2.0.0-blue.svg
[shield-version]: https://img.shields.io/badge/version-2.2.1-blue.svg
[shield-build]: https://img.shields.io/travis/pa11y/dashboard/master.svg

27
TROUBLESHOOTING.md Normal file
View File

@@ -0,0 +1,27 @@
Troubleshooting
===============
Common issues
-----
* `500` errors or `Could not connect to pa11y-webservice` messages are often related to MongoDB. Ensure that you have the [latest version of MongoDB][mongo-install] 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.
Check to see if the issue has been reported
-----
* Check the [issue tracker][issues] for similar issues.
Create an issue
-----
If all else fails, [create an issue][create-issue] and we'll help you. Please include your node.js, Phantom, and MongoDB version numbers, and your operating system.
[issues]: https://github.com/pa11y/dashboard/issues?utf8=%E2%9C%93&q=is%3Aissue
[mongo-install]: https://docs.mongodb.org/manual/installation/
[create-issue]: https://github.com/pa11y/dashboard/issues/new

69
app.js
View File

@@ -12,17 +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/>.
'use strict';
var bodyParser = require('body-parser');
var compression = require('compression');
var createClient = require('pa11y-webservice-client-node');
var EventEmitter = require('events').EventEmitter;
var express = require('express');
var hbs = require('express-hbs');
var http = require('http');
var pkg = require('./package.json');
const bodyParser = require('body-parser');
const compression = require('compression');
const createClient = require('pa11y-webservice-client-node');
const EventEmitter = require('events').EventEmitter;
const express = require('express');
const hbs = require('express-hbs');
const http = require('http');
const pkg = require('./package.json');
module.exports = initApp;
@@ -30,12 +29,12 @@ module.exports = initApp;
function initApp(config, callback) {
config = defaultConfig(config);
var webserviceUrl = config.webservice;
let webserviceUrl = config.webservice;
if (typeof webserviceUrl === 'object') {
webserviceUrl = 'http://' + webserviceUrl.host + ':' + webserviceUrl.port + '/';
webserviceUrl = `http://${webserviceUrl.host}:${webserviceUrl.port}/`;
}
var app = new EventEmitter();
const app = new EventEmitter();
app.address = null;
app.express = express();
app.server = http.createServer(app.express);
@@ -45,7 +44,7 @@ function initApp(config, callback) {
app.express.use(compression());
// Public files
app.express.use(express.static(__dirname + '/public', {
app.express.use(express.static(`${__dirname}/public`, {
maxAge: (process.env.NODE_ENV === 'production' ? 604800000 : 0)
}));
@@ -59,11 +58,11 @@ function initApp(config, callback) {
app.express.engine('html', hbs.express4({
extname: '.html',
contentHelperName: 'content',
layoutsDir: __dirname + '/view/layout',
partialsDir: __dirname + '/view/partial',
defaultLayout: __dirname + '/view/layout/default'
layoutsDir: `${__dirname}/view/layout`,
partialsDir: `${__dirname}/view/partial`,
defaultLayout: `${__dirname}/view/layout/default`
}));
app.express.set('views', __dirname + '/view');
app.express.set('views', `${__dirname}/view`);
app.express.set('view engine', 'html');
// View helpers
@@ -84,9 +83,9 @@ function initApp(config, callback) {
settings: {}
};
app.express.use(function(req, res, next) {
res.locals.isHomePage = (req.path === '/');
res.locals.host = req.hostname;
app.express.use((request, response, next) => {
response.locals.isHomePage = (request.path === '/');
response.locals.host = request.hostname;
next();
});
@@ -105,27 +104,27 @@ function initApp(config, callback) {
}
// Error handling
app.express.get('*', function(req, res) {
res.status(404);
res.render('404');
app.express.get('*', (request, response) => {
response.status(404);
response.render('404');
});
app.express.use(function(err, req, res, next) {
/* jshint unused: false */
if (err.code === 'ECONNREFUSED') {
err = new Error('Could not connect to Pa11y Webservice');
app.express.use((error, request, response, next) => {
/* eslint no-unused-vars: 'off' */
if (error.code === 'ECONNREFUSED') {
error = new Error('Could not connect to Pa11y Webservice');
}
app.emit('route-error', err);
app.emit('route-error', error);
if (process.env.NODE_ENV !== 'production') {
res.locals.error = err;
response.locals.error = error;
}
res.status(500);
res.render('500');
response.status(500);
response.render('500');
});
app.server.listen(config.port, function(err) {
var address = app.server.address();
app.address = 'http://' + address.address + ':' + address.port;
callback(err, app);
app.server.listen(config.port, error => {
const address = app.server.address();
app.address = `http://${address.address}:${address.port}`;
callback(error, app);
});
}

View File

@@ -12,14 +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/>.
'use strict';
var fs = require('fs');
var jsonPath = './config/' + (process.env.NODE_ENV || 'development') + '.json';
const fs = require('fs');
const environment = (process.env.NODE_ENV || 'development');
const jsonPath = `./config/${environment}.json`;
const jsPath = `./config/${environment}.js`;
if (fs.existsSync(jsonPath)) {
module.exports = require(jsonPath);
} else if (fs.existsSync(jsPath)) {
module.exports = require(jsPath);
} else {
module.exports = {
port: Number(env('PORT', '4000')),
@@ -36,6 +39,6 @@ if (fs.existsSync(jsonPath)) {
}
function env(name, defaultValue) {
var value = process.env[name];
const value = process.env[name];
return typeof value === 'string' ? value : defaultValue;
}

8
data/.eslintrc.js Normal file
View File

@@ -0,0 +1,8 @@
'use strict';
// Clone the main config
var config = module.exports = JSON.parse(JSON.stringify(require('../.eslintrc')));
// Disable max line length/statements
config.rules['max-len'] = 'off';
config.rules['max-statements'] = 'off';

View File

@@ -12,27 +12,30 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var chalk = require('chalk');
var config = require('./config');
const chalk = require('chalk');
const config = require('./config');
process.on('SIGINT', function() {
process.on('SIGINT', () => {
console.log('\nGracefully shutting down from SIGINT (Ctrl-C)');
process.exit();
});
require('./app')(config, function(err, app) {
require('./app')(config, (error, app) => {
if (error) {
console.error(error.stack);
process.exit(1);
}
console.log('');
console.log(chalk.underline.magenta('Pa11y Dashboard started'));
console.log(chalk.grey('mode: %s'), process.env.NODE_ENV);
console.log(chalk.grey('uri: %s'), app.address);
app.on('route-error', function(err) {
var stack = (err.stack ? err.stack.split('\n') : [err.message]);
var msg = chalk.red(stack.shift());
app.on('route-error', error => {
const stack = (error.stack ? error.stack.split('\n') : [error.message]);
const msg = chalk.red(stack.shift());
console.error('');
console.error(msg);
console.error(chalk.grey(stack.join('\n')));
@@ -40,7 +43,12 @@ require('./app')(config, function(err, app) {
// Start the webservice if required
if (typeof config.webservice === 'object') {
require('pa11y-webservice')(config.webservice, function(err, webservice) {
require('pa11y-webservice')(config.webservice, (error, webservice) => {
if (error) {
console.error(error.stack);
process.exit(1);
}
console.log('');
console.log(chalk.underline.cyan('Pa11y Webservice started'));
console.log(chalk.grey('mode: %s'), process.env.NODE_ENV);

View File

@@ -1,50 +1,53 @@
{
"name": "pa11y-dashboard",
"version": "2.0.0",
"private": true,
"description": "Pa11y Dashboard is a visual web interface to the Pa11y accessibility reporter",
"keywords": [ "accessibility", "analysis", "report" ],
"contributors": [
"Perry Harlock (http://www.phwebs.co.uk/)",
"Rowan Manning (http://rowanmanning.com/)"
],
"repository": {
"type": "git",
"url": "https://github.com/pa11y/dashboard.git"
},
"homepage": "https://github.com/pa11y/dashboard",
"bugs": "https://github.com/pa11y/dashboard/issues",
"engines": {
"node": ">=4"
},
"dependencies": {
"body-parser": "~1.15",
"chalk": "~1.1",
"compression": "~1.6",
"express": "~4.13",
"express-hbs": "~1.0",
"moment": "~2.13",
"pa11y-webservice": "~2.0",
"pa11y-webservice-client-node": "~1.2",
"underscore": "~1.8"
},
"devDependencies": {
"bower": "~1.7",
"cheerio": "~0.20",
"jscs": "^2",
"jshint": "^2",
"less": "~2.7",
"mocha": "^2",
"proclaim": "^3",
"request": "^2",
"uglify-js": "~2.6"
},
"scripts": {
"start": "node index.js",
"test": "make ci"
}
"name": "pa11y-dashboard",
"version": "2.2.2",
"private": true,
"description": "Pa11y Dashboard is a visual web interface to the Pa11y accessibility reporter",
"keywords": [
"accessibility",
"analysis",
"report"
],
"author": "Team Pa11y",
"contributors": [
"Perry Harlock (http://www.phwebs.co.uk/)",
"Rowan Manning (http://rowanmanning.com/)"
],
"repository": {
"type": "git",
"url": "https://github.com/pa11y/dashboard.git"
},
"homepage": "https://github.com/pa11y/dashboard",
"bugs": "https://github.com/pa11y/dashboard/issues",
"license": "GPL-3.0",
"engines": {
"node": ">=4"
},
"dependencies": {
"body-parser": "~1.17.1",
"chalk": "~1.1",
"compression": "~1.6",
"express": "~4.15.2",
"express-hbs": "~1.0",
"http-headers": "^3.0.1",
"moment": "~2.15.2",
"pa11y-webservice": "^2.3.0",
"pa11y-webservice-client-node": "^1.2.1",
"underscore": "~1.8"
},
"devDependencies": {
"bower": "~1.7",
"cheerio": "~0.20",
"eslint": "^3.18.0",
"less": "~2.7",
"mocha": "^2",
"pa11y-lint-config": "^1.0.0",
"proclaim": "^3",
"request": "^2.74",
"uglify-js": "~2.6"
},
"scripts": {
"start": "node index.js",
"test": "make ci"
}
}

View File

@@ -77,11 +77,11 @@ $(document).ready(function(){
expandLink.click( function(){
$(this).next().slideToggle('slow', function(){});
if ($(this).hasClass('showing')) {
$(this).find('span.expander').html('+');
$(this).find('span.expander').html('');
$(this).attr('aria-expanded', false);
}
else {
$(this).find('span.expander').html('-');
$(this).find('span.expander').html('');
$(this).attr('aria-expanded', true);
}
$(this).toggleClass('showing');

File diff suppressed because one or more lines are too long

View File

@@ -12,23 +12,22 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var presentTask = require('../view/presenter/task');
const presentTask = require('../view/presenter/task');
module.exports = route;
// Route definition
function route(app) {
app.express.get('/', function(req, res, next) {
app.webservice.tasks.get({lastres: true}, function(err, tasks) {
if (err) {
return next(err);
app.express.get('/', (request, response, next) => {
app.webservice.tasks.get({lastres: true}, (error, tasks) => {
if (error) {
return next(error);
}
res.render('index', {
response.render('index', {
tasks: tasks.map(presentTask),
deleted: (typeof req.query.deleted !== 'undefined'),
deleted: (typeof request.query.deleted !== 'undefined'),
isHomePage: true
});
});

View File

@@ -12,47 +12,68 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var getStandards = require('../data/standards');
const getStandards = require('../data/standards');
const httpHeaders = require('http-headers');
module.exports = route;
// Route definition
function route(app) {
app.express.get('/new', function(req, res) {
var standards = getStandards().map(function(standard) {
app.express.get('/new', (request, response) => {
const standards = getStandards().map(standard => {
if (standard.title === 'WCAG2AA') {
standard.selected = true;
}
return standard;
});
res.render('new', {
response.render('new', {
standards: standards,
isNewTaskPage: true
});
});
app.express.post('/new', function(req, res) {
var newTask = {
name: req.body.name,
url: req.body.url,
standard: req.body.standard,
ignore: req.body.ignore || [],
timeout: req.body.timeout,
wait: req.body.wait,
username: req.body.username,
password: req.body.password
app.express.post('/new', (request, response) => {
let parsedActions;
if (request.body.actions) {
parsedActions = request.body.actions.split(/[\r\n]+/)
.map(action => {
return action.trim();
})
.filter(action => {
return Boolean(action);
});
}
let parsedHeaders;
if (request.body.headers) {
parsedHeaders = httpHeaders(request.body.headers, true);
}
const newTask = {
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,
actions: parsedActions,
username: request.body.username || undefined,
password: request.body.password || undefined,
headers: parsedHeaders,
hideElements: request.body.hideElements || undefined
};
app.webservice.tasks.create(newTask, function(err, task) {
if (err) {
var standards = getStandards().map(function(standard) {
app.webservice.tasks.create(newTask, (error, task) => {
if (error) {
const standards = getStandards().map(standard => {
if (standard.title === newTask.standard) {
standard.selected = true;
}
standard.rules = standard.rules.map(function(rule) {
standard.rules = standard.rules.map(rule => {
if (newTask.ignore.indexOf(rule.name) !== -1) {
rule.ignored = true;
}
@@ -60,13 +81,15 @@ function route(app) {
});
return standard;
});
return res.render('new', {
error: err,
newTask.actions = request.body.actions;
newTask.headers = request.body.headers;
return response.render('new', {
error: error,
standards: standards,
task: newTask
});
}
res.redirect('/' + task.id + '?added');
response.redirect(`/${task.id}?added`);
});
});

View File

@@ -12,30 +12,29 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var moment = require('moment');
const moment = require('moment');
module.exports = route;
// Route definition
function route(app) {
function getTaskAndResult(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
function getTaskAndResult(request, response, next) {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
return next('route');
}
app.webservice
.task(req.params.id)
.result(req.params.rid)
.get({full: true}, function(err, result) {
if (err) {
.task(request.params.id)
.result(request.params.rid)
.get({full: true}, (error, result) => {
if (error) {
return next('route');
}
res.locals.task = task;
res.locals.result = result;
response.locals.task = task;
response.locals.result = result;
next();
});
});
@@ -48,7 +47,7 @@ function route(app) {
task.url
.replace(/^https?:\/\//i, '')
.replace(/\/$/, '')
.replace(/[^a-z0-9\.\-\_]+/gi, '-'),
.replace(/[^a-z0-9.\-_]+/gi, '-'),
'--',
task.standard.toLowerCase(),
'--',
@@ -58,11 +57,11 @@ function route(app) {
].join('');
}
app.express.get('/:id/:rid.csv', getTaskAndResult, function(req, res) {
var task = res.locals.task;
var result = res.locals.result;
var rows = ['"code","message","type","context","selector"'];
result.results.forEach(function(msg) {
app.express.get('/:id/:rid.csv', getTaskAndResult, (request, response) => {
const task = response.locals.task;
const result = response.locals.result;
const rows = ['"code","message","type","context","selector"'];
result.results.forEach(msg => {
rows.push([
JSON.stringify(msg.code),
JSON.stringify(msg.message),
@@ -71,18 +70,18 @@ function route(app) {
JSON.stringify(msg.selector)
].join(','));
});
res.attachment(getDownloadFileName(task, result, 'csv'));
res.send(rows.join('\n'));
response.attachment(getDownloadFileName(task, result, 'csv'));
response.send(rows.join('\n'));
});
app.express.get('/:id/:rid.json', getTaskAndResult, function(req, res) {
var task = res.locals.task;
var result = res.locals.result;
res.attachment(getDownloadFileName(task, result, 'json'));
app.express.get('/:id/:rid.json', getTaskAndResult, (request, response) => {
const task = response.locals.task;
const result = response.locals.result;
response.attachment(getDownloadFileName(task, result, 'json'));
delete task.id;
delete result.id;
result.task = task;
res.send(result);
response.send(result);
});
}

View File

@@ -12,30 +12,29 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var presentTask = require('../../view/presenter/task');
var presentResult = require('../../view/presenter/result');
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', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
app.express.get('/:id/:rid', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
return next();
}
app.webservice
.task(req.params.id)
.result(req.params.rid)
.get({full: true}, function(err, result) {
if (err) {
.task(request.params.id)
.result(request.params.rid)
.get({full: true}, (error, result) => {
if (error) {
return next();
}
res.render('result', {
response.render('result', {
task: presentTask(task),
mainResult: presentResult(result),
isResultPage: true

View File

@@ -12,34 +12,33 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var presentTask = require('../../view/presenter/task');
const presentTask = require('../../view/presenter/task');
module.exports = route;
// Route definition
function route(app) {
app.express.get('/:id/delete', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
app.express.get('/:id/delete', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
return next();
}
res.render('task/delete', {
response.render('task/delete', {
task: presentTask(task),
isTaskSubPage: true
});
});
});
app.express.post('/:id/delete', function(req, res, next) {
app.webservice.task(req.params.id).remove(function(err) {
if (err) {
app.express.post('/:id/delete', (request, response, next) => {
app.webservice.task(request.params.id).remove(error => {
if (error) {
return next();
}
res.redirect('/?deleted');
response.redirect('/?deleted');
});
});

View File

@@ -12,27 +12,27 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var presentTask = require('../../view/presenter/task');
var getStandards = require('../../data/standards');
const presentTask = require('../../view/presenter/task');
const getStandards = require('../../data/standards');
const httpHeaders = require('http-headers');
module.exports = route;
// Route definition
function route(app) {
app.express.get('/:id/edit', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
app.express.get('/:id/edit', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
return next();
}
var standards = getStandards().map(function(standard) {
const standards = getStandards().map(standard => {
if (standard.title === task.standard) {
standard.selected = true;
}
standard.rules = standard.rules.map(function(rule) {
standard.rules = standard.rules.map(rule => {
if (task.ignore.indexOf(rule.name) !== -1) {
rule.ignored = true;
}
@@ -40,8 +40,9 @@ function route(app) {
});
return standard;
});
res.render('task/edit', {
edited: (typeof req.query.edited !== 'undefined'),
task.actions = (task.actions ? task.actions.join('\n') : '');
response.render('task/edit', {
edited: (typeof request.query.edited !== 'undefined'),
standards: standards,
task: presentTask(task),
isTaskSubPage: true
@@ -49,25 +50,48 @@ function route(app) {
});
});
app.express.post('/:id/edit', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
app.express.post('/:id/edit', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
return next();
}
req.body.ignore = req.body.ignore || [];
app.webservice.task(req.params.id).edit(req.body, function(err) {
if (err) {
task.name = req.body.name;
task.ignore = req.body.ignore;
task.timeout = req.body.timeout;
task.wait = req.body.wait;
task.username = req.body.username;
task.password = req.body.password;
var standards = getStandards().map(function(standard) {
const originalActions = request.body.actions;
const originalHeaders = request.body.headers;
request.body.ignore = request.body.ignore || [];
request.body.timeout = request.body.timeout || undefined;
request.body.wait = request.body.wait || undefined;
if (request.body.actions) {
request.body.actions = request.body.actions.split(/[\r\n]+/)
.map(action => {
return action.trim();
})
.filter(action => {
return Boolean(action);
});
}
if (!request.body.actions) {
request.body.actions = [];
}
request.body.username = request.body.username || undefined;
request.body.password = request.body.password || undefined;
request.body.hideElements = request.body.hideElements || undefined;
request.body.headers = httpHeaders(request.body.headers || '', true);
app.webservice.task(request.params.id).edit(request.body, error => {
if (error) {
task.name = request.body.name;
task.ignore = request.body.ignore;
task.timeout = request.body.timeout;
task.wait = request.body.wait;
task.actions = originalActions;
task.username = request.body.username;
task.password = request.body.password;
task.headers = originalHeaders;
task.hideElements = request.body.hideElements;
const standards = getStandards().map(standard => {
if (standard.title === task.standard) {
standard.selected = true;
}
standard.rules = standard.rules.map(function(rule) {
standard.rules = standard.rules.map(rule => {
if (task.ignore.indexOf(rule.name) !== -1) {
rule.ignored = true;
}
@@ -75,14 +99,14 @@ function route(app) {
});
return standard;
});
return res.render('task/edit', {
error: err,
return response.render('task/edit', {
error: error,
standards: standards,
task: task,
isTaskSubPage: true
});
}
res.redirect('/' + req.params.id + '/edit?edited');
response.redirect(`/${request.params.id}/edit?edited`);
});
});
});

View File

@@ -5,20 +5,20 @@ module.exports = route;
// Route definition
function route(app) {
app.express.post('/:id/ignore', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
app.express.post('/:id/ignore', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
return next();
}
var edit = {
const edit = {
name: task.name,
ignore: task.ignore
};
if (typeof req.body.rule === 'string') {
edit.ignore.push(req.body.rule);
if (typeof request.body.rule === 'string') {
edit.ignore.push(request.body.rule);
}
app.webservice.task(req.params.id).edit(edit, function() {
res.redirect('/' + req.params.id + '?rule-ignored');
app.webservice.task(request.params.id).edit(edit, () => {
response.redirect(`/${request.params.id}?rule-ignored`);
});
});
});

View File

@@ -12,36 +12,35 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var presentTask = require('../../view/presenter/task');
var presentResult = require('../../view/presenter/result');
var presentResultList = require('../../view/presenter/result-list');
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) {
app.express.get('/:id', function(req, res, next) {
app.webservice.task(req.params.id).get({lastres: true}, function(err, task) {
if (err) {
app.express.get('/:id', (request, response, next) => {
app.webservice.task(request.params.id).get({lastres: true}, (error, task) => {
if (error) {
return next();
}
app.webservice.task(req.params.id).results({}, function(err, results) {
if (err) {
return next(err);
app.webservice.task(request.params.id).results({}, (error, results) => {
if (error) {
return next(error);
}
var presentedResults = presentResultList(results.map(presentResult));
res.render('task', {
const presentedResults = presentResultList(results.map(presentResult));
response.render('task', {
task: presentTask(task),
results: presentedResults,
mainResult: task.lastResult || null,
added: (typeof req.query.added !== 'undefined'),
running: (typeof req.query.running !== 'undefined'),
ruleIgnored: (typeof req.query['rule-ignored'] !== 'undefined'),
ruleUnignored: (typeof req.query['rule-unignored'] !== 'undefined'),
added: (typeof request.query.added !== 'undefined'),
running: (typeof request.query.running !== 'undefined'),
ruleIgnored: (typeof request.query['rule-ignored'] !== 'undefined'),
ruleUnignored: (typeof request.query['rule-unignored'] !== 'undefined'),
hasOneResult: (presentedResults.length < 2),
isTaskPage: true
});

View File

@@ -12,7 +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/>.
'use strict';
module.exports = route;
@@ -20,12 +19,12 @@ module.exports = route;
// Route definition
function route(app) {
app.express.get('/:id/run', function(req, res, next) {
app.webservice.task(req.params.id).run(function(err) {
if (err) {
app.express.get('/:id/run', (request, response, next) => {
app.webservice.task(request.params.id).run(error => {
if (error) {
return next();
}
res.redirect('/' + req.params.id + '?running');
response.redirect(`/${request.params.id}?running`);
});
});

View File

@@ -5,21 +5,21 @@ module.exports = route;
// Route definition
function route(app) {
app.express.post('/:id/unignore', function(req, res, next) {
app.webservice.task(req.params.id).get({}, function(err, task) {
if (err) {
app.express.post('/:id/unignore', (request, response, next) => {
app.webservice.task(request.params.id).get({}, (error, task) => {
if (error) {
return next();
}
var edit = {
const edit = {
name: task.name,
ignore: task.ignore
};
var indexOfRule = edit.ignore.indexOf(req.body.rule);
if (typeof req.body.rule === 'string' && indexOfRule !== -1) {
const indexOfRule = edit.ignore.indexOf(request.body.rule);
if (typeof request.body.rule === 'string' && indexOfRule !== -1) {
edit.ignore.splice(indexOfRule, 1);
}
app.webservice.task(req.params.id).edit(edit, function() {
res.redirect('/' + req.params.id + '?rule-unignored');
app.webservice.task(request.params.id).edit(edit, () => {
response.redirect(`/${request.params.id}?rule-unignored`);
});
});
});

15
test/.eslintrc.js Normal file
View File

@@ -0,0 +1,15 @@
'use strict';
// Clone the main config
var config = module.exports = JSON.parse(JSON.stringify(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';

View File

@@ -13,10 +13,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 requireArrowFunctions
'use strict';
var cheerio = require('cheerio');
var request = require('request');
const cheerio = require('cheerio');
const request = require('request');
module.exports = createNavigator;
@@ -37,12 +38,15 @@ function createNavigator(baseUrl, store) {
json: opts.json || false,
qs: opts.query,
followAllRedirects: true
}, function(err, res, body) {
}, function(error, response, body) {
if (error) {
return callback(error);
}
store.body = body;
store.request = res.request;
store.response = res;
store.status = res.statusCode;
store.request = response.request;
store.response = response;
store.status = response.statusCode;
if (opts.nonDom) {
store.dom = null;

View File

@@ -13,17 +13,18 @@
// 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';
var createClient = require('pa11y-webservice-client-node');
const createClient = require('pa11y-webservice-client-node');
module.exports = createWebserviceClient;
// Create a webservice client
function createWebserviceClient(config) {
var webserviceUrl = config.webservice;
let webserviceUrl = config.webservice;
if (typeof webserviceUrl === 'object') {
webserviceUrl = 'http://' + webserviceUrl.host + ':' + webserviceUrl.port + '/';
webserviceUrl = `http://${webserviceUrl.host}:${webserviceUrl.port}/`;
}
return createClient(webserviceUrl);
}

View File

@@ -13,18 +13,19 @@
// 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';
var assert = require('proclaim');
const assert = require('proclaim');
describe.only('GET /', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/'
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -32,13 +33,13 @@ describe.only('GET /', function() {
});
it('should display an "Add new URL" button', function() {
var elem = this.last.dom('[data-test=add-task]');
const elem = this.last.dom('[data-test=add-task]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem.eq(0).attr('href'), '/new');
});
it('should display all of the expected tasks', function() {
var tasks = this.last.dom('[data-test=task]');
const tasks = this.last.dom('[data-test=task]');
assert.strictEqual(tasks.length, 3);
assert.match(tasks.eq(0).text(), /npg home\s+\(wcag2aa\)/i);
assert.match(tasks.eq(1).text(), /npg home\s+\(wcag2aaa\)/i);
@@ -46,42 +47,42 @@ describe.only('GET /', function() {
});
it('should have links to each task', function() {
var tasks = this.last.dom('[data-test=task]');
const tasks = this.last.dom('[data-test=task]');
assert.strictEqual(tasks.eq(0).find('[href="/abc000000000000000000001"]').length, 1);
assert.strictEqual(tasks.eq(1).find('[href="/abc000000000000000000002"]').length, 1);
assert.strictEqual(tasks.eq(2).find('[href="/abc000000000000000000003"]').length, 1);
});
it('should display an "Edit" button for each task', function() {
var tasks = this.last.dom('[data-test=task]');
const tasks = this.last.dom('[data-test=task]');
assert.strictEqual(tasks.eq(0).find('[href="/abc000000000000000000001/edit"]').length, 1);
assert.strictEqual(tasks.eq(1).find('[href="/abc000000000000000000002/edit"]').length, 1);
assert.strictEqual(tasks.eq(2).find('[href="/abc000000000000000000003/edit"]').length, 1);
});
it('should display a "Delete" button for each task', function() {
var tasks = this.last.dom('[data-test=task]');
const tasks = this.last.dom('[data-test=task]');
assert.strictEqual(tasks.eq(0).find('[href="/abc000000000000000000001/delete"]').length, 1);
assert.strictEqual(tasks.eq(1).find('[href="/abc000000000000000000002/delete"]').length, 1);
assert.strictEqual(tasks.eq(2).find('[href="/abc000000000000000000003/delete"]').length, 1);
});
it('should display a "Run" button for each task', function() {
var tasks = this.last.dom('[data-test=task]');
const tasks = this.last.dom('[data-test=task]');
assert.strictEqual(tasks.eq(0).find('[href="/abc000000000000000000001/run"]').length, 1);
assert.strictEqual(tasks.eq(1).find('[href="/abc000000000000000000002/run"]').length, 1);
assert.strictEqual(tasks.eq(2).find('[href="/abc000000000000000000003/run"]').length, 1);
});
it('should display the task result counts if the task has been run', function() {
var tasks = this.last.dom('[data-test=task]');
const tasks = this.last.dom('[data-test=task]');
assert.match(tasks.eq(0).text(), /1\s*errors/i);
assert.match(tasks.eq(0).text(), /2\s*warnings/i);
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() {
var tasks = this.last.dom('[data-test=task]');
const tasks = this.last.dom('[data-test=task]');
assert.match(tasks.eq(2).text(), /no results/i);
});

View File

@@ -13,18 +13,19 @@
// 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';
var assert = require('proclaim');
const assert = require('proclaim');
describe('GET /new', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/new'
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -36,7 +37,7 @@ describe('GET /new', function() {
});
it('should have an "Add new URL" form', function() {
var form = this.last.dom('[data-test=new-url-form]').eq(0);
const form = this.last.dom('[data-test=new-url-form]').eq(0);
assert.isDefined(form);
assert.strictEqual(form.attr('action'), '/new');
assert.strictEqual(form.attr('method'), 'post');
@@ -49,52 +50,69 @@ describe('GET /new', function() {
});
it('should have a "name" field', function() {
var field = this.form.find('input[name=name]').eq(0);
const field = this.form.find('input[name=name]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), '');
});
it('should have a "url" field', function() {
var field = this.form.find('input[name=url]').eq(0);
const field = this.form.find('input[name=url]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'url');
assert.strictEqual(field.attr('value'), '');
});
it('should have a "wait" field', function() {
var field = this.form.find('input[name=wait]').eq(0);
const field = this.form.find('input[name=wait]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), '');
});
it('should have an "actions" field', function() {
const field = this.form.find('textarea[name=actions]').eq(0);
assert.isDefined(field);
});
it('should have a "username" field', function() {
var field = this.form.find('input[name=username]').eq(0);
const field = this.form.find('input[name=username]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), '');
});
it('should have a "password" field', function() {
var field = this.form.find('input[name=password]').eq(0);
const field = this.form.find('input[name=password]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), '');
});
it('should have a "standard" field', function() {
var field = this.form.find('select[name=standard]').eq(0);
const field = this.form.find('select[name=standard]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.find('option').length, 4);
});
it('should have "ignore" fields', function() {
var fields = this.form.find('input[name="ignore[]"]');
const fields = this.form.find('input[name="ignore[]"]');
assert.isDefined(fields);
assert.notStrictEqual(fields.length, 0);
});
it('should have a "hideElements" field', function() {
const field = this.form.find('input[name=hideElements]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), '');
});
it('should have a "headers" field', function() {
const field = this.form.find('textarea[name=headers]').eq(0);
assert.isDefined(field);
});
});
});
@@ -104,7 +122,7 @@ describe('POST /new', function() {
describe('with invalid query', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'POST',
endpoint: '/new',
form: {
@@ -112,7 +130,7 @@ describe('POST /new', function() {
url: ''
}
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -128,7 +146,7 @@ describe('POST /new', function() {
describe('with valid query', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'POST',
endpoint: '/new',
form: {
@@ -137,7 +155,7 @@ describe('POST /new', function() {
standard: 'WCAG2AA'
}
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -145,9 +163,9 @@ describe('POST /new', function() {
});
it('should create the task', function(done) {
this.webservice.tasks.get({}, function(err, tasks) {
this.webservice.tasks.get({}, function(error, tasks) {
assert.strictEqual(tasks.length, 4);
done();
done(error);
});
});
@@ -160,7 +178,7 @@ describe('POST /new', function() {
});
it('should display a success message', function() {
var alert = this.last.dom('[data-test=alert]').eq(0);
const alert = this.last.dom('[data-test=alert]').eq(0);
assert.isDefined(alert);
assert.match(alert.textContent, /url has been added/i);
});

View File

@@ -13,19 +13,20 @@
// 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';
var assert = require('proclaim');
const assert = require('proclaim');
describe('GET /<task-id>/<result-id>.csv', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/def000000000000000000001.csv',
nonDom: true
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -41,13 +42,13 @@ describe('GET /<task-id>/<result-id>.csv', function() {
describe('GET /<task-id>/<result-id>.json', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/def000000000000000000001.json',
nonDom: true,
json: true
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -55,7 +56,7 @@ describe('GET /<task-id>/<result-id>.json', function() {
});
it('should output JSON results', function() {
var json = this.last.body;
const json = this.last.body;
assert.strictEqual(json.task.name, 'NPG Home');
assert.strictEqual(json.task.url, 'nature.com');
assert.strictEqual(json.count.error, 1);

View File

@@ -13,18 +13,19 @@
// 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';
var assert = require('proclaim');
const assert = require('proclaim');
describe('GET /<task-id>/<result-id>', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/def000000000000000000001'
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -32,13 +33,13 @@ describe('GET /<task-id>/<result-id>', function() {
});
it('should display a "Download CSV" button', function() {
var elem = this.last.dom('[data-test=download-csv]');
const elem = this.last.dom('[data-test=download-csv]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem.eq(0).attr('href'), '/abc000000000000000000001/def000000000000000000001.csv');
});
it('should display a "Download JSON" button', function() {
var elem = this.last.dom('[data-test=download-json]');
const elem = this.last.dom('[data-test=download-json]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem.eq(0).attr('href'), '/abc000000000000000000001/def000000000000000000001.json');
});
@@ -48,19 +49,19 @@ describe('GET /<task-id>/<result-id>', function() {
});
it('should display errors', function() {
var elem = this.last.dom('[data-test=task-errors]').eq(0);
const elem = this.last.dom('[data-test=task-errors]').eq(0);
assert.isDefined(elem);
assert.match(elem.text(), /errors \( 1 \)/i);
});
it('should display warnings', function() {
var elem = this.last.dom('[data-test=task-warnings]').eq(0);
const elem = this.last.dom('[data-test=task-warnings]').eq(0);
assert.isDefined(elem);
assert.match(elem.text(), /warnings \( 2 \)/i);
});
it('should display notices', function() {
var elem = this.last.dom('[data-test=task-notices]').eq(0);
const elem = this.last.dom('[data-test=task-notices]').eq(0);
assert.isDefined(elem);
assert.match(elem.text(), /notices \( 3 \)/i);
});

View File

@@ -13,18 +13,19 @@
// 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';
var assert = require('proclaim');
const assert = require('proclaim');
describe('GET /<task-id>/delete', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/delete'
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -32,7 +33,7 @@ describe('GET /<task-id>/delete', function() {
});
it('should have a "Delete URL" form', function() {
var form = this.last.dom('[data-test=delete-url-form]').eq(0);
const form = this.last.dom('[data-test=delete-url-form]').eq(0);
assert.isDefined(form);
assert.strictEqual(form.attr('action'), '/abc000000000000000000001/delete');
assert.strictEqual(form.attr('method'), 'post');
@@ -47,11 +48,11 @@ describe('GET /<task-id>/delete', function() {
describe('POST /<task-id>/delete', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'POST',
endpoint: '/abc000000000000000000001/delete'
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -59,8 +60,8 @@ describe('POST /<task-id>/delete', function() {
});
it('should delete the task', function(done) {
this.webservice.task('abc000000000000000000001').get({}, function(err) {
assert.strictEqual(err.message, 'Error 404');
this.webservice.task('abc000000000000000000001').get({}, function(error) {
assert.strictEqual(error.message, 'Error 404');
done();
});
});
@@ -70,7 +71,7 @@ describe('POST /<task-id>/delete', function() {
});
it('should display a success message', function() {
var alert = this.last.dom('[data-test=alert]').eq(0);
const alert = this.last.dom('[data-test=alert]').eq(0);
assert.isDefined(alert);
assert.match(alert.text(), /been deleted/i);
});

View File

@@ -13,18 +13,19 @@
// 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';
var assert = require('proclaim');
const assert = require('proclaim');
describe('GET /<task-id>/edit', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/edit'
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -32,7 +33,7 @@ describe('GET /<task-id>/edit', function() {
});
it('should have an "Edit URL" form', function() {
var form = this.last.dom('[data-test=edit-url-form]').eq(0);
const form = this.last.dom('[data-test=edit-url-form]').eq(0);
assert.isDefined(form);
assert.strictEqual(form.attr('action'), '/abc000000000000000000001/edit');
assert.strictEqual(form.attr('method'), 'post');
@@ -49,14 +50,14 @@ describe('GET /<task-id>/edit', function() {
});
it('should have a "name" field', function() {
var field = this.form.find('input[name=name]').eq(0);
const field = this.form.find('input[name=name]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), 'NPG Home');
});
it('should have a disabled "url" field', function() {
var field = this.form.find('input[name=url]').eq(0);
const field = this.form.find('input[name=url]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'url');
assert.strictEqual(field.attr('value'), 'nature.com');
@@ -64,34 +65,51 @@ describe('GET /<task-id>/edit', function() {
});
it('should have a "wait" field', function() {
var field = this.form.find('input[name=wait]').eq(0);
const field = this.form.find('input[name=wait]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), '0');
});
it('should have an "actions" field', function() {
const field = this.form.find('textarea[name=actions]').eq(0);
assert.isDefined(field);
});
it('should have a disabled "standard" field', function() {
var field = this.form.find('select[name=standard]').eq(0);
const field = this.form.find('select[name=standard]').eq(0);
assert.isDefined(field);
assert.isDefined(field.attr('disabled'));
});
it('should have a "username" field', function() {
var field = this.form.find('input[name=username]').eq(0);
const field = this.form.find('input[name=username]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), 'user');
});
it('should have a "password" field', function() {
var field = this.form.find('input[name=password]').eq(0);
const field = this.form.find('input[name=password]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), 'access');
});
it('should have a "hideElements" field', function() {
const field = this.form.find('input[name=hideElements]').eq(0);
assert.isDefined(field);
assert.strictEqual(field.attr('type'), 'text');
assert.strictEqual(field.attr('value'), '');
});
it('should have a "headers" field', function() {
const field = this.form.find('textarea[name=headers]').eq(0);
assert.isDefined(field);
});
it('should have "ignore" fields', function() {
var fields = this.form.find('input[name="ignore[]"]');
const fields = this.form.find('input[name="ignore[]"]');
assert.isDefined(fields);
assert.notStrictEqual(fields.length, 0);
});
@@ -103,7 +121,7 @@ describe('GET /<task-id>/edit', function() {
describe('POST /<task-id>/edit', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'POST',
endpoint: '/abc000000000000000000001/edit',
form: {
@@ -113,7 +131,7 @@ describe('POST /<task-id>/edit', function() {
ignore: ['bar', 'baz']
}
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -121,17 +139,17 @@ describe('POST /<task-id>/edit', function() {
});
it('should edit the task', function(done) {
this.webservice.task('abc000000000000000000001').get({}, function(err, task) {
this.webservice.task('abc000000000000000000001').get({}, function(error, task) {
assert.strictEqual(task.name, 'foo');
assert.strictEqual(task.username, 'newuser');
assert.strictEqual(task.password, 'secure');
assert.deepEqual(task.ignore, ['bar', 'baz']);
done();
done(error);
});
});
it('should display a success message', function() {
var alert = this.last.dom('[data-test=alert]').eq(0);
const alert = this.last.dom('[data-test=alert]').eq(0);
assert.isDefined(alert);
assert.match(alert.text(), /been saved/i);
});

View File

@@ -13,20 +13,21 @@
// 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';
var assert = require('proclaim');
const assert = require('proclaim');
describe('GET /<task-id>', function() {
describe('when task has results', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001'
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -59,19 +60,19 @@ describe('GET /<task-id>', function() {
});
it('should display errors', function() {
var elem = this.last.dom('[data-test=task-errors]').eq(0);
const elem = this.last.dom('[data-test=task-errors]').eq(0);
assert.isDefined(elem);
assert.match(elem.text(), /errors \( 1 \)/i);
});
it('should display warnings', function() {
var elem = this.last.dom('[data-test=task-warnings]').eq(0);
const elem = this.last.dom('[data-test=task-warnings]').eq(0);
assert.isDefined(elem);
assert.match(elem.text(), /warnings \( 2 \)/i);
});
it('should display notices', function() {
var elem = this.last.dom('[data-test=task-notices]').eq(0);
const elem = this.last.dom('[data-test=task-notices]').eq(0);
assert.isDefined(elem);
assert.match(elem.text(), /notices \( 3 \)/i);
});
@@ -81,11 +82,11 @@ describe('GET /<task-id>', function() {
describe('when task has no results', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000003'
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -93,13 +94,13 @@ describe('GET /<task-id>', function() {
});
it('should display a "Run" button', function() {
var elem = this.last.dom('[data-test=run-task]');
const elem = this.last.dom('[data-test=run-task]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem.eq(0).attr('href'), '/abc000000000000000000003/run');
});
it('should display a message indicating that there are no results', function() {
var alert = this.last.dom('[data-test=alert]').eq(0);
const alert = this.last.dom('[data-test=alert]').eq(0);
assert.isDefined(alert);
assert.match(alert.text(), /there are no results to show/i);
});

View File

@@ -13,18 +13,19 @@
// 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';
var assert = require('proclaim');
const assert = require('proclaim');
describe('GET /<task-id>/run', function() {
beforeEach(function(done) {
var req = {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/run'
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -36,7 +37,7 @@ describe('GET /<task-id>/run', function() {
});
it('should display a success message', function() {
var alert = this.last.dom('[data-test=alert]').eq(0);
const alert = this.last.dom('[data-test=alert]').eq(0);
assert.isDefined(alert);
assert.match(alert.text(), /new results are being generated/i);
});

View File

@@ -13,21 +13,22 @@
// 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';
var config = require('../../config/test.json');
var createNavigator = require('./helper/navigate');
var createWebserviceClient = require('./helper/webservice');
var loadFixtures = require('pa11y-webservice/data/fixture/load');
var request = require('request');
const config = require('../../config/test.json');
const createNavigator = require('./helper/navigate');
const createWebserviceClient = require('./helper/webservice');
const loadFixtures = require('pa11y-webservice/data/fixture/load');
const request = require('request');
// Run before all tests
before(function(done) {
this.baseUrl = 'http://localhost:' + config.port;
this.baseUrl = `http://localhost:${config.port}`;
this.last = {};
this.navigate = createNavigator(this.baseUrl, this.last);
this.webservice = createWebserviceClient(config);
assertTestAppIsRunning(this.baseUrl, function() {
assertTestAppIsRunning(this.baseUrl, () => {
loadFixtures('test', config.webservice, done);
});
});
@@ -39,8 +40,8 @@ afterEach(function(done) {
// Check that the test application is running, and exit if not
function assertTestAppIsRunning(url, done) {
request(url, function(err) {
if (err) {
request(url, error => {
if (error) {
console.error('Error: Test app not started; run with `NODE_ENV=test node index.js`');
process.exit(1);
}

View File

@@ -15,9 +15,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/>.
}}
<div class="col-md-8">
<h1>Eeek! 500 error. This is serious.</h1>
<p class="h2">There isn't much you can do about this.</h2>
<p class="h4">Give it another go or try the <a href="/">home page</a>.</h4>
<h1>Eeek! 500 error.</h1>
<p class="h2">Let's see what we can do here:</h2>
<ul>
<li>Do you have <a href="https://www.mongodb.com/">MongoDB</a> installed and <code>mongod</code> running?</li>
<li>Check out the <a href="https://github.com/pa11y/dashboard/blob/master/TROUBLESHOOTING.md">Troubleshooting doc</a> for more information.</li>
<li>Search for a related <a href="https://github.com/pa11y/dashboard/issues">Github issue</a>, or open one yourself.</li>
</ul>
{{#if error}}
<h2>Stack-Trace</h2>
<pre>{{error.stack}}</pre>

View File

@@ -12,29 +12,23 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var moment = require('moment');
const moment = require('moment');
module.exports = helper;
function helper(hbs) {
// Format a date with Moment
hbs.registerHelper('date-format', function(context, block) {
var format = block.hash.format || 'YYYY-MM-DD HH:mm:ss';
hbs.registerHelper('date-format', (context, block) => {
const format = block.hash.format || 'YYYY-MM-DD HH:mm:ss';
return moment(context).format(format);
});
// Get a relative date
hbs.registerHelper('date-relative', function(context) {
return moment(context).fromNow();
});
hbs.registerHelper('date-timestamp', function(context) {
return moment(context).valueOf();
});
hbs.registerHelper('date-relative', context => moment(context).fromNow());
hbs.registerHelper('date-timestamp', context => moment(context).valueOf());
}

View File

@@ -5,8 +5,6 @@ module.exports = helper;
function helper(hbs) {
// Convert a string to lower-case
hbs.registerHelper('lowercase', function(context) {
return context.toLowerCase();
});
hbs.registerHelper('lowercase', context => context.toLowerCase());
}

View File

@@ -12,7 +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/>.
'use strict';
module.exports = helper;
@@ -20,7 +19,7 @@ module.exports = helper;
function helper(hbs) {
// Simplify url by removing (eg http://, https://, trailing slashes) from url
hbs.registerHelper('simplify-url', function(context) {
hbs.registerHelper('simplify-url', context => {
return context.replace(/^https?:\/\//i, '').replace(/\/$/, '').toLowerCase();
});

View File

@@ -38,7 +38,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="row">
<div class="col-md-8 col-sm-8 col-xs-10">
<label class="control-label" for="new-task-name">Name</label>
<input class="form-control" id="new-task-name" type="text" placeholder="E.g. My Home Page" name="name" value="{{task.name}}"/>
<input class="form-control" id="new-task-name" type="text" required placeholder="E.g. My Home Page" name="name" value="{{task.name}}"/>
</div>
</div>
</div>
@@ -47,7 +47,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="row">
<div class="col-md-8 col-sm-8 col-xs-10">
<label class="control-label" for="new-task-url">URL</label>
<input class="form-control" id="new-task-url" type="url" placeholder="E.g. http://mysite.com/" name="url" value="{{task.url}}"/>
<input class="form-control" id="new-task-url" type="url" required pattern="https?:\/\/.+" placeholder="E.g. http://mysite.com/" name="url" value="{{task.url}}"/>
</div>
</div>
</div>
@@ -84,6 +84,19 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
</div>
</div>
<div class="form-group clearfix">
<div class="row">
<div class="col-md-4 col-sm-4 col-xs-6">
<label class="control-label" for="new-task-actions">
Task Actions
(<a href="https://github.com/pa11y/pa11y#actions">see Pa11y documentation</a>)
</label>
<textarea class="form-control" id="new-task-actions" name="actions" aria-describedby="action-detail" placeholder="E.g. Click element #login-button">{{task.actions}}</textarea>
<em id="action-detail">(one action per line)</em>
</div>
</div>
</div>
<div class="form-group clearfix">
<div class="row">
<div class="col-md-4 col-sm-4 col-xs-6">
@@ -102,6 +115,25 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
</div>
</div>
<div class="form-group clearfix">
<div class="row">
<div class="col-md-4 col-sm-4 col-xs-6">
<label class="control-label" for="new-task-headers">HTTP Headers</label>
<textarea class="form-control" id="new-task-headers" name="headers" placeholder="Cookie: foo=bar">{{task.headers}}</textarea>
<em>(As key/value pairs, separated by newlines/colons)</em>
</div>
</div>
</div>
<div class="form-group clearfix">
<div class="row">
<div class="col-md-4 col-sm-4 col-xs-6">
<label class="control-label" for="new-task-hide-elements">Hide Elements</label>
<input class="form-control" id="new-task-hide-elements" type="text" name="hideElements" value="{{task.hideElements}}" placeholder=".advert, #modal, div[aria-role=presentation]"/> <em>(CSS selector)</em>
</div>
</div>
</div>
<p class="control-label"><b>Ignore these rules</b> <a target="_blank" href="https://github.com/pa11y/pa11y/wiki/HTML-CodeSniffer-Rules">(full list of rules here)</a></p>
<div class="standards-lists">

View File

@@ -18,7 +18,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="footer" role="contentinfo">
<div class="container">
<div class="col-md-5">
<small>&copy; {{year}} Springer Nature.<br/>Pa11y Dashboard is licensed under the GNU General Public License 3.0.<br/>Version {{version}}</small>
<small>&copy; 2013{{year}} Team Pa11y.<br/>Pa11y Dashboard is licensed under the GNU General Public License 3.0.<br/>Version {{version}}</small>
</div>
<div class="col-md-7 clearfix">
<ul class="crunch-bottom floated-list nav">

View File

@@ -73,7 +73,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="col-md-9" data-role="expandable-results" role="main">
{{#if mainResult.count.error}}
<div class="heading label-danger pointer showing first" id="errors" data-test="task-errors" data-role="expander" role="button" tabindex="0" aria-expanded="true" aria-controls="errors-list">
<span class="pull-right expander"> - <span class="hide">(close panel)</span></span>
<span class="pull-right expander"> <span class="hide">(close panel)</span></span>
Errors ( {{mainResult.count.error}} )
</div>
<div class="task-danger tasks-list collapse clearfix in" id="errors-list">
@@ -109,7 +109,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#if mainResult.count.warning}}
<div class="heading label-warning pointer" id="warnings" data-test="task-warnings" data-role="expander" role="button" tabindex="0" aria-expanded="false" aria-controls="warnings-list">
<span class="pull-right expander"> + <span class="hide">(open panel)</span></span>
<span class="pull-right expander"> <span class="hide">(open panel)</span></span>
Warnings ( {{mainResult.count.warning}} )
</div>
<div class="task-warning tasks-list collapse clearfix" id="warnings-list">
@@ -145,7 +145,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#if mainResult.count.notice}}
<div class="heading label-info pointer" id="notices" data-test="task-notices" data-role="expander" role="button" tabindex="0" aria-expanded="false" aria-controls="notices-list">
<span class="pull-right expander"> + <span class="hide">(open panel)</span></span>
<span class="pull-right expander"> <span class="hide">(open panel)</span></span>
Notices ( {{mainResult.count.notice}} )
</div>
<div class="task-info tasks-list collapse clearfix" id="notices-list">
@@ -180,7 +180,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#if mainResult.ignore.length}}
<div class="heading label-default pointer" id="ignore" data-role="expander" role="button" tabindex="0" aria-expanded="false" aria-controls="ignore-list">
<span class="pull-right expander"> + <span class="hide">(open panel)</span></span>
<span class="pull-right expander"> <span class="hide">(open panel)</span></span>
Ignored Rules ( {{mainResult.ignore.length}} )
</div>
<div class="task-default tasks-list collapse clearfix" id="ignore-list">

View File

@@ -16,19 +16,15 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<ul class="list-unstyled clearfix crunch-bottom">
<li class="col-md-4 col-sm-6 task-card add-task">
{{#if readonly}}
<span class="well task-card-link crunch-bottom">
<p class="h3 crunch">Add new URL</p>
<p class="supersize-me crunch">+</p>
</span>
{{else}}
{{#unless readonly}}
<li class="col-md-4 col-sm-6 task-card add-task">
<a class="well task-card-link crunch-bottom" data-role="add-task" href="/new" data-test="add-task">
<p class="h3 crunch">Add new URL</p>
<p class="supersize-me crunch">+</p>
</a>
{{/if}}
</li>
</li>
{{/unless}}
{{#each tasks}}
<li class="col-md-4 col-sm-6 task-card" data-test="task" data-role="task" data-keywords="{{lowercase name}} {{lowercase standard}} {{simplify-url url}}">
<a class="well task-card-link crunch-bottom" title="Details for URL {{simplify-url url}}" href="{{href}}">
@@ -49,14 +45,14 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
</a>
{{#unless ../readonly}}
<div class="btn-group options-button text-right">
<button type="button" class="btn btn-info btn-xs dropdown-toggle" data-toggle="dropdown"><span class="sr-only">Options</span><span class="glyphicon glyphicon-cog"></span></button>
<ul class="dropdown-menu pull-right" role="menu">
<li><a href="{{href}}/edit">Edit this task</a></li>
<li><a href="{{href}}/delete">Delete this task</a></li>
<li class="divider"></li>
<li><a href="{{href}}/run" data-test="run-task">Run Pa11y</a></li>
</ul>
</div>
<button type="button" class="btn btn-info btn-xs dropdown-toggle" data-toggle="dropdown"><span class="sr-only">Options</span><span class="glyphicon glyphicon-cog"></span></button>
<ul class="dropdown-menu pull-right" role="menu">
<li><a href="{{href}}/edit">Edit this task</a></li>
<li><a href="{{href}}/delete">Delete this task</a></li>
<li class="divider"></li>
<li><a href="{{href}}/run" data-test="run-task">Run Pa11y</a></li>
</ul>
</div>
{{/unless}}
</li>
{{/each}}

View File

@@ -12,16 +12,15 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var standardsArray = require('../../data/standards')();
var rules = createStandardDescriptionMap(standardsArray);
const standardsArray = require('../../data/standards')();
const rules = createStandardDescriptionMap(standardsArray);
module.exports = presentIgnoreRules;
function presentIgnoreRules(ignore) {
return ignore.map(function(name) {
return ignore.map(name => {
return {
name: name,
description: rules[name]
@@ -30,9 +29,9 @@ function presentIgnoreRules(ignore) {
}
function createStandardDescriptionMap(standards) {
var map = {};
standards.forEach(function(standard) {
standard.rules.forEach(function(rule) {
const map = {};
standards.forEach(standard => {
standard.rules.forEach(rule => {
map[rule.name] = rule.description;
});
});

View File

@@ -12,20 +12,19 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var _ = require('underscore');
var moment = require('moment');
const _ = require('underscore');
const moment = require('moment');
module.exports = presentResultList;
function presentResultList(results) {
var resultsByDay = _.groupBy(results, function(result) {
const resultsByDay = _.groupBy(results, result => {
return moment(result.date).format('YYYY-MM-DD');
});
var uniqueDayResults = [];
_.keys(resultsByDay).forEach(function(day) {
const uniqueDayResults = [];
_.keys(resultsByDay).forEach(day => {
uniqueDayResults.push(resultsByDay[day][0]);
});
return uniqueDayResults;

View File

@@ -12,20 +12,19 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var _ = require('underscore');
var presentIgnoreRules = require('./ignore');
const _ = require('underscore');
const presentIgnoreRules = require('./ignore');
module.exports = presentResult;
function presentResult(result) {
// Add additional info
result.href = '/' + result.task + '/' + result.id;
result.hrefCsv = '/' + result.task + '/' + result.id + '.csv';
result.hrefJson = '/' + result.task + '/' + result.id + '.json';
result.href = `/${result.task}/${result.id}`;
result.hrefCsv = `/${result.task}/${result.id}.csv`;
result.hrefJson = `/${result.task}/${result.id}.json`;
// Parse date
result.date = new Date(result.date);
@@ -35,13 +34,13 @@ function presentResult(result) {
// Split out message types
if (result.results) {
var groupedByType = _.groupBy(result.results, 'type');
['error', 'warning', 'notice'].forEach(function(type) {
var pluralType = type + 's';
var results = groupedByType[type] || [];
var groupedByCode = _.groupBy(results, 'code');
result[pluralType] = _.keys(groupedByCode).map(function(group) {
var firstMessage = groupedByCode[group][0];
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 firstMessage = groupedByCode[group][0];
firstMessage.count = groupedByCode[group].length;
return firstMessage;
});

View File

@@ -12,28 +12,34 @@
//
// You should have received a copy of the GNU General Public License
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var presentIgnoreRules = require('./ignore');
var presentResult = require('./result');
const presentIgnoreRules = require('./ignore');
const presentResult = require('./result');
module.exports = presentTask;
function presentTask(task) {
// Add additional info
task.href = '/' + task.id;
task.hrefDelete = '/' + task.id + '/delete';
task.hrefRun = '/' + task.id + '/run';
task.hrefJson = '/' + task.id + '.json';
task.hrefEdit = '/' + task.id + '/edit';
task.hrefIgnore = '/' + task.id + '/ignore';
task.hrefUnignore = '/' + task.id + '/unignore';
task.href = `/${task.id}`;
task.hrefDelete = `/${task.id}/delete`;
task.hrefRun = `/${task.id}/run`;
task.hrefJson = `/${task.id}.json`;
task.hrefEdit = `/${task.id}/edit`;
task.hrefIgnore = `/${task.id}/ignore`;
task.hrefUnignore = `/${task.id}/unignore`;
// Enhance the ignored rules
task.ignore = presentIgnoreRules(task.ignore);
// Change headers to a string format
if (task.headers && typeof task.headers === 'object') {
task.headers = Object.keys(task.headers).map(header => {
return `${header}: ${task.headers[header]}`;
}).join('\n');
}
// Present the last result if present
if (task.last_result) {
task.lastResult = presentResult(task.last_result);

View File

@@ -50,7 +50,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="row">
<div class="col-md-8 col-sm-8 col-xs-10">
<label class="control-label" for="new-task-name">Name</label>
<input class="form-control" id="new-task-name" type="text" placeholder="E.g. My Home Page" name="name" value="{{task.name}}"/>
<input class="form-control" id="new-task-name" type="text" required placeholder="E.g. My Home Page" name="name" value="{{task.name}}"/>
</div>
</div>
</div>
@@ -59,7 +59,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="row">
<div class="col-md-8 col-sm-8 col-xs-10">
<label class="control-label" for="new-task-url">URL</label>
<input class="form-control" id="new-task-url" type="url" placeholder="E.g. http://mysite.com/" name="url" value="{{task.url}}" disabled/>
<input class="form-control" id="new-task-url" type="url" required pattern="https?:\/\/.+" placeholder="E.g. http://mysite.com/" name="url" value="{{task.url}}" disabled/>
</div>
</div>
</div>
@@ -96,6 +96,19 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
</div>
</div>
<div class="form-group clearfix">
<div class="row">
<div class="col-md-4 col-sm-4 col-xs-6">
<label class="control-label" for="new-task-actions">
Task Actions
(<a href="https://github.com/pa11y/pa11y#actions">see Pa11y documentation</a>)
</label>
<textarea class="form-control" id="new-task-actions" name="actions" aria-describedby="action-detail" placeholder="E.g. Click element #login-button">{{task.actions}}</textarea>
<em id="action-detail">(one action per line)</em>
</div>
</div>
</div>
<div class="form-group clearfix">
<div class="row">
<div class="col-md-4 col-sm-4 col-xs-6">
@@ -114,6 +127,25 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
</div>
</div>
<div class="form-group clearfix">
<div class="row">
<div class="col-md-4 col-sm-4 col-xs-6">
<label class="control-label" for="new-task-headers">HTTP Headers</label>
<textarea class="form-control" id="new-task-headers" name="headers" placeholder="Cookie: foo=bar">{{task.headers}}</textarea>
<em>(As key/value pairs, separated by newlines/colons)</em>
</div>
</div>
</div>
<div class="form-group clearfix">
<div class="row">
<div class="col-md-4 col-sm-4 col-xs-6">
<label class="control-label" for="new-task-hide-elements">Hide Elements</label>
<input class="form-control" id="new-task-hide-elements" type="text" name="hideElements" value="{{task.hideElements}}" placeholder=".advert, #modal, div[aria-role=presentation]"/> <em>(CSS selector)</em>
</div>
</div>
</div>
<p class="control-label"><b>Ignore these rules</b> <a target="_blank" href="https://github.com/pa11y/pa11y/wiki/HTML-CodeSniffer-Rules">(full list of rules here)</a></p>
<div class="standards-lists">