Improve tests in python_examples.py.

[Vector73]

Adds assert statements to check if the request succeeded before
validating against the openapi schema.

Improves the robustness of tests in python_examples.py.
Fixes:

Screenshots and screen captures:

Self-review checklist

• Self-reviewed the changes for clarity and maintainability
  (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

• Explains differences from previous plans (e.g., issue description).
• Highlights technical choices and bugs encountered.
• Calls out remaining decisions and concerns.
• Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

• Each commit is a coherent idea.
• Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

• Visual appearance of the changes.
• Responsiveness and internationalization.
• Strings and tooltips.
• End-to-end functionality of buttons, interactions and flows.
• Corner cases, error conditions, and easily imagined bugs.

[laurynmm]

@Vector73 - Thanks for making these improvements. I had a few thoughts. Let me know if you have any questions about my comments.

Also, see my separate comment related to Greg's note. I think it'd be good to check both the success and error tests, so maybe instead of adding all of these asserts, we add a helper function to do that check.

[Vector73]

I have addressed the feedbacks by @laurynmm. I have also fixed some incorrect validate_against_openapi_schema(..., 400) which I found while verifying the "error" response.

Also, there are 2 functions - test_user_account_deactivated and test_realm_deactivated - which don't seem to work as expected because result["result]="success" but the request (messages/render) is supposed to fail (REALM_DEACTIVATED or USER_DEACTIVATED error) with 401 status code (the current code though checks for 403 status code which has been changed to 401 for these errors).

[laurynmm]

@Vector73 - Here's another round of comments for these changes.

I'll note that this would be easier to review if you possible split this into more than one commit. And doing that would also possibly help you self-review for some of the small inconsistencies I've noticed in this last round of review.

So, having a commit for updating the linkifier endpoints to pass the filter_id parameter for example. And a separate commit for the helper function for getting subscription IDs. And so on.

Looking at how I split things out in #30135 might be helpful with that.

---

For those two error checks that are returning success:

• I noted that if I comment out all the other tests in tools/api-tests and just run the deactivate realm test, then I do get the error response ... though the error code isn't the one documented and as you noted it's a 401 error now :/
• I feel like you can work on figuring out those in a separate follow-up PR since they're already not working

---

For error checks here in general, I'm wondering if we:

• Remove the calls to validate_against_openapi_schema since that's not currently validating the error response anyway.
• Add a check for the expected code in the error result.

I'll start a discussion in CZO and/or file an issue for validating error responses, but unfortunately it's a bit more complicated than adding error documentation to all the documented endpoints.

[Vector73]

I have addressed the recent feedback by @laurynmm and split the changes into multiple commits.

[laurynmm]

@Vector73 - Thanks for splitting up your changes! It was much easier to review and inspired me to make a few more updates to these tests/this file.

I've pushed my updates here and it would be great for you to review those changes!

[Vector73]

Thanks @laurynmm for this clean-up. It looks great to me other than the comments below.

[laurynmm]

@Vector73 - Thanks for making those updates. I think this looks good for now, so marking for integration review.

Follow-ups that remain are the error testing clean-ups:

• Remove validate_against_openapi_schema for the error tests since that's not currently testing anything. Probably replace those with an assertion/check of the error code (often defaults to "BAD_REQUEST") that we expect to be returned for the error.
• Fixing the two error tests in test-api that are not returning errors in the test suite: test_user_account_deactivated and test_realm_deactivated.

[timabbott]

Merged, thanks for all the work on this @Vector73 and @laurynmm!

I really appreciate how much easier to maintain this now looks to be.