Add docker image and Github action. (#617)

Apply style changes from black test.

Author: Spacetown

.dockerignore

@@ -0,0 +1,19 @@
+# ignore all by default
+*
+
+# explicitly allow certain code files, build files config files, and documentation
+!*.py
+!atlassian/**.py
+!docs/**.py
+!**.md
+!**.rst
+!*.txt
+!*.cfg
+!**/requirements.txt
+
+# explicitly allow tests
+!doc/examples
+!tests
+
+# always ignore these files
+**/*.pyc

.gitbugtraq

@@ -0,0 +1,5 @@
+# .gitbugtraq for Git GUIs (e.g. SmartGit) to show links to the Github issue tracker.
+[bugtraq]
+  url = https://github.com/atlassian-api/atlassian-python-api/issues/%BUGID%
+  loglinkregex = "#\\d+"
+  logregex = \\d+

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+
+  run-docker:
+
+    runs-on: ubuntu-18.04
+  
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.4', '3.5', '3.6', '3.7', '3.8']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run Docker
+      run: |
+        make docker-qa PYTHON_VERSION=${{matrix.python-version}}
+    

.travis.yml

@@ -17,4 +17,4 @@ install: pip install tox-travis
 before_script:
   - .travis/bump_version ./ minor > atlassian/VERSION
 script:
-  - tox
+  - make qa

CONTRIBUTING.rst

@@ -16,6 +16,7 @@ Getting Started
 * Start up related product:
   - Standalone product atlas-run-standalone_
   - For cloud product, just do registration
+* Run the quality checks with `make qa` or if you have docker installed with `make docker-qa` 
 * Send pull request
 
 .. _Fork: https://help.github.com/articles/fork-a-repo/

Dockerfile.qa

@@ -0,0 +1,21 @@
+FROM ubuntu:18.04
+
+ARG PYTHON_VERSION
+
+RUN \
+  apt update && \
+  apt-get install -y make gcc-5 libkrb5-dev python$PYTHON_VERSION python3-pip && \
+  apt-get clean
+
+WORKDIR /atlassian-python-api
+COPY requirements.txt .
+COPY requirements-dev.txt .
+
+ENV PYTHON_VERSION=PYTHON_VERSION
+
+RUN \
+  python3 -m pip install --no-cache-dir --upgrade pip && \
+  python3 -m pip install --no-cache-dir -r requirements-dev.txt
+
+CMD python3 -m pip install -e . && \
+  make qa PYTHON_VERSION=$PYTHON_VERSION

Makefile

@@ -0,0 +1,46 @@
+# This Makefile helps perform some developer tasks, like linting or testing.
+# Run `make` or `make help` to see a list of tasks.
+# Based on GCOVR project (https://github.com/gcovr/gcovr).
+
+PYTHON_VERSION ?= 3.7
+
+
+QA_CONTAINER ?= atlassian-python-api-qa-$(PYTHON_VERSION)
+TEST_OPTS ?=
+
+.PHONY: help setup-dev qa lint test doc docker-qa docker-qa-build
+
+help:
+	@echo "select one of the following targets:"
+	@echo "  help       print this message"
+	@echo "  setup-dev  prepare a development environment"
+	@echo "  qa         run all QA tasks"
+	@echo "  test       run the tests"
+	@echo "  docker-qa  run qa in the docker container"
+	@echo "  docker-qa-build"
+	@echo "             build the qa docker container"
+	@echo ""
+	@echo "environment variables:"
+	@echo "  TEST_OPTS  additional flags for pytest [current: $(TEST_OPTS)]"
+	@echo "  QA_CONTAINER"
+	@echo "             tag for the qa docker container [current: $(QA_CONTAINER)]"
+
+setup-dev:
+	python3 -m pip install --upgrade pip pytest
+	python3 -m pip install -r requirements-dev.txt
+
+qa: tox
+
+tox:
+	tox
+
+docker-qa: export TEST_OPTS := $(TEST_OPTS)
+
+docker-qa: | docker-qa-build
+	docker run --rm -e TEST_OPTS -v `pwd`:/atlassian-python-api $(QA_CONTAINER)
+
+docker-qa-build: Dockerfile.qa requirements.txt requirements-dev.txt
+	docker build \
+		--tag $(QA_CONTAINER) \
+		--build-arg PYTHON_VERSION=$(PYTHON_VERSION) \
+		--file $< .