.. | ||
app | ||
README.md | ||
requirements.txt | ||
tests.py | ||
users.json |
Your mission, should you choose to accept it, involves fixing the app in this directory, containerize it and set up a CI for it. Please read carefully all the instructions.
Installation
- Create a virtual environment with
python3 -m venv challenge_venv
- Activate it with
source challenge_venv/bin/activate
- Install the requirements in this directory
pip install -r requirements.txt
Run the app
If any of the following steps is not working, it is expected from you to fix them
- Run
export FLASK_APP=app/app.py
- To run the app execute
flask run
. If it doesn't works, fix it - Access
http://127.0.0.1:5000
. You should see the following
{
"resources_uris": {
"user": "/users/<username>",
"users": "/users"
},
"current_uri": "/"
}
- You should be able to access any of the resources and get the following data:
- /users/ - data on the specific chosen user
- /users - all users data
Containers
Using Docker or Podman, containerize the flask app so users can run the following two commands:
docker build -t app:latest /path/to/Dockerfile
docker run -d -p 5000:5000 app
- You can use any image base you would like
- Containrize only what you need for running the application, nothing else.
CI
Great, now that we have a working app and also can run it in a container, let's set up a CI for it so it won't break again in the future In current directory you have a file called tests.py which includes the tests for the app. What is expected from you is:
- The CI should run the app tests. You are free to choose whatever CI system or service you prefer.
- There should be some kind of test for the Dockerfile you wrote
- Add additional unit test (or another level of tests) for testing the app
Guidelines
- Except the app functionality, you can change whatever you want - structure, tooling, libraries, ... If possible add
notes.md
file which explains reasons, logic, thoughts and anything else you would like to share - The CI part should include the source code for the pipeline definition