systemlink-cli 1.13.14__tar.gz → 1.13.16__tar.gz

{systemlink_cli-1.13.14 → systemlink_cli-1.13.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: systemlink-cli
-Version: 1.13.14
+Version: 1.13.16
 Summary: SystemLink Integrator CLI - cross-platform CLI for SystemLink workflows and templates.
 License-File: LICENSE
 Author: Fred Visser

{systemlink_cli-1.13.14 → systemlink_cli-1.13.16}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "systemlink-cli"
-version = "1.13.14"
+version = "1.13.16"
 description = "SystemLink Integrator CLI - cross-platform CLI for SystemLink workflows and templates."
 authors = ["Fred Visser <fred.visser@emerson.com>"]
 packages = [{ include = "slcli" }]

{systemlink_cli-1.13.14 → systemlink_cli-1.13.16}/slcli/_version.py

@@ -1,4 +1,4 @@
 """Version information for slcli."""
 
 # This file is auto-generated. Do not edit manually.
-__version__ = "1.13.14"
+__version__ = "1.13.16"

{systemlink_cli-1.13.14 → systemlink_cli-1.13.16}/slcli/config_click.py

@@ -18,7 +18,14 @@ from .platform import (
 from .profiles import ProfileConfig, Profile, check_config_file_permissions
 from .rich_output import render_table
 from .table_utils import output_formatted_list
-from .utils import ExitCodes
+from .utils import (
+    ExitCodes,
+    describe_config_source,
+    get_api_key_resolution,
+    get_base_url_resolution,
+    get_web_url_resolution,
+    source_is_env,
+)
 
 API_KEY_LENGTH = 42
 API_KEY_PATTERN = re.compile(rf"^[A-Za-z0-9_-]{{{API_KEY_LENGTH}}}$")
@@ -372,6 +379,38 @@ def register_config_commands(cli: Any) -> None:
         """View the full configuration."""
         cfg = ProfileConfig.load()
 
+        effective: dict[str, Any] = {}
+        env_overrides: list[str] = []
+
+        try:
+            api_url_resolution = get_base_url_resolution()
+            effective["api-url"] = api_url_resolution.value
+            effective["api-url-source"] = api_url_resolution.source
+            if source_is_env(api_url_resolution.source):
+                env_overrides.append("API URL")
+        except Exception:
+            pass
+
+        try:
+            api_key_resolution = get_api_key_resolution(emit_error=False)
+            effective["api-key-source"] = api_key_resolution.source
+            if source_is_env(api_key_resolution.source):
+                env_overrides.append("API Key")
+        except Exception:
+            pass
+
+        try:
+            web_url_resolution = get_web_url_resolution()
+            effective["web-url"] = web_url_resolution.value
+            effective["web-url-source"] = web_url_resolution.source
+            if source_is_env(web_url_resolution.source):
+                env_overrides.append("Web URL")
+        except Exception:
+            pass
+
+        if env_overrides:
+            effective["env-overrides"] = env_overrides
+
         if format == "json":
             data: dict = {}
             if cfg.current_profile:
@@ -388,6 +427,8 @@ def register_config_commands(cli: Any) -> None:
                     data["profiles"][name] = profile_dict
             if cfg.settings:
                 data.update(cfg.settings)
+            if effective:
+                data["effective"] = effective
             click.echo(json.dumps(data, indent=2))
             return
 
@@ -412,7 +453,7 @@ def register_config_commands(cli: Any) -> None:
                 api_key_display = (
                     "****" + profile.api_key[-4:] if len(profile.api_key) >= 4 else "****"
                 )
-            rows.append(["API Key", api_key_display])
+            rows.append(["Profile API Key", api_key_display])
 
             if profile.workspace:
                 rows.append(["Workspace", profile.workspace])
@@ -420,6 +461,24 @@ def register_config_commands(cli: Any) -> None:
             if profile.readonly:
                 rows.append(["Readonly", "enabled"])
 
+        if effective:
+            api_url_source = effective.get("api-url-source")
+            if isinstance(api_url_source, str):
+                rows.append(["Effective API URL", str(effective.get("api-url", ""))])
+                rows.append(["API URL Source", describe_config_source(api_url_source)])
+
+            api_key_source = effective.get("api-key-source")
+            if isinstance(api_key_source, str):
+                rows.append(["API Key Source", describe_config_source(api_key_source)])
+
+            web_url_source = effective.get("web-url-source")
+            if isinstance(web_url_source, str):
+                rows.append(["Effective Web URL", str(effective.get("web-url", ""))])
+                rows.append(["Web URL Source", describe_config_source(web_url_source)])
+
+            if env_overrides:
+                rows.append(["Active Overrides", ", ".join(env_overrides)])
+
         click.echo("slcli Configuration:")
         render_table(
             headers=["SETTING", "VALUE"],

{systemlink_cli-1.13.14 → systemlink_cli-1.13.16}/slcli/main.py

@@ -41,6 +41,7 @@ from .tag_click import register_tag_commands
 from .templates_click import register_templates_commands
 from .testmonitor_click import register_testmonitor_commands
 from .user_click import register_user_commands
+from .utils import describe_config_source
 from .webapp_click import register_webapp_commands
 from .workitem_click import register_workitem_commands
 from .workspace_click import register_workspace_commands
@@ -596,14 +597,31 @@ def info(format: str, skip_health: bool, debug: bool) -> None:
     api_url = truncate(platform_info.get("api_url", "Not configured"))
     web_url = truncate(platform_info.get("web_url", "Not configured"))
 
+    api_url_source = truncate(
+        describe_config_source(platform_info.get("api_url_source", "Unknown"))
+    )
+    api_key_source = truncate(
+        describe_config_source(platform_info.get("api_key_source", "Unknown"))
+    )
+    web_url_source = truncate(
+        describe_config_source(platform_info.get("web_url_source", "Unknown"))
+    )
+
     info_rows = [
         ["Status", status],
         ["Profile", profile_display],
         ["Platform", platform_display],
         ["API URL", api_url],
+        ["API URL Source", api_url_source],
+        ["API Key Source", api_key_source],
         ["Web URL", web_url],
+        ["Web URL Source", web_url_source],
     ]
 
+    env_overrides = platform_info.get("env_overrides")
+    if isinstance(env_overrides, list) and env_overrides:
+        info_rows.append(["Overrides", truncate(", ".join(str(item) for item in env_overrides))])
+
     workspace = platform_info.get("active_profile_workspace")
     if workspace:
         workspace_display = truncate(workspace)

{systemlink_cli-1.13.14 → systemlink_cli-1.13.16}/slcli/platform.py

@@ -249,22 +249,19 @@ def _get_cached_service_status(service_name: str, api_url: str, api_key: str) ->
 
 def _get_current_api_context() -> Optional[Tuple[Optional[str], str, str]]:
     """Resolve the current profile name, API URL, and key for service probing."""
-    api_url = os.environ.get("SYSTEMLINK_API_URL")
-    api_key = os.environ.get("SYSTEMLINK_API_KEY")
-    if api_url and api_key:
-        return None, api_url, api_key
+    try:
+        from .utils import get_api_key_resolution, get_base_url_resolution
 
-    cfg = _get_keyring_config()
-    config_api_url = cfg.get("api_url") if cfg else None
-    config_api_key = cfg.get("api_key") if cfg else None
-    if config_api_url and config_api_key:
-        return None, str(config_api_url), str(config_api_key)
+        api_url_resolution = get_base_url_resolution()
+        api_key_resolution = get_api_key_resolution(emit_error=False)
 
-    try:
-        from .profiles import get_active_profile_name
-        from .utils import get_api_key, get_base_url
+        profile_name: Optional[str] = None
+        if api_url_resolution.source.startswith("profile:") and (
+            api_url_resolution.source == api_key_resolution.source
+        ):
+            profile_name = api_url_resolution.source.split(":", 1)[1]
 
-        return get_active_profile_name(), get_base_url(), get_api_key()
+        return profile_name, api_url_resolution.value, api_key_resolution.value
     except Exception:
         return None
 
@@ -376,7 +373,7 @@ def _get_runtime_platform() -> str:
     if platform != PLATFORM_UNKNOWN:
         return platform
 
-    status_snapshot = _get_service_status_snapshot(force_refresh=False)
+    status_snapshot = _get_service_status_snapshot(force_refresh=True)
     if status_snapshot is None:
         return platform
 
@@ -779,23 +776,36 @@ def get_platform_info(skip_health: bool = False) -> Dict[str, Any]:
     Returns:
         Dictionary with platform info including URL, platform type, and services.
     """
-    from .utils import get_api_key, get_base_url, get_web_url
+    from .utils import (
+        get_api_key_resolution,
+        get_base_url_resolution,
+        get_web_url_resolution,
+        source_is_env,
+    )
 
-    # Use profile-aware functions instead of keyring directly
     try:
-        api_url = get_base_url()
+        api_url_resolution = get_base_url_resolution()
+        api_url = api_url_resolution.value
+        api_url_source = api_url_resolution.source
     except Exception:
         api_url = "Not configured"
+        api_url_source = "unresolved"
 
     try:
-        web_url = get_web_url()
+        web_url_resolution = get_web_url_resolution()
+        web_url = web_url_resolution.value
+        web_url_source = web_url_resolution.source
     except Exception:
         web_url = "Not configured"
+        web_url_source = "unresolved"
 
     try:
-        api_key = get_api_key()
+        api_key_resolution = get_api_key_resolution(emit_error=False)
+        api_key = api_key_resolution.value
+        api_key_source = api_key_resolution.source
         logged_in = bool(api_key)
     except Exception:
+        api_key_source = "unresolved"
         logged_in = False
 
     # Get platform from profile or keyring config
@@ -833,7 +843,10 @@ def get_platform_info(skip_health: bool = False) -> Dict[str, Any]:
 
     info: Dict[str, Any] = {
         "api_url": api_url,
+        "api_url_source": api_url_source,
         "web_url": web_url,
+        "web_url_source": web_url_source,
+        "api_key_source": api_key_source,
         "platform": platform,
         "platform_display": _get_platform_display_name(platform),
         "logged_in": logged_in,
@@ -841,6 +854,16 @@ def get_platform_info(skip_health: bool = False) -> Dict[str, Any]:
         "auth_valid": auth_valid,
     }
 
+    env_overrides = []
+    if source_is_env(api_url_source):
+        env_overrides.append("API URL")
+    if source_is_env(api_key_source):
+        env_overrides.append("API Key")
+    if source_is_env(web_url_source):
+        env_overrides.append("Web URL")
+    if env_overrides:
+        info["env_overrides"] = env_overrides
+
     if file_query_endpoint is not None:
         info["file_query_endpoint"] = file_query_endpoint
     if elasticsearch_available is not None:

{systemlink_cli-1.13.14 → systemlink_cli-1.13.16}/slcli/utils.py

@@ -4,7 +4,8 @@ import datetime
 import json
 import os
 import sys
-from typing import Dict, List, Any, Optional, Callable
+from dataclasses import dataclass
+from typing import Dict, List, Any, Optional, Callable, Sequence
 
 import click
 import keyring
@@ -29,6 +30,14 @@ class SystemLinkConfig:
         self.ssl_verify = ssl_verify
 
 
+@dataclass(frozen=True)
+class ResolvedConfigValue:
+    """Resolved configuration value plus the source that supplied it."""
+
+    value: str
+    source: str
+
+
 class ExitCodes:
     """Standard exit codes for CLI operations."""
 
@@ -309,100 +318,195 @@ def get_http_configuration() -> SystemLinkConfig:
     )
 
 
-def get_base_url() -> str:
-    """Retrieve the SystemLink API base URL.
+def _get_env_override(env_names: Sequence[str]) -> Optional[ResolvedConfigValue]:
+    """Return the first non-empty environment override from the provided names."""
+    for env_name in env_names:
+        value = os.environ.get(env_name)
+        if value:
+            return ResolvedConfigValue(value=value, source=f"env:{env_name}")
+    return None
+
+
+def source_is_env(source: str) -> bool:
+    """Return True when the resolved source came from an environment variable."""
+    return source.startswith("env:")
+
+
+def describe_config_source(source: str) -> str:
+    """Return a user-facing description of a resolved configuration source."""
+    if source.startswith("env:"):
+        return f"Environment ({source.split(':', 1)[1]})"
+    if source.startswith("profile:"):
+        return f"Profile '{source.split(':', 1)[1]}'"
+    if source.startswith("keyring:"):
+        return f"Legacy keyring ({source.split(':', 1)[1]})"
+    if source.startswith("default:"):
+        return f"Default ({source.split(':', 1)[1]})"
+    if source.startswith("derived:"):
+        derived_from = source.split(":", 1)[1]
+        return f"Derived from API URL via {describe_config_source(derived_from)}"
+    return source
+
+
+def get_base_url_resolution() -> ResolvedConfigValue:
+    """Resolve the SystemLink API base URL and record where it came from.
 
     Preference order:
-    1. Environment variable SYSTEMLINK_API_URL (for runtime overrides/testing)
+    1. Environment variable SLCLI_API_URL (preferred) or SYSTEMLINK_API_URL
     2. Active profile from config file
     3. Combined keyring config (legacy)
     4. Legacy keyring entry SYSTEMLINK_API_URL
     5. Default fallback to localhost
     """
-    # First, check environment variable (highest priority for runtime overrides)
-    url = os.environ.get("SYSTEMLINK_API_URL")
-    if url:
-        return url
+    override = _get_env_override(("SLCLI_API_URL", "SYSTEMLINK_API_URL"))
+    if override is not None:
+        return ResolvedConfigValue(override.value.rstrip("/"), override.source)
 
-    # Second, try the active profile
     try:
         from .profiles import get_active_profile
 
         profile = get_active_profile()
         if profile and profile.server:
-            return profile.server
+            return ResolvedConfigValue(profile.server.rstrip("/"), f"profile:{profile.name}")
     except (FileNotFoundError, json.JSONDecodeError, KeyError, AttributeError):
-        # Profile file missing, corrupted, or malformed - fall back to keyring
         pass
 
-    # Third, try the combined keyring config (legacy)
     cfg = _get_keyring_config()
     if cfg and isinstance(cfg, dict):
         config_url = cfg.get("api_url")
         if config_url:
-            return config_url
+            return ResolvedConfigValue(str(config_url).rstrip("/"), "keyring:SYSTEMLINK_CONFIG")
 
-    # Fourth, try legacy keyring entry
-    url = keyring.get_password("systemlink-cli", "SYSTEMLINK_API_URL")
+    try:
+        url = keyring.get_password("systemlink-cli", "SYSTEMLINK_API_URL")
+    except Exception:
+        url = None
     if url:
-        return url
+        return ResolvedConfigValue(url.rstrip("/"), "keyring:SYSTEMLINK_API_URL")
 
-    return "http://localhost:8000"
+    return ResolvedConfigValue("http://localhost:8000", "default:localhost")
 
 
-def get_web_url() -> str:
-    """Return the SystemLink primary web UI URL.
+def get_web_url_resolution() -> ResolvedConfigValue:
+    """Resolve the SystemLink web UI URL and record where it came from.
 
     Preference order:
-    1. Environment variable SYSTEMLINK_WEB_URL
+    1. Environment variable SLCLI_WEB_URL (preferred) or SYSTEMLINK_WEB_URL
     2. Active profile from config file
     3. Combined keyring config (legacy)
     4. Legacy keyring entry SYSTEMLINK_WEB_URL
-    5. Derived from get_base_url()
+    5. Derived from the effective API base URL
     """
-    # 1) Explicit override via environment variable
-    url = os.environ.get("SYSTEMLINK_WEB_URL")
-    if url:
-        return url.rstrip("/")
+    override = _get_env_override(("SLCLI_WEB_URL", "SYSTEMLINK_WEB_URL"))
+    if override is not None:
+        return ResolvedConfigValue(override.value.rstrip("/"), override.source)
 
-    # 2) Try the active profile
     try:
         from .profiles import get_active_profile
 
         profile = get_active_profile()
         if profile and profile.web_url:
-            return profile.web_url.rstrip("/")
+            return ResolvedConfigValue(profile.web_url.rstrip("/"), f"profile:{profile.name}")
     except (FileNotFoundError, json.JSONDecodeError, KeyError, AttributeError):
-        # Profile unavailable or misconfigured, fall back to other sources
         pass
 
-    # 3) Combined keyring config entry (legacy)
     cfg = _get_keyring_config()
     if cfg and isinstance(cfg, dict):
         maybe = cfg.get("web_url") or cfg.get("webUrl") or cfg.get("web_ui_url")
         if maybe:
-            return str(maybe).rstrip("/")
+            return ResolvedConfigValue(str(maybe).rstrip("/"), "keyring:SYSTEMLINK_CONFIG")
 
-    # 4) Legacy keyring entry fallback
     try:
         url = keyring.get_password("systemlink-cli", "SYSTEMLINK_WEB_URL")
     except Exception:
         url = None
     if url:
-        return url.rstrip("/")
+        return ResolvedConfigValue(url.rstrip("/"), "keyring:SYSTEMLINK_WEB_URL")
 
-    # Derive from API base URL
-    base = get_base_url()
+    base_resolution = get_base_url_resolution()
+    base = base_resolution.value
     try:
         from urllib.parse import urlparse
 
         parsed = urlparse(base if base.startswith("http") else "https://" + base)
         host = parsed.netloc or parsed.path
         if not host:
-            return "https://localhost"
-        return f"https://{host.rstrip('/')}"
+            return ResolvedConfigValue("https://localhost", f"derived:{base_resolution.source}")
+        return ResolvedConfigValue(
+            f"https://{host.rstrip('/')}",
+            f"derived:{base_resolution.source}",
+        )
     except Exception:
-        return "https://localhost"
+        return ResolvedConfigValue("https://localhost", f"derived:{base_resolution.source}")
+
+
+def get_api_key_resolution(emit_error: bool = True) -> ResolvedConfigValue:
+    """Resolve the SystemLink API key and record where it came from.
+
+    Preference order:
+    1. Environment variable SLCLI_API_KEY (preferred) or SYSTEMLINK_API_KEY
+    2. Active profile from config file
+    3. Combined keyring config (legacy)
+    4. Legacy keyring entry SYSTEMLINK_API_KEY
+    """
+    override = _get_env_override(("SLCLI_API_KEY", "SYSTEMLINK_API_KEY"))
+    if override is not None:
+        return override
+
+    try:
+        from .profiles import get_active_profile
+
+        profile = get_active_profile()
+        if profile and profile.api_key:
+            return ResolvedConfigValue(profile.api_key, f"profile:{profile.name}")
+    except (FileNotFoundError, json.JSONDecodeError, KeyError, AttributeError):
+        pass
+
+    cfg = _get_keyring_config()
+    if cfg and isinstance(cfg, dict):
+        maybe = cfg.get("api_key") or cfg.get("apiKey") or cfg.get("apiToken")
+        if maybe:
+            return ResolvedConfigValue(str(maybe), "keyring:SYSTEMLINK_CONFIG")
+
+    try:
+        api_key = keyring.get_password("systemlink-cli", "SYSTEMLINK_API_KEY")
+    except Exception:
+        api_key = None
+    if api_key:
+        return ResolvedConfigValue(api_key, "keyring:SYSTEMLINK_API_KEY")
+
+    if emit_error:
+        raise click.ClickException(
+            "API key not found. Please set the SLCLI_API_KEY environment variable "
+            "(or legacy SYSTEMLINK_API_KEY) or run 'slcli login --profile <name>'."
+        )
+    raise click.ClickException("API key not found.")
+
+
+def get_base_url() -> str:
+    """Retrieve the SystemLink API base URL.
+
+    Preference order:
+    1. Environment variable SLCLI_API_URL (preferred) or SYSTEMLINK_API_URL
+    2. Active profile from config file
+    3. Combined keyring config (legacy)
+    4. Legacy keyring entry SYSTEMLINK_API_URL
+    5. Default fallback to localhost
+    """
+    return get_base_url_resolution().value
+
+
+def get_web_url() -> str:
+    """Return the SystemLink primary web UI URL.
+
+    Preference order:
+    1. Environment variable SLCLI_WEB_URL (preferred) or SYSTEMLINK_WEB_URL
+    2. Active profile from config file
+    3. Combined keyring config (legacy)
+    4. Legacy keyring entry SYSTEMLINK_WEB_URL
+    5. Derived from get_base_url()
+    """
+    return get_web_url_resolution().value
 
 
 def _get_keyring_config() -> Dict[str, Any]:
@@ -430,46 +534,12 @@ def get_api_key() -> str:
     """Retrieve the SystemLink API key.
 
     Preference order:
-    1. Environment variable SYSTEMLINK_API_KEY (for runtime overrides/testing)
+    1. Environment variable SLCLI_API_KEY (preferred) or SYSTEMLINK_API_KEY
     2. Active profile from config file
     3. Combined keyring config (legacy)
     4. Legacy keyring entry SYSTEMLINK_API_KEY
     """
-    import click
-
-    # First, check environment variable (highest priority for runtime overrides)
-    api_key = os.environ.get("SYSTEMLINK_API_KEY")
-    if api_key:
-        return api_key
-
-    # Second, try the active profile
-    try:
-        from .profiles import get_active_profile
-
-        profile = get_active_profile()
-        if profile and profile.api_key:
-            return profile.api_key
-    except (FileNotFoundError, json.JSONDecodeError, KeyError, AttributeError):
-        # Profile lookup error, fall back to keyring-based configuration
-        pass
-
-    # Third, consult combined keyring config if present (legacy)
-    cfg = _get_keyring_config()
-    if cfg and isinstance(cfg, dict):
-        maybe = cfg.get("api_key") or cfg.get("apiKey") or cfg.get("apiToken")
-        if maybe:
-            return str(maybe)
-
-    # Fourth, try legacy keyring entry
-    api_key = keyring.get_password("systemlink-cli", "SYSTEMLINK_API_KEY")
-    if api_key:
-        return api_key
-
-    click.echo(
-        "Error: API key not found. Please set the SYSTEMLINK_API_KEY "
-        "environment variable or run 'slcli login --profile <name>'."
-    )
-    raise click.ClickException("API key not found.")
+    return get_api_key_resolution().value
 
 
 def get_headers(content_type: str = "") -> Dict[str, str]: