Added support for additional linters (html-proofer link checker)

- added additional test matrix item just for linters
- install and build mdbook only when needed to speedup CI
- reorganized the travis scripts

Author: budziq

.travis.yml

@@ -12,8 +12,21 @@ env:
   global:
   - secure: m28oDDxTcaLlbCXv9la/yz0PzafOCDuhOhmHRoc1ELQC0wc3r6HT3a2myrP5ewQQhaxYDzd2XXYDJB3odFV1qLQOp0hFDgNn/w3ctWZpJdLxIJN6dsaPL/azhE2hz7T+SPEoWLwTW1va6bu4wwzSOykt9//RIK0ZoyVMCRSAlMB965iMV2Nkw7SWdQZ8SlskMVk8sB103N5+WTtt6rse54jHnXTpFEq9q0EAXC1R3GBDKEWB7iwb0c++Kw46Fz86ZJJDotiVuxMtsEk0VfT0Yxx665is5Ko6sV4cahbuXqMIqYYEfqpTHNHadHWD1m1i32hW9Rjtt9fFZ+a8m9zfTixPlkfOZvQ94RnD2zqv9qiwFr8oR7t2SsZaB4aqPlJd45DqgnwQ1B0cmrUAsjSB2+1DQDkR4FgKFB/o1c6F6g8imNh+2OwiZXVLwIimXNJQ5xfZeObXFMrEZ0+uj7oxFX49EcwE/SvwsVJHST3/zL5QuQwa9/uVhW/x135/Z2ypVao2xydpow/KL8VwhX9YsOSP5ApffL4OLJ5hE9qwS/SShHGg8AenFqqm/UNFqWDU+C097YaWvG5PEvCVXvOofic65AUTCmwB+h3MSQmZIqz2sb/kwdbtkoRRR6maMgelQmg1JdIfQcKeTJIStIihjk54VENHPVAslz0oV7Ia5Bo=
 
+matrix:
+  include:
+    - rust: stable
+      os: linux
+      env: CONTENT_TESTS=1
+  allow_failures:
+    - rust: stable
+      os: linux
+      env: CONTENT_TESTS=1
+
+
 before_install:
-  - cargo install mdbook --vers '0.0.25' --debug
+  - ./ci/install_deps.sh
   - export PATH=$HOME/.cargo/bin:$PATH
 
-after_success: ./deploy.sh
+script: ./ci/test_script.sh
+
+after_success: ./ci/deploy.sh

deploy.sh renamed to ci/deploy.sh

@@ -2,6 +2,8 @@
 
 set -o errexit -o nounset
 
+echo "Running $0"
+
 if [ -z "${TRAVIS_BRANCH:-}" ]; then
     echo "This script may only be run from Travis!"
     exit 1
@@ -14,16 +16,22 @@ if [[ "$TRAVIS_BRANCH" != "master" || "$TRAVIS_RUST_VERSION" != "stable" || "$TR
     exit 0
 fi
 
-# check for outdated dependencies on nightly builds
-if [ "${TRAVIS_EVENT_TYPE:-}" == "cron" ]; then
-    echo "This is cron build. Checking for outdated dependencies!"
-    rm ./Cargo.lock
-    cargo clean
-    # replace all [dependencies] versions with "*"
-    sed -i -e "/^\[dependencies\]/,/^\[.*\]/ s|^\(.*=[ \t]*\).*$|\1\"\*\"|" ./Cargo.toml
 
-    cargo test || { echo "Cron build failed! Dependencies outdated!"; exit 1; }
-    echo "Cron build success! Dependencies are up to date!"
+if [ -z "${CONTENT_TESTS:-}" ]; then
+    # check for outdated dependencies on nightly builds
+    if [ "${TRAVIS_EVENT_TYPE:-}" == "cron" ]; then
+        echo "This is cron build. Checking for outdated dependencies!"
+        rm ./Cargo.lock
+        cargo clean
+        # replace all [dependencies] versions with "*"
+        sed -i -e "/^\[dependencies\]/,/^\[.*\]/ s|^\(.*=[ \t]*\).*$|\1\"\*\"|" ./Cargo.toml
+
+        cargo test || { echo "Cron build failed! Dependencies outdated!"; exit 1; }
+        echo "Cron build success! Dependencies are up to date!"
+        exit 0
+    fi
+
+    echo "We deploy only after we also test the markup and descriptions!"
     exit 0
 fi
 

ci/install_deps.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -o errexit -o nounset
+
+echo "Running $0"
+
+if [ -z "${TRAVIS_BRANCH:-}" ]; then
+    echo "This script may only be run from Travis!"
+    exit 1
+fi
+
+if [[ "${CONTENT_TESTS:-}" == 1 ]]; then
+    echo "Installing additional dependencies"
+    gem install html-proofer
+    cargo install mdbook --vers '0.0.25' --debug
+fi
+
+exit 0
+

ci/test_script.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+set -o errexit -o nounset
+
+echo "Running $0"
+
+if [ -z "${TRAVIS_BRANCH:-}" ]; then
+    echo "This script may only be run from Travis!"
+    exit 1
+fi
+
+# Returns 1 if program is installed and 0 otherwise
+program_installed() {
+    local return_=1
+
+    type $1 >/dev/null 2>&1 || { local return_=0; }
+
+    echo "$return_"
+}
+
+if [[ "${CONTENT_TESTS:-}" == 1 ]]; then
+    # Ensure required programs are installed
+    if [ $(program_installed htmlproofer) == 0 ]; then
+        echo "Please install htmlproofer: gem install html-proofer"
+        exit 1
+    elif [ $(program_installed mdbook) == 0 ]; then
+        echo "Please install mdbook: cargo install mdbook."
+        exit 1
+    fi
+
+    echo "Testing markup and descriptions"
+    echo "Building site to book/"
+    mdbook build
+    htmlproofer --empty-alt-ignore ./book/
+else
+    echo "Testing code snippets"
+    cargo build --verbose
+    cargo test --verbose
+fi