pyxecm 2.0.0__py3-none-any.whl → 2.0.2__py3-none-any.whl

pyxecm/customizer/pht.py

@@ -17,21 +17,38 @@ __email__ = "mdiefenb@opentext.com"
 
 import json
 import logging
+import platform
+import sys
 import time
+from importlib.metadata import version
 
 import requests
 from requests.auth import HTTPBasicAuth
 
 from pyxecm.helper import Data
 
-default_logger = logging.getLogger("pyxecm.customizer.pht")
+APP_NAME = "pyxecm"
+APP_VERSION = version("pyxecm")
+MODULE_NAME = APP_NAME + ".customizer.pht"
 
-REQUEST_HEADERS = {"Accept": "application/json", "Content-Type": "application/json"}
+PYTHON_VERSION = f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
+OS_INFO = f"{platform.system()} {platform.release()}"
+ARCH_INFO = platform.machine()
+REQUESTS_VERSION = requests.__version__
+
+USER_AGENT = (
+    f"{APP_NAME}/{APP_VERSION} ({MODULE_NAME}/{APP_VERSION}; "
+    f"Python/{PYTHON_VERSION}; {OS_INFO}; {ARCH_INFO}; Requests/{REQUESTS_VERSION})"
+)
+
+REQUEST_HEADERS = {"User-Agent": USER_AGENT, "accept": "application/json", "Content-Type": "application/json"}
 
 REQUEST_TIMEOUT = 60
 REQUEST_RETRY_DELAY = 20
 REQUEST_MAX_RETRIES = 2
 
+default_logger = logging.getLogger(MODULE_NAME)
+
 
 class PHT:
     """Class PHT is used to retrieve data from OpenText PHT. It is a pure read-only access."""

pyxecm/customizer/servicenow.py

@@ -12,12 +12,15 @@ __email__ = "mdiefenb@opentext.com"
 import json
 import logging
 import os
+import platform
+import sys
 import tempfile
 import threading
 import time
 import urllib.parse
 from collections.abc import Callable
 from functools import cache
+from importlib.metadata import version
 from typing import Any
 
 import requests
@@ -26,14 +29,28 @@ from requests.exceptions import HTTPError, RequestException
 
 from pyxecm.helper import Data
 
-default_logger = logging.getLogger("pyxecm.customizer.servicenow")
+APP_NAME = "pyxecm"
+APP_VERSION = version("pyxecm")
+MODULE_NAME = APP_NAME + ".customizer.servicenow"
 
-REQUEST_HEADERS = {"Accept": "application/json", "Content-Type": "application/json"}
+PYTHON_VERSION = f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}"
+OS_INFO = f"{platform.system()} {platform.release()}"
+ARCH_INFO = platform.machine()
+REQUESTS_VERSION = requests.__version__
+
+USER_AGENT = (
+    f"{APP_NAME}/{APP_VERSION} ({MODULE_NAME}/{APP_VERSION}; "
+    f"Python/{PYTHON_VERSION}; {OS_INFO}; {ARCH_INFO}; Requests/{REQUESTS_VERSION})"
+)
+
+REQUEST_HEADERS = {"User-Agent": USER_AGENT, "Accept": "application/json", "Content-Type": "application/json"}
 
 REQUEST_TIMEOUT = 60
 
 KNOWLEDGE_BASE_PATH = os.path.join(tempfile.gettempdir(), "attachments")
 
+default_logger = logging.getLogger(MODULE_NAME)
+
 # ServiceNow database tables. Table names starting with "u_" are custom OpenText tables:
 SN_TABLE_CATEGORIES = "kb_category"
 SN_TABLE_KNOWLEDGE_BASES = "kb_knowledge_base"
@@ -78,7 +95,7 @@ class ServiceNow:
             base_url (str):
                 The base URL of the ServiceNow tenant.
             auth_type (str):
-                Athe authorization type, either "oauth" or "basic".
+                The authorization type, either "oauth" or "basic".
             client_id (str):
                 ServiceNow Client ID.
             client_secret (str):
@@ -168,7 +185,7 @@ class ServiceNow:
 
         Returns:
             dict:
-                The configuration dictionary.
+                The configuration dictionary with all settings.
 
         """
 
@@ -387,7 +404,7 @@ class ServiceNow:
 
             return token
         else:
-            self.logger.error("Unsupported authentication type")
+            self.logger.error("Unsupported authentication type -> %s!", auth_type)
             return None
 
     # end method definition

pyxecm/customizer/settings.py

@@ -19,7 +19,7 @@ class CustomizerSettingsOTDS(BaseModel):
     username: str = Field(default="admin", description="Username for the OTDS admin user")
     password: SecretStr = Field(default=None, description="Password for the OTDS admin user")
     ticket: str | None = Field(None, description="Ticket for the OTDS admin user")
-    admin_partition: str = Field(default="otds.admin", description="Name of the default Partition in OTDS")
+    admin_partition: str = Field(default="otds.admin", description="Name of the admin partition in OTDS")
     enable_audit: bool = Field(default=True, description="Enable the OTDS Audit")
     disable_password_policy: bool = Field(
         default=True,
@@ -68,6 +68,7 @@ class CustomizerSettingsOTCS(BaseModel):
     username: str = Field(default="admin", description="Username for the OTCS admin user")
     password: SecretStr = Field(default=None, description="Password for the OTCS admin user")
     base_path: str = Field(default="/cs/cs", description="Base path of the OTCS installation")
+    support_path: str = Field(default="/cssupport", description="Support path of the OTCS installation")
     url: HttpUrl | None = Field(default=None, description="URL of the OTCS service")
     url_frontend: HttpUrl | None = Field(
         default=None,
@@ -91,7 +92,7 @@ class CustomizerSettingsOTCS(BaseModel):
         description="temporary download directory for payload processing",
     )
 
-    # FEME endpoint for additional indexing supporting Content Aviator:
+    # FEME endpoint for additional embedding supporting Content Aviator:
     feme_uri: str = Field(default="ws://feme:4242", description="URL of the FEME endpoint")
 
     # Add configuration options for Customizer behaviour
@@ -266,7 +267,7 @@ class CustomizerSettingsK8S(BaseModel):
     sts_otcs_admin_replicas: int = Field(default=None)
     ingress_otxecm: str = Field(default="otxecm-ingress", description="Name of the otxecm ingress")
 
-    maintenance_service_name: str = Field(default="otxecm-customizer")
+    maintenance_service_name: str = Field(default="customizer")
     maintenance_service_port: int = Field(default=5555)
 
 
@@ -279,6 +280,7 @@ class CustomizerSettingsOTAWP(BaseModel):
         description="Username of the OTAWP Admin user",
     )
     password: SecretStr = Field(default=None, description="Password of the OTAWP Admin user")
+    organization: str = Field(default="system", description="The name of the organization (kind of tenant in AppWorks)")
     license_file: str = Field(default="/payload/otawp-license.lic", description="Path to the OTAWP license file.")
     product_name: str = Field(default="APPWORKS_PLATFORM", description="Name of the Product for the license")
     product_description: str = Field(
@@ -351,7 +353,6 @@ class CustomizerSettingsAVTS(BaseModel):
     enabled: bool = Field(default=False, description="Enable Aviator Search configuration")
     username: str = Field(default="", description="Admin username for Aviator Search")
     password: str = Field(default="", description="Admin password for Aviator Search")
-    otds_url: HttpUrl | None = Field(default=None, description="URL of the OTDS")
     client_id: str = Field(default="", description="OTDS Client ID for Aviator Search")
     client_secret: str = Field(default="", description="OTDS Client Secret for Aviator Search")
     base_url: HttpUrl | None = Field(
@@ -399,13 +400,15 @@ class Settings(BaseSettings):
 
     profiling: bool = Field(
         default=False,
-        description=" Profiling can only be enabled when using the CustomizerAPI. Switch to enable python profiling using pyinstrument. Result is a html file showing the execution of payload broken down into functions and their duration. The files are located in the logdir. Profiling is disabled by default.",
+        description="Profiling can only be enabled when using the CustomizerAPI. Switch to enable python profiling using pyinstrument. Result is a html file showing the execution of payload broken down into functions and their duration. The files are located in the logdir. Profiling is disabled by default.",
     )
     cprofiling: bool = Field(
         default=False,
-        description=" Profiling can only be enabled when using the CustomizerAPI. Switch to enable python profiling using cProfile. Result is a log file with the cProfile results, as well as a dump of the profiling session. The files are located in the logdir. The files are located in the logdir. Profilig is disabled by default.",
+        description="Profiling can only be enabled when using the CustomizerAPI. Switch to enable python profiling using cProfile. Result is a log file with the cProfile results, as well as a dump of the profiling session. The files are located in the logdir. The files are located in the logdir. Profilig is disabled by default.",
     )
 
+    headless_browser: bool = Field(default=True, description="Headless Browser for the BrowserAutomation")
+
     otds: CustomizerSettingsOTDS = CustomizerSettingsOTDS()
     otcs: CustomizerSettingsOTCS = CustomizerSettingsOTCS()
     otac: CustomizerSettingsOTAC = CustomizerSettingsOTAC()

pyxecm/helper/xml.py

@@ -31,6 +31,75 @@ class XML:
 
     logger: logging.Logger = default_logger
 
+    @classmethod
+    def remove_xml_namespace(cls, tag: str) -> str:
+        """Remove namespace from XML tag.
+
+        Args:
+            tag (str):
+                The XML tag with namespace.
+
+        Returns:
+            str:
+                The tag without namespace.
+
+        """
+
+        # In Python's ElementTree, the tag namespace
+        # is put into curly braces like "{namespace}element"
+        # that's why this method splits after the closing curly brace
+        # and takes the last item (-1):
+
+        return tag.split("}", 1)[-1]
+
+    # end method definition
+
+    @classmethod
+    def xml_to_dict(cls, xml_string: str) -> dict:
+        """Parse XML string and return a dictionary without namespaces.
+
+        Args:
+            xml_string (str):
+                The XML string to process.
+
+        Returns:
+            dict:
+                The XML structure converted to a dictionary.
+
+        """
+
+        def xml_element_to_dict(element: Element) -> dict:
+            """Convert XML element to dictionary.
+
+            Args:
+                element (Element):
+                    The XML element.
+
+            Returns:
+                dict:
+                    Dictionary representing the XML element
+
+            """
+            tag = cls.remove_xml_namespace(element.tag)
+            children = list(element)
+            if children:
+                return {
+                    tag: {
+                        cls.remove_xml_namespace(child.tag): xml_element_to_dict(child)[
+                            cls.remove_xml_namespace(child.tag)
+                        ]
+                        for child in children
+                    }
+                }
+
+            return {tag: element.text.strip() if element.text else None}
+
+        root = etree.fromstring(xml_string)
+
+        return xml_element_to_dict(root)
+
+    # end method definition
+
     @classmethod
     def load_xml_file(
         cls,

pyxecm/otac.py

@@ -387,7 +387,7 @@ class OTAC:
         # Check if previous authentication was not successful.
         # Then we do the normal username + password authentication:
         self.logger.debug(
-            "Requesting OTAC ticket with User/Password; calling -> %s",
+            "Requesting OTAC ticket with username and password; calling -> %s",
             request_url,
         )