hooking up integration tests with mock servers (#253)

Author: Juliya Smith

.github/workflows/build.yml

@@ -18,15 +18,42 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
+        with:
+          path: code42cli
       - name: Setup Python
         uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python }}
       - name: Install tox
         run: pip install tox==3.17.1
       - name: Run Unit tests
-        run: tox -e py  # Run tox using the version of Python in `PATH`
+        run: cd code42cli; tox -e py  # Run tox using the version of Python in `PATH`
       - name: Submit coverage report
         uses: codecov/codecov-action@v1.0.7
         with:
-          file: ./coverage.xml
+          file: code42cli/coverage.xml
+      - name: Checkout mock servers
+        uses: actions/checkout@v2
+        with:
+          repository: code42/code42-mock-servers
+          path: code42-mock-servers
+      - name: Add mock servers host addresses
+        run: |
+          sudo tee -a /etc/hosts <<EOF
+          127.0.0.1 core
+          127.0.0.1 alerts
+          127.0.0.1 alert-rules
+          127.0.0.1 detection-lists
+          127.0.0.1 audit-log
+          127.0.0.1 file-events
+          127.0.0.1 storage
+          127.0.0.1 preservation-data-service
+          127.0.0.1 connected-server
+          127.0.0.1 cases
+          EOF
+      - name: Install ncat
+        run: sudo apt-get install ncat
+      - name: Start up the mock servers
+        run: cd code42-mock-servers; docker-compose up -d --build
+      - name: Run the integration tests
+        run: cd code42cli; tox -e integration

src/code42cli/cmds/search/options.py

@@ -152,10 +152,12 @@ def server_options(f):
         type=click.Choice(ServerProtocol(), case_sensitive=False),
         default=ServerProtocol.UDP,
         help="Protocol used to send logs to server. "
-        "Use TLS for additional security. Defaults to UDP.",
+        "Use TCP-TLS for additional security. Defaults to UDP.",
     )
     certs_option = click.option(
-        "--certs", type=str, help="A CA certificates-chain file for the TLS protocol."
+        "--certs",
+        type=str,
+        help="A CA certificates-chain file for the TCP-TLS protocol.",
     )
     ignore_cert_validation = click.option(
         "--ignore-cert-validation",

tests/integration/conftest.py

@@ -49,13 +49,13 @@ def append_profile(command):
     return "{} --profile {}".format(command, TEST_PROFILE_NAME)
 
 
-@pytest.yield_fixture(scope="session")
+@pytest.fixture(scope="session")
 def udp_dataserver():
     with DataServer(protocol="UDP"):
         yield
 
 
-@pytest.yield_fixture(scope="session")
+@pytest.fixture(scope="session")
 def tcp_dataserver():
     with DataServer(protocol="TCP"):
         yield

tests/integration/util.py

@@ -1,5 +1,6 @@
 import os
 import subprocess
+import time
 from shlex import split as split_command
 
 from code42cli.main import cli
@@ -48,7 +49,8 @@ def __init__(self, protocol="TCP"):
         self.process = None
 
     def __enter__(self):
-        self.process = subprocess.Popen(self.command.split(" "))
+        self.process = subprocess.Popen(self.command, shell=True)
+        time.sleep(1)
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         self.process.kill()

tox.ini

@@ -39,7 +39,6 @@ deps = pre-commit
 skip_install = true
 commands = pre-commit run --all-files --show-diff-on-failure
 
-
 [testenv:nightly]
 deps =
     pytest == 4.6.11
@@ -48,6 +47,9 @@ deps =
     git+https://github.com/code42/py42.git@master#egg=py42
     git+ssh://git@github.com/code42/c42eventextractor.git@master#egg=c42eventextractor
 
+[testenv:integration]
+commands =
+    pytest -v -rsxX -l --tb=short --strict -m integration
 
 [pytest]
 markers =