systemlink-cli 1.13.1__tar.gz → 1.13.3__tar.gz

{systemlink_cli-1.13.1 → systemlink_cli-1.13.3}/PKG-INFO

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

{systemlink_cli-1.13.1 → systemlink_cli-1.13.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "systemlink-cli"
-version = "1.13.1"
+version = "1.13.3"
 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.1 → systemlink_cli-1.13.3}/slcli/_version.py

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

{systemlink_cli-1.13.1 → systemlink_cli-1.13.3}/slcli/config_click.py

@@ -2,8 +2,10 @@
 
 import getpass
 import json
+import re
 import sys
 from typing import Any, Optional
+from urllib.parse import urlparse
 
 import click
 import questionary
@@ -18,6 +20,70 @@ from .rich_output import render_table
 from .table_utils import output_formatted_list
 from .utils import ExitCodes
 
+API_KEY_LENGTH = 42
+API_KEY_PATTERN = re.compile(rf"^[A-Za-z0-9_-]{{{API_KEY_LENGTH}}}$")
+
+
+def _exit_with_validation_error(message: str, exit_code: int = ExitCodes.INVALID_INPUT) -> None:
+    """Exit the command with a consistent validation message."""
+    click.echo(f"✗ {message}", err=True)
+    sys.exit(exit_code)
+
+
+def _normalize_profile_name(profile: str) -> str:
+    """Normalize and validate a profile name."""
+    normalized = profile.strip()
+    if not normalized:
+        _exit_with_validation_error("Profile name cannot be empty.")
+    return normalized
+
+
+def _normalize_base_url(raw_url: str, label: str) -> str:
+    """Normalize and validate a SystemLink base URL."""
+    normalized = raw_url.strip()
+    if not normalized:
+        _exit_with_validation_error(f"{label} cannot be empty.")
+
+    if "://" not in normalized:
+        click.echo(f"⚠️  Warning: Adding HTTPS protocol to {label.lower()}.")
+        normalized = f"https://{normalized}"
+
+    parsed = urlparse(normalized)
+    if parsed.scheme not in ("http", "https"):
+        _exit_with_validation_error(f"{label} must use HTTP or HTTPS.")
+    if not parsed.hostname:
+        _exit_with_validation_error(f"{label} must include a valid host name.")
+    if parsed.path and parsed.path.strip("/"):
+        _exit_with_validation_error(
+            f"{label} must be a base URL without a path, query string, or fragment."
+        )
+    if parsed.params or parsed.query or parsed.fragment:
+        _exit_with_validation_error(
+            f"{label} must be a base URL without a path, query string, or fragment."
+        )
+
+    return normalized.rstrip("/")
+
+
+def _normalize_api_key(api_key: str) -> str:
+    """Normalize and validate an API key before probing the server."""
+    normalized = api_key.strip()
+    if not normalized:
+        _exit_with_validation_error("API key cannot be empty.")
+    if any(character.isspace() for character in normalized):
+        _exit_with_validation_error("API key must not contain spaces or line breaks.")
+    if not API_KEY_PATTERN.fullmatch(normalized):
+        _exit_with_validation_error(
+            f"API key must be a {API_KEY_LENGTH}-character URL-safe token containing only "
+            "letters, digits, '-' and '_'."
+        )
+    return normalized
+
+
+def _all_service_probes_unauthorized(services: dict[str, str]) -> bool:
+    """Return True only when every recorded service probe failed with authorization."""
+    return bool(services) and all(status == "unauthorized" for status in services.values())
+
 
 def _add_profile_impl(
     profile: Optional[str],
@@ -46,93 +112,78 @@ def _add_profile_impl(
     if not profile:
         profile = click.prompt("Profile name", default="default")
     assert isinstance(profile, str)
+    profile = _normalize_profile_name(profile)
 
     # Get URL - either from flag or prompt
     if not url:
         click.echo("Example: https://api.my-systemlink.com")
         url = click.prompt("Enter your SystemLink API URL")
-    # Ensure url is a string now
     assert isinstance(url, str)
-    if not url.strip():
-        click.echo("SystemLink URL cannot be empty.")
-        raise click.ClickException("SystemLink URL cannot be empty.")
-
-    # Ensure URL uses HTTPS
-    url = url.strip()
-    if url.startswith("http://"):
-        click.echo("⚠️  Warning: Converting HTTP to HTTPS for security.")
-        url = url.replace("http://", "https://", 1)
-    elif not url.startswith("https://"):
-        click.echo("⚠️  Warning: Adding HTTPS protocol to URL.")
-        url = f"https://{url}"
-    url = url.rstrip("/")
+    url = _normalize_base_url(url, "SystemLink API URL")
 
     # Get API key - either from flag or prompt
     if not api_key:
         api_key = getpass.getpass("Enter your SystemLink API key: ")
-    # Ensure api_key is a string now
     assert isinstance(api_key, str)
-    if not api_key.strip():
-        click.echo("API key cannot be empty.")
-        raise click.ClickException("API key cannot be empty.")
+    api_key = _normalize_api_key(api_key)
 
     # Normalize and validate web_url (prompt if not provided)
     if not web_url:
         click.echo("Example: https://my-systemlink.com")
         web_url = click.prompt("Enter your SystemLink Web UI URL")
     assert isinstance(web_url, str)
-    web_url = web_url.strip()
-    if web_url.startswith("http://"):
-        click.echo("⚠️  Warning: Converting HTTP to HTTPS for security.")
-        web_url = web_url.replace("http://", "https://", 1)
-    elif not web_url.startswith("https://"):
-        click.echo("⚠️  Warning: Adding HTTPS protocol to web URL.")
-        web_url = f"https://{web_url}"
-    web_url = web_url.rstrip("/")
+    web_url = _normalize_base_url(web_url, "SystemLink Web UI URL")
 
     # Detect platform type and check service status
     click.echo("Checking server connectivity and services...")
-    status = check_service_status(url, api_key.strip())
+    status = check_service_status(url, api_key)
     platform = status["platform"]
+    services = status.get("services", {})
 
     if not status["server_reachable"]:
-        click.echo("  ⚠️  Could not connect to server", err=True)
-        click.echo("      Verify the URL is correct and the server is reachable.", err=True)
-        click.echo(
-            "      Profile will be saved — run login again when the server is available.",
-            err=True,
+        _exit_with_validation_error(
+            "Could not connect to the SystemLink server. Verify the URL and network access. "
+            "Profile was not saved.",
+            ExitCodes.NETWORK_ERROR,
+        )
+
+    if status["auth_valid"] is False and _all_service_probes_unauthorized(services):
+        _exit_with_validation_error(
+            "API key validation failed. The server responded, but the key was not authorized. "
+            "Profile was not saved.",
+            ExitCodes.PERMISSION_DENIED,
+        )
+
+    if status["auth_valid"] is not True:
+        _exit_with_validation_error(
+            "Connected to the server, but profile verification was inconclusive. Check the "
+            "API URL, API key, and service availability. Profile was not saved.",
+            ExitCodes.GENERAL_ERROR,
         )
+
+    click.echo("  Connection: ✓ Verified")
+    if platform == PLATFORM_SLE:
+        click.echo("  Platform: SystemLink Enterprise (Cloud)")
+    elif platform == PLATFORM_SLS:
+        click.echo("  Platform: SystemLink Server (On-Premises)")
     else:
-        if platform == PLATFORM_SLE:
-            click.echo("  Platform: SystemLink Enterprise (Cloud)")
-        elif platform == PLATFORM_SLS:
-            click.echo("  Platform: SystemLink Server (On-Premises)")
-        else:
-            click.echo("  Platform: Unknown (will attempt all features)")
-
-        # Report authorization status
-        if status["auth_valid"] is False:
-            click.echo("  ⚠️  API key: Unauthorized — check that the key is valid", err=True)
-        elif status["auth_valid"] is True:
-            click.echo("  API key:  ✓ Authorized")
-
-        if status.get("file_query_endpoint") == "query-files":
-            click.echo("  File query: query-files")
-        elif status.get("elasticsearch_available") is False:
-            click.echo("  File query: query-files-linq (Elasticsearch unavailable)")
-            click.echo(
-                "      'slcli file list' will fall back automatically; 'slcli file query' requires search-files."
-            )
+        click.echo("  Platform: Unknown (will attempt all features)")
 
-        # Report individual service status
-        services = status.get("services", {})
-        problem_services = [
-            name for name, svc_status in services.items() if svc_status == "unauthorized"
-        ]
-        if problem_services and status["auth_valid"] is not False:
-            # Only show per-service issues if overall auth isn't completely invalid
-            for svc_name in problem_services:
-                click.echo(f"  ⚠️  {svc_name}: unauthorized", err=True)
+    click.echo("  API key:  ✓ Authorized")
+
+    if status.get("file_query_endpoint") == "query-files":
+        click.echo("  File query: query-files")
+    elif status.get("elasticsearch_available") is False:
+        click.echo("  File query: query-files-linq (Elasticsearch unavailable)")
+        click.echo(
+            "      'slcli file list' will fall back automatically; 'slcli file query' requires search-files."
+        )
+
+    problem_services = [
+        name for name, svc_status in services.items() if svc_status == "unauthorized"
+    ]
+    for svc_name in problem_services:
+        click.echo(f"  ⚠️  {svc_name}: unauthorized", err=True)
 
     # Get default workspace (optional)
     if workspace is None:
@@ -145,7 +196,7 @@ def _add_profile_impl(
     new_profile = Profile(
         name=profile,
         server=url,
-        api_key=api_key.strip(),
+        api_key=api_key,
         web_url=web_url,
         platform=platform,
         workspace=workspace,