yellowdog-python-examples 7.17.1__tar.gz → 7.17.2__tar.gz

{yellowdog_python_examples-7.17.1/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.17.1
+Version: 7.17.2
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 Project-URL: Homepage, https://github.com/yellowdog/python-examples

yellowdog_python_examples-7.17.2/yellowdog_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "7.17.2"

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2}/yellowdog_cli/create.py

@@ -25,6 +25,7 @@ from yellowdog_client.model import (
     CloudProvider,
     Group,
     ImageOsType,
+    InternalUser,
     Keyring,
     MachineImage,
     MachineImageFamily,
@@ -39,7 +40,9 @@ from yellowdog_client.model import (
 from yellowdog_client.model.exceptions import InvalidRequestException
 
 from yellowdog_cli.utils.entity_utils import (
+    clear_application_caches,
     clear_compute_source_template_cache,
+    clear_group_caches,
     clear_image_family_search_cache,
     find_compute_requirement_template_id_by_name,
     find_compute_source_template_id_by_name,
@@ -831,7 +834,6 @@ def _get_model_object(class_name: str, resource: Dict, **kwargs):
     Return a populated YellowDog model object for the resource.
     Discard unexpected keywords.
     """
-
     def _patch_aws_fleet_enums():
         if isinstance(model_object, AwsFleetComputeSource):
             try:
@@ -1017,6 +1019,10 @@ def create_group(resource: Dict):
 
         current_role_ids = {role.role.id for role in group.roles}
 
+        if current_role_ids == new_role_ids:
+            print_log("No Role additions or deletions required")
+            return
+
         role_ids_to_remove = current_role_ids - new_role_ids
         for role_id in role_ids_to_remove:
             CLIENT.account_client.remove_role_from_group(group.id, role_id)
@@ -1041,6 +1047,7 @@ def create_group(resource: Dict):
             _get_model_object(RN_ADD_GROUP_REQUEST, resource)
         )
         print_log(f"Created Group '{group.name}' ({group.id})")
+        clear_group_caches()
         update_roles(group)
 
     def update_group(group_id: str):
@@ -1095,6 +1102,10 @@ def create_application(resource: Dict):
             group.id for group in get_application_groups(CLIENT, app.id)
         }
 
+        if current_group_ids == new_group_ids:
+            print_log("No Group additions or deletions required")
+            return
+
         group_ids_to_remove = current_group_ids - new_group_ids
         for group_id in group_ids_to_remove:
             CLIENT.account_client.remove_application_from_group(group_id, app.id)
@@ -1128,6 +1139,7 @@ def create_application(resource: Dict):
         app = app_response.application
         print_log(f"Created Application '{app.name}' ({app.id})")
         show_key_and_secret(app_response.apiKey)
+        clear_application_caches()
         update_groups(app)
 
     def update_application(app_id: str):
@@ -1159,10 +1171,9 @@ def create_application(resource: Dict):
 
 def update_user(resource: Dict):
     """
-    Update a user. Will also add or remove groups specified
-    by their names or IDs.
+    Update a user (specified by name or ID). Will also add or remove
+    groups specified by their names or IDs.
     """
-
     name = resource.get(PROP_NAME)
     id = resource.get(PROP_ID)
 
@@ -1178,11 +1189,11 @@ def update_user(resource: Dict):
         # Convert group names to IDs
         new_group_ids = set()
         for group_name in groups:
-            app_id = get_group_id_by_name(CLIENT, group_name)
-            if app_id is None:
+            group_id = get_group_id_by_name(CLIENT, group_name)
+            if group_id is None:
                 print_warning(f"Group name '{group_name}' not found ... ignoring")
             else:
-                new_group_ids.add(app_id)
+                new_group_ids.add(group_id)
 
     def update_groups(user: User):
         """
@@ -1193,12 +1204,16 @@ def update_user(resource: Dict):
 
         current_group_ids = {group.id for group in get_user_groups(CLIENT, user.id)}
 
+        if current_group_ids == new_group_ids:
+            print_log("No Group additions or deletions required")
+            return
+
         group_ids_to_remove = current_group_ids - new_group_ids
         for group_id in group_ids_to_remove:
             CLIENT.account_client.remove_user_from_group(group_id, user.id)
             print_log(
                 f"Removed Group '{get_group_name_by_id(CLIENT, group_id)}' "
-                f"from User ({group_id})"
+                f"({group_id})"
             )
 
         group_ids_to_add = new_group_ids - current_group_ids
@@ -1206,13 +1221,16 @@ def update_user(resource: Dict):
             CLIENT.account_client.add_user_to_group(group_id, user.id)
             print_log(
                 f"Added Group '{get_group_name_by_id(CLIENT, group_id)}' "
-                f"to User ({group_id})"
+                f"({group_id})"
             )
 
-    # Main logic: try name then ID if present
+    # Main logic: try name then ID if present; check for ID match
     user = None
     if name is not None:
         user = get_user_by_name_or_id(CLIENT, name)
+    if user is not None and id is not None:
+        if user.id != id:
+            raise Exception(f"User name '{name}' and supplied ID do not match")
     if user is None and id is not None:
         user = get_user_by_name_or_id(CLIENT, id)
 
@@ -1221,11 +1239,15 @@ def update_user(resource: Dict):
             f"User '{name}' not found; Users cannot be created using "
             "the CLI, please use the YellowDog Portal"
         )
-    elif groups is not None:
-        print_log(f"Updating Groups for User '{name}' ({user.id})")
+        return
+
+    username = user.username if isinstance(user, InternalUser) else user.name
+
+    if groups is not None:
+        print_log(f"Updating Groups for User '{username}' ({user.id})")
         update_groups(user)
     else:
-        print_log(f"Nothing to do for User '{name}' ({user.id})")
+        print_log(f"Nothing to do for User '{username}' ({user.id})")
 
 
 # Entry point

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2}/yellowdog_cli/list.py

@@ -34,6 +34,7 @@ from yellowdog_client.model import (
     NodeSearch,
     NodeStatus,
     ObjectDetail,
+    PermissionDetail,
     Role,
     Task,
     TaskGroup,
@@ -131,6 +132,8 @@ def main():
         list_groups()
     elif ARGS_PARSER.roles:
         list_roles()
+    elif ARGS_PARSER.permissions:
+        list_permissions()
 
 
 def check_for_valid_option() -> bool:
@@ -151,8 +154,9 @@ def check_for_valid_option() -> bool:
         ARGS_PARSER.namespace_storage_configurations,
         ARGS_PARSER.nodes,
         ARGS_PARSER.object_paths,
-        ARGS_PARSER.source_templates,
+        ARGS_PARSER.permissions,
         ARGS_PARSER.roles,
+        ARGS_PARSER.source_templates,
         ARGS_PARSER.task_groups,
         ARGS_PARSER.tasks,
         ARGS_PARSER.users,
@@ -964,6 +968,21 @@ def list_roles():
         print_yd_object(selected_users)
 
 
+def list_permissions():
+    """
+    List all permissions in the account.
+    """
+    permissions: List[PermissionDetail] = CLIENT.account_client.list_permissions()
+    permissions.sort(key=lambda permission: permission.name)
+
+    if not ARGS_PARSER.details:
+        print_numbered_object_list(CLIENT, permissions, object_type_name="Permission")
+        return
+
+    for permission in select(CLIENT, permissions, object_type_name="Permission"):
+        print_yd_object(permission)
+
+
 def get_autoscaling_capacity(namespace: str) -> Dict:
     """
     Get the current autoscaling values for a namespace.

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2}/yellowdog_cli/remove.py

@@ -19,6 +19,8 @@ from yellowdog_client.model import (
 )
 
 from yellowdog_cli.utils.entity_utils import (
+    clear_application_caches,
+    clear_group_caches,
     find_compute_requirement_template_id_by_name,
     find_compute_source_template_id_by_name,
     get_application_id_by_name,
@@ -521,6 +523,7 @@ def remove_group(resource: Dict):
     try:
         CLIENT.account_client.delete_group(group_id)
         print_log(f"Removed Group '{group_name}' ({group_id})")
+        clear_group_caches()
     except Exception as e:
         print_error(f"Unable to delete Group '{group_name}' ({group_id}): {e}")
 
@@ -543,6 +546,7 @@ def remove_application(resource: Dict):
     try:
         CLIENT.account_client.delete_application(app_id)
         print_log(f"Removed Application '{app_name}' ({app_id})")
+        clear_application_caches()
     except Exception as e:
         print_error(f"Unable to delete Application '{app_name}' ({app_id}): {e}")
 

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2}/yellowdog_cli/utils/args.py

@@ -651,6 +651,12 @@ class CLIParser:
                 required=False,
                 help="list roles",
             )
+            parser.add_argument(
+                "--permissions",
+                action="store_true",
+                required=False,
+                help="list permissions",
+            )
             parser.add_argument(
                 "--output-file",
                 type=str,
@@ -1551,6 +1557,11 @@ class CLIParser:
     def roles(self) -> Optional[bool]:
         return self.args.roles
 
+    @property
+    @allow_missing_attribute
+    def permissions(self) -> Optional[bool]:
+        return self.args.permissions
+
     @property
     @allow_missing_attribute
     def show_keyring_passwords(self) -> Optional[bool]:

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2}/yellowdog_cli/utils/entity_utils.py

@@ -574,8 +574,11 @@ def get_role_id_by_name(client: PlatformClient, role_name: str) -> Optional[str]
     if get_ydid_type(role_name) == YDIDType.ROLE:
         return role_name
 
-    for role in get_all_roles(client):
-        if role_name == role.name:
+    role_search = RoleSearch(name=role_name)
+    search_client: SearchClient = client.account_client.get_roles(role_search)
+
+    for role in search_client.list_all():
+        if role.name == role_name:
             return role.id
 
     return None
@@ -606,8 +609,11 @@ def get_all_roles(client: PlatformClient) -> List[RoleSummary]:
 @lru_cache
 def get_group_id_by_name(client: PlatformClient, group_name: str) -> Optional[str]:
     """
-    Get a group's ID by its name.
+    Get a group's ID by its name. Accept IDs and return unchanged.
     """
+    if get_ydid_type(group_name) == YDIDType.GROUP:
+        return group_name
+
     group_search = GroupSearch(name=group_name)
     search_client: SearchClient = client.account_client.get_groups(group_search)
     group_summaries: List[GroupSummary] = search_client.list_all()
@@ -641,6 +647,15 @@ def get_all_groups(client: PlatformClient) -> List[GroupSummary]:
     return search_client.list_all()
 
 
+def clear_group_caches():
+    """
+    Clear the group caches.
+    """
+    get_all_groups.cache_clear()
+    get_group_name_by_id.cache_clear()
+    get_group_id_by_name.cache_clear()
+
+
 @lru_cache
 def get_all_applications(client: PlatformClient) -> List[Application]:
     """
@@ -656,8 +671,11 @@ def get_all_applications(client: PlatformClient) -> List[Application]:
 @lru_cache
 def get_application_id_by_name(client: PlatformClient, app_name: str) -> Optional[str]:
     """
-    Get an application ID by its name.
+    Get an application ID by its name. Accept IDs and return unchanged.
     """
+    if get_ydid_type(app_name) == YDIDType.APPLICATION:
+        return app_name
+
     for app in get_all_applications(client):
         if app.name == app_name:
             return app.id
@@ -665,6 +683,14 @@ def get_application_id_by_name(client: PlatformClient, app_name: str) -> Optiona
     return None
 
 
+def clear_application_caches():
+    """
+    Clear the application caches.
+    """
+    get_all_applications.cache_clear()
+    get_application_id_by_name.cache_clear()
+
+
 def get_application_groups(client: PlatformClient, app_id: str) -> List[GroupSummary]:
     """
     Get the groups to which an application belongs.
@@ -679,6 +705,7 @@ def get_user_groups(client: PlatformClient, user_id: str) -> List[GroupSummary]:
     return client.account_client.get_user_groups(user_id).list_all()
 
 
+@lru_cache
 def get_user_by_name_or_id(
     client: PlatformClient, user_name_or_id: str
 ) -> Optional[User]:

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2}/yellowdog_cli/utils/items.py

@@ -20,6 +20,7 @@ from yellowdog_client.model import (
     NamespaceStorageConfiguration,
     Node,
     ObjectPath,
+    PermissionDetail,
     ProvisionedWorkerPool,
     Role,
     Task,
@@ -50,6 +51,7 @@ Item = TypeVar(
     NamespaceStorageConfiguration,
     Node,
     ObjectPath,
+    PermissionDetail,
     ProvisionedWorkerPool,
     Role,
     Task,

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2}/yellowdog_cli/utils/load_resources.py

@@ -21,6 +21,7 @@ from yellowdog_cli.utils.settings import (
     RN_SOURCE_TEMPLATE,
     RN_STORAGE_CONFIGURATION,
     RN_STRING_ATTRIBUTE_DEFINITION,
+    RN_USER,
 )
 from yellowdog_cli.utils.variables import (
     load_json_file_with_variable_substitutions,
@@ -113,6 +114,7 @@ def _resequence_resources(
         RN_CONFIGURED_POOL,
         RN_GROUP,
         RN_APPLICATION,
+        RN_USER,
     ]
 
     try:

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2}/yellowdog_cli/utils/printing.py

@@ -41,6 +41,7 @@ from yellowdog_client.model import (
     Node,
     ObjectDetail,
     ObjectPath,
+    PermissionDetail,
     ProvisionedWorkerPool,
     ProvisionedWorkerPoolProperties,
     Role,
@@ -230,6 +231,7 @@ TYPE_MAP = {
     NamespacePolicy: "Namespace Policy",
     Node: "Node",
     ObjectPath: "Object Path",
+    PermissionDetail: "Permission",
     ProvisionedWorkerPool: "Provisioned Worker Pool",
     Task: "Task",
     TaskGroup: "Task Group",
@@ -831,6 +833,29 @@ def roles_table(
     return headers, table
 
 
+def permissions_table(
+    permissions: List[PermissionDetail],
+) -> (List[str], List[List]):
+    headers = [
+        "#",
+        "Name",
+        "Description",
+        "Includes",
+    ]
+    table = []
+    for index, permission in enumerate(permissions):
+        includes = ", ".join(sorted([x for x in permission.includes]))
+        table.append(
+            [
+                index + 1,
+                permission.name,
+                permission.title,
+                includes,
+            ]
+        )
+    return headers, table
+
+
 def print_numbered_object_list(
     client: PlatformClient,
     objects: List[Union[Item, str, Dict]],
@@ -899,6 +924,8 @@ def print_numbered_object_list(
         headers, table = groups_table(objects)
     elif isinstance(objects[0], Role):
         headers, table = roles_table(objects)
+    elif isinstance(objects[0], PermissionDetail):
+        headers, table = permissions_table(objects)
     else:
         table = []
         for index, obj in enumerate(objects):

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2}/yellowdog_cli/utils/settings.py

@@ -82,7 +82,7 @@ HIGHLIGHTED_STATES = [
     r"(?P<starved>STARVED)",
     r"(?P<transitioning>CONFIGURING)",
     r"(?P<transitioning>DOWNLOADING)",
-    r"(?P<transitioning>LATE)",
+    # r"(?P<transitioning>LATE$)",
     r"(?P<transitioning>NEW)",
     r"(?P<transitioning>PROVISIONING)",
     r"(?P<transitioning>STOPPING)",

{yellowdog_python_examples-7.17.1 → yellowdog_python_examples-7.17.2/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.17.1
+Version: 7.17.2
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 Project-URL: Homepage, https://github.com/yellowdog/python-examples

yellowdog_python_examples-7.17.1/yellowdog_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "7.17.1"