Add tests for new raster_equal options

geoutils/raster/raster.py

@@ -978,7 +978,7 @@ def raster_equal(self, other: RasterType, strict_masked: bool = True, warn_failu
         - The raster's transform, crs and nodata values.
 
         :param other: Other raster.
-        :param strict_masked: Whether to check if masked pixels (in .data.mask) have the same value (in .data.data).
+        :param strict_masked: Whether to check if masked cells (in .data.mask) have the same value (in .data.data).
         :param warn_failure_reason: Whether to warn for the reason of failure if the check does not pass.
         """
 

tests/test_raster.py

@@ -3465,6 +3465,21 @@ def test_raster_equal(self) -> None:
         r2.set_nodata(34)
         assert not r1.raster_equal(r2)
 
+        # Change value of a masked cell
+        r1.data[0, 0] = np.ma.masked
+        r1.data.data[0, 0] = 0
+        r2 = r1.copy()
+        r2.data.data[0, 0] = 10
+        assert not r1.raster_equal(r2)
+        assert r1.raster_equal(r2, strict_masked=False)
+
+        # Check that a warning is raised with useful information without equality
+        with pytest.warns(UserWarning, match="Equality failed for: data.data."):
+            assert not r1.raster_equal(r2, warn_failure_reason=True)
+
+        # But no warning is raised for an equality
+        assert r1.raster_equal(r2, strict_masked=False, warn_failure_reason=True)
+
     def test_equal_georeferenced_grid(self) -> None:
         """
         Test that equal for shape, crs and transform work as expected