add petsc_raises to tests (#4443)

* add `petsc_raises` to tests

* Increase permissiveness of petsc_raises

Previously issues were encountered if the garbage collection routines
threw an error. This should stop being an issue when the original error
stops getting destroyed too early (should be fixed in later Python
versions).

---------

Co-authored-by: Connor Ward <c.ward20@imperial.ac.uk>

Author: leo-collins

tests/firedrake/conftest.py

@@ -205,12 +205,12 @@ def __enter__(self):
         pass
 
     def __exit__(self, exc_type, exc_val, traceback):
-        # There is a bug where 'exc_val' is occasionally 'None'. In my tests
-        # this error only exists for Python < 3.12.11.
+        # There is a bug where 'exc_val' is occasionally the wrong thing,
+        # either 'None' or some unrelated garbage collection error. In my
+        # tests this error only exists for Python < 3.12.11.
         if exc_type is PETSc.Error:
             if sys.version_info < (3, 12, 11):
-                if exc_val is None or isinstance(exc_val.__cause__, self.exc_type):
-                    return True
+                return True
             else:
                 if isinstance(exc_val.__cause__, self.exc_type):
                     return True

tests/firedrake/vertexonly/test_vertex_only_fs.py

@@ -68,7 +68,7 @@ def pseudo_random_coords(size):
 
 # Function Space Generation Tests
 
-def functionspace_tests(vm):
+def functionspace_tests(vm, petsc_raises):
     # Prep
     num_cells = len(vm.coordinates.dat.data_ro)
     num_cells_mpi_global = MPI.COMM_WORLD.allreduce(num_cells, op=MPI.SUM)
@@ -153,34 +153,28 @@ def functionspace_tests(vm):
     h_star = h.riesz_representation(riesz_map="l2")
     g = assemble(I_io.interpolate(h_star, adjoint=True))
     assert np.allclose(g.dat.data_ro_with_halos, np.prod(vm.coordinates.dat.data_ro_with_halos.reshape(-1, vm.geometric_dimension()), axis=1))
-    with pytest.raises(NotImplementedError):
+    with petsc_raises(NotImplementedError):
         # Can't use adjoint on interpolators with expressions yet
-        try:
-            g2 = assemble(I2_io.interpolate(h_star, adjoint=True))
-            assert np.allclose(g2.dat.data_ro_with_halos, 2*np.prod(vm.coordinates.dat.data_ro_with_halos.reshape(-1, vm.geometric_dimension()), axis=1))
-        except PETSc.Error as e:
-            raise e.__cause__ from None
+        g2 = assemble(I2_io.interpolate(h_star, adjoint=True))
+        assert np.allclose(g2.dat.data_ro_with_halos, 2*np.prod(vm.coordinates.dat.data_ro_with_halos.reshape(-1, vm.geometric_dimension()), axis=1))
 
     I_io_adjoint = Interpolator(TestFunction(W), V)
     I2_io_adjoint = Interpolator(2*TestFunction(W), V)
     h_star = assemble(I_io_adjoint.interpolate(g, adjoint=True))
     h = h_star.riesz_representation(riesz_map="l2")
     assert np.allclose(h.dat.data_ro_with_halos[idxs_to_include], np.prod(vm.input_ordering.coordinates.dat.data_ro_with_halos[idxs_to_include].reshape(-1, vm.input_ordering.geometric_dimension()), axis=1))
     assert np.all(h.dat.data_ro_with_halos[~idxs_to_include] == 0)
-    with pytest.raises(NotImplementedError):
+    with petsc_raises(NotImplementedError):
         # Can't use adjoint on interpolators with expressions yet
-        try:
-            h2 = assemble(I2_io_adjoint.interpolate(g, adjoint=True))
-            assert np.allclose(h2.dat.data_ro_with_halos[idxs_to_include], 2*np.prod(vm.input_ordering.coordinates.dat.data_ro_with_halos[idxs_to_include].reshape(-1, vm.input_ordering.geometric_dimension()), axis=1))
-        except PETSc.Error as e:
-            raise e.__cause__ from None
+        h2 = assemble(I2_io_adjoint.interpolate(g, adjoint=True))
+        assert np.allclose(h2.dat.data_ro_with_halos[idxs_to_include], 2*np.prod(vm.input_ordering.coordinates.dat.data_ro_with_halos[idxs_to_include].reshape(-1, vm.input_ordering.geometric_dimension()), axis=1))
     g = assemble(I_io_adjoint.interpolate(h))
     assert np.allclose(g.dat.data_ro_with_halos, np.prod(vm.coordinates.dat.data_ro_with_halos.reshape(-1, vm.geometric_dimension()), axis=1))
     g2 = assemble(I2_io_adjoint.interpolate(h))
     assert np.allclose(g2.dat.data_ro_with_halos, 2*np.prod(vm.coordinates.dat.data_ro_with_halos.reshape(-1, vm.geometric_dimension()), axis=1))
 
 
-def vectorfunctionspace_tests(vm):
+def vectorfunctionspace_tests(vm, petsc_raises):
     # Prep
     gdim = vm.geometric_dimension()
     num_cells = len(vm.coordinates.dat.data_ro)
@@ -263,26 +257,20 @@ def vectorfunctionspace_tests(vm):
     h_star = h.riesz_representation(riesz_map="l2")
     g = assemble(I_io.interpolate(h_star, adjoint=True))
     assert np.allclose(g.dat.data_ro_with_halos, 2*vm.coordinates.dat.data_ro_with_halos)
-    with pytest.raises(NotImplementedError):
+    with petsc_raises(NotImplementedError):
         # Can't use adjoint on interpolators with expressions yet
-        try:
-            g2 = assemble(I2_io.interpolate(h_star, adjoint=True))
-            assert np.allclose(g2.dat.data_ro_with_halos, 4*vm.coordinates.dat.data_ro_with_halos)
-        except PETSc.Error as e:
-            raise e.__cause__ from None
+        g2 = assemble(I2_io.interpolate(h_star, adjoint=True))
+        assert np.allclose(g2.dat.data_ro_with_halos, 4*vm.coordinates.dat.data_ro_with_halos)
 
     I_io_adjoint = Interpolator(TestFunction(W), V)
     I2_io_adjoint = Interpolator(2*TestFunction(W), V)
     h_star = assemble(I_io_adjoint.interpolate(g, adjoint=True))
     assert np.allclose(h_star.dat.data_ro[idxs_to_include], 2*vm.input_ordering.coordinates.dat.data_ro_with_halos[idxs_to_include])
     assert np.all(h_star.dat.data_ro_with_halos[~idxs_to_include] == 0)
-    with pytest.raises(NotImplementedError):
-        try:
-            # Can't use adjoint on interpolators with expressions yet
-            h2 = assemble(I2_io_adjoint.interpolate(g, adjoint=True))
-            assert np.allclose(h2.dat.data_ro[idxs_to_include], 4*vm.input_ordering.coordinates.dat.data_ro_with_halos[idxs_to_include])
-        except PETSc.Error as e:
-            raise e.__cause__ from None
+    with petsc_raises(NotImplementedError):
+        # Can't use adjoint on interpolators with expressions yet
+        h2 = assemble(I2_io_adjoint.interpolate(g, adjoint=True))
+        assert np.allclose(h2.dat.data_ro[idxs_to_include], 4*vm.input_ordering.coordinates.dat.data_ro_with_halos[idxs_to_include])
 
     h = h_star.riesz_representation(riesz_map="l2")
     g = assemble(I_io_adjoint.interpolate(h))
@@ -292,12 +280,12 @@ def vectorfunctionspace_tests(vm):
 
 
 @pytest.mark.parallel([1, 3])
-def test_functionspaces(parentmesh, vertexcoords):
+def test_functionspaces(parentmesh, vertexcoords, petsc_raises):
     vm = VertexOnlyMesh(parentmesh, vertexcoords, missing_points_behaviour=None)
-    functionspace_tests(vm)
-    vectorfunctionspace_tests(vm)
-    functionspace_tests(vm.input_ordering)
-    vectorfunctionspace_tests(vm.input_ordering)
+    functionspace_tests(vm, petsc_raises)
+    vectorfunctionspace_tests(vm, petsc_raises)
+    functionspace_tests(vm.input_ordering, petsc_raises)
+    vectorfunctionspace_tests(vm.input_ordering, petsc_raises)
 
 
 @pytest.mark.parallel(nprocs=2)