Merge pull request #21 from Exabyte-io/feature/SOF-4351

Feature/sof 4351

Author: triplepoint

.gitignore

@@ -1,4 +1,10 @@
-.idea/
+*.pyc
+.idea
+Vagrantfile
+.vagrant
+htmlcov_*
+coverage_*.xml
+venv*/
 
 ### See: https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore
 # Byte-compiled / optimized / DLL files

pyproject.toml

@@ -0,0 +1,10 @@
+[build-system]
+requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
+build-backend = "setuptools.build_meta:__legacy__"
+
+[tool.setuptools_scm]
+version_scheme = "post-release"
+
+[tool.coverage.run]
+source = ['.']
+omit = ['env*/*', 'venv*/*', 'tests/*']

requirements-dev.txt

@@ -1,9 +1,9 @@
-certifi==2020.6.20
+certifi==2020.12.5
 chardet==3.0.4
+coverage==5.5
 idna==2.7
-mock==1.3.0
-pbr==5.5.1
+mock==4.0.3
 requests==2.20.1
-six==1.15.0
+toml==0.10.2
 urllib3==1.24.3
 -e .[test]

run-tests.sh

@@ -4,9 +4,10 @@ set -e
 TEST_TYPE="unit"
 PYTHON_BIN="python3"
 THIS_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" > /dev/null 2>&1 && pwd)"
+VENV_NAME="venv"
 
 usage() {
-    echo "run-tests.sh -p=PYTHON_BIN -t=TEST_TYPE"
+    echo "run-tests.sh -p=PYTHON_BIN -v=VENV_NAME -t=TEST_TYPE"
     exit 1
 }
 
@@ -19,6 +20,9 @@ check_args() {
             -p=* | --python-bin=*)
                 PYTHON_BIN="${i#*=}"
                 ;;
+            -v=* | --venvdir=*)
+                VENV_NAME="${i#*=}"
+                ;;
             *)
                 usage
                 ;;
@@ -29,15 +33,17 @@ check_args() {
 check_args $@
 
 # Prepare the execution virtualenv
-virtualenv --python ${PYTHON_BIN} ${THIS_DIR}/venv
-source ${THIS_DIR}/venv/bin/activate
+virtualenv --python ${PYTHON_BIN} ${THIS_DIR}/${VENV_NAME}
+source ${THIS_DIR}/${VENV_NAME}/bin/activate
 trap "deactivate" EXIT
 if [ -f ${THIS_DIR}/requirements-dev.txt ]; then
     pip install -r ${THIS_DIR}/requirements-dev.txt --no-deps
 fi
 
 # Execute the specified test suite
-python -m unittest discover --verbose --catch --start-directory ${THIS_DIR}/tests/${TEST_TYPE}
-if [ $? -ne 0 ]; then
-    exit 1
-fi
+coverage run -m unittest discover --verbose --catch --start-directory ${THIS_DIR}/tests/${TEST_TYPE}
+
+# Generate the code coverage reports
+coverage report
+coverage html --directory htmlcov_${TEST_TYPE}
+coverage xml -o coverage_${TEST_TYPE}.xml

setup.py

@@ -5,7 +5,10 @@
 
 setup(
     name='exabyte-api-client',
-    version='2021.01.18.1',
+    setup_requires=['setuptools_scm'],
+    use_scm_version={
+        'version_scheme': 'post-release',
+    },
     description='Exabyte Python Client for RESTful API',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -18,6 +21,7 @@
     ],
     extras_require={
         "test": [
+            "coverage[toml]>=5.3",
             "mock>=1.3.0",
         ],
     },