Skip to content

update to statefulapi calls due to latest changes in schemathesis version#333

Merged
dbasunag merged 1 commit intoopendatahub-io:mainfrom
dbasunag:stateful_api
Jun 4, 2025
Merged

update to statefulapi calls due to latest changes in schemathesis version#333
dbasunag merged 1 commit intoopendatahub-io:mainfrom
dbasunag:stateful_api

Conversation

@dbasunag
Copy link
Copy Markdown
Collaborator

@dbasunag dbasunag commented Jun 3, 2025

Description

How Has This Been Tested?

Merge criteria:

  • The commits are squashed in a cohesive manner and have meaningful messages.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work

Summary by CodeRabbit

  • Chores
    • Added a configuration file to manage API base URL dynamically via environment variables.
    • Enhanced test setup to improve API endpoint configuration and detailed logging of API calls during testing.

@dbasunag dbasunag requested a review from a team as a code owner June 3, 2025 23:11
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jun 3, 2025

Caution

Review failed

The pull request is closed.

"""

Walkthrough

A new schemathesis.toml configuration file was introduced to define the API base URL using an environment variable. The generated_schema fixture in the test suite was updated to utilize this configuration, set the relevant environment variable, and adjust the way the OpenAPI schema is loaded. Additionally, logging was enhanced in the state machine fixture to provide detailed request and response information.

Changes

File(s) Change Summary
schemathesis.toml Added new configuration file specifying base-url with an environment variable placeholder.
tests/model_registry/conftest.py Updated generated_schema fixture: added pytestconfig param, set API_HOST env var, loaded config from TOML; enhanced logging in state_machine fixture with before_call and detailed after_call.

Sequence Diagram(s)

sequenceDiagram
    participant Pytest
    participant Fixture as generated_schema
    participant Env as Environment
    participant Schemathesis

    Pytest->>Fixture: Call generated_schema(pytestconfig, model_registry_instance_rest_endpoint)
    Fixture->>Env: Set API_HOST = model_registry_instance_rest_endpoint
    Fixture->>Schemathesis: Load OpenAPI schema (from schemathesis.toml config)
    Schemathesis-->>Fixture: Return schema
    Fixture-->>Pytest: Return schema
Loading

Possibly related PRs

Suggested reviewers

  • lugi0
  • fege

Poem

A TOML file appears, so neat and small,
With ${API_HOST} to answer the call.
The schema now loads with a flexible base,
Tests run with ease, all in their place.
Logs now sing the story true,
Of calls and responses, fresh and new! 🐇✨
Hopping through code with joy anew! 🥕
"""


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 355597e and 52c69af.

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • schemathesis.toml (1 hunks)
  • tests/model_registry/conftest.py (3 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 3, 2025

The following are automatically added/executed:

  • PR size label.
  • Run pre-commit
  • Run tox
  • Add PR author as the PR assignee
  • Build image based on the PR

Available user actions:

  • To mark a PR as WIP, add /wip in a comment. To remove it from the PR comment /wip cancel to the PR.
  • To block merging of a PR, add /hold in a comment. To un-block merging of PR comment /hold cancel.
  • To mark a PR as approved, add /lgtm in a comment. To remove, add /lgtm cancel.
    lgtm label removed on each new commit push.
  • To mark PR as verified comment /verified to the PR, to un-verify comment /verified cancel to the PR.
    verified label removed on each new commit push.
  • To Cherry-pick a merged PR /cherry-pick <target_branch_name> to the PR. If <target_branch_name> is valid,
    and the current PR is merged, a cherry-picked PR would be created and linked to the current PR.
  • To build and push image to quay, add /build-push-pr-image in a comment. This would create an image with tag
    pr-<pr_number> to quay repository. This image tag, however would be deleted on PR merge or close action.
Supported labels

{'/wip', '/lgtm', '/hold', '/verified'}

@dbasunag
Copy link
Copy Markdown
Collaborator Author

dbasunag commented Jun 3, 2025

/build-push-pr-image

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 3, 2025

Status of building tag pr-333: success.
Status of pushing tag pr-333 to image registry: success.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
tests/model_registry/conftest.py (1)

264-270: Approve the configuration approach but address code quality issues.

The updated fixture correctly implements the new schemathesis configuration pattern using external TOML config and environment variables. However, there are several code quality issues to address:

Apply this diff to improve code quality:

-def generated_schema(pytestconfig: Config, model_registry_instance_rest_endpoint: str) -> BaseOpenAPISchema:
+def generated_schema(
+    pytestconfig: Config, 
+    model_registry_rest_endpoint: str
+) -> BaseOpenAPISchema:
+    """Generate OpenAPI schema with dynamic base URL configuration.
+    
+    Args:
+        pytestconfig: Pytest configuration object
+        model_registry_rest_endpoint: REST endpoint for model registry
+        
+    Returns:
+        BaseOpenAPISchema: Configured OpenAPI schema
+    """
-    os.environ["API_HOST"] = model_registry_instance_rest_endpoint
+    os.environ["API_HOST"] = model_registry_rest_endpoint
     schema = schemathesis.openapi.from_url(
-        url="https://raw.githubusercontent.com/kubeflow/model-registry/main/api/openapi/model-registry.yaml",
-        config=schemathesis.config.SchemathesisConfig.from_path(f"{pytestconfig.rootpath}/schemathesis.toml"),
+        url="https://raw.githubusercontent.com/kubeflow/model-registry/"
+            "main/api/openapi/model-registry.yaml",
+        config=schemathesis.config.SchemathesisConfig.from_path(
+            f"{pytestconfig.rootpath}/schemathesis.toml"
+        ),
     )
     return schema

This addresses:

  • Line length violations (C0301)
  • Missing docstring (C0116)
  • Parameter name shadowing (W0621)
🧰 Tools
🪛 Pylint (3.3.7)

[convention] 264-264: Line too long (108/100)

(C0301)


[convention] 267-267: Line too long (109/100)

(C0301)


[convention] 268-268: Line too long (110/100)

(C0301)


[convention] 264-264: Missing function or method docstring

(C0116)


[warning] 264-264: Redefining name 'model_registry_instance_rest_endpoint' from outer scope (line 250)

(W0621)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a21ceb3 and 355597e.

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • schemathesis.toml (1 hunks)
  • tests/model_registry/conftest.py (2 hunks)
🧰 Additional context used
🪛 Pylint (3.3.7)
tests/model_registry/conftest.py

[convention] 1-1: Missing module docstring

(C0114)


[convention] 264-264: Line too long (108/100)

(C0301)


[convention] 267-267: Line too long (109/100)

(C0301)


[convention] 268-268: Line too long (110/100)

(C0301)


[convention] 264-264: Missing function or method docstring

(C0116)


[warning] 264-264: Redefining name 'model_registry_instance_rest_endpoint' from outer scope (line 250)

(W0621)

🔇 Additional comments (2)
schemathesis.toml (1)

1-1: LGTM! Clean configuration approach.

The TOML configuration file correctly uses environment variable substitution to dynamically set the API base URL. This approach aligns with schemathesis best practices for external configuration management.

tests/model_registry/conftest.py (1)

1-3: LGTM! Necessary imports for the new configuration approach.

The added imports (os and Config) are required for the updated fixture implementation that uses environment variables and external configuration.

🧰 Tools
🪛 Pylint (3.3.7)

[convention] 1-1: Missing module docstring

(C0114)

Copy link
Copy Markdown
Contributor

@fege fege left a comment

Choose a reason for hiding this comment

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

/lgtm

@dbasunag dbasunag merged commit 55baa49 into opendatahub-io:main Jun 4, 2025
9 of 10 checks passed
@dbasunag dbasunag deleted the stateful_api branch June 4, 2025 13:01
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 4, 2025

Status of building tag latest: success.
Status of pushing tag latest to image registry: success.

adolfo-ab pushed a commit to adolfo-ab/opendatahub-tests that referenced this pull request Jun 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants