pyegeria 0.2.4__py3-none-any.whl → 5.3.0.dev3__py3-none-any.whl

pyegeria/commands/cat/list_projects.py

@@ -0,0 +1,221 @@
+#!/usr/bin/env python3
+"""
+SPDX-Lic
+ense-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Unit tests for the Utils helper functions using the Pytest framework.
+
+
+A simple display for glossary terms
+"""
+import argparse
+import json
+import os
+import time
+
+from rich import box
+from rich import print
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from pyegeria import ProjectManager, ClassificationManager
+
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_INTEGRATION_DAEMON_URL = os.environ.get(
+    "EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"
+)
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+def display_project_list(
+    project_name: str,
+    server: str,
+    url: str,
+    username: str,
+    user_pass: str,
+    save_output: bool,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    p_client = ProjectManager(server, url, user_id=username)
+    token = p_client.create_egeria_bearer_token(username, user_pass)
+    c_client = ClassificationManager(server, url, token=token)
+
+    def generate_table(project_name: str) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Project List: {project_name}  @ {time.asctime()}",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"Project list for Server '{server}' @ Platform - {url}",
+            expand=True,
+        )
+
+        table.add_column("Project Name")
+        table.add_column("Description")
+
+        table.add_column("Classifications")
+        table.add_column("Qualified Name")
+        table.add_column("Identifier")
+        table.add_column("Phase")
+        table.add_column("Health")
+        table.add_column("Status")
+        table.add_column("Start Date")
+        table.add_column("End Date")
+        table.add_column("Contracts")
+
+        projects = p_client.find_projects(project_name)
+
+        if projects is None:
+            name = " "
+            guid = " "
+            classification = " "
+            qualified_name = " "
+            identifier = " "
+            phase = " "
+            health = " "
+            status = " "
+            start = " "
+            end = " "
+            description = " "
+        elif type(projects) == str:
+            raise ValueError("-->This is not a known project")
+        else:
+            sorted_projects = sorted(
+                projects, key=lambda k: k["properties"].get("name", "---")
+            )
+
+            for project in sorted_projects:
+                classification = ""
+                guid = project["elementHeader"]["guid"]
+                props = project["properties"]
+                name = props.get("name", "None")
+                p_class = project["elementHeader"].get("classifications")
+                if p_class:
+                    for classif in p_class:
+                        classification += f"* {classif.get('classificationName')}\n"
+                qualified_name = props.get("qualifiedName", " ")
+                identifier = props.get("identifier", " ")
+                phase = props.get("projectPhase", " ")
+                health = props.get("projectHealth", " ")
+                status = props.get("projectStatus", " ")
+                description = props.get("description", " ")
+                start = props.get("startDate", " ")[0:10]
+                end = props.get("plannedEndDate", " ")
+                additional_properties = project.get("additionalProperties")
+                if additional_properties is not None:
+                    props = json.dumps(additional_properties)
+
+                governed_by = c_client.get_related_elements(guid, "GovernedBy")
+                if type(governed_by) is list:
+                    for gov in governed_by:
+                        rel_guid = gov["relatedElement"]["elementHeader"]["guid"]
+                        rel_title = gov["relatedElement"]["properties"].get(
+                            "title", "---"
+                        )
+                        certified_partner = f"{rel_title}: \n"
+                        certified = c_client.get_related_elements(
+                            rel_guid, "Certification"
+                        )
+                        if type(certified) is list:
+                            for rel_elem in certified:
+                                p_name = rel_elem["relatedElement"]["properties"][
+                                    "name"
+                                ]
+                                certified_partner += f"* {p_name}\n"
+                else:
+                    certified_partner = "---"
+
+                table.add_row(
+                    name,
+                    description,
+                    classification,
+                    qualified_name,
+                    identifier,
+                    phase,
+                    health,
+                    status,
+                    start,
+                    end,
+                    certified_partner,
+                )
+
+        p_client.close_session()
+        return table
+
+    try:
+        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+        #     while True:
+        #         time.sleep(2)
+        #         live.update(generate_table())
+        console = Console(
+            record=True, width=width, force_terminal=not jupyter, soft_wrap=True
+        )
+        with console.pager():
+            console.print(generate_table(project_name), soft_wrap=True)
+        if save_output:
+            console.save_html("projects.html")
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+        ValueError,
+    ) as e:
+        if type(e) is str:
+            print(e)
+        else:
+            print_exception_response(e)
+    except KeyboardInterrupt:
+        pass
+    finally:
+        p_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--save-output", help="Save output to file?")
+    parser.add_argument("--password", help="User Password")
+    # parser.add_argument("--sponsor", help="Name of sponsor to search")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        save_output = args.save_output if args.save_output is not None else False
+        project_name = Prompt.ask("Enter the Project to retrieve:", default="*")
+        display_project_list(project_name, server, url, userid, user_pass, save_output)
+
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/cat/list_servers_deployed_imp.py

@@ -0,0 +1,158 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Display by deployed implementation type.
+
+Note: This implementation is using the runtime manager.
+
+
+
+A simple server status display
+"""
+import argparse
+import os
+import sys
+import time
+
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.text import Text
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    RuntimeManager,
+)
+
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_INTEGRATION_DAEMON_URL = os.environ.get(
+    "EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"
+)
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+def display_servers_by_dep_imp(
+    filter: str = "*",
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    p_client = RuntimeManager(view_server, view_url, user, user_pass)
+    token = p_client.create_egeria_bearer_token()
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Servers by Deployed Implementation Type - {time.asctime()}",
+            style="bold white on black",
+            row_styles=["bold white on black"],
+            header_style="white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            caption=f"Platform - '{view_url}'",
+            show_lines=True,
+        )
+
+        table.add_column("Server")
+        table.add_column("Deployed Impl Type")
+        table.add_column("Zones")
+
+        table.add_column("Description")
+        table.add_column("Qualified Name & GUID", no_wrap=True)
+
+        unsorted_server_list = p_client.get_servers_by_dep_impl_type(filter)
+        if type(unsorted_server_list) is str:
+            print("No matching Software Servers found?")
+            sys.exit(1)
+        server_list = sorted(
+            unsorted_server_list,
+            key=lambda x: x["properties"].get("displayName", "---").lower(),
+        )
+
+        for server in server_list:
+            display_name = server["properties"].get("displayName", "---")
+            qualified_name = server["properties"].get("qualifiedName", "---")
+            classifications = server["elementHeader"].get("classifications", None)
+            zones = ""
+            if classifications:
+                for clas in classifications:
+                    if clas["classificationName"] == "AssetZoneMembership":
+                        classification_props = clas["classificationProperties"]
+                        zone_membership = classification_props.get(
+                            "zoneMembership", None
+                        )
+                        if zone_membership:
+                            for z in zone_membership.keys():
+                                zones += f"{zone_membership[z]}, "
+                            zones = zones[:-2]
+
+            impl_type = server["properties"].get("deployedImplementationType", "---")
+            server_guid = server["elementHeader"]["guid"]
+            server_desc = server["properties"].get("resourceDescription", "---")
+
+            server_id = Text(f"{qualified_name}\n&\n{server_guid}", justify="center")
+
+            table.add_row(display_name, impl_type, zones, server_desc, server_id)
+
+        return table
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        with console.pager(styles=True):
+            console.print(generate_table())
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+    except KeyboardInterrupt:
+        pass
+    finally:
+        p_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="User Password")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_ADMIN_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+    filter = Prompt.ask(
+        "Filter deployed for deployed implementation type by search string", default="*"
+    )
+    display_servers_by_dep_imp(filter, server, url, userid, user_pass)
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/cat/list_tech_type_elements.py

@@ -0,0 +1,190 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Display the status of cataloged platforms and servers.
+"""
+import argparse
+import os
+import sys
+import time
+
+import rich.box as box
+from rich import print
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    AutomatedCuration,
+)
+
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+disable_ssl_warnings = True
+console = Console(width=200)
+
+guid_list = []
+
+
+def list_tech_elements(
+    tech_name: str,
+    server_name: str,
+    platform_url: str,
+    user: str,
+    user_pass: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    console = Console(width=width, force_terminal=not jupyter)
+
+    a_client = AutomatedCuration(server_name, platform_url, user_id=user)
+    token = a_client.create_egeria_bearer_token(user, user_pass)
+
+    def build_classifications(classification: dict) -> Markdown:
+        class_md = "\n"
+        for c in classification:
+            c_type = c["classificationName"]
+            if c_type == "Anchors":
+                continue
+            class_md += f"* Classification: {c_type}\n"
+            class_props = c.get("classificationProperties", None)
+            if class_props is None:
+                continue
+            for prop in class_props.keys():
+                class_md += f"\t* {prop}: {class_props[prop]}\n"
+        if class_md == "-":
+            output = None
+        else:
+            output = class_md
+        return output
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Tech Type Elements for {tech_name} @ {time.asctime()}",
+            caption=f"{platform_url} - {server_name} @ {time.asctime()}",
+            style="bold bright_white on black",
+            row_styles=["bold bright_white on black"],
+            header_style="white on dark_blue",
+            title_style="bold bright_white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            expand=True,
+        )
+
+        table.add_column("Qualified Name/GUID", width=38, no_wrap=True)
+        table.add_column("Properties", width=40)
+        table.add_column("Classifications", width=50)
+
+        tech_elements = a_client.get_technology_type_elements(
+            tech_name, get_templates=False
+        )
+        if type(tech_elements) is str:
+            console.print(f"No elements found for {tech_name}")
+            sys.exit(1)
+
+        note: str = " "
+        for element in tech_elements:
+            header = element["elementHeader"]
+            tech_type = header["type"]["typeName"]
+            tech_collection = header["origin"]["homeMetadataCollectionName"]
+            tech_created_by = header["versions"]["createdBy"]
+            tech_created_at = header["versions"]["createTime"]
+            tech_guid = header["guid"]
+            tech_classifications = header["classifications"]
+            class_md = build_classifications(tech_classifications)
+
+            referenceables = element["referenceableProperties"]
+            tech_qualified_name = referenceables["qualifiedName"]
+            extended = referenceables["extendedProperties"]
+            ex_md: str = ""
+            for key, value in extended.items():
+                ex_md += f"* {key}: {value}\n"
+
+            note = (
+                f"{ex_md}\n"
+                f"* Created by: {tech_created_by}\n"
+                f"* Created at: {tech_created_at}\n"
+                f"* Home Collection: {tech_collection}\n"
+            )
+
+            interfaces = extended.get("connectorInterfaces", None)
+            if interfaces is not None:
+                interface_type_name = interfaces["typeName"]
+                interface_array_cnt = interfaces["arrayCount"]
+                note += f"* Interface Type: {interface_type_name}\n"
+                for i in range(0, int(interface_array_cnt)):
+                    note += (
+                        f"\t* Type: {interfaces['arrayValues']['propertyValueMap'][str(i)]['typeName']}"
+                        f"\tName: {interfaces['arrayValues']['propertiesAsStrings'][str(i)]}\n"
+                    )
+            note_md = Markdown(note)
+            qn = Markdown(f"\n{tech_qualified_name}\n \n--- \n\n\n{tech_guid}")
+            cm = Markdown(class_md)
+            table.add_row(qn, note_md, cm)
+        return table
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        with console.pager(styles=True):
+            console.print(generate_table())
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+        print("\n\nPerhaps the type name isn't known")
+    finally:
+        a_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="User Password")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+    try:
+        tech_name = Prompt.ask(
+            "Enter the tech type to view:", default="PostgreSQL Server"
+        )
+        list_tech_elements(tech_name, server, url, userid, user_pass)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()