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

Decrease test suite completion time #304

Merged
merged 13 commits into from
May 9, 2024

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Apr 22, 2024

Description

This PR updates the test suite to minimise the completion time while maintaing the performance assertions.

Issue reference

Fixes #302

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

@BradyPlanden BradyPlanden linked an issue Apr 22, 2024 that may be closed by this pull request
Copy link

codecov bot commented Apr 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.70%. Comparing base (10e68f2) to head (682fe61).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #304      +/-   ##
===========================================
- Coverage    95.80%   95.70%   -0.10%     
===========================================
  Files           38       38              
  Lines         2048     2048              
===========================================
- Hits          1962     1960       -2     
- Misses          86       88       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@BradyPlanden BradyPlanden changed the title [WIP]: Decrease integration test suite completion time [WIP]: Decrease test suite completion time Apr 22, 2024
@BradyPlanden
Copy link
Member Author

BradyPlanden commented Apr 27, 2024

The patch coverage for this PR has decreased because we don't have a direct test for the SciPyMinimize cost_wrapper() method. In its current state, this method is difficult to unit test, which is why I suspect we haven't added a unit test. Since #255 refactors these classes and will make it easier to test this function directly with a few small changes, I believe this PR can proceed as is, with a follow-on PR to add these tests once #255 is merged depending on which is merged first.

@BradyPlanden BradyPlanden changed the title [WIP]: Decrease test suite completion time Decrease test suite completion time Apr 27, 2024
@agriyakhetarpal
Copy link
Member

Just noticed that this PR fixes the scheduled tests, too. If you feel that this can take time for reviewing and merging, I wish to point towards #308, which fixes them as well.

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

Thanks, @BradyPlanden! The difference in the test suite completion time seems to be noticeable. Could you add a CHANGELOG entry as well?

.github/workflows/test_on_push.yaml Show resolved Hide resolved
@BradyPlanden
Copy link
Member Author

@all-contributors add @agriyakhetarpal to review.

Copy link
Contributor

@BradyPlanden

I've put up a pull request to add @agriyakhetarpal! 🎉

@BradyPlanden BradyPlanden merged commit 0395429 into develop May 9, 2024
28 of 29 checks passed
@BradyPlanden BradyPlanden deleted the 302-reduce-integation-test-suite-time branch May 9, 2024 11:53
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.

Reduce integation test suite time
2 participants