List 25 slowest tests

[bouweandela]

🚀 Pull Request

Description

Running the iris test suite feels a bit slow when developing. This pull request adds a pytest option that causes the 25 slowest tests to be displayed with every test run. This will make test run times more visible to developers and in that way encourage writing faster tests.

Examples

In CI: https://github.com/SciTools/iris/actions/runs/9186913624/job/25263500853?pr=5969#step:12:1646

Locally:

$ pytest lib/iris/tests/unit/cube/test_Cube.py
============================================================================ test session starts ============================================================================
platform linux -- Python 3.12.2, pytest-8.1.1, pluggy-1.4.0
rootdir: /home/bandela/src/scitools/iris
configfile: pyproject.toml
plugins: cov-5.0.0, xdist-3.5.0
collected 354 items                                                                                                                                                         

lib/iris/tests/unit/cube/test_Cube.py ............................................................................................................................... [ 35%]
..................................................................................................................................................................... [ 82%]
..............................................................                                                                                                        [100%]

============================================================================= warnings summary ==============================================================================
lib/iris/tests/unit/cube/test_Cube.py::Test___init___data::test_matrix
  /home/bandela/src/scitools/iris/lib/iris/tests/unit/cube/test_Cube.py:68: PendingDeprecationWarning: the matrix subclass is not the recommended way to represent matrices or deal with linear algebra (see https://docs.scipy.org/doc/numpy/user/numpy-for-matlab-users.html). Please adjust your code to use regular ndarray.
    data = np.matrix([[1, 2, 3], [4, 5, 6]])

lib/iris/tests/unit/cube/test_Cube.py: 41 warnings
  /home/bandela/src/scitools/iris/lib/iris/coords.py:2153: IrisVagueMetadataWarning: Cannot check if coordinate is contiguous: Invalid operation for 'y', with 0 bound(s). Contiguous bounds are only defined for 1D coordinates with 2 bounds. Metadata may not be fully descriptive for 'y'. Ignoring bounds.
    warnings.warn(

lib/iris/tests/unit/cube/test_Cube.py: 22 warnings
  /home/bandela/src/scitools/iris/lib/iris/coords.py:2153: IrisVagueMetadataWarning: Cannot check if coordinate is contiguous: Invalid operation for 'x', with 0 bound(s). Contiguous bounds are only defined for 1D coordinates with 2 bounds. Metadata may not be fully descriptive for 'x'. Ignoring bounds.
    warnings.warn(

lib/iris/tests/unit/cube/test_Cube.py: 26 warnings
  /home/bandela/src/scitools/iris/lib/iris/coords.py:2140: IrisVagueMetadataWarning: Collapsing a multi-dimensional coordinate. Metadata may not be fully descriptive for 'full_x'.
    warnings.warn(

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
=========================================================================== slowest 25 durations ============================================================================
2.26s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_1d_slice_dimension_given
2.25s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_1d_slice_coord_name_given
2.22s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_1d_slice_coord_given
2.21s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_duplicate_coordinate_given
2.21s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_non_orthogonal_coordinates_given
0.91s call     lib/iris/tests/unit/cube/test_Cube.py::Test_convert_units::test_unit_multiply
0.20s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_multidim_slice_coord_given
0.15s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_2d_slice_coord_given
0.15s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_2d_slice_reversed_dimension_given
0.15s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_2d_slice_coord_name_given
0.15s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_2d_slice_dimension_given
0.08s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_nodimension
0.06s call     lib/iris/tests/unit/cube/test_Cube.py::Test_xml::test_ancils
0.02s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_dim_order::test_all_permutations
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test__init__mesh::test_meshcoords_equal_meshes
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_2d_slice_nonexistent_dimension_given
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test__init__mesh::test_fail_meshcoords_different_meshes
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_1d_slice_nonexistent_coord_name_given
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_2d_slice_nonexistent_coord_name_given
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_1d_slice_nonexistent_dimension_given
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_1d_slice_nonexistent_coord_given
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test_intersection__Metadata::test_metadata_wrapped
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test_slices_over::test_2d_slice_nonexistent_coord_given
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test__add_aux_coord__mesh::test_fail_different_dimension
0.01s call     lib/iris/tests/unit/cube/test_Cube.py::Test_collapsed__multidim_weighted_with_dim_metadata::test_weighted_fullweights_lazy_x
===================================================================== 354 passed, 90 warnings in 14.03s =====================================================================

---

Consult Iris pull request check list

---

Add any of the below labels to trigger actions on this PR:

• benchmark_this Request that this pull request be benchmarked to check if it introduces performance shifts

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.78%. Comparing base (3e1e80e) to head (5bb2ce4).
Report is 1 commits behind head on main.

❗ Current head 5bb2ce4 differs from pull request most recent head 30d6c11

Please upload reports for the commit 30d6c11 to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5969      +/-   ##
==========================================
- Coverage   89.78%   89.78%   -0.01%     
==========================================
  Files          93       93              
  Lines       23010    23007       -3     
  Branches     5018     5017       -1     
==========================================
- Hits        20660    20657       -3     
  Misses       1620     1620              
  Partials      730      730              

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

[bjlittle]

@bouweandela Yup, this is really handy, thanks for adding this useful testing diagnostic 🍻