CI: unify and test all os (#115)

mathause · web-flow · commit 73bca9d7d4fc · 2024-05-30T23:19:14.000+02:00
* CI: unify and test all os

* fix package name

* fix location of environment file

* remove another mesmer artifact

* min-deps-check: fix filename

* remove all flag

* fix macosx backend check

* remove unused pytest-env

* add colors try not verbose

* not unbuffered

* remove pytest.ini

* get config

* move config to pyproject.toml

* undo show options

* try no options

* set options again

* cannot remove env var :-(

* fix tests

* fix expected_size

* next_try

* set dpi

* fix last test

* Apply suggestions from code review
diff --git a/.github/workflows/ci-additional.yaml b/.github/workflows/ci-additional.yaml
@@ -13,59 +13,6 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  test:
-    name: py${{ matrix.python-version }}-${{ matrix.env }}
-    runs-on: "ubuntu-latest"
-    defaults:
-      run:
-        shell: bash -l {0}
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - env: "min-all-deps"
-            python-version: "3.9"
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # Fetch all history for all branches and tags.
-
-      - name: Set environment variables
-        run: |
-            PY=${{ matrix.python-version }}
-            # replace "." in matrix.python-version
-            PY=${PY//./}
-            echo "CONDA_ENV_FILE=ci/requirements/py${PY}-${{ matrix.env }}.yml" >> $GITHUB_ENV
-      - name: Create conda environment
-        uses: mamba-org/setup-micromamba@v1
-        with:
-          environment-file: ${{ env.CONDA_ENV_FILE }}
-          cache-downloads: true
-          cache-downloads-key: "${{runner.os}}-${{runner.arch}}-py${{matrix.python-version}}"
-          create-args: >-
-            python=${{ matrix.python-version }}
-      - name: Install mplotutils
-        run: |
-          python -m pip install --no-deps -e .
-      - name: Import mplotutils
-        run: |
-          python -c "import mplotutils"
-      - name: Run tests
-        timeout-minutes: 15
-        run: python -u -m pytest
-          --cov=mplotutils
-          --cov-report=xml
-          $PYTEST_EXTRA_FLAGS
-
-      - name: Upload code coverage to Codecov
-        uses: codecov/codecov-action@v4
-        with:
-          file: ./coverage.xml
-          flags: unittests,${{ matrix.env }}
-          env_vars: RUNNER_OS
-          name: codecov-umbrella
-          fail_ci_if_error: false
-
   min-version-policy:
     name: Minimum Version Policy
     runs-on: "ubuntu-latest"
@@ -94,4 +41,4 @@ jobs:
 
       - name: minimum versions policy
         run: |
-          python ci/min_deps_check.py ci/requirements/py39-min-all-deps.yml
+          python ci/min_deps_check.py ci/requirements/min-all-deps.yml
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -11,51 +11,67 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  FORCE_COLOR: 3
+
 jobs:
   test:
-    name: py${{ matrix.python-version }}
+    name: py${{ matrix.python-version }} ${{ matrix.os }} ${{ matrix.env }}
     runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        shell: bash -l {0}
     strategy:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"]
-        # Bookend python versions
         python-version: ["3.9", "3.11", "3.12"]
+        env: [""]
+        include:
+          - env: "min-all-deps"
+            python-version: "3.9"
+            os: "ubuntu-latest"
+          - env: ""
+            python-version: "3.12"
+            os: "macos-latest"
+    defaults:
+      run:
+        shell: bash -l {0}
+
     steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # Fetch all history for all branches and tags.
-      - name: Set environment variables
-        run: |
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set environment variables
+      run: |
+
+        if [[ "${{ matrix.env }}" == "" ]]; then
           echo "CONDA_ENV_FILE=ci/requirements/environment.yml" >> $GITHUB_ENV
-          echo "PYTHON_VERSION=${{ matrix.python-version }}" >> $GITHUB_ENV
-      - name: Create conda environment
-        uses: mamba-org/setup-micromamba@v1
-        with:
-          environment-file: ci/requirements/environment.yml
-          cache-downloads: true
-          cache-downloads-key: "${{runner.os}}-${{runner.arch}}-py${{matrix.python-version}}"
-          create-args: >-
-            python=${{ matrix.python-version }}
-      - name: Install mplotutils
-        run: |
-          python -m pip install --no-deps -e .
-      - name: Import mplotutils
-        run: |
-          python -c "import mplotutils"
-      - name: Run tests
-        timeout-minutes: 5
-        run: python -u -m pytest
-          --cov=mplotutils
-          --cov-report=xml
-          --junitxml=test-results/${{ runner.os }}-${{ matrix.python-version }}.xml
+        else
+          echo "CONDA_ENV_FILE=ci/requirements/${{ matrix.env }}.yml" >> $GITHUB_ENV
+        fi
+
+    - name: Create conda environment
+      uses: mamba-org/setup-micromamba@v1
+      with:
+        environment-name: mplotutils-tests
+        cache-downloads: true
+        cache-downloads-key: "${{runner.os}}-${{runner.arch}}-py${{matrix.python-version}}-${{ env.CONDA_ENV_FILE }}"
+        micromamba-version: 'latest'
+        environment-file: ${{ env.CONDA_ENV_FILE }}
+        create-args: >-
+          python=${{ matrix.python-version }}
 
-      - name: Upload code coverage to Codecov
-        uses: codecov/codecov-action@v4
-        with:
+    - name: Install mplotutils
+      run: |
+        python -m pip install --no-deps -e .
+
+    - name: Run tests
+      run: python -m pytest
+       -ra -v
+       --cov=mplotutils
+       --cov-report=xml
+
+    - name: Upload code coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
           file: ./coverage.xml
           flags: unittests
           env_vars: RUNNER_OS,PYTHON_VERSION
@@ -67,7 +83,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.11"]
+        python-version: ["3.12"]
 
     steps:
     - uses: actions/checkout@v4
diff --git a/ci/requirements/environment.yml b/ci/requirements/environment.yml
@@ -15,4 +15,3 @@ dependencies:
 # for testing
   - pytest
   - pytest-cov
-  - pytest-env
diff --git a/ci/requirements/min-all-deps.yml b/ci/requirements/min-all-deps.yml
@@ -12,4 +12,3 @@ dependencies:
 # for testing
   - pytest
   - pytest-cov
-  - pytest-env
diff --git a/mplotutils/tests/test_set_map_layout.py b/mplotutils/tests/test_set_map_layout.py
@@ -1,16 +1,28 @@
+import matplotlib.pyplot as plt
 import numpy as np
 import pytest
 
 from mplotutils import set_map_layout
 
-from . import subplots_context
+from . import figure_context, subplots_context
+
+
+def get_rtol(f):
+    # macosx is only exact up to 1 / dpi
+
+    if plt.get_backend().lower() != "macosx":
+        rtol = 1e-07
+    else:
+        rtol = 1 / f.get_dpi()
+    return rtol
 
 
 def test_set_map_layout_default_width():
     with subplots_context() as (f, ax):
         set_map_layout(ax)
 
-        assert f.get_size_inches()[0] * 2.54 == 17.0
+        width = f.get_size_inches()[0] * 2.54
+        np.testing.assert_allclose(width, 17.0, rtol=get_rtol(f))
 
 
 @pytest.mark.parametrize(
@@ -25,7 +37,7 @@ def test_set_map_layout_no_borders(nrow_ncol):
         set_map_layout(ax, 10, **nrow_ncol)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 10))
+        np.testing.assert_allclose((width, height), (10, 10), rtol=get_rtol(f))
 
     # width:height = 2:1
     with subplots_context() as (f, ax):
@@ -35,7 +47,7 @@ def test_set_map_layout_no_borders(nrow_ncol):
         set_map_layout(ax, 10, **nrow_ncol)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 5))
+        np.testing.assert_allclose((width, height), (10, 5), rtol=get_rtol(f))
 
     # width:height = 1:2
     with subplots_context() as (f, ax):
@@ -45,7 +57,7 @@ def test_set_map_layout_no_borders(nrow_ncol):
         set_map_layout(ax, 10, **nrow_ncol)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 20))
+        np.testing.assert_allclose((width, height), (10, 20), rtol=get_rtol(f))
 
 
 @pytest.mark.parametrize("ax_to_arr", (lambda ax: [ax], lambda ax: np.array(ax)))
@@ -58,7 +70,7 @@ def test_set_map_layout_ax_arr(ax_to_arr):
         set_map_layout(ax_to_arr(ax), 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 10))
+        np.testing.assert_allclose((width, height), (10, 10), rtol=get_rtol(f))
 
 
 def test_set_map_layout_vert_borders():
@@ -72,7 +84,7 @@ def test_set_map_layout_vert_borders():
         set_map_layout(ax, 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 20))
+        np.testing.assert_allclose((width, height), (10, 20), rtol=get_rtol(f))
 
     # width:height = 1:1
     with subplots_context() as (f, ax):
@@ -84,7 +96,7 @@ def test_set_map_layout_vert_borders():
         set_map_layout(ax, 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 12.5))
+        np.testing.assert_allclose((width, height), (10, 12.5), rtol=get_rtol(f))
 
     # width:height = 1:1
     with subplots_context() as (f, ax):
@@ -96,7 +108,7 @@ def test_set_map_layout_vert_borders():
         set_map_layout(ax, 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 40))
+        np.testing.assert_allclose((width, height), (10, 40), rtol=get_rtol(f))
 
 
 def test_set_map_layout_horz_borders():
@@ -110,7 +122,7 @@ def test_set_map_layout_horz_borders():
         set_map_layout(ax, 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 5))
+        np.testing.assert_allclose((width, height), (10, 5), rtol=get_rtol(f))
 
     # width:height = 1:1
     with subplots_context() as (f, ax):
@@ -122,7 +134,7 @@ def test_set_map_layout_horz_borders():
         set_map_layout(ax, 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 5))
+        np.testing.assert_allclose((width, height), (10, 5), rtol=get_rtol(f))
 
 
 def test_set_map_layout_two_axes_vert():
@@ -137,7 +149,7 @@ def test_set_map_layout_two_axes_vert():
         set_map_layout(ax, 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 20))
+        np.testing.assert_allclose((width, height), (10, 20), rtol=get_rtol(f))
 
     # width:height = 1:1
     with subplots_context(2, 1) as (f, axs):
@@ -150,7 +162,7 @@ def test_set_map_layout_two_axes_vert():
         set_map_layout(ax, 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 30))
+        np.testing.assert_allclose((width, height), (10, 30), rtol=get_rtol(f))
 
 
 def test_set_map_layout_two_axes_horz():
@@ -165,7 +177,7 @@ def test_set_map_layout_two_axes_horz():
         set_map_layout(ax, 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 5))
+        np.testing.assert_allclose((width, height), (10, 5), rtol=get_rtol(f))
 
     # width:height = 1:1
     with subplots_context(1, 2) as (f, axs):
@@ -178,7 +190,7 @@ def test_set_map_layout_two_axes_horz():
         set_map_layout(ax, 10)
 
         width, height = f.get_size_inches() * 2.54
-        assert np.allclose((width, height), (10, 10 / 3))
+        np.testing.assert_allclose((width, height), (10, 10 / 3), rtol=get_rtol(f))
 
 
 def test_set_map_layout_nrow_ncol_only_one_raises():
@@ -201,4 +213,23 @@ def test_set_map_layout_cartopy_2_2():
         result = f.get_size_inches() * 2.54
         expected = (17, 8.5)
 
-        np.testing.assert_allclose(result, expected)
+        np.testing.assert_allclose(result, expected, rtol=get_rtol(f))
+
+
+@pytest.mark.skipif(plt.get_backend().lower() != "macosx", reason="only for macosx")
+@pytest.mark.parametrize("dpi", (100, 1000))
+@pytest.mark.parametrize("size", ([17, 6], [10, 5]))
+def test_set_size_inches_macosx(dpi, size):
+
+    with figure_context() as f:
+
+        f.set_dpi(dpi)
+
+        size = np.array(size)
+
+        f.set_size_inches(size / 2.54)
+
+        result = f.get_size_inches() * 2.54
+
+        expected_size = np.floor(size / 2.54 * dpi) / dpi * 2.54
+        np.testing.assert_allclose(result, expected_size)
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,3 +8,11 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools_scm]
 fallback_version = "999"
 version_scheme = "no-guess-dev"
+
+[tool.pytest.ini_options]
+
+log_cli_level = "INFO"
+
+filterwarnings = [
+    "ignore:numpy.ufunc size changed, may indicate binary incompatibility.:RuntimeWarning"
+]
diff --git a/pytest.ini b/pytest.ini
diff --git a/setup.cfg b/setup.cfg
@@ -30,10 +30,6 @@ install_requires =
     numpy >=1.22
     xarray >=2022.12
 
-[tool:pytest]
-filterwarnings =
-    ignore:numpy.ufunc size changed, may indicate binary incompatibility.:RuntimeWarning
-
 [flake8]
 ignore=
     # E203: whitespace before ':' - doesn't work well with black
