pvw-cli 1.0.8__py3-none-any.whl → 1.0.10__py3-none-any.whl

purviewcli/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.8"
+__version__ = "1.0.10"
 
 # Import main client modules
 from .client import *

purviewcli/cli/health.py

@@ -0,0 +1,250 @@
+"""
+Health CLI commands for Microsoft Purview Unified Catalog
+"""
+
+import click
+from rich.table import Table
+from rich.console import Console
+from purviewcli.client._health import Health
+import re
+
+console = Console()
+
+
+@click.group()
+def health():
+    """Health monitoring and governance recommendations."""
+    pass
+
+
+@health.command()
+@click.option("--domain-id", help="Filter by governance domain ID")
+@click.option("--severity", help="Filter by severity: High, Medium, Low")
+@click.option("--status", help="Filter by status: NotStarted, InProgress, Resolved, Dismissed")
+@click.option("--finding-type", help="Filter by finding type (e.g., 'Estate Curation')")
+@click.option("--target-entity-type", help="Filter by target entity type (e.g., DataProduct, Term)")
+def query(domain_id, severity, status, finding_type, target_entity_type):
+    """Query health actions (findings and recommendations)."""
+    client = Health()
+    
+    args = {
+        "--domain-id": [domain_id] if domain_id else [""],
+        "--severity": [severity] if severity else [""],
+        "--status": [status] if status else [""],
+        "--finding-type": [finding_type] if finding_type else [""],
+        "--target-entity-type": [target_entity_type] if target_entity_type else [""]
+    }
+    
+    result = client.query_health_actions(args)
+    
+    # get_data() in endpoint.py returns just the data part
+    if result and isinstance(result, dict):
+        actions = result.get("value", [])
+        
+        if not actions:
+            console.print("[yellow]No health actions found matching the filters.[/yellow]")
+            return
+        
+        # Create summary table
+        table = Table(title=f"Health Actions ({len(actions)} found)", show_lines=True)
+        table.add_column("ID", style="cyan", no_wrap=False)
+        table.add_column("Finding", style="white", no_wrap=False)
+        table.add_column("Severity", style="yellow")
+        table.add_column("Status", style="green")
+        table.add_column("Target", style="magenta", no_wrap=False)
+        table.add_column("Domain", style="blue", no_wrap=False)
+        
+        for action in actions:
+            # Color severity
+            severity_text = action.get("severity", "N/A")
+            if severity_text == "High":
+                severity_style = "[red]High[/red]"
+            elif severity_text == "Medium":
+                severity_style = "[yellow]Medium[/yellow]"
+            else:
+                severity_style = "[green]Low[/green]"
+            
+            # Color status
+            status_text = action.get("status", "N/A")
+            if status_text == "NotStarted":
+                status_style = "[red]Not Started[/red]"
+            elif status_text == "InProgress":
+                status_style = "[yellow]In Progress[/yellow]"
+            elif status_text == "Resolved":
+                status_style = "[green]Resolved[/green]"
+            else:
+                status_style = status_text
+            
+            # Truncate IDs for display
+            action_id = action.get("id", "N/A")
+            short_id = action_id[:13] + "..." if len(action_id) > 16 else action_id
+            
+            domain_id_val = action.get("domainId", "N/A")
+            short_domain = domain_id_val[:13] + "..." if len(domain_id_val) > 16 else domain_id_val
+            
+            table.add_row(
+                short_id,
+                action.get("findingName", "N/A"),
+                severity_style,
+                status_style,
+                action.get("targetEntityType", "N/A"),
+                short_domain
+            )
+        
+        console.print(table)
+        console.print(f"\n[dim]Showing {len(actions)} health action(s)[/dim]")
+        console.print("[dim]Use 'pvcli uc health show --action-id <id>' for details[/dim]")
+    else:
+        console.print("[red]Failed to retrieve health actions.[/red]")
+
+
+@health.command()
+@click.option("--action-id", required=True, help="Health action ID")
+def show(action_id):
+    """Show detailed information about a health action."""
+    client = Health()
+    args = {"--action-id": [action_id]}
+    
+    result = client.get_health_action(args)
+    
+    # get_data() returns just the data part
+    if result and isinstance(result, dict) and "id" in result:
+        action = result
+        
+        console.print(f"\n[bold cyan]Health Action Details[/bold cyan]\n")
+        
+        # Basic info
+        console.print(f"[bold]ID:[/bold] {action.get('id', 'N/A')}")
+        console.print(f"[bold]Finding ID:[/bold] {action.get('findingId', 'N/A')}")
+        console.print(f"[bold]Name:[/bold] {action.get('findingName', 'N/A')}")
+        
+        # Severity with color
+        severity = action.get("severity", "N/A")
+        severity_color = "red" if severity == "High" else "yellow" if severity == "Medium" else "green"
+        console.print(f"[bold]Severity:[/bold] [{severity_color}]{severity}[/{severity_color}]")
+        
+        # Status with color
+        status = action.get("status", "N/A")
+        status_color = "red" if status == "NotStarted" else "yellow" if status == "InProgress" else "green"
+        console.print(f"[bold]Status:[/bold] [{status_color}]{status}[/{status_color}]")
+        
+        # Category and types
+        console.print(f"\n[bold]Category:[/bold] {action.get('category', 'N/A')}")
+        console.print(f"[bold]Finding Type:[/bold] {action.get('findingType', 'N/A')}")
+        console.print(f"[bold]Finding SubType:[/bold] {action.get('findingSubType', 'N/A')}")
+        
+        # Target
+        console.print(f"\n[bold]Target Entity Type:[/bold] {action.get('targetEntityType', 'N/A')}")
+        console.print(f"[bold]Target Entity ID:[/bold] {action.get('targetEntityId', 'N/A')}")
+        console.print(f"[bold]Domain ID:[/bold] {action.get('domainId', 'N/A')}")
+        
+        # Recommendation
+        recommendation = action.get("recommendation", "")
+        if recommendation:
+            console.print(f"\n[bold]Recommendation:[/bold]\n{recommendation}")
+        
+        # Reason
+        reason = action.get("reason", "")
+        if reason:
+            console.print(f"\n[bold]Reason:[/bold]\n{reason}")
+        
+        # Assignment
+        assigned_to = action.get("assignedTo", [])
+        if assigned_to:
+            console.print(f"\n[bold]Assigned To:[/bold]")
+            for user_id in assigned_to:
+                console.print(f"  • {user_id}")
+        else:
+            console.print(f"\n[bold]Assigned To:[/bold] [yellow]Not assigned[/yellow]")
+        
+        # System data
+        system_data = action.get("systemData", {})
+        if system_data:
+            console.print(f"\n[bold]System Information:[/bold]")
+            console.print(f"  Created At: {system_data.get('createdAt', 'N/A')}")
+            console.print(f"  Created By: {system_data.get('createdBy', 'N/A')}")
+            console.print(f"  Last Modified: {system_data.get('lastModifiedAt', 'N/A')}")
+            console.print(f"  Last Modified By: {system_data.get('lastModifiedBy', 'N/A')}")
+            console.print(f"  Last Hint At: {system_data.get('lastHintAt', 'N/A')}")
+        
+        console.print()
+    else:
+        console.print(f"[red]Failed to retrieve health action: {action_id}[/red]")
+
+
+@health.command()
+@click.option("--action-id", required=True, help="Health action ID")
+@click.option("--status", help="New status: NotStarted, InProgress, Resolved, Dismissed")
+@click.option("--assigned-to", help="User ID or email to assign to")
+@click.option("--reason", help="Reason for the update")
+def update(action_id, status, assigned_to, reason):
+    """Update a health action (status, assignment, etc.)."""
+    if not status and not assigned_to and not reason:
+        console.print("[red]Error: At least one of --status, --assigned-to, or --reason must be provided.[/red]")
+        return
+    
+    client = Health()
+    args = {
+        "--action-id": [action_id],
+        "--status": [status] if status else [""],
+        "--assigned-to": [assigned_to] if assigned_to else [""],
+        "--reason": [reason] if reason else [""]
+    }
+    
+    result = client.update_health_action(args)
+    
+    if result and result.get("status") == "success":
+        console.print(f"[green]✓[/green] Health action updated successfully: {action_id}")
+        if status:
+            console.print(f"  Status: {status}")
+        if assigned_to:
+            console.print(f"  Assigned to: {assigned_to}")
+        if reason:
+            console.print(f"  Reason: {reason}")
+    else:
+        console.print(f"[red]Failed to update health action: {action_id}[/red]")
+
+
+@health.command()
+@click.option("--action-id", required=True, help="Health action ID")
+@click.confirmation_option(prompt="Are you sure you want to delete this health action?")
+def delete(action_id):
+    """Delete a health action."""
+    client = Health()
+    args = {"--action-id": [action_id]}
+    
+    result = client.delete_health_action(args)
+    
+    if result and result.get("status") == "success":
+        console.print(f"[green]✓[/green] Health action deleted successfully: {action_id}")
+    else:
+        console.print(f"[red]Failed to delete health action: {action_id}[/red]")
+
+
+@health.command()
+@click.option("--domain-id", help="Get summary for specific domain")
+def summary(domain_id):
+    """Get health summary statistics."""
+    client = Health()
+    args = {"--domain-id": [domain_id] if domain_id else [""]}
+    
+    result = client.get_health_summary(args)
+    
+    if result and result.get("data"):
+        summary_data = result["data"]
+        
+        console.print("\n[bold cyan]Health Summary[/bold cyan]\n")
+        
+        # Display summary statistics
+        console.print(f"Total Actions: {summary_data.get('total', 'N/A')}")
+        console.print(f"High Severity: [red]{summary_data.get('high', 'N/A')}[/red]")
+        console.print(f"Medium Severity: [yellow]{summary_data.get('medium', 'N/A')}[/yellow]")
+        console.print(f"Low Severity: [green]{summary_data.get('low', 'N/A')}[/green]")
+        console.print(f"\nNot Started: [red]{summary_data.get('notStarted', 'N/A')}[/red]")
+        console.print(f"In Progress: [yellow]{summary_data.get('inProgress', 'N/A')}[/yellow]")
+        console.print(f"Resolved: [green]{summary_data.get('resolved', 'N/A')}[/green]")
+        
+        console.print()
+    else:
+        console.print("[yellow]Summary endpoint may not be available or no data returned.[/yellow]")
+        console.print("[dim]Try using 'pvcli uc health query' to see all actions.[/dim]")

purviewcli/cli/search.py

@@ -21,39 +21,226 @@ options:
 CLI for advanced search and discovery
 """
 import click
+import json
+from rich.console import Console
+from rich.table import Table
 from purviewcli.client._search import Search
 
+console = Console()
+
 @click.group()
 def search():
     """Search and discover assets"""
     pass
 
+def _format_json_output(data):
+    """Format JSON output with syntax highlighting using Rich"""
+    from rich.console import Console
+    from rich.syntax import Syntax
+    import json
+    
+    console = Console()
+    
+    # Pretty print JSON with syntax highlighting
+    json_str = json.dumps(data, indent=2)
+    syntax = Syntax(json_str, "json", theme="monokai", line_numbers=True)
+    console.print(syntax)
+
+def _format_detailed_output(data):
+    """Format search results with detailed information in readable format"""
+    from rich.console import Console
+    from rich.panel import Panel
+    from rich.text import Text
+    
+    console = Console()
+    
+    # Extract results data
+    count = data.get('@search.count', 0)
+    items = data.get('value', [])
+    
+    if not items:
+        console.print("[yellow]No results found[/yellow]")
+        return
+    
+    console.print(f"\n[bold cyan]Search Results: {len(items)} of {count} total[/bold cyan]\n")
+    
+    for i, item in enumerate(items, 1):
+        # Create a panel for each result
+        details = []
+        
+        # Basic information
+        details.append(f"[bold cyan]Name:[/bold cyan] {item.get('name', 'N/A')}")
+        details.append(f"[bold green]Type:[/bold green] {item.get('entityType', 'N/A')}")
+        details.append(f"[bold yellow]ID:[/bold yellow] {item.get('id', 'N/A')}")
+        
+        # Collection
+        if 'collection' in item and item['collection']:
+            collection_name = item['collection'].get('name', 'N/A')
+        else:
+            collection_name = item.get('collectionId', 'N/A')
+        details.append(f"[bold blue]Collection:[/bold blue] {collection_name}")
+        
+        # Qualified Name
+        details.append(f"[bold white]Qualified Name:[/bold white] {item.get('qualifiedName', 'N/A')}")
+        
+        # Classifications
+        if 'classification' in item and item['classification']:
+            classifications = []
+            for cls in item['classification']:
+                if isinstance(cls, dict):
+                    classifications.append(cls.get('typeName', str(cls)))
+                else:
+                    classifications.append(str(cls))
+            details.append(f"[bold magenta]Classifications:[/bold magenta] {', '.join(classifications)}")
+        
+        # Additional metadata
+        if 'updateTime' in item:
+            details.append(f"[bold dim]Last Updated:[/bold dim] {item.get('updateTime')}")
+        if 'createTime' in item:
+            details.append(f"[bold dim]Created:[/bold dim] {item.get('createTime')}")
+        if 'updateBy' in item:
+            details.append(f"[bold dim]Updated By:[/bold dim] {item.get('updateBy')}")
+        
+        # Search score
+        if '@search.score' in item:
+            details.append(f"[bold dim]Search Score:[/bold dim] {item.get('@search.score'):.2f}")
+        
+        # Create panel
+        panel_content = "\n".join(details)
+        panel = Panel(
+            panel_content,
+            title=f"[bold]{i}. {item.get('name', 'Unknown')}[/bold]",
+            border_style="blue"
+        )
+        console.print(panel)
+    
+    # Add pagination hint if there are more results
+    if len(items) < count:
+        console.print(f"\n💡 [dim]More results available. Use --offset to paginate.[/dim]")
+    
+    return
+
+def _format_search_results(data, show_ids=False):
+    """Format search results as a nice table using Rich"""
+    from rich.console import Console
+    from rich.table import Table
+    
+    console = Console()
+    
+    # Extract results data
+    count = data.get('@search.count', 0)
+    items = data.get('value', [])
+    
+    if not items:
+        console.print("[yellow]No results found[/yellow]")
+        return
+    
+    # Create table
+    table = Table(title=f"Search Results ({len(items)} of {count} total)")
+    table.add_column("Name", style="cyan", min_width=15, max_width=25)
+    table.add_column("Type", style="green", min_width=15, max_width=20)
+    table.add_column("Collection", style="blue", min_width=12, max_width=20)
+    table.add_column("Classifications", style="magenta", min_width=15, max_width=30)
+    
+    if show_ids:
+        table.add_column("ID", style="yellow", min_width=36, max_width=36)
+    
+    table.add_column("Qualified Name", style="white", min_width=30)
+    
+    for item in items:
+        # Extract entity information
+        name = item.get('name', 'N/A')
+        entity_type = item.get('entityType', 'N/A')
+        entity_id = item.get('id', 'N/A')
+        qualified_name = item.get('qualifiedName', 'N/A')
+        
+        # Truncate long qualified names for better display
+        if len(qualified_name) > 60:
+            qualified_name = qualified_name[:57] + "..."
+        
+        # Handle collection
+        collection = 'N/A'
+        if 'collection' in item and item['collection']:
+            collection = item['collection'].get('name', 'N/A')
+        
+        # Handle classifications - truncate long classification lists
+        classifications = []
+        if 'classification' in item and item['classification']:
+            for cls in item['classification']:
+                if isinstance(cls, dict):
+                    cls_name = cls.get('typeName', str(cls))
+                    # Simplify Microsoft classifications for display
+                    if cls_name.startswith('MICROSOFT.'):
+                        cls_name = cls_name.replace('MICROSOFT.', 'MS.')
+                    classifications.append(cls_name)
+                else:
+                    classifications.append(str(cls))
+        
+        # Truncate classifications if too long
+        cls_display = ", ".join(classifications) if classifications else ""
+        if len(cls_display) > 40:
+            cls_display = cls_display[:37] + "..."
+        
+        # Build row data
+        row_data = [name, entity_type, collection, cls_display]
+        if show_ids:
+            row_data.append(entity_id)
+        row_data.append(qualified_name)
+        
+        # Add row to table
+        table.add_row(*row_data)
+    
+    # Print the table
+    console.print(table)
+    
+    # Add pagination hint if there are more results
+    if len(items) < count:
+        console.print(f"\n💡 More results available. Use --offset to paginate.")
+    
+    return
+
 def _invoke_search_method(method_name, **kwargs):
     search_client = Search()
     method = getattr(search_client, method_name)
+    
+    # Extract formatting options, don't pass to API
+    show_ids = kwargs.pop('show_ids', False)
+    output_json = kwargs.pop('output_json', False)
+    detailed = kwargs.pop('detailed', False)
+    
     args = {f'--{k}': v for k, v in kwargs.items() if v is not None}
     try:
         result = method(args)
-        click.echo(result)
+        # Choose output format
+        if output_json:
+            _format_json_output(result)
+        elif detailed and method_name in ['searchQuery', 'searchBrowse', 'searchSuggest', 'searchAutoComplete']:
+            _format_detailed_output(result)
+        elif method_name in ['searchQuery', 'searchBrowse', 'searchSuggest', 'searchAutoComplete']:
+            _format_search_results(result, show_ids=show_ids)
+        else:
+            _format_json_output(result)
     except Exception as e:
-        click.echo(f"[ERROR] {e}", err=True)
+        console.print(f"[red]ERROR:[/red] {str(e)}")
 
 @search.command()
 @click.option('--keywords', required=False)
 @click.option('--limit', required=False, type=int, default=25)
 @click.option('--filterFile', required=False, type=click.Path(exists=True))
-def autocomplete(keywords, limit, filterfile):
+@click.option('--json', 'output_json', is_flag=True, help='Show full JSON details instead of table')
+def autocomplete(keywords, limit, filterfile, output_json):
     """Autocomplete search suggestions"""
-    _invoke_search_method('searchAutoComplete', keywords=keywords, limit=limit, filterFile=filterfile)
+    _invoke_search_method('searchAutoComplete', keywords=keywords, limit=limit, filterFile=filterfile, output_json=output_json)
 
 @search.command()
 @click.option('--entityType', required=False)
 @click.option('--path', required=False)
 @click.option('--limit', required=False, type=int, default=25)
 @click.option('--offset', required=False, type=int, default=0)
-def browse(entitytype, path, limit, offset):
+@click.option('--json', 'output_json', is_flag=True, help='Show full JSON details instead of table')
+def browse(entitytype, path, limit, offset, output_json):
     """Browse entities by type or path"""
-    _invoke_search_method('searchBrowse', entityType=entitytype, path=path, limit=limit, offset=offset)
+    _invoke_search_method('searchBrowse', entityType=entitytype, path=path, limit=limit, offset=offset, output_json=output_json)
 
 @search.command()
 @click.option('--keywords', required=False)
@@ -61,17 +248,21 @@ def browse(entitytype, path, limit, offset):
 @click.option('--offset', required=False, type=int, default=0)
 @click.option('--filterFile', required=False, type=click.Path(exists=True))
 @click.option('--facets-file', required=False, type=click.Path(exists=True))
-def query(keywords, limit, offset, filterfile, facets_file):
+@click.option('--show-ids', is_flag=True, help='Show entity IDs in the results')
+@click.option('--json', 'output_json', is_flag=True, help='Show full JSON details instead of table')
+@click.option('--detailed', is_flag=True, help='Show detailed information in readable format')
+def query(keywords, limit, offset, filterfile, facets_file, show_ids, output_json, detailed):
     """Run a search query"""
-    _invoke_search_method('searchQuery', keywords=keywords, limit=limit, offset=offset, filterFile=filterfile, facets_file=facets_file)
+    _invoke_search_method('searchQuery', keywords=keywords, limit=limit, offset=offset, filterFile=filterfile, facets_file=facets_file, show_ids=show_ids, output_json=output_json, detailed=detailed)
 
 @search.command()
 @click.option('--keywords', required=False)
 @click.option('--limit', required=False, type=int, default=25)
 @click.option('--filterFile', required=False, type=click.Path(exists=True))
-def suggest(keywords, limit, filterfile):
+@click.option('--json', 'output_json', is_flag=True, help='Show full JSON details instead of table')
+def suggest(keywords, limit, filterfile, output_json):
     """Get search suggestions"""
-    _invoke_search_method('searchSuggest', keywords=keywords, limit=limit, filterFile=filterfile)
+    _invoke_search_method('searchSuggest', keywords=keywords, limit=limit, filterFile=filterfile, output_json=output_json)
 
 @search.command()
 @click.option('--keywords', required=False)