https://github.com/saulshanabrook/django-externaltestserver
Run your Django selenium tests against an external server
https://github.com/saulshanabrook/django-externaltestserver
Last synced: 6 months ago
JSON representation
Run your Django selenium tests against an external server
- Host: GitHub
- URL: https://github.com/saulshanabrook/django-externaltestserver
- Owner: saulshanabrook
- Created: 2015-11-14T18:00:01.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-11-17T03:16:23.000Z (almost 10 years ago)
- Last Synced: 2025-04-10T07:01:55.775Z (6 months ago)
- Language: Python
- Homepage:
- Size: 203 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `django-externaltestserver`
[](https://pypi.python.org/pypi/django-externaltestserver)
[](https://travis-ci.org/saulshanabrook/django-externaltestserver)
## What?
Allows you to easily run selenium tests against an external server. This comes
in two. The first is a drop in replacement for
[`LiveServerTestCase`](https://docs.djangoproject.com/en/1.8/topics/testing/tools/#liveservertestcase)
that will not start a server in the background.
The second is the `livetestserver` management command which allows you to run
a Django server in a seperate process.
## How?
1. `pip install django-externaltestserver`.
2. Set `EXTERNAL_TEST_SERVER` in your settings
3. Change test cases to inherit from
`externaltestserver.ExternalLiveServerTestCase` instead of
`LiveServerTestCase`.
4. (optional) Add `externaltestserver` to `INSTALLED_APPS` to run
`python manage.py livetestserver [--static]` in another process.
Note: This command uses the `default` database. By default, Django will
create a new database for tests. You must tell Django, when running
this command to use the name of the test database explicitly. By default
the test database is just `test_`, with the normal
connection settings.
## Why?
### External Server
We have a CI system that pushes to a staging server after all tests pass.
We wanted to re-run our selenium test against the staging server, to make
sure there are no regressions moving from a dev to a staging environment.
To do this, we just have to set the `EXTERNAL_TEST_SERVER`
setting to our staging server (like `http://magicapp-staging.herokuapp.com/`)
and make sure our integration tests inherit from `externaltestserver.ExternalLiveServerTestCase`
so that they get the correct `live_server_url`.
Also, if we are accessing the database in our tests, we need to make sure
that it is connected to the same database that is serving the site. I found
it easiest to just set `DATABASE_URL` for the command running the tests
to the database that is also running the server. My settings would pick
this up as the default databse. Then I just told Django to use this same
Database for testing, and not create a new one.
```python
# settings.py
DATABASES = {
'default': dj_database_url.config(
env=os.environ.get('DATABASE_URL_VAR', 'DATABASE_URL')
)
}
if os.getenv('TEST_USE_REGULAR_DB', False):
DATABASES['default']['TEST'] = {'NAME': DATABASES['default']['NAME']}
```
### Docker
#### Problem
Testing Selenium in Django with Docker is
[not obvious](http://stackoverflow.com/questions/32408429/running-django-tests-with-selenium-in-docker).
The problem is that there is a circular dependency between the testing
container and the selenium container. The test container needs to access
selenium in order to send commands and recieve responses. The selenium
container needs to access the testing container, in order to hit the server.
You might think we could represent this in our `docker-compose.yml`:
```yaml
db:
image: postgres
test:
build: .
command: python manage.py test
links:
- db
- selenium
selenium:
image: selenium/standalone-chrome
ports:
- "4444:4444"
- "5900:5900"
links:
- test
```
But alas `ERROR: Circular import between test and selenium and db`.
I was previously using
[an alternative solution](https://github.com/docker/compose/issues/1991#issuecomment-138139493),
by placing the the `test` container in the same network as the `selenium`
container, so that they could access each other.
```yaml
db:
image: postgres
test:
build: .
command: python manage.py test
links:
- db
net: "container:selenium"
selenium:
image: selenium/standalone-chrome
ports:
- "4444:4444"
- "5900:5900"
```
This stopped working with Docker Compose 1.5.0 / Docker 1.9.0 with
`ERROR: Conflicting options: --net=container can't be used with links. This would result in undefined behavior`.
#### Solution
Instead we break up the test command into
two seperate Docker containers. One handles serving the app, the other just runs the tests.
This way there are no cyclical dependencies.
```yaml
db:
image: postgres:9.5
test:
build: .
# wait for db to come up before starting tests, as shown in https://github.com/docker/compose/issues/374#issuecomment-126312313
# uses bash instead of netcat, because netcat is less likely to be installed
# strategy from http://superuser.com/a/806331/98716
command: >
bash -c "
while ! (echo > /dev/tcp/db/5432) >/dev/null 2>&1;
do sleep 1;
done;
python manage.py test
"
links:
- db
- selenium
environment:
- EXTERNAL_TEST_SERVER=http://livetestserver:8000
- SELENIUM_HOST=http://selenium:4444/wd/hub
- DATABASE_URL=postgres://postgres@db:5432/postgres
selenium:
image: selenium/standalone-chrome:2.48.2
links:
- livetestserver
livetestserver:
build: .
command: python manage.py livetestserver 8000 --static
expose:
- "8000"
links:
- db
environment:
- PYTHONUNBUFFERED=1
- DATABASE_URL=postgres://postgres@db:5432/test_postgres
```
Then we just tell our external live tests to use the other container :
```python
# settings.py
import os
EXTERNAL_TEST_SERVER = os.environ.get('EXTERNAL_TEST_SERVER', None)
```
And make sure we are `externaltestserver.ExternalLiveServerTestCase`
and accesing the right selenium server:
```python
# test_integration.py
import os
from selenium import webdriver
from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
from externaltestserver import ExternalLiveServerTestCase
from items.models import Item
class IntegrationTest(ExternalLiveServerTestCase):
def setUp(self):
self.browser = webdriver.Remote(
command_executor=os.environ['SELENIUM_HOST'],
desired_capabilities=DesiredCapabilities.CHROME
)
def test_item_count(self):
Item.objects.create()
# here self.live_server_url == settings.conf.EXTERNAL_TEST_SERVER == "http://testserver:8000/"
self.browser.get(self.live_server_url)
self.assertIn("1", self.browser.page_source)
```
Then we can run all the tests simply with `docker-compose run test`.
## Development
First choose what python and django versions you wanna test on:
```bash
sed -e 's/${PYTHON_VERSION}/3.5/g' -e 's/${DJANGO_VERSION}/1.8/g' Dockerfile.tmpl > Dockerfile
```
Then run the tests:
```bash
docker-compose run test
```
To deploy a new version:
```
# change version in setup.py
python setup.py publish
git tag
git push --tags
```