Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Enhance environment connection error handling #472

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 32 additions & 20 deletions podman/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
from podman.domain.secrets import SecretsManager
from podman.domain.system import SystemManager
from podman.domain.volumes import VolumesManager
from podman.errors.exceptions import PodmanConnectionError

logger = logging.getLogger("podman")

Expand Down Expand Up @@ -114,27 +115,38 @@ def from_env(
Client used to communicate with a Podman service.

Raises:
ValueError when required environment variable is not set
PodmanConnectionError: When connection to service fails or environment is invalid
"""
environment = environment or os.environ
credstore_env = credstore_env or {}

if version == "auto":
version = None

kwargs = {
'version': version,
'timeout': timeout,
'tls': False,
'credstore_env': credstore_env,
'max_pool_size': max_pool_size,
}

host = environment.get("CONTAINER_HOST") or environment.get("DOCKER_HOST") or None
if host is not None:
kwargs['base_url'] = host

return PodmanClient(**kwargs)
try:
environment = environment or os.environ
credstore_env = credstore_env or {}

if version == "auto":
version = None

kwargs = {
'version': version,
'timeout': timeout,
'tls': False,
'credstore_env': credstore_env,
'max_pool_size': max_pool_size,
}

host = environment.get("CONTAINER_HOST") or environment.get("DOCKER_HOST") or None
if host is not None:
kwargs['base_url'] = host

return PodmanClient(**kwargs)
except Exception as exc:
error_msg = "Failed to initialize Podman client from environment"
if isinstance(exc, ValueError):
error_msg = "Invalid environment configuration for Podman client"
elif isinstance(exc, (ConnectionError, TimeoutError)):
error_msg = "Failed to connect to Podman service"

raise PodmanConnectionError(
message=error_msg, environment=environment, host=host, original_error=exc
) from exc

Comment on lines +140 to 150
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For code clarity, I would prefer to use python's exception handling here.

except ValueError as e:
    error_msg = "Invalid environment configuration for Podman client"
    raise PodmanConnectionError(
        message=error_msg, environment=environment, host=host, original_error=e)
except (ConnectionError, TimeoutError) as e:
    error_msg = "Failed to connect to Podman service"
    raise PodmanConnectionError(
         message=error_msg, environment=environment, host=host, original_error=e)
except Exception as e:
    error_msg = "Failed to initialize Podman client from environment"
    raise PodmanConnectionError(
         message=error_msg, environment=environment, host=host, original_error=e)

I would avoid filtering exceptions with if conditions in the except block, unless you have a strong reason to do so.

@cached_property
def containers(self) -> ContainersManager:
Expand Down
57 changes: 56 additions & 1 deletion podman/errors/exceptions.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Podman API Errors."""

from typing import Iterable, List, Optional, Union, TYPE_CHECKING
from typing import Iterable, List, Optional, Union, Dict, TYPE_CHECKING

from requests import Response
from requests.exceptions import HTTPError
Expand Down Expand Up @@ -142,3 +142,58 @@ def __init__(

class InvalidArgument(PodmanError):
"""Parameter to method/function was not valid."""


class PodmanConnectionError(PodmanError):
"""Exception raised when connection to Podman service fails using environment configuration."""

def __init__(
self,
message: str,
environment: Optional[Dict[str, str]] = None,
host: Optional[str] = None,
original_error: Optional[Exception] = None,
):
"""Initialize PodmanConnectionError.

Args:
message: Description of the error
environment: Environment variables used in connection attempt
host: URL to Podman service that failed
original_error: Original exception that caused this error
"""
super().__init__(message)
self.environment = environment
self.host = host
self.original_error = original_error

def __str__(self) -> str:
"""Format error message with details about connection attempt."""
msg = [super().__str__()]

if self.host:
msg.append(f"Host: {self.host}")

if self.environment:
relevant_vars = {
k: v
for k, v in self.environment.items()
if k
in (
'DOCKER_HOST',
'CONTAINER_HOST',
'DOCKER_TLS_VERIFY',
'CONTAINER_TLS_VERIFY',
'DOCKER_CERT_PATH',
'CONTAINER_CERT_PATH',
)
}
if relevant_vars:
msg.append("Environment:")
for key, value in relevant_vars.items():
msg.append(f" {key}={value}")

if self.original_error:
msg.append(f"Caused by: {str(self.original_error)}")

return " | ".join(msg)
Loading