run_tests.sh

#!/bin/bash

#    Copyright 2015 Mirantis, Inc.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

set -eu

function usage {
  echo "Usage: $0 [OPTION]..."
  echo "Run fuel-ostf test suite(s)"
  echo ""
  echo "  -p, --flake8          Run FLAKE8 checks"
  echo "  -P, --no-flake8       Don't run FLAKE8 checks"
  echo "  -u, --unit            Run unit tests"
  echo "  -U, --no-unit         Don't run unit tests"
  echo "  -i, --integration     Run integarion tests"
  echo "  -I, --no-integration  Don't run inteagration tests"
  echo "  -t, --tests           Run a given test files"
  echo "  -h, --help            Print this usage message"
  echo "  -c, --with-cover      Run tests with coverage"
  echo ""
  echo "Note: with no options specified, the script will try to run all available"
  echo "      tests with all available checks."
  exit
}

function process_options {
  for arg in $@; do
    case "$arg" in
      -h|--help) usage;;
      -p|--flake8) flake8_checks=1;;
      -P|--no-flake8) no_flake8_checks=1;;
      -u|--unit) unit_tests=1;;
      -U|--no-unit) no_unit_tests=1;;
      -i|--integration) integration_tests=1;;
      -I|--no-integration) no_integration_tests=1;;
      -t|--tests) certain_tests=1;;
      -c|--with-cover) coverage=1;;
      -*) testropts="$testropts $arg";;
      *) testrargs="$testrargs $arg"
    esac
  done
}

# settings
ROOT=$(dirname `readlink -f $0`)

# test options
testrargs=
testropts="--with-timer --timer-warning=10 --timer-ok=2 --timer-top-n=10"

# customizable options
ARTIFACTS=${ARTIFACTS:-`pwd`/test_run}
INTEGRATION_XUNIT=${INTEGRATION_XUNIT:-"$ROOT/integration.xml"}
OSTF_SERVER_PORT=${OSRF_SERVER_PORT:-8777}
UNIT_XUNIT=${UNIT_XUNIT:-"$ROOT/unittests.xml"}

mkdir -p $ARTIFACTS

# disabled/enabled flags that are setted from the cli.
# used for manipulating run logic.
flake8_checks=0
no_flake8_checks=0
unit_tests=0
no_unit_tests=0
integration_tests=0
no_integration_tests=0
certain_tests=0
coverage=0

function run_tests {
  run_cleanup

  # This variable collects all failed tests. It'll be printed in
  # the end of this function as a small statistic for user.
  local errors=""

  # If tests was specified in command line then run only these tests
  if [[ $certain_tests -eq 1 ]]; then
    local result=0

    for testfile in $testrargs; do
      local testfile=`readlink -f $testfile`
      local tf=`echo $testfile | cut -d':' -f1`

      if [ ! -e $tf ]; then
          echo "ERROR: File or directory $tf not found"
          exit 1
      fi

      guess_test_run $testfile || result=1
    done

    exit $result
  fi

  # Enable all tests if none was specified skipping all explicitly disabled tests.
  if [[ $flake8_checks -eq 0 && \
      $integration_tests -eq 0 && \
      $unit_tests -eq 0 ]]; then

    if [[ $no_flake8_checks -ne 1 ]];  then flake8_checks=1;  fi
    if [[ $no_unit_tests -ne 1 ]];  then unit_tests=1;  fi
    if [[ $no_integration_tests -ne 1 ]]; then integration_tests=1; fi
  fi

  # Run all enabled tests
  if [[ $flake8_checks -eq 1 ]]; then
    run_flake8 || errors+=" flake8_checks"
  fi

  if [[ $unit_tests -eq 1 ]]; then
    run_unit_tests || errors+=" unit_tests"
  fi

  if [[ $integration_tests -eq 1 ]]; then
    run_integration_tests || errors+=" integration_tests"
  fi

  # print failed tests
  if [[ -n "$errors" ]]; then
    echo Failed tests: $errors
    exit 1
  fi

  exit 0
}


function guess_test_run {
  local errors=""

  if [[ $1 == *integration* ]]; then
    run_integration_tests $1 || errors=$1
  else
    run_unit_tests $1 || errors=$1
  fi

  if [[ -n "${errors}" ]]; then
    echo "ERROR: ${errors}"
    return 1
  fi
}


# Remove temporary files. No need to run manually, since it's
# called automatically in `run_tests` function.
function run_cleanup {
  find . -type f -name "*.pyc" -delete
  rm -f *.log
  rm -f *.pid
}


function run_flake8 {
  echo "Starting flake8 checks"
  local result=0
  tox -e pep8 || result=1

  return $result
}


function run_unit_tests {
  echo "Starting unit tests"
  if [[ $coverage -eq 1 ]]; then
    testropts="$testropts --with-coverage --cover-package fuel_plugin"
  fi

  local TESTS="$ROOT/fuel_plugin/testing/tests/unit"
  local options="-vv $testropts --xunit-file $UNIT_XUNIT"
  local result=0

  if [[ $# -ne 0 ]]; then
    TESTS=$@
  fi

  # run tests
  tox -epy26 -- $options $TESTS  || result=1

  return $result
}


function create_ostf_conf {
  local config_path=$1
  local artifacts_path=$2
  local SERVER_PORT=${3:-$OSTF_SERVER_PORT}
  cat > $config_path <<EOL
[adapter]
server_port = $SERVER_PORT
dbpath = postgresql+psycopg2://ostf:ostf@localhost/ostf
log_file = $artifacts_path/ostf.log
EOL
}


function syncdb {
  local SERVER_SETTINGS=$1
  local RUN_SYNCDB="\
      ostf-server \
      --debug
      --after-initialization-environment-hook
      --config-file $SERVER_SETTINGS"

      tox -evenv -- $RUN_SYNCDB > /dev/null
}


function cleardb {
  local SERVER_SETTINGS=$1
  local RUN_CLEARDB="\
      ostf-server \
      --debug
      --clear-db
      --config-file $SERVER_SETTINGS"

      tox -evenv -- $RUN_CLEARDB > /dev/null
}


function run_integration_tests {
  echo "Starting integration tests"
  if [[ $coverage -eq 1 ]]; then
    testropts="$testropts --with-coverage --cover-package fuel_plugin"
  fi

  local TESTS="$ROOT/fuel_plugin/testing/tests/integration"
  local options="-vv $testropts --xunit-file $INTEGRATION_XUNIT"
  local result=0
  local artifacts=$ARTIFACTS/integration
  local config=$artifacts/ostf.conf
  mkdir -p $artifacts

  if [[ $# -ne 0 ]]; then
    TESTS=$@
  fi

  create_ostf_conf $config $artifacts

  cleardb $config
  syncdb $config

  # run tests
  tox -epy26 -- $options $TESTS  || result=1

  return $result
}


# parse command line arguments and run the tests
process_options $@
run_tests