-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: adding lovely-pytest-docker code (#816)
This PR contains following changes - Added code for lovely-pytest-docker in PSA and migrated to v2 version of docker-compose as GitHub runners have stopped supporting docker compose v1. - Also fixed the CI runs for e2e tests as it always running on latest splunk instead of version provided by addonfactory-splunk-matrix.
- Loading branch information
1 parent
533efe5
commit ddca79c
Showing
9 changed files
with
256 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| import functools | ||
| import os | ||
| from urllib.request import urlopen | ||
|
|
||
| import pytest | ||
| import re | ||
| import subprocess | ||
| import time | ||
| import timeit | ||
|
|
||
| from requests import HTTPError | ||
|
|
||
|
|
||
| def check_url(docker_ip, public_port, path="/"): | ||
| """Check if a service is reachable. | ||
| Makes a simple GET request to path of the HTTP endpoint. Service is | ||
| available if returned status code is < 500. | ||
| """ | ||
| url = "http://{}:{}{}".format(docker_ip, public_port, path) | ||
| try: | ||
| r = urlopen(url) | ||
| return r.code < 500 | ||
| except HTTPError as e: | ||
| # If service returns e.g. a 404 it's ok | ||
| return e.code < 500 | ||
| except Exception: | ||
| # Possible service not yet started | ||
| return False | ||
|
|
||
|
|
||
| def execute(command, success_codes=(0,)): | ||
| """Run a shell command.""" | ||
| try: | ||
| output = subprocess.check_output( | ||
| command, | ||
| stderr=subprocess.STDOUT, | ||
| shell=False, | ||
| ) | ||
| status = 0 | ||
| except subprocess.CalledProcessError as error: | ||
| output = error.output or b"" | ||
| status = error.returncode | ||
| command = error.cmd | ||
| output = output.decode("utf-8") | ||
| if status not in success_codes: | ||
| raise Exception('Command %r returned %d: """%s""".' % (command, status, output)) | ||
| return output | ||
|
|
||
|
|
||
| class Services(object): | ||
| """A class which encapsulates services from docker compose definition. | ||
| This code is partly taken from | ||
| https://github.com/AndreLouisCaron/pytest-docker | ||
| """ | ||
|
|
||
| def __init__(self, compose_files, docker_ip, project_name="pytest"): | ||
| self._docker_compose = DockerComposeExecutor(compose_files, project_name) | ||
| self._services = {} | ||
| self.docker_ip = docker_ip | ||
|
|
||
| def start(self, *services): | ||
| """Ensures that the given services are started via docker compose. | ||
| :param services: the names of the services as defined in compose file | ||
| """ | ||
| self._docker_compose.execute("up", "--build", "-d", *services) | ||
|
|
||
| def stop(self, *services): | ||
| """Ensures that the given services are stopped via docker compose. | ||
| :param services: the names of the services as defined in compose file | ||
| """ | ||
| self._docker_compose.execute("stop", *services) | ||
|
|
||
| def execute(self, service, *cmd): | ||
| """Execute a command inside a docker container. | ||
| :param service: the name of the service as defined in compose file | ||
| :param cmd: list of command parts to execute | ||
| """ | ||
| return self._docker_compose.execute("exec", "-T", service, *cmd) | ||
|
|
||
| def wait_for_service( | ||
| self, service, private_port, check_server=check_url, timeout=30.0, pause=0.1 | ||
| ): | ||
| """ | ||
| Waits for the given service to response to a http GET. | ||
| :param service: the service name as defined in the docker compose file | ||
| :param private_port: the private port as defined in docker compose file | ||
| :param check_server: optional function to check if the server is ready | ||
| (default check method makes GET request to '/' | ||
| of HTTP endpoint) | ||
| :param timeout: maximum time to wait for the service in seconds | ||
| :param pause: time in seconds to wait between retries | ||
| :return: the public port of the service exposed to host system if any | ||
| """ | ||
| public_port = self.port_for(service, private_port) | ||
| self.wait_until_responsive( | ||
| timeout=timeout, | ||
| pause=pause, | ||
| check=lambda: check_server(self.docker_ip, public_port), | ||
| ) | ||
| return public_port | ||
|
|
||
| def shutdown(self): | ||
| self._docker_compose.execute("down", "-v") | ||
|
|
||
| def port_for(self, service, port): | ||
| """Get the effective bind port for a service.""" | ||
|
|
||
| # Lookup in the cache. | ||
| cache = self._services.get(service, {}).get(port, None) | ||
| if cache is not None: | ||
| return cache | ||
|
|
||
| output = self._docker_compose.execute("port", service, str(port)) | ||
| endpoint = output.strip() | ||
| if not endpoint: | ||
| raise ValueError('Could not detect port for "%s:%d".' % (service, port)) | ||
|
|
||
| # Usually, the IP address here is 0.0.0.0, so we don't use it. | ||
| match = int(endpoint.split(":", 1)[1]) | ||
|
|
||
| # Store it in cache in case we request it multiple times. | ||
| self._services.setdefault(service, {})[port] = match | ||
|
|
||
| return match | ||
|
|
||
| @staticmethod | ||
| def wait_until_responsive(check, timeout, pause, clock=timeit.default_timer): | ||
| """Wait until a service is responsive.""" | ||
|
|
||
| ref = clock() | ||
| now = ref | ||
| while (now - ref) < timeout: | ||
| if check(): | ||
| return | ||
| time.sleep(pause) | ||
| now = clock() | ||
|
|
||
| raise Exception("Timeout reached while waiting on service!") | ||
|
|
||
|
|
||
| class DockerComposeExecutor(object): | ||
| def __init__(self, compose_files, project_name): | ||
| self._compose_files = compose_files | ||
| self._project_name = project_name | ||
| self.project_directory = os.path.dirname(os.path.realpath(compose_files[0])) | ||
|
|
||
| def execute(self, *subcommand): | ||
| command = ["docker", "compose"] | ||
| for compose_file in self._compose_files: | ||
| command.append("-f") | ||
| command.append(compose_file) | ||
| command.append("-p") | ||
| command.append(self._project_name) | ||
| command += subcommand | ||
| return execute(command) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.