Improved error message and added python 2 in declaration

Author: Sylvain MARIE

.travis.yml

@@ -2,40 +2,38 @@ language: python
 
 cache: pip
 
-python:
-#  - "2.6"
-#  - "2.7"
-#  - "3.2"
-#  - "3.3"
-#  - "3.4"
-  - "3.5"
-#  - "3.5-dev" # 3.5 development branch
-  - "3.6"
-#  - "3.6-dev" # 3.6 development branch
-#  - "3.7-dev" # 3.7 development branch
-#  - "nightly" # currently points to 3.7-dev
-# PyPy versions
-#  - "pypy"  # PyPy2 2.5.0
-#  - "pypy3" # Pypy3 2.4.0
-#  - "pypy-5.3.1"
-#
+matrix:
+  fast_finish: true
+  include:
+#    - python: 2.6
+    - python: 2.7
+#    - python: 3.3
+#    - python: 3.4
+    - python: 3.5
+    - python: 3.6
+    - python: 3.7
+      dist: xenial
+      sudo: true
 
 env:
   global:
   - GH_REF: [email protected]:smarie/python-mini-lambda.git
 
 before_install:
+  # (a) linux dependencies
   - sudo apt-get install pandoc
   - sudo apt-get install ant
   - sudo apt-get install ant-optional
 
 install:
-  - pip install -r ci_tools/requirements-setup.txt
-  - pip install -r ci_tools/requirements-test.txt
-  - pip install -r ci_tools/requirements-report.txt
-  - pip install -r ci_tools/requirements-doc.txt
-  - pip install codecov    # https://github.com/codecov/example-python. This is specific to travis integration
-# - pip install coveralls  # this is an alternative to codecov
+  - pip list
+  # needs to be installed beforehand
+  - pip install setuptools_scm
+  - python ci_tools/py_install.py pip ci_tools/requirements-pip.txt
+  # travis-specific installs
+  - pip install PyGithub  # for ci_tools/github_release.py
+  - pip install codecov  # See https://github.com/codecov/example-python.
+  - pip list
 
 script:
 #  - coverage run tests.py
@@ -48,46 +46,56 @@ script:
 # now done in a dedicated script to capture exit code 1 and transform it to 0
   - chmod a+x ./ci_tools/run_tests.sh
   - sh ./ci_tools/run_tests.sh
+  - python ci_tools/generate-junit-badge.py 100  # generates the badge for the test results and fail build if less than x%
 
 after_success:
 # ***reporting***
 #  - junit2html junit.xml testrun.html  output is really not nice
   - ant -f ci_tools/generate-junit-html.xml  # generates the html for the test results. Actually we dont use it anymore
-  - python ci_tools/generate-junit-badge.py  # generates the badge for the test results
   - codecov
-  - pylint mini_lambda  # note that at the moment the report is simply lost, we dont transform the result into anything
+  # - pylint mini_lambda  # note that at the moment the report is simply lost, we dont transform the result into anything
 # ***documentation***
   - mkdocs build -f docs/mkdocs.yml
-  - if [ "${TRAVIS_PULL_REQUEST}" != "false" ]; then exit 0; fi;
   - mv reports/junit site/
   # mkdocs gh-deploy requires special care :
   # ---grant the possibility to push on the repo---
   - openssl aes-256-cbc -K $encrypted_fdc2c20d7f8b_key -iv $encrypted_fdc2c20d7f8b_iv -in ci_tools/github_travis_rsa.enc -out ci_tools/github_travis_rsa -d
-  - chmod 600 ci_tools/github_travis_rsa
-  - eval `ssh-agent -s`  # launch the authentication agent
-  - ssh-add ci_tools/github_travis_rsa  # register the key
-  - git config user.name "Automatic Publish"
-  - git config user.email "[email protected]"
-  - git remote add gh-remote "${GH_REF}";
-  - git fetch gh-remote && git fetch gh-remote gh-pages:gh-pages;
-  # push but only if this is not a build triggered by a pull request
-  # note: here we use the --dirty flag so that mkdocs does not clean the additional reports that we copied in the site
-  - if [ "${TRAVIS_PYTHON_VERSION}" = "3.5" ]; then echo "Pushing to github"; PYTHONPATH=mini_lambda/ mkdocs gh-deploy -v --dirty -f docs/mkdocs.yml --remote-name gh-remote; git push gh-remote gh-pages; fi;
-#  - if [ "${TRAVIS_PULL_REQUEST}" = "false" ] && [ "${TRAVIS_PYTHON_VERSION}" = "3.5" ]; then echo "Pushing to github"; git push gh-remote gh-pages; fi;
+  # If the output file does not exist, that is because the secret is invalid. This can happen in forked repos so do not fail the build
+  - |
+    if [ -s "ci_tools/github_travis_rsa" ]; then
+      chmod 600 ci_tools/github_travis_rsa
+      eval `ssh-agent -s`  # launch the authentication agent
+      ssh-add ci_tools/github_travis_rsa  # register the decrypted key
+      git config user.name "Automatic Publish"
+      git config user.email "[email protected]"
+      git remote add gh-remote "${GH_REF}";
+      git fetch gh-remote && git fetch gh-remote gh-pages:gh-pages;  # make sure we have the latest gh-remote
+      # push but only if this is not a build triggered by a pull request
+      # note: here we use the --dirty flag so that mkdocs does not clean the additional reports that we copied in the site
+      if [ "${TRAVIS_PULL_REQUEST}" = "false" ] && [ "${TRAVIS_PYTHON_VERSION}" = "3.5" ]; then echo "Pushing to github"; PYTHONPATH=mini_lambda/ mkdocs gh-deploy -v --dirty -f docs/mkdocs.yml --remote-name gh-remote; git push gh-remote gh-pages; fi;
+    else
+      echo "File 'ci_tools/github_travis_rsa' has not been created, please check your encrypted repo token in .travis.yml, on the line starting with 'openssl aes-256-cbc...'"
+    fi
 
 deploy:
-  provider: pypi
-  user: "smarie"
-  password:
-    secure: "L4CcfT7Aq4bTiVAkMadR1dHUgU0GEHFphuywP38OpPAofsgf1b/IFIZPT3SDpo5AhbzpDSm0GGgQmITJrFwUlh4K5ubs/QYB3AWQN/w1yEf9T+ON/UcwtJYvjtrMNHV5yNxtDiSmDe6T8pjV0w9210KB7cW0r3Nkjq4A/Vo6bdInMAiK1pSgreuYHqkvDvKytjBnray8UlPQK4Bc1w7ixA91veNvcD+0OlOrSROzb5No0zbZ8+6PVu0Sa6G5gV32cDWxL7sSSbfaFeebZFgoYPaZkPl14IhG/VA9698yZ26owaqI9UqKPnoO/ySisgxmljc0QA7zJksFYCPzjFOUVVmcDnRgJmcMrqg3wrbXJLYAPHoj1jDtd3R6eEXBDV/Z/rdX33YfalfeRiXj2xA6RBeYGscIrfe93PbOfKOl2oAv5So4Guip2gjubXyHH7720PUQu1D8h5kA/GP0OhISwrRc7SVg3gsx31vpQUMMWgryS4B40aVf30VIlruJFD/JNPBEIjH+otZmc1j4PIJ3swWtPgDKijaPkj0isvacCwMH89+DAYR19QyG/fuLZwEm4Vykrruk6s52FPnootWSShluRu6APbPeZ473UV7SaPDDYXt8eZAz4l7GvGz7yVpHLXLS368oUb4L8N3yICtmHha6vRJcFaVsQ6JFFH3S98A="
-  on:
-    tags: true
-    python: 3.6  # only one of the builds have to be deployed, we'll take the latest since generated code will be more complete
-#  server: https://test.pypi.org/legacy/
-  distributions: "sdist bdist_wheel"
+  # Deploy on PyPI on tags
+  - provider: pypi
+    user: "smarie"
+    password:
+      secure: "L4CcfT7Aq4bTiVAkMadR1dHUgU0GEHFphuywP38OpPAofsgf1b/IFIZPT3SDpo5AhbzpDSm0GGgQmITJrFwUlh4K5ubs/QYB3AWQN/w1yEf9T+ON/UcwtJYvjtrMNHV5yNxtDiSmDe6T8pjV0w9210KB7cW0r3Nkjq4A/Vo6bdInMAiK1pSgreuYHqkvDvKytjBnray8UlPQK4Bc1w7ixA91veNvcD+0OlOrSROzb5No0zbZ8+6PVu0Sa6G5gV32cDWxL7sSSbfaFeebZFgoYPaZkPl14IhG/VA9698yZ26owaqI9UqKPnoO/ySisgxmljc0QA7zJksFYCPzjFOUVVmcDnRgJmcMrqg3wrbXJLYAPHoj1jDtd3R6eEXBDV/Z/rdX33YfalfeRiXj2xA6RBeYGscIrfe93PbOfKOl2oAv5So4Guip2gjubXyHH7720PUQu1D8h5kA/GP0OhISwrRc7SVg3gsx31vpQUMMWgryS4B40aVf30VIlruJFD/JNPBEIjH+otZmc1j4PIJ3swWtPgDKijaPkj0isvacCwMH89+DAYR19QyG/fuLZwEm4Vykrruk6s52FPnootWSShluRu6APbPeZ473UV7SaPDDYXt8eZAz4l7GvGz7yVpHLXLS368oUb4L8N3yICtmHha6vRJcFaVsQ6JFFH3S98A="
+    on:
+      tags: true
+      python: 3.6  # only one of the builds have to be deployed, we'll take the latest since generated code will be more complete
+    #  server: https://test.pypi.org/legacy/
+    distributions: "sdist bdist_wheel"
 
-matrix:
-    fast_finish: true
+  # Create a github release on tags
+  - provider: script
+    script: python ci_tools/github_release.py -s $GITHUB_TOKEN --repo-slug smarie/python-decopatch -cf ./docs/changelog.md -d https://smarie.github.io/python-mini-lambda/changelog/ $TRAVIS_TAG
+    skip_cleanup: true
+    on:
+      tags: true
+      python: 3.5  #only one of the builds have to be deployed
 
 notifications:
   email:

ci_tools/Readme-travis.md

@@ -6,22 +6,44 @@ This is a reminder on how to grant travis the rights to deploy your site on gith
 
 The following does not work on windows as explained [here](https://github.com/travis-ci/travis-ci/issues/4746)
 
+Note: if you get tlsV1 errors below, create_function sure that you have the latest OpenSSL. If it is not available from you package manager, look at this [compilation sequance](https://github.com/curl/curl/issues/1583#issuecomment-309477196) (replace_fixture all versions with the ones you need / the latest). No need to use nghttp2. Dont forget to add `--with-libssh2` to curl compilation step, as mentioned in the [script](https://github.com/dertin/lemp-stack-debian/blob/develop/install.sh)!
+
 ## Install travis commandline 
 
 You have to be outside of the proxy for everything to work correctly, otherwise you will get strange errors mentioning ipaddr... either here or later in the process.
 
-Install ruby using RVM : (**DO NOT USE su OR sudo**)  
+**1- Install ruby** using RVM : (**DO NOT USE su NOR sudo**)  
 
 ```bash
 > \curl -sSL https://get.rvm.io | bash -s stable --ruby
 > source /home/ubuntu/.rvm/scripts/rvm
-> rvm install ruby (this installs to /home/ubuntu/.rvm/src/ruby...)
+> rvm install 2.5.1 (this installs to /home/ubuntu/.rvm/src/ruby...)
+```
+
+*Note: if you already have an old version of rvm you can update it to see the latest ruby versions*:
+```bash
+> rvm get master
+> rvm list known
+```
+
+*Note: if at some point there is an openssl issue inside ruby it is possible to either create_function it use the path you like or have it use its own version as explained [here](https://stackoverflow.com/questions/15511943/troubles-with-rvm-and-openssl)*:
+ 
+Either
+```bash
+> rvm install 2.5.1 --with-openssl-dir=/usr/local/ssl  or (does not work) /usr/bin/openssl
+```
+
+or
+
+```bash
+> rvm pkg install openssl
+> rvm install 2.5.1 --with-openssl-dir=$HOME/.rvm/usr
 ```
 
-Then install travis commandline:
+**2- install travis commandline** by following [these instructions](https://github.com/travis-ci/travis.rb#installation):
 
 ```bash
-> gem install travis
+> gem install travis -v 1.8.8 --no-rdoc --no-ri
 ```
 
 source: 
@@ -47,7 +69,7 @@ Generate an asymetric security key (public + private):
 ssh-keygen -t rsa -b 4096 -C "<your_github_email_address>" -f ci_tools/github_travis_rsa
 ```
 
-On the github repository page, `Settings > Deploy Keys > Add deploy key > add` the PUBLIC generated key (the file `ci_tools/github_travis_rsa.pub`)
+On the github repository page, `Settings > Deploy Keys > Add deploy key > add` the PUBLIC generated key (the file `ci_tools/github_travis_rsa.pub`) with write access
 
 
 Use travis CLI to encrypt your PRIVATE key:
@@ -64,6 +86,8 @@ Follow the instructions on screen :
 - modify the relative path to the generated file by adding 'ci_tools/' in front of 'github_travis_rsa_...enc'.
 - git add the generated file 'github_travis_rsa_...enc' but DO NOT ADD the private key
 
+Note: if you find bug 'no implicit conversion of nil intro String' as mentioned [here](https://github.com/travis-ci/travis.rb/issues/190#issuecomment-377823703), [here](https://github.com/travis-ci/travis.rb/issues/585#issuecomment-374307229) and especially [here](https://github.com/travis-ci/travis.rb/issues/586) it can either be a network proxy error (check that http_proxy is not set...) or a ruby/travis cli version issue. Or worse: an openssl version issue (you check check with wireshark). Best is to reinstall at least the gems: `rvm gemset empty` and then `gem install travis ...` (see above). Note that reinstalling ruby takes a *lot* more time than reinstalling the gems :).
+
 source: 
    * https://djw8605.github.io/2017/02/08/deploying-docs-on-github-with-travisci/ (rejecting https://docs.travis-ci.com/user/deployment/pages/ as this would grant full access to travis)
    * https://docs.travis-ci.com/user/encrypting-files/ 
@@ -84,7 +108,7 @@ source: https://docs.travis-ci.com/user/deployment/pypi/
 
 ## To deploy file releases on github
 
-Similar procedure to encrypt the OAuth password for github releases. **WARNING** unlike 'travis encrypt', this WILL modify your `travis.yml` file. Therefore you should make a backup of it beforehand, and then execute this command with the '--force' option.
+Similar procedure to encrypt the OAuth password for github releases. **WARNING** unlike 'travis encrypt', this WILL modify your `travis.yml` file. Therefore you should create_function a backup of it beforehand, and then execute this command with the '--force' option.
 
 ```bash
 > (cd, source, travis login)

mini_lambda/tests/conftest.py ci_tools/conftest.pymini_lambda/tests/conftest.py renamed to ci_tools/conftest.py

@@ -1,3 +1,6 @@
+"""
+This conftest adds a source link to all tests in the various test reports
+"""
 from py.xml import html
 import pytest
 from setuptools_scm.git import GitWorkdir

ci_tools/generate-junit-badge.py

@@ -1,28 +1,70 @@
+import sys
+try:
+    # python 3
+    from urllib.parse import quote_plus
+except ImportError:
+    # python 2
+    from urllib import quote_plus
+
 import requests
 import shutil
 from os import makedirs, path
 import xunitparser
 
 
-def download_badge(junit_xml: str='reports/junit/junit.xml', dest_folder: str='reports/junit'):
+class TestStats(object):
+    def __init__(self, success_percentage, success, runned, skipped):
+        self.success_percentage = success_percentage
+        self.success = success
+        self.runned = runned
+        self.skipped = skipped
 
-    makedirs(dest_folder, exist_ok=True)
 
-    # read the junit test file
+def get_test_stats(junit_xml='reports/junit/junit.xml'  # type: str
+                   ):
+    # type: (...) -> TestStats
+    """
+    read the junit test file and extract the success percentage
+    :param junit_xml: the junit xml file path
+    :return: the success percentage (an int)
+    """
     ts, tr = xunitparser.parse(open(junit_xml))
-    runned = tr.testsRun
+    skipped = len(tr.skipped)
+    runned = tr.testsRun - skipped
     failed = len(tr.failures)
+    success = runned - failed
+
+    success_percentage = round(success * 100 / runned)
+
+    return TestStats(success_percentage, success, runned, skipped)
+
+
+def download_badge(test_stats,                  # type: TestStats
+                   dest_folder='reports/junit'  # type: str
+                   ):
+    """
+    Downloads the badge corresponding to the provided success percentage, from https://img.shields.io.
 
-    success_percentage = round((runned - failed) * 100 / runned)
-    if success_percentage < 50:
+    :param test_stats:
+    :param dest_folder:
+    :return:
+    """
+    if not path.exists(dest_folder):
+        makedirs(dest_folder)  # , exist_ok=True) not python 2 compliant
+
+    if test_stats.success_percentage < 50:
         color = 'red'
-    elif success_percentage < 75:
+    elif test_stats.success_percentage < 75:
         color = 'orange'
-    elif success_percentage < 90:
+    elif test_stats.success_percentage < 90:
         color = 'green'
     else:
         color = 'brightgreen'
-    url = 'https://img.shields.io/badge/tests-' + str(success_percentage) + '%25-' + color + '.svg'
+
+    left_txt = "tests"
+    # right_txt = "%s%%" % test_stats.success_percentage
+    right_txt = "%s/%s" % (test_stats.success, test_stats.runned)
+    url = 'https://img.shields.io/badge/%s-%s-%s.svg' % (left_txt, quote_plus(right_txt), color)
 
     dest_file = path.join(dest_folder, 'junit-badge.svg')
 
@@ -35,5 +77,19 @@ def download_badge(junit_xml: str='reports/junit/junit.xml', dest_folder: str='r
 
 
 if __name__ == "__main__":
-    # execute only if run as a script
-    download_badge()
+    # Execute only if run as a script.
+    # Check the arguments
+    assert len(sys.argv[1:]) == 1, "a single mandatory argument is required: <threshold>"
+    threshold = float(sys.argv[1])
+
+    # First retrieve the success percentage from the junit xml
+    test_stats = get_test_stats()
+
+    # Validate against the threshold
+    print("Success percentage is %s%%. Checking that it is >= %s" % (test_stats.success_percentage, threshold))
+    if test_stats.success_percentage < threshold:
+        raise Exception("Success percentage %s%% is strictly lower than required threshold %s%%"
+                        "" % (test_stats.success_percentage, threshold))
+
+    # Download the badge
+    download_badge(test_stats)