refactor wiremock extension to use utils base class as well

Author: whummer

.github/workflows/wiremock.yml

@@ -39,6 +39,7 @@ jobs:
           pip install localstack terraform-local awscli-local[ver1]
 
           make install
+          make lint
           make dist
           localstack extensions -v install file://$(ls ./dist/localstack_wiremock-*.tar.gz)
 

utils/localstack_extensions/utils/docker.py

@@ -12,7 +12,10 @@
 from localstack.utils.docker_utils import DOCKER_CLIENT
 from localstack.extensions.api import Extension, http
 from localstack.http import Request
-from localstack.utils.container_utils.container_client import PortMappings
+from localstack.utils.container_utils.container_client import (
+    PortMappings,
+    SimpleVolumeBind,
+)
 from localstack.utils.net import get_addressable_container_host
 from localstack.utils.sync import retry
 from rolo import route
@@ -52,11 +55,17 @@ class ProxiedDockerContainerExtension(Extension):
     """Optional command (and flags) to execute in the container."""
     env_vars: dict[str, str] | None
     """Optional environment variables to pass to the container."""
+    volumes: list[SimpleVolumeBind] | None
+    """Optional volumes to mount into the container."""
     health_check_fn: Callable[[], None] | None
     """
     Optional custom health check function. If not provided, defaults to HTTP GET on main_port.
     The function should raise an exception if the health check fails.
     """
+    health_check_retries: int
+    """Number of times to retry the health check before giving up."""
+    health_check_sleep: float
+    """Time in seconds to sleep between health check retries."""
 
     request_to_port_router: Callable[[Request], int] | None
     """Callable that returns the target port for a given request, for routing purposes"""
@@ -87,7 +96,10 @@ def __init__(
         path: str | None = None,
         command: list[str] | None = None,
         env_vars: dict[str, str] | None = None,
+        volumes: list[SimpleVolumeBind] | None = None,
         health_check_fn: Callable[[], None] | None = None,
+        health_check_retries: int = 60,
+        health_check_sleep: float = 1.0,
         request_to_port_router: Callable[[Request], int] | None = None,
         http2_ports: list[int] | None = None,
         tcp_ports: list[int] | None = None,
@@ -101,7 +113,10 @@ def __init__(
         self.container_name = re.sub(r"\W", "-", f"ls-ext-{self.name}")
         self.command = command
         self.env_vars = env_vars
+        self.volumes = volumes
         self.health_check_fn = health_check_fn
+        self.health_check_retries = health_check_retries
+        self.health_check_sleep = health_check_sleep
         self.request_to_port_router = request_to_port_router
         self.http2_ports = http2_ports
         self.tcp_ports = tcp_ports
@@ -193,6 +208,8 @@ def start_container(self) -> None:
             kwargs["command"] = self.command
         if self.env_vars:
             kwargs["env_vars"] = self.env_vars
+        if self.volumes:
+            kwargs["volumes"] = self.volumes
 
         try:
             DOCKER_CLIENT.run_container(
@@ -213,7 +230,11 @@ def start_container(self) -> None:
         health_check = self.health_check_fn or self._default_health_check
 
         try:
-            retry(health_check, retries=60, sleep=1)
+            retry(
+                health_check,
+                retries=self.health_check_retries,
+                sleep=self.health_check_sleep,
+            )
         except Exception as e:
             LOG.info("Failed to connect to container %s: %s", self.container_name, e)
             self._remove_container()

wiremock/Makefile

@@ -34,6 +34,10 @@ entrypoints: venv   # Generate plugin entrypoints for Python package
 
 format:		    ## Run ruff to format the whole codebase
 	$(VENV_RUN); python -m ruff format .; python -m ruff check --output-format=full --fix .
+
+lint:		    ## Run ruff to lint the codebase
+	$(VENV_RUN); python -m ruff check --output-format=full .
+
 sample-oss:		    ## Deploy sample app (OSS mode)
 	echo "Creating stubs in WireMock ..."
 	bin/create-stubs.sh

wiremock/localstack_wiremock/extension.py

@@ -1,9 +1,11 @@
 import logging
 import os
 from pathlib import Path
+import requests
 
 from localstack import config, constants
-from localstack_wiremock.utils.docker import ProxiedDockerContainerExtension
+from localstack.utils.net import get_addressable_container_host
+from localstack_extensions.utils.docker import ProxiedDockerContainerExtension
 
 
 LOG = logging.getLogger(__name__)
@@ -71,15 +73,23 @@ def __init__(self):
         health_check_port = ADMIN_PORT if api_token else SERVICE_PORT
         self._is_runner_mode = bool(api_token)
 
+        def _health_check():
+            """Custom health check for WireMock."""
+            container_host = get_addressable_container_host()
+            health_url = (
+                f"http://{container_host}:{health_check_port}{health_check_path}"
+            )
+            LOG.debug("Health check: %s", health_url)
+            response = requests.get(health_url, timeout=5)
+            assert response.ok
+
         super().__init__(
             image_name=image_name,
             container_ports=container_ports,
-            container_name=self.CONTAINER_NAME,
             host=self.HOST,
             env_vars=env_vars if env_vars else None,
             volumes=volumes,
-            health_check_path=health_check_path,
-            health_check_port=health_check_port,
+            health_check_fn=_health_check,
             health_check_retries=health_check_retries,
             health_check_sleep=health_check_sleep,
         )

wiremock/localstack_wiremock/utils/__init__.py

@@ -14,7 +14,10 @@ authors = [
 keywords = ["LocalStack", "WireMock"]
 classifiers = []
 dependencies = [
-    "priority"
+    "priority",
+    # TODO remove / replace prior to merge!
+#    "localstack-extensions-utils",
+    "localstack-extensions-utils @ git+https://github.com/localstack/localstack-extensions.git@extract-utils-package#subdirectory=utils"
 ]
 
 [project.urls]