debian-mirror-gitlab/doc/ci/examples/test-and-deploy-python-application-to-heroku.md

102 lines
3.2 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
---
2020-06-23 00:09:42 +05:30
stage: Verify
group: Continuous Integration
2021-02-22 17:27:13 +05:30
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-09-04 21:01:54 +05:30
type: tutorial
---
2019-07-07 11:18:12 +05:30
# Test and deploy a Python application with GitLab CI/CD
2018-03-17 18:26:18 +05:30
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.
2019-09-04 21:01:54 +05:30
You can also view or fork the complete [example source](https://gitlab.com/ayufan/python-getting-started).
2018-03-17 18:26:18 +05:30
## 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
2019-09-04 21:01:54 +05:30
stages:
- test
- deploy
2015-09-25 12:07:36 +05:30
test:
2019-09-04 21:01:54 +05:30
stage: test
2015-09-25 12:07:36 +05:30
script:
2020-07-28 23:09:34 +05:30
# 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-09-25 12:07:36 +05:30
staging:
2019-09-04 21:01:54 +05:30
stage: deploy
2015-09-25 12:07:36 +05:30
script:
2020-07-28 23:09:34 +05:30
- 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-09-25 12:07:36 +05:30
only:
2020-07-28 23:09:34 +05:30
- master
2015-09-25 12:07:36 +05:30
production:
2019-09-04 21:01:54 +05:30
stage: deploy
2015-09-25 12:07:36 +05:30
script:
2020-07-28 23:09:34 +05:30
- 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-09-25 12:07:36 +05:30
only:
2020-07-28 23:09:34 +05:30
- tags
2015-09-25 12:07:36 +05:30
```
This project has three jobs:
2019-02-15 15:39:39 +05:30
2019-09-04 21:01:54 +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
2021-03-11 19:13:27 +05:30
You'll need to create two variables in **Settings > CI/CD > Variables** in your GitLab project:
2019-02-15 15:39:39 +05:30
- `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/).
2020-11-24 15:15:51 +05:30
## Create a runner
2018-03-17 18:26:18 +05:30
2015-09-25 12:07:36 +05:30
First install [Docker Engine](https://docs.docker.com/installation/).
2019-09-04 21:01:54 +05:30
2019-12-21 20:55:43 +05:30
To build this project you also need to have [GitLab Runner](https://docs.gitlab.com/runner/index.html).
2019-09-04 21:01:54 +05:30
You can use public runners available on `gitlab.com` or you can register your own:
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-05-24 23:13:21 +05:30
cat > /tmp/test-config.template.toml << EOF
[[runners]]
[runners.docker]
[[runners.docker.services]]
name = "postgres:latest"
EOF
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" \
2020-05-24 23:13:21 +05:30
--template-config /tmp/test-config.template.toml \
--docker-image python:3.5
2015-09-25 12:07:36 +05:30
```
2019-12-21 20:55:43 +05:30
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-09-25 12:07:36 +05:30
2019-09-04 21:01:54 +05:30
To access the PostgreSQL database, connect to `host: postgres` as user `postgres` with no password.