Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor unit tests to eliminate pytest warnings #322

Conversation

ChristianZaccaria
Copy link
Collaborator

@ChristianZaccaria ChristianZaccaria commented Aug 23, 2023

Issue link

Closes #321

Cause of Warnings

  • 7 of the warnings arise from tests that include a return statement. It seems these should only be making assertions and not returning anything. This way, pytest won't display any warnings.

  • The 4 other warnings are related to pkg_resources deprecation. I am unsure where this is coming from (it's not in the repo), it seems like an indirect library call:
    image
    Based on this GitHub issue on google-cloud-python and this PR on ibis repo, it seems people are inclined to silence these warnings for the meantime.

Changes

  • Refactored to remove return statements from the tests that are run.
  • Created the respective support functions.
  • Silenced warnings that originate from pkg_resources.

Verification steps

  1. From this branch, run in the terminal pip install -e .
  2. Then run: pytest -v tests/unit_test.py
  3. All tests should be passing without any warnings as shown below.

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
      image

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 23, 2023
Copy link
Contributor

@Bobbins228 Bobbins228 left a comment

Choose a reason for hiding this comment

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

Just ran the tests and received no warnings
PR just needs a rebase and it LGTM

@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 23, 2023
- Refactored to remove return statements from the tests that are ran.
- Created the respective support functions.
- Silenced warnings that originate from pkg_resources.
@ChristianZaccaria
Copy link
Collaborator Author

Just ran the tests and received no warnings PR just needs a rebase and it LGTM

Awesome, thanks for testing and reviewing! It's now rebased.

Copy link
Contributor

@Bobbins228 Bobbins228 left a comment

Choose a reason for hiding this comment

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

/LGTM

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 23, 2023
Copy link
Collaborator

@Maxusmusti Maxusmusti left a comment

Choose a reason for hiding this comment

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

LGTM

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 30, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bobbins228, Maxusmusti

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 30, 2023
@openshift-merge-robot openshift-merge-robot merged commit 61d7f3b into project-codeflare:main Aug 30, 2023
2 checks passed
@@ -66,6 +66,14 @@
export_env,
)

from tests.unit_test_support import (
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think you need to add an empty __init__.py file to tests/ so that you can import it this way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Correct/Refactor the unit tests to eliminate pytest Warnings
5 participants