uber-compose 1.0.0__tar.gz

uber_compose-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2023] [Yuriy Sagitov]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

uber_compose-1.0.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: uber-compose
+Version: 1.0.0
+Summary: docker compose testing env orchestrator
+Home-page: https://github.com/ko10ok/uber-compose
+Author: Yuriy Sagitov
+Author-email: pro100.ko10ok@gmail.com
+License: Apache-2.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: vedro<2.0,>=1.10
+Requires-Dist: PyYAML<6.1,>=6.0.1
+Requires-Dist: rtry<2.0,>=1.4.0
+Requires-Dist: rich<16.0,>=11.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Uber-Compose
+
+Lightweight docker compose extension to control environment for tests

uber_compose-1.0.0/README.md

@@ -0,0 +1,3 @@
+# Uber-Compose
+
+Lightweight docker compose extension to control environment for tests

uber_compose-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

uber_compose-1.0.0/setup.py

@@ -0,0 +1,43 @@
+import pathlib
+
+from setuptools import find_packages
+from setuptools import setup
+
+
+def find_required():
+    with open("requirements.txt") as f:
+        return f.read().splitlines()
+
+
+def get_version(filename='uber_compose/version'):
+    return open(filename, "r").read().strip()
+
+
+HERE = pathlib.Path(__file__).parent
+README = open("README.md").read()
+setup(
+    name="uber-compose",
+    version=get_version(),
+    description="docker compose testing env orchestrator",
+    long_description=README,
+    long_description_content_type="text/markdown",
+    author="Yuriy Sagitov",
+    author_email="pro100.ko10ok@gmail.com",
+    python_requires=">=3.10.0",
+    url="https://github.com/ko10ok/uber-compose",
+    license="Apache-2.0",
+    packages=find_packages(exclude=("tests",)),
+    install_requires=find_required(),
+    entry_points={},
+    classifiers=[
+        "License :: OSI Approved :: Apache Software License",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    package_data={
+        'uber_compose': ['version'],
+    },
+)

uber_compose-1.0.0/uber_compose/__init__.py

@@ -0,0 +1,16 @@
+from uber_compose.core.sequence_run_types import ComposeConfig
+from uber_compose.env_description.env_types import Env
+from uber_compose.env_description.env_types import Environment
+from uber_compose.env_description.env_types import OverridenService
+from uber_compose.env_description.env_types import Service
+from uber_compose.uber_compose import TheUberCompose
+from uber_compose.vedro_plugin.plugin import DEFAULT_COMPOSE
+from uber_compose.vedro_plugin.plugin import VedroUberCompose
+from uber_compose.version import get_version
+
+__version__ = get_version()
+__all__ = (
+    'TheUberCompose',
+    'Environment', 'Service', 'Env', 'OverridenService'
+    'VedroUberCompose', 'DEFAULT_COMPOSE', 'ComposeConfig'
+)

uber_compose-1.0.0/uber_compose/core/constants.py

@@ -0,0 +1,24 @@
+import os
+from pathlib import Path
+
+
+class Constants:
+    def __init__(self):
+        self.default_log_policy = os.environ.get('LOG_POLICY', 'DEFAULT')
+
+        self.project: str = os.environ.get('COMPOSE_PROJECT_NAME')
+        self.compose_project_name = os.environ.get('COMPOSE_PROJECT_NAME')
+        assert self.compose_project_name, 'COMPOSE_PROJECT_NAME environment variable is not set: - COMPOSE_PROJECT_NAME=${PWD##*/}'
+
+        self.docker_host = os.environ.get('DOCKER_HOST', 'unix:///var/run/docker.sock')
+
+        # inner directories
+        self.non_stop_containers: list[str] = os.environ.get('NON_STOP_CONTAINERS', 'e2e,dockersock').split(',')
+        self.tmp_envs_path: Path = Path(os.environ.get('TMP_ENVS_DIRECTORY', '/tmp-envs'))
+        self.in_docker_project_root_path: Path = Path(os.environ.get('PROJECT_ROOT_DIRECTORY', '/project'))
+
+        self.host_project_root_directory: Path = Path(
+            os.environ.get('HOST_PROJECT_ROOT_DIRECTORY', '__host_project_root__')
+        )
+
+        self.docker_compose_extra_exec_params = os.environ.get('DOCKER_COMPOSE_EXTRA_EXEC_PARAMS', '-T')

uber_compose-1.0.0/uber_compose/core/docker_compose.py

@@ -0,0 +1,243 @@
+import os
+import sys
+from asyncio import sleep
+from pathlib import Path
+
+from rich.text import Text
+
+from uber_compose.core.constants import Constants
+from uber_compose.core.docker_compose_shell.interface import ComposeShellInterface
+from uber_compose.core.sequence_run_types import ComposeInstanceFiles
+from uber_compose.core.sequence_run_types import EnvInstanceConfig
+from uber_compose.core.utils.compose_files import get_compose_services_dependency_tree
+from uber_compose.core.utils.compose_files import make_env_compose_instance_files
+from uber_compose.core.utils.compose_instance_cfg import make_env_instance_config
+from uber_compose.core.utils.state_waiting import wait_all_services_up
+from uber_compose.env_description.env_types import Environment
+from uber_compose.env_description.env_types import EventStage
+from uber_compose.errors.up import ServicesUpError
+from uber_compose.helpers.health_policy import UpHealthPolicy
+from uber_compose.helpers.jobs_result import JobResult
+from uber_compose.output.console import Logger
+from uber_compose.output.styles import Style
+
+INFLIGHT = 'inflight'
+
+
+class ComposeInstance:
+    def __init__(self,
+                 project: str,
+                 name: str,  # sometimes differs from Env.name in example DEFAULT_dev for different dc set
+                 new_env_id: str,
+                 compose_interface: type[ComposeShellInterface],  # = ComposeShellInterface
+                 compose_files: str,
+                 config_template: Environment | None,
+                 in_docker_project_root: Path,
+                 host_project_root_directory: Path,
+                 except_containers: list[str],
+                 tmp_envs_path: Path,
+                 execution_envs: dict = None,
+                 release_id: str = None,
+                 logger: Logger = None,
+                 health_policy: UpHealthPolicy = UpHealthPolicy(),
+                 ):
+        self.logger = logger
+        self.health_policy = health_policy
+        self.compose_files = compose_files
+        self.in_docker_project_root = in_docker_project_root
+        self.host_project_root_directory = host_project_root_directory
+        self.except_containers = except_containers
+        self.tmp_envs_path = tmp_envs_path
+
+        self.project = project
+        if execution_envs is None:
+            self.execution_envs = dict(os.environ)
+
+        self.new_env_id = new_env_id
+        self.name = name
+        self.config_template = config_template
+        self._env_instance_config = None
+        self.compose_interface = compose_interface
+
+        self.release_id: str = release_id
+
+        self.compose_instance_files: ComposeInstanceFiles = None
+        for file in self.compose_files.split(':'):
+            assert (file := Path(self.in_docker_project_root / file)).exists(), f'File {file} doesnt exist'
+
+    async def config(self) -> EnvInstanceConfig:
+        if self._env_instance_config is None:
+            self._env_instance_config = make_env_instance_config(
+                env_template=self.config_template,
+                env_id=self.new_env_id,
+                name=self.name,
+            )
+        return self._env_instance_config
+
+    async def generate_config_files(self) -> ComposeInstanceFiles:
+        assert self.new_env_id != INFLIGHT, 'somehow regenerated files for inflight env'
+        compose_instance_files = make_env_compose_instance_files(
+            await self.config(),
+            self.compose_files,
+            project_network_name=self.project,
+            host_project_root_directory=self.host_project_root_directory,
+            compose_files_path=self.in_docker_project_root,
+            tmp_env_path=self.tmp_envs_path,
+            release_id=self.release_id,
+        )
+        # TODO uneven compose_executor initialization!! but compose_interface compose_files-dependent
+        self.compose_executor = self.compose_interface(
+            compose_files=compose_instance_files.compose_files,
+            in_docker_project_root=self.in_docker_project_root,
+            logger=self.logger,
+        )
+        return compose_instance_files
+
+    async def run_migration(self, stages, services, env_config_instance, migrations):
+        for service in env_config_instance.env:
+            sys.stdout.flush()
+            if service not in services:
+                continue
+
+            for handler in migrations[service]:
+                if handler.stage not in stages:
+                    continue
+
+                # TODO fix service map if default env
+                target_service = env_config_instance.env_services_map[handler.executor or service]
+
+                # TODO check if need to template migrations
+                #   substituted_cmd = handler.cmd.format(**env_config_instance.env_services_map)
+                substituted_cmd = handler.cmd
+                migrate_result = await self.compose_executor.dc_exec_until_state(
+                    target_service, substituted_cmd,
+                    kill_before=False,
+                    kill_after=False,
+                )
+                if not migrate_result.check_result:
+                    services_status = await self.compose_executor.dc_state()
+                    raise ServicesUpError(f"Can't migrate service {target_service}, with {substituted_cmd}"
+                                          f"\n{migrate_result.stdout=}\n{migrate_result.stderr=}"
+                                          # TODO fix too verbose to file output?
+                                          # f"\nUp logs:\n {await self.logs(self.except_containers)}"
+                                          f"\nServices logs:\n {await self.logs(services)}"
+                                          f"\nServices status:\n {services_status.as_rich_text()}") from None
+
+    async def run_services_pack(self, services: list[str], migrations):
+
+        for container in self.except_containers:
+            if container in services:
+                services.remove(container)
+        self.logger.stage_details(f'Starting services pack: {services}; except: {self.except_containers}')
+
+        status_result = await self.compose_executor.dc_state()
+        assert status_result != JobResult.BAD, f"Can't get first status for services {services}"
+
+        await self.run_migration(
+            [EventStage.BEFORE_SERVICE_START],
+            services,
+            self.compose_instance_files.env_config_instance,
+            migrations
+        )
+
+        up_result = await self.compose_executor.dc_up(services)
+        assert up_result == JobResult.GOOD, (f"Can't run up services {services}\nIssues on up attempt:\n "
+                                             f"{up_result}")
+
+        await self.run_migration(
+            [EventStage.AFTER_SERVICE_START],
+            services,
+            self.compose_instance_files.env_config_instance,
+            migrations
+        )
+
+        # up process asynchronous
+        # check services started before migrations if health policy told to do that:
+
+        await sleep(self.health_policy.pre_check_delay_s)
+        if self.health_policy.wait_for_healthy_in_between:
+            check_up_result = await wait_all_services_up(
+                attempts=self.health_policy.service_up_check_attempts,
+                delay_s=self.health_policy.service_up_check_delay_s,
+                logger_func=self.logger.stage_details,
+                get_compose_state=self.compose_executor.dc_state,
+            )
+            if check_up_result != JobResult.GOOD:
+                services_status = await self.compose_executor.dc_state()
+                raise ServicesUpError(
+                    f"Can't up services {services} for "
+                    f"{self.health_policy.service_up_check_attempts * self.health_policy.service_up_check_delay_s}s"
+                    # TODO fix too verbose to file output?
+                    # f"\nUp logs:\n {await self.logs(self.except_containers)}"
+                    # f"\nServices logs:\n {await self.logs(services)}"
+                    f"\nServices status:\n {services_status.as_rich_text()}"
+                ) from None
+
+        await self.run_migration(
+            [EventStage.AFTER_SERVICE_HEALTHY],
+            services,
+            self.compose_instance_files.env_config_instance,
+            migrations
+        )
+
+    async def run(self):
+        self.compose_instance_files = await self.generate_config_files()
+
+        services_tiers = get_compose_services_dependency_tree(self.compose_instance_files.compose_files)
+        self.logger.stage_info(
+            Text('Starting services: ', style=Style.info)
+            .append(Text(str(services_tiers), style=Style.good))
+        )
+
+        migrations = {}
+        for service in self.compose_instance_files.env_config_instance.env:
+            if service not in migrations:
+                migrations[service] = []
+            migrations[service] += self.compose_instance_files.env_config_instance.env[service].events_handlers
+            migrations[service] += self.compose_instance_files.inline_migrations[service]
+
+        all_services = [
+            service
+            for service_tier_pack in services_tiers
+            for service in service_tier_pack
+        ]
+
+        await self.run_migration(
+            [EventStage.BEFORE_ALL],
+            all_services,
+            self.compose_instance_files.env_config_instance,
+            migrations
+        )
+
+        for service_tier_pack in services_tiers:
+            await self.run_services_pack(service_tier_pack, migrations)
+
+        await self.run_migration(
+            [EventStage.AFTER_ALL],
+            all_services,
+            self.compose_instance_files.env_config_instance,
+            migrations
+        )
+
+        if self.health_policy.wait_for_healthy_after_all:
+            check_up_result = await wait_all_services_up(
+                attempts=self.health_policy.service_up_check_attempts,
+                delay_s=self.health_policy.service_up_check_delay_s,
+                logger_func=self.logger.stage,
+                get_compose_state=self.compose_executor.dc_state,
+            )
+            if check_up_result != JobResult.GOOD:
+                services_status = await self.compose_executor.dc_state()
+                raise ServicesUpError(
+                    f"Can't up services {all_services} all together for "
+                    f"{self.health_policy.service_up_check_attempts * self.health_policy.service_up_check_delay_s}s"
+                    # TODO fix too verbose to file output?
+                    # f"\nUp logs:\n {await self.logs(self.except_containers)}"
+                    # f"\nServices logs:\n {await self.logs(services)}"
+                    f"\nServices status:\n {services_status.as_rich_text()}"
+                ) from None
+
+
+    async def logs(self, services=None) -> str:
+        job_result, log = await self.compose_executor.dc_logs(services, logs_param='')
+        return log.decode('utf-8') if job_result == JobResult.GOOD else ''