Improve testing setup

jpadilla · jpadilla · commit 6db17c3e4136 · 2019-04-12T20:19:08.000-04:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -29,15 +29,6 @@ jobs:
             - '.venv'
             - '/usr/local/bin'
             - '/usr/local/lib/python3.7/site-packages'
-      - run:
-          name: Run black
-          command: pipenv run black --check .
-      - run:
-          name: Run isort
-          command: pipenv run isort --recursive --check-only --diff
-      - run:
-          name: Run flake8
-          command: pipenv run flake8
       - run:
           name: Run tests
-          command: pipenv run pytest
+          command: pipenv run python runtests.py
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -87,14 +87,14 @@ If you want to go the usual route and run the project locally, though:
 - Install pre-commit hooks: `pipenv run pre-commit install`
 - Setup environment file: `cp example.env .env`
 - Install docker-compose: https://docs.docker.com/compose/install/
-- Build and start containers, including test container: `docker-compose up -d`
+- Build and start containers, including test container: `docker-compose up --build -d`
 - Create super user: `docker-compose exec web python manage.py createsuperuser`
 - Scrape some contracts: `docker-compose exec web python manage.py scrape_contracts --limit 100`
 - open http://localhost:8000
 
 And you should be ready to go!
 
-You can use this command to run tests on demand: `docker-compose up test`
+You can use this command to run tests on demand: `docker-compose run tests`
 
 ## Contribute Documentation
 
diff --git a/Dockerfile b/Dockerfile
@@ -24,6 +24,7 @@ FROM python:3.7
 ARG PIPENV_ARGS
 
 ENV LANG en_US.utf8
+ENV PYTHONUNBUFFERED 1
 
 RUN pip install pipenv==2018.11.26
 
diff --git a/Pipfile b/Pipfile
@@ -4,12 +4,12 @@ verify_ssl = true
 name = "pypi"
 
 [dev-packages]
-black = "*"
+black = "==19.3b0"
 isort = "==4.3.4"
-"flake8" = "*"
-pre-commit = "*"
+"flake8" = "==3.7.7"
+pre-commit = "==1.15.1"
 seed-isort-config = "==1.6.0"
-pytest-django = "*"
+pytest-django = "==3.4.8"
 
 [packages]
 dj-database-url = "==0.5.0"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/bin/docker-entrypoint b/bin/docker-entrypoint
@@ -35,7 +35,7 @@ case "$1" in
     ;;
 
   "run-tests")
-    pytest
+    python runtests.py
     ;;
 
   *)
diff --git a/contratospr/__init__.py b/contratospr/__init__.py
@@ -1 +1,5 @@
+from __future__ import absolute_import, unicode_literals
+
 from .tasks import app as celery_app  # noqa
+
+__all__ = ("celery_app",)
diff --git a/contratospr/settings.py b/contratospr/settings.py
@@ -237,12 +237,19 @@ def CACHES(self):
             }
         }
 
-    class Testing(Common):
-        PASSWORD_HASHERS = ["django.contrib.auth.hashers.MD5PasswordHasher"]
 
-        CELERY_TASK_IGNORE_RESULT = True
-        CELERY_TASK_ALWAYS_EAGER = True
-        CELERY_TASK_EAGER_PROPAGATES = True
+class Testing(Common):
+    PASSWORD_HASHERS = ["django.contrib.auth.hashers.MD5PasswordHasher"]
+
+    CELERY_TASK_IGNORE_RESULT = True
+    CELERY_TASK_ALWAYS_EAGER = True
+    CELERY_TASK_EAGER_PROPAGATES = True
+
+    SECRET_KEY = "dont-tell-eve"
+    GOOGLE_APPLICATION_CREDENTIALS = ""
+    AWS_ACCESS_KEY_ID = ""
+    AWS_S3_BUCKET_NAME = ""
+    AWS_SECRET_ACCESS_KEY = ""
 
 
 structlog.configure(
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -70,8 +70,9 @@ services:
         PIPENV_ARGS: --dev
     command: run-tests
     entrypoint: /app/bin/docker-entrypoint
-    env_file:
-      - .env
+    environment:
+      - DATABASE_URL=postgres://postgres:password@database/postgres
+      - REDIS_URL=redis://redis:6379
     volumes:
       - .:/app
     links:
diff --git a/pytest.ini b/pytest.ini
@@ -1,2 +1,3 @@
 [pytest]
 DJANGO_CONFIGURATION=Testing
+DJANGO_SETTINGS_MODULE=contratospr.settings
diff --git a/runtests.py b/runtests.py
@@ -0,0 +1,116 @@
+#! /usr/bin/env python
+from __future__ import print_function
+
+import subprocess
+import sys
+
+import pytest
+
+BLACK_ARGS = ["--check", "."]
+
+FLAKE8_ARGS = []
+
+ISORT_ARGS = ["--recursive", "--check-only", "--diff"]
+
+PYTEST_ARGS = {"default": [], "fast": ["-q"]}
+
+
+def exit_on_failure(ret, message=None):
+    if ret:
+        sys.exit(ret)
+
+
+def flake8_main(args):
+    print("Running flake8 code linting")
+    ret = subprocess.call(["flake8"] + args)
+    print("flake8 failed" if ret else "flake8 passed")
+    return ret
+
+
+def isort_main(args):
+    print("Running isort code checking")
+    ret = subprocess.call(["isort"] + args)
+    print("isort failed" if ret else "isort passed")
+    return ret
+
+
+def black_main(args):
+    print("Running black code formatting")
+    ret = subprocess.call(["black"] + args)
+    print("black failed" if ret else "black passed")
+    return ret
+
+
+def split_class_and_function(string):
+    class_string, function_string = string.split(".", 1)
+    return "%s and %s" % (class_string, function_string)
+
+
+def is_function(string):
+    # `True` if it looks like a test function is included in the string.
+    return string.startswith("test_") or ".test_" in string
+
+
+def is_class(string):
+    # `True` if first character is uppercase - assume it's a class name.
+    return string[0] == string[0].upper()
+
+
+if __name__ == "__main__":
+    try:
+        sys.argv.remove("--nolint")
+    except ValueError:
+        run_flake8 = True
+        run_isort = True
+        run_black = True
+    else:
+        run_flake8 = False
+        run_isort = False
+        run_black = False
+
+    try:
+        sys.argv.remove("--lintonly")
+    except ValueError:
+        run_tests = True
+    else:
+        run_tests = False
+
+    try:
+        sys.argv.remove("--fast")
+    except ValueError:
+        style = "default"
+    else:
+        style = "fast"
+        run_flake8 = False
+        run_isort = False
+        run_black = False
+
+    if len(sys.argv) > 1:
+        pytest_args = sys.argv[1:]
+        first_arg = pytest_args[0]
+
+        if first_arg.startswith("-"):
+            # `runtests.py [flags]`
+            pytest_args = ["tests"] + pytest_args
+        elif is_class(first_arg) and is_function(first_arg):
+            # `runtests.py TestCase.test_function [flags]`
+            expression = split_class_and_function(first_arg)
+            pytest_args = ["tests", "-k", expression] + pytest_args[1:]
+        elif is_class(first_arg) or is_function(first_arg):
+            # `runtests.py TestCase [flags]`
+            # `runtests.py test_function [flags]`
+            pytest_args = ["tests", "-k", pytest_args[0]] + pytest_args[1:]
+    else:
+        pytest_args = PYTEST_ARGS[style]
+
+    if run_tests:
+        exit_on_failure(pytest.main(pytest_args))
+
+    if run_black:
+        exit_on_failure(black_main(BLACK_ARGS))
+
+    if run_flake8:
+        exit_on_failure(flake8_main(FLAKE8_ARGS))
+
+    if run_isort:
+        exit_on_failure(isort_main(ISORT_ARGS))

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`[pytest]`
`2`	`2`	`DJANGO_CONFIGURATION=Testing`
	`3`	`+DJANGO_SETTINGS_MODULE=contratospr.settings`