midpoint-cli 1.2.0__tar.gz → 1.3.1__tar.gz

midpoint_cli-1.3.1/MANIFEST.in

@@ -0,0 +1 @@
+include requirements.txt

{midpoint_cli-1.2.0 → midpoint_cli-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: midpoint-cli
-Version: 1.2.0
+Version: 1.3.1
 Summary: A command line client to Midpoint Identity Management system.
 Home-page: https://gitlab.com/alcibiade/midpoint-cli
 Author: Yannick Kirschhoffer
@@ -21,6 +21,8 @@ Requires-Dist: requests>=2.31
 Requires-Dist: urllib3>=2.0
 Requires-Dist: setuptools>=68.0
 
+![link=https://badge.fury.io/py/midpoint-cli](https://badge.fury.io/py/midpoint-cli.svg)
+
 ## Midpoint CLI
 
 This project is a command line client interface used to drive an Evolveum Midpoint identity management server.
@@ -229,5 +231,6 @@ midpoint-1
 
 * Update revision in src/midpoint_cli/__init__.py
 * Commit and tag with corresponding version number
+* Generate markdown documentation: downdoc README.adoc
 * Build distribution: python setup.py sdist
 * Upload distribution to PyPI: twine upload dist/*

{midpoint_cli-1.2.0 → midpoint_cli-1.3.1}/README.md

@@ -1,3 +1,5 @@
+![link=https://badge.fury.io/py/midpoint-cli](https://badge.fury.io/py/midpoint-cli.svg)
+
 ## Midpoint CLI
 
 This project is a command line client interface used to drive an Evolveum Midpoint identity management server.
@@ -206,5 +208,6 @@ midpoint-1
 
 * Update revision in src/midpoint_cli/__init__.py
 * Commit and tag with corresponding version number
+* Generate markdown documentation: downdoc README.adoc
 * Build distribution: python setup.py sdist
 * Upload distribution to PyPI: twine upload dist/*

{midpoint_cli-1.2.0 → midpoint_cli-1.3.1}/midpoint_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: midpoint-cli
-Version: 1.2.0
+Version: 1.3.1
 Summary: A command line client to Midpoint Identity Management system.
 Home-page: https://gitlab.com/alcibiade/midpoint-cli
 Author: Yannick Kirschhoffer
@@ -21,6 +21,8 @@ Requires-Dist: requests>=2.31
 Requires-Dist: urllib3>=2.0
 Requires-Dist: setuptools>=68.0
 
+![link=https://badge.fury.io/py/midpoint-cli](https://badge.fury.io/py/midpoint-cli.svg)
+
 ## Midpoint CLI
 
 This project is a command line client interface used to drive an Evolveum Midpoint identity management server.
@@ -229,5 +231,6 @@ midpoint-1
 
 * Update revision in src/midpoint_cli/__init__.py
 * Commit and tag with corresponding version number
+* Generate markdown documentation: downdoc README.adoc
 * Build distribution: python setup.py sdist
 * Upload distribution to PyPI: twine upload dist/*

{midpoint_cli-1.2.0 → midpoint_cli-1.3.1}/midpoint_cli.egg-info/SOURCES.txt

@@ -1,5 +1,7 @@
 LICENSE
+MANIFEST.in
 README.md
+requirements.txt
 setup.cfg
 setup.py
 midpoint_cli.egg-info/PKG-INFO

midpoint_cli-1.3.1/requirements.txt

@@ -0,0 +1,7 @@
+clint>=0.5
+tabulate>=0.9
+unidecode>=1.3
+requests>=2.31
+urllib3>=2.0
+
+setuptools>=68.0

midpoint_cli-1.3.1/src/midpoint_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = '1.3.1'

{midpoint_cli-1.2.0 → midpoint_cli-1.3.1}/src/midpoint_cli/client/__init__.py

@@ -147,6 +147,18 @@ class MidpointClient:
         if api_client is not None:
             self.api_client = api_client
 
+    def __get_object(self, midpoint_type: str, oid: str) -> Element:
+        response = self.api_client.get_element(midpoint_type, oid)
+        tree = ElementTree.fromstring(response)
+
+        status = tree.find('c:status', namespaces)
+
+        if status is not None and status.text == 'fatal_error':
+            message = tree.find('c:partialResults/c:message', namespaces).text
+            raise MidpointServerError(message)
+
+        return tree
+
     def __get_collection(self, mp_class: str, local_class: Type) -> MidpointObjectList:
         tree = self.api_client.get_elements(mp_class)
         return MidpointObjectList([local_class(entity) for entity in tree])
@@ -160,6 +172,11 @@ class MidpointClient:
     def get_connectors(self) -> MidpointObjectList:
         return self.__get_collection('connector', MidpointConnector)
 
+    def get_user(self, oid: str) -> Optional[MidpointUser]:
+        user_root = self.__get_object('user', oid)
+        user = MidpointUser(user_root)
+        return user
+
     def get_users(self) -> MidpointObjectList:
         return self.__get_collection('user', MidpointUser)
 
@@ -171,18 +188,17 @@ class MidpointClient:
         selected_orgs = self._filter(queryterms, orgs)
         return selected_orgs
 
-    def task_action(self, task_oid: str, task_action: str) -> None:
+    def task_action(self, task_oid: str, task_action: str) -> Optional[MidpointTask]:
         self.api_client.execute_action('task', task_oid, task_action)
 
         if task_action == 'run':
             return self.task_wait(task_oid)
 
-    def task_wait(self, task_oid: str) -> None:
+    def task_wait(self, task_oid: str) -> MidpointTask:
         with AsciiProgressMonitor() as progress:
             while True:
                 time.sleep(2)
-                task_xml = self.api_client.get_element('task', task_oid)
-                task_root = ElementTree.fromstring(task_xml)
+                task_root = self.__get_object('task', task_oid)
                 task = MidpointTask(task_root)
 
                 progress.update(int(task['Progress'] or '0'))
@@ -194,7 +210,7 @@ class MidpointClient:
                     if rstatus != 'success':
                         raise TaskExecutionFailure('Failed execution of task ' + task_oid + ' with status ' + rstatus)
 
-                    break
+                    return task
 
     def test_resource(self, resource_oid: str) -> None:
         response = self.api_client.execute_action('resource', resource_oid, 'test')
@@ -202,11 +218,11 @@ class MidpointClient:
         status = tree.find('c:status', namespaces).text
         return status
 
-    def get_xml(self, type: str, oid: str) -> Optional[str]:
-        return self.api_client.get_element(type, oid)
+    def get_xml(self, midpoint_type: str, oid: str) -> Optional[str]:
+        return self.api_client.get_element(midpoint_type, oid)
 
     def put_xml(self, xml_file: str, patch_file: str = None, patch_write: bool = False) -> Tuple[str, str]:
         return self.api_client.put_element(xml_file, patch_file, patch_write)
 
-    def delete(self, type: str, oid: str) -> str:
-        return self.api_client.delete(type, oid)
+    def delete(self, midpoint_type: str, oid: str) -> str:
+        return self.api_client.delete(midpoint_type, oid)

{midpoint_cli-1.2.0 → midpoint_cli-1.3.1}/src/midpoint_cli/client/objects.py

@@ -1,9 +1,12 @@
+import itertools
 import re
 from collections import OrderedDict
+from textwrap import dedent
 from typing import Optional, List
 from xml.etree import ElementTree
 from xml.etree.ElementTree import Element
 
+import tabulate
 from unidecode import unidecode
 
 namespaces = {
@@ -76,6 +79,62 @@ class MidpointTask(MidpointObject):
         total = xml_entity.find('c:expectedTotal', namespaces)
         self['Expected Total'] = total.text if total is not None else ''
 
+        # Collect execution statistics
+
+        self._transitions = []
+        self._actions = []
+
+        statistics = xml_entity.find('c:activityState/c:activity/c:statistics', namespaces)
+
+        if statistics is not None:
+            synchronization = statistics.find('c:synchronization', namespaces)
+
+            for transition in synchronization or []:
+                if transition.find('c:onSynchronizationStart', namespaces) is not None:
+                    state_start = transition.find('c:onSynchronizationStart', namespaces).text
+                    state_end = transition.find('c:onSynchronizationEnd', namespaces).text
+                    count = int(transition.find('c:counter/c:count', namespaces).text)
+                    self._transitions.append((state_start, state_end, count))
+
+                if transition.find('c:exclusionReason', namespaces) is not None:
+                    reason = transition.find('c:exclusionReason', namespaces).text
+                    count = int(transition.find('c:counter/c:count', namespaces).text)
+                    self._transitions.append((reason, '', count))
+
+            actions_executed = statistics.find('c:actionsExecuted', namespaces)
+
+            for object_actions_entry in actions_executed or []:
+                object_type = object_actions_entry.find('c:objectType', namespaces).text
+                operation = object_actions_entry.find('c:operation', namespaces).text
+                count_success = int(object_actions_entry.find('c:totalSuccessCount', namespaces).text)
+                count_failure = int(object_actions_entry.find('c:totalFailureCount', namespaces).text)
+
+                self._actions.append((object_type, operation, count_success, count_failure))
+
+    def get_transitions(self):
+        return self._transitions
+
+    def get_actions(self):
+        return self._actions
+
+    def get_full_description(self):
+        text = dedent("""\
+            {}
+            
+            Transitions
+            {}
+                               
+            Actions
+            {} 
+        """).format(tabulate.tabulate(self.items()),
+                    tabulate.tabulate(self.get_transitions(),
+                                      headers=['From State', 'To State', 'Count']),
+                    tabulate.tabulate(self.get_actions(),
+                                      headers=['Type', 'Action', 'Count Success', 'Count Failure'])
+                    )
+
+        return text
+
 
 class MidpointResource(MidpointObject):
 
@@ -99,6 +158,10 @@ class MidpointConnector(MidpointObject):
 
 class MidpointUser(MidpointObject):
 
+    @staticmethod
+    def strip_namespace(tag: str) -> str:
+        return re.sub(r'{.*}', '', tag)
+
     def __init__(self, xml_entity: Element):
         super().__init__()
         self['OID'] = xml_entity.attrib['oid']
@@ -110,11 +173,18 @@ class MidpointUser(MidpointObject):
         self['Email'] = optional_text(xml_entity.find('c:emailAddress', namespaces))
         self['OU'] = optional_text(xml_entity.find('c:organizationalUnit', namespaces))
 
+        activation = xml_entity.find('c:activation', namespaces)
         extfields = xml_entity.find('c:extension', namespaces)
 
-        if extfields is not None:
-            for extfield in extfields:
-                self[re.sub(r'{.*}', '', extfield.tag)] = extfield.text
+        self._all_attributes = []
+
+        for child in itertools.chain(xml_entity, activation, extfields or []):
+            # Check if the child has no children and contains non-empty text
+            if len(child) == 0 and (child.text is not None and child.text.strip()):
+                self._all_attributes.append((self.strip_namespace(child.tag), child.text))
+
+    def get_all_attributes(self):
+        return self._all_attributes
 
 
 class MidpointOrganization(MidpointObject):

{midpoint_cli-1.2.0 → midpoint_cli-1.3.1}/src/midpoint_cli/prompt/task.py

@@ -4,7 +4,7 @@ from argparse import ArgumentParser, RawTextHelpFormatter
 import tabulate
 
 # Task command wrapper parser
-from midpoint_cli.client import TaskExecutionFailure
+from midpoint_cli.client import TaskExecutionFailure, MidpointTask
 from midpoint_cli.prompt.base import PromptBase
 
 task_parser = ArgumentParser(
@@ -40,6 +40,15 @@ task_wait_parser = ArgumentParser(
 )
 task_wait_parser.add_argument('task', help='Task to wait for. Can be an OID or a task name.', nargs='*')
 
+# Task GET parser
+
+task_get_parser = ArgumentParser(
+    formatter_class=RawTextHelpFormatter,
+    prog='task get',
+    description='Get data about a task.',
+)
+task_get_parser.add_argument('task', help='Task to wait for. Can be an OID or a task name.', nargs='*')
+
 
 class TaskClientPrompt(PromptBase):
 
@@ -51,6 +60,19 @@ class TaskClientPrompt(PromptBase):
             if ns.command == 'ls':
                 tasks = self.client.get_tasks()
                 print(tabulate.tabulate(tasks, headers='keys'))
+            elif ns.command == 'get':
+                tasks = self.client.get_tasks()
+                get_ns = task_wait_parser.parse_args(task_args[1:])
+
+                tasks_to_get = get_ns.task
+
+                for task_id in tasks_to_get:
+                    task_obj: MidpointTask = tasks.find_object(task_id)
+                    if task_obj is None:
+                        print(f'Task reference not found: {task_id}')
+                    else:
+                        print(task_obj.get_full_description())
+
             elif ns.command == 'wait':
                 tasks = self.client.get_tasks()
                 wait_ns = task_wait_parser.parse_args(task_args[1:])
@@ -63,9 +85,9 @@ class TaskClientPrompt(PromptBase):
                 for task_id in tasks_to_wait:
                     task_obj = tasks.find_object(task_id)
                     if task_obj is None:
-                        print('Task reference not found:', task_id)
+                        print(f'Task reference not found: {task_id}')
                     else:
-                        print('Waiting for task', task_obj.get_oid(), '/', task_obj.get_name())
+                        print(f'Waiting for task {task_obj.get_oid()} / {task_obj.get_name()}')
                         self.client.task_wait(task_obj.get_oid())
 
             elif ns.command in ['run', 'resume', 'suspend']:
@@ -85,11 +107,15 @@ class TaskClientPrompt(PromptBase):
 
                         print('Task', task_obj.get_name(), '-', ns.command)
                         try:
-                            self.client.task_action(task_obj.get_oid(), ns.command)
+                            task_result = self.client.task_action(task_obj.get_oid(), ns.command)
+
+                            if task_result is not None:
+                                print(task_result.get_full_description())
                         except TaskExecutionFailure as e:
                             self.error_code = 1
                             self.error_message = e.message
                             break
+
             else:
                 self.error_code = 1
                 self.error_message = f'Unknown command {ns.command}'

{midpoint_cli-1.2.0 → midpoint_cli-1.3.1}/src/midpoint_cli/prompt/user.py

@@ -3,6 +3,7 @@ from argparse import ArgumentParser, RawTextHelpFormatter
 
 import tabulate
 
+from midpoint_cli.client import MidpointUser, MidpointObjectList, MidpointServerError
 # User command wrapper parser
 from midpoint_cli.prompt.base import PromptBase
 
@@ -23,10 +24,17 @@ user_parser.add_argument('arg', help='Optional command arguments.', nargs='*')
 user_search_parser = ArgumentParser(
     formatter_class=RawTextHelpFormatter,
     prog='user search',
-    description='Search for a user.',
+    description='Search for users by substring.',
 )
 user_search_parser.add_argument('searchquery', help='A string fragment found in the user data.', nargs='+')
 
+user_get_parser = ArgumentParser(
+    formatter_class=RawTextHelpFormatter,
+    prog='user get',
+    description='Search for users by OID.',
+)
+user_get_parser.add_argument('oid', help='An OID or name value.')
+
 
 class UserClientPrompt(PromptBase):
 
@@ -42,6 +50,14 @@ class UserClientPrompt(PromptBase):
                 search_ns = user_search_parser.parse_args(user_args[1:])
                 users = self.client.get_users().filter(search_ns.searchquery)
                 self.print_users(users)
+            elif ns.command == 'get':
+                get_ns = user_get_parser.parse_args(user_args[1:])
+                try:
+                    user = self.client.get_user(get_ns.oid)
+                    self.print_user(user)
+                except MidpointServerError as e:
+                    self.error_code = 1
+                    self.error_message = str(e)
             else:
                 self.error_code = 1
                 self.error_message = f'Unknown command {ns.command}'
@@ -50,7 +66,11 @@ class UserClientPrompt(PromptBase):
             pass
 
     @staticmethod
-    def print_users(users):
+    def print_user(user: MidpointUser):
+        print(tabulate.tabulate(user.get_all_attributes()))
+
+    @staticmethod
+    def print_users(users: MidpointObjectList):
         print(tabulate.tabulate(users, headers='keys'))
         print()
         print(f'Total: {len(users)} users')

midpoint_cli-1.2.0/src/midpoint_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = '1.2.0'