Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add values() navigation method to AbstractMapAssert #3291 #3297

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import static java.util.Collections.singleton;
import static java.util.Objects.requireNonNull;
import static java.util.stream.Collectors.toList;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.entry;
import static org.assertj.core.description.Description.mostRelevantDescription;
import static org.assertj.core.error.ShouldBeUnmodifiable.shouldBeUnmodifiable;
Expand All @@ -27,6 +28,7 @@
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
Expand Down Expand Up @@ -2219,4 +2221,24 @@ private static List<Object> flatten(Iterable<Object> collectionToFlatten) {
}
return result;
}

/**
* <p>Returns an {@link AbstractCollectionAssert} to make assertions on the values of the map</p>
*
* <p><strong>Example</strong></p>
* <pre><code class='java'> TolkienCharacter pippin = new TolkienCharacter("Pippin", 28, HOBBIT);
* TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT);
* TolkienCharacter merry = new TolkienCharacter("Merry", 36, HOBBIT);
*
* Map&lt;String, TolkienCharacter&gt; characters = mapOf(entry("Pippin", pippin),
* entry("Frodo", frodo),
* entry("Merry", merry));
* assertThat(characters).values()
* .contains(frodo, pippin, merry); </code></pre>
* @return An {@link AbstractCollectionAssert} to make collections assertion only on map values.
*/
public AbstractCollectionAssert<?, Collection<? extends V>, V, ObjectAssert<V>> values() {
requireNonNull(actual, "Can not extract values from a null map.");
return assertThat(actual.values());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*
* Copyright 2012-2023 the original author or authors.
*/
package org.assertj.core.api.map;

import org.assertj.core.test.jdk11.Jdk11;
import org.junit.jupiter.api.Test;

import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatNullPointerException;
import static org.assertj.core.api.Assertions.from;

class MapAssert_values_Test {
@Test
void should_return_collection_assertion_on_values_for_map_values() {
Map<String, Integer> map = Jdk11.Map.of("first", 1, "second", 2);
assertThat(map).values().contains(1, 2);
}

@Test
void should_return_collection_assertion_with_right_generic_type() {
Map<String, String> map = Jdk11.Map.of("first", "one");
assertThat(map).values()
.singleElement()
.returns('o', from(s -> s.charAt(0)));
}

@Test
void should_have_an_helpful_error_message_when_size_is_used_on_a_null_map() {
Map<String, String> nullMap = null;
assertThatNullPointerException().isThrownBy(() -> assertThat(nullMap).values().contains("nothing"))
.withMessage("Can not extract values from a null map.");
}
}