Merge pull request #5150 from wiredfool/valgrind_tests

Support for ignoring tests when running valgrind

Tests/conftest.py

@@ -1,4 +1,7 @@
 import io
+import warnings
+
+import pytest
 
 
 def pytest_report_header(config):
@@ -10,3 +13,19 @@ def pytest_report_header(config):
             return out.getvalue()
     except Exception as e:
         return f"pytest_report_header failed: {e}"
+
+
+def pytest_configure(config):
+    # We're marking some tests to ignore valgrind errors and XFAIL them.
+    # Ensure that the mark is defined
+    # even in cases where pytest-valgrind isn't installed
+
+    with warnings.catch_warnings():
+        warnings.simplefilter("error")
+        try:
+            getattr(pytest.mark, "valgrind_known_error")
+        except Exception:
+            config.addinivalue_line(
+                "markers",
+                "valgrind_known_error: Tests that have known issues with valgrind",
+            )

Tests/test_file_eps.py

@@ -59,6 +59,7 @@ def test_invalid_file():
         EpsImagePlugin.EpsImageFile(invalid_file)
 
 
+@pytest.mark.valgrind_known_error(reason="Known Failing")
 @pytest.mark.skipif(not HAS_GHOSTSCRIPT, reason="Ghostscript not available")
 def test_cmyk():
     with Image.open("Tests/images/pil_sample_cmyk.eps") as cmyk_image:

Tests/test_file_jpeg.py

@@ -114,6 +114,7 @@ class TestFileJpeg:
         assert test(100, 200) == (100, 200)
         assert test(0) is None  # square pixels
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     def test_icc(self, tmp_path):
         # Test ICC support
         with Image.open("Tests/images/rgb.jpg") as im1:
@@ -153,6 +154,7 @@ class TestFileJpeg:
         test(ImageFile.MAXBLOCK + 1)  # full buffer block plus one byte
         test(ImageFile.MAXBLOCK * 4 + 3)  # large block
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     def test_large_icc_meta(self, tmp_path):
         # https://github.com/python-pillow/Pillow/issues/148
         # Sometimes the meta data on the icc_profile block is bigger than
@@ -419,6 +421,7 @@ class TestFileJpeg:
         with Image.open(filename):
             pass
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     def test_truncated_jpeg_should_read_all_the_data(self):
         filename = "Tests/images/truncated_jpeg.jpg"
         ImageFile.LOAD_TRUNCATED_IMAGES = True
@@ -437,6 +440,7 @@ class TestFileJpeg:
             with pytest.raises(OSError):
                 im.load()
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     def test_qtables(self, tmp_path):
         def _n_qtables_helper(n, test_file):
             with Image.open(test_file) as im:
@@ -720,6 +724,7 @@ class TestFileJpeg:
             # OSError for unidentified image.
             assert im.info.get("dpi") == (72, 72)
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     def test_exif_x_resolution(self, tmp_path):
         with Image.open("Tests/images/flower.jpg") as im:
             exif = im.getexif()
@@ -750,6 +755,7 @@ class TestFileJpeg:
             # Act / Assert
             assert im._getexif()[306] == "2017:03:13 23:03:09"
 
+    @pytest.mark.valgrind_known_error(reason="Backtrace in Python Core")
     def test_photoshop(self):
         with Image.open("Tests/images/photoshop-200dpi.jpg") as im:
             assert im.info["photoshop"][0x03ED] == {

Tests/test_file_libtiff.py

@@ -185,6 +185,7 @@ class TestFileLibTiff(LibTiffTestCase):
             for field in requested_fields:
                 assert field in reloaded, f"{field} not in metadata"
 
+    @pytest.mark.valgrind_known_error(reason="Known invalid metadata")
     def test_additional_metadata(self, tmp_path):
         # these should not crash. Seriously dummy data, most of it doesn't make
         # any sense, so we're running up against limits where we're asking
@@ -814,12 +815,14 @@ class TestFileLibTiff(LibTiffTestCase):
         with Image.open(infile) as im:
             assert_image_similar_tofile(im, "Tests/images/pil_sample_cmyk.jpg", 0.5)
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     @pytest.mark.xfail(is_big_endian(), reason="Fails on big-endian")
     def test_strip_ycbcr_jpeg_2x2_sampling(self):
         infile = "Tests/images/tiff_strip_ycbcr_jpeg_2x2_sampling.tif"
         with Image.open(infile) as im:
             assert_image_similar_tofile(im, "Tests/images/flower.jpg", 0.5)
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     @pytest.mark.xfail(is_big_endian(), reason="Fails on big-endian")
     def test_strip_ycbcr_jpeg_1x1_sampling(self):
         infile = "Tests/images/tiff_strip_ycbcr_jpeg_1x1_sampling.tif"
@@ -831,12 +834,14 @@ class TestFileLibTiff(LibTiffTestCase):
         with Image.open(infile) as im:
             assert_image_similar_tofile(im, "Tests/images/pil_sample_cmyk.jpg", 0.5)
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     @pytest.mark.xfail(is_big_endian(), reason="Fails on big-endian")
     def test_tiled_ycbcr_jpeg_1x1_sampling(self):
         infile = "Tests/images/tiff_tiled_ycbcr_jpeg_1x1_sampling.tif"
         with Image.open(infile) as im:
             assert_image_equal_tofile(im, "Tests/images/flower2.jpg")
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     @pytest.mark.xfail(is_big_endian(), reason="Fails on big-endian")
     def test_tiled_ycbcr_jpeg_2x2_sampling(self):
         infile = "Tests/images/tiff_tiled_ycbcr_jpeg_2x2_sampling.tif"
@@ -864,6 +869,7 @@ class TestFileLibTiff(LibTiffTestCase):
 
                     assert_image_similar(base_im, im, 0.7)
 
+    @pytest.mark.valgrind_known_error(reason="Backtrace in Python Core")
     def test_sampleformat_not_corrupted(self):
         # Assert that a TIFF image with SampleFormat=UINT tag is not corrupted
         # when saving to a new file.

Tests/test_file_pdf.py

@@ -85,6 +85,7 @@ def test_unsupported_mode(tmp_path):
         im.save(outfile)
 
 
+@pytest.mark.valgrind_known_error(reason="Known Failing")
 def test_save_all(tmp_path):
     # Single frame image
     helper_save_as_pdf(tmp_path, "RGB", save_all=True)

Tests/test_file_png.py

@@ -654,6 +654,7 @@ class TestFilePng:
             exif = reloaded._getexif()
         assert exif[274] == 1
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     def test_exif_from_jpg(self, tmp_path):
         with Image.open("Tests/images/pil_sample_rgb.jpg") as im:
             test_file = str(tmp_path / "temp.png")

Tests/test_file_webp_metadata.py

@@ -1,5 +1,7 @@
 from io import BytesIO
 
+import pytest
+
 from PIL import Image
 
 from .helper import skip_unless_feature
@@ -39,6 +41,7 @@ def test_read_exif_metadata_without_prefix():
         assert exif[305] == "Adobe Photoshop CS6 (Macintosh)"
 
 
+@pytest.mark.valgrind_known_error(reason="Known Failing")
 def test_write_exif_metadata():
     file_path = "Tests/images/flower.jpg"
     test_buffer = BytesIO()
@@ -71,6 +74,7 @@ def test_read_icc_profile():
             assert icc == expected_icc
 
 
+@pytest.mark.valgrind_known_error(reason="Known Failing")
 def test_write_icc_metadata():
     file_path = "Tests/images/flower2.jpg"
     test_buffer = BytesIO()
@@ -88,6 +92,7 @@ def test_write_icc_metadata():
         assert webp_icc_profile == expected_icc_profile, "Webp ICC didn't match"
 
 
+@pytest.mark.valgrind_known_error(reason="Known Failing")
 def test_read_no_exif():
     file_path = "Tests/images/flower.jpg"
     test_buffer = BytesIO()

Tests/test_image.py

@@ -652,6 +652,7 @@ class TestImage:
 
             assert not fp.closed
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     def test_exif_jpeg(self, tmp_path):
         with Image.open("Tests/images/exif-72dpi-int.jpg") as im:  # Little endian
             exif = im.getexif()

Tests/test_image_resample.py

@@ -455,6 +455,7 @@ class TestCoreResampleBox:
                 tiled.paste(tile, (x0, y0))
         return tiled
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     def test_tiles(self):
         with Image.open("Tests/images/flower.jpg") as im:
             assert im.size == (480, 360)
@@ -465,6 +466,7 @@ class TestCoreResampleBox:
                 tiled = self.resize_tiled(im, dst_size, *tiles)
                 assert_image_similar(reference, tiled, 0.01)
 
+    @pytest.mark.valgrind_known_error(reason="Known Failing")
     def test_subsample(self):
         # This test shows advantages of the subpixel resizing
         # after supersampling (e.g. during JPEG decoding).

Tests/test_image_thumbnail.py

@@ -88,6 +88,7 @@ def test_no_resize():
         assert im.size == (64, 64)
 
 
+@pytest.mark.valgrind_known_error(reason="Known Failing")
 def test_DCT_scaling_edges():
     # Make an image with red borders and size (N * 8) + 1 to cross DCT grid
     im = Image.new("RGB", (257, 257), "red")