systemlink-cli 1.4.2__tar.gz → 1.4.4__tar.gz

{systemlink_cli-1.4.2 → systemlink_cli-1.4.4}/PKG-INFO

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

{systemlink_cli-1.4.2 → systemlink_cli-1.4.4}/pyproject.toml

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

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

{systemlink_cli-1.4.2 → systemlink_cli-1.4.4}/slcli/config_click.py

@@ -64,6 +64,7 @@ def _add_profile_impl(
     elif not url.startswith("https://"):
         click.echo("⚠️  Warning: Adding HTTPS protocol to URL.")
         url = f"https://{url}"
+    url = url.rstrip("/")
 
     # Get API key - either from flag or prompt
     if not api_key:
@@ -86,6 +87,7 @@ def _add_profile_impl(
     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("/")
 
     # Detect platform type and check service status
     click.echo("Checking server connectivity and services...")
@@ -113,6 +115,12 @@ def _add_profile_impl(
         elif status["auth_valid"] is True:
             click.echo("  API key:  ✓ Authorized")
 
+        if 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."
+            )
+
         # Report individual service status
         services = status.get("services", {})
         problem_services = [

{systemlink_cli-1.4.2 → systemlink_cli-1.4.4}/slcli/examples/demo-complete-workflow/README.md

@@ -303,9 +303,7 @@ slcli result list -w <workspace>
 
 ## Additional Resources
 
-- **SystemLink API Documentation**: https://dev-api.lifecyclesolutions.ni.com/
-- **Test Monitor Specs**: https://dev-api.lifecyclesolutions.ni.com/nitestmonitor/swagger/
-- **Work Item API**: https://dev-api.lifecyclesolutions.ni.com/niworkitem/swagger/
+- **SystemLink API Documentation**: https://demo-api.lifecyclesolutions.ni.com/niapis/
 - **systemlink-cli GitHub**: https://github.com/ni/systemlink-cli
 
 ## Contact & Support

{systemlink_cli-1.4.2 → systemlink_cli-1.4.4}/slcli/file_click.py

@@ -10,9 +10,10 @@ from typing import Any, Dict, List, Optional
 
 import click
 import questionary
+import requests as requests_lib
 
 from .cli_utils import validate_output_format
-from .universal_handlers import UniversalResponseHandler
+from .universal_handlers import FilteredResponse, UniversalResponseHandler
 from .utils import (
     ExitCodes,
     format_success,
@@ -29,6 +30,120 @@ def _get_file_service_url() -> str:
     return f"{get_base_url()}/nifile/v1/service-groups/Default"
 
 
+def _get_search_files_url() -> str:
+    """Get the search-files endpoint URL."""
+    return f"{_get_file_service_url()}/search-files"
+
+
+def _is_search_files_unavailable(exc: requests_lib.HTTPError) -> bool:
+    """Return whether the search-files endpoint is unavailable."""
+    return exc.response is not None and exc.response.status_code in (404, 501)
+
+
+def _exit_search_files_required() -> None:
+    """Exit with a user-facing message when search-files is unavailable."""
+    click.echo(
+        "✗ File query requires the search-files endpoint, but Elasticsearch is not available.",
+        err=True,
+    )
+    click.echo(
+        "  Use 'slcli file list' for automatic fallback to query-files-linq.",
+        err=True,
+    )
+    sys.exit(ExitCodes.INVALID_INPUT)
+
+
+def _search_files_with_fallback(
+    payload: Dict[str, Any],
+    workspace_id: Optional[str],
+    name_filter: Optional[str],
+    id_filter: Optional[str],
+) -> Any:
+    """Try search-files endpoint, fall back to query-files-linq if unavailable.
+
+    The search-files endpoint requires additional software (DataFinder) to be
+    installed. If it is not available (HTTP 404), we fall back to query-files-linq.
+
+    Args:
+        payload: The search-files request payload
+        workspace_id: Optional workspace ID filter
+        name_filter: Optional name filter string
+        id_filter: Optional comma-separated file IDs
+
+    Returns:
+        Response object (real or FilteredResponse)
+    """
+    try:
+        return make_api_request(
+            "POST", _get_search_files_url(), payload=payload, handle_errors=False
+        )
+    except requests_lib.HTTPError as exc:
+        if _is_search_files_unavailable(exc):
+            return _query_files_linq_fallback(
+                take=payload.get("take", 25),
+                workspace_id=workspace_id,
+                name_filter=name_filter,
+                id_filter=id_filter,
+            )
+        raise
+
+
+def _query_files_linq_fallback(
+    take: int,
+    workspace_id: Optional[str],
+    name_filter: Optional[str],
+    id_filter: Optional[str],
+) -> Any:
+    """List files using query-files-linq as a fallback when search-files is unavailable.
+
+    Args:
+        take: Maximum number of files to return
+        workspace_id: Optional workspace ID filter
+        name_filter: Optional name filter string (applied client-side)
+        id_filter: Optional comma-separated file IDs
+
+    Returns:
+        Response or FilteredResponse with availableFiles data
+    """
+    base_url = _get_file_service_url()
+    url = f"{base_url}/query-files-linq"
+
+    # Build LINQ-style filter
+    filter_parts: List[str] = []
+
+    if id_filter:
+        ids = [fid.strip() for fid in id_filter.split(",")]
+        id_conditions = [f'id = "{fid}"' for fid in ids]
+        filter_parts.append("(" + " or ".join(id_conditions) + ")")
+
+    linq_payload: Dict[str, Any] = {}
+
+    # Request more if we need to filter client-side by name
+    if name_filter:
+        linq_payload["take"] = max(take * 4, 1000)
+    else:
+        linq_payload["take"] = take
+
+    if filter_parts:
+        linq_payload["filter"] = " and ".join(filter_parts)
+
+    # Workspace filtering via query parameter
+    if workspace_id:
+        url += f"?workspace={workspace_id}"
+
+    resp = make_api_request("POST", url, payload=linq_payload)
+
+    # Client-side name filtering (query-files-linq doesn't support name wildcards)
+    if name_filter:
+        data = resp.json()
+        files = data.get("availableFiles", [])
+        needle = name_filter.lower()
+        filtered = [f for f in files if needle in _get_file_name(f).lower()][:take]
+        return FilteredResponse({"availableFiles": filtered})
+
+    return resp
+
+
 def _format_file_size(size_bytes: Optional[int]) -> str:
     """Format file size in human-readable format.
 
@@ -178,9 +293,6 @@ def register_file_commands(cli: Any) -> None:
         """
         format_output = validate_output_format(format)
 
-        # Use search-files endpoint for better performance
-        url = f"{_get_file_service_url()}/search-files"
-
         try:
             # Resolve workspace name to ID if needed
             workspace_id = None
@@ -189,7 +301,7 @@ def register_file_commands(cli: Any) -> None:
                 workspace_map = get_workspace_map()
                 workspace_id = resolve_workspace_filter(workspace, workspace_map)
 
-            # Build search filter
+            # Build search filter for search-files endpoint
             filter_parts = []
 
             if workspace_id:
@@ -221,7 +333,13 @@ def register_file_commands(cli: Any) -> None:
             if filter_parts:
                 payload["filter"] = " AND ".join(filter_parts)
 
-            resp = make_api_request("POST", url, payload=payload)
+            # Try search-files, fall back to query-files-linq if unavailable
+            resp = _search_files_with_fallback(
+                payload=payload,
+                workspace_id=workspace_id,
+                name_filter=name_filter,
+                id_filter=id_filter,
+            )
 
             def file_formatter(file_item: dict) -> list:
                 name = _get_file_name(file_item)
@@ -567,11 +685,8 @@ def register_file_commands(cli: Any) -> None:
         """
         format_output = validate_output_format(format)
 
-        # Use search-files endpoint for better performance
-        url = f"{_get_file_service_url()}/search-files"
-
         try:
-            # Build request body
+            # Build request body for search-files
             query_body: Dict[str, Any] = {
                 "take": take if format_output.lower() == "json" else (take if take != 25 else 1000),
                 "orderByDescending": descending,
@@ -584,6 +699,7 @@ def register_file_commands(cli: Any) -> None:
                 filter_parts.append(filter_query)
 
             # Resolve workspace name to ID if needed
+            workspace_id = None
             workspace = get_effective_workspace(workspace)
             if workspace:
                 workspace_map = get_workspace_map()
@@ -598,7 +714,12 @@ def register_file_commands(cli: Any) -> None:
             else:
                 query_body["orderBy"] = "updated"
 
-            resp = make_api_request("POST", url, payload=query_body)
+            resp = make_api_request(
+                "POST",
+                _get_search_files_url(),
+                payload=query_body,
+                handle_errors=False,
+            )
 
             def file_formatter(file_item: dict) -> list:
                 name = _get_file_name(file_item)
@@ -620,6 +741,10 @@ def register_file_commands(cli: Any) -> None:
                 page_size=take,
             )
 
+        except requests_lib.HTTPError as exc:
+            if _is_search_files_unavailable(exc):
+                _exit_search_files_required()
+            handle_api_error(exc)
         except Exception as exc:
             handle_api_error(exc)
 

{systemlink_cli-1.4.2 → systemlink_cli-1.4.4}/slcli/main.py

@@ -368,6 +368,15 @@ def info(format: str, skip_health: bool) -> None:
         workspace_display = truncate(workspace)
         click.echo(f"│  Workspace: {workspace_display:<48}│")
 
+    file_query_endpoint = platform_info.get("file_query_endpoint")
+    if file_query_endpoint:
+        if platform_info.get("elasticsearch_available") is False:
+            file_query_display = f"{file_query_endpoint} (Elasticsearch unavailable)"
+        else:
+            file_query_display = str(file_query_endpoint)
+        file_query_display = truncate(file_query_display)
+        click.echo(f"│  File Query:{file_query_display:<48}│")
+
     # Service Health section (only when services were checked)
     services = platform_info.get("services")
     if services:
@@ -377,6 +386,7 @@ def info(format: str, skip_health: bool) -> None:
 
         status_display = {
             "ok": ("✓", "OK"),
+            "fallback": ("!", "Fallback (no Elasticsearch)"),
             "unauthorized": ("✗", "Unauthorized"),
             "not_found": ("—", "Not available"),
             "error": ("✗", "Error"),

{systemlink_cli-1.4.2 → systemlink_cli-1.4.4}/slcli/platform.py

@@ -56,6 +56,9 @@ FEATURE_DISPLAY_NAMES: Dict[str, str] = {
     "webapp": "Web Applications",
 }
 
+FILE_SEARCH_PATH = "/nifile/v1/service-groups/Default/search-files"
+FILE_QUERY_LINQ_PATH = "/nifile/v1/service-groups/Default/query-files-linq"
+
 
 def _get_keyring_config() -> Dict[str, Any]:
     """Attempt to read a single JSON config entry from keyring.
@@ -84,7 +87,6 @@ def detect_platform(api_url: str, api_key: str) -> str:
     Uses check_service_status to probe services and determine:
     - Platform type (SLE vs SLS)
     - Server reachability
-    Falls back to URL pattern matching when probe is inconclusive.
 
     Args:
         api_url: The SystemLink API base URL
@@ -98,45 +100,6 @@ def detect_platform(api_url: str, api_key: str) -> str:
     return status["platform"]
 
 
-def _detect_platform_from_url(api_url: str) -> str:
-    """Detect platform from URL pattern without making network requests.
-
-    This is a lightweight detection for use when environment variables
-    are set and we need quick platform detection.
-
-    SLE (SystemLink Enterprise Cloud) URLs typically contain:
-    - api.systemlink.io (production)
-    - dev-api.lifecyclesolutions.ni.com (development)
-    - demo-api.lifecyclesolutions.ni.com (demo)
-
-    On-premises SystemLink Server (SLS) instances may use custom domains
-    or even *.systemlink.io subdomains (like base.systemlink.io).
-
-    Args:
-        api_url: The SystemLink API base URL
-
-    Returns:
-        Platform identifier: PLATFORM_SLE or PLATFORM_SLS.
-        Note: This function never returns PLATFORM_UNKNOWN - it defaults to SLS.
-    """
-    api_url_lower = api_url.lower()
-
-    # SLE cloud service has specific URL patterns
-    sle_patterns = [
-        "api.systemlink.io",  # SLE production
-        "-api.lifecyclesolutions.ni.com",  # SLE dev/demo with -api suffix
-        "dev-api.lifecyclesolutions",
-        "demo-api.lifecyclesolutions",
-    ]
-    for pattern in sle_patterns:
-        if pattern in api_url_lower:
-            return PLATFORM_SLE
-
-    # Default to SLS for on-premises/custom URLs
-    # This includes on-prem servers that may use *.systemlink.io subdomains
-    return PLATFORM_SLS
-
-
 @lru_cache(maxsize=1)
 def get_platform() -> str:
     """Get the current platform from stored configuration or environment.
@@ -144,8 +107,7 @@ def get_platform() -> str:
     Detection priority:
     1. SYSTEMLINK_PLATFORM environment variable (explicit, most reliable)
     2. Stored platform from keyring config (set during login via endpoint probing)
-    3. URL pattern matching (fallback, less reliable)
-    4. Return PLATFORM_UNKNOWN if all methods fail
+    3. Return PLATFORM_UNKNOWN if no explicit or stored platform is available
 
     Note: Results are cached for performance. Use clear_platform_cache() to reset.
 
@@ -166,12 +128,6 @@ def get_platform() -> str:
         if platform in (PLATFORM_SLE, PLATFORM_SLS):
             return platform
 
-    # Priority 3: URL pattern matching (fallback, less reliable)
-    # Only used when env vars are set but no explicit platform is provided
-    env_url = os.environ.get("SYSTEMLINK_API_URL")
-    if env_url:
-        return _detect_platform_from_url(env_url)
-
     return PLATFORM_UNKNOWN
 
 
@@ -240,7 +196,7 @@ SERVICE_CHECKS: List[List[str]] = [
     ["Asset Management", "POST", "/niapm/v1/query-assets"],
     ["Systems", "POST", "/nisysmgmt/v1/query-systems"],
     ["Tag", "GET", "/nitag/v2/tags?take=0"],
-    ["File", "POST", "/nifile/v1/service-groups/Default/search-files"],
+    ["File", "POST", FILE_SEARCH_PATH],
     ["Notebook", "POST", "/ninotebook/v1/notebook/query"],
     ["Web Application", "POST", "/niapp/v1/webapps/query"],
     ["Dynamic Form Fields", "GET", "/nidynamicformfields/v1/groups"],
@@ -248,6 +204,87 @@ SERVICE_CHECKS: List[List[str]] = [
 ]
 
 
+def get_file_query_capability(api_url: str, api_key: str) -> Dict[str, Any]:
+    """Determine which file query endpoint is available for this server."""
+    headers = {
+        "x-ni-api-key": api_key,
+        "Content-Type": "application/json",
+        "User-Agent": "SystemLink-CLI/1.0 (cross-platform)",
+    }
+    ssl_verify = get_ssl_verify()
+
+    try:
+        search_resp = requests.post(
+            f"{api_url}{FILE_SEARCH_PATH}",
+            headers=headers,
+            json={"take": 1},
+            verify=ssl_verify,
+            timeout=10,
+        )
+        if search_resp.status_code in (200, 400):
+            return {
+                "status": "ok",
+                "file_query_endpoint": "search-files",
+                "elasticsearch_available": True,
+            }
+        if search_resp.status_code in (401, 403):
+            return {
+                "status": "unauthorized",
+                "file_query_endpoint": "search-files",
+                "elasticsearch_available": True,
+            }
+        if search_resp.status_code not in (404, 501):
+            return {
+                "status": "error" if search_resp.status_code >= 500 else "not_found",
+                "file_query_endpoint": None,
+                "elasticsearch_available": True,
+            }
+    except requests.RequestException:
+        return {
+            "status": "unreachable",
+            "file_query_endpoint": None,
+            "elasticsearch_available": None,
+        }
+
+    try:
+        fallback_resp = requests.post(
+            f"{api_url}{FILE_QUERY_LINQ_PATH}",
+            headers=headers,
+            json={"take": 1},
+            verify=ssl_verify,
+            timeout=10,
+        )
+        if fallback_resp.status_code in (200, 400):
+            return {
+                "status": "fallback",
+                "file_query_endpoint": "query-files-linq",
+                "elasticsearch_available": False,
+            }
+        if fallback_resp.status_code in (401, 403):
+            return {
+                "status": "unauthorized",
+                "file_query_endpoint": "query-files-linq",
+                "elasticsearch_available": False,
+            }
+        if fallback_resp.status_code in (404, 501):
+            return {
+                "status": "not_found",
+                "file_query_endpoint": None,
+                "elasticsearch_available": False,
+            }
+        return {
+            "status": "error",
+            "file_query_endpoint": None,
+            "elasticsearch_available": False,
+        }
+    except requests.RequestException:
+        return {
+            "status": "unreachable",
+            "file_query_endpoint": None,
+            "elasticsearch_available": False,
+        }
+
+
 def check_service_status(api_url: str, api_key: str) -> Dict[str, Any]:
     """Probe key SystemLink services and report their status.
 
@@ -263,8 +300,10 @@ def check_service_status(api_url: str, api_key: str) -> Dict[str, Any]:
         - auth_valid: bool | None - whether the API key is authorized (None if unreachable)
         - services: dict mapping service name to status string
           ("ok", "unauthorized", "not_found", "error", "unreachable")
-        - platform: detected platform string (PLATFORM_SLE, PLATFORM_SLS,
-          PLATFORM_UNREACHABLE)
+                - file_query_endpoint: selected file query endpoint, if available
+                - elasticsearch_available: bool | None - whether search-files is available
+                - platform: detected platform string (PLATFORM_SLE, PLATFORM_SLS,
+                    PLATFORM_UNREACHABLE, PLATFORM_UNKNOWN)
     """
     headers = {
         "x-ni-api-key": api_key,
@@ -321,6 +360,8 @@ def check_service_status(api_url: str, api_key: str) -> Dict[str, Any]:
             "server_reachable": False,
             "auth_valid": None,
             "services": services,
+            "file_query_endpoint": None,
+            "elasticsearch_available": None,
             "platform": PLATFORM_UNREACHABLE,
         }
 
@@ -337,13 +378,17 @@ def check_service_status(api_url: str, api_key: str) -> Dict[str, Any]:
     elif workorder_status == "not_found":
         platform = PLATFORM_SLS
     else:
-        # Fall back to URL pattern matching
-        platform = _detect_platform_from_url(api_url)
+        platform = PLATFORM_UNKNOWN
+
+    file_capability = get_file_query_capability(api_url, api_key)
+    services["File"] = file_capability["status"]
 
     return {
         "server_reachable": True,
         "auth_valid": auth_valid,
         "services": services,
+        "file_query_endpoint": file_capability["file_query_endpoint"],
+        "elasticsearch_available": file_capability["elasticsearch_available"],
         "platform": platform,
     }
 
@@ -392,6 +437,8 @@ def get_platform_info(skip_health: bool = False) -> Dict[str, Any]:
     auth_valid: Optional[bool] = None
     services: Optional[Dict[str, str]] = None
     platform = stored_platform
+    file_query_endpoint: Optional[str] = None
+    elasticsearch_available: Optional[bool] = None
 
     if not skip_health and logged_in and isinstance(api_url, str) and api_url != "Not configured":
         status = check_service_status(api_url, api_key)
@@ -399,6 +446,8 @@ def get_platform_info(skip_health: bool = False) -> Dict[str, Any]:
         auth_valid = status["auth_valid"]
         services = status["services"]
         platform = status["platform"]
+        file_query_endpoint = status.get("file_query_endpoint")
+        elasticsearch_available = status.get("elasticsearch_available")
 
     info: Dict[str, Any] = {
         "api_url": api_url,
@@ -410,6 +459,11 @@ def get_platform_info(skip_health: bool = False) -> Dict[str, Any]:
         "auth_valid": auth_valid,
     }
 
+    if file_query_endpoint is not None:
+        info["file_query_endpoint"] = file_query_endpoint
+    if elasticsearch_available is not None:
+        info["elasticsearch_available"] = elasticsearch_available
+
     if services is not None:
         info["services"] = services
 

{systemlink_cli-1.4.2 → systemlink_cli-1.4.4}/slcli/user_click.py

@@ -423,7 +423,7 @@ def _query_all_users(
     - Uses 'status = "active"' for filtering disabled users
 
     TODO: Follow this pattern for other API clients that support continuation tokens
-    Reference: https://dev-api.lifecyclesolutions.ni.com/niuser/swagger/v1/niuser.yaml
+    Reference: https://demo-api.lifecyclesolutions.ni.com/niuser/swagger/v1/niuser.yaml
 
     Args:
         filter_str: Filter expression for users