mantis-cli 22.2.0__tar.gz → 22.3.0__tar.gz

{mantis_cli-22.2.0 → mantis_cli-22.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: mantis_cli
-Version: 22.2.0
+Version: 22.3.0
 Summary: Management command to build and deploy webapps, especially based on Django
 Home-page: https://github.com/PragmaticMates/mantis-cli
 Author: Erik Telepovský
@@ -9,7 +9,6 @@ Maintainer: Pragmatic Mates
 Maintainer-email: info@pragmaticmates.com
 License: GNU General Public License (GPL)
 Keywords: management deployment docker command
-Platform: UNKNOWN
 Classifier: Programming Language :: Python
 Classifier: Operating System :: OS Independent
 Classifier: Environment :: Web Environment
@@ -19,6 +18,27 @@ Classifier: License :: OSI Approved :: GNU General Public License (GPL)
 Classifier: Development Status :: 5 - Production/Stable
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: cffi
+Requires-Dist: click
+Requires-Dist: cryptography
+Requires-Dist: pycryptodome
+Requires-Dist: pydantic
+Requires-Dist: PyYAML
+Requires-Dist: rich
+Requires-Dist: typer
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: requires-dist
+Dynamic: summary
 
 # mantis-cli
 
@@ -325,18 +345,18 @@ Run `mantis --help` to see all available commands with their descriptions.
 
 | Command / Shortcut                    | Description                                               |
 |---------------------------------------|-----------------------------------------------------------|
-| logs [CONTAINER] / l                  | Prints logs of containers                                 |
+| logs [CONTAINER\|SERVICE] / l          | Prints logs of containers                                 |
 | networks / n                          | Prints docker networks                                    |
-| healthcheck [CONTAINER] / hc          | Execute health-check of container                         |
+| healthcheck [CONTAINER\|SERVICE] / hc  | Execute health-check of container                         |
 | stop [CONTAINERS...]                  | Stops containers                                          |
 | start [CONTAINERS...]                 | Starts containers                                         |
 | kill [CONTAINERS...]                  | Kills containers                                          |
 | remove [CONTAINERS...] [--force]      | Removes containers                                        |
 | rename CONTAINER NEW_NAME             | Rename container                                          |
-| bash CONTAINER                        | Runs bash in container                                    |
-| sh CONTAINER                          | Runs sh in container                                      |
-| exec CONTAINER COMMAND...             | Executes command in container                             |
-| exec-it CONTAINER COMMAND...          | Executes command in container (interactive)               |
+| bash CONTAINER\|SERVICE               | Runs bash in container                                    |
+| sh CONTAINER\|SERVICE                 | Runs sh in container                                      |
+| exec CONTAINER\|SERVICE COMMAND...    | Executes command in container                             |
+| exec-it CONTAINER\|SERVICE COMMAND... | Executes command in container (interactive)               |
 | get-container-name SERVICE            | Gets container name for service                           |
 | remove-suffixes [PREFIX]              | Removes numerical suffixes from container names           |
 
@@ -520,6 +540,38 @@ If you need to follow logs of a specific container, you can do it by passing con
 mantis -e <ENVIRONMENT> logs <container-name>
 ```
 
+#### Container or service name
+
+Commands taking a container (`logs`, `healthcheck`, `bash`, `sh`, `exec`, `exec-it`) also accept a
+plain service name and mantis finds its container(s) for you, including scaled ones with numerical
+suffixes and services declaring their own `container_name`:
+
+```bash
+mantis -e production logs app   # reads logs of <project>-app container
+mantis -e production bash app   # same container, no need to type the project prefix
+```
+
+A name which is not a service is still matched against container names without their project
+prefix, which covers services numbered in the compose file:
+
+```bash
+mantis -e production logs htmltopdf  # reads <project>-htmltopdf-1 and <project>-htmltopdf-2
+```
+
+An exact container name always takes precedence: if a container literally named `app` exists,
+`logs app` reads that one instead of `<project>-app`. Names matching no container at all are
+passed to docker as they are.
+
+`logs` follows all matching containers at once, prefixing every line with a container name:
+
+```
+itfitness-htmltopdf-1 | POST /generate-pdf 200 3355.969 ms - 837045
+itfitness-htmltopdf-2 | POST /generate-pdf 200 889.662 ms - 747746
+```
+
+Commands which can only operate on one container (`bash`, `sh`, `exec`, `exec-it`, `healthcheck`)
+use the first match and warn about the rest.
+
 ### 5. Another useful commands
 
 Sometimes, instead of calling whole deployment process, you just need to call compose commands directly:
@@ -559,4 +611,3 @@ Works as follows:
 ## Release notes
 
 Mantis uses semantic versioning. See more in [changelog](https://github.com/PragmaticMates/mantis-cli/blob/master/CHANGES.md).
-

mantis_cli-22.2.0/mantis_cli.egg-info/PKG-INFO → mantis_cli-22.3.0/README.md

@@ -1,25 +1,3 @@
-Metadata-Version: 2.1
-Name: mantis-cli
-Version: 22.2.0
-Summary: Management command to build and deploy webapps, especially based on Django
-Home-page: https://github.com/PragmaticMates/mantis-cli
-Author: Erik Telepovský
-Author-email: info@pragmaticmates.com
-Maintainer: Pragmatic Mates
-Maintainer-email: info@pragmaticmates.com
-License: GNU General Public License (GPL)
-Keywords: management deployment docker command
-Platform: UNKNOWN
-Classifier: Programming Language :: Python
-Classifier: Operating System :: OS Independent
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: Framework :: Django
-Classifier: License :: OSI Approved :: GNU General Public License (GPL)
-Classifier: Development Status :: 5 - Production/Stable
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
 # mantis-cli
 
 Mantis is a CLI (command line interface) tool designed as a wrapper upon docker and docker compose commands for your project.
@@ -325,18 +303,18 @@ Run `mantis --help` to see all available commands with their descriptions.
 
 | Command / Shortcut                    | Description                                               |
 |---------------------------------------|-----------------------------------------------------------|
-| logs [CONTAINER] / l                  | Prints logs of containers                                 |
+| logs [CONTAINER\|SERVICE] / l          | Prints logs of containers                                 |
 | networks / n                          | Prints docker networks                                    |
-| healthcheck [CONTAINER] / hc          | Execute health-check of container                         |
+| healthcheck [CONTAINER\|SERVICE] / hc  | Execute health-check of container                         |
 | stop [CONTAINERS...]                  | Stops containers                                          |
 | start [CONTAINERS...]                 | Starts containers                                         |
 | kill [CONTAINERS...]                  | Kills containers                                          |
 | remove [CONTAINERS...] [--force]      | Removes containers                                        |
 | rename CONTAINER NEW_NAME             | Rename container                                          |
-| bash CONTAINER                        | Runs bash in container                                    |
-| sh CONTAINER                          | Runs sh in container                                      |
-| exec CONTAINER COMMAND...             | Executes command in container                             |
-| exec-it CONTAINER COMMAND...          | Executes command in container (interactive)               |
+| bash CONTAINER\|SERVICE               | Runs bash in container                                    |
+| sh CONTAINER\|SERVICE                 | Runs sh in container                                      |
+| exec CONTAINER\|SERVICE COMMAND...    | Executes command in container                             |
+| exec-it CONTAINER\|SERVICE COMMAND... | Executes command in container (interactive)               |
 | get-container-name SERVICE            | Gets container name for service                           |
 | remove-suffixes [PREFIX]              | Removes numerical suffixes from container names           |
 
@@ -520,6 +498,38 @@ If you need to follow logs of a specific container, you can do it by passing con
 mantis -e <ENVIRONMENT> logs <container-name>
 ```
 
+#### Container or service name
+
+Commands taking a container (`logs`, `healthcheck`, `bash`, `sh`, `exec`, `exec-it`) also accept a
+plain service name and mantis finds its container(s) for you, including scaled ones with numerical
+suffixes and services declaring their own `container_name`:
+
+```bash
+mantis -e production logs app   # reads logs of <project>-app container
+mantis -e production bash app   # same container, no need to type the project prefix
+```
+
+A name which is not a service is still matched against container names without their project
+prefix, which covers services numbered in the compose file:
+
+```bash
+mantis -e production logs htmltopdf  # reads <project>-htmltopdf-1 and <project>-htmltopdf-2
+```
+
+An exact container name always takes precedence: if a container literally named `app` exists,
+`logs app` reads that one instead of `<project>-app`. Names matching no container at all are
+passed to docker as they are.
+
+`logs` follows all matching containers at once, prefixing every line with a container name:
+
+```
+itfitness-htmltopdf-1 | POST /generate-pdf 200 3355.969 ms - 837045
+itfitness-htmltopdf-2 | POST /generate-pdf 200 889.662 ms - 747746
+```
+
+Commands which can only operate on one container (`bash`, `sh`, `exec`, `exec-it`, `healthcheck`)
+use the first match and warn about the rest.
+
 ### 5. Another useful commands
 
 Sometimes, instead of calling whole deployment process, you just need to call compose commands directly:
@@ -558,5 +568,4 @@ Works as follows:
 
 ## Release notes
 
-Mantis uses semantic versioning. See more in [changelog](https://github.com/PragmaticMates/mantis-cli/blob/master/CHANGES.md).
-
+Mantis uses semantic versioning. See more in [changelog](https://github.com/PragmaticMates/mantis-cli/blob/master/CHANGES.md).

mantis_cli-22.3.0/mantis/__init__.py

@@ -0,0 +1 @@
+VERSION = '22.3.0'

{mantis_cli-22.2.0 → mantis_cli-22.3.0}/mantis/commands/containers.py

@@ -8,7 +8,7 @@ from mantis.app import command, state
 
 @command(shortcut="l", panel="Containers")
 def logs(
-    container: Optional[str] = typer.Argument(None, help="Container name"),
+    container: Optional[str] = typer.Argument(None, help="Container or service name"),
 ):
     """Prints logs of containers"""
     state.logs(container)
@@ -22,7 +22,7 @@ def networks():
 
 @command(shortcut="hc", panel="Containers")
 def healthcheck(
-    container: Optional[str] = typer.Argument(None, help="Container name"),
+    container: Optional[str] = typer.Argument(None, help="Container or service name"),
 ):
     """Execute health-check of container"""
     state.healthcheck(container)
@@ -72,7 +72,7 @@ def rename(
 
 @command(panel="Containers")
 def bash(
-    container: str = typer.Argument(..., help="Container name"),
+    container: str = typer.Argument(..., help="Container or service name"),
 ):
     """Runs bash in container"""
     state.bash(container)
@@ -80,7 +80,7 @@ def bash(
 
 @command(panel="Containers")
 def sh(
-    container: str = typer.Argument(..., help="Container name"),
+    container: str = typer.Argument(..., help="Container or service name"),
 ):
     """Runs sh in container"""
     state.sh(container)
@@ -88,7 +88,7 @@ def sh(
 
 @command(name="exec", panel="Containers")
 def exec_cmd(
-    container: str = typer.Argument(..., help="Container name"),
+    container: str = typer.Argument(..., help="Container or service name"),
     cmd: List[str] = typer.Argument(..., help="Command to execute"),
 ):
     """Executes command in container"""
@@ -97,7 +97,7 @@ def exec_cmd(
 
 @command(name="exec-it", panel="Containers")
 def exec_it(
-    container: str = typer.Argument(..., help="Container name"),
+    container: str = typer.Argument(..., help="Container or service name"),
     cmd: List[str] = typer.Argument(..., help="Command to execute"),
 ):
     """Executes command in container (interactive)"""

{mantis_cli-22.2.0 → mantis_cli-22.3.0}/mantis/managers.py

@@ -2,7 +2,9 @@ import asyncio
 import atexit
 import json
 import os
+import re
 import shutil
+import signal
 import subprocess
 import sys
 import tempfile
@@ -519,10 +521,13 @@ class AbstractManager(object):
         except OSError as e:
             CLI.error(f"{error_message}: {e}")
 
-    def docker_command(self, command: str, return_output: bool = False, use_connection: bool = True) -> Optional[str]:
+    def build_docker_command(self, command: str, use_connection: bool = True) -> str:
         docker_connection = self.docker_connection if use_connection else ''
 
-        cmd = f'{docker_connection} {command}'
+        return f'{docker_connection} {command}'.strip()
+
+    def docker_command(self, command: str, return_output: bool = False, use_connection: bool = True) -> Optional[str]:
+        cmd = self.build_docker_command(command, use_connection)
 
         if return_output:
             if self.dry_run:
@@ -889,6 +894,97 @@ class BaseManager(AbstractManager):
         prefix = self.get_project_by_service(service)
         return f'{prefix}{suffix}'.replace('_', '-')
 
+    def resolve_containers(self, names: List[str], project_containers: Optional[List[str]] = None) -> List[str]:
+        """
+        Resolves given names to project container names.
+        Exact container name has the highest priority, service name is used as a fallback,
+        i.e. "app" resolves to "<project>-app" (or its scaled containers "<project>-app-1", ...)
+        unless a container literally named "app" exists.
+        """
+        if project_containers is None:
+            project_containers = self.get_containers()
+
+        services = self.services()
+        resolved = []
+
+        for name in names:
+            # exact container name has the highest priority
+            if name in project_containers:
+                containers = [name]
+            else:
+                # service name, or a common name of numbered containers
+                containers = (self.get_containers_by_service(name, project_containers) if name in services else []) \
+                    or self.get_containers_by_name(name, project_containers)
+
+                if containers:
+                    CLI.info(f'{name} resolved to: {", ".join(containers)}')
+                else:
+                    # unknown name: keep it as given and let docker report it
+                    containers = [name]
+
+            # keep the order and avoid duplicates
+            resolved.extend(container for container in containers if container not in resolved)
+
+        return resolved
+
+    def resolve_container(self, name: str, project_containers: Optional[List[str]] = None) -> str:
+        """
+        Resolves given name to a single project container name (see resolve_containers).
+        Used by commands which can operate on one container only.
+        """
+        containers = self.resolve_containers([name], project_containers)
+
+        if len(containers) > 1:
+            CLI.warning(f'{name} matches {len(containers)} containers, using {containers[0]}')
+
+        return containers[0]
+
+    def get_containers_by_service(self, service: str, project_containers: Optional[List[str]] = None) -> List[str]:
+        """
+        Returns names of existing containers belonging to given service,
+        including scaled ones with numerical suffixes
+        """
+        if project_containers is None:
+            project_containers = self.get_containers()
+
+        # service can define its container name explicitly
+        defined_container_name = self.compose_config.get('services', {}).get(service, {}).get('container_name', None)
+
+        if defined_container_name and defined_container_name in project_containers:
+            return [defined_container_name]
+
+        return self.match_containers(self.get_container_name(service), project_containers)
+
+    def get_containers_by_name(self, name: str, project_containers: Optional[List[str]] = None) -> List[str]:
+        """
+        Returns names of existing project containers matching given name prefixed with a project name.
+        Covers names which are not declared services, i.e. "htmltopdf" for services "htmltopdf-1"
+        and "htmltopdf-2" running as containers "<project>-htmltopdf-1" and "<project>-htmltopdf-2"
+        """
+        if project_containers is None:
+            project_containers = self.get_containers()
+
+        containers = []
+
+        for project in self.project_services().keys():
+            container_name = f'{project}{self.get_container_suffix(name)}'.replace('_', '-')
+
+            containers.extend(
+                container
+                for container in self.match_containers(container_name, project_containers)
+                if container not in containers
+            )
+
+        return containers
+
+    def match_containers(self, container_name: str, project_containers: List[str]) -> List[str]:
+        """
+        Returns containers named exactly as given container name or its numbered variants
+        """
+        pattern = re.compile(rf'^{re.escape(container_name)}(-\d+)?$')
+
+        return [container for container in project_containers if pattern.match(container)]
+
     def get_service_containers(self, service: str) -> List[str]:
         """
         Prints container names of given service
@@ -954,7 +1050,10 @@ class BaseManager(AbstractManager):
         """
         Execute health-check of given project container
         """
-        if container not in self.get_containers():
+        project_containers = self.get_containers()
+        container = self.resolve_container(container, project_containers)
+
+        if container not in project_containers:
             CLI.error(f"Container {container} not found")
 
         console = Console()
@@ -1746,28 +1845,112 @@ class BaseManager(AbstractManager):
         """
         CLI.info('Reading logs...')
 
-        containers = params.split(' ') if params else self.get_containers()
-        lines = '--tail 1000 -f' if params else '--tail 10'
-        steps = len(containers)
+        if not params:
+            containers = self.get_containers()
+            steps = len(containers)
 
-        for index, container in enumerate(containers):
-            CLI.step(index + 1, steps, f'{container} logs')
-            self.docker(f'logs {container} {lines}')
+            for index, container in enumerate(containers):
+                CLI.step(index + 1, steps, f'{container} logs')
+                self.docker(f'logs {container} --tail 10')
+
+            return
+
+        containers = self.resolve_containers(params.split())
+
+        # following a single container does not need any output multiplexing
+        if len(containers) == 1:
+            self.docker(f'logs {containers[0]} --tail 1000 -f')
+            return
+
+        self.follow_logs(containers)
+
+    def follow_logs(self, containers: List[str], tail: int = 1000) -> None:
+        """
+        Follows logs of multiple containers at once, prefixing every line with a container name.
+        Following them one by one is not an option as the first one would never finish.
+        """
+        commands = {
+            container: self.build_docker_command(f'docker logs {container} --tail {tail} -f')
+            for container in containers
+        }
+
+        if self.dry_run:
+            for command in commands.values():
+                CLI.warning(f'[DRY-RUN] {command}')
+            return
+
+        processes = {}
+
+        for container, command in commands.items():
+            print(command)
+            processes[container] = subprocess.Popen(
+                command,
+                shell=True,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.STDOUT,
+                text=True,
+                bufsize=1,
+                # own process group, so Ctrl+C is handled here and kills the whole shell + docker tree
+                start_new_session=True
+            )
+
+        width = max(map(len, processes.keys()))
+
+        def stream(container: str, process: subprocess.Popen) -> None:
+            for line in process.stdout:
+                print(f'{container:<{width}} | {line}', end='', flush=True)
+
+        threads = [
+            threading.Thread(target=stream, args=(container, process), daemon=True)
+            for container, process in processes.items()
+        ]
+
+        for thread in threads:
+            thread.start()
+
+        try:
+            # wait for the processes rather than for the reader threads, so that Ctrl+C
+            # interrupts a plain sleep in the main thread and cleanup always runs
+            while any(process.poll() is None for process in processes.values()):
+                sleep(0.2)
+        except KeyboardInterrupt:
+            pass
+        finally:
+            for process in processes.values():
+                self.terminate_process_group(process)
+
+            for thread in threads:
+                thread.join(timeout=1)
+
+    @staticmethod
+    def terminate_process_group(process: subprocess.Popen) -> None:
+        """
+        Terminates given process together with its children, i.e. the shell running a docker command
+        """
+        if process.poll() is not None:
+            return
+
+        try:
+            os.killpg(os.getpgid(process.pid), signal.SIGTERM)
+        except (ProcessLookupError, PermissionError):
+            process.terminate()
 
     def bash(self, params: str) -> None:
         """
         Runs bash in container
         """
+        container = self.resolve_container(params)
         CLI.info('Running bash...')
-        self.docker(f'exec -it --user root {params} /bin/bash')
+        self.docker(f'exec -it --user root {container} /bin/bash')
         # self.docker_compose(f'run --entrypoint /bin/bash {container}')
 
     def sh(self, params: str) -> None:
         """
         Runs sh in container
         """
+        container = self.resolve_container(params)
         CLI.info('Logging to container...')
-        self.docker(f'exec -it --user root {params} /bin/sh')
+        self.docker(f'exec -it --user root {container} /bin/sh')
 
     def ssh(self) -> None:
         if not self.connection:
@@ -1783,6 +1966,7 @@ class BaseManager(AbstractManager):
         """
         Executes command in container
         """
+        container = self.resolve_container(container)
         command = ' '.join(cmd)
         CLI.info(f'Executing command "{command}" in container {container}...')
         self.docker(f'exec {container} {command}')
@@ -1791,6 +1975,7 @@ class BaseManager(AbstractManager):
         """
         Executes command in container using interactive pseudo-TTY
         """
+        container = self.resolve_container(container)
         command = ' '.join(cmd)
         CLI.info(f'Executing command "{command}" in container {container}...')
         self.docker(f'exec -it {container} {command}')

mantis_cli-22.2.0/README.md → mantis_cli-22.3.0/mantis_cli.egg-info/PKG-INFO

@@ -1,3 +1,45 @@
+Metadata-Version: 2.4
+Name: mantis_cli
+Version: 22.3.0
+Summary: Management command to build and deploy webapps, especially based on Django
+Home-page: https://github.com/PragmaticMates/mantis-cli
+Author: Erik Telepovský
+Author-email: info@pragmaticmates.com
+Maintainer: Pragmatic Mates
+Maintainer-email: info@pragmaticmates.com
+License: GNU General Public License (GPL)
+Keywords: management deployment docker command
+Classifier: Programming Language :: Python
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: GNU General Public License (GPL)
+Classifier: Development Status :: 5 - Production/Stable
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cffi
+Requires-Dist: click
+Requires-Dist: cryptography
+Requires-Dist: pycryptodome
+Requires-Dist: pydantic
+Requires-Dist: PyYAML
+Requires-Dist: rich
+Requires-Dist: typer
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: requires-dist
+Dynamic: summary
+
 # mantis-cli
 
 Mantis is a CLI (command line interface) tool designed as a wrapper upon docker and docker compose commands for your project.
@@ -303,18 +345,18 @@ Run `mantis --help` to see all available commands with their descriptions.
 
 | Command / Shortcut                    | Description                                               |
 |---------------------------------------|-----------------------------------------------------------|
-| logs [CONTAINER] / l                  | Prints logs of containers                                 |
+| logs [CONTAINER\|SERVICE] / l          | Prints logs of containers                                 |
 | networks / n                          | Prints docker networks                                    |
-| healthcheck [CONTAINER] / hc          | Execute health-check of container                         |
+| healthcheck [CONTAINER\|SERVICE] / hc  | Execute health-check of container                         |
 | stop [CONTAINERS...]                  | Stops containers                                          |
 | start [CONTAINERS...]                 | Starts containers                                         |
 | kill [CONTAINERS...]                  | Kills containers                                          |
 | remove [CONTAINERS...] [--force]      | Removes containers                                        |
 | rename CONTAINER NEW_NAME             | Rename container                                          |
-| bash CONTAINER                        | Runs bash in container                                    |
-| sh CONTAINER                          | Runs sh in container                                      |
-| exec CONTAINER COMMAND...             | Executes command in container                             |
-| exec-it CONTAINER COMMAND...          | Executes command in container (interactive)               |
+| bash CONTAINER\|SERVICE               | Runs bash in container                                    |
+| sh CONTAINER\|SERVICE                 | Runs sh in container                                      |
+| exec CONTAINER\|SERVICE COMMAND...    | Executes command in container                             |
+| exec-it CONTAINER\|SERVICE COMMAND... | Executes command in container (interactive)               |
 | get-container-name SERVICE            | Gets container name for service                           |
 | remove-suffixes [PREFIX]              | Removes numerical suffixes from container names           |
 
@@ -498,6 +540,38 @@ If you need to follow logs of a specific container, you can do it by passing con
 mantis -e <ENVIRONMENT> logs <container-name>
 ```
 
+#### Container or service name
+
+Commands taking a container (`logs`, `healthcheck`, `bash`, `sh`, `exec`, `exec-it`) also accept a
+plain service name and mantis finds its container(s) for you, including scaled ones with numerical
+suffixes and services declaring their own `container_name`:
+
+```bash
+mantis -e production logs app   # reads logs of <project>-app container
+mantis -e production bash app   # same container, no need to type the project prefix
+```
+
+A name which is not a service is still matched against container names without their project
+prefix, which covers services numbered in the compose file:
+
+```bash
+mantis -e production logs htmltopdf  # reads <project>-htmltopdf-1 and <project>-htmltopdf-2
+```
+
+An exact container name always takes precedence: if a container literally named `app` exists,
+`logs app` reads that one instead of `<project>-app`. Names matching no container at all are
+passed to docker as they are.
+
+`logs` follows all matching containers at once, prefixing every line with a container name:
+
+```
+itfitness-htmltopdf-1 | POST /generate-pdf 200 3355.969 ms - 837045
+itfitness-htmltopdf-2 | POST /generate-pdf 200 889.662 ms - 747746
+```
+
+Commands which can only operate on one container (`bash`, `sh`, `exec`, `exec-it`, `healthcheck`)
+use the first match and warn about the rest.
+
 ### 5. Another useful commands
 
 Sometimes, instead of calling whole deployment process, you just need to call compose commands directly:
@@ -536,4 +610,4 @@ Works as follows:
 
 ## Release notes
 
-Mantis uses semantic versioning. See more in [changelog](https://github.com/PragmaticMates/mantis-cli/blob/master/CHANGES.md).
+Mantis uses semantic versioning. See more in [changelog](https://github.com/PragmaticMates/mantis-cli/blob/master/CHANGES.md).

{mantis_cli-22.2.0 → mantis_cli-22.3.0}/mantis_cli.egg-info/entry_points.txt

@@ -1,3 +1,2 @@
 [console_scripts]
 mantis = mantis.command_line:run
-

{mantis_cli-22.2.0 → mantis_cli-22.3.0}/tests/test_managers.py

@@ -4,6 +4,7 @@ from unittest.mock import patch, MagicMock
 from pathlib import Path
 
 from mantis.managers import (
+    BaseManager,
     validate_environment_for_commands,
     resolve_environment,
     SECRETS_COMMANDS,
@@ -403,3 +404,111 @@ class TestSecretsCommandsConstant:
         """Test that managers SECRETS_COMMANDS matches config module."""
         from mantis.config import SECRETS_COMMANDS as CONFIG_SECRETS_COMMANDS
         assert SECRETS_COMMANDS == CONFIG_SECRETS_COMMANDS
+
+
+class TestResolveContainers:
+    """Tests for resolving container names from container or service names."""
+
+    def _manager(self, containers, services, project='itfitness', compose_services=None):
+        manager = BaseManager.__new__(BaseManager)
+        manager.get_containers = lambda *args, **kwargs: list(containers)
+        manager.services = lambda *args, **kwargs: list(services)
+        manager.get_project_by_service = lambda service: project
+        manager.project_services = lambda: {project: list(services)}
+        manager.compose_config = {'services': compose_services or {}}
+        return manager
+
+    def test_exact_container_name_has_priority(self):
+        """A container named exactly like the argument wins over the service lookup."""
+        manager = self._manager(['itfitness-app', 'app'], ['app'])
+
+        assert manager.resolve_containers(['app']) == ['app']
+
+    def test_service_name_resolves_to_container(self):
+        """Service name is prefixed with the project name."""
+        manager = self._manager(['itfitness-app', 'itfitness-db'], ['app', 'db'])
+
+        assert manager.resolve_containers(['app']) == ['itfitness-app']
+
+    def test_service_name_resolves_to_scaled_containers(self):
+        """All containers of a scaled service are resolved."""
+        manager = self._manager(['itfitness-app-1', 'itfitness-app-2'], ['app'])
+
+        assert manager.resolve_containers(['app']) == ['itfitness-app-1', 'itfitness-app-2']
+
+    def test_service_name_does_not_match_similar_services(self):
+        """Service "app" must not pull in containers of service "app-worker"."""
+        manager = self._manager(['itfitness-app', 'itfitness-app-worker'], ['app', 'app-worker'])
+
+        assert manager.resolve_containers(['app']) == ['itfitness-app']
+
+    def test_explicit_container_name_of_service_is_used(self):
+        """Service defining its own container_name is resolved to that name."""
+        manager = self._manager(
+            ['legacy-app'],
+            ['app'],
+            compose_services={'app': {'container_name': 'legacy-app'}},
+        )
+
+        assert manager.resolve_containers(['app']) == ['legacy-app']
+
+    def test_common_name_of_numbered_services_resolves(self):
+        """"htmltopdf" matches containers of services "htmltopdf-1" and "htmltopdf-2"."""
+        manager = self._manager(
+            ['itfitness-htmltopdf-1', 'itfitness-htmltopdf-2', 'itfitness-app'],
+            ['htmltopdf-1', 'htmltopdf-2', 'app'],
+            compose_services={
+                'htmltopdf-1': {'container_name': 'itfitness-htmltopdf-1'},
+                'htmltopdf-2': {'container_name': 'itfitness-htmltopdf-2'},
+            },
+        )
+
+        assert manager.resolve_containers(['htmltopdf']) == ['itfitness-htmltopdf-1', 'itfitness-htmltopdf-2']
+
+    def test_numbered_service_still_resolves_to_its_own_container(self):
+        """The numbered service name keeps resolving to a single container."""
+        manager = self._manager(
+            ['itfitness-htmltopdf-1', 'itfitness-htmltopdf-2'],
+            ['htmltopdf-1', 'htmltopdf-2'],
+            compose_services={
+                'htmltopdf-1': {'container_name': 'itfitness-htmltopdf-1'},
+                'htmltopdf-2': {'container_name': 'itfitness-htmltopdf-2'},
+            },
+        )
+
+        assert manager.resolve_containers(['htmltopdf-2']) == ['itfitness-htmltopdf-2']
+
+    def test_unknown_name_is_kept_as_given(self):
+        """Names which are neither a container nor a service are passed to docker untouched."""
+        manager = self._manager(['itfitness-app'], ['app'])
+
+        assert manager.resolve_containers(['whatever']) == ['whatever']
+
+    def test_multiple_names_are_deduplicated(self):
+        """Service name and its container name resolve to a single container."""
+        manager = self._manager(['itfitness-app', 'itfitness-db'], ['app', 'db'])
+
+        assert manager.resolve_containers(['app', 'itfitness-app', 'db']) == ['itfitness-app', 'itfitness-db']
+
+    @patch('mantis.managers.CLI.warning')
+    def test_resolve_container_returns_single_name(self, mock_warning):
+        """Commands operating on one container get one container name."""
+        manager = self._manager(['itfitness-app', 'itfitness-db'], ['app', 'db'])
+
+        assert manager.resolve_container('app') == 'itfitness-app'
+        mock_warning.assert_not_called()
+
+    @patch('mantis.managers.CLI.warning')
+    def test_resolve_container_warns_on_multiple_matches(self, mock_warning):
+        """A scaled service picks the first container and warns about the rest."""
+        manager = self._manager(['itfitness-app-1', 'itfitness-app-2'], ['app'])
+
+        assert manager.resolve_container('app') == 'itfitness-app-1'
+        mock_warning.assert_called_once()
+
+    def test_resolve_container_accepts_prefetched_containers(self):
+        """Callers which already listed containers do not trigger another docker call."""
+        manager = self._manager([], ['app'])
+        manager.get_containers = lambda *args, **kwargs: pytest.fail('containers listed again')
+
+        assert manager.resolve_container('app', ['itfitness-app']) == 'itfitness-app'

mantis_cli-22.2.0/mantis/__init__.py

@@ -1 +0,0 @@
-VERSION = '22.2.0'