2019-06-11 12:39:26 -04:00
---
2020-05-29 14:08:26 -04:00
stage: Verify
group: Continuous Integration
2020-11-26 01:09:20 -05:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2019-06-11 12:39:26 -04:00
type: tutorial
---
2019-03-07 22:34:28 -05:00
# Test and deploy a Python application with GitLab CI/CD
2017-11-01 11:56:40 -04:00
2015-08-25 21:42:46 -04:00
This example will guide you how to run tests in your Python application and deploy it automatically as Heroku application.
2019-06-11 12:39:26 -04:00
You can also view or fork the complete [example source ](https://gitlab.com/ayufan/python-getting-started ).
2017-11-01 11:56:40 -04:00
## Configure project
2015-08-25 21:42:46 -04:00
This is what the `.gitlab-ci.yml` file looks like for this project:
2017-11-01 11:56:40 -04:00
2015-08-25 21:42:46 -04:00
```yaml
2019-05-02 06:17:06 -04:00
stages:
- test
- deploy
2015-08-25 21:42:46 -04:00
test:
2019-05-02 06:17:06 -04:00
stage: test
2015-08-25 21:42:46 -04:00
script:
2020-07-03 05:08:53 -04:00
# this configures Django application to use attached postgres database that is run on `postgres` host
- 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
2015-08-25 21:42:46 -04:00
staging:
2019-05-02 06:17:06 -04:00
stage: deploy
2015-08-25 21:42:46 -04:00
script:
2020-07-03 05:08:53 -04:00
- 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
2015-08-25 21:42:46 -04:00
only:
2020-07-03 05:08:53 -04:00
- master
2015-08-25 21:42:46 -04:00
production:
2019-05-02 06:17:06 -04:00
stage: deploy
2015-08-25 21:42:46 -04:00
script:
2020-07-03 05:08:53 -04:00
- 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
2015-08-25 21:42:46 -04:00
only:
2020-07-03 05:08:53 -04:00
- tags
2015-08-25 21:42:46 -04:00
```
This project has three jobs:
2018-11-12 19:39:21 -05:00
2019-06-11 12:39:26 -04:00
- `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.
2015-08-25 21:42:46 -04:00
2017-11-01 11:56:40 -04:00
## Store API keys
2019-01-30 05:20:50 -05:00
You'll need to create two variables in **Settings > CI/CD > Environment variables** in your GitLab project:
2018-11-12 19:39:21 -05:00
- `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-08-25 21:42:46 -04:00
Find your Heroku API key in [Manage Account ](https://dashboard.heroku.com/account ).
2017-11-01 11:56:40 -04:00
## Create Heroku application
2015-08-25 21:42:46 -04:00
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/ ).
2020-09-12 05:09:53 -04:00
## Create a runner
2017-11-01 11:56:40 -04:00
2015-08-25 21:42:46 -04:00
First install [Docker Engine ](https://docs.docker.com/installation/ ).
2019-06-11 12:39:26 -04:00
2019-10-10 23:07:00 -04:00
To build this project you also need to have [GitLab Runner ](https://docs.gitlab.com/runner/index.html ).
2019-06-11 12:39:26 -04:00
You can use public runners available on `gitlab.com` or you can register your own:
2017-11-01 11:56:40 -04:00
2020-01-30 10:09:15 -05:00
```shell
2020-05-07 14:09:28 -04:00
cat > /tmp/test-config.template.toml < < EOF
[[runners]]
[runners.docker]
[[runners.docker.services]]
name = "postgres:latest"
EOF
2017-10-31 05:20:40 -04:00
gitlab-runner register \
2015-08-25 21:42:46 -04:00
--non-interactive \
2017-04-06 18:25:45 -04:00
--url "https://gitlab.com/" \
2015-08-25 21:42:46 -04:00
--registration-token "PROJECT_REGISTRATION_TOKEN" \
2016-05-07 00:09:27 -04:00
--description "python-3.5" \
2015-08-25 21:42:46 -04:00
--executor "docker" \
2020-05-07 14:09:28 -04:00
--template-config /tmp/test-config.template.toml \
--docker-image python:3.5
2015-08-25 21:42:46 -04:00
```
2019-10-10 23:07:00 -04:00
With the command above, you create a runner that uses the [`python:3.5` ](https://hub.docker.com/_/python ) image and uses a [PostgreSQL ](https://hub.docker.com/_/postgres ) database.
2015-08-25 21:42:46 -04:00
2019-06-11 12:39:26 -04:00
To access the PostgreSQL database, connect to `host: postgres` as user `postgres` with no password.