Use waldo::compare(list_as_map) in expect_mapequal()

This weakens the expectation so it shouldn't cause any existing tests to fail.

Fixes #1521

Author: hadley

NEWS.md

@@ -1,5 +1,6 @@
 # testthat (development version)
 
+* Power `expect_mapequal()` with `waldo::compare(list_as_map = TRUE)` (#1521).
 * `expect_snapshot_value()` can now handle expressions that generate `-` (#1678) or zero length atomic vectors (#2042).
 * `expect_matches()` failures should be a little easier to read (#2135).
 * New `local_on_cran(TRUE)` allows you to simulate how your tests will run on CRAN (#2112).

R/expect-equality.R

@@ -123,7 +123,7 @@ expect_waldo_equal_ <- function(
   type,
   act,
   exp,
-  info,
+  info = NULL,
   ...,
   trace_env = caller_env()
 ) {

R/expect-setequal.R

@@ -6,8 +6,9 @@
 #'   (i.e. `y` is a subset of `x`).
 #' * `expect_in(x, y)` tests every element of `x` is in `y`
 #'   (i.e. `x` is a subset of `y`).
-#' * `expect_mapequal(x, y)` tests that `x` and `y` have the same names, and
-#'    that `x[names(y)]` equals `y`.
+#' * `expect_mapequal(x, y)` treats lists as if they are mappings between names
+#'   and values. Concretely, this drops `NULL`s in both objects and sorts
+#'   named components.
 #'
 #' Note that `expect_setequal()` ignores names, and you will be warned if both
 #' `object` and `expected` have them.
@@ -79,39 +80,7 @@ expect_mapequal <- function(object, expected) {
   act <- quasi_label(enquo(object), arg = "object")
   exp <- quasi_label(enquo(expected), arg = "expected")
 
-  if (!is_vector(act$val) || !is_vector(exp$val)) {
-    abort("`object` and `expected` must both be vectors")
-  }
-
-  # Length-0 vectors are OK whether named or unnamed.
-  if (length(act$val) == 0 && length(exp$val) == 0) {
-    warn("`object` and `expected` are empty lists")
-    return(pass(act$val))
-  }
-
-  act_nms <- names(act$val)
-  exp_nms <- names(exp$val)
-
-  check_names_ok(act_nms, "object")
-  check_names_ok(exp_nms, "expected")
-
-  if (setequal(act_nms, exp_nms)) {
-    return(expect_equal(act$val[exp_nms], exp$val))
-  }
-
-  act_miss <- setdiff(exp_nms, act_nms)
-  if (length(act_miss) > 0) {
-    vals <- paste0(encodeString(act_miss, quote = '"'), ", ")
-    return(fail(paste0("Names absent from `object`: ", vals)))
-  }
-
-  exp_miss <- setdiff(act_nms, exp_nms)
-  if (length(exp_miss) > 0) {
-    vals <- paste0(encodeString(exp_miss, quote = '"'), ", ")
-    return(fail(paste0("Names absent from `expected`: ", vals)))
-  }
-
-  pass(act$val)
+  expect_waldo_equal_("equal", act, exp, list_as_map = TRUE)
 }
 
 check_names_ok <- function(x, label) {

man/expect_setequal.Rd

@@ -50,10 +50,17 @@ test_that("ignores order", {
   expect_success(expect_mapequal(list(a = 1, b = 2), list(b = 2, a = 1)))
 })
 
+test_that("ignores order recursively", {
+  local_edition(3)
+  x <- list(outer_1 = 1, outer_2 = list(inner_1 = 1, inner_2 = 2))
+  y <- list(outer_2 = list(inner_2 = 2, inner_1 = 1), outer_1 = 1)
+  expect_success(expect_mapequal(x, y))
+})
+
 test_that("error if any names are duplicated", {
-  expect_error(expect_mapequal(list(a = 1, b = 2, b = 3), list(b = 2, a = 1)))
-  expect_error(expect_mapequal(list(a = 1, b = 2), list(b = 3, b = 2, a = 1)))
-  expect_error(expect_mapequal(
+  expect_failure(expect_mapequal(list(a = 1, b = 2, b = 3), list(b = 2, a = 1)))
+  expect_failure(expect_mapequal(list(a = 1, b = 2), list(b = 3, b = 2, a = 1)))
+  expect_failure(expect_mapequal(
     list(a = 1, b = 2, b = 3),
     list(b = 3, b = 2, a = 1)
   ))
@@ -72,24 +79,9 @@ test_that("fails if values don't match", {
   expect_failure(expect_mapequal(list(a = 1, b = 2), list(a = 1, b = 3)))
 })
 
-test_that("error for non-vectors", {
-  expect_error(expect_mapequal(sum, sum), "be vectors")
-  expect_error(expect_mapequal(NULL, NULL), "be vectors")
-})
-
-test_that("error if any unnamed values", {
-  expect_error(expect_mapequal(list(1, b = 2), list(1, b = 2)))
-  expect_error(expect_mapequal(list(1, b = 2), list(b = 2, 1)))
-})
-
-test_that("succeeds if comparing empty named and unnamed vectors", {
-  x1 <- list()
-  x2 <- setNames(list(), character())
-
-  expect_warning(expect_success(expect_mapequal(x1, x1)))
-  expect_warning(expect_success(expect_mapequal(x1, x2)))
-  expect_warning(expect_success(expect_mapequal(x2, x1)))
-  expect_warning(expect_success(expect_mapequal(x2, x2)))
+test_that("fails if unnamed values in different location if any unnamed values", {
+  expect_success(expect_mapequal(list(1, b = 2, c = 3), list(1, c = 3, b = 2)))
+  expect_failure(expect_mapequal(list(1, b = 2, c = 3), list(b = 2, 1, c = 3)))
 })
 
 # contains ----------------------------------------------------------------