Skip to content

fix: remove unnecessary jira references that interferes with pytest-jira plugin#1227

Merged
dbasunag merged 2 commits intoopendatahub-io:mainfrom
dbasunag:jira_refs_ai_hub
Mar 17, 2026
Merged

fix: remove unnecessary jira references that interferes with pytest-jira plugin#1227
dbasunag merged 2 commits intoopendatahub-io:mainfrom
dbasunag:jira_refs_ai_hub

Conversation

@dbasunag
Copy link
Copy Markdown
Collaborator

@dbasunag dbasunag commented Mar 16, 2026

Pull Request

Summary

pytest-jira plugin 0.3.22 now can automatically mark tests as xfail based on Jira ticket status when test
docstrings or markers reference Jira issues.
This is problematic for many of our test where we just use jira references for documentation purposes. This PR removes such references and only keeps the ones associated with @pytest.mark.jira

Related Issues

  • Fixes:
  • JIRA:

How it has been tested

  • Locally
  • Jenkins

Additional Requirements

  • If this PR introduces a new test image, did you create a PR to mirror it in disconnected environment?
  • If this PR introduces new marker(s)/adds a new component, was relevant ticket created to update relevant Jenkins job?

Summary by CodeRabbit

  • Documentation

    • Updated docstrings and test descriptions across the test suite to remove internal issue/ticket references and standardize wording for clarity.
    • Simplified TODOs and in-test comments to be neutral and easier to read.
  • Chores

    • Minor log message wording adjusted for consistency.
    • Removed markers that previously flagged a couple of parameterized tests as expected failures.

@github-actions
Copy link
Copy Markdown

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', '/build-push-pr-image', '/lgtm', '/verified', '/cherry-pick', '/hold'}

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 0ba27ff2-e61b-43be-bbe1-c56b26e6512d

📥 Commits

Reviewing files that changed from the base of the PR and between 752ec6d and ad785bd.

📒 Files selected for processing (30)
  • tests/model_registry/mcp_servers/config/test_invalid_yaml.py
  • tests/model_registry/mcp_servers/config/test_multi_source.py
  • tests/model_registry/mcp_servers/config/test_named_queries.py
  • tests/model_registry/mcp_servers/search/test_filtering.py
  • tests/model_registry/mcp_servers/search/test_ordering.py
  • tests/model_registry/mcp_servers/test_data_integrity.py
  • tests/model_registry/model_catalog/catalog_config/conftest.py
  • tests/model_registry/model_catalog/catalog_config/test_catalog_source_merge.py
  • tests/model_registry/model_catalog/catalog_config/test_default_model_catalog.py
  • tests/model_registry/model_catalog/catalog_config/test_default_source_inclusion_exclusion_cleanup.py
  • tests/model_registry/model_catalog/huggingface/test_huggingface_model_search.py
  • tests/model_registry/model_catalog/huggingface/test_huggingface_model_type_classification.py
  • tests/model_registry/model_catalog/huggingface/test_huggingface_source_error_validation.py
  • tests/model_registry/model_catalog/metadata/test_catalog_preview.py
  • tests/model_registry/model_catalog/metadata/test_custom_properties.py
  • tests/model_registry/model_catalog/metadata/test_filter_options_endpoint.py
  • tests/model_registry/model_catalog/metadata/test_sources_endpoint.py
  • tests/model_registry/model_catalog/rbac/test_catalog_rbac.py
  • tests/model_registry/model_catalog/search/test_model_artifact_search.py
  • tests/model_registry/model_catalog/search/test_model_search.py
  • tests/model_registry/model_catalog/sorting/test_model_artifacts_sorting.py
  • tests/model_registry/model_catalog/sorting/test_model_sorting.py
  • tests/model_registry/model_catalog/sorting/test_sorting_functionality.py
  • tests/model_registry/model_registry/async_job/test_async_upload_e2e.py
  • tests/model_registry/model_registry/negative_tests/test_db_migration.py
  • tests/model_registry/model_registry/python_client/test_model_registry_creation.py
  • tests/model_registry/model_registry/rest_api/test_model_registry_rest_api.py
  • tests/model_registry/model_registry/rest_api/test_model_registry_secure_db.py
  • utilities/inference_utils.py
  • utilities/infra.py
💤 Files with no reviewable changes (3)
  • tests/model_registry/model_registry/rest_api/test_model_registry_secure_db.py
  • tests/model_registry/model_catalog/metadata/test_catalog_preview.py
  • tests/model_registry/model_catalog/metadata/test_filter_options_endpoint.py
✅ Files skipped from review due to trivial changes (1)
  • tests/model_registry/model_catalog/catalog_config/test_catalog_source_merge.py
🚧 Files skipped from review as they are similar to previous changes (19)
  • tests/model_registry/model_registry/python_client/test_model_registry_creation.py
  • tests/model_registry/model_catalog/huggingface/test_huggingface_source_error_validation.py
  • tests/model_registry/model_registry/async_job/test_async_upload_e2e.py
  • utilities/infra.py
  • tests/model_registry/model_catalog/sorting/test_sorting_functionality.py
  • tests/model_registry/mcp_servers/config/test_named_queries.py
  • tests/model_registry/mcp_servers/test_data_integrity.py
  • tests/model_registry/mcp_servers/search/test_filtering.py
  • tests/model_registry/model_catalog/search/test_model_artifact_search.py
  • tests/model_registry/model_registry/negative_tests/test_db_migration.py
  • utilities/inference_utils.py
  • tests/model_registry/mcp_servers/config/test_invalid_yaml.py
  • tests/model_registry/model_catalog/huggingface/test_huggingface_model_search.py
  • tests/model_registry/model_catalog/catalog_config/test_default_source_inclusion_exclusion_cleanup.py
  • tests/model_registry/model_registry/rest_api/test_model_registry_rest_api.py
  • tests/model_registry/model_catalog/rbac/test_catalog_rbac.py
  • tests/model_registry/mcp_servers/config/test_multi_source.py
  • tests/model_registry/model_catalog/catalog_config/test_default_model_catalog.py
  • tests/model_registry/model_catalog/metadata/test_sources_endpoint.py

📝 Walkthrough

Walkthrough

This PR removes issue-tracking identifiers and adjusts docstrings/comments/log messages across tests and utilities; one test file had two pytest.xfail markers removed. No other control-flow or API signature changes.

Changes

Cohort / File(s) Summary
MCP Server Tests
tests/model_registry/mcp_servers/config/test_invalid_yaml.py, tests/model_registry/mcp_servers/config/test_multi_source.py, tests/model_registry/mcp_servers/config/test_named_queries.py, tests/model_registry/mcp_servers/search/test_filtering.py, tests/model_registry/mcp_servers/search/test_ordering.py, tests/model_registry/mcp_servers/test_data_integrity.py
Removed RHOAIENG ticket references from class/method docstrings and comments; no behavioral changes.
Model Catalog — Config
tests/model_registry/model_catalog/catalog_config/conftest.py, tests/model_registry/model_catalog/catalog_config/test_catalog_source_merge.py, tests/model_registry/model_catalog/catalog_config/test_default_model_catalog.py, tests/model_registry/model_catalog/catalog_config/test_default_source_inclusion_exclusion_cleanup.py
Stripped issue IDs from docstrings/comments; removed a note about a known failing null-YAML condition. No logic changes.
Model Catalog — HuggingFace
tests/model_registry/model_catalog/huggingface/test_huggingface_model_search.py, tests/model_registry/model_catalog/huggingface/test_huggingface_model_type_classification.py, tests/model_registry/model_catalog/huggingface/test_huggingface_source_error_validation.py
Standardized and expanded/shortened docstrings by removing RHOAIENG references; no functional changes.
Model Catalog — Metadata
tests/model_registry/model_catalog/metadata/test_catalog_preview.py, tests/model_registry/model_catalog/metadata/test_custom_properties.py, tests/model_registry/model_catalog/metadata/test_filter_options_endpoint.py, tests/model_registry/model_catalog/metadata/test_sources_endpoint.py
Removed issue identifiers from test class/method docstrings; no behavior changes.
Model Catalog — RBAC & Search
tests/model_registry/model_catalog/rbac/test_catalog_rbac.py, tests/model_registry/model_catalog/search/test_model_artifact_search.py, tests/model_registry/model_catalog/search/test_model_search.py
Removed RHOAIENG ticket prefixes from docstrings across tests; no code changes.
Model Catalog — Sorting
tests/model_registry/model_catalog/sorting/test_model_artifacts_sorting.py, tests/model_registry/model_catalog/sorting/test_model_sorting.py, tests/model_registry/model_catalog/sorting/test_sorting_functionality.py
Removed issue keys from docstrings; additionally removed two pytest.xfail markers for NAME sorting cases in test_model_artifacts_sorting.py.
Model Registry Tests
tests/model_registry/model_registry/async_job/test_async_upload_e2e.py, tests/model_registry/model_registry/negative_tests/test_db_migration.py, tests/model_registry/model_registry/python_client/test_model_registry_creation.py, tests/model_registry/model_registry/rest_api/test_model_registry_rest_api.py, tests/model_registry/model_registry/rest_api/test_model_registry_secure_db.py
Removed RHOAIENG ticket references from docstrings and one implementation comment; no functional changes.
Utilities
utilities/inference_utils.py, utilities/infra.py
Replaced a multi-line logger warning with a single-line message in create_isvc and removed an issue reference from create_ns docstring; behavior unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: removing Jira references from test docstrings to prevent pytest-jira plugin interference.
Description check ✅ Passed The description explains the reason (pytest-jira plugin v0.3.22 auto-marking tests) and approach (remove non-essential Jira references, keep marked ones). However, the Related Issues section is incomplete—both fields are empty.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
tests/model_registry/model_registry/python_client/test_model_registry_creation.py (1)

99-104: ⚠️ Potential issue | 🟡 Minor

Fix misleading test docstring for MLMD log validation.

Line 99 describes grpc-container removal, but this test validates MLMD-removal behavior via pod logs. Update the docstring to match actual test intent.

Proposed patch
     def test_model_registry_pod_log_mlmd_removal(
         self, model_registry_deployment_containers: list[dict[str, Any]], model_registry_pod: Pod
     ):
         """
-        Test to ensure removal of grpc container from model registry deployment
+        Test to ensure MLMD removal is reflected in model registry pod logs
         Steps:
             Create metadata database
             Deploys model registry using the same
-            Check model registry deployment for grpc container. It should not be present
+            Check model registry pod logs for MLMD-removal evidence
         """
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In
`@tests/model_registry/model_registry/python_client/test_model_registry_creation.py`
around lines 99 - 104, Update the misleading docstring in the test in
tests/model_registry/model_registry/python_client/test_model_registry_creation.py
(the test that inspects pod logs for MLMD removal) so it accurately describes
that the test validates MLMD-removal behavior by checking pod logs rather than
verifying grpc container removal; locate the test's triple-quoted docstring (the
block that currently mentions "grpc container") and replace its text with a
short description of steps: set up metadata DB, deploy model registry, and
assert MLMD-related log messages indicating MLMD was removed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In
`@tests/model_registry/model_registry/python_client/test_model_registry_creation.py`:
- Around line 99-104: Update the misleading docstring in the test in
tests/model_registry/model_registry/python_client/test_model_registry_creation.py
(the test that inspects pod logs for MLMD removal) so it accurately describes
that the test validates MLMD-removal behavior by checking pod logs rather than
verifying grpc container removal; locate the test's triple-quoted docstring (the
block that currently mentions "grpc container") and replace its text with a
short description of steps: set up metadata DB, deploy model registry, and
assert MLMD-related log messages indicating MLMD was removed.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 9ad904e3-ae0b-4c6b-a028-9919ecccd69f

📥 Commits

Reviewing files that changed from the base of the PR and between 5e62a40 and 752ec6d.

📒 Files selected for processing (30)
  • tests/model_registry/mcp_servers/config/test_invalid_yaml.py
  • tests/model_registry/mcp_servers/config/test_multi_source.py
  • tests/model_registry/mcp_servers/config/test_named_queries.py
  • tests/model_registry/mcp_servers/search/test_filtering.py
  • tests/model_registry/mcp_servers/search/test_ordering.py
  • tests/model_registry/mcp_servers/test_data_integrity.py
  • tests/model_registry/model_catalog/catalog_config/conftest.py
  • tests/model_registry/model_catalog/catalog_config/test_catalog_source_merge.py
  • tests/model_registry/model_catalog/catalog_config/test_default_model_catalog.py
  • tests/model_registry/model_catalog/catalog_config/test_default_source_inclusion_exclusion_cleanup.py
  • tests/model_registry/model_catalog/huggingface/test_huggingface_model_search.py
  • tests/model_registry/model_catalog/huggingface/test_huggingface_model_type_classification.py
  • tests/model_registry/model_catalog/huggingface/test_huggingface_source_error_validation.py
  • tests/model_registry/model_catalog/metadata/test_catalog_preview.py
  • tests/model_registry/model_catalog/metadata/test_custom_properties.py
  • tests/model_registry/model_catalog/metadata/test_filter_options_endpoint.py
  • tests/model_registry/model_catalog/metadata/test_sources_endpoint.py
  • tests/model_registry/model_catalog/rbac/test_catalog_rbac.py
  • tests/model_registry/model_catalog/search/test_model_artifact_search.py
  • tests/model_registry/model_catalog/search/test_model_search.py
  • tests/model_registry/model_catalog/sorting/test_model_artifacts_sorting.py
  • tests/model_registry/model_catalog/sorting/test_model_sorting.py
  • tests/model_registry/model_catalog/sorting/test_sorting_functionality.py
  • tests/model_registry/model_registry/async_job/test_async_upload_e2e.py
  • tests/model_registry/model_registry/negative_tests/test_db_migration.py
  • tests/model_registry/model_registry/python_client/test_model_registry_creation.py
  • tests/model_registry/model_registry/rest_api/test_model_registry_rest_api.py
  • tests/model_registry/model_registry/rest_api/test_model_registry_secure_db.py
  • utilities/inference_utils.py
  • utilities/infra.py
💤 Files with no reviewable changes (3)
  • tests/model_registry/model_catalog/metadata/test_filter_options_endpoint.py
  • tests/model_registry/model_catalog/metadata/test_catalog_preview.py
  • tests/model_registry/model_registry/rest_api/test_model_registry_secure_db.py

…ira plugin

Signed-off-by: Debarati Basu-Nag <dbasunag@redhat.com>
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 4e3cb17 into opendatahub-io:main Mar 17, 2026
12 checks passed
@dbasunag dbasunag deleted the jira_refs_ai_hub branch March 17, 2026 11:31
@github-actions
Copy link
Copy Markdown

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

ssaleem-rh pushed a commit to ssaleem-rh/opendatahub-tests that referenced this pull request Mar 23, 2026
…ira plugin (opendatahub-io#1227)

Signed-off-by: Debarati Basu-Nag <dbasunag@redhat.com>
Signed-off-by: Shehan Saleem <ssaleem@redhat.com>
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.

3 participants