cyberspark13 / devops-course-starter

DevOps Apprenticeship: Project Exercise

System Requirements

The project uses poetry for Python to create an isolated environment and manage package dependencies. To prepare your system, ensure you have an official distribution of Python version 3.7+ and install poetry using one of the following commands (as instructed by the poetry documentation):

Poetry installation (Bash)

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

Poetry installation (PowerShell)

(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python

Pre-requisites

You'll need to have a Trello account and an API key/token pair to setup this app. Details on how to obtain these can be found here.

You'll also want to have a Trello board setup for your todos with 3 lists with the following names:

• To Do
• Doing
• Done

You'll also want to have your board id to hand. See here on how to locate your board id.

Dependencies

The project uses a virtual environment to isolate package dependencies. To create the virtual environment and install required packages, run the following from your preferred shell:

$ poetry install

You'll also need to clone a new .env file from the .env.template to store local configuration options. This is a one-time operation on first setup:

$ cp .env.template .env  # (first time only)

The .env file is used by flask to set environment variables when running flask run. This enables things like development mode (which also enables features like hot reloading when you make a file change).

You also want to fill in the values for your Trello API key, token and board (see the prerequisites section above)

Running the App

Once the all dependencies have been installed, start the Flask app in development mode within the poetry environment by running:

$ poetry run flask run

You should see output similar to the following:

 * Serving Flask app "app" (lazy loading)
 * Environment: development
 * Debug mode: on
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with fsevents reloader
 * Debugger is active!
 * Debugger PIN: 226-556-590

Now visit http://localhost:5000/ in your web browser to view the app.

Running the Tests

Tests can be run as a whole by running poetry run pytest. To skip the slow end to end tests, you can run poetry run pytest tests.

To run the tests individually in vscode run >Python: Discover Tests from the command window (Ctrl/Cmd + Shift + P), select pytest as the test runner and then . as the test folder.

• To get the end to end tests running you'll need to download the applicable chromedriver for your version of Chrome + OS and add it the project root folder or your PATH.
• We'd recommend installing the Python Test Explorer extension for VSCode as it doesn't have issues like all the tests vanishing when one file has a syntax error (plus it's easier to view individual test log output).

Ansible

Log in to your controller node and copy across the ansible-playbook.yml and ansible-inventory file.

Run the playbook with: ansible-playbook my-playbook.yml -i my-inventory

You will be prompted for the trello api key, secret, and board ID, which you can paste in.

Docker

You can run 'docker-compose up' to create the Dev, Prod, and Test images. The test results will output to the terminal.

For Prod - http://localhost For Dev - http://localhost:5000

To run the commands manually you can use: docker build --target test --tag todo-app:test . docker run todo-app:test tests docker run -e TRELLO_API_KEY=${{ secrets.TRELLO_API_KEY }} -e TRELLO_API_SECRET=${{ secrets.TRELLO_API_SECRET }} -e TRELLO_BOARD_ID=${{ secrets.TRELLO_BOARD_ID }} todo-app:test tests_e2e

Secrets

You must define the following secrets in GitHub Secrets section:

For the board to work: TRELLO_API_KEY TRELLO_API_SECRET TRELLO_BOARD_ID

For slack notifications: SLACK_WEBHOOK_URL From thew Incoming WebHooks app in the slack app directory.