Merge pull request #82 from thenewguy/vagrant-demo

configured vagrant guest to run interactive demo

Author: thenewguy

README.md

@@ -212,3 +212,6 @@ Now you can run tests as shown below:
 ```sh
 python runtests.py
 ```
+
+Alternately, you can skip local configuration and use the provided vagrant environment for testing.
+[Reference its README for further details.](vagrant/README)

manage.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals, absolute_import
+
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "wagtailmedia.tests.settings")
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

setup.py

@@ -18,9 +18,14 @@
     # For coverage and PEP8 linting
     'coverage>=3.7.0',
     'flake8>=2.2.0',
+    'isort',
 
     # Required for matrix build on Travis
     'tox==3.9.0',
+    
+    # Required for interactive testing via tox
+    'psycopg2-binary',
+    'django-redis-cache',
 ]
 
 with io.open('README.md', encoding='utf-8') as readme_file:

tox.ini

@@ -1,18 +1,27 @@
 [tox]
+requires = tox-docker
 skipsdist = True
+toxworkdir = /home/vagrant/.tox
 usedevelop = True
 
-envlist = py{35,36,37}-dj{20,21,22}-wag{22,23,24,25,26,27},
+envlist = 
+    py{35,36,37}-dj{20,21,22}-wag{22,23,24,25,26,27}
+    interactive
+    flake
+    isort
+
 
 [testenv]
 install_command = pip install -e ".[testing]" -U {opts} {packages}
+
 commands =
     {posargs:python runtests.py}
 
 basepython =
     py35: python3.5
     py36: python3.6
     py37: python3.7
+    {interactive,flake,isort}: python3.6
 
 deps =
     dj111: Django>=1.11.20,<2.0
@@ -25,3 +34,50 @@ deps =
     wag25: wagtail>=2.5,<2.6
     wag26: wagtail>=2.6,<2.7
     wag27: wagtail>=2.7,<2.8
+    {interactive,flake,isort}: wagtail
+
+
+[testenv:flake]
+commands = {posargs:flake8 wagtailmedia}
+
+
+[testenv:isort]
+commands = {posargs:isort --check-only --diff --recursive wagtailmedia}
+
+
+[testenv:interactive]
+commands_pre = 
+    python {toxinidir}/manage.py makemigrations
+    python {toxinidir}/manage.py migrate
+    python {toxinidir}/manage.py shell -c "from django.contrib.auth.models import User; User.objects.create_superuser('super', '[email protected]', 'super')"
+
+commands =
+    {posargs:python manage.py runserver 0.0.0.0:8020}
+
+docker =
+    postgres:12.0
+    redis:5.0
+
+dockerenv =
+    POSTGRES_PASSWORD=pgpass
+    POSTGRES_USER=pguser
+    POSTGRES_DB=pgdb
+
+setenv =
+    INTERACTIVE = 1
+
+
+[docker:redis:5.0]
+healthcheck_cmd = redis-cli ping | grep -q PONG
+healthcheck_interval = 3
+healthcheck_timeout = 3
+healthcheck_retries = 30
+healthcheck_start_period = 5
+
+
+[docker:postgres:12.0]
+healthcheck_cmd = pg_isready
+healthcheck_interval = 3
+healthcheck_timeout = 3
+healthcheck_retries = 30
+healthcheck_start_period = 5

vagrant/.gitignore

@@ -0,0 +1 @@
+.vagrant/

vagrant/README

@@ -0,0 +1,35 @@
+CREATES A VAGRANT ENVIRONMENT TO FACILITATE LOCAL TESTING
+
+** VAGRANT MUST BE INSTALLED FOR THIS TO WORK! **
+IF YOU ARE NOT FAMILIAR WITH VAGRANT, [FOLLOW THE INSTALLATION INSTRUCTIONS BEFORE CONTINUING](https://www.vagrantup.com/docs/installation/).
+
+========
+USAGE:
+========
+To run tests:
+    cd to this directory on the host machine and issue the following commands:
+        vagrant up
+        vagrant ssh
+    
+    then:
+        bash /vagrant/vagrant/runtox.sh -e py35-dj20-wag22
+
+To run interactive demo inside the vagrant guest:
+    ** note: you might need to manually pull the docker images in tox.ini manually on the first run! it hangs for me occasionally **
+    docker pull redis:5.0
+    docker pull postgres:12.0
+    
+    bash /vagrant/vagrant/runtox.sh -e interactive
+    
+    then:
+        open your browser on the host and navigate to http://localhost:8020/admin/
+    
+    log in credentials:
+        username: super
+        password: super
+
+To run flake8 inside the vagrant guest:
+    bash /vagrant/vagrant/runtox.sh -e flake
+
+To run isort inside the vagrant guest:
+    bash /vagrant/vagrant/runtox.sh -e isort

vagrant/Vagrantfile

@@ -0,0 +1,12 @@
+Vagrant.configure("2") do |config|
+    config.vm.box = "hashicorp/bionic64"
+    
+    config.vm.provider "virtualbox" do |v|
+      v.name = "wagtailmedia"
+    end
+    
+    config.vm.network "forwarded_port", guest: 8020, host: 8020
+    config.vm.provision :shell, path: "provision.sh"
+    config.vm.synced_folder ".", "/vagrant", disabled: true
+    config.vm.synced_folder "../", "/vagrant"
+end

vagrant/provision.sh

@@ -0,0 +1,17 @@
+set -o errexit
+set -o pipefail
+set -o nounset
+shopt -s failglob
+set -o xtrace
+
+export DEBIAN_FRONTEND=noninteractive
+
+add-apt-repository -y ppa:deadsnakes/ppa
+apt-get update
+apt-get install -y python3-distutils build-essential libssl-dev python-dev python3.5 python3.5-dev python3.6 python3.6-dev python3.7 python3.7-dev
+
+curl -sSL https://get.docker.com/ | sh
+adduser vagrant docker
+
+curl https://bootstrap.pypa.io/get-pip.py | python3
+pip3 install tox tox-docker

vagrant/runtox.sh

@@ -0,0 +1,4 @@
+tox -c /vagrant/tox.ini -vv "$@"
+
+docker stop $(docker ps -q)
+docker system prune --force --volumes

wagtailmedia/tests/settings.py

@@ -1,23 +1,38 @@
 import os
 
+DEBUG = 'INTERACTIVE' in os.environ
+
 WAGTAILMEDIA_ROOT = os.path.dirname(__file__)
 STATIC_ROOT = os.path.join(WAGTAILMEDIA_ROOT, 'test-static')
 MEDIA_ROOT = os.path.join(WAGTAILMEDIA_ROOT, 'test-media')
 MEDIA_URL = '/media/'
 
-DATABASES = {
-    'default': {
-        'ENGINE': os.environ.get('DATABASE_ENGINE', 'django.db.backends.sqlite3'),
-        'NAME': os.environ.get('DATABASE_NAME', 'wagtailmedia'),
-        'USER': os.environ.get('DATABASE_USER', None),
-        'PASSWORD': os.environ.get('DATABASE_PASS', None),
-        'HOST': os.environ.get('DATABASE_HOST', None),
-
-        'TEST': {
-            'NAME': os.environ.get('DATABASE_NAME', None),
+POSTGRES_PORT = os.getenv('POSTGRES_5432_TCP_PORT', '')
+if POSTGRES_PORT:
+    DATABASES = {
+        'default': {
+            'ENGINE': 'django.db.backends.postgresql',
+            'NAME': 'pgdb',
+            'USER': 'pguser',
+            'PASSWORD': 'pgpass',
+            'HOST': 'localhost',
+            'PORT': POSTGRES_PORT,
+        }
+    }
+else:
+    DATABASES = {
+        'default': {
+            'ENGINE': os.environ.get('DATABASE_ENGINE', 'django.db.backends.sqlite3'),
+            'NAME': os.environ.get('DATABASE_NAME', 'wagtailmedia'),
+            'USER': os.environ.get('DATABASE_USER', None),
+            'PASSWORD': os.environ.get('DATABASE_PASS', None),
+            'HOST': os.environ.get('DATABASE_HOST', None),
+
+            'TEST': {
+                'NAME': os.environ.get('DATABASE_NAME', None),
+            }
         }
     }
-}
 
 
 SECRET_KEY = 'not needed'
@@ -89,12 +104,23 @@
 # Using DatabaseCache to make sure THAT the cache is cleared between tests.
 # This prevents false-positives in some wagtail core tests where we are
 # changing the 'wagtail_root_paths' key which may cause future tests to fail.
-CACHES = {
-    'default': {
-        'BACKEND': 'django.core.cache.backends.db.DatabaseCache',
-        'LOCATION': 'cache',
+
+REDIS_PORT = os.getenv('REDIS_6379_TCP_PORT', '')
+
+if REDIS_PORT:
+    CACHES = {
+        "default": {
+            'BACKEND': 'redis_cache.RedisCache',
+            'LOCATION': 'localhost:%s' % REDIS_PORT,
+        },
+    }
+else:
+    CACHES = {
+        'default': {
+            'BACKEND': 'django.core.cache.backends.db.DatabaseCache',
+            'LOCATION': 'cache',
+        }
     }
-}
 
 PASSWORD_HASHERS = (
     'django.contrib.auth.hashers.MD5PasswordHasher',  # don't use the intentionally slow default password hasher
@@ -107,5 +133,8 @@
     }
 }
 
+# must be set for interactive demo, copied per
+# https://github.com/django/django/commit/adb96617897690b3a01e39e8297ae7d67825d2bc
+ALLOWED_HOSTS = ['.localhost', '127.0.0.1', '[::1]']
 
 WAGTAIL_SITE_NAME = "Test Site"