diff --git a/.travis.yml b/.travis.yml index b9d7ab3..bbe59ac 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,18 +1,11 @@ -matrix: - include: - - os: linux - dist: trusty - sudo: required - - os: osx - env: ZSH_SRC=system - - os: osx - env: ZSH_SRC=homebrew +addons: + apt: + packages: + zsh before_script: -- if [[ "$ZSH_SRC" == "homebrew" ]]; then brew install zsh; fi -- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install zsh; fi - mkdir .bin -- sudo curl -L https://raw.githubusercontent.com/molovo/revolver/master/revolver > .bin/revolver -- sudo curl -L https://raw.githubusercontent.com/molovo/color/master/color.zsh > .bin/color +- curl -L https://raw.githubusercontent.com/molovo/revolver/master/revolver > .bin/revolver +- curl -L https://raw.githubusercontent.com/molovo/color/master/color.zsh > .bin/color - chmod u+x .bin/{color,revolver} - export PATH="$PWD/.bin:$PATH" script: ./zunit diff --git a/README.md b/README.md index eb4082e..0c1a19f 100644 --- a/README.md +++ b/README.md @@ -256,6 +256,27 @@ directories: To set up ZUnit for a new project, just run `zunit init` in the project's root directory. This will create the `.zunit.yml` config file and relevant directories, including an example test. +### [Travis CI](https://travis-ci.org) config + +ZUnit can generate a `.travis.yml` file for you, which contains the build steps needed to install ZUnit's dependencies and then run tests. Just run `zunit init --travis` when initialising your project. + +An example `.travis.yml` is below: + +```yaml +addons: + apt: + packages: + zsh +before_script: +- mkdir .bin +- curl -L https://raw.githubusercontent.com/molovo/revolver/master/revolver > .bin/revolver +- curl -L https://raw.githubusercontent.com/molovo/color/master/color.zsh > .bin/color +- curl -L https://raw.githubusercontent.com/molovo/zunit/master/zunit > .bin/zunit +- chmod u+x .bin/{color,revolver,zunit} +- export PATH="$PWD/.bin:$PATH" +script: zunit +``` + ## Running Tests The CLI program `zunit` is used to run tests. @@ -286,6 +307,15 @@ zunit --tap zunit --output-text ``` +### HTML Reports + +ZUnit is capable of producing a detail HTML report, which you can view in your browser. + +```sh +# Prints HTML report to the _output directory +zunit --output-html +``` + ### Risky Tests By default, risky tests (those that make no assertions) raise a warning in the test output. To supress this behaviour, and allow risky tests to pass without warning, use the `--allow-risky` option. diff --git a/zunit b/zunit index 5b3577f..8d63608 100755 --- a/zunit +++ b/zunit @@ -4,6 +4,16 @@ # Internal assertion functions # ################################ +function _zunit_html_header() { + echo ' ZUnit Test Results
ZUnit Test Results Documentation
    ' +} + +function _zunit_html_footer() { + integer elapsed=$(( end_time - start_time )) + output="
  • $total tests run
  • taking $(_zunit_human_time $elapsed)
  • All $total
  • Passed $passed
  • Failed $failed
  • Errors $errors
  • Warnings $warnings
  • Skipped $skipped
" + echo $output +} + ### # Assert that two integers are equal ### @@ -359,6 +369,7 @@ function _zunit_usage() { echo " -f, --fail-fast Stop the test runner immediately after the first failure" echo " -t, --tap Output results in a TAP compatible format" echo " --output-text Print results to a text log, in TAP compatible format" + echo " --output-html Print results to a HTML page" echo " --allow-risky Supress warnings generated for risky tests" } @@ -375,6 +386,7 @@ function _zunit_run_usage() { echo " -f, --fail-fast Stop the test runner immediately after the first failure" echo " -t, --tap Output results in a TAP compatible format" echo " --output-text Print results to a text log, in TAP compatible format" + echo " --output-html Print results to a HTML page" echo " --allow-risky Supress warnings generated for risky tests" } @@ -388,20 +400,64 @@ function _zunit_init_usage() { echo "$(color yellow 'Options:')" echo " -h, --help Output help text and exit" echo " -v, --version Output version information and exit" + echo " -t, --travis Generate .travis.yml in project" +} + +### +# Shutdown testing early +# Usually called if --fail-fast is specified +### +function _zunit_fail_shutdown() { + # Kill the revolver process + [[ -z $tap ]] && revolver stop + + echo $(color red bold 'Execution halted after failure') + end_time=$((EPOCHREALTIME*1000)) + + [[ -z $tap ]] && _zunit_output_results + + # Print end of HTML report + if [[ -n $output_html ]]; then + name='Execution halted after failure' + _zunit_html_error >> $logfile_html + _zunit_html_footer >> $logfile_html + fi + + exit 1 +} + +### +# Output a HTML fatal error message +### +_zunit_html_fatal_error() { + message="$@" + echo "
  • +
    $message
    +
    • " } ### # Output a TAP compatible success message ### -_zunit_tap_success() { +function _zunit_tap_success() { echo "ok ${total} - ${name}" } +### +# Output a HTML success message +### +_zunit_html_success() { + echo "
  • +
    $name
    +
    • " +} + ### # Output a success message ### -_zunit_success() { +function _zunit_success() { [[ -n $output_text ]] && _zunit_tap_success "$@" >> $logfile_text + [[ -n $output_html ]] && _zunit_html_success "$@" >> $logfile_html passed=$(( passed + 1 )) @@ -416,7 +472,7 @@ _zunit_success() { ### # Output a TAP compatible failure message ### -_zunit_tap_failure() { +function _zunit_tap_failure() { local message="$@" echo "not ok ${total} - Failure: ${name}" @@ -425,35 +481,45 @@ _zunit_tap_failure() { echo " severity: fail" echo " ..." - [[ -n $fail_fast ]] && echo "Bail out!" && exit 1 + [[ -n $fail_fast ]] && echo "Bail out!" +} + +### +# Output a HTML failure message +### +_zunit_html_failure() { + echo "
  • +
    $name
    + 
    $message
    +
    • " } ### # Output a failure message ### -_zunit_failure() { +function _zunit_failure() { local message="$1" output="${(@)@:2}" failed=$(( failed + 1 )) [[ -n $output_text ]] && _zunit_tap_failure "$@" >> $logfile_text + [[ -n $output_html ]] && _zunit_html_failure "$@" >> $logfile_html if [[ -n $tap ]]; then _zunit_tap_failure "$@" - return + else + echo "$(color red '✘' ${name})" + echo " $(color red underline ${message})" + echo " $(color red ${output})" fi - echo "$(color red '✘' ${name})" - echo " $(color red underline ${message})" - echo " $(color red ${output})" - - [[ -n $fail_fast ]] && revolver stop && exit 1 + [[ -n $fail_fast ]] && _zunit_fail_shutdown } ### # Output a TAP compatible error message ### -_zunit_tap_error() { +function _zunit_tap_error() { local message="$@" echo "not ok ${total} - Error: ${name}" @@ -462,35 +528,45 @@ _zunit_tap_error() { echo " severity: fail" echo " ..." - [[ -n $fail_fast ]] && echo "Bail out!" && exit 1 + [[ -n $fail_fast ]] && echo "Bail out!" +} + +### +# Output a HTML error message +### +_zunit_html_error() { + echo "
  • +
    $name
    + 
    $message
    +
    • " } ### # Output a error message ### -_zunit_error() { +function _zunit_error() { local message="$1" output="${(@)@:2}" errors=$(( errors + 1 )) [[ -n $output_text ]] && _zunit_tap_error "$@" >> $logfile_text + [[ -n $output_html ]] && _zunit_html_error "$@" >> $logfile_html if [[ -n $tap ]]; then _zunit_tap_error "$@" - return + else + echo "$(color red '‼' ${name})" + echo " $(color red underline ${message})" + echo " $(color red ${output})" fi - echo "$(color red '‼' ${name})" - echo " $(color red underline ${message})" - echo " $(color red ${output})" - - [[ -n $fail_fast ]] && revolver stop && exit 1 + [[ -n $fail_fast ]] && _zunit_fail_shutdown } ### # Output a TAP compatible warning message ### -_zunit_tap_warn() { +function _zunit_tap_warn() { local message="$@" echo "ok ${total} - Warning: ${name}" @@ -500,16 +576,26 @@ _zunit_tap_warn() { echo " ..." } +### +# Output a HTML warning message +### +_zunit_html_warn() { + echo "
  • +
    $name
    + $message +
    • " +} + ### # Output a warning message ### -_zunit_warn() { +function _zunit_warn() { local message="$@" warnings=$(( warnings + 1 )) - passed=$(( passed + 1 )) [[ -n $output_text ]] && _zunit_tap_warn "$@" >> $logfile_text + [[ -n $output_html ]] && _zunit_html_warn "$@" >> $logfile_html if [[ -n $tap ]]; then _zunit_tap_warn "$@" @@ -523,7 +609,7 @@ _zunit_warn() { ### # Output a TAP compatible skipped test message ### -_zunit_tap_skip() { +function _zunit_tap_skip() { local message="$@" echo "ok ${total} - # SKIP ${name}" @@ -533,15 +619,26 @@ _zunit_tap_skip() { echo " ..." } +### +# Output a HTML skipped test message +### +_zunit_html_skip() { + echo "
  • +
    $name
    + $message +
    • " +} + ### # Output a skipped test message ### -_zunit_skip() { +function _zunit_skip() { local message="$@" skipped=$(( skipped + 1 )) [[ -n $output_text ]] && _zunit_tap_skip "$@" >> $logfile_text + [[ -n $output_html ]] && _zunit_html_skip "$@" >> $logfile_html if [[ -n $tap ]]; then _zunit_tap_skip "$@" @@ -549,13 +646,13 @@ _zunit_skip() { fi echo "$(color magenta '•') Skipped: ${name}" - echo " $(color gray "# ${message}")" + echo " # ${message}" } ### # Format a ms timestamp in a human-readable format ### -_zunit_human_time() { +function _zunit_human_time() { local ms=$1 local tmp=$(( $1 / 1000 )) local days=$(( tmp / 60 / 60 / 24 )) @@ -573,7 +670,7 @@ _zunit_human_time() { ### # Output test results ### -_zunit_output_results() { +function _zunit_output_results() { integer elapsed=$(( end_time - start_time )) echo echo "$total tests run in $(_zunit_human_time $elapsed)" @@ -584,12 +681,16 @@ _zunit_output_results() { echo "$(color red '‼') Errors $errors " echo "$(color magenta '•') Skipped $skipped " echo "$(color yellow '‼') Warnings $warnings " + echo + + [[ -n $output_text ]] && echo "TAP report written at $PWD/$logfile_text" + [[ -n $output_html ]] && echo "HTML report written at $PWD/$logfile_html" } ### # Execute a test and store the result ### -_zunit_execute_test() { +function _zunit_execute_test() { local name="$1" body="$2" if [[ -n $body ]] && [[ -n $name ]]; then @@ -851,7 +952,7 @@ function _zunit_parse_argument() { # Parse a YAML config file # Based on https://gist.github.com/pkuczynski/8665367 ### -_zunit_parse_yaml() { +function _zunit_parse_yaml() { local s w fs prefix=$2 s='[[:space:]]*' w='[a-zA-Z0-9_]*' @@ -864,12 +965,16 @@ _zunit_parse_yaml() { for (i in vname) {if (i > indent) {delete vname[i]}} if (length($3) > 0) { vn=""; for (i=0; i&2 + echo $(color red "Zunit config file already exists at $PWD/.zunit.yml") >&2 exit 1 else echo "$yaml" > "$PWD/.zunit.yml" fi if [[ -d "$PWD/tests" ]]; then - echo $(color red 'Directory already exists at $PWD/tests') >&2 + echo $(color red "Directory already exists at $PWD/tests") >&2 exit 1 else mkdir -p tests/_{output,support} touch tests/_{output,support}/.gitkeep + echo "$bootstrap" > "$PWD/tests/_support/bootstrap" echo "$example" > "$PWD/tests/example.zunit" fi + + #statements + if [[ -n $with_travis ]]; then + if [[ -f "$PWD/.travis.yml" ]]; then + echo $(color red "Travis config already exists at $PWD/.travis.yml") >&2 + exit 1 + else + echo "$travis_yml" > "$PWD/.travis.yml" + fi + fi } ### # Run tests ### function _zunit_run() { - local -a arguments testfiles fail_fast tap output_text allow_risky + local -a arguments testfiles + local fail_fast tap allow_risky + local output_text logfile_text output_html logfile_html zmodload zsh/datetime local start_time=$((EPOCHREALTIME*1000)) end_time @@ -915,6 +1050,7 @@ function _zunit_run() { f=fail_fast -fail-fast=fail_fast \ t=tap -tap=tap \ -output-text=output_text \ + -output-html=output_html \ -allow-risky=allow_risky if [[ -n $tap ]] || [[ "$zunit_config_tap" = "true" ]]; then @@ -932,9 +1068,30 @@ function _zunit_run() { echo $(color red 'Output directory must be specified in .zunit.yml') exit 1 fi + fi + if [[ -n $output_text ]]; then logfile_text="$zunit_config_directories_output/output.txt" - echo 'TAP version 13' >! $logfile_text + echo 'TAP version 13' > $logfile_text + fi + + if [[ -n $output_html ]]; then + logfile_html="$zunit_config_directories_output/output.html" + _zunit_html_header > $logfile_html + fi + + if [[ -n $zunit_config_directories_support ]]; then + local support="$zunit_config_directories_support" + if [[ ! -d $support ]]; then + echo $(color red "Support directory at $support is missing") + exit 1 + fi + + if [[ -f "$support/bootstrap" ]]; then + source "$support/bootstrap" + echo "$(color green '✔') Sourced bootstrap script $support/bootstrap" + which crash + fi fi arguments=("$@") @@ -966,13 +1123,15 @@ function _zunit_run() { _zunit_run_testfile $testfile done - [[ -n $tap ]] && echo "1..$total" - end_time=$((EPOCHREALTIME*1000)) + [[ -n $tap ]] && echo "1..$total" + [[ -n $output_text ]] && echo "1..$total" >> $logfile_text + [[ -n $output_html ]] && _zunit_html_footer >> $logfile_html + [[ -z $tap ]] && _zunit_output_results && revolver stop - [[ $passed -eq $total ]] + [[ $(( $passed + $skipped )) -eq $total ]] } ### @@ -1017,7 +1176,7 @@ function _zunit() { # If the version option is passed, # output version information and exit if [[ -n $version ]]; then - echo '0.3.0' + echo '0.4.0' exit 0 fi diff --git a/zunit.zsh-completion b/zunit.zsh-completion index 30478c7..abcffef 100644 --- a/zunit.zsh-completion +++ b/zunit.zsh-completion @@ -15,7 +15,8 @@ _zunit() { '(-f --fail-fast)'{-f,--fail-fast}'[stop execution after the first failure]' \ '(-t --tap)'{-t,--tap}'[output results in a TAP compatible format]' \ '--output-text[Print results to a text log, in TAP compatible format]' \ - '--allow-risky[Supress warnings generated for risky tests]' + '--output-html[Print results to a HTML page]' \ + '--allow-risky[Supress warnings generated for risky tests]' _arguments \ '1: :_zunit_cmds' \ @@ -36,6 +37,7 @@ _zunit() { '(-f --fail-fast)'{-f,--fail-fast}'[stop execution after the first failure]' \ '(-t --tap)'{-t,--tap}'[output results in a TAP compatible format]' \ '--output-text[Print results to a text log, in TAP compatible format]' \ + '--output-html[Print results to a HTML page]' \ '--allow-risky[Supress warnings generated for risky tests]' _arguments \