pyegeria 5.4.0.23__py3-none-any.whl → 5.4.0.24__py3-none-any.whl

md_processing/md_commands/governance_officer_commands.py

@@ -3,24 +3,28 @@ This file contains term-related object_action functions for processing Egeria Ma
 """
 import json
 import os
-import sys
-
 from typing import Optional
 
+from inflect import engine
+from jsonschema import ValidationError
 from loguru import logger
+from md_processing.md_processing_utils.common_md_proc_utils import (parse_upsert_command, parse_view_command,
+                                                                    process_output_command)
+from md_processing.md_processing_utils.common_md_utils import (set_gov_prop_body,
+                                                               set_update_body, set_create_body,
+                                                               set_peer_gov_def_request_body, setup_log,
+                                                               ALL_GOVERNANCE_DEFINITIONS, GOVERNANCE_POLICIES,
+                                                               GOVERNANCE_CONTROLS, GOVERNANCE_DRIVERS,
+                                                               set_find_body,
+                                                               set_delete_request_body)
+from md_processing.md_processing_utils.extraction_utils import (extract_command_plus, update_a_command)
+from md_processing.md_processing_utils.md_processing_constants import (load_commands)
+from pyegeria import DEBUG_LEVEL, body_slimmer, PyegeriaException, print_basic_exception, print_validation_error
+from pyegeria.egeria_tech_client import EgeriaTech
 from rich import print
 from rich.console import Console
 from rich.markdown import Markdown
 
-from md_processing.md_processing_utils.common_md_proc_utils import (parse_upsert_command, parse_view_command)
-from md_processing.md_processing_utils.common_md_utils import (update_element_dictionary, set_gov_prop_body, \
-    set_update_body, set_create_body, set_peer_gov_def_request_body, set_rel_request_body,
-    set_metadata_source_request_body, set_filter_request_body, setup_log)
-from md_processing.md_processing_utils.extraction_utils import (extract_command_plus, update_a_command)
-from md_processing.md_processing_utils.md_processing_constants import (load_commands, ERROR)
-from pyegeria import DEBUG_LEVEL, body_slimmer
-from pyegeria.egeria_tech_client import EgeriaTech
-
 GERIA_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")
@@ -52,53 +56,156 @@ debug_level = DEBUG_LEVEL
 console = Console(width=int(200))
 setup_log()
 
+
 #
 # Helper functions for the governance officer commands
 #
 
 @logger.catch
-def sync_gov_rel_elements(egeria_client: EgeriaTech, object_action:str, object_type:str, guid:str, qualified_name:str, attributes: dict):
-# TODO: when the next release is available, I should be able to more easily get the asis elements - so will
-# TODO: hold off on implementing replace all
+def sync_gov_rel_elements(egeria_client: EgeriaTech, object_action: str, object_type: str, guid: str,
+                          qualified_name: str, attributes: dict):
+    # TODO: when the next release is available, I should be able to more easily get the asis elements - so will
+    # TODO: hold off on implementing replace all
     try:
-        merge_update = attributes.get("Merge Update", {}).get("value",True)
-        to_be_supports_policies = attributes.get("Supports Policies", {}).get("guid_list",None)
-        to_be_governance_drivers = attributes.get("Governance Drivers", {}).get("guid_list",None)
+        merge_update = attributes.get("Merge Update", {}).get("value", True)
+        to_be_supports_policies = attributes.get("Supports Policies", {}).get("guid_list", None)
+        to_be_governance_drivers = attributes.get("Governance Drivers", {}).get("guid_list", None)
 
         if merge_update or object_action == "Create":
             if to_be_supports_policies:
                 for policy in to_be_supports_policies:
-                    egeria_client.attach_supporting_definitions(policy, "GovernanceImplementation",guid)
+                    egeria_client.attach_supporting_definitions(policy, "GovernanceImplementation", guid)
                     print(f"Added `{policy}` to `{guid}`")
             elif to_be_governance_drivers:
                 for policy in to_be_governance_drivers:
-                    egeria_client.attach_supporting_definitions(policy, "GovernanceResponse",guid)
+                    egeria_client.attach_supporting_definitions(policy, "GovernanceResponse", guid)
                     print(f"Added `{policy}` to `{guid}`")
     except Exception as ex:
         print(ex)
 
+
 @logger.catch
-def process_gov_definition_upsert_command(egeria_client: EgeriaTech, txt: str, directive: str = "display") -> Optional[str]:
+def process_gov_definition_upsert_command(egeria_client: EgeriaTech, txt: str, directive: str = "display") -> Optional[
+    str]:
+    """
+    Processes a data specification create or update object_action by extracting key attributes.
+
+    :param txt: Command details in text format.
+    :param directive: An optional string indicating the directive - display, validate, or process.
+    :return: A string summarizing the outcome, or None if no processing is needed.
     """
-    Processes a data specification create or update object_action by extracting key attributes such as
-    spec name, parent_guid, parent_relationship_type, parent_at_end_1, category
+    try:
+        # Extract basic command information
+        command, object_type, object_action = extract_command_plus(txt)
+        if not (command and object_type and object_action):
+            logger.error("Failed to parse `command`, `object_type`, or `object_action` from input text.")
+            return None
+        if object_type not in ALL_GOVERNANCE_DEFINITIONS:
+            logger.error(f"Invalid object type: {object_type}")
+            return None
+        # Log command details
+        print(Markdown(f"# {command}\n"))
+
+        # Parse command attributes
+        parsed_output = parse_upsert_command(egeria_client, object_type, object_action, txt, directive)
+        if not parsed_output or 'valid' not in parsed_output:
+            logger.error(f"Unable to parse command properly: {txt}")
+            return None
+
+        valid = parsed_output['valid']
+        exists = parsed_output['exists']
+        qualified_name = parsed_output.get('qualified_name')
+        display_name = parsed_output.get('attributes', {}).get('Display Name', {}).get('value')
+        guid = parsed_output.get('guid')
+
+        print(Markdown(parsed_output.get('display', '')))
+        logger.debug(json.dumps(parsed_output, indent=4))
+
+        if directive == "display":
+            logger.info("Directive set to display. No processing required.")
+            return None
+
+        elif directive == "validate":
+            if valid:
+                print(Markdown(f"==> Validation of {command} completed successfully!\n"))
+            else:
+                logger.error(f"Validation failed for `{command}`.")
+            return valid
+
+        elif directive == "process":
+            if object_action == "Update":
+                if not guid:
+                    msg = (f"The `{object_type}` '{display_name}' does not yet exist.\n The result document has been "
+                           f"updated to change `Update` to `Create` in processed output\n{'-' * 80}\n ")
+                    logger.error(msg)
+                    # print(msg)
+                    return update_a_command(txt, object_action, object_type, qualified_name, guid)
+
+                if not valid:
+                    logger.error("Invalid data for update action.")
+                    return None
+
+                # Proceed with the update
+                update_body = set_update_body(object_type, parsed_output['attributes'])
+                update_body['properties'] = set_gov_prop_body(object_type, qualified_name, parsed_output['attributes'])
+                egeria_client.update_governance_definition(guid, body_slimmer(update_body))
+                if status := parsed_output['attributes'].get('Status', {}).get('value', None):
+                    egeria_client.update_governance_definition_status(guid, status)
+                logger.success(f"Updated {object_type} `{display_name}` with GUID {guid}")
+                return egeria_client.get_governance_definition_by_guid(guid, output_format='MD')
+
+            elif object_action == "Create":
+                if valid is False and exists:
+                    msg = (f"Failed to create `{object_type}` named `{display_name}` because it already exists.\n "
+                           f"Result document has been updated to change `Create` to `Update` in processed o"
+                           f"utput\n{'-' * 80}\n")
+                    logger.error(msg)
+                    return update_a_command(txt, object_action, object_type, qualified_name, guid)
+                elif valid is False:
+                    msg = f" invalid data? - Correct and try again\n\n___"
+                    logger.error(msg)
+                    return None
+                else:
+                    create_body = set_create_body(object_type, parsed_output['attributes'])
+                    create_body['properties'] = set_gov_prop_body(object_type, qualified_name,
+                                                                  parsed_output['attributes'])
+                    guid = egeria_client.create_governance_definition(body_slimmer(create_body))
+                    if guid:
+                        logger.success(f"Created {object_type} `{display_name}` with GUID {guid}")
+                        return egeria_client.get_governance_definition_by_guid(guid, output_format='MD')
+                    else:
+                        logger.error(f"Failed to create {object_type} `{display_name}`.")
+                        return None
+
+        else:
+            logger.error(f"Unsupported directive: {directive}")
+            return None
+
+    except PyegeriaException as e:
+        logger.error(f"PyegeriaException occurred: {e}")
+        print_basic_exception(e)
+        return None
+
+    except Exception as e:
+        logger.exception(f"Unexpected error: {e}")
+        return None
+
+
+@logger.catch
+def process_gov_def_link_detach_command(egeria_client: EgeriaTech, txt: str,
+                                        directive: str = "display") -> Optional[str]:
+    """
+    Processes a link or unlink command to associate or break up peer governance definitions.
 
     :param txt: A string representing the input cell to be processed for
-        extracting glossary-related attributes.
+        extracting blueprint-related attributes.
     :param directive: an optional string indicating the directive to be used - display, validate or execute
     :return: A string summarizing the outcome of the processing.
     """
-
     command, object_type, object_action = extract_command_plus(txt)
     print(Markdown(f"# {command}\n"))
-    parsed_output = parse_upsert_command(egeria_client, object_type, object_action, txt, directive)
-
 
-    valid = parsed_output['valid']
-    exists = parsed_output['exists']
-    qualified_name = parsed_output.get('qualified_name', None)
-    display_name = parsed_output.get('display_name', None)
-    guid = parsed_output.get('guid', None)
+    parsed_output = parse_view_command(egeria_client, object_type, object_action, txt, directive)
 
     print(Markdown(parsed_output['display']))
 
@@ -106,10 +213,13 @@ def process_gov_definition_upsert_command(egeria_client: EgeriaTech, txt: str, d
 
     attributes = parsed_output['attributes']
 
-    display_name = attributes['Display Name'].get('value', None)
-
-    replace_all_props = not attributes.get('Merge Update', {}).get('value', True)
+    definition1 = attributes.get('Definition 1', {}).get('guid', None)
+    definition2 = attributes.get('Definition 2', {}).get('guid', None)
+    label = attributes.get('Link Label', {}).get('value', None)
+    description = attributes.get('Description', {}).get('value', None)
 
+    valid = parsed_output['valid']
+    exists = definition1 is not None and definition2 is not None
 
     if directive == "display":
 
@@ -122,73 +232,87 @@ def process_gov_definition_upsert_command(egeria_client: EgeriaTech, txt: str, d
         return valid
 
     elif directive == "process":
+        # Initialize the inflect engine
+        inflector = engine()
 
-        try:
-            if object_action == "Update":
-                if not exists:
-                    msg = (f" Element `{display_name}` does not exist! Updating result document with Create "
-                           f"object_action\n")
-                    logger.error(msg)
-                    return update_a_command(txt, object_action, object_type, qualified_name, guid)
-                elif not valid:
-                    return None
-                else:
-                    print(Markdown(
-                        f"==> Validation of {command} completed successfully! Proceeding to apply the changes.\n"))
-                update_body = set_update_body(object_type, attributes)
-                update_body['properties'] = set_gov_prop_body(object_type, qualified_name, attributes)
-
-                egeria_client.update_governance_definition(guid, update_body, replace_all_props)
-                logger.success(f"Updated  {object_type} `{display_name}` with GUID {guid}\n\n___")
-                update_element_dictionary(qualified_name, {
-                    'guid': guid, 'display_name': display_name
-                    })
-                sync_gov_rel_elements(egeria_client,object_type, object_type,guid, qualified_name, attributes)
-                return egeria_client.get_governance_definition_by_guid(guid, output_format='MD')
+        # Split the object_type into words
+        object_type_parts = object_type.split()
 
+        # Determine which word to singularize (third word if present, otherwise fallback to last word)
+        if len(object_type_parts) >= 3:
+            word_to_singularize = object_type_parts[2]
+        else:
+            word_to_singularize = object_type_parts[-1]  # Fallback to last word
 
-            elif object_action == "Create":
-                if valid is False and exists:
-                    msg = (f"  Data Specification `{display_name}` already exists and result document updated changing "
-                           f"`Create` to `Update` in processed output\n\n___")
-                    logger.error(msg)
-                    return update_a_command(txt, object_action, object_type, qualified_name, guid)
-                # elif valid is False and in_data_spec_valid is False:
-                #     msg = (f" Invalid data specification(s) `{in_data_spec_list}` "
-                #            f" invalid data? - Correct and try again\n\n___")
-                #     logger.error(msg)
-                #     return None
-                else:
-                    create_body = set_create_body(object_type, attributes)
-                    create_body['properties'] = set_gov_prop_body(object_type, qualified_name,attributes)
-                    guid = egeria_client.create_governance_definition(create_body)
-                    if guid:
-                        update_element_dictionary(qualified_name, {
-                            'guid': guid, 'display_name': display_name
-                            })
-                        sync_gov_rel_elements(egeria_client, object_action,
-                                              object_type, guid, qualified_name,
-                                              attributes)
-
-                        msg = f"Created Element `{display_name}` with GUID {guid}\n\n___"
-                        logger.success(msg)
-                        return egeria_client.get_governance_definition_by_guid(guid, output_format='MD')
-                    else:
-                        msg = f"Failed to create element `{display_name}` with GUID {guid}\n\n___"
-                        logger.error(msg)
-                        return None
+        # Singularize the selected word
+        singular_word = inflector.singular_noun(word_to_singularize) or word_to_singularize
 
-        except Exception as e:
-            logger.error(f"Error performing {command}: {e}")
-            return None
-    else:
+        # Construct gov_peer_relationship_type
+        gov_peer_relationship_type = f"Governance{singular_word}Link"
+
+    try:
+        if object_action == "Detach":
+            if not exists:
+                msg = (f" Link `{label}` does not exist! Updating result document with Link "
+                       f"object_action\n")
+                logger.error(msg)
+                out = parsed_output['display'].replace('Link', 'Detach', 1)
+                return out
+            elif not valid:
+                return None
+            else:
+                print(Markdown(
+                    f"==> Validation of {command} completed successfully! Proceeding to apply the changes.\n"))
+                body = set_delete_request_body(object_type, attributes)
+
+            egeria_client.detach_peer_definitions(definition1, gov_peer_relationship_type,
+                                                  definition2, body)
+
+            logger.success(f"===> Detached segment with {label} from `{definition1}`to {definition2}\n")
+            out = parsed_output['display'].replace('Unlink', 'Link', 1)
+
+            return (out)
+
+
+        elif object_action == "Link":
+            if valid is False and exists:
+                msg = (f"-->  Link called `{label}` already exists and result document updated changing "
+                       f"`Link` to `Detach` in processed output\n")
+                logger.error(msg)
+
+            elif valid is False:
+                msg = f"==>{object_type} Link with label `{label}` is not valid and can't be created"
+                logger.error(msg)
+                return
+
+            else:
+                body = set_peer_gov_def_request_body(object_type, attributes)
+                egeria_client.link_peer_definitions(definition1, gov_peer_relationship_type,
+                                                    definition2, body)
+                msg = f"==>Created {object_type} link named `{label}`\n"
+                logger.success(msg)
+                out = parsed_output['display'].replace('Link', 'Detach', 1)
+                return out
+
+    except ValidationError as e:
+        print_validation_error(e)
+        logger.error(f"Validation Error performing {command}: {e}")
+        return None
+    except PyegeriaException as e:
+        print_basic_exception(e)
+        logger.error(f"PyegeriaException occurred: {e}")
         return None
 
+    except Exception as e:
+        logger.error(f"Error performing {command}: {e}")
+        return None
+    else:
+        return None
 
 
 @logger.catch
-def process_gov_def_link_detach_command(egeria_client: EgeriaTech, txt: str,
-                                        directive: str = "display") -> Optional[str]:
+def process_supporting_gov_def_link_detach_command(egeria_client: EgeriaTech, txt: str,
+                                                   directive: str = "display") -> Optional[str]:
     """
     Processes a link or unlink command to associate or break up peer governance definitions.
 
@@ -214,8 +338,7 @@ def process_gov_def_link_detach_command(egeria_client: EgeriaTech, txt: str,
     description = attributes.get('Description', {}).get('value', None)
 
     valid = parsed_output['valid']
-    exists = definition1 is not None and  definition2 is not None
-
+    exists = definition1 is not None and definition2 is not None
 
     if directive == "display":
 
@@ -228,64 +351,81 @@ def process_gov_def_link_detach_command(egeria_client: EgeriaTech, txt: str,
         return valid
 
     elif directive == "process":
-        gov_peer_relationship_type = object_type[:-1].replace(" ","") + "Link"
-
-        try:
-            if object_action == "Detach":
-                if not exists:
-                    msg = (f" Link `{label}` does not exist! Updating result document with Link "
-                           f"object_action\n")
-                    logger.error(msg)
-                    out = parsed_output['display'].replace('Link', 'Detach', 1)
-                    return out
-                elif not valid:
-                    return None
-                else:
-                    print(Markdown(
-                        f"==> Validation of {command} completed successfully! Proceeding to apply the changes.\n"))
-                    body = set_metadata_source_request_body(object_type, attributes)
-
-                egeria_client._async_detach_peer_definitions(definition1, gov_peer_relationship_type,
-                                                             definition2,body)
 
-                logger.success(f"===> Detached segment with {label} from `{definition1}`to {definition2}\n")
-                out = parsed_output['display'].replace('Unlink', 'Link', 1)
+        # Construct gov_peer_relationship_type
+        relationship_type_name = object_type.replace(' ', '')
+        print(f"relationship_type_name: {relationship_type_name}")
+    try:
+        if object_action == "Detach":
+            if not exists:
+                msg = (f" Link `{label}` does not exist! Updating result document with Link "
+                       f"object_action\n")
+                logger.error(msg)
+                out = parsed_output['display'].replace('Link', 'Detach', 1)
+                return out
+            elif not valid:
+                return None
+            else:
+                print(Markdown(
+                    f"==> Validation of {command} completed successfully! Proceeding to apply the changes.\n"))
+                body = set_delete_request_body(object_type, attributes)
 
-                return (out)
+            egeria_client.detach_supporting_definitions(definition1, relationship_type_name,
+                                                        definition2, body)
 
+            logger.success(f"===> Detached segment with {label} from `{definition1}`to {definition2}\n")
+            out = parsed_output['display'].replace('Unlink', 'Link', 1)
 
-            elif object_action == "Link":
-                if valid is False and exists:
-                    msg = (f"-->  Link called `{label}` already exists and result document updated changing "
-                           f"`Link` to `Detach` in processed output\n")
-                    logger.error(msg)
+            return (out)
 
-                elif valid is False:
-                    msg = f"==>{object_type} Link with label `{label}` is not valid and can't be created"
-                    logger.error(msg)
-                    return
 
-                else:
-                    body = set_peer_gov_def_request_body(object_type, attributes)
+        elif object_action == "Link":
+            if valid is False and exists:
+                msg = (f"-->  Link called `{label}` already exists and result document updated changing "
+                       f"`Link` to `Detach` in processed output\n")
+                logger.error(msg)
 
-                    egeria_client.link_peer_definitions(definition1, gov_peer_relationship_type,
-                                                        definition2, body)
-                    msg = f"==>Created {object_type} link named `{label}`\n"
-                    logger.success(msg)
-                    out = parsed_output['display'].replace('Link', 'Detach', 1)
-                    return out
+            elif valid is False:
+                msg = f"==>{object_type} Link with label `{label}` is not valid and can't be created"
+                logger.error(msg)
+                return
 
+            else:
+                body_prop = {
+                    "class": "SupportingDefinitionProperties",
+                    "rationale": attributes.get('Rationale', {}).get('value', None),
+                    "effectiveFrom": attributes.get('Effective From', {}).get('value', None),
+                    "effectiveTo": attributes.get('Effective To', {}).get('value', None),
+                    }
+
+                body = set_peer_gov_def_request_body(object_type, attributes)
+                body['properties'] = body_prop
+                egeria_client.attach_supporting_definitions(definition1, relationship_type_name,
+                                                            definition2, body)
+                msg = f"==>Created {object_type} link named `{label}`\n"
+                logger.success(msg)
+                out = parsed_output['display'].replace('Link', 'Detach', 1)
+                return out
+
+    except ValidationError as e:
+        print_validation_error(e)
+        logger.error(f"Validation Error performing {command}: {e}")
+        return None
+    except PyegeriaException as e:
+        print_basic_exception(e)
+        logger.error(f"PyegeriaException occurred: {e}")
+        return None
 
-        except Exception as e:
-            logger.error(f"Error performing {command}: {e}")
-            return None
+    except Exception as e:
+        logger.error(f"Error performing {command}: {e}")
+        return None
     else:
         return None
 
 
 @logger.catch
 def process_gov_definition_list_command(egeria_client: EgeriaTech, txt: str,
-                                         directive: str = "display") -> Optional[str]:
+                                        directive: str = "display") -> Optional[str]:
     """
     Processes a Governance Definition  list object_action by extracting key attributes such as
      search string from the given text.
@@ -295,24 +435,25 @@ def process_gov_definition_list_command(egeria_client: EgeriaTech, txt: str,
     :param directive: an optional string indicating the directive to be used - display, validate or execute
     :return: A string summarizing the outcome of the processing.
     """
+    if True:
+        return process_output_command(egeria_client, txt, directive)
+
     command, object_type, object_action = extract_command_plus(txt)
     print(Markdown(f"# {command}\n"))
 
     parsed_output = parse_view_command(egeria_client, object_type, object_action, txt, directive)
 
-
-
     valid = parsed_output['valid']
     print(Markdown(f"Performing {command}"))
     print(Markdown(parsed_output['display']))
 
-    attr = parsed_output.get('attributes',{})
+    attr = parsed_output.get('attributes', {})
 
     search_string = attr.get('Search String', {}).get('value', '*')
     output_format = attr.get('Output Format', {}).get('value', 'LIST')
+    output_format_set = attr.get('Output Format Set', {}).get('value', object_type)
     detailed = attr.get('Detailed', {}).get('value', False)
 
-
     if directive == "display":
         return None
     elif directive == "validate":
@@ -331,11 +472,13 @@ def process_gov_definition_list_command(egeria_client: EgeriaTech, txt: str,
                 return None
 
             list_md = f"\n# `{object_type}` with filter: `{search_string}`\n\n"
-            body = set_update_body(object_type, attr)
+            body = set_find_body(object_type, attr)
 
             struct = egeria_client.find_governance_definitions(search_string,
-                                                                       body = body,
-                                                                      output_format=output_format)
+                                                               body=body,
+                                                               output_format=output_format,
+                                                               output_format_set=output_format_set,
+                                                               )
             if output_format.upper() == "DICT":
                 list_md += f"```\n{json.dumps(struct, indent=4)}\n```\n"
             else:
@@ -351,9 +494,10 @@ def process_gov_definition_list_command(egeria_client: EgeriaTech, txt: str,
     else:
         return None
 
+
 @logger.catch
 def process_gov_def_context_command(egeria_client: EgeriaTech, txt: str,
-                                         directive: str = "display") -> Optional[str]:
+                                    directive: str = "display") -> Optional[str]:
     """
     Retrieves the context graph for a governance definition.
 
@@ -375,12 +519,11 @@ def process_gov_def_context_command(egeria_client: EgeriaTech, txt: str,
 
     print(Markdown(parsed_output['display']))
 
-    attr = parsed_output.get('attributes',{})
+    attr = parsed_output.get('attributes', {})
 
     output_format = attr.get('Output Format', {}).get('value', 'LIST')
     detailed = attr.get('Detailed', {}).get('value', False)
 
-
     if directive == "display":
         return None
     elif directive == "validate":
@@ -401,7 +544,7 @@ def process_gov_def_context_command(egeria_client: EgeriaTech, txt: str,
             list_md = f"\n# `{object_type}` with Qualified Name: `{qualified_name}`\n\n"
             body = set_update_body(object_type, attr)
 
-            struct = egeria_client.get_gov_def_in_context(guid, body = body, output_format=output_format)
+            struct = egeria_client.get_gov_def_in_context(guid, body=body, output_format=output_format)
             if output_format.upper() == "DICT":
                 list_md += f"```\n{json.dumps(struct, indent=4)}\n```\n"
             else:
@@ -416,5 +559,3 @@ def process_gov_def_context_command(egeria_client: EgeriaTech, txt: str,
             return None
     else:
         return None
-
-