systemlink-cli 1.20.0__tar.gz → 1.22.0__tar.gz

{systemlink_cli-1.20.0 → systemlink_cli-1.22.0}/PKG-INFO

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

{systemlink_cli-1.20.0 → systemlink_cli-1.22.0}/pyproject.toml

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

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

{systemlink_cli-1.20.0 → systemlink_cli-1.22.0}/slcli/example_click.py

@@ -2,6 +2,7 @@
 
 import json
 import sys
+from pathlib import Path
 from typing import Any, Dict, List, Optional
 
 import click
@@ -57,11 +58,60 @@ def _serialize_results(results: List[ProvisioningResult]) -> List[Dict[str, Any]
                 "action": action_value,
                 "server_id": res.server_id,
                 "error": res.error,
+                "details": res.details,
             }
         )
     return serialized
 
 
+def _build_install_manifest(
+    config: Dict[str, Any],
+    workspace_id: Optional[str],
+    results: List[Dict[str, Any]],
+    logical_ids: Dict[str, str],
+) -> Dict[str, Any]:
+    """Build the opt-in manifest contract for data-heavy fixtures."""
+    resource_actions: Dict[str, List[Dict[str, Any]]] = {
+        "created": [],
+        "updated": [],
+        "skipped": [],
+        "failed": [],
+    }
+    for result in results:
+        action = result.get("action")
+        if action in resource_actions:
+            resource_actions[action].append(result)
+
+    validation = config.get("validation", {})
+    if not isinstance(validation, dict):
+        validation = {}
+    unsupported = validation.get("unsupported", [])
+    if not isinstance(unsupported, list):
+        unsupported = [str(unsupported)]
+    required_relationships = validation.get("required_relationships", [])
+    if not isinstance(required_relationships, list):
+        required_relationships = [str(required_relationships)]
+
+    failed_relationships = validation.get("failed_relationships", [])
+    if not isinstance(failed_relationships, list):
+        failed_relationships = [str(failed_relationships)]
+
+    incomplete = bool(resource_actions["failed"] or unsupported or failed_relationships)
+    return {
+        "example": config.get("name", ""),
+        "version": config.get("example_version", "1.0.0"),
+        "workspace": {"name": config.get("workspace_name", ""), "id": workspace_id},
+        "resources": resource_actions,
+        "logical_ids": logical_ids,
+        "validation": {
+            "required_relationships": required_relationships,
+            "failed_relationships": failed_relationships,
+            "unsupported": unsupported,
+            "complete": not incomplete,
+        },
+    }
+
+
 def _result_row_formatter(item: Dict[str, Any]) -> List[str]:
     """Formatter for table rows in provisioning output."""
     return [
@@ -101,9 +151,7 @@ def _output_results(results: List[Dict[str, Any]], format_output: str) -> None:
     )
 
 
-def _write_audit_log(
-    results: List[Dict[str, Any]], audit_log: Optional[str], quiet: bool = False
-) -> None:
+def _write_audit_log(results: Any, audit_log: Optional[str], quiet: bool = False) -> None:
     """Persist results to an audit log file if requested."""
     if not audit_log:
         return
@@ -189,7 +237,7 @@ def register_example_commands(cli: Any) -> None:
         estimated setup time.
 
         Example:
-            slcli example info demo-test-plans
+            slcli example info demo-data-2
         """
         try:
             loader = ExampleLoader()
@@ -234,7 +282,13 @@ def register_example_commands(cli: Any) -> None:
             handle_api_error(exc)
 
     @example.command(name="install")
-    @click.argument("example_name")
+    @click.argument("example_name", required=False)
+    @click.option(
+        "--file",
+        "config_file",
+        type=click.Path(exists=True, dir_okay=False, readable=True, resolve_path=True),
+        help="Path to an example config.yaml; referenced files are relative to its directory.",
+    )
     @click.option("--workspace", "-w", required=True, help="Workspace name or ID for resources")
     @click.option(
         "--format",
@@ -255,7 +309,8 @@ def register_example_commands(cli: Any) -> None:
         help="Path to write provisioning results as JSON for auditing.",
     )
     def install_example(
-        example_name: str,
+        example_name: Optional[str],
+        config_file: Optional[str],
         workspace: Optional[str],
         format: str,
         dry_run: bool,
@@ -264,26 +319,62 @@ def register_example_commands(cli: Any) -> None:
         """Provision all resources defined by an example configuration."""
         try:
             loader = ExampleLoader()
-            config = loader.load_config(example_name)
+            example_dir: Optional[Path] = None
+            if config_file and example_name:
+                raise ValueError("Specify either EXAMPLE_NAME or --file, not both.")
+            if not config_file and not example_name:
+                raise ValueError("Provide an EXAMPLE_NAME or --file path to config.yaml.")
+
+            if config_file:
+                config_path = Path(config_file)
+                config = loader.load_config_file(config_path)
+                example_name = str(config["name"])
+                example_dir = config_path.parent
+            else:
+                config = loader.load_config(example_name or "")
 
             workspace_id = _resolve_workspace_id(get_effective_workspace(workspace))
-            provisioner = ExampleProvisioner(
-                workspace_id=workspace_id,
-                example_name=example_name,
-                dry_run=dry_run,
-            )
+            provisioner_options: Dict[str, Any] = {
+                "workspace_id": workspace_id,
+                "example_name": example_name,
+                "dry_run": dry_run,
+            }
+            if example_dir is not None:
+                provisioner_options["example_dir"] = example_dir
+            provisioner = ExampleProvisioner(**provisioner_options)
 
             results, err = provisioner.provision(config)
             if err:
                 handle_api_error(err)
 
             serialized = _serialize_results(results)
-            _write_audit_log(serialized, audit_log, quiet=format == "json")
-            _output_results(serialized, format)
-
+            manifest_mode = bool(config.get("install_manifest"))
+            manifest = _build_install_manifest(
+                config,
+                workspace_id,
+                serialized,
+                getattr(provisioner, "id_map", {}),
+            )
             failed = any(r.get("action") == ProvisioningAction.FAILED.value for r in serialized)
-            if failed:
-                click.echo("✗ One or more resources failed to provision.", err=True)
+            incomplete = manifest["validation"]["complete"] is False
+
+            if manifest_mode and format == "json":
+                _write_audit_log(manifest, audit_log, quiet=True)
+                click.echo(json.dumps(manifest, indent=2))
+            else:
+                _write_audit_log(serialized, audit_log, quiet=format == "json")
+                _output_results(serialized, format)
+
+            if failed or (manifest_mode and incomplete):
+                if manifest_mode and incomplete and manifest["validation"]["unsupported"]:
+                    click.echo(
+                        "✗ Example install is incomplete: required capabilities are unsupported.",
+                        err=True,
+                    )
+                elif failed:
+                    click.echo("✗ One or more resources failed to provision.", err=True)
+                else:
+                    click.echo("✗ Example install is incomplete.", err=True)
                 sys.exit(ExitCodes.GENERAL_ERROR)
 
             if format == "json":

{systemlink_cli-1.20.0 → systemlink_cli-1.22.0}/slcli/example_loader.py

@@ -33,6 +33,11 @@ class ExampleLoader:
         "data_table",
         "file",
         "notebook",
+        "state",
+        "tag",
+        "specification",
+        "feed",
+        "alarm",
     }
 
     def __init__(self, examples_dir: Optional[Path] = None) -> None:
@@ -100,6 +105,31 @@ class ExampleLoader:
                 f"Example '{example_name}' not found. " f"Config path: {config_path}"
             )
 
+        return self._load_config(config_path, example_name)
+
+    def load_config_file(self, config_file: Path) -> Dict[str, Any]:
+        """Load and validate an example configuration from an arbitrary file.
+
+        Args:
+            config_file: Path to the example's YAML configuration file.
+
+        Returns:
+            Validated config dictionary.
+
+        Raises:
+            FileNotFoundError: If the config file does not exist.
+            ValueError: If config fails validation.
+        """
+        config_path = config_file.expanduser().resolve()
+        if not config_path.exists():
+            raise FileNotFoundError(f"Example config not found: {config_path}")
+        if not config_path.is_file():
+            raise ValueError(f"Example config is not a file: {config_path}")
+
+        return self._load_config(config_path, str(config_path))
+
+    def _load_config(self, config_path: Path, source_name: str) -> Dict[str, Any]:
+        """Load and validate a config at a known path."""
         # Load YAML
         try:
             with open(config_path, "r") as f:
@@ -113,14 +143,14 @@ class ExampleLoader:
         # Validate schema
         errors = self.validate_config(config)
         if errors:
-            msg = f"Config validation failed for '{example_name}':\n"
+            msg = f"Config validation failed for '{source_name}':\n"
             msg += "\n".join(f"  - {e}" for e in errors)
             raise ValueError(msg)
 
         # Validate references
         ref_errors = self._validate_references(config)
         if ref_errors:
-            msg = f"Reference validation failed for '{example_name}':\n"
+            msg = f"Reference validation failed for '{source_name}':\n"
             msg += "\n".join(f"  - {e}" for e in ref_errors)
             raise ValueError(msg)
 
@@ -143,6 +173,10 @@ class ExampleLoader:
         if missing_fields:
             errors.append(f"Missing required fields: {', '.join(sorted(missing_fields))}")
 
+        name = config.get("name")
+        if "name" in config and (not isinstance(name, str) or not name.strip()):
+            errors.append("name must be a non-empty string")
+
         # Check format_version is supported
         version = config.get("format_version")
         if version and version not in self.SUPPORTED_SCHEMA_VERSIONS: