globus-cli 3.27.0__tar.gz → 3.28.0__tar.gz

{globus-cli-3.27.0/src/globus_cli.egg-info → globus_cli-3.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: globus-cli
-Version: 3.27.0
+Version: 3.28.0
 Summary: Globus CLI
 Author-email: Stephen Rosen <sirosen@globus.org>
 Project-URL: homepage, https://github.com/globus/globus-cli
@@ -18,7 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: globus-sdk==3.39.0
+Requires-Dist: globus-sdk==3.41.0
 Requires-Dist: click<9,>=8.1.4
 Requires-Dist: jmespath==1.0.1
 Requires-Dist: packaging>=17.0

{globus-cli-3.27.0 → globus_cli-3.28.0}/pyproject.toml

@@ -28,7 +28,7 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
-    "globus-sdk==3.39.0",
+    "globus-sdk==3.41.0",
     "click>=8.1.4,<9",
     "jmespath==1.0.1",
     "packaging>=17.0",

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/commands/flows/__init__.py

@@ -6,6 +6,7 @@ from globus_cli.parsing import group
     lazy_subcommands={
         "create": (".create", "create_command"),
         "update": (".update", "update_command"),
+        "validate": (".validate", "validate_command"),
         "delete": (".delete", "delete_command"),
         "list": (".list", "list_command"),
         "show": (".show", "show_command"),

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/commands/flows/_common.py

@@ -1,12 +1,13 @@
+from __future__ import annotations
+
+import typing as t
+import uuid
+
 import click
 
 from globus_cli.parsing import JSONStringOrFile
 
-input_schema_option = click.option(
-    "--input-schema",
-    "input_schema",
-    type=JSONStringOrFile(),
-    help="""
+_input_schema_helptext = """
         The JSON input schema that governs the parameters
         used to start the flow.
 
@@ -21,11 +22,22 @@ input_schema_option = click.option(
 
         \b
             --input-schema schema.json
+    """
 
-        If unspecified, the default is an empty JSON object ('{}').
-    """,
+input_schema_option = click.option(
+    "--input-schema",
+    "input_schema",
+    type=JSONStringOrFile(),
+    help=_input_schema_helptext,
 )
 
+input_schema_option_with_default = click.option(
+    "--input-schema",
+    "input_schema",
+    type=JSONStringOrFile(),
+    help=_input_schema_helptext
+    + "\n    If unspecified, the default is an empty JSON object ('{}').",
+)
 
 subtitle_option = click.option(
     "--subtitle",
@@ -102,3 +114,30 @@ keywords_option = click.option(
         to create a list of keywords.
     """,
 )
+
+
+class SubscriptionIdType(click.ParamType):
+    name = "SUBSCRIPTION_ID"
+
+    def convert(
+        self, value: str, param: click.Parameter | None, ctx: click.Context | None
+    ) -> uuid.UUID | t.Literal["DEFAULT"]:
+        if value.upper() == "DEFAULT":
+            return "DEFAULT"
+        try:
+            return uuid.UUID(value)
+        except ValueError:
+            self.fail(f"{value} must be either a UUID or 'DEFAULT'", param, ctx)
+
+
+subscription_id_option = click.option(
+    "--subscription-id",
+    "subscription_id",
+    type=SubscriptionIdType(),
+    multiple=False,
+    help="""
+        A subscription ID to assign to the flow.
+
+        The value may be a UUID or the word "DEFAULT".
+    """,
+)

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/commands/flows/create.py

@@ -7,7 +7,7 @@ import click
 from globus_cli.commands.flows._common import (
     administrators_option,
     description_option,
-    input_schema_option,
+    input_schema_option_with_default,
     keywords_option,
     starters_option,
     subtitle_option,
@@ -31,7 +31,7 @@ ROLE_TYPES = ("flow_viewer", "flow_starter", "flow_administrator", "flow_owner")
     type=JSONStringOrFile(),
     metavar="DEFINITION",
 )
-@input_schema_option
+@input_schema_option_with_default
 @subtitle_option
 @description_option
 @administrators_option

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/commands/flows/run/resume.py

@@ -129,5 +129,7 @@ def _has_required_consent(
 ) -> bool:
     auth_client = login_manager.get_auth_client()
     user_identity_id = get_current_identity_id()
-    consents = auth_client.get_consents(user_identity_id)
-    return consents.contains_scopes(required_scopes)
+    consents = auth_client.get_consents(user_identity_id).to_forest()
+    # FIXME: this type ignore is temporary because `meets_scope_requirements()`
+    # has too tight of a type
+    return consents.meets_scope_requirements(required_scopes)  # type: ignore[arg-type]

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/commands/flows/update.py

@@ -1,12 +1,15 @@
 from __future__ import annotations
 
+import typing as t
 import uuid
 
 import click
+from globus_sdk.utils import MISSING
 
 from globus_cli.commands.flows._common import (
     description_option,
-    input_schema_option,
+    input_schema_option_with_default,
+    subscription_id_option,
     subtitle_option,
 )
 from globus_cli.login_manager import LoginManager
@@ -60,7 +63,7 @@ ROLE_TYPES = ("flow_viewer", "flow_starter", "flow_administrator", "flow_owner")
 )
 @subtitle_option
 @description_option
-@input_schema_option
+@input_schema_option_with_default
 @click.option(
     "--administrators",
     type=CommaDelimitedList(),
@@ -104,6 +107,7 @@ ROLE_TYPES = ("flow_viewer", "flow_starter", "flow_administrator", "flow_owner")
         Passing an empty string will clear any existing keywords.
     """,
 )
+@subscription_id_option
 @LoginManager.requires_login("flows")
 def update_command(
     login_manager: LoginManager,
@@ -119,6 +123,7 @@ def update_command(
     starters: list[str] | None,
     viewers: list[str] | None,
     keywords: list[str] | None,
+    subscription_id: uuid.UUID | t.Literal["DEFAULT"] | None,
 ) -> None:
     """
     Update a flow.
@@ -154,6 +159,7 @@ def update_command(
         flow_starters=starters,
         flow_viewers=viewers,
         keywords=keywords,
+        subscription_id=subscription_id or MISSING,
     )
 
     # Configure formatters for principals
@@ -170,6 +176,7 @@ def update_command(
         Field("Description", "description"),
         Field("Keywords", "keywords", formatter=formatters.ArrayFormatter()),
         Field("Owner", "flow_owner", formatter=principal_formatter),
+        Field("Subscription ID", "subscription_id"),
         Field("Created At", "created_at", formatter=formatters.Date),
         Field("Updated At", "updated_at", formatter=formatters.Date),
         Field(

globus_cli-3.28.0/src/globus_cli/commands/flows/validate.py

@@ -0,0 +1,106 @@
+from __future__ import annotations
+
+import click
+import globus_sdk
+
+from globus_cli.commands.flows._common import input_schema_option
+from globus_cli.login_manager import LoginManager
+from globus_cli.parsing import JSONStringOrFile, ParsedJSONData, command
+from globus_cli.termio import Field, display
+
+
+@command("validate", short_help="Validate a flow definition")
+@click.argument(
+    "definition",
+    type=JSONStringOrFile(),
+    metavar="DEFINITION",
+)
+@input_schema_option
+@LoginManager.requires_login("flows")
+def validate_command(
+    login_manager: LoginManager,
+    *,
+    definition: ParsedJSONData,
+    input_schema: ParsedJSONData | None,
+) -> None:
+    """
+    Validate a flow definition (BETA).
+
+    DEFINITION is the JSON document that defines the flow's instructions.
+    The definition document may be specified inline, or it may be
+    a path to a JSON file.
+
+        Example: Inline JSON:
+
+        \b
+            globus flows validate \\
+            '{{"StartAt": "a", "States": {{"a": {{"Type": "Pass", "End": true}}}}}}'
+
+        Example: Path to JSON file:
+
+        \b
+            globus flows validate definition.json
+    """
+    payload = {}
+
+    # Ensure that the definition is a JSON object
+    if not isinstance(definition.data, dict):
+        raise click.UsageError("Flow definition must be a JSON object")
+    payload["definition"] = definition.data
+
+    # Ensure the input schema, if provided, is a JSON object
+    if input_schema is not None:
+        if not isinstance(input_schema.data, dict):
+            raise click.UsageError("--input-schema must be a JSON object")
+        payload["input_schema"] = input_schema.data
+
+    # Configure client
+    flows_client = login_manager.get_flows_client()
+
+    res = flows_client.validate_flow(**payload)
+
+    display(
+        res,
+        text_mode=_validate_flow_output_handler,
+    )
+
+
+def _validate_flow_output_handler(result: globus_sdk.GlobusHTTPResponse) -> None:
+    # Discovered scopes output
+    analysis_response = result.get("analysis")
+    # Beta API: Defend against the case where 'analysis' is no longer returned
+    if analysis_response is not None:
+        _validate_flow_analysis_output_handler(analysis_response)
+        click.echo()
+
+    scopes_response = result.get("scopes")
+    # Beta API: Defend against the case where 'scopes' is no longer returned
+    if scopes_response is not None:
+        _validate_flow_scope_output_handler(scopes_response)
+
+
+def _validate_flow_scope_output_handler(scopes_response: dict[str, str]) -> None:
+    # Always include User and Flow scopes
+    scopes_fields = [Field("RunAs", "RunAs"), Field("Scope", "scope")]
+    scope_entries = [
+        {"RunAs": k, "scope": scope}
+        for k, scopes in scopes_response.items()
+        for scope in scopes
+    ]
+    click.echo("Discovered Scopes")
+    click.echo("=================")
+    if scope_entries:
+        display.render_table(
+            scope_entries,
+            fields=scopes_fields,
+        )
+    else:
+        click.echo("No scopes discovered")
+
+
+def _validate_flow_analysis_output_handler(analysis_response: dict[str, str]) -> None:
+    # Always include the analysis output
+    click.echo("Analysis")
+    click.echo("========")
+    if count := analysis_response.get("number_of_possibilities"):
+        click.echo(f"Possible State Traversals: {count}")

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/commands/timer/create/transfer.py

@@ -315,13 +315,13 @@ def _derive_missing_scopes(
     user_identity_id = get_current_identity_id()
 
     # get the user's Globus CLI consents
-    consents = auth_client.get_consents(user_identity_id)
+    consents = auth_client.get_consents(user_identity_id).to_forest()
 
     # check the 'needs_data_access' scope names against the 3rd-order dependencies
     # of the Timer scope and record the names of the ones which we need to request
     will_request_data_access: list[str] = []
     for name, scope_object in scopes_needed.items():
-        if not consents.contains_scopes([scope_object]):
+        if not consents.meets_scope_requirements([str(scope_object)]):
             will_request_data_access.append(name)
 
     # return these ultimately filtered requirements

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/commands/timer/resume.py

@@ -122,5 +122,7 @@ def _has_required_consent(
 ) -> bool:
     auth_client = login_manager.get_auth_client()
     user_identity_id = get_current_identity_id()
-    consents = auth_client.get_consents(user_identity_id)
-    return consents.contains_scopes(required_scopes)
+    consents = auth_client.get_consents(user_identity_id).to_forest()
+    # FIXME: this type ignore is temporary because `meets_scope_requirements()`
+    # has too tight of a type
+    return consents.meets_scope_requirements(required_scopes)  # type: ignore[arg-type]

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/exception_handling/hooks.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import json
+import textwrap
 import typing as t
 
 import click
@@ -20,6 +21,38 @@ def _pretty_json(data: dict, compact: bool = False) -> str:
     return json.dumps(data, indent=2, separators=(",", ": "), sort_keys=True)
 
 
+_JSONPATH_SPECIAL_CHARS = "[]'\"\\."
+_JSONPATH_ESCAPE_MAP = str.maketrans(
+    {
+        "'": "\\'",
+        "\\": "\\\\",
+    }
+)
+
+
+def _jsonpath_from_pydantic_loc(loc: list[str | int]) -> str:
+    """
+    Given a 'loc' from pydantic error data, convert it into a JSON Path expression.
+
+    Takes the following steps:
+    - turns integers into integer indices
+    - turns most strings into dotted access
+    - turns strings containing special characters into single-quoted bracket access
+      with ' and \\ escaped
+    """
+    path = "$"
+    for part in loc:
+        if isinstance(part, int):
+            path += f"[{part}]"
+        else:
+            if any(c in part for c in _JSONPATH_SPECIAL_CHARS):
+                part = f"'{part.translate(_JSONPATH_ESCAPE_MAP)}'"
+                path += f"[{part}]"
+            else:
+                path += f".{part}"
+    return path
+
+
 _DEFAULT_SESSION_REAUTH_MESSAGE = (
     "The resource you are trying to access requires you to re-authenticate."
 )
@@ -271,6 +304,82 @@ def searchapi_hook(exception: globus_sdk.SearchAPIError) -> None:
     write_error_info("Search API Error", fields)
 
 
+@sdk_error_handler(
+    error_class="FlowsAPIError",
+    condition=lambda err: err.code == "UNPROCESSABLE_ENTITY",
+)
+def flows_validation_error_hook(exception: globus_sdk.FlowsAPIError) -> None:
+    message_string: str = exception.raw_json["error"]["message"]  # type: ignore[index]
+    details: str | list[dict[str, t.Any]] = exception.raw_json["error"]["detail"]  # type: ignore[index] # noqa: E501
+    message_fields = [PrintableErrorField("message", message_string)]
+
+    # conditionally do this work if there are multiple details
+    if isinstance(details, list) and len(details) > 1:
+        num_errors = len(details)
+        # try to extract 'loc' and 'msg' from the details, but only
+        # update 'message_fields' if the data are present
+        try:
+            messages = [
+                f"{_jsonpath_from_pydantic_loc(data['loc'])}: {data['msg']}"
+                for data in details
+            ]
+        except KeyError:
+            pass
+        else:
+            message_fields = [
+                PrintableErrorField(
+                    "message", f"{num_errors} validation errors", multiline=True
+                ),
+                PrintableErrorField(
+                    "errors",
+                    "\n".join(messages),
+                    multiline=True,
+                ),
+            ]
+
+    write_error_info(
+        "Flows API Error",
+        [
+            PrintableErrorField("HTTP status", exception.http_status),
+            PrintableErrorField("code", exception.code),
+            *message_fields,
+        ],
+    )
+
+
+@sdk_error_handler(error_class="FlowsAPIError")
+def flows_error_hook(exception: globus_sdk.FlowsAPIError) -> None:
+    details: list[dict[str, t.Any]] | str = exception.raw_json["error"]["detail"]  # type: ignore[index] # noqa: E501
+    detail_fields: list[PrintableErrorField] = []
+
+    # if the detail is a string, return that as a single field
+    if isinstance(details, str):
+        if len(details) > 120:
+            details = textwrap.fill(details, width=80)
+        detail_fields = [PrintableErrorField("detail", details, multiline=True)]
+    # if it's a list of objects, wrap them into a multiline detail field
+    else:
+        detail_fields = [
+            PrintableErrorField(
+                "detail",
+                "\n".join(_pretty_json(detail, compact=True) for detail in details),
+                multiline=True,
+            )
+        ]
+
+    write_error_info(
+        "Flows API Error",
+        [
+            PrintableErrorField("HTTP status", exception.http_status),
+            PrintableErrorField("code", exception.code),
+            PrintableErrorField(
+                "message", exception.raw_json["error"]["message"]  # type: ignore[index]
+            ),
+            *detail_fields,
+        ],
+    )
+
+
 @sdk_error_handler(
     error_class="AuthAPIError",
     condition=lambda err: err.message == "invalid_grant",

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/login_manager/manager.py

@@ -7,6 +7,7 @@ import uuid
 
 import click
 import globus_sdk
+from globus_sdk.experimental.consents import ConsentForest
 from globus_sdk.experimental.scope_parser import Scope
 from globus_sdk.scopes import (
     AuthScopes,
@@ -37,7 +38,7 @@ from .tokenstore import (
 from .utils import get_current_identity_id, is_remote_session
 
 if t.TYPE_CHECKING:
-    from ..services.auth import ConsentForestResponse, CustomAuthClient
+    from ..services.auth import CustomAuthClient
     from ..services.gcs import CustomGCSClient
     from ..services.transfer import CustomTransferClient
 
@@ -178,14 +179,19 @@ class LoginManager:
         else:
             # If there are dependent scopes all required scope paths are present in the
             #   user's cached consent forest.
-            return self._cached_consent_forest.contains_scopes(required_scopes)
+            #
+            # FIXME: this type ignore is temporary because `meets_scope_requirements()`
+            # has too tight of a type
+            return self._cached_consent_forest.meets_scope_requirements(
+                required_scopes  # type: ignore[arg-type]
+            )
 
     @property
     @functools.lru_cache(maxsize=1)  # noqa: B019
-    def _cached_consent_forest(self) -> ConsentForestResponse:
+    def _cached_consent_forest(self) -> ConsentForest:
         identity_id = get_current_identity_id()
 
-        return self.get_auth_client().get_consents(identity_id)
+        return self.get_auth_client().get_consents(identity_id).to_forest()
 
     def run_login_flow(
         self,

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/parsing/commands.py

@@ -212,6 +212,10 @@ class TopLevelGroup(GlobusCommandGroup):
     def invoke(self, ctx: click.Context) -> t.Any:
         try:
             return super().invoke(ctx)
+        # explicitly re-raise any IOError (e.g. broken pipe) in order to engage
+        # click's existing handling of broken pipes
+        except OSError:
+            raise
         except Exception:
             # mypy thinks that exc_info could be (None, None, None), but... nope. False.
             custom_except_hook(sys.exc_info())  # type: ignore[arg-type]

globus_cli-3.28.0/src/globus_cli/services/auth.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+import typing as t
+import uuid
+
+import globus_sdk
+import globus_sdk.scopes
+
+
+def _is_uuid(s: str) -> bool:
+    try:
+        uuid.UUID(s)
+        return True
+    except ValueError:
+        return False
+
+
+class GetIdentitiesKwargs(t.TypedDict, total=False):
+    provision: bool
+    usernames: str
+    ids: str
+
+
+class CustomAuthClient(globus_sdk.AuthClient):
+    def _lookup_identity_field(
+        self,
+        id_name: str | None = None,
+        id_id: str | None = None,
+        field: t.Literal["id", "username"] = "id",
+        provision: bool = False,
+    ) -> str | None:
+        assert (id_name or id_id) and not (id_name and id_id)
+
+        kw: GetIdentitiesKwargs = dict(provision=provision)
+        if id_name:
+            kw["usernames"] = id_name
+        elif id_id:
+            kw["ids"] = id_id
+        else:
+            raise NotImplementedError("must provide id or name")
+
+        try:
+            value = self.get_identities(**kw)["identities"][0][field]
+        # capture any failure to lookup this data, including:
+        # - identity doesn't exist (`identities=[]`)
+        # - field is missing
+        except LookupError:
+            return None
+
+        if not isinstance(value, str):
+            return None
+
+        return value
+
+    # this method has been added in the latest SDK versions but is not
+    # present in the last release
+    # this is therefore temporary until an SDK release ships with the change
+    # so that CLI testing against SDK main can succeed
+    if not hasattr(globus_sdk.AuthClient, "userinfo"):
+        userinfo = globus_sdk.AuthClient.oauth2_userinfo
+
+    @t.overload
+    def maybe_lookup_identity_id(
+        self, identity_name: str, provision: t.Literal[True]
+    ) -> str: ...
+
+    @t.overload
+    def maybe_lookup_identity_id(
+        self, identity_name: str, provision: bool = False
+    ) -> str | None: ...
+
+    def maybe_lookup_identity_id(
+        self, identity_name: str, provision: bool = False
+    ) -> str | None:
+        if _is_uuid(identity_name):
+            return identity_name
+        else:
+            return self._lookup_identity_field(
+                id_name=identity_name, provision=provision
+            )
+
+    def lookup_identity_name(self, identity_id: str) -> str | None:
+        return self._lookup_identity_field(id_id=identity_id, field="username")

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/termio/printer.py

@@ -170,7 +170,6 @@ class Renderer:
     TABLE = TextMode.text_table
     SILENT = TextMode.silent
     JSON = TextMode.json
-    TABLE = TextMode.text_table
     RECORD = TextMode.text_record
     RECORD_LIST = TextMode.text_record_list
     RAW = TextMode.text_raw
@@ -200,6 +199,14 @@ class Renderer:
             sort_json_keys=sort_json_keys,
         )
 
+    def render_table(
+        self,
+        iterable: t.Iterable[t.Any],
+        fields: list[Field],
+        print_headers: bool = True,
+    ) -> None:
+        print_table(iterable, fields, print_headers)
+
 
 display = Renderer()
 

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli/version.py

@@ -7,7 +7,7 @@ if t.TYPE_CHECKING:
 
 # single source of truth for package version,
 # see https://packaging.python.org/en/latest/single_source_version/
-__version__ = "3.27.0"
+__version__ = "3.28.0"
 
 # app name to send as part of SDK requests
 app_name = f"Globus CLI v{__version__}"

{globus-cli-3.27.0 → globus_cli-3.28.0/src/globus_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: globus-cli
-Version: 3.27.0
+Version: 3.28.0
 Summary: Globus CLI
 Author-email: Stephen Rosen <sirosen@globus.org>
 Project-URL: homepage, https://github.com/globus/globus-cli
@@ -18,7 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: globus-sdk==3.39.0
+Requires-Dist: globus-sdk==3.41.0
 Requires-Dist: click<9,>=8.1.4
 Requires-Dist: jmespath==1.0.1
 Requires-Dist: packaging>=17.0

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli.egg-info/SOURCES.txt

@@ -105,6 +105,7 @@ src/globus_cli/commands/flows/list.py
 src/globus_cli/commands/flows/show.py
 src/globus_cli/commands/flows/start.py
 src/globus_cli/commands/flows/update.py
+src/globus_cli/commands/flows/validate.py
 src/globus_cli/commands/flows/run/__init__.py
 src/globus_cli/commands/flows/run/cancel.py
 src/globus_cli/commands/flows/run/delete.py

{globus-cli-3.27.0 → globus_cli-3.28.0}/src/globus_cli.egg-info/requires.txt

@@ -1,4 +1,4 @@
-globus-sdk==3.39.0
+globus-sdk==3.41.0
 click<9,>=8.1.4
 jmespath==1.0.1
 packaging>=17.0