Refactor visualize tests (#370)

## Description  This PR splits the tests for ribs.visualize into multiple files. Test methods and baseline images are also renamed since their filepaths now include the name of their respective visualization function. ## TODO  - [x] Split up tests - [x] Check that number of tests matches (93) ## Questions  ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [x] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
icaros-usc · Sep 13, 2023 · 8efa0f2 · 8efa0f2
1 parent 9f292a6
commit 8efa0f2
Show file tree

Hide file tree

Showing 67 changed files with 1,045 additions and 992 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -28,6 +28,7 @@
 
 - Improve developer workflow with pre-commit ({pr}`351`, {pr}`363`)
 - Refactor visualize module into multiple files ({pr}`357`)
+- Refactor visualize tests into multiple files ({pr}`370`)
 - Add GitHub link roles in documentation ({pr}`361`)
 - Refactor argument validation utilities ({pr}`365`)
 - Use Conda envs in all CI jobs ({pr}`368`)

diff --git a/tests/visualize/README.md b/tests/visualize/README.md
@@ -0,0 +1,20 @@
+# Visualization Tests
+
+This directory contains tests for ribs.visualize. For image comparison tests,
+read
+[these instructions](https://matplotlib.org/stable/devel/testing.html#writing-an-image-comparison-test).
+Essentially, start by writing a test in one of the files in this directory;
+let's pick `grid_archive_heatmap_test.py`. After writing this test, run it with
+pytest, then go to the _root_ directory of this repo. There, you will find the
+output image in `tests/visualize/baseline_images/grid_archive_heatmap_test`.
+Copy this image into the `baseline_images/grid_archive_heatmap_test` directory
+in this directory. Here's an example cp command:
+
+```
+cp result_images/grid_archive_heatmap_test/my_new_test.png \
+    tests/baseline_images/grid_archive_heatmap_test
+```
+
+Assuming the output is as expected (and assuming the code is deterministic), the
+test should now pass when it is re-run. The same applies for tests in other
+files; for instance, you can do the same for `cvt_archive_heatmap_test`.
diff --git a/tests/visualize/args_test.py b/tests/visualize/args_test.py
@@ -0,0 +1,95 @@
+"""Tests to check argument validation in various visualization functions.
+
+Many of the functions share parameters like cbar, so here we check if passing
+invalid arguments to these functions results in an error.
+"""
+import pytest
+
+from ribs.archives import CVTArchive, GridArchive, SlidingBoundariesArchive
+from ribs.visualize import (cvt_archive_heatmap, grid_archive_heatmap,
+                            sliding_boundaries_archive_heatmap)
+
+
+@pytest.mark.parametrize("archive_type", ["grid", "cvt", "sliding"])
+def test_heatmap_fails_on_unsupported_dims(archive_type):
+    archive = {
+        "grid":
+            lambda: GridArchive(
+                solution_dim=2, dims=[20, 20, 20], ranges=[(-1, 1)] * 3),
+        "cvt":
+            lambda: CVTArchive(
+                solution_dim=2,
+                cells=100,
+                ranges=[(-1, 1)] * 3,
+                samples=100,
+            ),
+        "sliding":
+            lambda: SlidingBoundariesArchive(
+                solution_dim=2, dims=[20, 20, 20], ranges=[(-1, 1)] * 3),
+    }[archive_type]()
+
+    with pytest.raises(ValueError):
+        {
+            "grid": grid_archive_heatmap,
+            "cvt": cvt_archive_heatmap,
+            "sliding": sliding_boundaries_archive_heatmap,
+        }[archive_type](archive)
+
+
+@pytest.mark.parametrize("archive_type", ["grid", "cvt", "sliding"])
+@pytest.mark.parametrize(
+    "invalid_arg_cbar",
+    ["None", 3.2, True,
+     (3.2, None), [3.2, None]])  # some random but invalid inputs
+def test_heatmap_fails_on_invalid_cbar_option(archive_type, invalid_arg_cbar):
+    archive = {
+        "grid":
+            lambda: GridArchive(
+                solution_dim=2, dims=[20, 20, 20], ranges=[(-1, 1)] * 3),
+        "cvt":
+            lambda: CVTArchive(
+                solution_dim=2,
+                cells=100,
+                ranges=[(-1, 1)] * 3,
+                samples=100,
+            ),
+        "sliding":
+            lambda: SlidingBoundariesArchive(
+                solution_dim=2,
+                dims=[20, 20, 20],
+                ranges=[(-1, 1)] * 3,
+            ),
+    }[archive_type]()
+
+    with pytest.raises(ValueError):
+        {
+            "grid": grid_archive_heatmap,
+            "cvt": cvt_archive_heatmap,
+            "sliding": sliding_boundaries_archive_heatmap,
+        }[archive_type](archive=archive, cbar=invalid_arg_cbar)
+
+
+@pytest.mark.parametrize("archive_type", ["grid", "cvt", "sliding"])
+@pytest.mark.parametrize(
+    "invalid_arg_aspect",
+    ["None", True, (3.2, None), [3.2, None]])  # some random but invalid inputs
+def test_heatmap_fails_on_invalid_aspect_option(archive_type,
+                                                invalid_arg_aspect):
+    archive = {
+        "grid":
+            lambda: GridArchive(
+                solution_dim=2, dims=[20, 20, 20], ranges=[(-1, 1)] * 3),
+        "cvt":
+            lambda: CVTArchive(
+                solution_dim=2, cells=100, ranges=[(-1, 1)] * 3, samples=100),
+        "sliding":
+            lambda: SlidingBoundariesArchive(
+                solution_dim=2, dims=[20, 20, 20], ranges=[(-1, 1)] * 3),
+    }[archive_type]()
+
+    with pytest.raises(ValueError):
+        {
+            "grid": grid_archive_heatmap,
+            "cvt": cvt_archive_heatmap,
+            "sliding": sliding_boundaries_archive_heatmap,
+        }[archive_type](archive=archive, aspect=invalid_arg_aspect)
diff --git a/...visualize_test/cvt_archive_heatmap_1d.png → ...ne_images/cvt_archive_heatmap_test/1d.png b/...visualize_test/cvt_archive_heatmap_1d.png → ...ne_images/cvt_archive_heatmap_test/1d.png
diff --git a/...st/cvt_archive_heatmap_1d_aspect_gt_1.png → ...heatmap_test/1d_aspect_greater_than_1.png b/...st/cvt_archive_heatmap_1d_aspect_gt_1.png → ...heatmap_test/1d_aspect_greater_than_1.png
diff --git a/...st/cvt_archive_heatmap_1d_aspect_lt_1.png → ...ve_heatmap_test/1d_aspect_less_than_1.png b/...st/cvt_archive_heatmap_1d_aspect_lt_1.png → ...ve_heatmap_test/1d_aspect_less_than_1.png
diff --git a/...ze_test/cvt_archive_heatmap_1d_sphere.png → ...es/cvt_archive_heatmap_test/1d_sphere.png b/...ze_test/cvt_archive_heatmap_1d_sphere.png → ...es/cvt_archive_heatmap_test/1d_sphere.png
diff --git a/...ize_test/cvt_archive_heatmap_1d_style.png → ...ges/cvt_archive_heatmap_test/1d_style.png b/...ize_test/cvt_archive_heatmap_1d_style.png → ...ges/cvt_archive_heatmap_test/1d_style.png
diff --git a/...st/cvt_archive_heatmap_1d_with_points.png → ...t_archive_heatmap_test/1d_with_points.png b/...st/cvt_archive_heatmap_1d_with_points.png → ...t_archive_heatmap_test/1d_with_points.png
diff --git a/...es/visualize_test/cvt_archive_heatmap.png → ...ne_images/cvt_archive_heatmap_test/2d.png b/...es/visualize_test/cvt_archive_heatmap.png → ...ne_images/cvt_archive_heatmap_test/2d.png
diff --git a/...sualize_test/cvt_archive_heatmap_long.png → ...ages/cvt_archive_heatmap_test/2d_long.png b/...sualize_test/cvt_archive_heatmap_long.png → ...ages/cvt_archive_heatmap_test/2d_long.png
diff --git a/..._test/cvt_archive_heatmap_long_square.png → ...t_archive_heatmap_test/2d_long_square.png b/..._test/cvt_archive_heatmap_long_square.png → ...t_archive_heatmap_test/2d_long_square.png
diff --git a/...st/cvt_archive_heatmap_long_transpose.png → ...rchive_heatmap_test/2d_long_transpose.png b/...st/cvt_archive_heatmap_long_transpose.png → ...rchive_heatmap_test/2d_long_transpose.png
diff --git a/...sualize_test/cvt_archive_heatmap_clip.png → ..._images/cvt_archive_heatmap_test/clip.png b/...sualize_test/cvt_archive_heatmap_clip.png → ..._images/cvt_archive_heatmap_test/clip.png
diff --git a/...test/cvt_archive_heatmap_clip_polygon.png → ...cvt_archive_heatmap_test/clip_polygon.png b/...test/cvt_archive_heatmap_clip_polygon.png → ...cvt_archive_heatmap_test/clip_polygon.png
diff --git a/...rchive_heatmap_clip_polygon_with_hole.png → ...e_heatmap_test/clip_polygon_with_hole.png b/...rchive_heatmap_clip_polygon_with_hole.png → ...e_heatmap_test/clip_polygon_with_hole.png
diff --git a/...vt_archive_heatmap_with_coolwarm_cmap.png → ...vt_archive_heatmap_test/coolwarm_cmap.png b/...vt_archive_heatmap_with_coolwarm_cmap.png → ...vt_archive_heatmap_test/coolwarm_cmap.png
diff --git a/..._test/cvt_archive_heatmap_with_limits.png → ...mages/cvt_archive_heatmap_test/limits.png b/..._test/cvt_archive_heatmap_with_limits.png → ...mages/cvt_archive_heatmap_test/limits.png
diff --git a/.../cvt_archive_heatmap_with_listed_cmap.png → .../cvt_archive_heatmap_test/listed_cmap.png b/.../cvt_archive_heatmap_with_listed_cmap.png → .../cvt_archive_heatmap_test/listed_cmap.png
diff --git a/...alize_test/cvt_archive_heatmap_noclip.png → ...mages/cvt_archive_heatmap_test/noclip.png b/...alize_test/cvt_archive_heatmap_noclip.png → ...mages/cvt_archive_heatmap_test/noclip.png
diff --git a/...st/cvt_archive_heatmap_with_centroids.png → ...t_archive_heatmap_test/plot_centroids.png b/...st/cvt_archive_heatmap_with_centroids.png → ...t_archive_heatmap_test/plot_centroids.png
diff --git a/...test/cvt_archive_heatmap_with_samples.png → ...cvt_archive_heatmap_test/plot_samples.png b/...test/cvt_archive_heatmap_with_samples.png → ...cvt_archive_heatmap_test/plot_samples.png
diff --git a/...e_test/cvt_archive_heatmap_rasterized.pdf → ...s/cvt_archive_heatmap_test/rasterized.pdf b/...e_test/cvt_archive_heatmap_rasterized.pdf → ...s/cvt_archive_heatmap_test/rasterized.pdf
diff --git a/.../cvt_archive_heatmap_vmin_equals_vmax.png → ...archive_heatmap_test/vmin_equals_vmax.png b/.../cvt_archive_heatmap_vmin_equals_vmax.png → ...archive_heatmap_test/vmin_equals_vmax.png
diff --git a/...est/cvt_archive_heatmap_voronoi_style.png → ...vt_archive_heatmap_test/voronoi_style.png b/...est/cvt_archive_heatmap_voronoi_style.png → ...vt_archive_heatmap_test/voronoi_style.png
diff --git a/...isualize_test/grid_archive_heatmap_1d.png → ...e_images/grid_archive_heatmap_test/1d.png b/...isualize_test/grid_archive_heatmap_1d.png → ...e_images/grid_archive_heatmap_test/1d.png
diff --git a/...t/grid_archive_heatmap_1d_aspect_gt_1.png → ...heatmap_test/1d_aspect_greater_than_1.png b/...t/grid_archive_heatmap_1d_aspect_gt_1.png → ...heatmap_test/1d_aspect_greater_than_1.png
diff --git a/...t/grid_archive_heatmap_1d_aspect_lt_1.png → ...ve_heatmap_test/1d_aspect_less_than_1.png b/...t/grid_archive_heatmap_1d_aspect_lt_1.png → ...ve_heatmap_test/1d_aspect_less_than_1.png
diff --git a/...s/visualize_test/grid_archive_heatmap.png → ...e_images/grid_archive_heatmap_test/2d.png b/...s/visualize_test/grid_archive_heatmap.png → ...e_images/grid_archive_heatmap_test/2d.png
diff --git a/...ualize_test/grid_archive_heatmap_long.png → ...ges/grid_archive_heatmap_test/2d_long.png b/...ualize_test/grid_archive_heatmap_long.png → ...ges/grid_archive_heatmap_test/2d_long.png
diff --git a/...test/grid_archive_heatmap_long_square.png → ...d_archive_heatmap_test/2d_long_square.png b/...test/grid_archive_heatmap_long_square.png → ...d_archive_heatmap_test/2d_long_square.png
diff --git a/...t/grid_archive_heatmap_long_transpose.png → ...rchive_heatmap_test/2d_long_transpose.png b/...t/grid_archive_heatmap_long_transpose.png → ...rchive_heatmap_test/2d_long_transpose.png
diff --git a/...test/grid_archive_heatmap_aspect_gt_1.png → ...ve_heatmap_test/aspect_greater_than_1.png b/...test/grid_archive_heatmap_aspect_gt_1.png → ...ve_heatmap_test/aspect_greater_than_1.png
diff --git a/...test/grid_archive_heatmap_aspect_lt_1.png → ...chive_heatmap_test/aspect_less_than_1.png b/...test/grid_archive_heatmap_aspect_lt_1.png → ...chive_heatmap_test/aspect_less_than_1.png
diff --git a/.../grid_archive_heatmap_with_boundaries.png → .../grid_archive_heatmap_test/boundaries.png b/.../grid_archive_heatmap_with_boundaries.png → .../grid_archive_heatmap_test/boundaries.png
diff --git a/...id_archive_heatmap_with_coolwarm_cmap.png → ...id_archive_heatmap_test/coolwarm_cmap.png b/...id_archive_heatmap_with_coolwarm_cmap.png → ...id_archive_heatmap_test/coolwarm_cmap.png
diff --git a/...grid_archive_heatmap_custom_cbar_axis.png → ...archive_heatmap_test/custom_cbar_axis.png b/...grid_archive_heatmap_custom_cbar_axis.png → ...archive_heatmap_test/custom_cbar_axis.png
diff --git a/...est/grid_archive_heatmap_equal_aspect.png → ...rid_archive_heatmap_test/equal_aspect.png b/...est/grid_archive_heatmap_equal_aspect.png → ...rid_archive_heatmap_test/equal_aspect.png
diff --git a/...test/grid_archive_heatmap_with_limits.png → ...ages/grid_archive_heatmap_test/limits.png b/...test/grid_archive_heatmap_with_limits.png → ...ages/grid_archive_heatmap_test/limits.png
diff --git a/...grid_archive_heatmap_with_listed_cmap.png → ...grid_archive_heatmap_test/listed_cmap.png b/...grid_archive_heatmap_with_listed_cmap.png → ...grid_archive_heatmap_test/listed_cmap.png
diff --git a/...ize_test/grid_archive_heatmap_no_cbar.png → ...ges/grid_archive_heatmap_test/no_cbar.png b/...ize_test/grid_archive_heatmap_no_cbar.png → ...ges/grid_archive_heatmap_test/no_cbar.png
diff --git a/..._test/grid_archive_heatmap_rasterized.pdf → .../grid_archive_heatmap_test/rasterized.pdf b/..._test/grid_archive_heatmap_rasterized.pdf → .../grid_archive_heatmap_test/rasterized.pdf
diff --git a/...mages/visualize_test/parallel_axes_2d.png → ...ine_images/parallel_axes_plot_test/2d.png b/...mages/visualize_test/parallel_axes_2d.png → ...ine_images/parallel_axes_plot_test/2d.png
diff --git a/...mages/visualize_test/parallel_axes_3d.png → ...ine_images/parallel_axes_plot_test/3d.png b/...mages/visualize_test/parallel_axes_3d.png → ...ine_images/parallel_axes_plot_test/3d.png
diff --git a/...ualize_test/parallel_axes_3d_coolwarm.png → ...s/parallel_axes_plot_test/3d_coolwarm.png b/...ualize_test/parallel_axes_3d_coolwarm.png → ...s/parallel_axes_plot_test/3d_coolwarm.png
diff --git a/...ze_test/parallel_axes_3d_custom_names.png → ...rallel_axes_plot_test/3d_custom_names.png b/...ze_test/parallel_axes_3d_custom_names.png → ...rallel_axes_plot_test/3d_custom_names.png
diff --git a/...allel_axes_3d_custom_objective_limits.png → ..._plot_test/3d_custom_objective_limits.png b/...allel_axes_3d_custom_objective_limits.png → ..._plot_test/3d_custom_objective_limits.png
diff --git a/...ze_test/parallel_axes_3d_custom_order.png → ...rallel_axes_plot_test/3d_custom_order.png b/...ze_test/parallel_axes_3d_custom_order.png → ...rallel_axes_plot_test/3d_custom_order.png
diff --git a/...isualize_test/parallel_axes_3d_sorted.png → ...ges/parallel_axes_plot_test/3d_sorted.png b/...isualize_test/parallel_axes_3d_sorted.png → ...ges/parallel_axes_plot_test/3d_sorted.png
diff --git a/...e_test/parallel_axes_3d_vertical_cbar.png → ...allel_axes_plot_test/3d_vertical_cbar.png b/...e_test/parallel_axes_3d_vertical_cbar.png → ...allel_axes_plot_test/3d_vertical_cbar.png
diff --git a/...e_test/parallel_axes_3d_width2_alpha2.png → ...allel_axes_plot_test/3d_width2_alpha2.png b/...e_test/parallel_axes_3d_width2_alpha2.png → ...allel_axes_plot_test/3d_width2_alpha2.png
diff --git a/...alize_test/sliding_boundaries_heatmap.png → ...ng_boundaries_archive_heatmap_test/2d.png b/...alize_test/sliding_boundaries_heatmap.png → ...ng_boundaries_archive_heatmap_test/2d.png
diff --git a/..._test/sliding_boundaries_heatmap_long.png → ...undaries_archive_heatmap_test/2d_long.png b/..._test/sliding_boundaries_heatmap_long.png → ...undaries_archive_heatmap_test/2d_long.png
diff --git a/...liding_boundaries_heatmap_long_square.png → ...s_archive_heatmap_test/2d_long_square.png b/...liding_boundaries_heatmap_long_square.png → ...s_archive_heatmap_test/2d_long_square.png
diff --git a/...ing_boundaries_heatmap_long_transpose.png → ...rchive_heatmap_test/2d_long_transpose.png b/...ing_boundaries_heatmap_long_transpose.png → ...rchive_heatmap_test/2d_long_transpose.png
diff --git a/...ng_boundaries_heatmap_with_boundaries.png → ...aries_archive_heatmap_test/boundaries.png b/...ng_boundaries_heatmap_with_boundaries.png → ...aries_archive_heatmap_test/boundaries.png
diff --git a/...boundaries_heatmap_with_coolwarm_cmap.png → ...es_archive_heatmap_test/coolwarm_cmap.png b/...boundaries_heatmap_with_coolwarm_cmap.png → ...es_archive_heatmap_test/coolwarm_cmap.png
diff --git a/...liding_boundaries_heatmap_with_limits.png → ...oundaries_archive_heatmap_test/limits.png b/...liding_boundaries_heatmap_with_limits.png → ...oundaries_archive_heatmap_test/limits.png
diff --git a/...g_boundaries_heatmap_with_listed_cmap.png → ...ries_archive_heatmap_test/listed_cmap.png b/...g_boundaries_heatmap_with_listed_cmap.png → ...ries_archive_heatmap_test/listed_cmap.png
diff --git a/...s_heatmap_mismatch_xy_with_boundaries.png → ...tmap_test/mismatch_xy_with_boundaries.png b/...s_heatmap_mismatch_xy_with_boundaries.png → ...tmap_test/mismatch_xy_with_boundaries.png
diff --git a/...sliding_boundaries_heatmap_rasterized.pdf → ...aries_archive_heatmap_test/rasterized.pdf b/...sliding_boundaries_heatmap_rasterized.pdf → ...aries_archive_heatmap_test/rasterized.pdf
diff --git a/tests/visualize/conftest.py b/tests/visualize/conftest.py
@@ -0,0 +1,75 @@
+"""Utilities for all visualization tests.
+
+See README.md for instructions on writing tests.
+"""
+import matplotlib.pyplot as plt
+import numpy as np
+import pytest
+
+
+@pytest.fixture(autouse=True)
+def clean_matplotlib():
+    """Cleans up matplotlib figures before and after each test."""
+    # Before the test.
+    plt.close("all")
+
+    yield
+
+    # After the test.
+    plt.close("all")
+
+
+def add_uniform_sphere_1d(archive, x_range):
+    """Adds points from the negative sphere function in a 1D grid w/ 100 elites.
+
+    The solutions are the same as the measures
+
+    x_range is a tuple of (lower_bound, upper_bound).
+    """
+    x = np.linspace(x_range[0], x_range[1], 100)
+    archive.add(
+        solution_batch=x[:, None],
+        objective_batch=-x**2,
+        measures_batch=x[:, None],
+    )
+
+
+def add_uniform_sphere_2d(archive, x_range, y_range):
+    """Adds points from the negative sphere function in a 100x100 grid.
+
+    The solutions are the same as the measures (the (x,y) coordinates).
+
+    x_range and y_range are tuples of (lower_bound, upper_bound).
+    """
+    xxs, yys = np.meshgrid(
+        np.linspace(x_range[0], x_range[1], 100),
+        np.linspace(y_range[0], y_range[1], 100),
+    )
+    xxs, yys = xxs.ravel(), yys.ravel()
+    coords = np.stack((xxs, yys), axis=1)
+    archive.add(
+        solution_batch=coords,
+        objective_batch=-(xxs**2 + yys**2),  # Negative sphere.
+        measures_batch=coords,
+    )
+
+
+def add_uniform_sphere_3d(archive, x_range, y_range, z_range):
+    """Adds points from the negative sphere function in a 100x100x100 grid.
+
+    The solutions are the same as the measures (the (x,y,z) coordinates).
+
+    x_range, y_range, and z_range are tuples of (lower_bound, upper_bound).
+    """
+    xxs, yys, zzs = np.meshgrid(
+        np.linspace(x_range[0], x_range[1], 40),
+        np.linspace(y_range[0], y_range[1], 40),
+        np.linspace(z_range[0], z_range[1], 40),
+    )
+    xxs, yys, zzs = xxs.ravel(), yys.ravel(), zzs.ravel()
+    coords = np.stack((xxs, yys, zzs), axis=1)
+    archive.add(
+        solution_batch=coords,
+        objective_batch=-(xxs**2 + yys**2 + zzs**2),  # Negative sphere.
+        measures_batch=coords,
+    )