Skip to content

docs: overview of the clients registered for LS AAI - #32

Merged
uniqueg merged 3 commits into
devfrom
xpavlic/registered_clients
Nov 12, 2026
Merged

uniqueg merged 3 commits into
devfrom
xpavlic/registered_clients

Conversation

@xpavlic

@xpavlic xpavlic commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Summary

I completed the client registration for the LS AAI and added the relevant documentation.
Changed the use of the eduperson_entitlement scope and claim to entitlements, as eduperson_entitlement is considered legacy according to the AARC-G069 guideline. and is kept for backward compatibility.

Tests use a temporary port automatically to prevent conflicts with running Docker.

Initial login through LS AAI works.

Closes #8

Verification

Go through the registered clients in the LS AAI client registration app. All members of ECP_CLN:ADMIN group should be able to see them.

Configure lslogin.env and test initial login.

Declined review findings

Open questions

Checklist

  • Tests are added or updated where the change affects behaviour, and
    pass.
  • The documentation is updated where the change affects it.
  • The title follows Conventional
    Commits
    (at most 50 characters,
    imperative mood, no trailing period).

Summary by Sourcery

Align LS AAI client registration and entitlement processing with the current entitlements standard while documenting registered services and improving login test isolation.

Enhancements:

  • Standardize entitlement handling on the AARC-G069 entitlements scope and claim across the testbed and its documentation.
  • Document the registered LS AAI services and provide direct links to their registration records.
  • Allow login tests to use temporary callback ports so running LS Login sessions do not conflict with the test suite.

Documentation:

  • Update client-registration, assumptions, development, and group-testing documentation for LS AAI registration, entitlement usage, and test execution.

Tests:

  • Update mocked providers and login, service, session, and token tests to use entitlements and isolated callback ports.

Chores:

  • Enable readline history for the interactive session.

@xpavlic
xpavlic requested a review from uniqueg November 11, 2026 09:32
@xpavlic xpavlic self-assigned this Nov 11, 2026
@sourcery-ai

sourcery-ai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

Implementation

Switch entitlement scope, mock claims, and UserInfo processing to the entitlements claim, and remove the configurable list of legacy entitlement claims.

  • src/testbed/service.py L129-135
  • src/testbed/session.py L43, L50
  • src/testbed/settings.py L63 (removed lines), L78 (removed lines)

Enable interactive readline history for the session command line.

  • src/testbed/session.py L10, L889

Configuration

Update the repository ignore configuration.

  • .gitignore L20

Documentation

Document the registered LS AAI clients and align entitlement scopes and claims across the registration, assumptions, and group-test guidance.

  • docs/setup/client-registration.md L21-24, L43-54
  • docs/testbed/assumptions.md L53, L69 (removed lines)
  • docs/tests/t3-groups.md L32

Explain that login tests use a temporary callback port so an existing LS Login session can remain running.

  • docs/about/development.md L16-17

Tests

Use a temporary callback port in login tests and update fixtures and assertions to expect the entitlements claim.

  • tests/conftest.py L33-48 (+3 small edits)
  • tests/test_login.py L13-19, L262-265 (+2 small edits)
  • tests/test_services.py L170, L412
  • tests/test_session.py L470-474 (+6 small edits)
  • tests/test_tokens.py L175

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@read-the-docs-community

read-the-docs-community Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

@sourcery-ai

sourcery-ai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Linked issues

Checked at commit 71e4e90

#9 chore: find out how to assign test groups · 2 of 3 met · 1 to check by hand

# Requirement Status Notes
1 Find out which role is needed. ✅ Met The Client registration page names TrustedFacilityAdmin within the relevant VO and says the LS AAI team confirmed it.
2 Assign the test group. 👀 Check by hand (external system) Check in LS AAI/Perun that the test group was actually assigned to the relevant service resource.
3 Record the steps on the Client registration page. ✅ Met The page describes who assigns groups and gives steps for assigning and verifying their release.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've found 3 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/setup/client-registration.md" line_range="53" />
<code_context>
+| Gateway | `ELIXIR On-Cloud token exchange testbed gateway` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4304 |
+| Orchestrator | `ELIXIR On-Cloud token exchange testbed orchestrator` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4308 |
+| Client | `ELIXIR On-Cloud token exchange testbed client` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4309 |
+| Public client (optional) | `ELIXIR On-Cloud token exchange testbed client` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4309 |
+
 ## Group release
</code_context>
<issue_to_address>
**Public client uses wrong facility**

When an operator follows the table to locate or configure the separately registered public client, the public-client row points to facility 4309, already listed for `tx-test-client`, and repeats its service name, so operators cannot identify the separate `tx-test-public` registration or configure its groups and distinct client credentials on the intended facility; public-client tests then use the wrong registration.

Replace the public-client row's service name and URL with those of the distinct `tx-test-public` facility.
</issue_to_address>

### Comment 2
<location path="docs/setup/client-registration.md" line_range="53" />
<code_context>
+| Gateway | `ELIXIR On-Cloud token exchange testbed gateway` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4304 |
+| Orchestrator | `ELIXIR On-Cloud token exchange testbed orchestrator` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4308 |
+| Client | `ELIXIR On-Cloud token exchange testbed client` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4309 |
+| Public client (optional) | `ELIXIR On-Cloud token exchange testbed client` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4309 |
+
 ## Group release
</code_context>
<issue_to_address>
**Public-client tests are skipped**

When a reader follows the registered-services table literally, a reader can omit `tx-test-public`, leaving the documented five-client setup incomplete and preventing the public-client exchange variant from being run.

Remove “optional,” or clarify that the public client is optional only when deliberately skipping the public-client test.
</issue_to_address>

### Comment 3
<location path="docs/setup/client-registration.md" line_range="49-53" />
<code_context>
+
+| Role | Service name | Registration link |
+|---|---|---|
+| Node | `ELIXIR On-Cloud token exchange testbed node` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4303 |
+| Gateway | `ELIXIR On-Cloud token exchange testbed gateway` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4304 |
+| Orchestrator | `ELIXIR On-Cloud token exchange testbed orchestrator` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4308 |
+| Client | `ELIXIR On-Cloud token exchange testbed client` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4309 |
+| Public client (optional) | `ELIXIR On-Cloud token exchange testbed client` | https://services.aai.lifescience-ri.eu/spreg/auth/facilities/detail/4309 |
+
 ## Group release
</code_context>
<issue_to_address>
**Registration URLs are not clickable**

When a reader views the rendered documentation, mkDocs renders the bare registration URLs as text, so readers cannot open the facility pages directly from the documentation.

Format each registration URL as a Markdown link.
</issue_to_address>

Sourcery assessment

Approval pending. 2 findings to address first.

Blocking findings: docs/setup/client-registration.md:53, docs/setup/client-registration.md:53


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread docs/setup/client-registration.md Resolved
Comment thread docs/setup/client-registration.md Resolved
Comment thread docs/setup/client-registration.md Resolved

@uniqueg uniqueg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Can you please address or reject the open Sourcery comments? 🙏 Otherwise looks good :)

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New gaps against the linked issues

Comment thread docs/setup/client-registration.md Resolved
@xpavlic
xpavlic force-pushed the xpavlic/registered_clients branch 3 times, most recently from 6499264 to 71e4e90 Compare November 12, 2026 14:12
@xpavlic
xpavlic force-pushed the xpavlic/registered_clients branch from 71e4e90 to 1a35ae0 Compare November 12, 2026 14:18
@xpavlic
xpavlic requested a review from uniqueg November 12, 2026 14:20
@xpavlic

xpavlic commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor Author

I made a few more improvements; see the PR description.

@uniqueg uniqueg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM 👍

@uniqueg
uniqueg merged commit 6732ab4 into dev Nov 12, 2026
7 checks passed
@uniqueg
uniqueg deleted the xpavlic/registered_clients branch November 12, 2026 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: register the test clients on LS Login

2 participants