Description
Fixes for several consecutive bugs with field assertions:
- Unnecessary Object type case for variables created with reflection
- Missed initial field states for arrays
- Unnecessary field state assertions for failed tests
Also, added line separator after single-line block comment.
See corresponding tests behavior in Manual Testing section.
Type of Change
- Bug fix (non-breaking change which fixes an issue)
How Has This Been Tested?
Automated Testing
org.utbot.examples.codegen.modifiers.ClassWithPrivateMutableFieldOfPrivateTypeTest
Manual Scenario
Consider the following code:
public class StringRegex {
Pattern pattern = Pattern.compile("\\d{1,10}\\w");
public String stringRegex(String str) {
if (pattern.matcher(str).find()) {
return str.substring(0, 2);
} else {
return str;
}
}
}and generate tests for the method stringRegex with the following settings: [Java, JUnit4, No mocks, 60s timeout, useConcreteExecution = true].
- One of the generated test methods contains the following code:
stringRegex.stringRegex(null);
Pattern pattern1 = stringRegex.pattern;
Object finalStringRegexPatternCompiled = getFieldValue(pattern1, "java.util.regex.Pattern", "compiled");
Class assertClazz = Class.forName("org.junit.Assert");
Class finalStringRegexPatternCompiledType = boolean.class;
Method assertTrueMethod = assertClazz.getDeclaredMethod("assertTrue", finalStringRegexPatternCompiledType);
assertTrueMethod.setAccessible(true);
Object[] assertTrueMethodArguments = new Object[1];
assertTrueMethodArguments[0] = finalStringRegexPatternCompiled;
assertTrueMethod.invoke(null, assertTrueMethodArguments);Here the JUnit4 method assertTrue is invoked using reflection because of variable finalStringRegexPatternCompiled with type Object.
But in this example this variable may be safely casted to its type boolean, and reflection usage for the assertTrue usage would be redundant.
So, expected code:
stringRegex.stringRegex(null);
Pattern pattern1 = stringRegex.pattern;
boolean finalStringRegexPatternCompiled = ((Boolean) getFieldValue(pattern1, "java.util.regex.Pattern", "compiled"));
assertTrue(finalStringRegexPatternCompiled);
- One of the generated test methods contains the following code:
stringRegex.stringRegex(null);
Pattern pattern1 = stringRegex.pattern;
int[] finalStringRegexPatternBuffer = ((int[]) getFieldValue(pattern1, "java.util.regex.Pattern", "buffer"));
Pattern pattern2 = stringRegex.pattern;
Map finalStringRegexPatternNamedGroups = ((Map) getFieldValue(pattern2, "java.util.regex.Pattern", "namedGroups"));
Pattern pattern3 = stringRegex.pattern;
Object finalStringRegexPatternGroupNodes = getFieldValue(pattern3, "java.util.regex.Pattern", "groupNodes");
Pattern pattern4 = stringRegex.pattern;
int[] finalStringRegexPatternTemp = ((int[]) getFieldValue(pattern4, "java.util.regex.Pattern", "temp"));
Pattern pattern5 = stringRegex.pattern;
int finalStringRegexPatternPatternLength = ((Integer) getFieldValue(pattern5, "java.util.regex.Pattern", "patternLength"));
assertNull(finalStringRegexPatternNamedGroups);
assertEquals(0, finalStringRegexPatternPatternLength);
There are no assertions for finalStringRegexPatternNamedGroups and finalStringRegexPatternGroupNodes because they have array types and are filtered out from initial states by mistake.
So, expected code is:
stringRegex.stringRegex(null);
Pattern pattern1 = stringRegex.pattern;
boolean finalStringRegexPatternCompiled = ((Boolean) getFieldValue(pattern1, "java.util.regex.Pattern", "compiled"));
Pattern pattern2 = stringRegex.pattern;
int[] finalStringRegexPatternBuffer = ((int[]) getFieldValue(pattern2, "java.util.regex.Pattern", "buffer"));
Pattern pattern3 = stringRegex.pattern;
Map finalStringRegexPatternNamedGroups = ((Map) getFieldValue(pattern3, "java.util.regex.Pattern", "namedGroups"));
Pattern pattern4 = stringRegex.pattern;
List finalStringRegexPatternTopClosureNodes = ((List) getFieldValue(pattern4, "java.util.regex.Pattern", "topClosureNodes"));
Pattern pattern5 = stringRegex.pattern;
int[] finalStringRegexPatternTemp = ((int[]) getFieldValue(pattern5, "java.util.regex.Pattern", "temp"));
Pattern pattern6 = stringRegex.pattern;
boolean finalStringRegexPatternHasSupplementary = ((Boolean) getFieldValue(pattern6, "java.util.regex.Pattern", "hasSupplementary"));
assertTrue(finalStringRegexPatternCompiled);
assertNull(finalStringRegexPatternBuffer);
assertNull(finalStringRegexPatternNamedGroups);
assertNull(finalStringRegexPatternTopClosureNodes);
assertNull(finalStringRegexPatternTemp);
assertTrue(finalStringRegexPatternHasSupplementary);
that contains assertions for these fields.
- Actually, the execution above is exception-throwing and breaks after invocation of method under test
stringRegex.stringRegex(string);.
So, all these field assertions are redundant because they will never be invoked, and the last statement of this test method has to be MUT invocation.
Checklist (remove irrelevant options):
- The change followed the style guidelines of the UTBot project
- Self-review of the code is passed
- The change contains enough commentaries, particularly in hard-to-understand areas
- New documentation is provided or existed one is altered
- No new warnings
- New tests have been added
- All tests pass locally with my changes