test coverage

src/geovista/geoplotter.py

@@ -1039,6 +1039,21 @@ def add_points(
         .. versionadded:: 0.4.0
 
         """
+        if crs is not None:
+            # sanity check the source crs
+            crs = CRS.from_user_input(crs)
+
+        if style is None:
+            style = "points"
+
+        if style not in ADD_POINTS_STYLE:
+            options = "or ".join(f"{option!r}" for option in ADD_POINTS_STYLE)
+            emsg = (
+                f"Invalid 'style' for 'add_points', expected {options}, "
+                f"got {style!r}."
+            )
+            raise ValueError(emsg)
+
         if points is None and xs is None and ys is None:
             emsg = (
                 "Require either 'points' or both 'xs' and 'ys' to be specified, "
@@ -1057,7 +1072,7 @@ def add_points(
             if xs is not None or ys is not None:
                 emsg = (
                     "Require either 'points' or both 'xs' and 'ys' to be specified, "
-                    "got both 'points', and 'xs' and/or 'ys'."
+                    "got both 'points', and 'xs' or 'ys'."
                 )
                 raise ValueError(emsg)
 
@@ -1071,8 +1086,8 @@ def add_points(
                     other = from_wkt(mesh)
                     if other != crs:
                         emsg = (
-                            "The CRS serialized as WKT on the 'points' mesh does match "
-                            "the provided 'crs'."
+                            "The CRS serialized as WKT on the 'points' mesh does not "
+                            "match the provided 'crs'."
                         )
                         raise ValueError(emsg)
                 else:
@@ -1105,17 +1120,7 @@ def add_points(
                 zscale=zscale,
             )
 
-        if style is None:
-            style = "points"
-
-        if style not in ADD_POINTS_STYLE:
-            options = "or ".join(f"{option!r}" for option in ADD_POINTS_STYLE)
-            emsg = (
-                f"Invalid 'style' for 'add_points', expected {options}, "
-                f"got {style!r}."
-            )
-            raise ValueError(emsg)
-
+        # defensive kwarg pop
         if "texture" in kwargs:
             _ = kwargs.pop("texture")
 

tests/geoplotter/test_add_points.py

@@ -0,0 +1,150 @@
+"""Unit-tests for :meth:`geovista.geoplotter.GeoPlotter.add_points`."""
+from __future__ import annotations
+
+from pyproj import CRS
+from pyproj.exceptions import CRSError
+import pytest
+
+from geovista.crs import WGS84, from_wkt, has_wkt, to_wkt
+from geovista.geoplotter import GeoPlotter
+
+
+def test_style_fail():
+    """Test trap of invalid style request."""
+    plotter = GeoPlotter()
+    emsg = "Invalid 'style' for 'add_points'"
+    with pytest.raises(ValueError, match=emsg):
+        _ = plotter.add_points(style="dolce and gabbana")
+
+
+def test_no_points_fail():
+    """Test trap of no spatial points provided."""
+    plotter = GeoPlotter()
+    emsg = "got neither"
+    with pytest.raises(ValueError, match=emsg):
+        _ = plotter.add_points()
+
+
+def test_duplicate_points_fail(mocker):
+    """Test trap of duplicate spatial points provided."""
+    plotter = GeoPlotter()
+    points, xs, ys = mocker.sentinel.points, mocker.sentinel.xs, mocker.sentinel.ys
+    emsg = "got both 'points', and 'xs' and 'ys'"
+    with pytest.raises(ValueError, match=emsg):
+        _ = plotter.add_points(points=points, xs=xs, ys=ys)
+
+
+@pytest.mark.parametrize("xs, ys", [(True, None), (None, True)])
+def test_over_specified_points_fail(mocker, xs, ys):
+    """Test trap of points and xs or ys provided."""
+    plotter = GeoPlotter()
+    points = mocker.sentinel.points
+    emsg = "got both 'points', and 'xs' or 'ys'"
+    with pytest.raises(ValueError, match=emsg):
+        _ = plotter.add_points(points=points, xs=xs, ys=ys)
+
+
+def test_points_mesh_crs_fail(sphere):
+    """Test trap of crs mismatch with points mesh serialized crs as wkt."""
+    plotter = GeoPlotter()
+    emsg = "The CRS serialized as WKT on the 'points' mesh does not match"
+    to_wkt(sphere, WGS84)
+    with pytest.raises(ValueError, match=emsg):
+        _ = plotter.add_points(points=sphere, crs="+proj=eqc")
+
+
+@pytest.mark.parametrize("crs", [None, CRS.from_user_input("+proj=eqc")])
+def test_points_mesh_with_no_crs(mocker, sphere, crs):
+    """Test points mesh with no serialized crs."""
+    assert not has_wkt(sphere)
+    plotter = GeoPlotter()
+    actor = mocker.sentinel.actor
+    _ = mocker.patch("geovista.geoplotter.GeoPlotterBase.add_mesh", return_value=actor)
+    _ = plotter.add_points(sphere, crs=crs)
+    plotter.add_mesh.assert_called_once_with(sphere, style="points", scalars=None)
+    assert has_wkt(sphere)
+    expected = WGS84 if crs is None else crs
+    assert from_wkt(sphere) == expected
+
+
+def test_crs_invalid_fail():
+    """Test trap of crs validity sanity check."""
+    plotter = GeoPlotter()
+    emsg = "Invalid projection"
+    with pytest.raises(CRSError, match=emsg):
+        _ = plotter.add_points(crs="invalid")
+
+
+def test_points_mesh_with_scalars(mocker, sphere):
+    """Test points mesh with scalars pass-through."""
+    plotter = GeoPlotter()
+    _ = mocker.patch("geovista.geoplotter.GeoPlotterBase.add_mesh")
+    scalars = mocker.sentinel.scalars
+    _ = plotter.add_points(sphere, scalars=scalars)
+    plotter.add_mesh.assert_called_once_with(sphere, style="points", scalars=scalars)
+
+
+def test_texture_kwarg_pop(mocker, sphere):
+    """Test defensive texture kwarg purge."""
+    plotter = GeoPlotter()
+    _ = mocker.patch("geovista.geoplotter.GeoPlotterBase.add_mesh")
+    texture = mocker.sentinel.texture
+    _ = plotter.add_points(sphere, texture=texture)
+    plotter.add_mesh.assert_called_once_with(sphere, style="points", scalars=None)
+
+
+@pytest.mark.parametrize("xs, ys", [(None, True), (True, None)])
+def test_xs_ys_incomplete_fail(xs, ys):
+    """Test trap of missing spatial points."""
+    plotter = GeoPlotter()
+    emsg = "got only 'xs' or 'ys'"
+    with pytest.raises(ValueError, match=emsg):
+        _ = plotter.add_points(xs=xs, ys=ys)
+
+
+def test_xs_ys(mocker):
+    """Test xs/ys points."""
+    plotter = GeoPlotter()
+    mesh = mocker.sentinel.mesh
+    _ = mocker.patch("geovista.Transform.from_points", return_value=mesh)
+    actor = mocker.sentinel.actor
+    _ = mocker.patch("geovista.geoplotter.GeoPlotterBase.add_mesh", return_value=actor)
+    xs, ys = mocker.sentinel.xs, mocker.sentinel.ys
+    crs, scalars = WGS84, mocker.sentinel.scalars
+    radius, zlevel, zscale = (
+        mocker.sentinel.radius,
+        mocker.sentinel.zlevel,
+        mocker.sentinel.zscale,
+    )
+    result = plotter.add_points(
+        xs=xs,
+        ys=ys,
+        scalars=scalars,
+        crs=crs,
+        radius=radius,
+        zlevel=zlevel,
+        zscale=zscale,
+    )
+    assert result == actor
+    from geovista.bridge import Transform
+
+    Transform.from_points.assert_called_once_with(
+        xs=xs, ys=ys, crs=crs, radius=radius, zlevel=zlevel, zscale=zscale
+    )
+    plotter.add_mesh.assert_called_once_with(mesh, style="points", scalars=scalars)
+
+
+def test_xy_ys_scalars_name_warnings(mocker):
+    """Test xy/ys points invalid scalars array name warning is raised."""
+    plotter = GeoPlotter()
+    mesh = mocker.sentinel.mesh
+    _ = mocker.patch("geovista.Transform.from_points", return_value=mesh)
+    _ = mocker.patch("geovista.geoplotter.GeoPlotterBase.add_mesh")
+    xs, ys = mocker.sentinel.xs, mocker.sentinel.ys
+    scalars = "invalid"
+    wmsg = (
+        f"Ignoring the 'scalars' string name '{scalars}', "
+        "as no 'points' mesh was provided"
+    )
+    with pytest.warns(UserWarning, match=wmsg):
+        _ = plotter.add_points(xs=xs, ys=ys, scalars=scalars)