yellowdog-python-examples 7.20.3__tar.gz → 8.0.0__tar.gz

{yellowdog_python_examples-7.20.3/yellowdog_python_examples.egg-info → yellowdog_python_examples-8.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.20.3
+Version: 8.0.0
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 License-Expression: Apache-2.0
@@ -26,7 +26,7 @@ Requires-Dist: requests
 Requires-Dist: rich==13.9.4
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: toml
-Requires-Dist: yellowdog-sdk>=11.2.0
+Requires-Dist: yellowdog-sdk>=11.2.1
 Provides-Extra: jsonnet
 Requires-Dist: jsonnet; extra == "jsonnet"
 Provides-Extra: cloudwizard

{yellowdog_python_examples-7.20.3 → yellowdog_python_examples-8.0.0}/README.md

@@ -2427,16 +2427,31 @@ Namespace Policies are matched by their `namespace` property when using `yd-crea
 
 ## Groups
 
-When creating and updating groups, a list of roles can can be supplied and the group will be created or updated with the roles specified. Roles can be identified by their names or YellowDog IDs.
+When creating and updating groups, a list of roles with their scopes can can be supplied and the group will be created or updated with the roles specified. Roles can be identified by their names or YellowDog IDs.
 
 Example:
 
 ```json
 {
-    "resource": "Group",
-    "name": "my-group",
-    "description": "Description of my group",
-    "roles" : ["work-viewer", "compute-viewer"]
+  "resource": "Group",
+  "name": "my-group",
+  "description": "Description of my group",
+  "roles": [
+    {
+      "role": {"name": "work-viewer"},
+      "scope": {"global": true}
+    },
+    {
+      "role": {"name": "work-manager"},
+      "scope": {
+        "global": false,
+        "namespaces": [
+          {"namespace": "namespace-1"},
+          {"namespace": "namespace-2"}
+        ]
+      }
+    }
+  ]
 }
 ```
 

{yellowdog_python_examples-7.20.3 → yellowdog_python_examples-8.0.0}/requirements.txt

@@ -5,4 +5,4 @@ requests
 rich == 13.9.4
 tabulate >= 0.9.0
 toml
-yellowdog-sdk >= 11.2.0
+yellowdog-sdk >= 11.2.1

{yellowdog_python_examples-7.20.3 → yellowdog_python_examples-8.0.0}/tests/test_list.py

@@ -57,3 +57,15 @@ class TestList:
     def test_allowances(self):
         result = shell("yd-list -A -n='' -t=''")
         assert result.exit_code == 0
+
+    def test_groups(self):
+        result = shell("yd-list --groups -n='' -t=''")
+        assert result.exit_code == 0
+
+    def test_roles(self):
+        result = shell("yd-list --roles -n='' -t=''")
+        assert result.exit_code == 0
+
+    def test_permissions(self):
+        result = shell("yd-list --permissions -n='' -t=''")
+        assert result.exit_code == 0

yellowdog_python_examples-8.0.0/yellowdog_cli/__init__.py

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

{yellowdog_python_examples-7.20.3 → yellowdog_python_examples-8.0.0}/yellowdog_cli/create.py

@@ -5,8 +5,9 @@ A script to create or update YellowDog resources.
 """
 
 from copy import deepcopy
+from dataclasses import dataclass
 from datetime import datetime
-from typing import Dict, List, Optional
+from typing import Dict, List, Optional, Set
 
 import yellowdog_client.model as model
 from dateparser import parse as date_parse
@@ -16,6 +17,7 @@ from yellowdog_client.model import (
     AccountAllowance,
     AddApplicationResponse,
     AddConfiguredWorkerPoolResponse,
+    AddGroupRequest,
     AllowanceLimitEnforcement,
     AllowanceResetType,
     ApiKey,
@@ -25,6 +27,7 @@ from yellowdog_client.model import (
     CloudProvider,
     CreateNamespaceRequest,
     Group,
+    GroupRole,
     ImageOsType,
     InstanceStatus,
     InternalUser,
@@ -38,6 +41,7 @@ from yellowdog_client.model import (
     RoleScope,
     SourceAllowance,
     SourcesAllowance,
+    UpdateGroupRequest,
     User,
 )
 from yellowdog_client.model.exceptions import InvalidRequestException
@@ -78,6 +82,7 @@ from yellowdog_cli.utils.settings import (
     PROP_DESCRIPTION,
     PROP_EFFECTIVE_FROM,
     PROP_EFFECTIVE_UNTIL,
+    PROP_GLOBAL,
     PROP_GROUPS,
     PROP_ID,
     PROP_IMAGE,
@@ -86,12 +91,15 @@ from yellowdog_cli.utils.settings import (
     PROP_KEYRING_NAME,
     PROP_NAME,
     PROP_NAMESPACE,
+    PROP_NAMESPACES,
     PROP_OPTIONS,
     PROP_OS_TYPE,
     PROP_RANGE,
     PROP_REQUIREMENT_CREATED_FROM,
     PROP_RESOURCE,
+    PROP_ROLE,
     PROP_ROLES,
+    PROP_SCOPE,
     PROP_SOURCE,
     PROP_SOURCE_CREATED_FROM,
     PROP_SOURCES,
@@ -100,7 +108,6 @@ from yellowdog_cli.utils.settings import (
     PROP_UNITS,
     PROP_USERNAME,
     RN_ADD_APPLICATION_REQUEST,
-    RN_ADD_GROUP_REQUEST,
     RN_ALLOWANCE,
     RN_APPLICATION,
     RN_CONFIGURED_POOL,
@@ -118,7 +125,6 @@ from yellowdog_cli.utils.settings import (
     RN_STORAGE_CONFIGURATION,
     RN_STRING_ATTRIBUTE_DEFINITION,
     RN_UPDATE_APPLICATION_REQUEST,
-    RN_UPDATE_GROUP_REQUEST,
 )
 from yellowdog_cli.utils.wrapper import ARGS_PARSER, CLIENT, CONFIG_COMMON, main_wrapper
 from yellowdog_cli.utils.ydid_utils import YDIDType, get_ydid_type
@@ -938,69 +944,171 @@ def create_namespace_policy(resource: Dict):
     )
 
 
+@dataclass
+class RoleSpecification:
+    """
+    Class to represent a compact expression of a role.
+    """
+
+    id: str
+    name: str
+    global_: Optional[bool]
+    namespaces: Optional[Set[str]]
+
+
 def create_group(resource: Dict):
     """
-    Create or update a group. Will also add or remove roles specified
-    by their names or IDs.
+    Create or update a group. Will also add or remove scoped
+    roles specified by their names or IDs.
     """
     try:
         name = resource[PROP_NAME]
+        description = resource.get(PROP_DESCRIPTION)
     except KeyError as e:
         raise Exception(f"Expected property to be defined ({e})")
 
-    roles: Optional[List[str]] = resource.pop(PROP_ROLES, None)
-
-    if roles is not None:
-        # Convert role names to IDs
-        new_role_ids = set()
-        for role_name in roles:
-            role_id = get_role_id_by_name(CLIENT, role_name)
-            if role_id is None:
-                print_warning(f"Role '{role_name}' not found ... ignoring")
-            else:
-                new_role_ids.add(role_id)
-
-    def update_roles(group: Group):
+    def get_updated_role_specifications() -> List[RoleSpecification]:
         """
-        Helper function to add/remove roles from a group.
+        Helper function to generate the list of supplied role specifications.
         """
-        if roles is None:
-            return
-
-        current_role_ids = {role.role.id for role in group.roles}
+        roles_input = resource.get(PROP_ROLES)
+        if roles_input is None:
+            return []
+
+        role_specifications = []
+        for role_item in roles_input:
+            # Get the role
+            role = role_item.get(PROP_ROLE)
+            if role is None:
+                raise Exception("Role must have 'role' property")
+
+            # Get the ID and name of the role
+            id_ = role.get(PROP_ID)
+            if id_ is None:
+                name_ = role.get(PROP_NAME)
+                if name_ is None:
+                    raise Exception("Group role must have 'id' or 'name' specified")
+                id_ = get_role_id_by_name(CLIENT, name_)
+            else:
+                name_ = role.get(PROP_NAME)
+                if name_ is None:
+                    name_ = get_role_name_by_id(CLIENT, id_)
+
+            # Get the scope of the role
+            scope = role_item.get(PROP_SCOPE)
+            if scope is None:
+                raise Exception(f"Group role '{name_}' must have 'scope' specified")
+            global_ = scope.get(PROP_GLOBAL)
+            if global_ is None or global_ is False:
+                namespaces_ = scope.get(PROP_NAMESPACES)
+                if namespaces_ is None:
+                    raise Exception(
+                        f"Non-global group role '{name_}' must have 'namespaces' specified"
+                    )
+                namespace_names = []
+                for namespace_ in namespaces_:
+                    namespace_name = namespace_.get(PROP_NAMESPACE)
+                    if namespace_name is None:
+                        raise Exception(
+                            f"Namespace applied to role '{name_}' "
+                            "must have 'namespace' property"
+                        )
+                    namespace_names.append(namespace_name)
+
+                # Construct the role specification & add to the list
+                if len(namespace_names) == 0:
+                    raise Exception(
+                        f"Non-global role '{name_}' must have at least one namespace scope"
+                    )
+                role_specifications.append(
+                    RoleSpecification(
+                        id=id_,
+                        name=name_,
+                        global_=False,
+                        namespaces=set(namespace_names),
+                    )
+                )
+            else:
+                role_specifications.append(
+                    RoleSpecification(id=id_, name=name_, global_=True, namespaces=None)
+                )
 
-        if current_role_ids == new_role_ids:
-            print_log("No Role additions or deletions required")
-            return
+        return role_specifications
 
-        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)
-            print_log(
-                f"Removed Role '{get_role_name_by_id(CLIENT, role_id)}' "
-                f"from Group ({role_id})"
+    def add_or_update_roles(role_specifications: List[RoleSpecification]):
+        """
+        Helper function to add/update a list of roles.
+        """
+        for role_spec in role_specifications:
+            CLIENT.account_client.add_role_to_group(
+                group_id,
+                role_spec.id,
+                RoleScope(role_spec.global_, role_spec.namespaces),
             )
+            if role_spec.global_:
+                print_log(f"Added/updated role '{role_spec.name}' with global scope")
+            else:
+                ns_list_quoted = [f"'{ns}'" for ns in role_spec.namespaces]
+                print_log(
+                    f"Added/updated role '{role_spec.name}' scoped to "
+                    f"namespace(s): {', '.join(ns_list_quoted)}"
+                )
 
-        role_ids_to_add = new_role_ids - current_role_ids
-        for role_id in role_ids_to_add:
-            CLIENT.account_client.add_role_to_group(
-                group.id, role_id, RoleScope(global_=True)
+    def remove_roles(role_specifications: List[RoleSpecification]):
+        """
+        Helper function to remove a list of roles.
+        """
+        for role_spec in role_specifications:
+            CLIENT.account_client.remove_role_from_group(
+                group_id,
+                role_spec.id,
             )
-            print_log(
-                f"Added Role '{get_role_name_by_id(CLIENT, role_id)}' "
-                f"to Group ({role_id})"
+            if role_spec.global_:
+                print_log(f"Removed role '{role_spec.name}' with global scope")
+            else:
+                ns_list_quoted = [f"'{ns}'" for ns in role_spec.namespaces]
+                print_log(
+                    f"Removed role '{role_spec.name}' scoped to "
+                    f"namespace(s): {', '.join(ns_list_quoted)}"
+                )
+
+    def get_roles_to_remove(
+        existing_roles: List[GroupRole], new_roles: List[RoleSpecification]
+    ) -> List[RoleSpecification]:
+        """
+        Helper function to determine the roles to be removed.
+        """
+        existing_role_specifications = [
+            RoleSpecification(
+                id=role.role.id,
+                name=role.role.name,
+                global_=role.scope.global_,
+                namespaces=(
+                    None
+                    if role.scope.namespaces is None
+                    else set([ns.namespace for ns in role.scope.namespaces])
+                ),
             )
+            for role in existing_roles
+        ]
+        # Select roles to remove
+        return [
+            role_spec
+            for role_spec in existing_role_specifications
+            if role_spec.name not in [role_spec.name for role_spec in new_roles]
+        ]
 
-    def add_group():
+    def add_group() -> str:
         """
-        Helper function to add a new group and its roles.
+        Helper function to add a new group.
+        Return the ID of the newly created group.
         """
         group: Group = CLIENT.account_client.add_group(
-            _get_model_object(RN_ADD_GROUP_REQUEST, resource)
+            AddGroupRequest(name=name, description=description)
         )
         print_log(f"Created Group '{group.name}' ({group.id})")
         clear_group_caches()
-        update_roles(group)
+        return group.id
 
     def update_group(group_id: str):
         """
@@ -1009,18 +1117,20 @@ def create_group(resource: Dict):
         """
         if not confirmed(f"Update Group '{name}' ({group_id})?"):
             return
-
         group: Group = CLIENT.account_client.update_group(
-            group_id, _get_model_object(RN_UPDATE_GROUP_REQUEST, resource)
+            group_id, UpdateGroupRequest(name=name, description=description)
         )
         print_log(f"Updated Group '{group.name}' ({group.id})")
-        update_roles(group)
+        updated_role_specs = get_updated_role_specifications()
+        remove_roles(get_roles_to_remove(group.roles, updated_role_specs))
+        add_or_update_roles(updated_role_specs)
 
     # Main logic
     group_id = get_group_id_by_name(CLIENT, name)
-    if group_id is None:
-        add_group()
-    else:
+    if group_id is None:  # New group
+        group_id = add_group()
+        add_or_update_roles(get_updated_role_specifications())
+    else:  # Existing group
         update_group(group_id)
 
 

{yellowdog_python_examples-7.20.3 → yellowdog_python_examples-8.0.0}/yellowdog_cli/list.py

@@ -62,6 +62,7 @@ from yellowdog_cli.utils.entity_utils import (
     get_user_groups,
     get_worker_pools,
     list_matching_object_paths,
+    substitute_id_for_name_in_allowance,
     substitute_ids_for_names_in_crt,
     substitute_image_family_id_for_name_in_cst,
 )
@@ -807,14 +808,26 @@ def list_allowances():
         print_log("No Allowances to display")
         return
 
+    if ARGS_PARSER.ids_only:
+        for allowance in allowances:
+            print(allowance.id)
+        return
+
     if not ARGS_PARSER.details:
         print_numbered_object_list(CLIENT, allowances)
         return
 
     # Show details
+    if len(allowances) > 0 and ARGS_PARSER.substitute_ids:
+        print_log(
+            "Substituting Compute Requirement Template IDs with names (if applicable)"
+        )
     print_yd_object_list(
         [
-            (allowance, {PROP_RESOURCE: RN_ALLOWANCE})
+            (
+                substitute_id_for_name_in_allowance(CLIENT, allowance),
+                {PROP_RESOURCE: RN_ALLOWANCE},
+            )
             for allowance in select(CLIENT, allowances)
         ]
     )
@@ -1010,12 +1023,6 @@ def list_groups():
 
     selected_groups = select(CLIENT, groups)
 
-    # If stripping IDs, just supply the list of role names;
-    # subverts the type
-    if ARGS_PARSER.strip_ids:
-        for group in selected_groups:
-            group.roles = [group_role.role.name for group_role in group.roles]
-
     print_yd_object_list(
         [(group, {PROP_RESOURCE: RN_GROUP}) for group in selected_groups]
     )

{yellowdog_python_examples-7.20.3 → yellowdog_python_examples-8.0.0}/yellowdog_cli/utils/entity_utils.py

@@ -8,6 +8,7 @@ from typing import Callable, List, Optional, Tuple, Union
 from yellowdog_client import PlatformClient
 from yellowdog_client.common import SearchClient
 from yellowdog_client.model import (
+    AccountAllowance,
     AllowanceSearch,
     Application,
     ApplicationSearch,
@@ -635,11 +636,17 @@ def substitute_image_family_id_for_name_in_cst(
 
 def substitute_id_for_name_in_allowance(
     client: PlatformClient,
-    allowance: Union[RequirementsAllowance, SourcesAllowance, SourceAllowance],
-) -> Union[RequirementsAllowance, SourcesAllowance, SourceAllowance]:
+    allowance: Union[
+        AccountAllowance, RequirementsAllowance, SourcesAllowance, SourceAllowance
+    ],
+) -> Union[AccountAllowance, RequirementsAllowance, SourcesAllowance, SourceAllowance]:
     """
     Substitute IDs in Allowance objects.
     """
+
+    if not ARGS_PARSER.substitute_ids:
+        return allowance
+
     if isinstance(allowance, RequirementsAllowance):
         allowance.requirementCreatedFromId = _get_requirement_template_name_from_id(
             client, allowance.requirementCreatedFromId
@@ -650,9 +657,7 @@ def substitute_id_for_name_in_allowance(
             client, allowance.sourceCreatedFromId
         )
 
-    elif isinstance(allowance, SourceAllowance):
-        # No processing for source allowances
-        pass
+    # No processing for other allowance types
 
     return allowance
 

{yellowdog_python_examples-7.20.3 → yellowdog_python_examples-8.0.0}/yellowdog_cli/utils/settings.py

@@ -154,6 +154,7 @@ PROP_DELETABLE = "deletable"
 PROP_DESCRIPTION = "description"
 PROP_EFFECTIVE_FROM = "effectiveFrom"
 PROP_EFFECTIVE_UNTIL = "effectiveUntil"
+PROP_GLOBAL = "global"
 PROP_GROUPS = "groups"
 PROP_ID = "id"
 PROP_IMAGE = "image"
@@ -164,13 +165,16 @@ PROP_KEYRING = "keyring"
 PROP_KEYRING_NAME = "keyringName"
 PROP_NAME = "name"
 PROP_NAMESPACE = "namespace"
+PROP_NAMESPACES = "namespaces"
 PROP_OPTIONS = "options"
 PROP_OS_TYPE = "osType"
 PROP_RANGE = "range"
 PROP_REMAINING_HOURS = "remainingHours"
 PROP_REQUIREMENT_CREATED_FROM = "requirementCreatedFromId"
 PROP_RESOURCE = "resource"
+PROP_ROLE = "role"
 PROP_ROLES = "roles"
+PROP_SCOPE = "scope"
 PROP_SOURCE = "source"
 PROP_SOURCES = "sources"
 PROP_SOURCE_CREATED_FROM = "sourceCreatedFromId"

{yellowdog_python_examples-7.20.3 → yellowdog_python_examples-8.0.0/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.20.3
+Version: 8.0.0
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 License-Expression: Apache-2.0
@@ -26,7 +26,7 @@ Requires-Dist: requests
 Requires-Dist: rich==13.9.4
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: toml
-Requires-Dist: yellowdog-sdk>=11.2.0
+Requires-Dist: yellowdog-sdk>=11.2.1
 Provides-Extra: jsonnet
 Requires-Dist: jsonnet; extra == "jsonnet"
 Provides-Extra: cloudwizard

{yellowdog_python_examples-7.20.3 → yellowdog_python_examples-8.0.0}/yellowdog_python_examples.egg-info/requires.txt

@@ -5,7 +5,7 @@ requests
 rich==13.9.4
 tabulate>=0.9.0
 toml
-yellowdog-sdk>=11.2.0
+yellowdog-sdk>=11.2.1
 
 [cloudwizard]
 boto3

yellowdog_python_examples-7.20.3/yellowdog_cli/__init__.py

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