From 7fdfa3204ed050c97e938f651b707a1e27d9b4ae Mon Sep 17 00:00:00 2001
From: Rich Megginson <rmeggins@redhat.com>
Date: Wed, 1 Apr 2020 15:24:09 -0600
Subject: [PATCH] update to latest template code

These changes don't directly affect network, or don't actually
change the behavior of existing code that network uses (coveralls),
but are intended to sync with the latest template code.

Adds `LSR_PUBLISH_COVERAGE=normal` to `.travis/config.sh` because
network wants to publish coverage normally (as opposed to `strict`
or not at all).
---
 .travis/config.sh       |  7 +++
 .travis/fix-coverage.sh | 13 ------
 .travis/runcoveralls.sh | 95 +++++++++++++++++++++++++++++++++++++++++
 tox.ini                 |  9 ++--
 4 files changed, 106 insertions(+), 18 deletions(-)
 delete mode 100755 .travis/fix-coverage.sh
 create mode 100755 .travis/runcoveralls.sh

diff --git a/.travis/config.sh b/.travis/config.sh
index 5619ab3..85040b2 100644
--- a/.travis/config.sh
+++ b/.travis/config.sh
@@ -12,6 +12,12 @@
 #       - LSR_ANSIBLES
 #       - LSR_MSCENARIOS
 #
+#   * .travis/runcoveralls.sh:
+#
+#       - LSR_PUBLISH_COVERAGE
+#       - LSR_TESTSDIR
+#       - function lsr_runcoveralls_hook
+#
 # Environment variables that not start with LSR_* but have influence on CI
 # process:
 #
@@ -35,3 +41,4 @@
 #   * .travis/runpytest.sh:
 #
 #       - RUN_PYTEST_SETUP_MODULE_UTILS
+LSR_PUBLISH_COVERAGE=normal
diff --git a/.travis/fix-coverage.sh b/.travis/fix-coverage.sh
deleted file mode 100755
index 9b15758..0000000
--- a/.travis/fix-coverage.sh
+++ /dev/null
@@ -1,13 +0,0 @@
-#!/bin/bash
-# SPDX-License-Identifier: MIT
-
-set -ex
-
-cat > .coveragerc <<EOF
-[paths]
-source =
-    .
-    $PWD
-EOF
-mv .coverage .coverage.merge
-coverage combine --append .
diff --git a/.travis/runcoveralls.sh b/.travis/runcoveralls.sh
new file mode 100755
index 0000000..4b3ad4e
--- /dev/null
+++ b/.travis/runcoveralls.sh
@@ -0,0 +1,95 @@
+#!/bin/bash
+# SPDX-License-Identifier: MIT
+
+# Reports coverage results using coveralls. The aim of this script is to
+# provide a unified way to reporting coverage results across all linux system
+# roles projects.
+
+# The given command line arguments are passed to coveralls.
+
+# Environment variables:
+#
+#   LSR_PUBLISH_COVERAGE
+#     If the variable is unset or empty (the default), no coverage is published.
+#     Other valid values for the variable are:
+#     strict - the reporting is performed in strict mode, so situations
+#              like missing data to be reported are treated as errors
+#     debug  - coveralls is run in debug mode (see coveralls debug --help)
+#     normal - coverage results will be reported normally
+#   LSR_TESTSDIR
+#     a path to directory where tests and tests artifacts are located; if unset
+#     or empty, this variable is set to ${TOPDIR}/tests; this path should
+#     already exists and be populated with tests artifacts before the script
+#     starts performing actions on it
+
+set -e
+
+ME=$(basename $0)
+SCRIPTDIR=$(readlink -f $(dirname $0))
+
+. ${SCRIPTDIR}/utils.sh
+. ${SCRIPTDIR}/config.sh
+
+# Publish the results only if it is desired.
+if [[ -z "${LSR_PUBLISH_COVERAGE}" ]]; then
+  lsr_info "${ME}: Publishing coverage report is not enabled. Skipping."
+  exit 0
+fi
+
+case "${LSR_PUBLISH_COVERAGE}" in
+    strict) : ;;
+    debug) : ;;
+    normal) : ;;
+    *) lsr_error Error: \"${LSR_PUBLISH_COVERAGE}\" is not a valid option ;;
+esac
+
+LSR_TESTSDIR=${LSR_TESTSDIR:-${TOPDIR}/tests}
+
+# Ensure we are in $LSR_TESTSDIR. It is supposed that if a user wants to submit
+# tests results, $LSR_TESTSDIR always exists.
+cd ${LSR_TESTSDIR}
+
+# For simplicity, we suppose that coverage core data file has name .coverage
+# and it is situated in $LSR_TESTSDIR. Similarly for .coveragerc.
+COVERAGEFILE='.coverage'
+COVERAGERCFILE='.coveragerc'
+
+# In case there is no $COVERAGEFILE, there is nothing to report. If we are
+# running in strict mode, treat this situation as error.
+if [[ ! -s ${COVERAGEFILE} ]]; then
+  NO_COVERAGEFILE_MSG="${COVERAGEFILE} is missing or empty"
+  if [[ "${LSR_PUBLISH_COVERAGE}" == "strict" ]]; then
+    lsr_error "${ME} (strict mode): ${NO_COVERAGEFILE_MSG}!"
+  fi
+  lsr_info "${ME}: ${NO_COVERAGEFILE_MSG}, nothing to publish."
+  exit 0
+fi
+
+# Create $COVERAGERCFILE file with a [paths] section. From the official docs:
+#
+#   The first value must be an actual file path on the machine where the
+#   reporting will happen, so that source code can be found. The other values
+#   can be file patterns to match against the paths of collected data, or they
+#   can be absolute or relative file paths on the current machine.
+#
+# So in our $COVERAGERCFILE file we make both locations to point to the
+# project's top directory.
+cat > ${COVERAGERCFILE} <<EOF
+[paths]
+source =
+    ..
+    $(readlink -f ..)
+EOF
+
+# Rename $COVERAGEFILE to ${COVERAGEFILE}.merge. With this trick, coverage
+# combine applies configuration in $COVERAGERCFILE also to $COVERAGEFILE.
+mv ${COVERAGEFILE} ${COVERAGEFILE}.merge
+python -m coverage combine --append
+
+MAYBE_DEBUG=""
+if [[ "${LSR_PUBLISH_COVERAGE}" == "debug" ]]; then
+  MAYBE_DEBUG=debug
+fi
+
+set -x
+coveralls ${MAYBE_DEBUG} "$@"
diff --git a/tox.ini b/tox.ini
index 6e9127c..27d5671 100644
--- a/tox.ini
+++ b/tox.ini
@@ -17,7 +17,6 @@ deps =
     py26: pytest
 
 [base]
-system_python = /usr/bin/python3
 passenv = *
 setenv =
     PYTHONPATH = {toxinidir}/library:{toxinidir}/module_utils
@@ -143,9 +142,9 @@ passenv = RUN_PYLINT_*
 setenv =
     {[base]setenv}
 deps =
+    ansible
     colorama
     pylint>=1.8.4
-    ansible
     -rpylint_extra_requirements.txt
 whitelist_externals =
     {[base]whitelist_externals}
@@ -170,13 +169,13 @@ commands = yamllint .
 [testenv:coveralls]
 envdir = {toxworkdir}/env-{env:TRAVIS_PYTHON_VERSION:coveralls}
 passenv = TRAVIS TRAVIS_*
-whitelist_externals = bash
 deps =
     coveralls
 changedir = {[base]changedir}
+whitelist_externals =
+    {[base]whitelist_externals}
 commands =
-    bash -c 'cd ..; bash .travis/fix-coverage.sh; cd -'
-    coveralls
+    bash {toxinidir}/.travis/runcoveralls.sh {posargs}
 
 [molecule_common]
 deps =