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.

Sign up for GitHub

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

Generate default error message #1

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Generate default error message #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4462e9d
Add a default error message for Assertions.fail() for when the error …
PhilIngham Jul 4, 2024
2765f00
Remove final methods from final class
PhilIngham Jul 4, 2024
6a75ce0
Change error message and minor grammar change
PhilIngham Jul 4, 2024
684e9cb
Revert final method removal
PhilipIngham Jul 11, 2024
db99bf9
Fix 'key' and 'value' text changes
PhilipIngham Jul 18, 2024
8923066
Merge branch 'refs/heads/main' into generate-default-error-message
PhilipIngham Jul 18, 2024
73ae77c
Fix .isBlank errors
PhilipIngham Jul 18, 2024
ded1b44
Remove null check
PhilipIngham Jul 19, 2024
20b5853
Add StringUtils.isBlank
PhilipIngham Jul 19, 2024
79e6e79
Test fixes
PhilipIngham Jul 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions junit-jupiter-api/src/main/java/org/junit/jupiter/api/Assertions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import org.apiguardian.api.API;
import org.junit.jupiter.api.function.Executable;
import org.junit.jupiter.api.function.ThrowingSupplier;
import org.junit.platform.commons.util.StringUtils;
import org.opentest4j.MultipleFailuresError;

/**
Expand Down Expand Up @@ -135,6 +136,9 @@ public static <V> V fail() {
* }</pre>
*/
public static <V> V fail(String message) {
if (StringUtils.isBlank(message)) {
AssertionUtils.fail("Assertion.fail() called");
}
AssertionUtils.fail(message);
return null; // appeasing the compiler: this line will never be executed.
}
Expand All @@ -147,6 +151,9 @@ public static <V> V fail(String message) {
* generic return type {@code V}.
*/
public static <V> V fail(String message, Throwable cause) {
if (StringUtils.isBlank(message)) {
AssertionUtils.fail("Assertion.fail() called", cause);
}
AssertionUtils.fail(message, cause);
return null; // appeasing the compiler: this line will never be executed.
}
Expand Down
11 changes: 5 additions & 6 deletions junit-jupiter-engine/src/test/java/org/junit/jupiter/api/FailAssertionsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@

package org.junit.jupiter.api;

import static org.junit.jupiter.api.AssertionTestUtils.assertEmptyMessage;
import static org.junit.jupiter.api.AssertionTestUtils.assertMessageContains;
import static org.junit.jupiter.api.AssertionTestUtils.assertMessageEquals;
import static org.junit.jupiter.api.AssertionTestUtils.expectAssertionFailedError;
Expand All @@ -36,7 +35,7 @@ void failWithoutArgument() {
expectAssertionFailedError();
}
catch (AssertionFailedError ex) {
assertEmptyMessage(ex);
assertMessageEquals(ex, "Assertion.fail() called");
}
}

Expand Down Expand Up @@ -69,7 +68,7 @@ void failWithNullString() {
expectAssertionFailedError();
}
catch (AssertionFailedError ex) {
assertEmptyMessage(ex);
assertMessageEquals(ex, "Assertion.fail() called");
}
}

Expand All @@ -80,7 +79,7 @@ void failWithNullMessageSupplier() {
expectAssertionFailedError();
}
catch (AssertionFailedError ex) {
assertEmptyMessage(ex);
assertMessageEquals(ex, "Assertion.fail() called");
}
}

Expand All @@ -104,7 +103,7 @@ void failWithThrowable() {
expectAssertionFailedError();
}
catch (AssertionFailedError ex) {
assertEmptyMessage(ex);
assertMessageEquals(ex, "Assertion.fail() called");
Throwable cause = ex.getCause();
assertMessageContains(cause, "cause");
}
Expand All @@ -131,7 +130,7 @@ void failWithNullStringAndThrowable() {
expectAssertionFailedError();
}
catch (AssertionFailedError ex) {
assertEmptyMessage(ex);
assertMessageEquals(ex, "Assertion.fail() called");
Throwable cause = ex.getCause();
assertMessageContains(cause, "cause");
}
Expand Down
9 changes: 4 additions & 5 deletions junit-jupiter-engine/src/test/kotlin/org/junit/jupiter/api/KotlinFailAssertionsTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
package org.junit.jupiter.api

import org.junit.jupiter.api.AssertEquals.assertEquals
import org.junit.jupiter.api.AssertionTestUtils.assertEmptyMessage
import org.junit.jupiter.api.AssertionTestUtils.assertMessageContains
import org.junit.jupiter.api.AssertionTestUtils.assertMessageEquals
import org.opentest4j.AssertionFailedError
Expand Down Expand Up @@ -43,7 +42,7 @@ class KotlinFailAssertionsTests {
assertThrows<AssertionFailedError> {
fail(null as String?)
}
assertEmptyMessage(ex)
assertMessageEquals(ex, "Assertion.fail() called")
}

@Test
Expand All @@ -52,7 +51,7 @@ class KotlinFailAssertionsTests {
assertThrows<AssertionFailedError> {
fail(null as (() -> String)?)
}
assertEmptyMessage(ex)
assertMessageEquals(ex, "Assertion.fail() called")
}

@Test
Expand All @@ -75,7 +74,7 @@ class KotlinFailAssertionsTests {
assertThrows<AssertionFailedError> {
fail(Throwable(throwableCause))
}
assertEmptyMessage(ex)
assertMessageEquals(ex, "Assertion.fail() called")
val cause = ex.cause
assertMessageContains(cause, throwableCause)
}
Expand All @@ -100,7 +99,7 @@ class KotlinFailAssertionsTests {
assertThrows<AssertionFailedError> {
fail(null, Throwable(throwableCause))
}
assertEmptyMessage(ex)
assertMessageEquals(ex, "Assertion.fail() called")
val cause = ex.cause
assertMessageContains(cause, throwableCause)
}
Expand Down
2 changes: 1 addition & 1 deletion junit-platform-engine/src/main/java/org/junit/platform/engine/reporting/ReportEntry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public static ReportEntry from(Map<String, String> keyValuePairs) {
/**
* Factory for creating a new {@code ReportEntry} from a key-value pair.
*
* @param key the key under which the value should published; never
* @param key the key under which the value should be published; never
* {@code null} or blank
* @param value the value to publish; never {@code null} or blank
*/
Expand Down