Merge pull request #3 from alephmelo/add-testing-infra

Add testing infra

Author: alephmelo

README.md

@@ -12,7 +12,7 @@ FastAPI Docker is a template to facilitate development as well as productionizat
 
 ## Customize
 ### Settings Files
-The `envs` folder contains the files so you can use different settings depending on the environment you're running the API. It relies on the environment variable `MODE`, which evals to `production` or `development` in order to read the correct `.env` file.
+The `envs` folder contains the files so you can use different settings depending on the environment you're running the API. It relies on the environment variable `MODE`, which evals to `production`, `development` or `testing` in order to read the correct `.env` file.
 
 ### Environment Variables
 - `PORT`=`80`
@@ -27,7 +27,7 @@ $ cookiecutter https://github.com/alephmelo/fast-api-docker-template.git
 ```
 
 ### Build
-This will build both `dev` and `prod` images.
+This will build `dev`, `prod` and `test` images.
 ```bash
 $ make build
 ```
@@ -43,6 +43,11 @@ dev_1   | INFO:     Waiting for application startup.
 dev_1   | INFO:     Application startup complete.
 ```
 
+### Test
+```bash
+$ make tests
+```
+
 ## Deployment
 Just push your built image to whatever cloud provider or manually start the service. It's tagged locally as `<app_name>/<app_name>:latest-prod`.
 
@@ -57,4 +62,5 @@ INFO:     Uvicorn running on http://0.0.0.0:80 (Press CTRL+C to quit)
 ```
 
 ## Release History
+- 0.2.0 - Add testing infrastructure.
 - 0.1.0 - Initial version.

{{cookiecutter.app_name}}/Dockerfile

@@ -6,12 +6,22 @@ COPY requirements.txt requirements.txt
 
 RUN pip install --upgrade pip && pip install -r requirements.txt
 
+
+# development image.
 FROM base as development
 
 COPY requirements_dev.txt requirements_dev.txt
 
 RUN pip install -r requirements_dev.txt
 
+
+# testing image.
+FROM base as testing
+
+RUN pip install pytest && pip install requests
+
+
+# production image.
 FROM base as production
 
 WORKDIR /production

{{cookiecutter.app_name}}/Makefile

@@ -1,14 +1,20 @@
-phony: build dev up-dev bash prod up-dev up-prod
+phony: build dev test tests up-dev bash prod up-dev up-prod
 
 
-build: dev prod
+build: dev prod test
 
 dev:
 	docker-compose build dev
 
 prod:
 	docker-compose build prod
 
+test:
+	docker-compose build test
+
+tests:
+	docker-compose run test
+
 up-dev:
 	docker-compose up dev
 

{{cookiecutter.app_name}}/docker-compose.yml

@@ -24,3 +24,19 @@ services:
       target: production
       context: .
       dockerfile: Dockerfile
+  
+  test:
+    image: {{cookiecutter.app_name}}/{{cookiecutter.app_name}}:latest-test
+    working_dir: /home/{{cookiecutter.app_name}}
+    entrypoint: pytest
+    build: 
+      target: testing
+      context: .
+      dockerfile: Dockerfile
+    ports: 
+      - 8000:8000
+    volumes:
+      - .:/home/{{cookiecutter.app_name}}
+    
+    environment: 
+      - MODE=testing

{{cookiecutter.app_name}}/{{cookiecutter.app_name}}/envs/testing.env

@@ -0,0 +1 @@
+dbpath="localhost:5432"

{{cookiecutter.app_name}}/{{cookiecutter.app_name}}/tests/__init__.py

@@ -0,0 +1,11 @@
+from fastapi.testclient import TestClient
+
+from {{cookiecutter.app_name}}.{{cookiecutter.main_file_name}} import app
+
+client = TestClient(app)
+
+
+def test_read_main():
+    response = client.get("/")
+    assert response.status_code == 200
+    assert response.json() == {"message": "Hello World, testing"}