Add tests for tern-rest-api reports implementation

This commit adds all the tern-rest-api reports implementation tests
covering 100%

Adjusts the repository to use Docker.

Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>

Author: Kairo de Araujo

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = *tests*,app.py

.github/workflows/ci.yml

@@ -22,4 +22,4 @@ jobs:
       run: pip install tox tox-gh-actions
 
     - name: Run Python tests
-      run: tox
+      run: tox -r

Dockerfile

@@ -16,14 +16,15 @@ RUN echo "deb http://deb.debian.org/debian bullseye main" > /etc/apt/sources.lis
     skopeo \
     && rm -rf /var/lib/apt/lists/*
 
+COPY requirements.txt requirements.txt
+RUN pip install --no-cache -r ./requirements.txt
+
 RUN mkdir /opt/tern-rest-api
 
 ADD . /opt/tern-rest-api
 WORKDIR /opt/tern-rest-api
-RUN pip install --no-cache -r ./requirements.txt
 
-ENV TERN_API_CACHE_DIR=/var/opt/tern-rest-api/cached
+ENV TERN_API_CACHE_DIR=/var/opt/tern-rest-api/cache
 ENV TERN_DEFAULT_REGISTRY="registry.hub.docker.com"
 
-ENV FLASK_APP=/opt/tern-rest-api/app.py
-CMD ["bash", "docker_start.sh"]
+ENTRYPOINT [ "bash", "docker_start.sh" ]

Makefile

@@ -5,7 +5,17 @@
 # SPDX-License-Identifier: BSD-2-Clause
 
 build-dev:
-	docker build -t tern-rest-api:dev .
+	docker-compose build --force-rm tern-rest-api
 
 serve-dev: build-dev
-	docker run --rm --name tern-rest-api -e ENVIRONMENT=DEVELOPMENT --privileged -v /var/run/docker.sock:/var/run/docker.sock -v $(PWD):/opt/tern-rest-api -p 5001:80 tern-rest-api:dev
+	docker-compose up --remove-orphans
+
+tests: build-dev
+	docker-compose run --rm --volume=$(PWD):/opt/tern-rest-api --entrypoint="/bin/sh" tern-rest-api -c 'pip install tox && tox'
+
+stop:
+	docker-compose down -v
+
+update-requirements:
+	pipenv lock -r > requirements.txt
+	pipenv lock -r -d > requirements-dev.txt

README.md

@@ -68,6 +68,8 @@ Open http://localhost/ in your browser.
 Changing the source code will automatically reload the server inside the
 container and makes the development easier.
 
+You can stop the sever using ``Ctrl+C`` and running ``make stop``
+
 ## On your local machine
 Runing the API locally
 
@@ -81,7 +83,12 @@ Open http://localhost:5000/ in your browser.
 
 We use [Tox](https://tox.wiki/en/latest/) to manage running the tests.
 
-Running tests
+## As a Docker Container
+```shell
+$ make tests
+```
+
+## On your local machine
 ```shell
 $ tox
 ```
@@ -106,6 +113,5 @@ $ pipenv update
 
 Updating the ``requirements.txt`` and ``requirements-dev.txt``
 ```shell
-$ pipenv lock -r > requirements.txt
-$ pipenv lock -r -d > requirements-dev.txt
+$ make update-requirements
 ```

app.py

@@ -10,7 +10,7 @@
 
 from tern_api import __version__, tern_app
 from tern_api.api.v1.common_models import api_models_namespace
-from tern_api.api.v1.reports import ns as report_v1
+from tern_api.api.v1.reports import ns as reports_v1
 from tern_api.api.v1.version import ns as version_v1
 
 logging.basicConfig(
@@ -35,7 +35,7 @@
 
 api.add_namespace(api_models_namespace)
 api.add_namespace(version_v1, path="/api/v1/version")
-api.add_namespace(report_v1, path="/api/v1/report")
+api.add_namespace(reports_v1, path="/api/v1/reports")
 
 
 def export_swagger_json(filepath):

docker-compose.yml

@@ -0,0 +1,21 @@
+version: '3'
+
+volumes:
+  tern-cache:
+
+services:
+  tern-rest-api:
+    build:
+      context: .
+      args:
+        DEVEL: "yes"
+    command: "bash bash_start.sh"
+    environment:
+      - ENVIRONMENT=development
+      - TERN_DEFAULT_REGISTRY=registry.hub.docker.com
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+      - tern-cache:/var/opt/tern-rest-api/cache:z
+      - ./tern_api:/opt/tern-rest-api/tern_api:z
+    ports:
+      - "5001:80"

docker_start.sh

@@ -1,7 +1,8 @@
 #!/bin/bash
 
 if [[ ${ENVIRONMENT^^} == "DEVELOPMENT" ]]; then
-    flask run --reload --debugger -h 0.0.0.0 -p 80
+    echo "Starting tern-rest-api in development mode"
+    gunicorn --reload -b 0.0.0.0:80 app:tern_app
 else
-    gunicorn --workers=1 -b 0.0.0.0:80 app:tern_api
+    gunicorn -b 0.0.0.0:80 app:tern_app
 fi

tern_api/__init__.py

@@ -13,3 +13,4 @@
 tern_app.config["TERN_DEFAULT_REGISTRY"] = os.getenv("TERN_DEFAULT_REGISTRY")
 
 tern_tasks = Executor(tern_app)
+tern_app.config["TERN_TASKS"] = tern_tasks

tern_api/api/v1/reports.py

@@ -6,12 +6,13 @@
 from flask import request
 from flask_restx import Namespace, Resource, fields
 
-from tern_api import reports, tern_app
+from tern_api import constants, tern_app
 from tern_api.api.v1.common_models import (
     async_response_model,
     error_model,
     report_model,
 )
+from tern_api.reports import status, submit
 
 ns = Namespace("/reports", description="Tern Bill of Materials Report")
 
@@ -53,14 +54,14 @@ class Report(Resource):
     )
 
     @ns.response(200, "OK", report_response_request)
-    @ns.expect(report_parameters)
+    @ns.expect(report_parameters, validate=True)
     def post(self):
         """Tern BoM report
 
         **Note**: This request will be processed assynchronous.
         """
         payload = request.json
-        response = reports.request(payload)
+        response = submit(payload)
         return response.to_response()
 
 
@@ -79,13 +80,28 @@ class ReportStatus(Resource):
     data_status_response = ns.model(
         "data_status_response",
         {
+            "cache": fields.Boolean(
+                description="Requested using cache?",
+                required=True,
+                example=True,
+            ),
+            "id": fields.String(
+                description="Unique Identification for request",
+                required=False,
+                example="19f035a711644eab84ef5a38ceb5572e",
+            ),
+            "message": fields.String(
+                description="Message",
+                required=False,
+                exampple="Request is running",
+            ),
+            "report": fields.Nested(report_model),
             "status": fields.String(
                 description="Status of request",
                 required=True,
-                example="FINISH",
-                enum=["UNKNOWN", "FINISH", "RUNNING", "FAIL"],
+                example=constants.task_status.SUCCESS.value,
+                enum=[s.value for s in constants.task_status],
             ),
-            "result": fields.Nested(report_model),
         },
     )
     report_status_response = ns.model(
@@ -97,10 +113,10 @@ class ReportStatus(Resource):
     )
 
     @ns.response(200, "OK", report_status_response)
-    @ns.expect(report_status_parameters)
+    @ns.expect(report_status_parameters, validate=True)
     def post(self):
         """Request Tern BoM report status/result"""
 
         payload = request.json
-        response = reports.status(payload.get("id"))
+        response = status(payload.get("id"))
         return response.to_response()