refactor: use pytest fixtures to parameterize tests for lead acid battery model #4723

Aswinr24 · 2024-12-29T18:52:23Z

Description

Refactored the lead-acid model test cases to use pytest fixtures, reducing code duplication and improving test clarity and maintainability.

Related to #4502

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

Code refactor (test improvements to reduce repetition)

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 tests pass: $ python run-tests.py --all (or $ nox -s tests)
The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

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

Further checks:

Code is commented, particularly in hard-to-understand areas
Tests added that prove fix is effective or that feature works

codecov · 2024-12-30T11:45:53Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.70%. Comparing base (651584f) to head (8205a6f).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #4723   +/-   ##
========================================
  Coverage    98.70%   98.70%           
========================================
  Files          304      304           
  Lines        23452    23452           
========================================
  Hits         23149    23149           
  Misses         303      303

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

agriyakhetarpal

I haven't gone through the tests in detail, just skimmed them for now – I think this looks wrong because tests for options such as {"current collector": "potential pair", "dimensionality": 1} that were previously present have been removed, apparently. The tests for the lumped thermal model are not present either (and others). Is this PR ready for review, @Aswinr24, or is it in progress and you're writing more tests? Apologies if it's the latter (and please mark it as a draft if it is!)

prady0t · 2024-12-31T11:48:22Z

@Aswinr24 Thanks for adding fixtures across tests! I suggest covering multiple files per PR so we don't have too many PRs covering single files. While you are working with this file, try to find more tests that can be parameterized using fixtures and cover those in this PR as well.

Once you have enough tests, you can mark this for review. Also, make a list of files (for yourself, no need to open any tracking issue) to keep track of the files you went through and the ones that are pending.

I'll add my reviews once it's marked as ready.

Aswinr24 · 2024-12-31T18:07:47Z

Thanks for the feedback @prady0t @agriyakhetarpal !
Sure will try adding multiple files in this PR and cover the tests that I believe can be parameterized using fixtures

…acid model

Aswinr24 · 2025-01-04T09:53:12Z

@prady0t @agriyakhetarpal Could You Please Review this.
I have tried to cover most of the tests which can be parameterized using fixtures, particularly in case of the Lead Acid Battery Model.
Would like to hear your feedback on this

tests/integration/test_models/test_full_battery_models/test_lead_acid/test_full.py

prady0t

Just by looking at the changes, I think we can use parametrize fixture here. @Aswinr24 can you maybe look into ways you can parametrize these tests?
Before that please add the class structure back, it would be easier to review with a cleaner diff.

…acid model-v2

Aswinr24 · 2025-01-05T11:58:53Z

@prady0t Thanks for the review, added back the class structure and tried to use the parameterize fixture wherever feasible.
Could you check this now

prady0t · 2025-01-07T17:22:48Z

It looks good. The tests look clean! The CI failure is unrelated to this PR, as the tests pass locally for me. Maybe we should re-run. @agriyakhetarpal would love your thoughts on these changes.

Aswinr24 · 2025-01-17T15:29:00Z

@agriyakhetarpal could you please review this submission and check if it is good to go?
Waiting to hear your thoughts on the changes done

agriyakhetarpal · 2025-01-18T06:09:15Z

Hi @Aswinr24, thanks for your work! I haven't had time to look at these changes in detail, sorry for the delay on this. I'll try to do so this weekend.

Saransh-cpp

Thanks for picking this up, @Aswinr24! Sorry for the delay in review. See my comments below -

Saransh-cpp · 2025-02-13T00:12:37Z

tests/integration/test_models/test_full_battery_models/test_lead_acid/test_loqs.py

+@pytest.fixture
+def loqs_model():
+    return pybamm.lead_acid.LOQS()


This looks like a redundant refactor (plus pass-by-sharing might meddle with the tests here), so I would suggest initialising the model in each test (just how it is done right now).

tests/integration/test_models/test_full_battery_models/test_lead_acid/test_full.py

Saransh-cpp · 2025-02-13T00:16:10Z

Could you also resolve the conflicts? Thanks!

Aswinr24 · 2025-02-15T08:22:46Z

Thanks for the review!
Sure will get back to you once I am done with resolving the conflicts and the changes suggested @Saransh-cpp

Aswinr24 · 2025-02-19T09:47:20Z

@Saransh-cpp done with my changes needed and resolving conflicts, waiting to hear if it is good to go ?

Saransh-cpp

Thanks, @Aswinr24! This looks good to me. I will wait for a review by others before merging this.

prady0t

Lgtm. Thanks @Aswinr24!

agriyakhetarpal

Thanks, @Aswinr24! I have a couple of small suggestions, happy to approve after.

tests/unit/test_models/test_full_battery_models/test_lead_acid/test_full.py

tests/unit/test_models/test_full_battery_models/test_lead_acid/test_loqs.py

Aswinr24 · 2025-02-22T19:17:39Z

@agriyakhetarpal Done with my changes! waiting to hear if it is good to go ?

agriyakhetarpal · 2025-02-22T21:39:30Z

This is good to go, indeed. Thanks, @Aswinr24!

refactor: use pytest fixtures to reduce repetition in tests

f500d54

agriyakhetarpal requested a review from prady0t December 30, 2024 12:02

agriyakhetarpal requested changes Dec 30, 2024

View reviewed changes

Aswinr24 marked this pull request as draft December 30, 2024 16:26

Aswinr24 and others added 2 commits January 4, 2025 15:14

refactor: use pytest fixtures to reduce repetition in tests for lead …

234fe49

…acid model

Merge branch 'develop' into refactor/unit-tests

0149b26

Aswinr24 marked this pull request as ready for review January 4, 2025 09:53

Aswinr24 changed the title ~~refactor: use pytest fixtures to reduce repetition in tests~~ refactor: use pytest fixtures to parameterize tests for lead acid battery model Jan 4, 2025

prady0t reviewed Jan 4, 2025

View reviewed changes

tests/integration/test_models/test_full_battery_models/test_lead_acid/test_full.py Show resolved Hide resolved

prady0t suggested changes Jan 4, 2025

View reviewed changes

refactor: use pytest fixtures to reduce repetition in tests for lead …

2755e4a

…acid model-v2

Merge branch 'develop' into refactor/unit-tests

4ef92a6

Aswinr24 mentioned this pull request Jan 21, 2025

chore: switch to np.testing.assert_allclose for better precision in tests #4789

Merged

8 tasks

Saransh-cpp requested changes Feb 13, 2025

View reviewed changes

Saransh-cpp marked this pull request as draft February 13, 2025 00:16

Aswinr24 added 2 commits February 19, 2025 14:30

Merge branch 'develop' into refactor/unit-tests

f12953b

refactor: move optimtest fixture and resolve merge conflicts

12c9114

Saransh-cpp previously approved these changes Feb 19, 2025

View reviewed changes

Saransh-cpp requested a review from prady0t February 19, 2025 10:55

Saransh-cpp requested a review from agriyakhetarpal February 19, 2025 10:55

Saransh-cpp marked this pull request as ready for review February 19, 2025 10:55

Saransh-cpp requested a review from a team as a code owner February 19, 2025 10:55

prady0t approved these changes Feb 20, 2025

View reviewed changes

agriyakhetarpal reviewed Feb 20, 2025

View reviewed changes

tests/unit/test_models/test_full_battery_models/test_lead_acid/test_full.py Outdated Show resolved Hide resolved

tests/unit/test_models/test_full_battery_models/test_lead_acid/test_loqs.py Outdated Show resolved Hide resolved

Aswinr24 and others added 2 commits February 23, 2025 00:45

Merge branch 'develop' into refactor/unit-tests

cc2a7c1

fix: naming redundancy and structural fixes

8205a6f

Aswinr24 dismissed Saransh-cpp’s stale review via 8205a6f February 22, 2025 19:16

agriyakhetarpal approved these changes Feb 22, 2025

View reviewed changes

agriyakhetarpal enabled auto-merge (squash) February 22, 2025 21:39

agriyakhetarpal merged commit 725a42c into pybamm-team:develop Feb 22, 2025
25 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: use pytest fixtures to parameterize tests for lead acid battery model #4723

refactor: use pytest fixtures to parameterize tests for lead acid battery model #4723

Aswinr24 commented Dec 29, 2024

codecov bot commented Dec 30, 2024 •

edited

Loading

agriyakhetarpal left a comment •

edited

Loading

prady0t commented Dec 31, 2024 •

edited

Loading

Aswinr24 commented Dec 31, 2024

Aswinr24 commented Jan 4, 2025

prady0t left a comment

Aswinr24 commented Jan 5, 2025

prady0t commented Jan 7, 2025 •

edited

Loading

Aswinr24 commented Jan 17, 2025

agriyakhetarpal commented Jan 18, 2025

Saransh-cpp left a comment

Saransh-cpp Feb 13, 2025

Saransh-cpp commented Feb 13, 2025

Aswinr24 commented Feb 15, 2025

Aswinr24 commented Feb 19, 2025

Saransh-cpp left a comment

prady0t left a comment

agriyakhetarpal left a comment

Aswinr24 commented Feb 22, 2025

agriyakhetarpal commented Feb 22, 2025

refactor: use pytest fixtures to parameterize tests for lead acid battery model #4723

refactor: use pytest fixtures to parameterize tests for lead acid battery model #4723

Conversation

Aswinr24 commented Dec 29, 2024

Description

Type of change

Key checklist:

Further checks:

codecov bot commented Dec 30, 2024 • edited Loading

Codecov Report

agriyakhetarpal left a comment • edited Loading

Choose a reason for hiding this comment

prady0t commented Dec 31, 2024 • edited Loading

Aswinr24 commented Dec 31, 2024

Aswinr24 commented Jan 4, 2025

prady0t left a comment

Choose a reason for hiding this comment

Aswinr24 commented Jan 5, 2025

prady0t commented Jan 7, 2025 • edited Loading

Aswinr24 commented Jan 17, 2025

agriyakhetarpal commented Jan 18, 2025

Saransh-cpp left a comment

Choose a reason for hiding this comment

Saransh-cpp Feb 13, 2025

Choose a reason for hiding this comment

Saransh-cpp commented Feb 13, 2025

Aswinr24 commented Feb 15, 2025

Aswinr24 commented Feb 19, 2025

Saransh-cpp left a comment

Choose a reason for hiding this comment

prady0t left a comment

Choose a reason for hiding this comment

agriyakhetarpal left a comment

Choose a reason for hiding this comment

Aswinr24 commented Feb 22, 2025

agriyakhetarpal commented Feb 22, 2025

codecov bot commented Dec 30, 2024 •

edited

Loading

agriyakhetarpal left a comment •

edited

Loading

prady0t commented Dec 31, 2024 •

edited

Loading

prady0t commented Jan 7, 2025 •

edited

Loading