Merge pull request #20 from CSCfi/devel

bump to 0.4.3

Author: blankdots

.github/workflows/eslint.yml

@@ -0,0 +1,25 @@
+name: Javascript ESLint check
+
+on: [push]
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ '12', '14' ]
+    name: Node ${{ matrix.node }} eslint check
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install dependencies
+        run: npm i -g eslint
+      - name: Run eslint
+        run: |
+          pushd bindings/js
+          eslint --no-eslintrc --ext js --env es6,node --parser-options=ecmaVersion:8 --parser-options=sourceType:module swift_sharing_request_bind.js
+      

.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+name: Publish Docker image
+
+on:
+  release:
+    types: [published]
+  push:
+    branches: [master, devel]
+
+jobs:
+  push_to_registry:
+    name: Push swift-sharing-request Docker image to Docker Hub
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Login to DockerHub Registry
+        run: echo '${{ secrets.DOCKER_PASSWORD }}' | docker login -u '${{ secrets.DOCKER_USERNAME }}' --password-stdin
+      - name: Get the version
+        id: vars
+        run: echo ::set-output name=tag::$(echo ${GITHUB_REF:10})
+      - name: Build the tagged Docker image
+        if:  ${{ steps.vars.outputs.tag != '/master' && steps.vars.outputs.tag != '/devel' }}
+        run: docker build . --file Dockerfile --tag cscfi/swift-sharing-request:${{steps.vars.outputs.tag}}
+      - name: Push the tagged Docker image
+        if:  ${{ steps.vars.outputs.tag != '/master' && steps.vars.outputs.tag != '/devel' }}
+        run: docker push cscfi/swift-sharing-request:${{steps.vars.outputs.tag}}
+      - name: Build the latest Docker image
+        if:  ${{ steps.vars.outputs.tag == '/master' }}
+        run: docker build . --file Dockerfile --tag cscfi/swift-sharing-request:latest
+      - name: Push the latest Docker image
+        if:  ${{ steps.vars.outputs.tag == '/master' }}
+        run: docker push cscfi/swift-sharing-request:latest
+      - name: Build the stage Docker image
+        if:  ${{ steps.vars.outputs.tag == '/devel' }}
+        run: docker build . --file Dockerfile --tag cscfi/swift-sharing-request:stage
+      - name: Push the stage Docker image
+        if:  ${{ steps.vars.outputs.tag == '/devel' }}
+        run: docker push cscfi/swift-sharing-request:stage

.github/workflows/style.yml

@@ -0,0 +1,28 @@
+name: Python style check
+
+on: [push]
+
+jobs:
+  style_check:
+    strategy:
+      max-parallel: 4
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.7]
+      
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox tox-gh-actions
+    - name: Test flake8 syntax with tox
+      run: tox -e flake8
+    - name: bandit static check
+      run: tox -e bandit

.github/workflows/unit.yml

@@ -0,0 +1,26 @@
+name: Python Unit Tests
+
+on: [push]
+
+jobs:
+  unit_test:
+    strategy:
+      max-parallel: 4
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.6, 3.7]
+    
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox tox-gh-actions
+    - name: Run unit tests
+      run: tox -e pytest

.travis.yml

@@ -1,4 +1,4 @@
-FROM python:3.7-alpine3.9 as BACKEND
+FROM python:3.7-alpine3.12 as BACKEND
 
 RUN apk add --update \
     && apk add --no-cache build-base curl-dev linux-headers bash git\
@@ -13,15 +13,15 @@ RUN pip install --upgrade pip\
     && pip install -r /root/swift_request/requirements.txt \
     && pip install /root/swift_request
 
-FROM python:3.7-alpine3.9
+FROM python:3.7-alpine3.12
 
 RUN apk add --no-cache --update bash
 
 LABEL maintainer "CSC Developers"
 LABEL org.label-schema.schema-version="1.0"
 LABEL org.label-schema.vcs-url="https://github.com/CSCFI/swift-sharing-request"
 
-COPY --from=BACKEND usr/local/lib/python3.7 usr/local/lib/python3.7/
+COPY --from=BACKEND /usr/local/lib/python3.7 /usr/local/lib/python3.7/
 
 COPY --from=BACKEND /usr/local/bin/gunicorn /usr/local/bin/
 

Dockerfile

@@ -1,3 +1,7 @@
+![Python style check](https://github.com/CSCfi/swift-sharing-request/workflows/Python%20style%20check/badge.svg)
+![Javascript ESLint check](https://github.com/CSCfi/swift-sharing-request/workflows/Javascript%20ESLint%20check/badge.svg)
+![Python Unit Tests](https://github.com/CSCfi/swift-sharing-request/workflows/Python%20Unit%20Tests/badge.svg)
+
 ### swift-request-backend
 API for requesting access to swift containers, to enable more fluid container
 sharing process, the main use being the abstraction of separation of the

README.md

@@ -2,6 +2,6 @@
 
 
 __name__ = "swift_sharing_request"
-__version__ = "0.4.2"
+__version__ = "0.4.3"
 __author__ = "CSC Developers"
 __license__ = "MIT License"

swift_sharing_request/__init__.py

@@ -2,28 +2,15 @@
 
 
 import logging
-import asyncio
 
 import aiohttp.web
 from asyncpg import InterfaceError
 
 
-MODULE_LOGGER = logging.getLogger("api")
+from .db import handle_dropped_connection
 
 
-def handle_dropped_connection(request):
-    """Handle dropped database connection."""
-    MODULE_LOGGER.log(
-        logging.ERROR,
-        "Lost database connection, reconnecting..."
-    )
-    request.app["db_conn"].erase()
-    asyncio.ensure_future(
-        request.app["db_conn"].open()
-    )
-    raise aiohttp.web.HTTPServiceUnavailable(
-        reason="No database connection."
-    )
+MODULE_LOGGER = logging.getLogger("api")
 
 
 async def handle_share_request_post(request):
@@ -166,3 +153,30 @@ async def handle_user_list_tokens(
         rec["identifier"]
         for rec in tokens
     ])
+
+
+async def handle_health_check(
+        request: aiohttp.web.Request
+) -> aiohttp.web.Response:
+    """Answer a service health check."""
+    # Case degraded
+    try:
+        if request.app["db_conn"].conn.is_closed():
+            return aiohttp.web.json_response({
+                "status": "Degraded",
+                "degraded": [
+                    "database"
+                ]
+            })
+    except AttributeError:
+        return aiohttp.web.json_response({
+            "status": "Degraded",
+            "degraded": [
+                "database"
+            ]
+        })
+
+    # Case nominal
+    return aiohttp.web.json_response({
+        "status": "Ok",
+    })

swift_sharing_request/api.py

@@ -15,6 +15,9 @@
 import logging
 
 import aiohttp.web
+from asyncpg import InterfaceError
+
+from .db import handle_dropped_connection
 
 
 AiohttpHandler = typing.Callable[
@@ -84,7 +87,6 @@ async def handle_validate_authentication(
         )
 
     project_tokens = []
-    project = None
     try:
         project = request.match_info["project"]
     except KeyError:
@@ -94,18 +96,22 @@ async def handle_validate_authentication(
             try:
                 project = request.query["project"]
             except KeyError:
-                pass
+                project = None
     finally:
         if project:
-            project_tokens = [
-                rec["token"].encode("utf-8")
-                for rec in await request.app["db_conn"].get_tokens(project)
-            ]
+            try:
+                project_tokens = [
+                    rec["token"].encode("utf-8")
+                    for rec in await request.app["db_conn"].get_tokens(project)
+                ]
+            except InterfaceError:
+                handle_dropped_connection(request)
         else:
             LOGGER.debug(f"No project ID found in request {request}")
-            raise aiohttp.web.HTTPUnauthorized(
-                reason="No project ID in request"
-            )
+            if request.path != "/health":
+                raise aiohttp.web.HTTPUnauthorized(
+                    reason="No project ID in request"
+                )
 
     await test_signature(
         request.app["tokens"] + project_tokens,