Compare commits

..

99 Commits
1.8.1 ... 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
Rowan Manning
df8f5a7d07 Version 2.0.0 2016-06-05 13:35:36 +01:00
Rowan Manning
b727251862 Use Pa11y Webservice 2.0 2016-06-05 13:33:31 +01:00
Rowan Manning
9d53739c06 Add a migration guide 2016-06-05 12:59:10 +01:00
Rowan Manning
2633248ea1 Drop support for Node.js 0.10-0.12 2016-06-05 12:56:50 +01:00
Rowan Manning
ea7e6f4052 Version 1.12.1 2016-06-05 12:55:43 +01:00
Andrew Mee
a3bc8c0443 Merge pull request #136 from pa11y/repo-rename
Rename all the repos and uppercase Pa11y
2016-06-02 10:26:20 +01:00
Rowan Manning
b1ae55c802 Rename all the repos and uppercase Pa11y 2016-06-01 20:57:09 +01:00
Andrew Mee
0a14a321d2 Version 1.12.0 2016-05-26 15:45:03 +01:00
Rowan Manning
ae6208d87e Support Node.js 0.10–6 (#132)
* Update dependencies

* Switch from jsdom to cheerio

* Update the supported Node.js versions

* Recompile the client-side CSS and JS
2016-05-26 15:33:58 +01:00
Rowan Manning
6bfb4f72d9 Version 1.11.0 2016-05-23 19:13:46 +01:00
Rowan Manning
b3a28bb1e8 Update the README based on review comments 2016-05-23 19:07:23 +01:00
Rowan Manning
4bd5613427 Update references to the new Pa11y organisation 2016-05-23 19:00:22 +01:00
Rowan Manning
17b04daae0 Document how to use environment variables 2016-05-22 13:10:52 +01:00
Rowan Manning
c15cc32542 Fix some lint errors 2016-05-22 13:05:08 +01:00
Josh Chisholm
08a1a9060f allow configuration by environment variables 2016-05-22 13:01:05 +01:00
Rowan Manning
1358d0f38d Add a changelog 2016-05-22 12:58:13 +01:00
Rowan Manning
4eb2fba6aa Bring the README into line with newer projects 2016-05-22 11:45:57 +01:00
Rowan Manning
6a1e06a435 Update to the latest version of the webservice 2016-05-22 11:39:00 +01:00
Rayraegah
5bfc958270 Revert "if wait value is null or undefined, set it to 0"
This reverts commit 7ce4127908.
2016-05-21 16:14:53 +01:00
Rayraegah
7ce4127908 if wait value is null or undefined, set it to 0 2016-05-21 15:43:58 +01:00
Rayraegah
2a15773e04 Added "wait" field in new task and edit task pages
Added UI control to set `wait` option in pa11y script. Updated test
cases.

[pa11y-dashboard issue
#127](https://github.com/springernature/pa11y-dashboard/issues/127)
2016-05-21 14:13:38 +01:00
Hollie Kay
aa3f0eb727 Merge pull request #128 from springernature/sidekick-update
Sidekick update
2016-05-20 16:21:35 +01:00
hollsk
aad26d8cd1 add horizontal rules 2016-05-20 16:20:47 +01:00
hollsk
fbe6875cf0 moar space 2016-05-20 15:45:37 +01:00
hollsk
c0ee197138 add sidekick update 2016-05-20 15:44:19 +01:00
hollsk
1723472b93 Version 1.10.0 2016-05-18 21:30:11 +01:00
hollsk
f8f1e8c15d merge pull request #124 from springernature/make-task-clickable 2016-05-18 21:23:13 +01:00
hollsk
95869aae56 merge pull request #125 from springernature/focus-filter 2016-05-18 21:22:34 +01:00
hollsk
83d8503ef6 automatically focus on the filter input box when you select the filter 2016-05-18 14:16:38 +01:00
Hollie Kay
1e5e310b4e Merge pull request #122 from springernature/tweak-install-steps
hopefully make the steps a littler clearer/more obvious
2016-05-18 14:07:54 +01:00
hollsk
7e8d6b122b make task URL clickable 2016-05-18 13:47:42 +01:00
Hollie Kay
a2e7e1ffc4 Merge pull request #123 from springernature/update-copyright-date
ITS BEEN THREE YEARS
2016-05-13 13:41:28 +01:00
hollsk
feacb2601d Removed line about webservice 2016-05-13 10:54:05 +01:00
hollsk
358278ad00 ITS BEEN THREE YEARS 2016-05-11 14:33:24 +01:00
hollsk
a94a9ed465 hopefully make the steps a littler clearer/more obvious 2016-05-11 14:25:02 +01:00
Hollie Kay
0918403876 Merge pull request #120 from springernature/add-unas-post
create a resources section and add a link to it
2016-05-11 14:21:36 +01:00
hollsk
e7b7792f89 create a resources section and add a link to it 2016-05-11 11:12:36 +01:00
Hollie Kay
46b2fcd3af Merge pull request #117 from una/master
docs updates
2016-05-04 10:40:42 +01:00
Una Kravets
c298668b76 docs updates 2016-04-29 14:57:27 -05:00
Rowan Manning
fe2630e9cc Version 1.9.0 2016-04-25 22:00:38 +01:00
Rowan Manning
1794e72d0a Update to the latest version of the webservice 2016-04-25 21:59:19 +01:00
Rowan Manning
2ebcafece3 Style up the result selector and context 2016-04-25 21:53:11 +01:00
M Somerville
aadb791d47 Show first context and selector on results page
The message is sometimes specific, so point out it's the first result.
2016-04-25 21:39:52 +01:00
Rowan Manning
73b20f14f0 Remove the fixtures script from the Makefile 2016-04-25 21:37:20 +01:00
M Somerville
eff26a55a4 Add context and selector to CSV output 2016-04-25 21:33:05 +01:00
Rowan Manning
ea48d6a6fd Fix JSCS errors 2016-04-25 21:26:59 +01:00
Rowan Manning
90328cfa39 Fix JSHint errors 2016-04-25 21:17:03 +01:00
Rowan Manning
d766029bbb Switch from Grunt to Make 2016-04-25 21:16:53 +01:00
Rowan Manning
7ea14497d9 Merge pull request #98 from dracos/patch-1
Add SIGINT handler
2016-03-17 00:06:21 +00:00
Rowan Manning
4675d2200c Use the latest version of pa11y-webservice 2016-03-17 00:03:23 +00:00
M Somerville
f00a1ec426 Add SIGINT handler
This is so you can exit with a Ctrl-C.
2016-03-16 23:16:21 +00:00
Rowan Manning
3841c36889 Version 1.8.2 2016-02-10 08:35:30 +00:00
Rowan Manning
f39df5b33e Update the license in the footer 2016-02-10 08:34:56 +00:00
80 changed files with 2313 additions and 1719 deletions

2
.eslintignore Normal file
View File

@@ -0,0 +1,2 @@
coverage
public/js

3
.eslintrc.js Normal file
View File

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

View File

@@ -1,8 +1,11 @@
# Language/versions
language: node_js
node_js:
- "0.10"
matrix:
include:
- node_js: '4'
- node_js: '5'
- node_js: '6'
# Build only master (and pull-requests)
branches:
@@ -15,15 +18,7 @@ services:
# Build script
before_script:
- npm install -g grunt-cli
- cp config/test.sample.json config/test.json
- grunt start-test &
- NODE_ENV=test node index.js &
- sleep 5 # give server time to start
script: 'grunt ci'
# Notifications
notifications:
email:
- j.robinson@nature.com
- perry.harlock@nature.com
- rowan.manning@nature.com
script: 'make ci'

245
CHANGELOG.md Normal file
View File

@@ -0,0 +1,245 @@
# 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
* Update dependencies
* pa11y-webservice: ~1.11 to ~2.0
* See the [migration guide](https://github.com/pa11y/dashboard/blob/master/MIGRATION.md#migrating-from-10-to-20) for details
## 1.12.1 (2016-06-05)
* Update references/links after a repo rename
## 1.12.0 (2016-05-26)
* Update Node.js version support to 0.106.0
* Update dependencies
* body-parser: added at ~1.15
* chalk: ~0.2 to ~1.1
* compression: added at ~1.6
* express: ~3.4 to ~4.13
* express-hbs: ~0.2 to ~1.0
* moment: ~2.2 to ~2.13
* pa11y-webservice: ~1.10 to ~1.11
* pa11y-webservice-client-node: ~1.1 to ~1.2
* bower: ~1.2 to ~1.7
* cheerio: added at ~0.20
* jsdom: removed
* request: ~2.27 to ^2
* uglify-js: ~2.4 to ~2.6
## 1.11.0 (2016-05-23)
* Add the ability to configure task wait times
* Allow configuration by environment variables
* Update repository references to the new Pa11y organisation
* Add a changelog
## 1.10.0 (2016-05-18)
* Automatically focus on the filter input box when you select the filter
* Make a task URL clickable
* Tweak the documentation to make it more usable
* Add a resources section to the README
## 1.9.0 (2016-04-25)
* Show errors' context and selector on the results page
* Add context and selector to CSV output
* Fix lint errors
* Switch from Grunt to Make
* Add a `SIGINT` handler
* Update dependencies
* pa11y-webservice: ~1.6 to ~1.8
## 1.8.2 (2016-02-10)
* Update the license in the footer
## 1.8.1 (2016-02-10)
* Update repository references to springernature
## 1.8.0 (2016-02-04)
* Make the graph more accessible to color-blind users
* Fix lint errors
## 1.7.0 (2016-01-29)
* Hide the date list from individual result pages
* Make the date selector properly keyboard accessible
* Change the options button into a more accessible list
* Make the errors/warnings/notices lists keyboard accessible
## 1.6.1 (2016-01-26)
* Add keyboard access for filters
* Fix lint errors
## 1.6.0 (2015-08-20)
* Hide all graph data except for errors by default
## 1.5.0 (2015-07-06)
* Add the ability to use HTTP basic auth with task URLs
* Update dependencies
* pa11y-webservice: ~1.5 to ~1.6
## 1.4.0 (2015-07-02)
* Add the ability to set a per-task timeout
## 1.3.2 (2015-01-17)
* Update dependencies
* pa11y-webservice: ~1.3 to ~1.4
## 1.3.1 (2014-03-05)
* Fix the URL filter position when in demo mode
## 1.3.0 (2014-03-04)
* Add filtering of tasks on the home page
* Add the ability to ignore certain rules
* Add the ability to ignore a rule from the result page
* Tweak the display of task cards
## 1.2.3 (2014-01-13)
* Fix CSV export for the OS X version of Excel
## 1.2.2 (2014-01-09)
* Fix spacing issues when the graph is not visible
* Add notes on publishing a release
## 1.2.1 (2014-01-08)
* Fix dropdown positioning in Internet Explorer 7 and 8
## 1.2.0 (2013-12-12)
* Add HTML Codesniffer links on the results page
* Display the ignore rules for results on the results page
* Link the breadcrumbs on task sub-pages
* Fix an issue with saving empty ignore rules
* Cache-bust the CSS and JavaScript
* Add the ability to edit tasks
* Fix lint errors
* Tweaks to the display of the graphs
* Update dependencies
* pa11y-webservice: ~1.1 to ~1.2
* pa11y-webservice-client-node: ~1.0 to ~1.1
## 1.1.0 (2013-11-22)
* Add a functional test suite
* Allow the webservice to run automatically
* Documentation improvements
* Add a Travis config
* Fix lint errors
## 1.0.0 (2013-11-19)
* Initial stable release
* Add the ability to set a site-wide message
* Add a demo mode for demo/public-facing sites
* Disable search engine indexing by default
* Tweak the task header at smaller screen sizes
* Make checkboxes on the graph WCAG2AA compliant
* Make checkbox inputs and labels WCAG2AA compliant on new URL page
* Colour changes to ensure there are no contrast issues
* Make the copy more consistent
* Update screenshots
* Update dependencies
* pa11y-webservice-client-node: 1.0.0-beta.7 to ~1.0
## 1.0.0-beta.3 pre-release (2013-11-12)
* Fix lint errors
* Add descriptive labels to tasks
* Add a name field to "New URL" form
* Add a WCAG 2.0 link to the footer
* Tweak the layout at smaller screen sizes
* Notify users when there are no ignored rules
* Fix the expires headers for front end assets
* Move from Make to Grunt
* Compress static files
* Minify the site JavaScript
* Compile LESS files with grunt
* Add a watch task to recompile assets on change
* Commit compiled front-end code to the repo
* Add development instructions
* Update screenshots
* Update dependencies
* pa11y-webservice-client-node: 1.0.0-beta.4 to 1.0.0-beta.7
## 1.0.0-beta.2 pre-release (2013-10-04)
* Add screenshots to the README
* Fix margins
* Add bower package management
* Stop the graph from appearing if there's only one result
* Add the ability to run tasks ad-hoc
* Add more useful information to the footer
* General copy edits
* Update dependencies
* pa11y-webservice-client-node: 1.0.0-beta.3 to 1.0.0-beta.4
## 1.0.0-beta.1 pre-release (2013-09-27)
* Initial release

View File

@@ -1,53 +1,21 @@
How To Contribute
=================
Contributing Guide
==================
pa11y-dashboard accepts contributions from anyone, as long as you follow the guidelines below. If you'd like to contribute but aren't sure what there is for you to do, check the issue tracker for [things ready to be worked on][ready] and [known bugs][bugs].
Thanks for getting involved :tada:
It might be an idea to focus efforts on the goal of the [next milestone][milestones] before jumping onto anything too far ahead on the roadmap.
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]
Features
--------
We won't accept features without prior discussion in the [issue tracker][issues]. Two heads are always better than one this blanket rule stops you from spending your valuable time on features which may not make it back into pa11y-dashboard.
If you want to fork the project and build on it by yourself, of course that's absolutely fine! Just don't expect your code to me merged back upstream :)
Refactoring/Rewriting
---------------------
We will accept refactors where it makes an improvement to the maintainability of the code-base or makes code more readable/understandable. If there's an argument about what's readable or not, chat about it in a pull-request.
Coding Guidelines
-----------------
* No trailing whitespace please (except in Markdown)
* Generally follow the style that is currently present in the code consistency is important
* Keep indentation consistent (tabs)
* Don't commit code with lint errors (run `grunt lint` to run JSHint with the correct configurations)
* Don't commit code without passing tests (run `grunt test`).
Versioning
----------
We use [Semantic Versioning][semver] in this project. The process for releasing a new version is as follows; this should only be done by core contributors you don't need to include a tagged version in your pull-requests.
* Switch to `master` and merge the `develop` branch into it
* Update the version number in `package.json` and `README.md`
* Commit the changes with the message: "Version x.x.x" (x.x.x being the new version number)
* Tag the commit with the version number (just the numbers, no "version" or "v"): `git tag x.x.x`
* Push with tags: `git push && git push --tags`
* Check out the `develop` branch, merge `master` into it, and push
* On GitHub, add [release notes][release-notes] for the new version. The title should be "Version x.x.x", and the description should be a list of new features/fixes
[bugs]: https://github.com/springernature/pa11y-dashboard/issues?labels=bug&state=open
[ready]: https://github.com/springernature/pa11y-dashboard/issues?labels=ready&state=open
[issues]: https://github.com/springernature/pa11y-dashboard/issues
[milestones]: https://github.com/springernature/pa11y-dashboard/issues/milestones
[release-notes]: https://github.com/springernature/pa11y-dashboard/releases
[semver]: http://semver.org/
[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,135 +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/>.
module.exports = function (grunt) {
grunt.initConfig({
jshint: {
all: [
'**/*.js',
'!node_modules/**/*.js',
'!public/js/vendor/**/*.js',
'!public/js/site.min.js'
],
options: {
es3: false,
indent: 4,
latedef: false,
maxcomplexity: 6,
maxdepth: 2,
maxlen: 100,
maxparams: 4,
maxstatements: false,
node: true,
quotmark: 'single'
}
},
less: {
all: {
options: {
cleancss: true
},
files: {
'public/css/site.min.css': 'public/less/main.less'
}
}
},
mochaTest: {
functional: {
src: ['test/functional/**/*.js'],
options: {
reporter: 'spec',
timeout: 4000
}
}
},
nodemon: {
development: {
options: {
cwd: __dirname,
file: 'index.js',
env: {
NODE_ENV: 'development'
}
}
},
test: {
options: {
cwd: __dirname,
file: 'index.js',
env: {
NODE_ENV: 'test'
}
}
}
},
uglify: {
options: {
mangle: false
},
all: {
files: {
'public/js/site.min.js': [
'public/js/vendor/jquery/jquery.min.js',
'public/js/vendor/bootstrap/js/alert.js',
'public/js/vendor/bootstrap/js/dropdown.js',
'public/js/vendor/bootstrap/js/tooltip.js',
'public/js/vendor/bootstrap/js/transition.js',
'public/js/vendor/bootstrap/js/collapse.js',
'public/js/vendor/flot/jquery.flot.js',
'public/js/vendor/flot/jquery.flot.dashes.js',
'public/js/vendor/flot/jquery.flot.time.js',
'public/js/vendor/flot/jquery.flot.selection.js',
'public/js/vendor/flot/jquery.flot.resize.js',
'public/js/site.js'
]
}
}
},
watch: {
less: {
files: ['public/less/**/*.less'],
tasks: ['less']
},
js: {
files: ['public/js/**/*.js', '!public/js/site.min.js'],
tasks: ['uglify']
}
}
});
grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-contrib-less');
grunt.loadNpmTasks('grunt-contrib-uglify');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-mocha-test');
grunt.loadNpmTasks('grunt-nodemon');
grunt.registerTask('lint', ['jshint']);
grunt.registerTask('test', ['mochaTest']);
grunt.registerTask('compile', ['less', 'uglify']);
grunt.registerTask('start', ['nodemon:development']);
grunt.registerTask('start-test', ['nodemon:test']);
grunt.registerTask('default', ['compile', 'lint', 'test']);
grunt.registerTask('ci', ['lint', 'test']);
};

19
MIGRATION.md Normal file
View File

@@ -0,0 +1,19 @@
Migration Guide
===============
Pa11y Dashboard's API changes between major versions. This is a guide to help you make the switch when this happens.
Table Of Contents
-----------------
- [Migrating from 1.0 to 2.0](#migrating-from-10-to-20)
Migrating from 1.0 to 2.0
-------------------------
### Node.js Support
The only breaking change in Pa11y Dashboard 2.0 is that Node.js 0.10 and 0.12 are no longer supported. We'll be using newer ES6 features in upcoming releases which will not work in these older Node.js versions.

38
Makefile Normal file
View File

@@ -0,0 +1,38 @@
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 \
public/js/vendor/bootstrap/js/alert.js \
public/js/vendor/bootstrap/js/dropdown.js \
public/js/vendor/bootstrap/js/tooltip.js \
public/js/vendor/bootstrap/js/transition.js \
public/js/vendor/bootstrap/js/collapse.js \
public/js/vendor/flot/jquery.flot.js \
public/js/vendor/flot/jquery.flot.dashes.js \
public/js/vendor/flot/jquery.flot.time.js \
public/js/vendor/flot/jquery.flot.selection.js \
public/js/vendor/flot/jquery.flot.resize.js \
public/js/site.js \
-o ./public/js/site.min.js
@$(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)

140
README.md
View File

@@ -1,11 +1,18 @@
pa11y-dashboard
Pa11y Dashboard
===============
pa11y-dashboard is a web interface to the [pa11y][pa11y] accessibility reporter; allowing you to focus on *fixing* issues rather than hunting them down.
Pa11y Dashboard is a web interface to the [Pa11y][pa11y] accessibility reporter; allowing you to focus on *fixing* issues rather than hunting them down.
**Current Version:** *1.8.1*
**Build Status:** [![Build Status][travis-img]][travis]
**Node Version Support:** *0.10*
![Version][shield-version]
[![Node.js version support][shield-node]][info-node]
[![Build status][shield-build]][info-build]
[![GPL-3.0 licensed][shield-license]][info-license]
---
✨ 🔜 ✨ The Pa11y team is very excited to announce plans for the successor to Pa11y Dashboard and Pa11y Webservice, codename "Sidekick". Help us define the features that you want to see by visiting the [proposal][sidekick-proposal]. ✨
---
![dashboard](https://f.cloud.github.com/assets/1225142/1549567/f0361e72-4de8-11e3-8d14-3fe6900cc15d.jpg)
@@ -15,95 +22,138 @@ pa11y-dashboard is a web interface to the [pa11y][pa11y] accessibility reporter;
Setup
-----
pa11y-dashboard requires [Node.js][node] 0.10+, [PhantomJS][phantom], and [MongoDB][mongo] to be installed. See the [pa11y][pa11y] and [pa11y-webservice][pa11y-webservice] documentation for more information on these dependencies.
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 then need to clone this repo locally and install dependencies with `npm install`.
You'll also need to have [MongoDB][mongo] installed and running. See the [MongoDB install guide][mongo-install] for more information on this.
Once you have a local clone, you'll need to copy some sample configuration files in order to run the application. From within the repo, run the following commands:
You'll then need to clone this repo locally and install dependencies with `npm install`. Now you need to add some configuration before you can run the application. We can do this in two ways:
### Option 1: Using Environment Variables
Each configuration can be set with an environment variable rather than a config file. For example to run the application on port `8080` you can use the following:
```sh
$ cp config/development.sample.json config/development.json
$ cp config/production.sample.json config/production.json
$ cp config/test.sample.json config/test.json
PORT=8080 node index.js
```
Each of these files defines configurations for a different environment. If you're just running the application locally, then you should be OK with just development configurations. The [available configurations are documented here](#configurations).
The [available configurations are documented here](#configurations).
Now that you've got your application configured, you can run in each mode with the following commands:
### Option 2: Using Config Files
You'll need to copy and modify different config files depending on your environment (set with `NODE_ENV`):
```sh
$ NODE_ENV=production node . # Run in production
$ NODE_ENV=development node . # Run in development
$ NODE_ENV=test node . # Run in test
cp config/development.sample.json config/development.json
cp config/production.sample.json config/production.json
cp config/test.sample.json config/test.json
```
Check the [development instructions](#development) for more information about running locally (and restarting automatically when files change).
Each of these files defines configurations for a different environment. If you're just running the application locally, then you should be OK with just development and test configurations. The [available configurations are documented here](#configurations).
Now that you've got your application configured, make sure you have a MongoDB server running with the `mongod` command in another terminal window. You can run in each mode by changing the `NODE_ENV` environment variable:
```sh
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
--------------
The boot configurations for pa11y-dashboard are as follows. Look at the sample JSON files in the repo for example usage.
The boot configurations for Pa11y Dashboard are as follows. Look at the sample JSON files in the repo for example usage.
### port
*(number)* The port to run the application on.
*(number)* The port to run the application on. Set via a config file or the `PORT` environment variable.
### noindex
*(boolean)* If set to `true` (default), the dashboard will not be indexed by search engines. Set to `false` to allow indexing.
*(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
*(boolean)* If set to `true`, users will not be able to add, delete or run URLs (defaults to `false`).
*(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
*(string)* A message to display prominently on the site home page. Defaults to `null`.
### 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.
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). You'll also need [Grunt][grunt] to be installed globally in order to run tests, you can do this with `npm install -g grunt-cli`.
There are many ways to contribute to Pa11y Dashboard, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.
Once you've done this, 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
$ grunt start-test
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
$ grunt # Run the lint and test tasks together
$ grunt lint # Run JSHint with the correct config
$ grunt compile # Compile front-end assets
$ grunt start # Run app in development mode, restarting if files change
$ grunt start-test # Run app in test mode, restarting if files change
$ grunt test # Run functional tests
$ grunt watch # Watch for file changes and compile assets
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.
For users with push-access, don't commit to the master branch. Code should be in `develop` until it's ready to be released.
```sh
make less # Compile the site CSS from LESS files
make uglify # Compile and uglify the client-side JavaScript
```
Useful Resources
-------
* [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitalOcean][resource-una-k]
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.
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 |
| :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.
License
-------
[Copyright 2013 Springer Nature](LICENSE.txt).
pa11y-dashboard is licensed under the [GNU General Public License 3.0][gpl].
Pa11y Dashboard is licensed under the [GNU General Public License 3.0][info-license].<br/>
Copyright &copy; 20132017, Team Pa11y
[gpl]: http://www.gnu.org/licenses/gpl-3.0.html
[grunt]: http://gruntjs.com/
[mongo]: http://www.mongodb.org/
[mongo-install]: https://docs.mongodb.org/manual/installation/
[node]: http://nodejs.org/
[pa11y]: https://github.com/springernature/pa11y
[pa11y-webservice]: https://github.com/springernature/pa11y-webservice
[pa11y-webservice-config]: https://github.com/springernature/pa11y-webservice#configurations
[pa11y]: https://github.com/pa11y/pa11y
[pa11y-webservice-config]: https://github.com/pa11y/webservice#configurations
[phantom]: http://phantomjs.org/
[travis]: https://travis-ci.org/springernature/pa11y-dashboard
[travis-img]: https://travis-ci.org/springernature/pa11y-dashboard.png?branch=master
[resource-una-k]: https://una.im/pa11y-dash/
[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.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

98
app.js
View File

@@ -1,26 +1,27 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
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;
@@ -28,47 +29,49 @@ module.exports = initApp;
function initApp(config, callback) {
config = defaultConfig(config);
var webserviceUrl = config.webservice;
if (typeof webserviceUrl == 'object') {
webserviceUrl = 'http://' + webserviceUrl.host + ':' + webserviceUrl.port + '/';
let webserviceUrl = config.webservice;
if (typeof webserviceUrl === 'object') {
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);
app.webservice = createClient(webserviceUrl);
// Compression
app.express.use(express.compress());
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)
}));
// General express config
app.express.disable('x-powered-by');
app.express.use(express.bodyParser());
app.express.use(bodyParser.urlencoded({
extended: true
}));
// View engine
app.express.set('views', __dirname + '/view');
app.express.engine('html', hbs.express3({
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('view engine', 'html');
// View helpers
require('./view/helper/date')(hbs.registerHelper);
require('./view/helper/string')(hbs.registerHelper);
require('./view/helper/url')(hbs.registerHelper);
require('./view/helper/date')(hbs);
require('./view/helper/string')(hbs);
require('./view/helper/url')(hbs);
// Populate view locals
app.express.locals({
app.express.locals = {
lang: 'en',
year: (new Date()).getFullYear(),
version: pkg.version,
@@ -76,12 +79,13 @@ function initApp (config, callback) {
bugtracker: pkg.bugs,
noindex: config.noindex,
readonly: config.readonly,
siteMessage: config.siteMessage
});
siteMessage: config.siteMessage,
settings: {}
};
app.express.use(function (req, res, next) {
res.locals.isHomePage = (req.path === '/');
res.locals.host = req.host;
app.express.use((request, response, next) => {
response.locals.isHomePage = (request.path === '/');
response.locals.host = request.hostname;
next();
});
@@ -100,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);
});
}

44
config.js Normal file
View File

@@ -0,0 +1,44 @@
// 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/>.
'use strict';
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')),
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'),
port: Number(env('WEBSERVICE_PORT', '3000')),
cron: env('WEBSERVICE_CRON', false)
})
};
}
function env(name, defaultValue) {
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

@@ -1,19 +1,19 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
/* jshint maxlen: false */
// jscs:disable maximumLineLength
'use strict';
module.exports = getStandards;
@@ -656,10 +656,12 @@ function getStandards () {
{
name: 'WCAG2AA.Principle1.Guideline1_1.1_1_1.H30.2',
description: 'Img element is the only content of the link, but is missing alt text. The alt text should describe the purpose of the link.'
}, {
},
{
name: 'WCAG2AA.Principle1.Guideline1_1.1_1_1.H37',
description: 'Img element missing an alt attribute. Use the alt attribute to specify a short text alternative.'
}, {
},
{
name: 'WCAG2AA.Principle1.Guideline1_1.1_1_1.H67.1',
description: 'Img element with empty alt text must have absent or empty title attribute.'
},

View File

@@ -1,33 +1,41 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var chalk = require('chalk');
var config = require('./config/' + (process.env.NODE_ENV || 'development') + '.json');
const chalk = require('chalk');
const config = require('./config');
require('./app')(config, function (err, app) {
process.on('SIGINT', () => {
console.log('\nGracefully shutting down from SIGINT (Ctrl-C)');
process.exit();
});
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.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')));
@@ -35,9 +43,14 @@ 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.underline.cyan('Pa11y Webservice started'));
console.log(chalk.grey('mode: %s'), process.env.NODE_ENV);
console.log(chalk.grey('uri: %s'), webservice.server.info.uri);
});

View File

@@ -1,49 +1,53 @@
{
"name": "pa11y-dashboard",
"version": "1.8.1",
"version": "2.2.2",
"private": true,
"description": "pa11y-dashboard is a visual web interface to the pa11y accessibility reporter",
"keywords": [ "accessibility", "analysis", "report" ],
"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/springernature/pa11y-dashboard.git"
"url": "https://github.com/pa11y/dashboard.git"
},
"homepage": "https://github.com/springernature/pa11y-dashboard",
"bugs": "https://github.com/springernature/pa11y-dashboard/issues",
"homepage": "https://github.com/pa11y/dashboard",
"bugs": "https://github.com/pa11y/dashboard/issues",
"license": "GPL-3.0",
"engines": {
"node": ">=0.10"
"node": ">=4"
},
"dependencies": {
"chalk": "~0.2",
"express": "~3.4",
"express-hbs": "~0.2",
"moment": "~2.2",
"pa11y-webservice": "~1.6",
"pa11y-webservice-client-node": "~1.1",
"underscore": "~1.5"
"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.2",
"grunt": "~0.4",
"grunt-contrib-jshint": "~0.7",
"grunt-contrib-less": "~0.8",
"grunt-contrib-uglify": "~0.2",
"grunt-contrib-watch": "~0.5",
"grunt-mocha-test": "~0.7",
"grunt-nodemon": "~0.1",
"jsdom": "~0.8",
"proclaim": "~2.0",
"request": "~2.27"
"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 ."
"start": "node index.js",
"test": "make ci"
}
}

File diff suppressed because one or more lines are too long

View File

@@ -1,17 +1,17 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
$(document).ready(function(){
@@ -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');

12
public/js/site.min.js vendored

File diff suppressed because one or more lines are too long

View File

@@ -17,7 +17,6 @@ code {
font-size: 90%;
color: @code-color;
background-color: @code-bg;
white-space: nowrap;
border-radius: @border-radius-base;
}

View File

@@ -1,17 +1,17 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// Making up for the non support of IE8 and IE7 in Bootstrap 3
.ie7, .ie8 {

View File

@@ -1,17 +1,17 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
/* No javascript */
.no-javascript {

View File

@@ -1,17 +1,17 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
/* Media queries */
@media (max-width:991px) {

View File

@@ -1,17 +1,17 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
/* Site specific styling */

View File

@@ -1,34 +1,33 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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

@@ -1,57 +1,79 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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,
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;
}
@@ -59,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

@@ -1,41 +1,40 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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,29 +57,31 @@ 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"'];
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),
JSON.stringify(msg.type)
JSON.stringify(msg.type),
JSON.stringify(msg.context),
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

@@ -1,41 +1,40 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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

@@ -1,46 +1,44 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var _ = require('underscore');
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

@@ -1,39 +1,38 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var _ = require('underscore');
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;
}
@@ -41,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
@@ -50,24 +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.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

@@ -1,28 +1,24 @@
'use strict';
var _ = require('underscore');
var presentTask = require('../../view/presenter/task');
var getStandards = require('../../data/standards');
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

@@ -1,47 +1,46 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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

@@ -1,18 +1,17 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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, task) {
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

@@ -1,29 +1,25 @@
'use strict';
var _ = require('underscore');
var presentTask = require('../../view/presenter/task');
var getStandards = require('../../data/standards');
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

@@ -1,94 +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/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /', function () {
beforeEach(function (done) {
var req = {
method: 'GET',
endpoint: '/'
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should display an "Add new URL" button', function () {
var elem = this.last.dom.querySelectorAll('[data-test=add-task]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem[0].getAttribute('href'), '/new');
});
it('should display all of the expected tasks', function () {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks.length, 3);
assert.match(tasks[0].textContent, /npg home\s+\(wcag2aa\)/i);
assert.match(tasks[1].textContent, /npg home\s+\(wcag2aaa\)/i);
assert.match(tasks[2].textContent, /nature news\s+\(section508\)/i);
});
it('should have links to each task', function () {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks[0].querySelectorAll('[href="/abc000000000000000000001"]').length, 1);
assert.strictEqual(tasks[1].querySelectorAll('[href="/abc000000000000000000002"]').length, 1);
assert.strictEqual(tasks[2].querySelectorAll('[href="/abc000000000000000000003"]').length, 1);
});
it('should display an "Edit" button for each task', function () {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks[0].querySelectorAll('[href="/abc000000000000000000001/edit"]').length, 1);
assert.strictEqual(tasks[1].querySelectorAll('[href="/abc000000000000000000002/edit"]').length, 1);
assert.strictEqual(tasks[2].querySelectorAll('[href="/abc000000000000000000003/edit"]').length, 1);
});
it('should display a "Delete" button for each task', function () {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks[0].querySelectorAll('[href="/abc000000000000000000001/delete"]').length, 1);
assert.strictEqual(tasks[1].querySelectorAll('[href="/abc000000000000000000002/delete"]').length, 1);
assert.strictEqual(tasks[2].querySelectorAll('[href="/abc000000000000000000003/delete"]').length, 1);
});
it('should display a "Run" button for each task', function () {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.strictEqual(tasks[0].querySelectorAll('[href="/abc000000000000000000001/run"]').length, 1);
assert.strictEqual(tasks[1].querySelectorAll('[href="/abc000000000000000000002/run"]').length, 1);
assert.strictEqual(tasks[2].querySelectorAll('[href="/abc000000000000000000003/run"]').length, 1);
});
it('should display the task result counts if the task has been run', function () {
var tasks = this.last.dom.querySelectorAll('[data-test=task]');
assert.match(tasks[0].textContent, /1\s*errors/i);
assert.match(tasks[0].textContent, /2\s*warnings/i);
assert.match(tasks[0].textContent, /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.querySelectorAll('[data-test=task]');
assert.match(tasks[2].textContent, /no results/i);
});
it('should not display an alert message', function () {
assert.strictEqual(this.last.dom.querySelectorAll('[data-test=alert]').length, 0);
});
});

View File

@@ -1,165 +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/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /new', function () {
beforeEach(function (done) {
var req = {
method: 'GET',
endpoint: '/new'
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should not display an error message', function () {
assert.strictEqual(this.last.dom.querySelectorAll('[data-test=error]').length, 0);
});
it('should have an "Add new URL" form', function () {
var form = this.last.dom.querySelectorAll('[data-test=new-url-form]')[0];
assert.isDefined(form);
assert.strictEqual(form.getAttribute('action'), '/new');
assert.strictEqual(form.getAttribute('method'), 'post');
});
describe('"Add New URL" form', function () {
beforeEach(function () {
this.form = this.last.dom.querySelectorAll('[data-test=new-url-form]')[0];
});
it('should have a "name" field', function () {
var field = this.form.querySelectorAll('input[name=name]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), '');
});
it('should have a "url" field', function () {
var field = this.form.querySelectorAll('input[name=url]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'url');
assert.strictEqual(field.getAttribute('value'), '');
});
it('should have a "username" field', function () {
var field = this.form.querySelectorAll('input[name=username]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), '');
});
it('should have a "password" field', function () {
var field = this.form.querySelectorAll('input[name=password]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), '');
});
it('should have a "standard" field', function () {
var field = this.form.querySelectorAll('select[name=standard]')[0];
assert.isDefined(field);
assert.strictEqual(field.querySelectorAll('option').length, 4);
});
it('should have "ignore" fields', function () {
var fields = this.form.querySelectorAll('input[name="ignore[]"]');
assert.isDefined(fields);
assert.notStrictEqual(fields.length, 0);
});
});
});
describe('POST /new', function () {
describe('with invalid query', function () {
beforeEach(function (done) {
var req = {
method: 'POST',
endpoint: '/new',
body: {
name: '',
url: ''
}
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should display an error message', function () {
assert.strictEqual(this.last.dom.querySelectorAll('[data-test=error]').length, 1);
});
});
describe('with valid query', function () {
beforeEach(function (done) {
var req = {
method: 'POST',
endpoint: '/new',
body: {
name: 'Example',
url: 'http://example.com/',
standard: 'WCAG2AA'
}
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should create the task', function (done) {
this.webservice.tasks.get({}, function (err, tasks) {
assert.strictEqual(tasks.length, 4);
done();
});
});
it('should redirect me to the new URL page', function () {
assert.match(this.last.request.uri.pathname, /^\/[a-z0-9]{24}$/i);
});
it('should not display an error message', function () {
assert.strictEqual(this.last.dom.querySelectorAll('[data-test=error]').length, 0);
});
it('should display a success message', function () {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /url has been added/i);
});
});
});

View File

@@ -1,70 +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/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>/<result-id>', function () {
beforeEach(function (done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/def000000000000000000001'
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should display a "Download CSV" button', function () {
var elem = this.last.dom.querySelectorAll('[data-test=download-csv]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem[0].getAttribute('href'), '/abc000000000000000000001/def000000000000000000001.csv');
});
it('should display a "Download JSON" button', function () {
var elem = this.last.dom.querySelectorAll('[data-test=download-json]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem[0].getAttribute('href'), '/abc000000000000000000001/def000000000000000000001.json');
});
it('should display a link back to the task', function () {
assert.isDefined(this.last.dom.querySelectorAll('[href="/abc000000000000000000001"]')[0]);
});
it('should display errors', function () {
var elem = this.last.dom.querySelectorAll('[data-test=task-errors]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /errors \( 1 \)/i);
});
it('should display warnings', function () {
var elem = this.last.dom.querySelectorAll('[data-test=task-warnings]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /warnings \( 2 \)/i);
});
it('should display notices', function () {
var elem = this.last.dom.querySelectorAll('[data-test=task-notices]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /notices \( 3 \)/i);
});
});

View File

@@ -1,80 +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/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>/delete', function () {
beforeEach(function (done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/delete'
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should have a "Delete URL" form', function () {
var form = this.last.dom.querySelectorAll('[data-test=delete-url-form]')[0];
assert.isDefined(form);
assert.strictEqual(form.getAttribute('action'), '/abc000000000000000000001/delete');
assert.strictEqual(form.getAttribute('method'), 'post');
});
it('should display a link back to the task page', function () {
assert.greaterThan(this.last.dom.querySelectorAll('[href="/abc000000000000000000001"]').length, 0);
});
});
describe('POST /<task-id>/delete', function () {
beforeEach(function (done) {
var req = {
method: 'POST',
endpoint: '/abc000000000000000000001/delete'
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should delete the task', function (done) {
this.webservice.task('abc000000000000000000001').get({}, function (err) {
assert.strictEqual(err.message, 'Error 404');
done();
});
});
it('should redirect me to the home page', function () {
assert.strictEqual(this.last.request.uri.pathname, '/');
});
it('should display a success message', function () {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /been deleted/i);
});
});

View File

@@ -1,135 +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/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>/edit', function () {
beforeEach(function (done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/edit'
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should have an "Edit URL" form', function () {
var form = this.last.dom.querySelectorAll('[data-test=edit-url-form]')[0];
assert.isDefined(form);
assert.strictEqual(form.getAttribute('action'), '/abc000000000000000000001/edit');
assert.strictEqual(form.getAttribute('method'), 'post');
});
it('should display a link back to the task page', function () {
assert.greaterThan(this.last.dom.querySelectorAll('[href="/abc000000000000000000001"]').length, 0);
});
describe('"Edit URL" form', function () {
beforeEach(function () {
this.form = this.last.dom.querySelectorAll('[data-test=edit-url-form]')[0];
});
it('should have a "name" field', function () {
var field = this.form.querySelectorAll('input[name=name]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), 'NPG Home');
});
it('should have a disabled "url" field', function () {
var field = this.form.querySelectorAll('input[name=url]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'url');
assert.strictEqual(field.getAttribute('value'), 'nature.com');
assert.isDefined(field.getAttribute('disabled'));
});
it('should have a disabled "standard" field', function () {
var field = this.form.querySelectorAll('select[name=standard]')[0];
assert.isDefined(field);
assert.isDefined(field.getAttribute('disabled'));
});
it('should have a "username" field', function () {
var field = this.form.querySelectorAll('input[name=username]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), 'user');
});
it('should have a "password" field', function () {
var field = this.form.querySelectorAll('input[name=password]')[0];
assert.isDefined(field);
assert.strictEqual(field.getAttribute('type'), 'text');
assert.strictEqual(field.getAttribute('value'), 'access');
});
it('should have "ignore" fields', function () {
var fields = this.form.querySelectorAll('input[name="ignore[]"]');
assert.isDefined(fields);
assert.notStrictEqual(fields.length, 0);
});
});
});
describe('POST /<task-id>/edit', function () {
beforeEach(function (done) {
var req = {
method: 'POST',
endpoint: '/abc000000000000000000001/edit',
body: {
name: 'foo',
username: 'newuser',
password: 'secure',
ignore: ['bar', 'baz']
}
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should edit the task', function (done) {
this.webservice.task('abc000000000000000000001').get({}, function (err, task) {
assert.strictEqual(task.name, 'foo');
assert.strictEqual(task.username, 'newuser');
assert.strictEqual(task.password, 'secure');
assert.deepEqual(task.ignore, ['bar', 'baz']);
done();
});
});
it('should display a success message', function () {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /been saved/i);
});
});

View File

@@ -1,111 +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/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>', function () {
describe('when task has results', function () {
beforeEach(function (done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001'
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should display an "Edit" button', function () {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/edit"]').length, 1);
});
it('should display a "Delete" button', function () {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/delete"]').length, 1);
});
it('should display a "Run" button', function () {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/run"]').length, 1);
});
it('should display a "Download CSV" button for the latest result', function () {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/def000000000000000000001.csv"]').length, 1);
});
it('should display a "Download JSON" button for the latest result', function () {
assert.strictEqual(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/def000000000000000000001.json"]').length, 1);
});
it('should display links to all results', function () {
assert.isDefined(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/def000000000000000000001"]')[0]);
assert.isDefined(this.last.dom.querySelectorAll('[href="/abc000000000000000000001/def000000000000000000003"]')[0]);
});
it('should display errors', function () {
var elem = this.last.dom.querySelectorAll('[data-test=task-errors]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /errors \( 1 \)/i);
});
it('should display warnings', function () {
var elem = this.last.dom.querySelectorAll('[data-test=task-warnings]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /warnings \( 2 \)/i);
});
it('should display notices', function () {
var elem = this.last.dom.querySelectorAll('[data-test=task-notices]')[0];
assert.isDefined(elem);
assert.match(elem.textContent, /notices \( 3 \)/i);
});
});
describe('when task has no results', function () {
beforeEach(function (done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000003'
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should display a "Run" button', function () {
var elem = this.last.dom.querySelectorAll('[data-test=run-task]');
assert.strictEqual(elem.length, 1);
assert.strictEqual(elem[0].getAttribute('href'), '/abc000000000000000000003/run');
});
it('should display a message indicating that there are no results', function () {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /there are no results to show/i);
});
});
});

View File

@@ -1,46 +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/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
'use strict';
var assert = require('proclaim');
describe('GET /<task-id>/run', function () {
beforeEach(function (done) {
var req = {
method: 'GET',
endpoint: '/abc000000000000000000001/run'
};
this.navigate(req, done);
});
it('should send a 200 status', function () {
assert.strictEqual(this.last.status, 200);
});
it('should redirect me to the task page', function () {
assert.strictEqual(this.last.request.uri.pathname, '/abc000000000000000000001');
});
it('should display a success message', function () {
var alert = this.last.dom.querySelectorAll('[data-test=alert]')[0];
assert.isDefined(alert);
assert.match(alert.textContent, /new results are being generated/i);
});
});

View File

@@ -1,51 +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/>.
/* global afterEach, before */
/* jshint maxlen: false, maxstatements: false */
'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');
// 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, function () {
loadFixtures('test', config.webservice, done);
});
});
// Run after each test
afterEach(function (done) {
loadFixtures('test', config.webservice, done);
});
// Check that the test application is running, and exit if not
function assertTestAppIsRunning (url, done) {
request(url, function (err) {
if (err) {
console.error('Error: Test app not started; run with `grunt start-test`');
process.exit(1);
}
done();
});
}

View File

@@ -1,22 +1,23 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
// jscs:disable requireArrowFunctions
'use strict';
var jsdom = require('jsdom');
var request = require('request');
const cheerio = require('cheerio');
const request = require('request');
module.exports = createNavigator;
@@ -29,36 +30,30 @@ function createNavigator (baseUrl, store) {
store.request = null;
store.response = null;
store.status = null;
store.window = null;
request({
url: baseUrl + opts.endpoint,
method: opts.method || 'GET',
body: opts.body,
json: true,
form: opts.form,
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.window = null;
store.dom = null;
callback();
} else {
jsdom.env(
store.body,
function (err, window) {
store.window = window;
store.dom = window.document;
store.dom = cheerio.load(store.body);
}
callback();
}
);
}
});

View File

@@ -1,29 +1,30 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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;
if (typeof webserviceUrl == 'object') {
webserviceUrl = 'http://' + webserviceUrl.host + ':' + webserviceUrl.port + '/';
let webserviceUrl = config.webservice;
if (typeof webserviceUrl === 'object') {
webserviceUrl = `http://${webserviceUrl.host}:${webserviceUrl.port}/`;
}
return createClient(webserviceUrl);
}

View File

@@ -0,0 +1,93 @@
// 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 maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe.only('GET /', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
endpoint: '/'
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should display an "Add new URL" button', function() {
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() {
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);
assert.match(tasks.eq(2).text(), /nature news\s+\(section508\)/i);
});
it('should have links to each task', function() {
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() {
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() {
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() {
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() {
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() {
const tasks = this.last.dom('[data-test=task]');
assert.match(tasks.eq(2).text(), /no results/i);
});
it('should not display an alert message', function() {
assert.strictEqual(this.last.dom('[data-test=alert]').length, 0);
});
});

View File

@@ -0,0 +1,188 @@
// 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 maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /new', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
endpoint: '/new'
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should not display an error message', function() {
assert.strictEqual(this.last.dom('[data-test=error]').length, 0);
});
it('should have an "Add new URL" form', function() {
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');
});
describe('"Add New URL" form', function() {
beforeEach(function() {
this.form = this.last.dom('[data-test=new-url-form]').eq(0);
});
it('should have a "name" field', function() {
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() {
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() {
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() {
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() {
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() {
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() {
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);
});
});
});
describe('POST /new', function() {
describe('with invalid query', function() {
beforeEach(function(done) {
const request = {
method: 'POST',
endpoint: '/new',
form: {
name: '',
url: ''
}
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
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 = {
method: 'POST',
endpoint: '/new',
form: {
name: 'Example',
url: 'http://example.com/',
standard: 'WCAG2AA'
}
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should create the task', function(done) {
this.webservice.tasks.get({}, function(error, tasks) {
assert.strictEqual(tasks.length, 4);
done(error);
});
});
it('should redirect me to the new URL page', function() {
assert.match(this.last.request.uri.pathname, /^\/[a-z0-9]{24}$/i);
});
it('should not display an error message', function() {
assert.strictEqual(this.last.dom('[data-test=error]').length, 0);
});
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);
});
});
});

View File

@@ -1,33 +1,32 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
/* global beforeEach, describe, it */
/* jshint maxlen: false, maxstatements: false */
// 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() {
@@ -43,12 +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
nonDom: true,
json: true
};
this.navigate(req, done);
this.navigate(request, done);
});
it('should send a 200 status', function() {
@@ -56,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

@@ -0,0 +1,69 @@
// 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 maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /<task-id>/<result-id>', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/def000000000000000000001'
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
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');
});
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');
});
it('should display a link back to the task', function() {
assert.isDefined(this.last.dom('[href="/abc000000000000000000001"]').eq(0));
});
it('should display errors', function() {
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() {
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() {
const elem = this.last.dom('[data-test=task-notices]').eq(0);
assert.isDefined(elem);
assert.match(elem.text(), /notices \( 3 \)/i);
});
});

View File

@@ -0,0 +1,79 @@
// 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 maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /<task-id>/delete', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/delete'
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should have a "Delete URL" form', function() {
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');
});
it('should display a link back to the task page', function() {
assert.greaterThan(this.last.dom('[href="/abc000000000000000000001"]').length, 0);
});
});
describe('POST /<task-id>/delete', function() {
beforeEach(function(done) {
const request = {
method: 'POST',
endpoint: '/abc000000000000000000001/delete'
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should delete the task', function(done) {
this.webservice.task('abc000000000000000000001').get({}, function(error) {
assert.strictEqual(error.message, 'Error 404');
done();
});
});
it('should redirect me to the home page', function() {
assert.strictEqual(this.last.request.uri.pathname, '/');
});
it('should display a success message', function() {
const alert = this.last.dom('[data-test=alert]').eq(0);
assert.isDefined(alert);
assert.match(alert.text(), /been deleted/i);
});
});

View File

@@ -0,0 +1,157 @@
// 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 maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /<task-id>/edit', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/edit'
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should have an "Edit URL" form', function() {
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');
});
it('should display a link back to the task page', function() {
assert.greaterThan(this.last.dom('[href="/abc000000000000000000001"]').length, 0);
});
describe('"Edit URL" form', function() {
beforeEach(function() {
this.form = this.last.dom('[data-test=edit-url-form]').eq(0);
});
it('should have a "name" field', function() {
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() {
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');
assert.isDefined(field.attr('disabled'));
});
it('should have a "wait" field', function() {
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() {
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() {
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() {
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() {
const fields = this.form.find('input[name="ignore[]"]');
assert.isDefined(fields);
assert.notStrictEqual(fields.length, 0);
});
});
});
describe('POST /<task-id>/edit', function() {
beforeEach(function(done) {
const request = {
method: 'POST',
endpoint: '/abc000000000000000000001/edit',
form: {
name: 'foo',
username: 'newuser',
password: 'secure',
ignore: ['bar', 'baz']
}
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should edit the task', function(done) {
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(error);
});
});
it('should display a success message', function() {
const alert = this.last.dom('[data-test=alert]').eq(0);
assert.isDefined(alert);
assert.match(alert.text(), /been saved/i);
});
});

View File

@@ -0,0 +1,110 @@
// 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 maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /<task-id>', function() {
describe('when task has results', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001'
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should display an "Edit" button', function() {
assert.strictEqual(this.last.dom('[href="/abc000000000000000000001/edit"]').length, 1);
});
it('should display a "Delete" button', function() {
assert.strictEqual(this.last.dom('[href="/abc000000000000000000001/delete"]').length, 1);
});
it('should display a "Run" button', function() {
assert.strictEqual(this.last.dom('[href="/abc000000000000000000001/run"]').length, 1);
});
it('should display a "Download CSV" button for the latest result', function() {
assert.strictEqual(this.last.dom('[href="/abc000000000000000000001/def000000000000000000001.csv"]').length, 1);
});
it('should display a "Download JSON" button for the latest result', function() {
assert.strictEqual(this.last.dom('[href="/abc000000000000000000001/def000000000000000000001.json"]').length, 1);
});
it('should display links to all results', function() {
assert.isDefined(this.last.dom('[href="/abc000000000000000000001/def000000000000000000001"]').eq(0));
assert.isDefined(this.last.dom('[href="/abc000000000000000000001/def000000000000000000003"]').eq(0));
});
it('should display errors', function() {
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() {
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() {
const elem = this.last.dom('[data-test=task-notices]').eq(0);
assert.isDefined(elem);
assert.match(elem.text(), /notices \( 3 \)/i);
});
});
describe('when task has no results', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000003'
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should display a "Run" button', function() {
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() {
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

@@ -0,0 +1,45 @@
// 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 maximumLineLength, requireArrowFunctions
'use strict';
const assert = require('proclaim');
describe('GET /<task-id>/run', function() {
beforeEach(function(done) {
const request = {
method: 'GET',
endpoint: '/abc000000000000000000001/run'
};
this.navigate(request, done);
});
it('should send a 200 status', function() {
assert.strictEqual(this.last.status, 200);
});
it('should redirect me to the task page', function() {
assert.strictEqual(this.last.request.uri.pathname, '/abc000000000000000000001');
});
it('should display a success message', function() {
const alert = this.last.dom('[data-test=alert]').eq(0);
assert.isDefined(alert);
assert.match(alert.text(), /new results are being generated/i);
});
});

50
test/integration/setup.js Normal file
View File

@@ -0,0 +1,50 @@
// 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 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.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);
});
// 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();
});
}

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<div class="col-md-8">
<h1>Hmmm, this page indicates a 404 error.</h1>

View File

@@ -1,23 +1,27 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
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

@@ -1,40 +1,34 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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 (register) {
function helper(hbs) {
// Format a date with Moment
register('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
register('date-relative', function (context) {
return moment(context).fromNow();
});
register('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

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

View File

@@ -1,26 +1,25 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
module.exports = helper;
function helper (register) {
function helper(hbs) {
// Simplify url by removing (eg http://, https://, trailing slashes) from url
register('simplify-url', function (context) {
hbs.registerHelper('simplify-url', context => {
return context.replace(/^https?:\/\//i, '').replace(/\/$/, '').toLowerCase();
});

View File

@@ -1,26 +1,26 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
{{#content "title"}}pa11y-dashboard{{/content}}
{{#content "title"}}Pa11y Dashboard{{/content}}
<div data-control="task-list">
<div class="clearfix">
<div class="col-md-6 col-md-offset-3 filter-toggle no-js-hide text-center">
<label for="filter-input" class="filter-trigger" data-toggle="collapse" data-target="#filter-input">Filter<span class="glyphicon glyphicon-filter"></span>
<label for="task-filter" class="filter-trigger" data-toggle="collapse" data-target="#filter-input">Filter<span class="glyphicon glyphicon-filter"></span>
</label>
<div id="filter-input" class="collapse">
<input class="form-control" id="task-filter" type="text" data-role="input" placeholder="Type filter term (name or standard)"/>

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<!DOCTYPE html>
<html lang="{{lang}}" class="no-javascript">

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
{{#content "title"}}
@@ -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>
@@ -74,6 +74,29 @@ 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-wait">Wait (milliseconds)</label>
<input class="form-control" id="new-task-wait" type="text" placeholder="E.g. 3000" name="wait" value="{{task.wait}}"/>
<em>(Note: default wait time is 0ms)</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-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">
@@ -92,7 +115,26 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
</div>
</div>
<p class="control-label"><b>Ignore these rules</b> <a target="_blank" href="https://github.com/springernature/pa11y/wiki/HTML-CodeSniffer-Rules">(full list of rules here)</a></p>
<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">
{{#standards}}

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
{{#unless isHomePage}}
<div class="container">

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<div class="col-md-12 clearfix">
<div class="graph-container graph-spacer ruled clearfix">
@@ -58,8 +58,8 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="col-md-12 hidden">
<div class="graph-spacer ruled">
<table id="graph-data" class="table graph-table" summary="Accessibility results from pa11y for this page">
<caption>pa11y results for this URL</caption>
<table id="graph-data" class="table graph-table" summary="Accessibility results from Pa11y for this page">
<caption>Pa11y results for this URL</caption>
<thead>
<tr>
<th>Date</th>

View File

@@ -1,24 +1,24 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<footer>
<div class="footer" role="contentinfo">
<div class="container">
<div class="col-md-5">
<small>&copy; {{year}} Nature Publishing Group.<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

@@ -1,24 +1,24 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<header>
<div role="banner" class="header">
<div class="container">
{{#if isHomePage}}<h1>{{else}}<div class="h1">{{/if}}
<a href="/">pa11y dashboard</a> -
<a href="/">Pa11y Dashboard</a> -
<span class="h3">your automated accessibility testing pal</span>
{{#if isHomePage}}</h1>{{else}}</div>{{/if}}
</div>

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<div class="col-md-12">
<div class="ruled task-header">

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<div class="col-md-3 aside">
@@ -64,7 +64,7 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="col-md-12 col-sm-12 clearfix">
<div class="well">
<h4 class="crunch-top">View results in browser</h4>
<p class="crunch-bottom">pa11y uses HTML_CodeSniffer to find accessibility issues. <a href="http://squizlabs.github.io/HTML_CodeSniffer/">Use their bookmarklet</a> to view results on the page you are testing.</p>
<p class="crunch-bottom">Pa11y uses HTML_CodeSniffer to find accessibility issues. <a href="http://squizlabs.github.io/HTML_CodeSniffer/">Use their bookmarklet</a> to view results on the page you are testing.</p>
</div>
</div>
</div>
@@ -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">
@@ -82,7 +82,14 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#mainResult.errors}}
<li>
<p class="crunch rule-name">{{code}} <span class="badge">{{count}}</span></p>
<p>{{message}}</p>
<p><em>First result:</em> {{message}}</p>
<p>
<b>Selector:</b>
<code style="text-wrap:pre-wrap">{{#if selector}}{{selector}}{{else}}-{{/if}}</code>
<br/>
<b>Context:</b>
<code style="text-wrap:pre-wrap">{{#if context}}{{context}}{{else}}-{{/if}}</code>
</p>
{{#unless readonly}}
{{#if ../../isTaskPage}}
<form action="{{../../../task.hrefIgnore}}" method="post">
@@ -102,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">
@@ -110,7 +117,14 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#mainResult.warnings}}
<li>
<p class="crunch rule-name">{{code}} <span class="badge">{{count}}</span></p>
<p>{{message}}</p>
<p><em>First result:</em> {{message}}</p>
<p>
<b>Selector:</b>
<code style="text-wrap:pre-wrap">{{#if selector}}{{selector}}{{else}}-{{/if}}</code>
<br/>
<b>Context:</b>
<code style="text-wrap:pre-wrap">{{#if context}}{{context}}{{else}}-{{/if}}</code>
</p>
{{#unless readonly}}
{{#if ../../isTaskPage}}
<form action="{{../../../task.hrefIgnore}}" method="post">
@@ -131,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">
@@ -139,7 +153,14 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#mainResult.notices}}
<li>
<p class="crunch rule-name">{{code}} <span class="badge">{{count}}</span></p>
<p>{{message}}</p>
<p><em>First result:</em> {{message}}</p>
<p>
<b>Selector:</b>
<code style="text-wrap:pre-wrap">{{#if selector}}{{selector}}{{else}}-{{/if}}</code>
<br/>
<b>Context:</b>
<code style="text-wrap:pre-wrap">{{#if context}}{{context}}{{else}}-{{/if}}</code>
</p>
{{#unless readonly}}
{{#if ../../isTaskPage}}
<form action="{{../../../task.hrefIgnore}}" method="post">
@@ -159,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

@@ -1,25 +1,25 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<div class="col-md-12 zfix">
<div class="ruled task-header">
<div class="row clearfix">
<div class="col-md-12">
<h1 class="h2 crunch-top">{{task.name}}</h1>
<p class="h4">{{simplify-url task.url}}<span class="h5"> ({{task.standard}})</span></p>
<p class="h4"><a href="{{task.url}}">{{simplify-url task.url}}</a><span class="h5"> ({{task.standard}})</span></p>
</div>
<div class="run-details task-header clearfix">
<div class="col-md-12 clearfix">
@@ -27,7 +27,7 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
<ul class="inline-list" role="menu">
<li><a href="/{{task.id}}/edit">Edit this task</a></li>
<li><a href="/{{task.id}}/delete">Delete this task</a></li>
<li><a href="{{task.hrefRun}}" data-test="run-task">Run pa11y</a></li>
<li><a href="{{task.hrefRun}}" data-test="run-task">Run Pa11y</a></li>
</ul>
{{/unless}}
{{#if mainResult}}

View File

@@ -1,34 +1,30 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
<ul class="list-unstyled clearfix crunch-bottom">
{{#unless readonly}}
<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}}
<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>
{{/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}}">
@@ -54,7 +50,7 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
<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>
<li><a href="{{href}}/run" data-test="run-task">Run Pa11y</a></li>
</ul>
</div>
{{/unless}}

View File

@@ -1,27 +1,26 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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

@@ -1,31 +1,30 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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

@@ -1,31 +1,30 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// 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

@@ -1,40 +1,45 @@
// This file is part of pa11y-dashboard.
// This file is part of Pa11y Dashboard.
//
// pa11y-dashboard is free software: you can redistribute it and/or modify
// 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,
// 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/>.
// along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
'use strict';
var _ = require('underscore');
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

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
{{#content "title"}}

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
{{#content "title"}}

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
{{#content "title"}}
@@ -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>
@@ -86,6 +86,29 @@ 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-wait">Wait (milliseconds)</label>
<input class="form-control" id="new-task-wait" type="text" placeholder="E.g. 3000" name="wait" value="{{task.wait}}"/>
<em>(Note: default wait time is 0ms)</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-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">
@@ -104,7 +127,26 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
</div>
</div>
<p class="control-label"><b>Ignore these rules</b> <a target="_blank" href="https://github.com/springernature/pa11y/wiki/HTML-CodeSniffer-Rules">(full list of rules here)</a></p>
<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">
{{#standards}}

View File

@@ -1,18 +1,18 @@
{{!
This file is part of pa11y-dashboard.
This file is part of Pa11y Dashboard.
pa11y-dashboard is free software: you can redistribute it and/or modify
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,
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/>.
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}}
{{#content "title"}}
@@ -84,7 +84,7 @@ along with pa11y-dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="col-md-12" data-test="alert">
<div class="alert alert-info">
<h4>There are no results to show</h4>
<p>pa11y has not been run against this URL yet so there are no results to show.</p>
<p>Pa11y has not been run against this URL yet so there are no results to show.</p>
<p><a href="{{task.hrefRun}}">Click here to generate results for this URL</a>.</p>
</div>
</div>