2017-11-01 15:56:40 +00:00
# Test and Deploy a python application with GitLab CI/CD
2015-08-26 01:42:46 +00:00
This example will guide you how to run tests in your Python application and deploy it automatically as Heroku application.
2017-11-01 15:56:40 +00:00
You can checkout the [example source ](https://gitlab.com/ayufan/python-getting-started ).
## Configure project
2015-08-26 01:42:46 +00:00
This is what the `.gitlab-ci.yml` file looks like for this project:
2017-11-01 15:56:40 +00:00
2015-08-26 01:42:46 +00:00
```yaml
test:
script:
2016-05-07 04:09:27 +00:00
# this configures Django application to use attached postgres database that is run on `postgres` host
2015-08-26 01:42:46 +00:00
- 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:
2016-05-07 04:09:27 +00:00
1. `test` - used to test Django application,
2015-08-26 01:42:46 +00:00
2. `staging` - used to automatically deploy staging environment every push to `master` branch
3. `production` - used to automatically deploy production environmnet for every created tag
2017-11-01 15:56:40 +00:00
## Store API keys
2015-08-26 01:42:46 +00:00
You'll need to create two variables in `Project > Variables` :
1. `HEROKU_STAGING_API_KEY` - Heroku API key used to deploy staging app,
2. `HEROKU_PRODUCTION_API_KEY` - Heroku API key used to deploy production app.
Find your Heroku API key in [Manage Account ](https://dashboard.heroku.com/account ).
2017-11-01 15:56:40 +00:00
## Create Heroku application
2015-08-26 01:42:46 +00: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/ ).
2017-11-01 15:56:40 +00:00
## Create Runner
2015-08-26 01:42:46 +00:00
First install [Docker Engine ](https://docs.docker.com/installation/ ).
2017-11-01 15:56:40 +00:00
To build this project you also need to have [GitLab Runner ](https://docs.gitlab.com/runner ).
2017-04-06 22:25:45 +00:00
You can use public runners available on `gitlab.com` , but you can register your own:
2017-11-01 15:56:40 +00:00
2015-08-26 01:42:46 +00:00
```
2017-10-31 09:20:40 +00:00
gitlab-runner register \
2015-08-26 01:42:46 +00:00
--non-interactive \
2017-04-06 22:25:45 +00:00
--url "https://gitlab.com/" \
2015-08-26 01:42:46 +00:00
--registration-token "PROJECT_REGISTRATION_TOKEN" \
2016-05-07 04:09:27 +00:00
--description "python-3.5" \
2015-08-26 01:42:46 +00:00
--executor "docker" \
2016-05-07 04:09:27 +00:00
--docker-image python:3.5 \
2015-08-26 01:42:46 +00:00
--docker-postgres latest
```
2016-05-07 04:09:27 +00:00
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-08-26 01:42:46 +00:00
To access PostgreSQL database you need to connect to `host: postgres` as user `postgres` without password.