Add testing script, derp, and python-based version test

Author: kroenlein

.travis.yml

@@ -18,11 +18,9 @@ install:
 - pip install -U -r test_requirements.txt
 - pip install --no-deps -e .
 script:
-- flake8 gemd
-- pytest --cov=gemd --cov-report term-missing:skip-covered --cov-config=tox.ini --no-cov-on-fail --cov-fail-under=100 gemd
+- bash scripts/run_tests.sh
 - cd docs; make html; cd ..;
 - touch ./docs/_build/html/.nojekyll
-- if [ "$TRAVIS_PULL_REQUEST" != "false" ] && [ "$TRAVIS_BRANCH" == "main" ]; then bash ./scripts/validate-version-bump.sh; fi
 deploy:
   - provider: pages
     skip_cleanup: true

CONTRIBUTING.md

@@ -8,20 +8,13 @@ Changes are gated on:
  * PEP8 style compliance, with some exceptions in the [tox file](tox.ini)
  * Incrementing the package version number in [setup.py](setup.py)
 
-Check out the [.travis.yml](.travis.yml) file for the exact testing procedure.
+Travis runs the tests in `scripts/run_tests.sh`, which gives a convenient one-line invocation for testing.
 
 As it can be easy to forget to verify these prior to pushing, it's possible to use [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) to enforce compliance during normal workflows.
 Consider editing `.git/hooks/pre-commit` or `.git/hooks/pre-push` (or adding them and marking them as executable: `chmod +x <file>`). 
 For example, you could set your local `.git/hooks/pre-commit` to be
 ```shell
-if [ "`git rev-parse --abbrev-ref HEAD`" == "main" ];
-     then echo "On main branch";
-     exit 1;
-fi                                 &&
-scripts/validate-version-bump.sh   &&
-flake8 gemd                        &&
-pytest --quiet --cov=gemd --cov-report term-missing:skip-covered   \
-  --cov-config=tox.ini --no-cov-on-fail --cov-fail-under=100 -x .
+scripts/run_tests.sh --quiet --exitfirst
 ```
 to make sure you're not on the `main` branch, you've incremented the package version, you pass the linter and you have complete, passing tests.
 

scripts/run_tests.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+for i in "$@"; do
+  case $i in
+    -q|--quiet)
+      QUIET="--quiet --no-cov-on-fail "
+      shift # past argument=value
+      ;;
+    -x|--exitfirst)
+      EXITFIRST="--exitfirst "
+      shift # past argument=value
+      ;;
+    -*|--*)
+      echo "Unknown option $i"
+      exit 1
+      ;;
+    *)
+      ;;
+  esac
+done
+
+REPO_DIR=`git rev-parse --show-toplevel`
+
+# following https://docs.travis-ci.com/user/environment-variables/#convenience-variables
+# the pull request isn't set to true if its a PR; its just set to false if its not.
+if [ -z "$TRAVIS_PULL_REQUEST" ];  # Not Travis context
+then
+    if [ "`git rev-parse --abbrev-ref HEAD`" == "main" ];
+    then echo "On main branch";                                                  exit 1;
+    else python $REPO_DIR/scripts/validate_version_bump.py                    || exit 1;
+    fi
+# only run the validate-version_bump.py script on PR builds against main,
+# since those have access to a "main" reference to git show the version
+elif [ "$TRAVIS_PULL_REQUEST" != "false" ] && [ "$TRAVIS_BRANCH" == "main" ];
+then python $REPO_DIR/scripts/validate_version_bump.py                        || exit 1;
+fi
+
+flake8 $REPO_DIR/gemd                                                         || exit 1;
+derp $REPO_DIR $REPO_DIR/setup.py                                             || exit 1;
+pytest $QUIET $EXITFIRST --cov=$REPO_DIR                                     \
+       --cov-report term-missing:skip-covered                                \
+       --cov-config=$REPO_DIR/tox.ini --no-cov-on-fail --cov-fail-under=100  \
+       $REPO_DIR/gemd                                                         || exit 1;

scripts/validate_version_bump.py

@@ -0,0 +1,65 @@
+#!python
+from os import getcwd, popen
+from os.path import relpath
+from packaging.version import Version
+import re
+import sys
+from typing import TextIO
+
+
+def main():
+    repo_dir = popen("git rev-parse --show-toplevel", mode="r").read().rstrip()
+    version_path = relpath(f'{repo_dir}/setup.py', getcwd())
+
+    try:
+        with open(version_path, "r") as fh:
+            new_version = extract_version(fh)
+    except Exception as e:
+        raise ValueError(f"Couldn't extract version from {version_path}") from e
+
+    try:
+        with popen(f"git show main:setup.py", mode="r") as fh:
+            old_version = extract_version(fh)
+    except Exception as e:
+        raise ValueError(f"Couldn't extract version from main branch") from e
+
+    if new_version.major != old_version.major:
+        number = "major"
+        code = 1
+    elif new_version.minor != old_version.minor:
+        number = "minor"
+        code = 2
+    elif new_version.micro != old_version.micro:
+        number = "patch"
+        code = 3
+    else:
+        number = "other component of"
+        code = 5
+
+    if new_version > old_version:
+        print(f"{number} version bump")
+        return 0
+    elif new_version < old_version:
+        print(f"error - {number} version decreased! {new_version} < {old_version}")
+        return code
+    else:
+        print(f"error - version unchanged! {new_version} == {old_version}")
+        return 4
+
+
+def extract_version(handle: TextIO) -> Version:
+    text = handle.read()
+    if not re.search(r"\S", text):
+        raise ValueError(f"No content")
+    match = re.search(r"""^\s*_*version_*\s*=\s*(['"])(\S+)\1""", text, re.MULTILINE)
+    if match:
+        return Version(match.group(2))
+    else:
+        raise ValueError(f"No version found\n{text}")
+
+
+if __name__ == "__main__":
+    sys.tracebacklimit = 0
+    result = main()
+    if result != 0:
+        sys.exit(result)

setup.py

@@ -2,7 +2,7 @@
 
 
 setup(name='gemd',
-      version='1.12.2',
+      version='1.12.3',
       url='http://github.com/CitrineInformatics/gemd-python',
       description="Python binding for Citrine's GEMD data model",
       author='Citrine Informatics',

test_requirements.txt

@@ -5,3 +5,4 @@ pydocstyle==3.0.0
 pytest-cov==3.0.0
 pytest-flake8==1.0.4
 pandas>=1.1.5,<2
+derp==0.1.1