refactor(tests): Parameterize group_cmaps tests

Author: rwbaber

tests/test_plotting.py

@@ -1823,16 +1823,92 @@ def test_violin_scale_warning(monkeypatch):
         sc.pl.StackedViolin(adata, adata.var_names[:3], groupby="louvain")
 
 
-def test_dotplot_group_cmaps(image_comparer):
+# def test_dotplot_group_cmaps(image_comparer):
+#     """Check group_cmaps parameter with custom color maps per group."""
+#     save_and_compare_images = partial(image_comparer, ROOT, tol=15)
+
+#     adata = pbmc68k_reduced()
+
+#     # Use markers with a good range of expression values to check color gradients
+#     markers = ["SERPINB1", "IGFBP7", "GNLY", "IFITM1", "IMP3", "UBALD2", "LTB", "CLPP"]
+
+#     # Define a complete set of colormaps for all groups that will be plotted
+#     group_cmaps = {
+#         "CD14+ Monocyte": "Greys",
+#         "Dendritic": "Purples",
+#         "CD8+ Cytotoxic T": "Reds",
+#         "CD8+/CD45RA+ Naive Cytotoxic": "Greens",
+#         "CD4+/CD45RA+/CD25- Naive T": "Oranges",
+#         "CD4+/CD25 T Reg": "Blues",
+#         "CD4+/CD45RO+ Memory": "hot",
+#         "CD19+ B": "cool",
+#         "CD56+ NK": "winter",
+#         "CD34+": "copper",
+#     }
+
+#     # Call dotplot with new parameter
+#     sc.pl.dotplot(
+#         adata,
+#         markers,
+#         groupby="bulk_labels",
+#         group_cmaps=group_cmaps,  # Define custom color maps for each group from 'groupby'
+#         dendrogram=True,  # Test with dendrogram reordering
+#         show=False,
+#     )
+
+#     # This will try to save the plot and compare it to a reference
+#     save_and_compare_images("dotplot_group_cmaps")
+
+
+# def test_dotplot_group_cmaps_swap_axes(image_comparer):
+#     """Check that group_cmaps works with swapped axes."""
+#     save_and_compare_images = partial(image_comparer, ROOT, tol=15)
+
+#     adata = pbmc68k_reduced()
+
+#     # Use markers with a good range of expression values to check color gradients
+#     markers = ["SERPINB1", "IGFBP7", "GNLY", "IFITM1", "IMP3", "UBALD2", "LTB", "CLPP"]
+
+#     # Define a complete set of colormaps for all groups that will be plotted
+#     group_cmaps = {
+#         "CD14+ Monocyte": "Greys",
+#         "Dendritic": "Purples",
+#         "CD8+ Cytotoxic T": "Reds",
+#         "CD8+/CD45RA+ Naive Cytotoxic": "Greens",
+#         "CD4+/CD45RA+/CD25- Naive T": "Oranges",
+#         "CD4+/CD25 T Reg": "Blues",
+#         "CD4+/CD45RO+ Memory": "hot",
+#         "CD19+ B": "cool",
+#         "CD56+ NK": "winter",
+#         "CD34+": "copper",
+#     }
+
+#     sc.pl.dotplot(
+#         adata,
+#         markers,
+#         groupby="bulk_labels",
+#         group_cmaps=group_cmaps,
+#         dendrogram=True,
+#         swap_axes=True,  # Check that group_cmaps works with swapped axes
+#         show=False,
+#     )
+#     save_and_compare_images("dotplot_group_cmaps_swap_axes")
+
+params_dotplot_group_cmaps = [
+    pytest.param("dotplot_group_cmaps", False, id="default"),
+    pytest.param("dotplot_group_cmaps_swap_axes", True, id="swap_axes"),
+]
+
+
+@pytest.mark.parametrize(("name", "swap_axes"), params_dotplot_group_cmaps)
+def test_dotplot_group_cmaps(image_comparer, name, swap_axes):
     """Check group_cmaps parameter with custom color maps per group."""
     save_and_compare_images = partial(image_comparer, ROOT, tol=15)
 
     adata = pbmc68k_reduced()
 
-    # Use markers with a good range of expression values to check color gradients
     markers = ["SERPINB1", "IGFBP7", "GNLY", "IFITM1", "IMP3", "UBALD2", "LTB", "CLPP"]
 
-    # Define a complete set of colormaps for all groups that will be plotted
     group_cmaps = {
         "CD14+ Monocyte": "Greys",
         "Dendritic": "Purples",
@@ -1846,50 +1922,26 @@ def test_dotplot_group_cmaps(image_comparer):
         "CD34+": "copper",
     }
 
-    # Call dotplot with new parameter
     sc.pl.dotplot(
         adata,
         markers,
         groupby="bulk_labels",
-        group_cmaps=group_cmaps,  # Define custom color maps for each group from 'groupby'
-        dendrogram=True,  # Test with dendrogram reordering
+        group_cmaps=group_cmaps,
+        dendrogram=True,
+        swap_axes=swap_axes,
         show=False,
     )
+    save_and_compare_images(name)
 
-    # This will try to save the plot and compare it to a reference
-    save_and_compare_images("dotplot_group_cmaps")
-
-
-def test_dotplot_group_cmaps_swap_axes(image_comparer):
-    """Check that group_cmaps works with swapped axes."""
-    save_and_compare_images = partial(image_comparer, ROOT, tol=15)
 
+def test_dotplot_group_cmaps_raises_error():
+    """Check that a ValueError is raised for missing groups in group_cmaps."""
     adata = pbmc68k_reduced()
+    markers = ["CD79A"]
+    # Intentionally incomplete dictionary to trigger the error
+    group_cmaps = {"CD19+ B": "Blues"}
 
-    # Use markers with a good range of expression values to check color gradients
-    markers = ["SERPINB1", "IGFBP7", "GNLY", "IFITM1", "IMP3", "UBALD2", "LTB", "CLPP"]
-
-    # Define a complete set of colormaps for all groups that will be plotted
-    group_cmaps = {
-        "CD14+ Monocyte": "Greys",
-        "Dendritic": "Purples",
-        "CD8+ Cytotoxic T": "Reds",
-        "CD8+/CD45RA+ Naive Cytotoxic": "Greens",
-        "CD4+/CD45RA+/CD25- Naive T": "Oranges",
-        "CD4+/CD25 T Reg": "Blues",
-        "CD4+/CD45RO+ Memory": "hot",
-        "CD19+ B": "cool",
-        "CD56+ NK": "winter",
-        "CD34+": "copper",
-    }
-
-    sc.pl.dotplot(
-        adata,
-        markers,
-        groupby="bulk_labels",
-        group_cmaps=group_cmaps,
-        dendrogram=True,
-        swap_axes=True,  # Check that group_cmaps works with swapped axes
-        show=False,
-    )
-    save_and_compare_images("dotplot_group_cmaps_swap_axes")
+    with pytest.raises(ValueError, match="missing from the `group_cmaps` dictionary"):
+        sc.pl.dotplot(
+            adata, markers, groupby="bulk_labels", group_cmaps=group_cmaps, show=False
+        )