Added globus auth scope show command #1077

derek-globus · 2025-01-31T04:45:07Z

Added

New command globus auth scope show SCOPE_ID_OR_STRING
- Note: globus auth is a hidden command tree; Stephen and I discussed keeping it that way until we have 5+ commands registered under there.
New FieldFormatters:
- ArrayMultilineFormatter(ArrayFormatter) - Supports multiline formatted elements, adding a yaml-style - element start indicator to the beginning of each new one.
- RecordFormatter - Prints an object using the RecordPrinter into a buffered string.
New util,LazyDict - A dict with "key loaders" which will load values for specific keys when accessed the first time, caching the result.
New termio module: terminal_info with a global singleton TERM_INFO to centrally track and mutate content width.

Changed

Empty arrays render as [] instead of nothing.

Draft

~~This PR is in draft until:~~
1. ~~I have a chance to put the command in front of the auth team.~~
2. ~~I figure out how to figure out reserved_width in RecordFormatter; it's a pretty minute thing but is hardcoded right now.~~

Auth team has signed off in slack & I figured it out!

Usage

By Scope ID

Standard Output (dependent scope strings get loaded in a secondary batched call)

> globus auth scope show 24f3dcbe-7655-4721-bc64-d1c5d635b9a1
Scope String:          https://auth.globus.org/scopes/actions.globus.org/hello_world
Scope ID:              24f3dcbe-7655-4721-bc64-d1c5d635b9a1
Name:                  Hello World Action
Description:           Allow the Hello World action to extend greetings.
Client ID:             5fac2e64-c734-4e6b-90ea-ff12ddbf9653
Allows Refresh Tokens: True
Required Domains:      
Advertised:            True
Dependent Scopes:      
  - Scope String:           urn:globus:auth:scope:nexus.api.globus.org:groups
    Scope ID:               69a73d8f-cd45-4e37-bb3b-43678424aeb7
    Optional:               False
    Requires Refresh Token: False
  - Scope String:           urn:globus:auth:scope:groups.api.globus.org:view_my_groups_and_memberships
    Scope ID:               73320ffe-4cb4-4b25-a0a3-83d53d59ce4f
    Optional:               False
    Requires Refresh Token: False

JSON Output (no secondary dependent scope resolution call happens)

> globus auth scope show 24f3dcbe-7655-4721-bc64-d1c5d635b9a1 -F json                
{
  "scope": {
    "advertised": true,
    "allows_refresh_token": true,
    "client": "5fac2e64-c734-4e6b-90ea-ff12ddbf9653",
    "dependent_scopes": [
      {
        "optional": false,
        "requires_refresh_token": false,
        "scope": "69a73d8f-cd45-4e37-bb3b-43678424aeb7"
      },
      {
        "optional": false,
        "requires_refresh_token": false,
        "scope": "73320ffe-4cb4-4b25-a0a3-83d53d59ce4f"
      }
    ],
    "description": "Allow the Hello World action to extend greetings.",
    "id": "24f3dcbe-7655-4721-bc64-d1c5d635b9a1",
    "name": "Hello World Action",
    "required_domains": [],
    "scope_string": "https://auth.globus.org/scopes/actions.globus.org/hello_world"
  }
}

By Scope String

Similarly when accessing by scope string

> globus auth scope show https://auth.globus.org/scopes/actions.globus.org/hello_world
Scope String:          https://auth.globus.org/scopes/actions.globus.org/hello_world
Scope ID:              24f3dcbe-7655-4721-bc64-d1c5d635b9a1
Name:                  Hello World Action
Description:           Allow the Hello World action to extend greetings.
Client ID:             5fac2e64-c734-4e6b-90ea-ff12ddbf9653
Allows Refresh Tokens: True
Required Domains:      
Advertised:            True
Dependent Scopes:      
  - Scope String:           urn:globus:auth:scope:nexus.api.globus.org:groups
    Scope ID:               69a73d8f-cd45-4e37-bb3b-43678424aeb7
    Optional:               False
    Requires Refresh Token: False
  - Scope String:           urn:globus:auth:scope:groups.api.globus.org:view_my_groups_and_memberships
    Scope ID:               73320ffe-4cb4-4b25-a0a3-83d53d59ce4f
    Optional:               False
    Requires Refresh Token: False

JSON by scope string uses a the get-scopes route so response is a list of one element

> globus auth scope show https://auth.globus.org/scopes/actions.globus.org/hello_world -F json
{
  "scopes": [
    {
      "advertised": true,
      "allows_refresh_token": true,
      "client": "5fac2e64-c734-4e6b-90ea-ff12ddbf9653",
      "dependent_scopes": [
        {
          "optional": false,
          "requires_refresh_token": false,
          "scope": "69a73d8f-cd45-4e37-bb3b-43678424aeb7"
        },
        {
          "optional": false,
          "requires_refresh_token": false,
          "scope": "73320ffe-4cb4-4b25-a0a3-83d53d59ce4f"
        }
      ],
      "description": "Allow the Hello World action to extend greetings.",
      "id": "24f3dcbe-7655-4721-bc64-d1c5d635b9a1",
      "name": "Hello World Action",
      "required_domains": [],
      "scope_string": "https://auth.globus.org/scopes/actions.globus.org/hello_world"
    }
  ]
}

kurtmckee · 2025-01-31T14:21:41Z

globus auth is a hidden command tree; Stephen and I discussed keeping it that way until we have 5+ commands registered under there

Why?

sirosen · 2025-01-31T22:35:37Z

globus auth is a hidden command tree; Stephen and I discussed keeping it that way until we have 5+ commands registered under there

Why?

Because the launch of a globus auth command tree should potentially include aliasing/renaming and deprecation of existing commands like globus get-identities. We agreed on hidden commands as an easy way for us to continue to discuss exactly what should happen to the CLI when we add globus auth commands without blocking work, and that once there are a handful of commands implemented, the downside of holding back a release outweighs the potential upsides of making more adjustments for the initial release of these commands.

We can reopen this debate, but let's not do it in this PR thread.

src/globus_cli/termio/terminal_info.py

src/globus_cli/types.py

src/globus_cli/utils.py

derek-globus · 2025-02-03T20:09:15Z

Auth has confirmed their comfort with (1) this command structure proposal and (2) the decisions made in this PR that diverge our display slightly from their raw api.

So this guy is open for business!

src/globus_cli/termio/formatters/compound.py

src/globus_cli/termio/printers/record_printer.py

sirosen

I only have a couple of minor comments I'd like us to evaluate before approval. I did a reread of the parts I had already reviewed and feel pretty good about the state of this.

sirosen · 2025-03-04T20:32:32Z

src/globus_cli/termio/terminal_info.py

+    MIN_COLUMNS = 6
+
+    def __init__(self) -> None:
+        self._column_delta = 0


May I suggest that we name this to align with indented() as the indent? Also requires that we invert some of the arithmetic around it.

Suggested change

self._column_delta = 0

self._current_indent = 0

I suggest this after a moment of confusion reading the +=, -=, etc during review.

sirosen · 2025-03-04T20:54:55Z

tests/functional/auth/scope/test_show_scope.py

+    "scope_id_or_string",
+    (
+        "24f3dcbe-7655-4721-bc64-d1c5d635b9a1",
+        "https://auth.globus.org/scopes/actions.globus.org/hello_world",
+    ),
+)
+def test_show_scope(run_line, scope_id_or_string):
+    load_response_set("cli.scopes")
+
+    result = run_line(f"globus auth scope show {scope_id_or_string}")


I notice that we have pytest params matched to the data here. I think it's fine but if you wanted to break the dependency up a bit, you can

@pytest.mark.parametrize("lookup_method", ("id", "scope_string")) def test_...: rset = load_response_set("cli.scopes") if lookup_method == "id": scope_arg = rset.metadata["hello_world_id"] elif lookup_method == "scope_string": scope_arg = rset.metadata["hello_world_string"] else: raise NotImplementedError(lookup_method)

It's totally optional, but if you'd like to do so, there's a path to doing this and potentially something similar to the expected output formulation.

It doesn't look like a conditional is required.

@pytest.mark.parametrize( "metadata_key", ( pytest.param("hello_world_id", id="lookup by scope id"), pytest.param("hello_world_string", id="lookup by scope string"), ) ) def test_...: rset = load_response_set("cli.scopes") scope_arg = rset.metadata[metadata_key]

kurtmckee · 2025-03-07T19:22:35Z

src/globus_cli/commands/auth/scope/_common.py

+        self,
+        auth_client: globus_sdk.AuthClient,
+        scope_ids: list[str],
+        default: str | None = "UNKNOWN",


Since None isn't the default, I'm surprised that it appears in the type annotation. Is this an artifact of a previous rev?

kurtmckee · 2025-03-07T19:35:03Z

src/globus_cli/termio/formatters/compound.py

+        if not value:
+            return "[]"
+


It looks like this condition exists in two places.

First it appears here, which appears to break the past behavior (render([]) return "" before but now returns "[]").

But then it's recreated in the subclass, which explicitly checks to see if the list is empty and then calls this function to rely on its behavior.

It seems like the subclass could take the responsibility to return "[]", rather than changing the behavior here. Is that accurate? Or am I overlooking some additional context?

kurtmckee · 2025-03-07T19:41:09Z

src/globus_cli/utils.py

+    A dictionary with support for lazily loaded values.
+    Lazy loaders are registered using the `register_loader` method.
+
+    Note: This class extends `dict`, not `UserDict` for json serializability.


I haven't seen UserDict since the Python 2 days, when it was impossible to subclass the built-in dict. I didn't realize it was still around!

Probably the comment reflects some of my influence via code I've left around. 😁
We have it in the SDK as well, as the base for the payload classes!

I think UserDict has some differences vs subclassing dict regarding the consistency of various mutators. It's all very niche stuff and I don't think there's much call for UserDict these days (and less for UserList and less than that for UserString!).

I also think it's incidentally nice that self.data is available on UserDict, since it means you can implement __getitem__ in terms of self.data.__getitem__ and have a clearer flow of control. So there is at least some rationale for still liking it!

But, of course, I'm not particularly attached to one implementation vs another for this sort of thing. 🙂

kurtmckee · 2025-03-07T20:00:27Z

tests/functional/auth/scope/test_show_scope.py

+    "scope_id_or_string",
+    (
+        "24f3dcbe-7655-4721-bc64-d1c5d635b9a1",
+        "https://auth.globus.org/scopes/actions.globus.org/hello_world",
+    ),
+)
+def test_show_scope(run_line, scope_id_or_string):
+    load_response_set("cli.scopes")
+
+    result = run_line(f"globus auth scope show {scope_id_or_string}")


It doesn't look like a conditional is required.

@pytest.mark.parametrize( "metadata_key", ( pytest.param("hello_world_id", id="lookup by scope id"), pytest.param("hello_world_string", id="lookup by scope string"), ) ) def test_...: rset = load_response_set("cli.scopes") scope_arg = rset.metadata[metadata_key]

derek-globus added 2 commits January 30, 2025 22:34

Added globus auth scope show command

70dcca1

Remove list subscripting for py38

9c8e230

derek-globus added 3 commits January 31, 2025 15:56

Added module for tracking global indentation

914bfbd

Make it work for py38 again; someday I'll learn

28ef3c5

commit commit commit

5063012

Try fixing windows

5bc3d0f

sirosen reviewed Jan 31, 2025

View reviewed changes

src/globus_cli/termio/terminal_info.py Show resolved Hide resolved

src/globus_cli/types.py Show resolved Hide resolved

src/globus_cli/utils.py Show resolved Hide resolved

Address Windows-specific output differences

eeb9088

derek-globus marked this pull request as ready for review February 3, 2025 20:08

derek-globus requested review from aaschaer, ada-globus, kurtmckee, m1yag1 and MaxTueckeGlobus as code owners February 3, 2025 20:08

sirosen reviewed Feb 4, 2025

View reviewed changes

derek-globus added 7 commits February 4, 2025 19:44

Max recursion depth in json value typeguard

61c1ab1

Added TerminalTextWrapper

ecf9df7

Comment py38 compatibility decision

9e8e3dc

ArrayMultilineFormatter._indent_element -> _left_pad_element

799ea26

Made left padding example more normal

699bb8d

Make array render control flow more clear

b56ef11

Render an empty array as []

5e38ed8

sirosen reviewed Mar 4, 2025

View reviewed changes

kurtmckee approved these changes Mar 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added globus auth scope show command #1077

Added globus auth scope show command #1077

derek-globus commented Jan 31, 2025 •

edited

Loading

kurtmckee commented Jan 31, 2025

sirosen commented Jan 31, 2025

derek-globus commented Feb 3, 2025 •

edited

Loading

sirosen left a comment

sirosen Mar 4, 2025

sirosen Mar 4, 2025

kurtmckee Mar 7, 2025 •

edited

Loading

kurtmckee Mar 7, 2025

kurtmckee Mar 7, 2025

kurtmckee Mar 7, 2025

sirosen Mar 7, 2025

kurtmckee Mar 7, 2025 •

edited

Loading

Added globus auth scope show command #1077

Are you sure you want to change the base?

Added globus auth scope show command #1077

Conversation

derek-globus commented Jan 31, 2025 • edited Loading

Added

Changed

Draft

Usage

By Scope ID

By Scope String

kurtmckee commented Jan 31, 2025

sirosen commented Jan 31, 2025

derek-globus commented Feb 3, 2025 • edited Loading

sirosen left a comment

Choose a reason for hiding this comment

sirosen Mar 4, 2025

Choose a reason for hiding this comment

sirosen Mar 4, 2025

Choose a reason for hiding this comment

kurtmckee Mar 7, 2025 • edited Loading

Choose a reason for hiding this comment

kurtmckee Mar 7, 2025

Choose a reason for hiding this comment

kurtmckee Mar 7, 2025

Choose a reason for hiding this comment

kurtmckee Mar 7, 2025

Choose a reason for hiding this comment

sirosen Mar 7, 2025

Choose a reason for hiding this comment

kurtmckee Mar 7, 2025 • edited Loading

Choose a reason for hiding this comment

derek-globus commented Jan 31, 2025 •

edited

Loading

derek-globus commented Feb 3, 2025 •

edited

Loading

kurtmckee Mar 7, 2025 •

edited

Loading

kurtmckee Mar 7, 2025 •

edited

Loading