Skip to content

Commit

Permalink
Issue #9142: Migrate to Truth in AutomaticBeanTest
Browse files Browse the repository at this point in the history
  • Loading branch information
@shashwatj07 @pbludov
shashwatj07 authored and pbludov committed Jun 27, 2021
1 parent 0d9b3af commit 28fe683
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 53 deletions.
6 changes: 0 additions & 6 deletions config/sevntu_suppressions.xml
View file
Expand Up @@ -40,10 +40,4 @@
<!-- No need for constructor with cause -->
<suppress checks="CauseParameterInException" files=".*MetadataGenerationException\.java"/>

<!-- Migrating to Truth -->
<suppress checks="RequireFailForTryCatchInJunit" files="MutableExceptionCheckTest.java"/>
<suppress checks="RequireFailForTryCatchInJunit" files="CheckstyleAntTaskTest.java"/>
<suppress checks="RequireFailForTryCatchInJunit" files="AbstractViolationReporterTest.java"/>
<suppress checks="RequireFailForTryCatchInJunit" files="AbstractFileSetCheckTest.java"/>

</suppressions>
2 changes: 0 additions & 2 deletions config/suppressions.xml
View file
Expand Up @@ -174,8 +174,6 @@
files="[\\/]src[\\/]test[\\/]java[\\/]com[\\/]puppycrawl[\\/]tools[\\/]checkstyle[\\/]ant[\\/]CheckstyleAntTaskTest.java"/>
<suppress id="ImportControlTest"
files="[\\/]src[\\/]test[\\/]java[\\/]com[\\/]puppycrawl[\\/]tools[\\/]checkstyle[\\/]api[\\/]AbstractCheckTest.java"/>
<suppress id="ImportControlTest"
files="[\\/]src[\\/]test[\\/]java[\\/]com[\\/]puppycrawl[\\/]tools[\\/]checkstyle[\\/]api[\\/]AutomaticBeanTest.java"/>
<suppress id="ImportControlTest"
files="[\\/]src[\\/]test[\\/]java[\\/]com[\\/]puppycrawl[\\/]tools[\\/]checkstyle[\\/]api[\\/]FileSetCheckTest.java"/>
<suppress id="ImportControlTest"
Expand Down
140 changes: 95 additions & 45 deletions src/test/java/com/puppycrawl/tools/checkstyle/api/AutomaticBeanTest.java
View file
Expand Up @@ -19,11 +19,7 @@

package com.puppycrawl.tools.checkstyle.api;

import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import static com.google.common.truth.Truth.assertWithMessage;

import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
Expand All @@ -50,12 +46,19 @@ public void testConfigureNoSuchAttribute() {
conf.addAttribute("NonExistent", "doesn't matter");
try {
testBean.configure(conf);
fail("Exception is expected");
assertWithMessage("Exception is expected")
.fail();
}
catch (CheckstyleException ex) {
assertNull(ex.getCause(), "Exceptions cause should be null");
assertEquals("Property 'NonExistent' does not exist, please check the documentation",
ex.getMessage(), "Invalid exception message");
assertWithMessage("Exceptions cause should be null")
.that(ex)
.hasCauseThat()
.isNull();
assertWithMessage("Invalid exception message")
.that(ex)
.hasMessageThat()
.isEqualTo("Property 'NonExistent' does not exist,"
+ " please check the documentation");
}
}

Expand All @@ -66,12 +69,19 @@ public void testConfigureNoSuchAttribute2() {
conf.addAttribute("privateField", "doesn't matter");
try {
testBean.configure(conf);
fail("Exception is expected");
assertWithMessage("Exception is expected")
.fail();
}
catch (CheckstyleException ex) {
assertNull(ex.getCause(), "Exceptions cause should be null");
assertEquals("Property 'privateField' does not exist, please check the documentation",
ex.getMessage(), "Invalid exception message");
assertWithMessage("Exceptions cause should be null")
.that(ex)
.hasCauseThat()
.isNull();
assertWithMessage("Invalid exception message")
.that(ex)
.hasMessageThat()
.isEqualTo("Property 'privateField' does not exist,"
+ " please check the documentation");
}
}

Expand All @@ -82,13 +92,17 @@ public void testSetupChildFromBaseClass() throws CheckstyleException {
testBean.setupChild(null);
try {
testBean.setupChild(new DefaultConfiguration("dummy"));
fail("Exception expected");
assertWithMessage("Exception is expected")
.fail();
}
catch (CheckstyleException ex) {
final String expectedMessage = "dummy is not allowed as a child in bean config. "
+ "Please review 'Parent Module' section for this Check"
+ " in web documentation if Check is standard.";
assertEquals(expectedMessage, ex.getMessage(), "Invalid exception message");
assertWithMessage("Invalid exception message")
.that(ex)
.hasMessageThat()
.isEqualTo(expectedMessage);
}
}

Expand All @@ -103,13 +117,16 @@ public void testSetupInvalidChildFromBaseClass() throws Exception {

try {
testBean.setupChild(childConf);
fail("expecting checkstyle exception");
assertWithMessage("expecting checkstyle exception")
.fail();
}
catch (CheckstyleException ex) {
assertEquals("childConf is not allowed as a "
assertWithMessage("Invalid exception message")
.that(ex)
.hasMessageThat()
.isEqualTo("childConf is not allowed as a "
+ "child in parentConf. Please review 'Parent Module' section "
+ "for this Check in web documentation if Check is standard.",
ex.getMessage(), "expected exception");
+ "for this Check in web documentation if Check is standard.");
}
}

Expand All @@ -120,14 +137,19 @@ public void testContextualizeInvocationTargetException() {
context.add("exceptionalMethod", 123.0f);
try {
testBean.contextualize(context);
fail("InvocationTargetException is expected");
assertWithMessage("InvocationTargetException is expected")
.fail();
}
catch (CheckstyleException ex) {
final String expected = "Cannot set property ";
assertTrue(ex.getCause() instanceof InvocationTargetException,
"Invalid exception cause, should be: InvocationTargetException");
assertTrue(ex.getMessage().startsWith(expected),
"Invalid exception message, should start with: " + expected);
assertWithMessage("Invalid exception cause, should be: InvocationTargetException")
.that(ex)
.hasCauseThat()
.isInstanceOf(InvocationTargetException.class);
assertWithMessage("Invalid exception message, should start with: " + expected)
.that(ex)
.hasMessageThat()
.startsWith(expected);
}
}

Expand All @@ -138,14 +160,19 @@ public void testContextualizeConversionException() {
context.add("val", "some string");
try {
testBean.contextualize(context);
fail("InvocationTargetException is expected");
assertWithMessage("InvocationTargetException is expected")
.fail();
}
catch (CheckstyleException ex) {
final String expected = "illegal value ";
assertTrue(ex.getCause() instanceof ConversionException,
"Invalid exception cause, should be: ConversionException");
assertTrue(ex.getMessage().startsWith(expected),
"Invalid exception message, should start with: " + expected);
assertWithMessage("Invalid exception cause, should be: ConversionException")
.that(ex)
.hasCauseThat()
.isInstanceOf(ConversionException.class);
assertWithMessage("Invalid exception message, should start with: " + expected)
.that(ex)
.hasMessageThat()
.startsWith(expected);
}
}

Expand All @@ -157,19 +184,24 @@ public void testTestBean() {
testBean.assignPrivateFieldSecretly(null);
try {
testBean.setExceptionalMethod("someValue");
fail("exception expected");
assertWithMessage("exception expected")
.fail();
}
catch (IllegalStateException ex) {
assertEquals("null,wrongVal,0,someValue", ex.getMessage(), "Invalid exception message");
assertWithMessage("Invalid exception message")
.that(ex)
.hasMessageThat()
.isEqualTo("null,wrongVal,0,someValue");
}
}

@Test
public void testRegisterIntegralTypes() throws Exception {
final ConvertUtilsBeanStub convertUtilsBean = new ConvertUtilsBeanStub();
Whitebox.invokeMethod(AutomaticBean.class, "registerIntegralTypes", convertUtilsBean);
assertEquals(81, convertUtilsBean.getRegisterCount(),
"Number of converters registered differs from expected");
assertWithMessage("Number of converters registered differs from expected")
.that(convertUtilsBean.getRegisterCount())
.isEqualTo(81);
}

@Test
Expand All @@ -193,14 +225,27 @@ public void testBeanConverters() throws Exception {
config.addAttribute("accessModifiers", "public, private");
bean.configure(config);

assertArrayEquals(new String[] {"a", "b", "c"}, bean.strings, "invalid result");
assertEquals(".*", bean.pattern.pattern(), "invalid result");
assertEquals(SeverityLevel.ERROR, bean.severityLevel, "invalid result");
assertEquals(Scope.PUBLIC, bean.scope, "invalid result");
assertEquals(new URI("http://github.com"), bean.uri, "invalid result");
assertArrayEquals(new AccessModifierOption[] {AccessModifierOption.PUBLIC,
AccessModifierOption.PRIVATE}, bean.accessModifiers,
"invalid result");
final String message = "invalid result";
assertWithMessage(message)
.that(bean.strings).asList()
.containsExactly("a", "b", "c")
.inOrder();
assertWithMessage(message)
.that(bean.pattern.pattern())
.isEqualTo(".*");
assertWithMessage(message)
.that(bean.severityLevel)
.isEqualTo(SeverityLevel.ERROR);
assertWithMessage(message)
.that(bean.scope)
.isEqualTo(Scope.PUBLIC);
assertWithMessage(message)
.that(bean.uri)
.isEqualTo(new URI("http://github.com"));
assertWithMessage(message)
.that(bean.accessModifiers).asList()
.containsExactly(AccessModifierOption.PUBLIC, AccessModifierOption.PRIVATE)
.inOrder();
}

@Test
Expand All @@ -210,7 +255,9 @@ public void testBeanConvertersUri2() throws Exception {
config.addAttribute("uri", "");
bean.configure(config);

assertNull(bean.uri, "invalid result");
assertWithMessage("invalid result")
.that(bean.uri)
.isNull();
}

@Test
Expand All @@ -221,11 +268,14 @@ public void testBeanConvertersUri3() {

try {
bean.configure(config);
fail("Exception is expected");
assertWithMessage("Exception is expected")
.fail();
}
catch (CheckstyleException ex) {
assertEquals("illegal value 'BAD' for property 'uri'", ex.getMessage(),
"Error message is not expected");
assertWithMessage("Error message is not expected")
.that(ex)
.hasMessageThat()
.isEqualTo("illegal value 'BAD' for property 'uri'");
}
}

Expand Down

0 comments on commit 28fe683

Please sign in to comment.