Cleanup (#40)

* Update dependencies and fix conflicts with ETOS Library

* Fix pylint, pydocstyle and black

* Fix tests

* Add github actions

* Fix hadolint errors

* Fix review comments and update etos library version

Author: t-persson

.github/workflows/main.yml

@@ -0,0 +1,58 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events
+on: [push, pull_request]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  run-tox:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under , so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Setup python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: Install Tox
+        run: pip install tox
+      - name: Upgrade setuptools
+        run: pip install -U setuptools
+      - name: Run Tox
+        run: tox
+
+  run-hadolint:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under , so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Run hadolint for API
+        uses: hadolint/hadolint-action@master
+        with:
+          dockerfile: Dockerfile
+
+  build-docker-images:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under , so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Build API image
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile

.gitignore

@@ -13,6 +13,7 @@ __pycache__/*
 .*.swp
 */.ipynb_checkpoints/*
 .DS_Store
+.tags
 
 # Project files
 .ropeproject
@@ -48,3 +49,4 @@ MANIFEST
 
 # Per-project virtualenvs
 .venv*/
+.python-version

Dockerfile

@@ -5,13 +5,18 @@ WORKDIR /src
 RUN python3 setup.py bdist_wheel
 
 FROM python:3.9.0-slim-buster
-
+ARG TZ
+ENV TZ=$TZ
 
 COPY --from=build /src/dist/*.whl /tmp
 # hadolint ignore=DL3013
+# hadolint ignore=DL3008
 
-# Installing an older version of pip as we wait for a real release of gql.
-RUN apt-get update && apt-get install -y gcc libc-dev --no-install-recommends && pip install --no-cache-dir pip==20.1.1 && pip install --no-cache-dir /tmp/*.whl && apt-get purge -y --auto-remove gcc libc-dev
+RUN apt-get update && \
+    apt-get install -y gcc libc-dev tzdata --no-install-recommends && \
+    pip install --no-cache-dir /tmp/*.whl && \
+    apt-get purge -y --auto-remove gcc libc-dev && \
+	rm -rf /var/lib/apt/lists/*
 
 RUN groupadd -r etos && useradd -r -m -s /bin/false -g etos etos
 USER etos

docs/conf.py

@@ -92,8 +92,8 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"etos_api"
-copyright = u"2020, Axis Communications AB"
+project = "etos_api"
+copyright = "Axis Communications AB"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -241,7 +241,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ("index", "user_guide.tex", u"etos_api Documentation", u"", "manual"),
+    ("index", "user_guide.tex", "etos_api Documentation", "", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

requirements.txt

@@ -11,17 +11,10 @@
 # Add your pinned requirements so that they can be easily installed with:
 # pip install -r requirements.txt
 # Remember to also add them in setup.cfg but unpinned.
-# Example:
-# numpy==1.13.3
-# scipy==1.0
-#
-etos_lib==2.1.0
-pyscaffold==3.2.3
-uvicorn==0.12.2
-fastapi==0.61.1
-aiohttp[speedups]==3.6.2
 
-# These are not compatible with etos library
-multidict==5.1.0
-gql==v3.0.0a3
-graphql-core<3.2,>=3.1
+etos_lib==3.2.1
+pyscaffold~=4.4
+uvicorn~=0.22
+fastapi~=0.96.0
+aiohttp[speedups]~=3.8
+gql[requests]~=3.4

setup.cfg

@@ -24,14 +24,12 @@ package_dir =
 # DON'T CHANGE THE FOLLOWING LINE! IT WILL BE UPDATED BY PYSCAFFOLD!
 setup_requires = pyscaffold>=3.2a0,<3.3a0
 install_requires =
-    etos_lib==2.1.0
-    pyscaffold==3.2.3
-    uvicorn==0.12.2
-    fastapi==0.61.1
-    aiohttp[speedups]==3.6.2
-    multidict==5.1.0
-    gql==v3.0.0a3
-    graphql-core<3.2,>=3.1
+    etos_lib==3.2.1
+    pyscaffold~=4.4
+    uvicorn~=0.22
+    fastapi~=0.96.0
+    aiohttp[speedups]~=3.8
+    gql[requests]~=3.4
 
 # Require a specific Python version, e.g. Python 2.7 or >= 3.4
 python_requires = >=3.4

src/etos_api/__init__.py

@@ -16,8 +16,12 @@
 """ETOS API module."""
 import os
 from importlib.metadata import version, PackageNotFoundError
-from etos_api.library.context_logging import ContextLogging
 from etos_lib.logging.logger import setup_logging
+from etos_api.library.context_logging import ContextLogging
+
+# The API shall not send logs to RabbitMQ as it
+# is too early in the ETOS test run.
+os.environ["ETOS_ENABLE_SENDING_LOGS"] = "false"
 
 try:
     VERSION = version("environment_provider")

src/etos_api/library/context_logging.py

@@ -16,7 +16,7 @@
 """ETOS API context based logging."""
 import logging
 from contextvars import ContextVar
-from etos_lib.logging.logger import setup_logging, FORMAT_CONFIG
+from etos_lib.logging.logger import FORMAT_CONFIG
 
 
 class ContextLogging(logging.Logger):

src/etos_api/library/graphql.py

@@ -15,7 +15,8 @@
 # limitations under the License.
 """Graphql query handler."""
 import asyncio
-from gql import gql, AIOHTTPTransport, Client
+from gql import gql, Client
+from gql.transport.aiohttp import AIOHTTPTransport
 
 
 class GraphqlQueryHandler:  # pylint:disable=too-few-public-methods

src/etos_api/library/validator.py

@@ -17,10 +17,15 @@
 import logging
 from uuid import UUID
 from typing import Union, List
-from pydantic import BaseModel, validator, ValidationError, constr, conlist
+
+# Pylint refrains from linting C extensions due to arbitrary code execution.
+from pydantic import BaseModel, constr, conlist  # pylint:disable=no-name-in-module
+from pydantic import validator, ValidationError
 import requests
 from etos_api.library.docker import Docker
 
+# pylint:disable=too-few-public-methods
+
 
 class Environment(BaseModel):
     """ETOS suite definion 'ENVIRONMENT' constraint."""
@@ -119,10 +124,8 @@ def validate_constraints(
         for constraint in value:
             model = cls.__constraint_models.get(constraint.key)
             if model is None:
-                raise TypeError(
-                    "Unknown key %r, valid keys: %r"
-                    % (constraint.key, tuple(cls.__constraint_models.keys()))
-                )
+                keys = tuple(cls.__constraint_models.keys())
+                raise TypeError(f"Unknown key {constraint.key}, valid keys: {keys}")
             try:
                 model(**constraint.dict())
             except ValidationError as exception:
@@ -131,12 +134,12 @@ def validate_constraints(
         more_than_one = [key for key, number in count.items() if number > 1]
         if more_than_one:
             raise ValueError(
-                "Too many instances of keys %r. Only 1 allowed." % more_than_one
+                f"Too many instances of keys {more_than_one}. Only 1 allowed."
             )
         missing = [key for key, number in count.items() if number == 0]
         if missing:
             raise ValueError(
-                "Too few instances of keys %r. At least 1 required." % missing
+                f"Too few instances of keys {missing}. At least 1 required."
             )
         return value
 
@@ -149,7 +152,7 @@ class Suite(BaseModel):
     recipes: List[Recipe]
 
 
-class SuiteValidator:  # pylint:disable=too-few-public-methods
+class SuiteValidator:
     """Validate ETOS suite definitions to make sure they are executable."""
 
     logger = logging.getLogger(__name__)
@@ -163,11 +166,11 @@ async def _download_suite(self, test_suite_url):
         :rtype: list
         """
         try:
-            suite = requests.get(test_suite_url)
+            suite = requests.get(test_suite_url, timeout=60)
             suite.raise_for_status()
         except Exception as exception:  # pylint:disable=broad-except
             raise AssertionError(
-                "Unable to download suite from %r" % test_suite_url
+                f"Unable to download suite from {test_suite_url}"
             ) from exception
         return suite.json()