Validate whether TrustyAI operator, service and oauth-proxy images match the ones in the configmap

[sheltoncyril]

Check if TrustyAI operator deployment oauth-proxy
and trustyai-service pods are using the right images from the configmap in redhat-ods-applications namespace.

Makes sure the TrustyAI deployment and service pods are created with the right images using the configmap as the source of truth.
Adresses RHOAIENG-22502 and RHOAIENG-23499

Description

Added a new test which validates whether the deployment/service pods have the same data in the image fields as the configmap.

How Has This Been Tested?

Test run successfully on a PSI cluster.

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

• Tests
  • Added a new test to verify that TrustyAI Operator and Service pods use the correct container images as specified in the configuration.
  • Introduced a fixture for accessing the TrustyAI Operator configuration.
  • Implemented utility logic to validate container images against expected values from the configuration.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new pytest fixture for accessing the TrustyAI operator's ConfigMap was introduced. A test was added to verify that both the TrustyAI Operator and Service pods use the correct container images, as specified in the ConfigMap. Supporting utility functions and constants for image validation were also implemented.

Changes

File(s)	Change Summary
tests/conftest.py	Added a pytest fixture trustyai_operator_configmap for providing the TrustyAI operator ConfigMap to tests.
tests/model_explainability/trustyai_service/test_trustyai_service.py	Added a test test_trustyai_operator_and_service_images to validate container images; updated imports for new utilities and types.
tests/model_explainability/trustyai_service/utils.py	Introduced constants for operator namespace/deployment and a function validate_trustyai_operator_and_service_images for image checks.

Sequence Diagram(s)

sequenceDiagram
    participant Test as test_trustyai_operator_and_service_images
    participant ConfigMap as trustyai_operator_configmap
    participant Utils as validate_trustyai_operator_and_service_images
    participant Admin as admin_client
    participant K8s as Kubernetes API

    Test->>ConfigMap: Access ConfigMap data
    Test->>Utils: Call validate_trustyai_operator_and_service_images(admin_client, namespace, configmap_data)
    Utils->>K8s: Fetch TrustyAI Operator deployment
    Utils->>K8s: Fetch TrustyAI Service pods in namespace
    Utils->>Utils: Validate container images

Loading

Suggested labels

size/l, lgtm-by-rnetser, Utilities

Poem

🐇
In the warren of tests, a fixture appears,
To check that our images are what they declare.
With ConfigMaps in paw and assertions in sight,
TrustyAI pods are inspected each night.
The rabbits all cheer, for the checks are robust—
Our containers are trusted, in code we trust!

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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]

The following are automatically added/executed:

• PR size label.
• Run pre-commit
• Run tox
• Add PR author as the PR assignee

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.

Supported labels

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

[sheltoncyril]

/wip

[sheltoncyril]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

tests/model_explainability/trustyai_service/utils.py (1)

175-200: Consider adding error handling for missing ConfigMap keys.

The validation function works well but assumes that specific keys exist in the ConfigMap. Consider adding validation to check if the required keys exist before accessing them to avoid potential KeyError exceptions.

Additionally, you might want to verify that both "oauth-proxy" and TrustyAI service containers were found in the pod, as the current implementation will silently skip validation if a container is not present.

Here's a suggested improvement:

def validate_trustyai_operator_and_service_images(
    client: DynamicClient, model_namespace: str, configmap_data_dict: dict[str, str]
) -> None:
    """Validate if the TrustyAI operator deployment and service pods use the correct images from the configmap."""
+   # Verify required keys exist in configmap
+   required_keys = ["trustyaiOperatorImage", "oauthProxyImage", "trustyaiServiceImage"]
+   for key in required_keys:
+       if key not in configmap_data_dict:
+           raise KeyError(f"Required key '{key}' not found in ConfigMap data")
+
    trustyai_deployment = Deployment(
        name=TRUSTYAI_OPERATOR_DEPLOYMENT_NAME, namespace=TRUSTYAI_OPERATOR_NAMESPACE, wait_for_resource=True
    )
    assert (
        trustyai_deployment.instance.spec.template.spec.containers[0].image
        == configmap_data_dict["trustyaiOperatorImage"]
    )
    service_pods = list(
        Pod.get(
            dyn_client=client,
            namespace=model_namespace,
            label_selector=f"app.kubernetes.io/instance={TRUSTYAI_SERVICE_NAME}",
        )
    )
    if service_pods:
        if len(service_pods) > 1:
            raise TooManyPodsError("More than one pod found in TrustyAIService.")
+       
+       oauth_proxy_found = False
+       trustyai_service_found = False
+       
        for container_status in service_pods[0].instance.status.containerStatuses:
            if container_status.name == "oauth-proxy":
+               oauth_proxy_found = True
                assert configmap_data_dict["oauthProxyImage"] == container_status.image
            if container_status.name == TRUSTYAI_SERVICE_NAME:
+               trustyai_service_found = True
                assert configmap_data_dict["trustyaiServiceImage"] == container_status.image
+       
+       if not oauth_proxy_found:
+           raise AssertionError(f"Container 'oauth-proxy' not found in TrustyAI service pod")
+       if not trustyai_service_found:
+           raise AssertionError(f"Container '{TRUSTYAI_SERVICE_NAME}' not found in TrustyAI service pod")
+   else:
+       raise AssertionError(f"No TrustyAI service pods found in namespace '{model_namespace}'")

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fc0db40 and 05c2c56.

📒 Files selected for processing (3)

• tests/conftest.py (1 hunks)
• tests/model_explainability/trustyai_service/test_trustyai_service.py (2 hunks)
• tests/model_explainability/trustyai_service/utils.py (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

tests/model_explainability/trustyai_service/test_trustyai_service.py (3)

tests/model_explainability/trustyai_service/utils.py (1)

• validate_trustyai_operator_and_service_images (175-200)

tests/conftest.py (4)

• admin_client (52-53)
• current_client_token (83-84)
• model_namespace (99-119)
• trustyai_operator_configmap (123-129)

tests/model_explainability/trustyai_service/conftest.py (1)

• trustyai_service_with_db_storage (93-107)

tests/model_explainability/trustyai_service/utils.py (2)

tests/conftest.py (1)

• model_namespace (99-119)

utilities/exceptions.py (1)

• TooManyPodsError (107-108)

🔇 Additional comments (5)

tests/conftest.py (1)

122-129: Good fixture implementation.

The fixture is well-structured and follows the established pattern in the file. It correctly returns a ConfigMap object for the TrustyAI service operator config in the appropriate namespace.

tests/model_explainability/trustyai_service/test_trustyai_service.py (3)

2-2: Appropriate import addition.

The ConfigMap import is correctly added to support the new test functionality.

---

5-8: Good import organization.

The import statement is properly updated to include the new validation function while maintaining the existing imports.

---

34-56: Well-structured test implementation.

The test is properly parameterized and uses the appropriate fixtures. The test clearly defines its purpose in the docstring and follows the established testing pattern in the file.

tests/model_explainability/trustyai_service/utils.py (1)

23-24: Good constant declarations.

The constants for the TrustyAI operator namespace and deployment name are properly defined with clear names and values.

[adolfo-ab]

Few things here:

1. yield instead of return
2. use ensure_exists to raise if the CM doesn't exist
3. use applications_namespace from pyconfig instead of redhat-ods-applications
4. use TRUSTYAI_SERVICE_NAME constant in the name
5. I think you don't need teardown_resources here

[sheltoncyril]

I've made the changes but if you don't mind me asking, why yield if we are only fetching information and do not aim to modify it? I understand if there is some transactional way of doing things and we need to commit at the end but in this case a return would be more apt, right?

[adolfo-ab]

Same, we need to split this into 2 functions, one for the service and one for the operator

[sheltoncyril]

Closing due to merge issues, recreating another PR