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

Use tox to manage the test suite #7

Merged
merged 2 commits into from
Jul 12, 2023
Merged

Conversation

kurtmckee
Copy link
Contributor

This PR introduces tox to manage the test suite. This includes the following changes:

  • The test suite is now run on Python 3.8 through Python 3.11 automatically.
  • Coverage reports include runs across all Python versions, not just Python 3.8.
  • The coverage report include coverage of the tests/ directory.
  • The documentation is built as a part of the test suite.
  • pandas is now recognized as a test dependency (previously the test suite would fail when pandas was not manually installed).
  • CI now runs the test suite across all Python versions, including building the docs.

To run the test suite locally, simply install tox (pip install tox) and run tox. To run the tests in parallel, run tox parallel or tox p.

@kurtmckee
Copy link
Contributor Author

Rebased on main to resolve merge conflict

@kurtmckee
Copy link
Contributor Author

It appears the Sonar test is failing. This is very likely a security consideration that prevents external repositories from accessing this repository's secrets.

I looked through past runs of CI and found that they appear to succeed when they're running against main and to fail when they're running against PR branches.

I'm not yet familiar with the security considerations for token access, but I don't think that the CI failure is happening because of a change introduced in this PR.

@phschiele
Copy link
Collaborator

@kurtmckee yes, sonar is failing because of the missing secret.

I haven't used tox before, so I'm reading up a bit before merging. I like the idea of moving logic from the CI bash scripts to the tox configuration.

@kurtmckee
Copy link
Contributor Author

Sounds good. Let me know if you have any questions or see any changes that are needed.

BTW, I saw you're giving some talks at SciPy 2023! I'm looking forward to it!

Copy link
Collaborator

@phschiele phschiele left a comment

Choose a reason for hiding this comment

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

Thanks, this is indeed a great functionality. See you at the talks!

@phschiele phschiele merged commit 1f35563 into cvxgrp:main Jul 12, 2023
1 of 2 checks passed
@kurtmckee kurtmckee deleted the use-tox branch July 12, 2023 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants