Merge pull request #24 from openscm/add-extra-test

Add extra test

Author: znicholls

.github/workflows/ci.yaml

@@ -104,6 +104,42 @@ jobs:
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+  tests-without-extras:
+    # Run the tests without installing extras.
+    # This is just a test to make sure to avoid
+    # breaking our test PyPI install workflow.
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ "ubuntu-latest" ]
+        # Just test against one Python version, this is just a helper.
+        # The real work happens in the test PyPI install
+        python-version: [ "3.11" ]
+    runs-on: "${{ matrix.os }}"
+    defaults:
+      run:
+        # This might be needed for Windows
+        # and doesn't seem to affect unix-based systems so we include it.
+        # If you have better proof of whether this is needed or not,
+        # feel free to update.
+        shell: bash
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Set up Python "${{ matrix.python-version }}"
+        id: setup-python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "${{ matrix.python-version }}"
+      - name: Install
+        run: |
+          pip install --upgrade pip wheel
+          pip install .
+          pip install -r requirements-only-tests-locked.txt
+      - name: Run tests
+        run: |
+          pytest tests -r a -vv tests
+
   imports-without-extras:
     strategy:
       fail-fast: false

.github/workflows/install-pypi.yaml

@@ -75,16 +75,10 @@ jobs:
         # So this is really just a smoke test,
         # rather than a super thorough integration test.
         pytest tests -r a -vv tests
-    # # This is a sketch of how you would do more thorough tests.
-    # # I don't like this solution because it is out of line with the lock file.
-    # # Probably the simplest way to do this is to use uv somehow,
-    # # install the package from pypi and the test dependencies
-    # # based on the lock file.
-    # - name: Install extra test dependencies
-    #   run: |
-    #     # A bit annoying to maintain this by hand, but ok for now.
-    #     pip install ipython matplotlib openscm-units scipy
-    # - name: Run tests with extra test dependencies installed
-    #   run: |
-    #     # Can't run doctests here because the paths are different.
-    #     pytest tests -r a -vv tests
+    - name: Install all test dependencies
+      run: |
+        pip install -r requirements-only-tests-locked.txt
+    - name: Run tests with extra test dependencies installed
+      run: |
+        # Can't run doctests here because the paths are different.
+        pytest tests -r a -vv tests

.pre-commit-config.yaml

@@ -55,6 +55,9 @@ repos:
       - id: uv-export
         name: export-requirements-docs
         args: ["-o", "requirements-docs-locked.txt", "--no-hashes", "--no-dev", "--no-emit-project", "--all-extras", "--group", "docs"]
+      - id: uv-export
+        name: export-requirements-only-tests
+        args: ["-o", "requirements-only-tests-locked.txt", "--no-hashes", "--no-dev", "--no-emit-project", "--only-group", "tests"]
       # # Not released yet
       # - id: uv-sync
   - repo: https://github.com/pdm-project/pdm

changelog/24.trivial.md

@@ -0,0 +1 @@
+Added a test to the CI to try and avoid breaking the PyPI install test inadvertently again.

requirements-only-tests-locked.txt

@@ -0,0 +1,45 @@
+# This file was autogenerated by uv via the following command:
+#    uv export -o requirements-only-tests-locked.txt --no-hashes --no-dev --no-emit-project --only-group tests
+asttokens==3.0.0
+colorama==0.4.6 ; sys_platform == 'win32'
+coverage==7.6.10
+decorator==5.1.1
+exceptiongroup==1.2.2 ; python_full_version < '3.11'
+executing==2.1.0
+flexcache==0.3
+flexparser==0.4
+globalwarmingpotentials==0.11.1
+iniconfig==2.0.0
+ipython==8.18.1
+jedi==0.19.2
+matplotlib-inline==0.1.7
+numpy==2.0.2 ; python_full_version < '3.10'
+numpy==2.2.0 ; python_full_version >= '3.10'
+openscm-units==0.6.3
+packaging==24.2
+pandas==2.2.3
+parso==0.8.4
+pexpect==4.9.0 ; sys_platform != 'win32'
+pint==0.24.4
+platformdirs==4.3.6
+pluggy==1.5.0
+prompt-toolkit==3.0.48
+ptyprocess==0.7.0 ; sys_platform != 'win32'
+pure-eval==0.2.3
+pygments==2.19.1
+pytest==8.3.4
+pytest-cov==6.0.0
+pytest-datadir==1.5.0
+pytest-regressions==2.6.0
+python-dateutil==2.9.0.post0
+pytz==2024.2
+pyyaml==6.0.2
+scipy==1.13.1 ; python_full_version < '3.10'
+scipy==1.14.1 ; python_full_version >= '3.10'
+six==1.17.0
+stack-data==0.6.3
+tomli==2.2.1 ; python_full_version <= '3.11'
+traitlets==5.14.3
+typing-extensions==4.12.2
+tzdata==2024.2
+wcwidth==0.2.13

tests/integration/test_timeseries_continous_integration.py

@@ -673,7 +673,7 @@ def test_differentiate(operations_test_case, differentiate_kwargs):
 def test_plot(  # noqa: PLR0913
     x_units, y_units, plot_kwargs, legend, time_axis_plot, image_regression, tmp_path
 ):
-    import matplotlib
+    matplotlib = pytest.importorskip("matplotlib")
 
     # ensure matplotlib does not use a GUI backend (such as Tk)
     matplotlib.use("Agg")
@@ -782,7 +782,7 @@ def test_plot(  # noqa: PLR0913
 def test_plot_matplotlib_units_not_registered(
     plot_kwargs, expectation, image_regression, tmp_path
 ):
-    import matplotlib
+    matplotlib = pytest.importorskip("matplotlib")
 
     # ensure matplotlib does not use a GUI backend (such as Tk)
     matplotlib.use("Agg")
@@ -828,6 +828,8 @@ def test_plot_matplotlib_units_not_registered(
     ),
 )
 def test_plot_ax_creation(sys_modules_patch, expectation):
+    pytest.importorskip("matplotlib")
+
     ts = TimeseriesContinuous(
         name="piecewise_quadratic",
         time_units=UR.Unit("yr"),

tests/integration/test_timeseries_discrete_integration.py

@@ -316,7 +316,7 @@ def test_plot_matplotlib_units_not_registered(
     ),
 )
 def test_plot_ax_creation(sys_modules_patch, expectation):
-    (pytest.importorskip("matplotlib"),)
+    pytest.importorskip("matplotlib")
 
     ts = TimeseriesDiscrete(
         name="basic",

tests/integration/test_timeseries_integration.py

@@ -1221,7 +1221,7 @@ def test_differentiate_then_integrate(start_interp, exp_result):
 def test_plot(  # noqa: PLR0913
     x_units, y_units, plot_kwargs, legend, image_regression, tmp_path
 ):
-    import matplotlib
+    matplotlib = pytest.importorskip("matplotlib")
 
     # ensure matplotlib does not use a GUI backend (such as Tk)
     matplotlib.use("Agg")
@@ -1322,7 +1322,7 @@ def test_plot(  # noqa: PLR0913
 def test_plot_matplotlib_units_not_registered(
     plot_kwargs, expectation, image_regression, tmp_path
 ):
-    import matplotlib
+    matplotlib = pytest.importorskip("matplotlib")
 
     # ensure matplotlib does not use a GUI backend (such as Tk)
     matplotlib.use("Agg")
@@ -1364,6 +1364,8 @@ def test_plot_matplotlib_units_not_registered(
     ),
 )
 def test_plot_ax_creation(sys_modules_patch, expectation):
+    pytest.importorskip("matplotlib")
+
     ts = Timeseries.from_arrays(
         x=Q([1.0, 10.0, 20.0], "yr"),
         y=Q([10.0, 12.0, 32.0], "Mt / yr"),