Tracking Issue for Pytest migration.

[prady0t]

This is a tracking issue to keep track of all the files that have been successfully migrated to pytest.

Integration Tests

• ├── test_experiments.py(Migrating rest of integration tests to pytest #4285)
  ├── test_models
• │  ├── standard_model_tests.py(Not needed)
• │  ├── standard_output_comparison.py(Not needed)
• │  ├── standard_output_tests.py(Not needed)
  │  ├── test_full_battery_models
  │   │  ├── test_equivalent_circuit
• │   │   │   └── test_thevenin.py(Moving a bunch of integration test files to pytest. #4238)
  │   │  ├── test_lead_acid
• │   │   │   ├── test_asymptotics_convergence.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   │   ├── test_compare_basic_models.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   │   ├── test_compare_outputs.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   │   ├── test_full.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   │   ├── test_loqs.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   │   ├── test_loqs_surface_form.py(Moving a bunch of integration test files to pytest. #4238)
  │   │   │  └── test_side_reactions
• │   │   │   ├── test_full_side_reactions.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   │   └── test_loqs_side_reactions.py(Moving a bunch of integration test files to pytest. #4238)
  │   │  └── test_lithium_ion
• │   │   ├── base_lithium_ion_half_cell_tests.py(Not needed)
• │   │   ├── base_lithium_ion_tests.py(Not needed)
• │   │   ├── test_basic_models.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   ├── test_compare_basic_models.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   ├── test_compare_outputs.py(Not needed)
• │   │   ├── test_compare_outputs_two_phase.py(Migrating rest of integration tests to pytest #4285)
• │   │   ├── test_dfn.py(Migrating rest of integration tests to pytest #4285)
• │   │   ├── test_dfn_half_cell.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   │   └── test_external_temperature.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   ├── test_initial_soc.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   ├── test_mpm.py(Migrating rest of integration tests to pytest #4285)
• │   │   ├── test_newman_tobias.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   ├── test_spm.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   ├── test_spm_half_cell.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   ├── test_spme.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   ├── test_spme_half_cell.py(Moving a bunch of integration test files to pytest. #4238)
• │   │   ├── test_thermal_models.py(Migrating rest of integration tests to pytest #4285)
• │   │   └── test_yang2017.py(Moving a bunch of integration test files to pytest. #4238)
  │ └── test_submodels
  │   ├── test_external_circuit
• │   │   └── test_function_control.py(Migrating rest of integration tests to pytest #4285)

•   │       └──  `test_interface`
  

• │   ├── test_butler_volmer.py(Migrating rest of integration tests to pytest #4285)
• │   ├── test_lead_acid.py(Migrating rest of integration tests to pytest #4285)
• │   └── test_lithium_ion.py(Migrating rest of integration tests to pytest #4285)
  ├── test_solvers
• │   ├── test_idaklu.py(Migrating rest of integration tests to pytest #4285)
• │  └── test_solution.py(Migrating rest of integration tests to pytest #4285)
  └── test_spatial_methods
• ├── test_finite_volume.py(Migrating rest of integration tests to pytest #4285)
• └── test_spectral_volume.py(Migrating rest of integration tests to pytest #4285)

Unit Tests

• ├── test_batch_study.py (Migrating unit tests to pytest (Part 5) #4333)
• ├── test_callbacks.py (Migrating unit tests to pytest (Part 5) #4333)
• ├── test_citations.py (Migrating unit tests to pytest (Part 5) #4333)
  ├── test_discretisations
• │   └── test_discretisation.py (Migrating unit tests to pytest (Part 5) #4333)
• ├── test_doc_utils.py(Moving a bunch of unit tests to pytest. #4264)
  ├── test_experiments
• │   ├── test_experiment.py (Migrating unit tests to pytest (Part 5) #4333)
• │   ├── test_experiment_step_termination.py
• │   ├── test_experiment_steps.py (Migrating unit tests to pytest (Part 5) #4333)
• │   └── test_simulation_with_experiment.py (Final pytest migration #4443)
  ├── test_expression_tree
• │   ├── test_array.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_averages.py (Migrating unit tests to pytest (Part 5) #4333)
• │   ├── test_binary_operators.py (Final pytest migration #4443)
• │   ├── test_broadcasts.py (Migrating unit tests to pytest (Part 5) #4333)
• │   ├── test_concatenations.py (Migrating unit tests to pytest (Part 5) #4333)
• │   ├── test_d_dt.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_functions.py (Migrating unit tests to pytest (Part 5) #4333)
• │   ├── test_independent_variable.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_input_parameter.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_interpolant.py (Migrating unit tests to pytest (Part 5) #4333)
• │   ├── test_matrix.py(Moving a bunch of unit tests to pytest. #4264)
  │   ├── test_operations
• │   │   ├── test_convert_to_casadi.py (Migrating unit tests to pytest (Part 5) #4333)
• │   │   ├── test_copy.py (Migrating unit tests to pytest (Part 5) #4333)
• │   │   ├── test_evaluate_python.py (Migrating unit tests to pytest (Part 5) #4333)
• │   │   ├── test_jac.py (Migrating unit tests to pytest (Part 5) #4333)
• │   │   ├── test_jac_2D.py
• │   │   ├── test_latexify.py (Migrating unit tests to pytest (Part 5) #4333)
• │   │   └── test_unpack_symbols.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_parameter.py (Migrating unit tests to pytest (Part 5) #4333)
  │   ├── test_printing
• │   │   ├── test_print_name.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   └── test_sympy_overrides.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_scalar.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_state_vector.py (Migrating unit tests to pytest (Part 5) #4333)
• │   ├── test_symbol.py (Migrating unit tests to pytest (Part 5) #4333)
• │   ├── test_symbolic_diff.py (Migrating unittest to pytest 6 #4354)
• │   ├── test_unary_operators.py (Migrating unittest to pytest 6 #4354)
• │   ├── test_variable.py
• │   └── test_vector.py(Moving a bunch of unit tests to pytest. #4264)
  ├── test_geometry
• │   └── test_battery_geometry.py (Migrating unittest to pytest 6 #4354)
• ├── test_logger.py(Moving a bunch of unit tests to pytest. #4264)
  ├── test_meshes
• │   ├── test_meshes.py (Migrating unittest to pytest 6 #4354)
• │   ├── test_one_dimensional_submesh.py (Migrating unittest to pytest 6 #4354)
• │   ├── test_scikit_fem_submesh.py (Migrating unittest to pytest 6 #4354)
• │   └── test_zero_dimensional_submesh.py(Moving a bunch of unit tests to pytest. #4264)
  ├── test_models
• │   ├── test_base_model.py (Migrating unittest to pytest 6 #4354)
• │   ├── test_event.py(Moving a bunch of unit tests to pytest. #4264)
  │   ├── test_full_battery_models
• │   │   ├── test_base_battery_model.py (Final pytest migration #4443 )
  │   │   ├── test_equivalent_circuit
• │   │   │   └── test_thevenin.py (Migrating unittest to pytest 6 #4354)
  │   │   ├── test_lead_acid
• │   │   │   ├── test_base_lead_acid_model.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   │   ├── test_basic_models.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   │   ├── test_full.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   │   └── test_loqs.py (Migrating unittest to pytest 6 #4354)
  │   │   └── test_lithium_ion
• │   │   ├── base_lithium_ion_half_cell_tests.py
• │   │   ├── base_lithium_ion_tests.py
• │   │   ├── test_Yang2017.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_base_lithium_ion_model.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_basic_models.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_dfn.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_dfn_half_cell.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_electrode_soh.py (Migrating unittest to pytest 6 #4354)
• │   │   ├── test_mpm.py (Migrating unittest to pytest 6 #4354)
• │   │   ├── test_mpm_half_cell.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_msmr.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_newman_tobias.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_spm.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_spm_half_cell.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_spme.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   └── test_spme_half_cell.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_model_info.py(Moving a bunch of unit tests to pytest. #4264)
  │   └── test_submodels
• │   ├── test_base_submodel.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_effective_current_collector.py(Moving a bunch of unit tests to pytest. #4264)
• │   └── test_particle_polynomial_profile.py(Moving a bunch of unit tests to pytest. #4264)
  ├── test_parameters
• │   ├── test_base_parameters.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_bpx.py (Migrating unittest to pytest 6 #4354)
• │   ├── test_current_functions.py (Migrating unittest to pytest 6 #4354)
• │   ├── test_ecm_parameters.py (Migrating unittest to pytest 6 #4354)
• │   ├── test_electrical_parameters.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_geometric_parameters.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_lead_acid_parameters.py (Migrating unittest to pytest 6 #4354)
• │   ├── test_lithium_ion_parameters.py (Migrating unittest to pytest 6 #4354)
  │   ├── test_parameter_sets
• │   │   ├── test_Ai2020.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_Ecker2015.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_Ecker2015_graphite_halfcell.py
• │   │   ├── test_LCO_Ramadass2004.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_LGM50_ORegan2022.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   ├── test_OKane2022.py (Final pytest migration #4443)
• │   │   ├── test_OKane2022_negative_halfcell.py(Moving a bunch of unit tests to pytest. #4264)
• │   │   └── test_parameters_with_default_models.py (Final pytest migration #4443)
• │   ├── test_parameter_sets_class.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_parameter_values.py (Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_process_parameter_data.py (Migrating unittest to pytest (Part 7) #4431)
• │   └── test_size_distribution_parameters.py(Moving a bunch of unit tests to pytest. #4264)
  ├── test_plotting
• │   ├── test_plot.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_plot_summary_variables.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_plot_thermal_components.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_plot_voltage_components.py(Moving a bunch of unit tests to pytest. #4264)
• │   └── test_quick_plot.py (Migrating unittest to pytest (Part 7) #4431)
• ├── test_pybamm_data.py
  ├── test_serialisation
• │   └── test_serialisation.py(Migrating unittest to pytest (Part 7) #4431)
• ├── test_settings.py(Moving a bunch of unit tests to pytest. #4264)
• ├── test_simulation.py(Migrating unittest to pytest (Part 7) #4431)
  ├── test_solvers
• │   ├── test_algebraic_solver.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_base_solver.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_casadi_algebraic_solver.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_casadi_solver.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_dummy_solver.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_idaklu_jax.py
• │   ├── test_idaklu_solver.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_jax_bdf_solver.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_jax_solver.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_lrudict.py(Moving a bunch of unit tests to pytest. #4264)
• │   ├── test_processed_variable.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_processed_variable_computed.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_scipy_solver.py (Final pytest migration #4443)
• │   └── test_solution.py
  ├── test_spatial_methods
• │   ├── test_base_spatial_method.py(Migrating unittest to pytest (Part 7) #4431)
  │   ├── test_finite_volume
• │   │   ├── test_extrapolation.py(Migrating unittest to pytest (Part 7) #4431)
• │   │   ├── test_finite_volume.py(Migrating unittest to pytest (Part 7) #4431)
• │   │   ├── test_ghost_nodes_and_neumann.py(Migrating unittest to pytest (Part 7) #4431)
• │   │   ├── test_grad_div_shapes.py(Migrating unittest to pytest (Part 7) #4431)
• │   │   └── test_integration.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_scikit_finite_element.py(Migrating unittest to pytest (Part 7) #4431)
• │   ├── test_spectral_volume.py(Migrating unittest to pytest (Part 7) #4431)
• │   └── test_zero_dimensional_method.py(Moving a bunch of unit tests to pytest. #4264)
• ├── test_timer.py(Moving a bunch of unit tests to pytest. #4264)
• └── test_util.py (Moving test_util.py to pytest #4214)

Note :

• Use setup_method instead of fixtures everywhere.
• test_citations.py : This is an example of a file that contains a lot of boilerplate and can be reduced by fixtures and parametrizing the test cases
• Parameterize tests/unit/test_parameters/test_process_parameter_data.py

[kratman]

@prady0t Can you summarize what is not covered in #3617 so that we can close the older issue?

[agriyakhetarpal]

I closed the older issue, just the updates to the Contributing Guide and the removal of the run-tests.py file remain, which are being tracked through weekly updates.

[prady0t]

there are still 14 files left. I should open a new PR concluding everything or should I cover them in pt-7?

[agriyakhetarpal]

A new PR would be better. Part 6 and Part 7 are ready to merge, I approved them

[prady0t]

Correction : 9 files

[agriyakhetarpal]

Almost there with completing them all!

[agriyakhetarpal]

@prady0t, after #4443, it looks like 8 files are still left:

❯ rg unittest

tests/testcase.py
4:import unittest
7:class TestCase(unittest.TestCase):

tests/integration/test_models/test_submodels/test_interface/test_butler_volmer.py
8:import unittest
12:class TestButlerVolmer(unittest.TestCase):
387:    unittest.main()

tests/unit/test_expression_tree/test_concatenations.py
5:import unittest.mock as mock

tests/unit/test_parameters/test_parameter_sets/test_Ecker2015.py
6:import unittest
9:class TestEcker2015(unittest.TestCase):
55:    unittest.main()

tests/unit/test_expression_tree/test_functions.py
6:import unittest.mock as mock

tests/unit/test_expression_tree/test_input_parameter.py
7:import unittest.mock as mock

tests/unit/test_expression_tree/test_operations/test_evaluate_python.py
9:import unittest
758:    unittest.main()

tests/integration/test_models/test_full_battery_models/test_lithium_ion/test_compare_outputs.py
7:import unittest
11:class TestCompareOutputs(unittest.TestCase):
153:    unittest.main()

Could you migrate these files, too? Also, please check for any additional files that were missed.

[prady0t]

Thanks for pointing out! Check #4472

[kratman]

@prady0t Is this done now?

[prady0t]

Yes, I think this can be closed.