ci: tests

Signed-off-by: Sébastien Han <seb@redhat.com>

llama_stack/apis/datatypes.py

@@ -30,14 +30,14 @@ class DynamicApiMeta(EnumMeta):
         try:
             return super().__call__(value)
         except ValueError as e:
-            # If the value doesn't exist, create a new enum member
-            # Create a new member name from the value
-            member_name = value.lower().replace("-", "_")
-
             # If this value was already dynamically added, return it
             if value in cls._dynamic_values:
                 return cls._dynamic_values[value]
 
+            # If the value doesn't exist, create a new enum member
+            # Create a new member name from the value
+            member_name = value.lower().replace("-", "_")
+
             # If this member name already exists in the enum, return the existing member
             if member_name in cls._member_map_:
                 return cls._member_map_[member_name]
@@ -55,7 +55,7 @@ class DynamicApiMeta(EnumMeta):
     def add(cls, value):
         """
         Add a new API to the enum.
-        Particulary useful for external APIs.
+        Used to register external APIs.
         """
         member_name = value.lower().replace("-", "_")
 

llama_stack/cli/stack/_build.py

@@ -36,6 +36,7 @@ from llama_stack.distribution.datatypes import (
     StackRunConfig,
 )
 from llama_stack.distribution.distribution import get_provider_registry
+from llama_stack.distribution.external import load_external_apis
 from llama_stack.distribution.resolver import InvalidProviderError
 from llama_stack.distribution.stack import replace_env_vars
 from llama_stack.distribution.utils.config_dirs import DISTRIBS_BASE_DIR, EXTERNAL_PROVIDERS_DIR
@@ -404,6 +405,29 @@ def _run_stack_build_command_from_build_config(
         to_write = json.loads(build_config.model_dump_json())
         f.write(yaml.dump(to_write, sort_keys=False))
 
+    # We first install the external APIs so that the build process can use them and discover the
+    # providers dependencies
+    if build_config.external_apis_dir:
+        cprint("Installing external APIs", color="yellow", file=sys.stderr)
+        external_apis = load_external_apis(build_config)
+        if external_apis:
+            # install the external APIs
+            packages = []
+            for _, api_spec in external_apis.items():
+                if api_spec.pip_packages:
+                    packages.extend(api_spec.pip_packages)
+                    cprint(
+                        f"Installing {api_spec.name} with pip packages {api_spec.pip_packages}",
+                        color="yellow",
+                        file=sys.stderr,
+                    )
+            return_code = run_command(["uv", "pip", "install", *packages])
+            if return_code != 0:
+                packages_str = ", ".join(packages)
+                raise RuntimeError(
+                    f"Failed to install external APIs packages: {packages_str} (return code: {return_code})"
+                )
+
     return_code = build_image(
         build_config,
         build_file_path,

llama_stack/distribution/build.py

@@ -14,6 +14,7 @@ from termcolor import cprint
 
 from llama_stack.distribution.datatypes import BuildConfig
 from llama_stack.distribution.distribution import get_provider_registry
+from llama_stack.distribution.external import load_external_apis
 from llama_stack.distribution.utils.exec import run_command
 from llama_stack.distribution.utils.image_types import LlamaStackImageType
 from llama_stack.providers.datatypes import Api
@@ -105,6 +106,11 @@ def build_image(
 
     normal_deps, special_deps = get_provider_dependencies(build_config)
     normal_deps += SERVER_DEPENDENCIES
+    if build_config.external_apis_dir:
+        external_apis = load_external_apis(build_config)
+        if external_apis:
+            for _, api_spec in external_apis.items():
+                normal_deps.extend(api_spec.pip_packages)
 
     if build_config.image_type == LlamaStackImageType.CONTAINER.value:
         script = str(importlib.resources.files("llama_stack") / "distribution/build_container.sh")

llama_stack/distribution/datatypes.py

@@ -423,6 +423,10 @@ class BuildConfig(BaseModel):
         default_factory=list,
         description="Additional pip packages to install in the distribution. These packages will be installed in the distribution environment.",
     )
+    external_apis_dir: Path | None = Field(
+        default=None,
+        description="Path to directory containing external API implementations. The APIs code and dependencies must be installed on the system.",
+    )
 
     @field_validator("external_providers_dir")
     @classmethod

llama_stack/distribution/distribution.py

@@ -152,10 +152,15 @@ def get_provider_registry(
         try:
             module = importlib.import_module(api_spec.module)
             registry[api] = {a.provider_type: a for a in module.available_providers()}
-        except ImportError as e:
-            raise ImportError(
-                f"Failed to import external API module {name}. Is the external API package installed? {e}"
-            ) from e
+        except (ImportError, AttributeError) as e:
+            # Populate the registry with an empty dict to avoid breaking the provider registry
+            # This assume that the in-tree provider(s) are not available for this API which means
+            # that users will need to use external providers for this API.
+            registry[api] = {}
+            logger.error(
+                f"Failed to import external API {name}: {e}. Could not populate the in-tree provider(s) registry for {api.name}. \n"
+                "Install the API package to load any in-tree providers for this API."
+            )
 
     # Check if config has the external_providers_dir attribute
     if config and hasattr(config, "external_providers_dir") and config.external_providers_dir:

llama_stack/distribution/external.py

@@ -8,23 +8,21 @@
 import yaml
 
 from llama_stack.apis.datatypes import Api, ExternalApiSpec
+from llama_stack.distribution.datatypes import BuildConfig, StackRunConfig
 from llama_stack.log import get_logger
 
 logger = get_logger(name=__name__, category="core")
 
 
-def load_external_apis(config=None) -> dict[Api, ExternalApiSpec]:
+def load_external_apis(config: StackRunConfig | BuildConfig) -> dict[Api, ExternalApiSpec]:
     """Load external API specifications from the configured directory.
 
     Args:
-        config: StackRunConfig containing the external APIs directory path
+        config: StackRunConfig or BuildConfig containing the external APIs directory path
 
     Returns:
         A dictionary mapping API names to their specifications
     """
-    if not config:
-        return {}
-
     if not hasattr(config, "external_apis_dir"):
         return {}
 
@@ -51,9 +49,9 @@ def load_external_apis(config=None) -> dict[Api, ExternalApiSpec]:
             external_apis[api] = spec
         except yaml.YAMLError as yaml_err:
             logger.error(f"Failed to parse YAML file {yaml_path}: {yaml_err}")
-            raise yaml_err
-        except Exception as e:
-            logger.error(f"Failed to load external API spec from {yaml_path}: {e}")
-            raise e
+            raise
+        except Exception:
+            logger.exception(f"Failed to load external API spec from {yaml_path}")
+            raise
 
     return external_apis

llama_stack/distribution/resolver.py

@@ -100,8 +100,8 @@ def api_protocol_map(external_apis: dict[Api, ExternalApiSpec] | None = None) ->
                 api_class = getattr(module, api_spec.protocol)
 
                 protocols[api] = api_class
-            except (ImportError, AttributeError) as e:
-                logger.warning(f"Failed to load external API {api_spec.name}: {e}")
+            except (ImportError, AttributeError):
+                logger.exception(f"Failed to load external API {api_spec.name}")
 
     return protocols
 

llama_stack/distribution/server/routes.py

@@ -37,8 +37,6 @@ def get_all_api_routes(
 ) -> dict[Api, list[tuple[Route, WebMethod]]]:
     apis = {}
 
-    # Lazy import to avoid circular dependency
-
     protocols = api_protocol_map(external_apis)
     toolgroup_protocols = toolgroup_protocol_map()
     for api, protocol in protocols.items():