2018-03-17 18:26:18 +05:30
# Test and Deploy a python application with GitLab CI/CD
2015-09-25 12:07:36 +05:30
This example will guide you how to run tests in your Python application and deploy it automatically as Heroku application.
2018-03-17 18:26:18 +05:30
You can checkout the [example source ](https://gitlab.com/ayufan/python-getting-started ).
## Configure project
2015-09-25 12:07:36 +05:30
This is what the `.gitlab-ci.yml` file looks like for this project:
2018-03-17 18:26:18 +05:30
2015-09-25 12:07:36 +05:30
```yaml
test:
script:
2016-06-02 11:05:42 +05:30
# this configures Django application to use attached postgres database that is run on `postgres` host
2015-09-25 12:07:36 +05:30
- export DATABASE_URL=postgres://postgres:@postgres:5432/python-test-app
- apt-get update -qy
- apt-get install -y python-dev python-pip
- pip install -r requirements.txt
- python manage.py test
staging:
type: deploy
script:
- apt-get update -qy
- apt-get install -y ruby-dev
- gem install dpl
- dpl --provider=heroku --app=gitlab-ci-python-test-staging --api-key=$HEROKU_STAGING_API_KEY
only:
- master
production:
type: deploy
script:
- apt-get update -qy
- apt-get install -y ruby-dev
- gem install dpl
- dpl --provider=heroku --app=gitlab-ci-python-test-prod --api-key=$HEROKU_PRODUCTION_API_KEY
only:
- tags
```
This project has three jobs:
2019-02-15 15:39:39 +05:30
- `test` - used to test Django application,
- `staging` - used to automatically deploy staging environment every push to `master` branch
- `production` - used to automatically deploy production environment for every created tag
2018-03-17 18:26:18 +05:30
## Store API keys
2015-09-25 12:07:36 +05:30
2019-02-15 15:39:39 +05:30
You'll need to create two variables in **Settings > CI/CD > Variables** in your GitLab project:
- `HEROKU_STAGING_API_KEY` - Heroku API key used to deploy staging app.
- `HEROKU_PRODUCTION_API_KEY` - Heroku API key used to deploy production app.
2015-09-25 12:07:36 +05:30
Find your Heroku API key in [Manage Account ](https://dashboard.heroku.com/account ).
2018-03-17 18:26:18 +05:30
## Create Heroku application
2015-09-25 12:07:36 +05:30
For each of your environments, you'll need to create a new Heroku application.
You can do this through the [Dashboard ](https://dashboard.heroku.com/ ).
2018-03-17 18:26:18 +05:30
## Create Runner
2015-09-25 12:07:36 +05:30
First install [Docker Engine ](https://docs.docker.com/installation/ ).
2018-03-17 18:26:18 +05:30
To build this project you also need to have [GitLab Runner ](https://docs.gitlab.com/runner ).
2017-09-10 17:25:29 +05:30
You can use public runners available on `gitlab.com` , but you can register your own:
2018-03-17 18:26:18 +05:30
2015-09-25 12:07:36 +05:30
```
2018-03-17 18:26:18 +05:30
gitlab-runner register \
2015-09-25 12:07:36 +05:30
--non-interactive \
2017-09-10 17:25:29 +05:30
--url "https://gitlab.com/" \
2015-09-25 12:07:36 +05:30
--registration-token "PROJECT_REGISTRATION_TOKEN" \
2016-06-02 11:05:42 +05:30
--description "python-3.5" \
2015-09-25 12:07:36 +05:30
--executor "docker" \
2016-06-02 11:05:42 +05:30
--docker-image python:3.5 \
2015-09-25 12:07:36 +05:30
--docker-postgres latest
```
2016-06-02 11:05:42 +05:30
With the command above, you create a runner that uses [python:3.5 ](https://hub.docker.com/r/_/python/ ) image and uses [postgres ](https://hub.docker.com/r/_/postgres/ ) database.
2015-09-25 12:07:36 +05:30
To access PostgreSQL database you need to connect to `host: postgres` as user `postgres` without password.