This repository has been archived by the owner on Aug 27, 2019. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
128 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,130 +1,5 @@ | ||
#! /usr/bin/env bash | ||
|
||
if [[ -z "$TRAVIS" ]]; | ||
then | ||
# local development options; run this script in an unrelated project | ||
TRAVIS_PULL_REQUEST=false | ||
TRAVIS_BRANCH="test" | ||
TRAVIS_COMMIT="$(echo $RANDOM | md5)" | ||
# TRAVIS_REPO_SLUG must be a valid github repo | ||
TRAVIS_REPO_SLUG="18F/continua11y" | ||
# change to whichever script you need to start the web server (make sure to detach so that the script continues) | ||
RUN_SCRIPT="FRESHDB=TRUE forever start --spinSleepTime 1000 --minUptime 3000 app.js" | ||
# shut down the web server so that you can run the script again without conflicts | ||
KILL_SCRIPT="forever stopall" | ||
# the port where the server will run | ||
PORT=3000 | ||
# if your site generates a sitemap, set this to true to use it instead of spidering | ||
USE_SITEMAP=false | ||
# the location for the locally-running version of continua11y | ||
# for local development, set the protocol for cURL to http, as well | ||
CONTINUA11Y="localhost:3000" | ||
else | ||
# we're on travis, so install the tools needed | ||
npm install -g pa11y | ||
npm install -g pa11y-reporter-1.0-json | ||
npm install -g forever | ||
# jq is already be installed on travis, but it needs to v1.5 to have --slurpfile | ||
wget https://github.com/stedolan/jq/releases/download/jq-1.5/jq-linux64 -O /tmp/jq | ||
chmod +x /tmp/jq | ||
export PATH=/tmp:$PATH | ||
fi | ||
|
||
red=`tput setaf 1` | ||
green=`tput setaf 2` | ||
yellow=`tput setaf 3` | ||
blue=`tput setaf 4` | ||
reset=`tput sgr0` | ||
|
||
# set the default standard, if necessary | ||
if [[ -z "$STANDARD" ]]; | ||
then | ||
STANDARD="WCAG2AAA" | ||
fi | ||
|
||
# get the most recent git commit message | ||
TRAVIS_COMMIT_MSG="$(git log --format=%B --no-merges -n 1)" | ||
TRAVIS_COMMIT_MSG="$(echo $TRAVIS_COMMIT_MSG | sed s/\"/\'/g)" | ||
|
||
# set up the JSON file for full results to send | ||
echo '{"repository":"'$TRAVIS_REPO_SLUG'", "branch": "'$TRAVIS_BRANCH'","commit":"'$TRAVIS_COMMIT'","commit_message":"'$TRAVIS_COMMIT_MSG'","pull_request":"'$TRAVIS_PULL_REQUEST'","commit_range":"'TRAVIS_COMMIT_RANGE'","standard":"'$STANDARD'","data":{}}' | jq '.' > results.json | ||
|
||
# start the server, if necessary | ||
RUNNING="$(curl -s -o /dev/null -w "%{http_code}" http://localhost:${PORT})" | ||
if [[ $RUNNING == "000" ]] | ||
then | ||
echo "${green} >>> ${reset} starting the server" | ||
eval $RUN_SCRIPT | ||
sleep 5 # sometimes things take time | ||
else | ||
echo "${green} >>> ${reset} the server's already running" | ||
fi | ||
|
||
# make local copy of the site | ||
mkdir temp | ||
cd temp | ||
if ! $USE_SITEMAP; | ||
then | ||
echo "${green} >>> ${reset} using wget to mirror site" | ||
wget --quiet --mirror --convert-links http://localhost:${PORT} | ||
else | ||
echo "${green} >>> ${reset} using sitemap to mirror relevant portion of site" | ||
wget --quiet http://localhost:${PORT}/sitemap.xml --no-cache -O - | egrep -o "http://localhost:${PORT}" > sites.txt | ||
cat sites.txt | while read a; do wget --convert-links --page-requisites $a; done | ||
rm sites.txt | ||
fi | ||
echo "${green} <<< ${reset} found $(find . -type f | wc -l | sed 's/^ *//;s/ *$//') files in $(find . -mindepth 1 -type d | wc -l | sed 's/^ *//;s/ *$//') directories" | ||
|
||
function relpath() { | ||
python -c 'import sys, os.path; print os.path.relpath(sys.argv[1], sys.argv[2])' "$1" "${2:-$PWD}"; | ||
} | ||
|
||
# iterate through URLs and run runtest on each | ||
function runtest () { | ||
URL="$(relpath $file .)" | ||
if [[ $(file -b --mime-type $file) == "text/html" ]] | ||
then | ||
echo "${blue} |--------------------------------------- ${reset}" | ||
echo "${blue} |-> ${reset} analyzing ${URL}" | ||
pa11y -r 1.0-json -s $STANDARD $URL > pa11y.json | ||
|
||
# add this report into results.json | ||
jq -n --slurpfile a pa11y.json --slurpfile b ../results.json '$b | .[] * {data: {"'"${URL}"'": ($a | .[]) }}' > ../temp.json | ||
cp ../temp.json ../results.json | ||
ERROR="$(cat pa11y.json | jq .count.error)" | ||
WARNING="$(cat pa11y.json | jq .count.warning)" | ||
NOTICE="$(cat pa11y.json | jq .count.notice)" | ||
echo "${green} <<< ${reset} pa11y says: ${red}error:${reset} ${ERROR} | ${yellow}warning:${reset} ${WARNING} | ${green}notice:${reset} ${NOTICE}" | ||
rm pa11y.json | ||
else | ||
echo "${blue} || ${reset} ${URL} is not an html document, skipping" | ||
fi | ||
} | ||
|
||
echo "${green} >>> ${reset} beginning the analysis" | ||
echo "${blue} |--------------------------------------- ${reset}" | ||
for file in $(find .); | ||
do | ||
runtest $file | ||
done | ||
cd .. | ||
|
||
# shut down the server, if necessary | ||
if [[ $RUNNING == "000" ]]; | ||
then | ||
echo "${green} >>> ${reset} closing the server" | ||
eval $KILL_SCRIPT | ||
fi | ||
|
||
# send the results on to continua11y | ||
echo "${green} >>> ${reset} sending results to continua11y" | ||
if [[ -z "$TRAVIS" ]] | ||
then | ||
curl -s -X POST http://${CONTINUA11Y}/incoming -H "Content-Type: application/json" -d @results.json -o curl.txt | ||
else | ||
curl -s -X POST https://continua11y.18f.gov/incoming -H "Content-Type: application/json" -d @results.json -o curl.txt | ||
fi | ||
|
||
# clean up | ||
echo "${green} >>> ${reset} cleaning up" | ||
rm -rf temp temp.json curl.txt results.json | ||
npm install -g pa11y-crawl | ||
nohup npm start >/dev/null 2>&1 & | ||
pa11y-crawl --ci http://localhost:3000 |