Replace figure infra (#216)

Author: nabobalis

.circleci/codecov_upload.sh

@@ -0,0 +1,9 @@
+#!/bin/bash -e
+curl https://keybase.io/codecovsecurity/pgp_keys.asc | gpg --no-default-keyring --keyring trustedkeys.gpg --import
+curl -Os https://uploader.codecov.io/latest/linux/codecov
+curl -Os https://uploader.codecov.io/latest/linux/codecov.SHA256SUM
+curl -Os https://uploader.codecov.io/latest/linux/codecov.SHA256SUM.sig
+gpgv codecov.SHA256SUM.sig codecov.SHA256SUM
+shasum -a 256 -c codecov.SHA256SUM
+chmod +x codecov
+./codecov "$@"

.circleci/config.yml

@@ -0,0 +1,118 @@
+version: 2.1
+
+no-backports: &no-backports
+  name: Skip any branches called cherry-pick
+  command: |
+    if [[ "${CIRCLE_BRANCH}" == *"cherry-pick"* || "${CIRCLE_BRANCH}" == *"backport"* ]]; then
+      circleci step halt
+    fi
+
+skip-check: &skip-check
+  name: Check for [ci skip]
+  command: bash .circleci/early_exit.sh
+
+merge-check: &merge-check
+  name: Check if we need to merge upstream main
+  command: |
+    if [[ -n "${CIRCLE_PR_NUMBER}" ]]; then
+      git fetch origin --tags
+      git fetch origin +refs/pull/$CIRCLE_PR_NUMBER/merge:pr/$CIRCLE_PR_NUMBER/merge
+      git checkout -qf pr/$CIRCLE_PR_NUMBER/merge
+    fi
+
+apt-run: &apt-install
+  name: Install apt packages
+  command: |
+    sudo apt update
+    sudo apt install -y xvfb libglfw3-dev libgles2-mesa-dev libegl1-mesa-dev mesa-utils
+
+jobs:
+  figure:
+    parameters:
+      jobname:
+        type: string
+    docker:
+      - image: cimg/python:3.13
+    environment:
+      TOXENV=<< parameters.jobname >>
+    steps:
+      - run: *no-backports
+      - checkout
+      - run: *skip-check
+      - run: *merge-check
+      - run: *apt-install
+      - run: pip install --user -U tox tox-pypi-filter
+      - run:
+          name: Running X virtual framebuffer
+          command: Xvfb :99 -screen 0 1280x1024x24
+          background: true
+      - run: xvfb-run -a tox -v
+      - run:
+          name: Running codecov
+          command: bash -e .circleci/codecov_upload.sh -f ".tmp/${TOXENV}/coverage.xml"
+      - store_artifacts:
+          path: .tmp/<< parameters.jobname >>/figure_test_images
+      - run:
+          name: "Image comparison page is available at: "
+          command: echo "${CIRCLE_BUILD_URL}/artifacts/${CIRCLE_NODE_INDEX}/.tmp/${TOXENV}/figure_test_images/fig_comparison.html"
+
+  deploy-reference-images:
+    parameters:
+      jobname:
+        type: string
+    docker:
+      - image: cimg/python:3.13
+    environment:
+      TOXENV: << parameters.jobname >>
+      GIT_SSH_COMMAND: ssh -i ~/.ssh/id_rsa_7b8fc81c13a3b446ec9aa50d3f626978
+    steps:
+      - checkout
+      - run: *skip-check
+      - run: *merge-check
+      - run: *apt-install
+      # Clear out all the ssh keys so that it always uses the write deploy key
+      - run: ssh-add -D
+      # Add private key for deploying to the figure tests repo
+      - add_ssh_keys:
+          fingerprints: "7b:8f:c8:1c:13:a3:b4:46:ec:9a:a5:0d:3f:62:69:78"
+      - run: ssh-keyscan github.com >> ~/.ssh/known_hosts
+      - run: git config --global user.email "sunpy@circleci" && git config --global user.name "SunPy Circle CI"
+      - run: git clone git@github.com:sunpy/sunpy-figure-tests.git --depth 1 -b sunkit-pyvista-${CIRCLE_BRANCH} ~/sunpy-figure-tests/
+      # Generate Reference images
+      - run: pip install --user -U tox tox-pypi-filter
+      - run: rm -rf /home/circleci/sunpy-figure-tests/figures/$TOXENV/*
+      - run: tox -v -- --mpl-generate-path=/home/circleci/sunpy-figure-tests/figures/$TOXENV | tee toxlog
+      - run: |
+          hashlib=$(grep "^figure_hashes.*\.json$" toxlog)
+          cp ./sunpy/tests/$hashlib /home/circleci/sunpy-figure-tests/figures/$TOXENV/
+      - run: |
+          cd ~/sunpy-figure-tests/
+          git pull
+          git status
+          git add .
+          git commit -m "Update reference figures from ${CIRCLE_BRANCH}" || echo "No changes to reference images to deploy"
+          git push
+
+workflows:
+
+  figure-tests:
+    jobs:
+      - figure:
+          name: << matrix.jobname >>
+          matrix:
+            parameters:
+              jobname:
+                - "py313-figure"
+
+      - deploy-reference-images:
+          name: baseline-<< matrix.jobname >>
+          matrix:
+            parameters:
+              jobname:
+                - "py313-figure"
+          requires:
+            - << matrix.jobname >>
+          filters:
+            branches:
+              only:
+                - main

.circleci/early_exit.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+commitmessage=$(git log --pretty=%B -n 1)
+if [[ $commitmessage = *"[ci skip]"* ]] || [[ $commitmessage = *"[skip ci]"* ]]; then
+    echo "Skipping build because [ci skip] found in commit message"
+    circleci step halt
+fi

.github/workflows/ci.yml

@@ -71,9 +71,8 @@ jobs:
           - libglfw3-dev
           - libgles2-mesa-dev
       envs: |
-        - linux: py314
-        - windows: py312
-        - macos: py312
+        - windows: py313
+        - macos: py313
         - linux: py312-oldestdeps
         - linux: py314-devdeps
     secrets:

conftest.py

@@ -38,6 +38,7 @@ all = ["sunkit_pyvista"]
 tests = [
   "pytest",
   "pytest-astropy",
+  "pytest-mpl",
   "scikit-image",
   "sunkit-magex>=1.1.0",
   "sunkit_pyvista[all]",
@@ -74,6 +75,19 @@ exclude = ["sunkit_pyvista._dev*"]
 version_file = "sunkit_pyvista/_version.py"
 
 [tool.gilesbot]
+  [tool.gilesbot.circleci_artifacts]
+  enabled = true
+
+  [tool.gilesbot.circleci_artifacts.figure_report]
+  url = ".tmp/py312-figure/figure_test_images/fig_comparison.html"
+  message = "Click details to see the figure test comparisons, for py312-figure."
+  report_on_fail = true
+
+  [tool.gilesbot.circleci_artifacts.figure_report_devdeps]
+  url = ".tmp/py312-figure-devdeps/figure_test_images/fig_comparison.html"
+  message = "Click details to see the figure test comparisons for py312-figure-devdeps."
+  report_on_fail = true
+
   [tool.gilesbot.pull_requests]
   enabled = true
 

pyproject.toml

@@ -24,7 +24,11 @@ addopts =
     --doctest-ignore-import-errors
     -p no:unraisableexception
     -p no:threadexception
+    -m "not mpl_image_compare"
+mpl-results-path = figure_test_images
+mpl-use-full-test-name = true
 markers =
+    mpl_image_compare: marks this test function as using hash-based Matplotlib figure verification. This mark is not meant to be directly applied, but is instead automatically applied when a test function uses the @sunkit_pyvista.tests.helpers.figure_test decorator.
     display_server: marks this test function as needing a display server.
 filterwarnings =
     # Turn all warnings into errors so they do not pass silently.

pytest.ini

@@ -20,10 +20,32 @@
 
 from sunkit_pyvista.utils import get_limb_coordinates
 
-__all__ = ["SunpyPlotter", "CartesianPlotter"]
+__all__ = ["SaveMixIn", "SunpyPlotter", "CartesianPlotter"]
 
 
-class SunpyPlotter(pv.Plotter):
+class SaveMixIn:
+    """
+    A mixin class to add savefig used for pytest-mpl figure comparison testing.
+    """
+
+    def savefig(self, filename, **kwargs):
+        """
+        Save a screenshot of the current figure.
+
+        This is a wrapper around `pyvista.Plotter.screenshot` and was written
+        so we use pytest-mpl's figure comparison testing.
+
+        Parameters
+        ----------
+        filename : str
+            The name of the file to save the screenshot to.
+        kwargs : dict
+            Keyword arguments are ignored.
+        """
+        self.screenshot(filename)
+
+
+class SunpyPlotter(SaveMixIn, pv.Plotter):
     """
     A plotter for 3D data.
 
@@ -614,7 +636,7 @@ def plot_limb(self, m, *, radius=0.02, **kwargs):
         self._add_mesh_to_dict(block_name="limbs", mesh=limb_block)
 
 
-class CartesianPlotter(pv.Plotter):
+class CartesianPlotter(SaveMixIn, pv.Plotter):
     """
     A plotter for 3D data in a Cartesian box.
 

sunkit_pyvista/plotter.py

@@ -1,10 +1,22 @@
+import logging
+
 import pytest
+import pyvista
+import pyvista as pv
 
 import sunpy.data.test as test
 import sunpy.map as smap
 
 from sunkit_pyvista import CartesianPlotter, SunpyPlotter
 
+pv.OFF_SCREEN = True
+
+try:
+    pyvista.start_xvfb()
+except Exception as e:  # NOQA: BLE001
+    msg = f"Could not start xvfb server:\n{e}"
+    logging.info(msg)
+
 
 @pytest.fixture()
 def aia171_test_map():

sunkit_pyvista/tests/conftest.py

@@ -0,0 +1,7 @@
+{
+  "sunkit_pyvista.tests.test_magex.test_field_lines_figure": "b988779ed9e44ab423cfa14406b8cc1bf97b66baa0518e1d6ab7046ecf01a20d",
+  "sunkit_pyvista.tests.test_magex.test_field_lines_and_color_func": "f9ef4edf7dbc0fa549426aa2546dcbacb3787431ee7d90bd74991c0f9b92e4c0",
+  "sunkit_pyvista.tests.test_magex.test_current_sheet_figure": "45a9baad2b4dc2388795519561ad50d7aca64a4043a1e9b46b3f5fb673d5c018",
+  "sunkit_pyvista.tests.test_plotting.test_plot_map_with_functionality": "c4e366bb35e1563d26b3447f5312e5c5bad46d63160d0412306f86b9d1ceef85",
+  "sunkit_pyvista.tests.test_plotting.test_cartesian_plotter": "c2cd087ffeab32e0977795bf4295c03eb16dd3a4d92726718d56fbf9e40c9209"
+}