#485 refactor of all tests

Author: royrusso

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2013-2018, Roy Russo
+Copyright 2013-2019, Roy Russo
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

docs/source/developer-guide.rst

@@ -57,27 +57,25 @@ Once the distribution is built, you can start the server with ``python applicati
 Running Tests
 -------------
 
-1. ``/tests/scripts`` contains ``start_clusters.sh`` which will start up 3 ES clusters on ports 9200, 8200, 7200. These are versions 2.x, 5.x, and 6.x respectively.
-2. Edit ``start_clusters.sh`` to point to your local ES binaries.
-3. Source the virtual environment:
+All tests run using docker containers for specific versions of ES. Running the entire suite will run against all containers, one at a time.
+
+To run all tests across all ES major versions:
 
 .. code-block:: bash
 
-    source ../environments/elastichq/bin/activate
+    ./run-tests.sh
 
-4. To run tests:
+To run tests for a specific major version of ES:
 
 .. code-block:: bash
 
-    elastichq/run_tests
-
+    python manage.py run-tests --esv=<MAJOR_VERSION>
 
 Notes
 ~~~~~
 
-* Coverage report will be appear under ``/tests/cover``.
-* All tests will fail without those 3 clusters running. They are the 3 major versions that HQ currently supports.
-* The scripts under ``/tests/scripts`` allow for starting, stopping, and listing all clusters. You will need to edit those for the tests to run.
+* Coverage report will be appear under ``/tests/htmlcov``.
+* HTML report of pytest output will appear under ``/tests/htmlout11.
 
 Building Documentation
 ----------------------

manage.py

@@ -95,60 +95,67 @@ class PyTest(Command):
     """
     Runs all unittests. You MUST make sure that all clusters configured are running for the tests to pass!
     """
+    version = None
 
-    def run(self):
+    def get_options(self):
+        options = (
+            Option('-E', '--esv',
+                   dest='version',
+                   default=self.version),
+
+        )
+        return options
+
+    def run(self, version):
         import pytest
 
         tests_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'tests')
         sys.path.append(os.path.abspath(tests_path))
 
-        pytest.main(
-            [
-                tests_path,
-                '--verbose',
-                '--color=yes',
-                '-c=' + tests_path + '/pytest.ini',
+        default_test_args = [
+            tests_path,
+            '--ignore=node_modules',
+            '--verbose',
+            '--color=yes',
+            '-c=' + tests_path + '/pytest.ini',
+            '--docker-compose-remove-volumes',
+            # '-s',  # WARNING: Turning this on, breaks the tests on a Mac.
+            '--cov=' + tests_path,
+            '--cov-report=html:' + tests_path + '/htmlcov',
+            '--self-contained-html'
+        ]
+
+        sig = None
+        if version is None:
+            hq_args = [
                 '--docker-compose=' + tests_path + '/hq_docker-compose.yml',
-                '--docker-compose-remove-volumes',
-                '-m=hq_ops',
-                '-s',  # verbose logging
-                '--cov=' + tests_path,
-                '--cov-report=html:' + tests_path + '/htmlcov',
                 '--html=' + tests_path + '/htmlout/hq_ops.html',
-                '--self-contained-html'
-            ])
-
-        pytest.main(
-            [
-                tests_path,
-                '--verbose',
-                '--color=yes',
-                '-c=' + tests_path + '/pytest.ini',
-                '--docker-compose=' + tests_path + '/v2_docker-compose.yml',
-                '--docker-compose-remove-volumes',
-                '-m=es_versions',
-                '-s',  # verbose logging
-                '--cov=' + tests_path,
-                '--html=' + tests_path + '/htmlout/es_2.html',
-                '--self-contained-html'
-            ])
-
-        pytest.main(
-            [
-                tests_path,
-                '--verbose',
-                '--color=yes',
-                '-c=' + tests_path + '/pytest.ini',
-                '--docker-compose=' + tests_path + '/v5_docker-compose.yml',
-                '--docker-compose-remove-volumes',
-                '-m=es_versions',
-                '-s',  # verbose logging
-                '--cov=' + tests_path,
-                '--html=' + tests_path + '/htmlout/es_5.html',
-                '--self-contained-html'
-            ])
-
-        return None
+                '-m=hq_ops'
+            ]
+            sig = pytest.main(default_test_args + hq_args)
+
+        if version is not None:
+            if "2" in version:
+                v2_args = ['--docker-compose=' + tests_path + '/v2_docker-compose.yml', '-m=es_versions',
+                           '--html=' + tests_path + '/htmlout/es_2.html']
+                sig = pytest.main(default_test_args + v2_args)
+
+            if "5" in version:
+                v5_args = ['--docker-compose=' + tests_path + '/v5_docker-compose.yml', '-m=es_versions',
+                           '--html=' + tests_path + '/htmlout/es_5.html']
+                sig = pytest.main(default_test_args + v5_args)
+
+            if "6" in version:
+                v6_args = ['--docker-compose=' + tests_path + '/v6_docker-compose.yml', '-m=es_versions',
+                           '--html=' + tests_path + '/htmlout/es_6.html']
+                sig = pytest.main(default_test_args + v6_args)
+
+            if "7" in version:
+                v7_args = ['--docker-compose=' + tests_path + '/v7_docker-compose.yml', '-m=es_versions',
+                           '--html=' + tests_path + '/htmlout/es_7.html']
+                sig = pytest.main(default_test_args + v7_args)
+
+        return sig
 
 
 manager.add_command("runserver", Server())

run-tests.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+python manage.py run-tests
+
+python manage.py run-tests --esv=2
+
+python manage.py run-tests --esv=5
+
+python manage.py run-tests --esv=6
+
+python manage.py run-tests --esv=7

run_tests.sh

@@ -1,15 +1,12 @@
 __author__ = 'royrusso'
 
-import logging
-
 import pytest
 
 pytest_plugins = ["docker_compose"]
-LOGGER = logging.getLogger(__name__)
 
 
 @pytest.mark.hq_ops
-def test_get_clusters(session_scoped_container_getter, fixture):
+def test_get_clusters(fixture):
     fixture.clear_all_clusters()
 
     response = fixture.app.get('/api/clusters')

tests/combined/test_connections.py

@@ -19,6 +19,7 @@
 @pytest.fixture(scope="session", autouse=True)
 def wait_for_api(session_scoped_container_getter):
     """Wait for the api from elasticsearch to become responsive"""
+    LOGGER.info("Waiting on API...")
     request_session = requests.Session()
     retries = Retry(total=20,
                     backoff_factor=0.1,
@@ -60,7 +61,7 @@ def create_indices(session_scoped_container_getter):
     Creates indices for testing. Applies mapping and populates with test data.
     :return:
     """
-    LOGGER.info("******** Creating Indices...")
+    print("******** Creating Indices...")
     try:
         cur_path = os.path.dirname(__file__)
         test_data_path = os.path.join(cur_path, 'data')

tests/conftest.py

@@ -0,0 +1,13 @@
+<html>
+<head>
+
+</head>
+
+<a href="htmlcov/index.html">Coverage Report</a>
+<hr/>
+<a href="htmlout/hq_ops.html">ElasticHQ Tests</a><br/>
+<a href="htmlout/es_2.html">Elasticsearch 2.x Tests</a><br/>
+<a href="htmlout/es_5.html">Elasticsearch 5.x Tests</a><br/>
+<a href="htmlout/es_6.html">Elasticsearch 6.x Tests</a><br/>
+<a href="htmlout/es_7.html">Elasticsearch 7.x Tests</a>
+</html>

tests/index.html

@@ -3,12 +3,13 @@ markers =
     hq_ops: HQ-specific operations. Uses Flask + ES 2.x for now.
     es_versions: Elasticsearch version-specific operations.
 
-addopts = ''
+;addopts = ''
 
 log_cli = 1
 log_cli_level = INFO
 log_cli_format = %(asctime)s [%(levelname)8s] %(message)s (%(filename)s:%(lineno)s)
 log_cli_date_format=%Y-%m-%d %H:%M:%S
+
 ;
 ;log_file = pytest.log
 ;log_file_level = DEBUG