pyxecm 2.0.4__py3-none-any.whl → 3.0.0__py3-none-any.whl

{pyxecm/customizer → pyxecm_customizer}/customizer.py

@@ -11,21 +11,22 @@ import os
 import sys
 import tempfile
 import time
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 
 import requests
 
 # OpenText specific modules:
 import yaml
 from pydantic import HttpUrl
-
 from pyxecm import AVTS, OTAC, OTAWP, OTCA, OTCS, OTDS, OTIV, OTKD, OTPD, CoreShare
-from pyxecm.customizer.k8s import K8s
-from pyxecm.customizer.m365 import M365
-from pyxecm.customizer.payload import Payload
-from pyxecm.customizer.settings import Settings
+from pyxecm.helper.otel_config import tracer
+
+from .k8s import K8s
+from .m365 import M365
+from .payload import Payload
+from .settings import Settings
 
-default_logger = logging.getLogger("pyxecm.customizer")
+default_logger = logging.getLogger("pyxecm_customizer")
 
 
 class Customizer:
@@ -410,11 +411,23 @@ class Customizer:
             self.settings.aviator.oauth_secret,
         )
 
+        content_system = None
+
+        # Read the Content_System from the ConfigMaps - This controls the authentication system for OTCA
+        if self.k8s_object:
+            content_system = {}
+            for service in ["chat", "embed"]:
+                cm = self.k8s_object.get_config_map(f"csai-{service}-svc")
+                if cm:
+                    content_system[service] = cm.data.get("CONTENT_SYSTEM", "none")
+
         return OTCA(
             chat_url=str(self.settings.aviator.chat_svc_url),
             embed_url=str(self.settings.aviator.embed_svc_url),
+            studio_url=str(self.settings.aviator.studio_url),
             client_id=self.settings.avts.client_id,
             client_secret=self.settings.avts.client_secret,
+            content_system=content_system,
             otds_url=str(self.settings.otds.url),
             otcs_object=self.otcs_backend_object,
             logger=self.logger,
@@ -819,7 +832,7 @@ class Customizer:
 
         """
 
-        self.logger.info("Connection parameters OTCS (Extended ECM):")
+        self.logger.info("Connection parameters OTCS:")
         self.logger.info("OTCS URL                   = %s", str(self.settings.otcs.url))
         self.logger.info(
             "OTCS Frontend URL          = %s",
@@ -921,7 +934,7 @@ class Customizer:
             )
             otcs_resource["logoutMethod"] = "GET"
 
-            self.otds_object.update_resource(name="cs", resource=otcs_resource)
+            self.otds_object.update_resource(name=self.settings.otcs.resource_name, resource=otcs_resource)
 
         # Allow impersonation of the resource for all users:
         self.otds_object.impersonate_resource(self.settings.otcs.resource_name)
@@ -1136,7 +1149,7 @@ class Customizer:
         self.logger.info("Found Content Server OTDS resource ID -> %s", otcs_resource_id)
 
         # make sure code is idempotent and only try to add ressource if it doesn't exist already:
-        awp_resource = self.otds_object.get_resource(self.settings.otawp.resource_name)
+        awp_resource = self.otds_object.get_resource(name=self.settings.otawp.resource_name)
         if not awp_resource:
             self.logger.info(
                 "OTDS resource -> '%s' for AppWorks Platform does not yet exist. Creating...",
@@ -1331,6 +1344,41 @@ class Customizer:
 
         self.logger.info("Restart OTCS frontend and backend pods...")
 
+        # Get number of replicas or update it for da as it might change with dynamic scaling:
+        otcs_da_scale = self.k8s_object.get_stateful_set_scale(
+            sts_name=self.settings.k8s.sts_otcs_da,
+        )
+        if not otcs_da_scale:
+            self.logger.warning(
+                "Cannot find Kubernetes Stateful Set -> '%s' for OTCS DA!",
+                self.settings.k8s.sts_otcs_da,
+            )
+            self.settings.k8s.sts_otcs_da_replicas = 0
+        else:
+            self.settings.k8s.sts_otcs_da_replicas = otcs_da_scale.spec.replicas
+
+        # Restart all da:
+        for x in range(self.settings.k8s.sts_otcs_da_replicas):
+            pod_name = self.settings.k8s.sts_otcs_da + "-" + str(x)
+
+            self.logger.info("Deactivate Liveness probe for pod -> '%s'", pod_name)
+            self.k8s_object.exec_pod_command(
+                pod_name,
+                ["/bin/sh", "-c", "touch /tmp/keepalive"],
+                container="otcs-da-container",
+            )
+            self.logger.info("Restarting OTCS in pod -> '%s'", pod_name)
+            self.k8s_object.exec_pod_command(
+                pod_name,
+                ["/bin/sh", "-c", "/opt/opentext/cs/stop_csserver"],
+                container="otcs-da-container",
+            )
+            self.k8s_object.exec_pod_command(
+                pod_name,
+                ["/bin/sh", "-c", "/opt/opentext/cs/start_csserver"],
+                container="otcs-da-container",
+            )
+
         # Get number of replicas or update it for frontends as it might change with dynamic scaling:
         otcs_frontend_scale = self.k8s_object.get_stateful_set_scale(
             sts_name=self.settings.k8s.sts_otcs_frontend,
@@ -1340,8 +1388,9 @@ class Customizer:
                 "Cannot find Kubernetes Stateful Set -> '%s' for OTCS Frontends!",
                 self.settings.k8s.sts_otcs_frontend,
             )
-
-        self.settings.k8s.sts_otcs_frontend_replicas = otcs_frontend_scale.spec.replicas
+            self.settings.k8s.sts_otcs_frontend_replicas = 0
+        else:
+            self.settings.k8s.sts_otcs_frontend_replicas = otcs_frontend_scale.spec.replicas
 
         # Restart all frontends:
         for x in range(self.settings.k8s.sts_otcs_frontend_replicas):
@@ -1577,6 +1626,7 @@ class Customizer:
 
     # end method definition
 
+    @tracer.start_as_current_span("init_customizer")
     def init_customizer(self) -> bool:
         """Initialize all objects used by the customizer.
 
@@ -1734,13 +1784,14 @@ class Customizer:
 
     # end method definition
 
+    @tracer.start_as_current_span("customization_run")
     def customization_run(self) -> bool:
         """Central method to initiate the customization."""
 
         success = True
 
         # Set Timer for duration calculation
-        self.customizer_start_time = datetime.now(timezone.utc)
+        self.customizer_start_time = datetime.now(UTC)
 
         if not self.init_customizer():
             self.logger.error("Initialization of customizer failed!")
@@ -1789,122 +1840,133 @@ class Customizer:
             )
 
         for cust_payload in cust_payload_list:
-            self.log_header("Start processing of payload -> '{}'".format(cust_payload))
-
-            # Set startTime for duration calculation
-            start_time = datetime.now(timezone.utc)
-
-            # Create payload object:
-            payload_object = Payload(
-                payload_source=cust_payload,
-                custom_settings_dir=self.settings.cust_settings_dir,
-                k8s_object=self.k8s_object,
-                otds_object=self.otds_object,
-                otac_object=self.otac_object,
-                otcs_backend_object=self.otcs_backend_object,
-                otcs_frontend_object=self.otcs_frontend_object,
-                otcs_restart_callback=self.restart_otcs_service,
-                otiv_object=self.otiv_object,
-                otpd_object=self.otpd_object,
-                m365_object=self.m365_object,
-                core_share_object=self.core_share_object,
-                browser_headless=self.settings.headless_browser,
-                placeholder_values=self.settings.placeholder_values,  # this dict includes placeholder replacements for the Ressource IDs of OTAWP and OTCS
-                log_header_callback=self.log_header,
-                stop_on_error=self.settings.stop_on_error,
-                aviator_enabled=self.settings.aviator.enabled,
-                upload_status_files=self.settings.otcs.upload_status_files,
-                otawp_object=self.otawp_object,
-                otca_object=self.otca_object,
-                otkd_object=self.otkd_object,
-                avts_object=self.avts_object,
-                logger=self.logger,
-            )
-            # Load the payload file and initialize the payload sections:
-            if not payload_object.init_payload():
-                self.logger.error(
-                    "Failed to initialize payload -> '%s' - skipping payload file...",
-                    cust_payload,
+            with tracer.start_as_current_span("customizer_run_payload") as t:
+                t.set_attributes(
+                    {
+                        "payload": cust_payload,
+                    }
+                )
+                self.log_header("Start processing of payload -> '{}'".format(cust_payload))
+
+                # Set startTime for duration calculation
+                start_time = datetime.now(UTC)
+
+                # Create payload object:
+                payload_object = Payload(
+                    payload_source=cust_payload,
+                    custom_settings_dir=self.settings.cust_settings_dir,
+                    k8s_object=self.k8s_object,
+                    otds_object=self.otds_object,
+                    otac_object=self.otac_object,
+                    otcs_backend_object=self.otcs_backend_object,
+                    otcs_frontend_object=self.otcs_frontend_object,
+                    otcs_restart_callback=self.restart_otcs_service,
+                    otiv_object=self.otiv_object,
+                    otpd_object=self.otpd_object,
+                    m365_object=self.m365_object,
+                    core_share_object=self.core_share_object,
+                    browser_headless=self.settings.headless_browser,
+                    placeholder_values=self.settings.placeholder_values,  # this dict includes placeholder replacements for the Ressource IDs of OTAWP and OTCS
+                    log_header_callback=self.log_header,
+                    stop_on_error=self.settings.stop_on_error,
+                    aviator_enabled=self.settings.aviator.enabled,
+                    upload_status_files=self.settings.otcs.upload_status_files,
+                    otawp_object=self.otawp_object,
+                    otca_object=self.otca_object,
+                    otkd_object=self.otkd_object,
+                    avts_object=self.avts_object,
+                    logger=self.logger,
                 )
-                success = False
-                continue
+                # Load the payload file and initialize the payload sections:
+                t.add_event("Payload file loaded", timestamp=time.time_ns())
+                if not payload_object.init_payload():
+                    self.logger.error(
+                        "Failed to initialize payload -> '%s' - skipping payload file...",
+                        cust_payload,
+                    )
+                    success = False
+                    continue
 
-            # Now process the payload in the defined ordering:
-            payload_object.process_payload()
+                t.add_event("Payload initialized", timestamp=time.time_ns())
 
-            self.log_header("Consolidate OTDS Resources")
-            self.consolidate_otds()
+                # Now process the payload in the defined ordering:
+                payload_object.process_payload()
+                t.add_event("Payload processsed", timestamp=time.time_ns())
 
-            # Upload payload file for later review to Enterprise Workspace
-            if self.settings.otcs.upload_config_files:
-                self.log_header("Upload Payload file to OpenText Content Management")
-                response = self.otcs_backend_object.get_node_from_nickname(
-                    nickname=self.settings.cust_target_folder_nickname,
-                )
-                target_folder_id = self.otcs_backend_object.get_result_value(
-                    response=response,
-                    key="id",
-                )
-                if not target_folder_id:
-                    target_folder_id = 2000  # use Enterprise Workspace as fallback
-                # Write YAML file with upadated payload (including IDs, etc.).
-                # We need to write to a temporary location as initial location is read-only:
-                payload_file = os.path.basename(cust_payload)
-                payload_file = payload_file.removesuffix(".gz.b64")
-                payload_file = payload_file.replace(".tfvars", ".yaml").replace(
-                    ".tf",
-                    ".yaml",
-                )
-                cust_payload = os.path.join(tempfile.gettempdir(), payload_file)
-
-                with open(cust_payload, "w", encoding="utf-8") as file:
-                    yaml.dump(
-                        data=payload_object.get_payload(
-                            drop_bulk_datasources_data=True,
-                        ),
-                        stream=file,
-                    )
+                self.log_header("Consolidate OTDS Resources")
+                self.consolidate_otds()
+                t.add_event("OTCS consolidated", timestamp=time.time_ns())
 
-                # Check if the payload file has been uploaded before.
-                # This can happen if we re-run the python container.
-                # In this case we add a version to the existing document:
-                response = self.otcs_backend_object.get_node_by_parent_and_name(
-                    parent_id=int(target_folder_id),
-                    name=os.path.basename(cust_payload),
-                )
-                target_document_id = self.otcs_backend_object.get_result_value(
-                    response=response,
-                    key="id",
-                )
-                if target_document_id:
-                    response = self.otcs_backend_object.add_document_version(
-                        node_id=int(target_document_id),
-                        file_url=cust_payload,
-                        file_name=os.path.basename(cust_payload),
-                        mime_type="text/plain",
-                        description="Updated payload file after re-run of customization",
+                # Upload payload file for later review to Enterprise Workspace
+                if self.settings.otcs.upload_config_files:
+                    self.log_header("Upload Payload file to OpenText Content Management")
+                    response = self.otcs_backend_object.get_node_from_nickname(
+                        nickname=self.settings.cust_target_folder_nickname,
                     )
-                else:
-                    response = self.otcs_backend_object.upload_file_to_parent(
-                        file_url=cust_payload,
-                        file_name=os.path.basename(cust_payload),
-                        mime_type="text/plain",
+                    target_folder_id = self.otcs_backend_object.get_result_value(
+                        response=response,
+                        key="id",
+                    )
+                    if not target_folder_id:
+                        target_folder_id = 2000  # use Enterprise Workspace as fallback
+                    # Write YAML file with upadated payload (including IDs, etc.).
+                    # We need to write to a temporary location as initial location is read-only:
+                    payload_file = os.path.basename(cust_payload)
+                    payload_file = payload_file.removesuffix(".gz.b64")
+                    payload_file = payload_file.replace(".tfvars", ".yaml").replace(
+                        ".tf",
+                        ".yaml",
+                    )
+                    cust_payload = os.path.join(tempfile.gettempdir(), payload_file)
+
+                    with open(cust_payload, "w", encoding="utf-8") as file:
+                        yaml.dump(
+                            data=payload_object.get_payload(
+                                drop_bulk_datasources_data=True,
+                            ),
+                            stream=file,
+                        )
+
+                    # Check if the payload file has been uploaded before.
+                    # This can happen if we re-run the python container.
+                    # In this case we add a version to the existing document:
+                    response = self.otcs_backend_object.get_node_by_parent_and_name(
                         parent_id=int(target_folder_id),
+                        name=os.path.basename(cust_payload),
+                    )
+                    target_document_id = self.otcs_backend_object.get_result_value(
+                        response=response,
+                        key="id",
                     )
+                    if target_document_id:
+                        response = self.otcs_backend_object.add_document_version(
+                            node_id=int(target_document_id),
+                            file_url=cust_payload,
+                            file_name=os.path.basename(cust_payload),
+                            mime_type="text/plain",
+                            description="Updated payload file after re-run of customization",
+                        )
+                    else:
+                        response = self.otcs_backend_object.upload_file_to_parent(
+                            file_url=cust_payload,
+                            file_name=os.path.basename(cust_payload),
+                            mime_type="text/plain",
+                            parent_id=int(target_folder_id),
+                        )
 
-            duration = datetime.now(timezone.utc) - start_time
-            self.log_header(
-                "Customizer completed processing of payload -> {} in {}".format(
-                    cust_payload,
-                    duration,
-                ),
-            )
+                duration = datetime.now(UTC) - start_time
+                self.log_header(
+                    "Customizer completed processing of payload -> {} in {}".format(
+                        cust_payload,
+                        duration,
+                    ),
+                )
         # end for cust_payload in cust_payload_list
 
         if self.settings.otcs.maintenance_mode:
             self.set_maintenance_mode(enable=False)
 
-        # Code below disbaled -> not needed anymore, will be done via "kubernetes" payload section
+        # Code below disabled -> not needed anymore, will be done via "kubernetes" payload section
         #
         # # Restart AppWorksPlatform pod if it is deployed (to make settings effective):
         # if self.settings.otawp.enabled:  # is AppWorks Platform deployed?
@@ -1984,7 +2046,7 @@ class Customizer:
                     description="Initial Python Log after first run of customization",
                 )
 
-        self.customizer_end_time = datetime.now(timezone.utc)
+        self.customizer_end_time = datetime.now(UTC)
         self.log_header(
             "Customizer completed in {}".format(
                 self.customizer_end_time - self.customizer_start_time,

{pyxecm/customizer → pyxecm_customizer}/guidewire.py

@@ -143,7 +143,7 @@ class Guidewire:
         """Authenticate with the Guidewire API using either client credentials or username/password.
 
         Args:
-            auth_type (str | None):
+            auth_type (str | None, optional):
                 The Authorization type. This can be "basic" or "oauth".
 
         Returns:
@@ -340,7 +340,7 @@ class Guidewire:
         """Retrieve a list of Guidewire groups.
 
         Args:
-            fields (list):
+            fields (list | None, optional):
                 The list of fields in the results. If None, all default
                 fields are returned.
                 Fields for Guidewire accounts:
@@ -357,7 +357,7 @@ class Guidewire:
                 - parent
                 - securityZone
                 - supervisor
-            filters (list):
+            filters (list | None, optional):
                 List of dictionaries with three keys each:
                 - "attribute" - name of the attribute to use for the filter (available attributes see above)
                 - "op" - operator:
@@ -444,6 +444,42 @@ class Guidewire:
             for group in groups:
                 logger.info("Traversing Guidewire group -> '%s'...", group.get("attributes", {}).get("displayName"))
 
+        Args:
+            fields (list | None, optional):
+                The list of fields in the results. If None, all default
+                fields are returned.
+                Fields for Guidewire accounts:
+                - *all = return all fields
+                - *default = return just the default list of fields
+                - *summary = return the fields defined for giving a summary
+                - *detail = details
+                - displayName
+                - groupType
+                - id
+                - loadFactor
+                - name
+                - organization
+                - parent
+                - securityZone
+                - supervisor
+            filters (list | None, optional):
+                List of dictionaries with three keys each:
+                - "attribute" - name of the attribute to use for the filter (available attributes see above)
+                - "op" - operator:
+                    * eq - equal
+                    * ne - not equal
+                    * lt - less than - also usable for dates (before)
+                    * gt - greater than - also usable for dates (after)
+                    * le - less or equal
+                    * ge - greater or equal
+                    * in - is in list
+                    * ni - is NOT in list
+                    * sw - starts with
+                    * cn - contains
+                - "value": the value to filter for. Either literal or list of values
+            page_size (int, optional):
+                The maximum number of groups to return.
+
         Returns:
             iter:
                 A generator yielding one Guidewire group per iteration.
@@ -480,10 +516,12 @@ class Guidewire:
         """Retrieve details of a specific group.
 
         Args:
-            group_id: The unique identifier of the group.
+            group_id:
+                The unique identifier of the group.
 
         Returns:
-            dict: JSON response containing group details.
+            dict:
+                JSON response containing group details.
 
         Example response;
         {
@@ -543,7 +581,7 @@ class Guidewire:
         """Retrieve a list of Guidewire users.
 
         Args:
-            fields (list):
+            fields (list | None, optional):
                 The list of fields in the results. If None, all default
                 fields are returned.
                 Fields for Guidewire accounts:
@@ -560,7 +598,7 @@ class Guidewire:
                 - parent
                 - securityZone
                 - supervisor
-            filters (list):
+            filters (list | None, optional):
                 List of dictionaries with three keys each:
                 - "attribute" - name of the attribute to use for the filter (available attributes see above)
                 - "op" - operator:
@@ -577,7 +615,7 @@ class Guidewire:
                 - "value": the value to filter for. Either literal or list of values
             page_size (int, optional):
                 The maximum number of groups to return.
-            next_page_url (str, optional):
+            next_page_url (str | None, optional):
                 The Guidewire URL to retrieve the next page of Guidewire groups (pagination).
                 This is used for the iterator get_groups_iterator() below.
 
@@ -696,7 +734,7 @@ class Guidewire:
                 logger.info("Traversing Guidewire user -> '%s'...", user.get("attributes", {}).get("displayName"))
 
         Args:
-            fields (list):
+            fields (list | None, optional):
                 The list of fields in the results. If None, all default
                 fields are returned.
                 Fields for Guidewire accounts:
@@ -714,7 +752,7 @@ class Guidewire:
                 - useOrgAddress
                 - useProducerCodeSecurity
                 - username
-            filters (list):
+            filters (list | None, optional):
                 List of dictionaries with three keys each:
                 - "attribute" - name of the attribute to use for the filter (available attributes see above)
                 - "op" - operator:
@@ -866,7 +904,7 @@ class Guidewire:
         """Retrieve a list of accounts.
 
         Args:
-            fields (list):
+            fields (list | None, optional):
                 The list of fields in the results. If None, all default
                 fields are returned.
                 Fields for Guidewire accounts:
@@ -889,7 +927,7 @@ class Guidewire:
                 - primaryLocale
                 - primaryLocation
                 - producerCodes
-            filters (list):
+            filters (list | None, optional):
                 List of dictionaries with three keys each:
                 - "attribute" - name of the attribute to use for the filter (available attributes see above)
                 - "op" - operator:
@@ -943,7 +981,7 @@ class Guidewire:
                 logger.info("Traversing Guidewire account -> '%s'...", account.get("attributes", {}).get("displayName"))
 
         Args:
-            fields (list):
+            fields (list | None, optional):
                 The list of fields in the results. If None, all default
                 fields are returned.
                 Fields for Guidewire accounts:
@@ -966,7 +1004,7 @@ class Guidewire:
                 - primaryLocale
                 - primaryLocation
                 - producerCodes
-            filters (list):
+            filters (list | None, optional):
                 List of dictionaries with three keys each:
                 - "attribute" - name of the attribute to use for the filter (available attributes see above)
                 - "op" - operator:
@@ -1081,10 +1119,12 @@ class Guidewire:
         """Delete an account.
 
         Args:
-            account_id: The unique identifier of the account to delete.
+            account_id (str):
+                The unique identifier of the account to delete.
 
         Returns:
-            dict: JSON response indicating deletion success.
+            dict:
+                JSON response indicating deletion success.
 
         """
 
@@ -1104,7 +1144,7 @@ class Guidewire:
         """Retrieve a list of claims.
 
         Args:
-            fields (list):
+            fields (list | None, optional):
                 The list of fields in the results. If None, all default
                 fields are returned.
                 Fields for Guidewire accounts:
@@ -1121,7 +1161,7 @@ class Guidewire:
                 - parent
                 - securityZone
                 - supervisor
-            filters (list):
+            filters (list | None, optional):
                 List of dictionaries with three keys each:
                 - "attribute" - name of the attribute to use for the filter (available attributes see above)
                 - "op" - operator:
@@ -1173,7 +1213,7 @@ class Guidewire:
                 logger.info("Traversing Guidewire claim -> '%s'...", claim.get("attributes", {}).get("displayName"))
 
         Args:
-            fields (list):
+            fields (list | None, optional):
                 The list of fields in the results. If None, all default
                 fields are returned.
                 Fields for Guidewire accounts:
@@ -1190,7 +1230,7 @@ class Guidewire:
                 - parent
                 - securityZone
                 - supervisor
-            filters (list):
+            filters (list | None, optional):
                 List of dictionaries with three keys each:
                 - "attribute" - name of the attribute to use for the filter (available attributes see above)
                 - "op" - operator:

{pyxecm/customizer → pyxecm_customizer}/k8s.py

@@ -16,7 +16,7 @@ __email__ = "mdiefenb@opentext.com"
 import logging
 import os
 import time
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 
 from kubernetes import client, config
 from kubernetes.client import (
@@ -36,7 +36,7 @@ from kubernetes.client.exceptions import ApiException
 from kubernetes.config.config_exception import ConfigException
 from kubernetes.stream import stream
 
-default_logger = logging.getLogger("pyxecm.customizer.k8s")
+default_logger = logging.getLogger("pyxecm_customizer.k8s")
 
 
 class K8s:
@@ -1331,7 +1331,7 @@ class K8s:
         success = True
 
         if not force:
-            now = datetime.now(timezone.utc).isoformat(timespec="seconds") + "Z"
+            now = datetime.now(UTC).isoformat(timespec="seconds") + "Z"
 
             body = {
                 "spec": {
@@ -1468,7 +1468,7 @@ class K8s:
 
         success = True
 
-        now = datetime.now(timezone.utc).isoformat(timespec="seconds") + "Z"
+        now = datetime.now(UTC).isoformat(timespec="seconds") + "Z"
 
         body = {
             "spec": {