Test Release (#8)

* Authenticate/Authorise on resources (#5)

* Added PyJWT

* Resource API now requires authentication/authorisation

* Greeting makes use of the new read fixture

* Skipping tests when no OIDC configuration is available

* More appropriate permissions

* Tests should be running an install the first time they execute

* Additional check whether the test configuration file exists

* Fixed pylint complaint

... by ignoring the unnecessary lambda that needs to be there

* Fixed flake8 complaints

* Switching to 'compatible' requirements

* Reorganised the build/release workflow (#7)

* Enabling coverage measurement again

* My YAML style

* Version calculation

* Pipeline debugging

* Pipeline debugging

* Pipeline debugging

* Pipeline debugging

* Pipeline debugging

* Finetuning build mech

Author: MrMatAP

.github/workflows/build.yml

@@ -1,54 +1,84 @@
-name: Build
+#
+# Main workflow to build and release
+
+name: Main
+
+#
+# Operational Variables
+
+env:
+  MAJOR: 0
+  MINOR: 0
+  PYTHON_VERSION: 3.9.6
+
+#
+# Establish when the workflow is run
+# What we want is that a release is made whenever we merge into master. Here is an example:
+# if: ${{ github.event_name == 'pull_request' && github.event.pull_request.merged == true && github.base_ref == 'refs/heads/main' }}
+# But really, we can also just say that a push into master causes a release. Whether that must come from a PR
+# can be controlled via branch protection
 
 on:
-  push:
-    branches: [ main, develop ]
-  pull_request:
-    branches: [ main ]
+  push: {}
+  pull_request: {}
+
+#
+# Workflow
 
 jobs:
-  build:
 
+  build:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [3.9]
-
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
+
+    - name: Determine whether this is a release build
+      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+      env:
+        IS_RELEASE: "true"
+      run: echo "We will be performing a release upon success"
+
+    - name: Checkout out our code
+      uses: actions/checkout@v2
+
+    - name: Set up Python ${{ env.PYTHON_VERSION }}
       uses: actions/setup-python@v2
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: ${{ env.PYTHON_VERSION }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        pip install wheel
         pip install -r requirements.txt
         pip install -r test-requirements.txt
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Lint with pylint
+
+    - name: Lint
       run: |
+        flake8 --statistics
         pylint mrmat_python_api_flask
-    - name: Install locally
+
+    - name: Test
       run: |
         python ./setup.py install
-    - name: Test with pytest
-      run: |
-        python -m pytest --junitxml=build/test-results-${{ matrix.python-version }}.xml
-    - name: Upload pytest test results
+        python -m pytest
+
+    - name: Upload test results
       uses: actions/upload-artifact@v2
-      with:
-        name: pytest-results-${{ matrix.python-version }}
-        path: build/test-results-${{ matrix.python-version }}.xml
-      # Use always() to always run this step to publish test results when there are test failures
       if: ${{ always() }}
+      with:
+        name: tests
+        path: build/junit.xml
+
     - name: Upload coverage
       uses: actions/upload-artifact@v2
       with:
         name: coverage
         path: build/coverage.xml
+
+    - name: Conditionally perform a release
+      if: ${{ env.IS_RELEASE == 'true' }}
+      uses: elgohr/Github-Release-Action@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
+      with:
+        args: Creating release

.github/workflows/sast.yml

@@ -7,7 +7,7 @@ Boilerplate code for a Python Flask API
 
 This variant of a Python Flask API is code-first and using native Flask
 
-Features:
+## Features
 
 * Code-first
 * Pluggable APIs and multiple API versions
@@ -17,6 +17,15 @@ Features:
 * No TLS, because this is intended to run behind a reverse proxy
 * Healthz
 
+## How to build this
+
+Use the standard `python ./setup.py install` to build. There are two environment variables that influence the build
+
+| Environment Variable | Default | Description |
+|----------------------|---------|-------------|
+| IS_RELEASE           | <unset> | If unset, `.dev0` is appended to the version being built, otherwise an empty string |
+| GITHUB_RUN_NUMBER    | 0       | Determines the micro version. If unset, the micro number is 0 |
+
 ## How to run this
 
 You have the choice of running this 

.idea/codeStyles/codeStyleConfig.xml

@@ -1,15 +1,15 @@
 # Runtime requirements
 
-flask==1.1.2                    # BSD 3-Clause
-Flask-SQLAlchemy==2.5.1         # BSD 3-Clause
-Flask-Migrate==2.7.0            # MIT
-Flask-Marshmallow==0.14.0       # MIT
-marshmallow-sqlalchemy==0.25.0  # MIT
+flask~=1.1.2                    # BSD 3-Clause
+Flask-SQLAlchemy~=2.5.1         # BSD 3-Clause
+Flask-Migrate~=2.7.0            # MIT
+Flask-Marshmallow~=0.14.0       # MIT
+marshmallow-sqlalchemy~=0.25.0  # MIT
 
-psycopg2==2.9.1                 # LGPL with exceptions
+psycopg2~=2.9.1                 # LGPL with exceptions
 
-Flask-OIDC==1.4.0               # MIT
-requests_oauthlib==1.3.0        # ISC
+Flask-OIDC~=1.4.0               # MIT
+requests_oauthlib~=1.3.0        # ISC
 
-cli-ui==0.12                    # BSD 3-Clause
-halo==0.0.31                    # MIT
+cli-ui~=0.12                    # BSD 3-Clause
+halo~=0.0.31                    # MIT

README.md

@@ -20,11 +20,22 @@
 #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #  SOFTWARE.
 
+import os
 from setuptools import setup, find_packages
 
+#
+# Construct the version
+# If we are running in the context of a GitHub action then we use the GITHUB_RUN_NUMBER
+# otherwise we will default to 0 for the micro version.
+
+major = 0
+minor = 0
+micro = os.environ['GITHUB_RUN_NUMBER'] if 'GITHUB_RUN_NUMBER' in os.environ else 0
+dev = '.dev0' if 'IS_RELEASE' not in os.environ else ''
+
 setup(
     name='mrmat-python-api-flask',
-    version='0.0.3',
+    version=f'{major}.{minor}.{micro}{dev}',
     packages=find_packages(),
     license='MIT',
     author='MrMat',