Issue #13321: Kill mutation for DescendantTokenCheck by Kevin222004 · Pull Request #13375 · checkstyle/checkstyle

Kevin222004 · 2023-07-07T12:51:31Z

Issue #13321: Kill mutation for DescendantTokenCheck

Check

https://checkstyle.org/checks/misc/descendanttoken.html#DescendantToken

mutation

checkstyle/config/pitest-suppressions/pitest-misc-suppressions.xml

Lines 3 to 19 in 20a52f7

    
           <mutation unstable="false"> 
        
             <sourceFile>DescendantTokenCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck</mutatedClass> 
        
             <mutatedMethod>&lt;init&gt;</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.MemberVariableMutator</mutator> 
        
             <description>Removed assignment to member variable limitedTokens</description> 
        
             <lineContent>@XdocsPropertyType(PropertyType.TOKEN_ARRAY)</lineContent> 
        
           </mutation> 
        
           <mutation unstable="false"> 
        
             <sourceFile>DescendantTokenCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck</mutatedClass> 
        
             <mutatedMethod>&lt;init&gt;</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.MemberVariableMutator</mutator> 
        
             <description>Removed assignment to member variable counts</description> 
        
             <lineContent>private int[] counts = CommonUtil.EMPTY_INT_ARRAY;</lineContent> 
        
           </mutation>

Explaination

Test added

Regression

Diff Regression config: https://gist.githubusercontent.com/Kevin222004/14aa273cb63f5e0c9b09b80021c9662d/raw/e44a7eed1601ecce19ab969e66dd27c698281ebd/desc.xml
Diff Regression projects: https://gist.githubusercontent.com/Kevin222004/21e3934e85f802e2fbd48af06d122364/raw/604256badd733d8568064f371d55657c04b00dfd/test-projects-2.properties
Report label: Regression-1

Vyom-Yadav · 2023-07-16T10:49:18Z

@Kevin222004 please generate reports and fix CI failures

Kevin222004 · 2023-07-28T17:37:48Z

Github, generate report

github-actions · 2023-07-28T17:45:08Z

Report generation failed on phase "make_report",
step "Generate report".
Link: https://github.com/checkstyle/checkstyle/actions/runs/5694738448

romani · 2023-07-29T14:52:16Z

@Kevin222004 , please continue.

romani · 2023-07-29T14:56:49Z

conflict with spotbugs:

INFO] --- spotbugs-maven-plugin:4.7.3.0:check (default) @ checkstyle ---
[INFO] BugInstance size is 5
[INFO] Error size is 0
[INFO] Total bugs: 5
[ERROR] Low: DescendantTokenCheck.counts not initialized in constructor and dereferenced
 in com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck.countTokens(DetailAST, int)
 [com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck] At DescendantTokenCheck.java:[line 787]
 UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR

[ERROR] Low: DescendantTokenCheck.counts not initialized in constructor and dereferenced in 
com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck.logAsSeparated(DetailAST)
 [com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck] At DescendantTokenCheck.java:[line 713]
 UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR

[ERROR] Low: DescendantTokenCheck.counts not initialized in constructor and dereferenced in 
com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck.logAsTotal(DetailAST) 
[com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck] At DescendantTokenCheck.java:[line 754]
 UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR

[ERROR] Low: DescendantTokenCheck.limitedTokens not initialized in constructor and dereferenced in com
.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck.logAsSeparated(DetailAST) 
[com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck] At DescendantTokenCheck.java:[line 712]
 UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR

[ERROR] Low: DescendantTokenCheck.limitedTokens not initialized in constructor and dereferenced in
 com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck.logAsTotal(DetailAST) 
[com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck] At DescendantTokenCheck.java:[line 753]
 UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR

romani · 2023-07-29T15:09:43Z

we set counts at

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java

Lines 806 to 817 in e539d51

    
           public void setLimitedTokens(String... limitedTokensParam) { 
        
               limitedTokens = new int[limitedTokensParam.length]; 
        
               int maxToken = 0; 
        
               for (int i = 0; i < limitedTokensParam.length; i++) { 
        
                   limitedTokens[i] = TokenUtil.getTokenId(limitedTokensParam[i]); 
        
                   if (limitedTokens[i] >= maxToken + 1) { 
        
                       maxToken = limitedTokens[i]; 
        
                   } 
        
               } 
        
               counts = new int[maxToken]; 
        
           }

we need to suppress spotbugs violations. with comment spotbugs does not know sequence of public method executions, null dereference is not possible But it is not a problem.

romani · 2023-07-30T13:22:29Z

@Kevin222004 , please do excludes for spotbugs at https://github.com/checkstyle/checkstyle/blob/master/config/spotbugs-exclude.xml

romani · 2023-08-02T16:59:23Z

@Kevin222004 , please fix Checker

Kevin222004 · 2023-08-03T16:31:56Z

@romani I will fix the checker

but i dont know how can i fix https://dev.azure.com/romanivanovjr/romanivanovjr/_build/results?buildId=15736&view=logs&j=c902ebb4-c9f8-5f09-4e17-ff78fbbc842e&t=9ca98c81-ff64-58f0-9d03-a23ac1c4a111&l=1123

romani · 2023-08-03T23:55:42Z

Add to suppression it for now

romani · 2023-08-07T00:53:42Z

@Kevin222004 , this looks like simple PR to update to get approval.

Vyom-Yadav

Items:

Vyom-Yadav · 2023-08-09T09:26:42Z

src/main/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java

    /** Specify set of tokens with limited occurrences as descendants. */
    @XdocsPropertyType(PropertyType.TOKEN_ARRAY)
-    private int[] limitedTokens = CommonUtil.EMPTY_INT_ARRAY;
+    private int[] limitedTokens;


@Kevin222004 Won't this throw NPE when there is no mention of this property in the config? limitedTokens is just not there in the config. In that case counts will be null and Arrays.fill(counts, 0); will throw an NPE.

/* DescendantToken tokens = LITERAL_SWITCH maximumDepth = 2 - limitedTokens = minimumNumber = 1 */

In this type of config, an NPE would be thrown. Is limitedTokens mandatory for the user to set?

Yes, should be npe.
It should be reproduced by default config usage.
@Kevin222004 , please look why it is not happening, we must have default config usage in tests.
It might be due to (default) usage in property-stle config in comment of Input.

I am not sure where things have gone wrong from my side. but done

Test Added

Vyom-Yadav

minors:

Vyom-Yadav · 2023-08-13T18:18:28Z

src/test/java/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheckTest.java

+    @Test
+    public void testProperty() throws Exception {
+        final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;


testProperty is really vague, please keep a specific name.

@Kevin222004 , please fix method name

Input file has values that are not default,

I have make it simple testLimitedToken

Vyom-Yadav · 2023-08-13T18:18:32Z

...ces/com/puppycrawl/tools/checkstyle/checks/descendanttoken/InputDescendantTokenProperty.java

+// ok
+public class InputDescendantTokenProperty {
+}
+
+class Test {
+    public static void main(String[] args) {
+        int x = 1;
+        switch (x) { // ok


One ok on top is enough.

romani

Ok to merge as raised items are resolved

Vyom-Yadav

LGTM!

Vyom-Yadav · 2023-08-15T13:19:35Z

@romani Assigned it to you as 2 reviews are sufficient for PRs adding a test case to kill a mutation.

Kevin222004 mentioned this pull request Jul 7, 2023

Resolve pitest survivals in modules - 2 #13321

Closed

41 tasks

romani self-assigned this Jul 29, 2023

Kevin222004 force-pushed the dtc branch from 18879b1 to 215d6e8 Compare August 1, 2023 17:32

This was referenced Aug 2, 2023

storage Kevin222004/GitHub-action#3

Closed

Resolve pitest survivals in modules - 3 #13501

Closed

Vyom-Yadav reviewed Aug 9, 2023

View reviewed changes

Kevin222004 force-pushed the dtc branch 2 times, most recently from 97c05ef to 20ec60f Compare August 13, 2023 16:58

Vyom-Yadav suggested changes Aug 13, 2023

View reviewed changes

romani approved these changes Aug 13, 2023

View reviewed changes

romani requested a review from rdiachenko August 13, 2023 18:46

Kevin222004 force-pushed the dtc branch from 20ec60f to 64b3b63 Compare August 14, 2023 03:53

romani assigned Vyom-Yadav and unassigned romani Aug 14, 2023

Kevin222004 force-pushed the dtc branch from 64b3b63 to 4e60cb4 Compare August 14, 2023 03:55

Issue checkstyle#13321: Kill mutation for DescendantTokenCheck

b143de4

Kevin222004 force-pushed the dtc branch from 4e60cb4 to b143de4 Compare August 14, 2023 04:03

Vyom-Yadav approved these changes Aug 15, 2023

View reviewed changes

Vyom-Yadav removed their assignment Aug 15, 2023

Vyom-Yadav assigned romani Aug 15, 2023

Vyom-Yadav removed the request for review from rdiachenko August 15, 2023 13:18

romani merged commit 79e7609 into checkstyle:master Aug 15, 2023

	<mutation unstable="false">
	<sourceFile>DescendantTokenCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck</mutatedClass>
	<mutatedMethod><init></mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.MemberVariableMutator</mutator>
	<description>Removed assignment to member variable limitedTokens</description>
	<lineContent>@XdocsPropertyType(PropertyType.TOKEN_ARRAY)</lineContent>
	</mutation>

	<mutation unstable="false">
	<sourceFile>DescendantTokenCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck</mutatedClass>
	<mutatedMethod><init></mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.MemberVariableMutator</mutator>
	<description>Removed assignment to member variable counts</description>
	<lineContent>private int[] counts = CommonUtil.EMPTY_INT_ARRAY;</lineContent>
	</mutation>

Uh oh!

Conversation

Kevin222004 commented Jul 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Check

mutation

Explaination

Regression

Uh oh!

Vyom-Yadav commented Jul 16, 2023

Uh oh!

Kevin222004 commented Jul 28, 2023

Uh oh!

github-actions bot commented Jul 28, 2023

Uh oh!

romani commented Jul 29, 2023

Uh oh!

romani commented Jul 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

romani commented Jul 29, 2023

Uh oh!

romani commented Jul 30, 2023

Uh oh!

romani commented Aug 2, 2023

Uh oh!

Kevin222004 commented Aug 3, 2023

Uh oh!

romani commented Aug 3, 2023

Uh oh!

romani commented Aug 7, 2023

Uh oh!

Vyom-Yadav left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Vyom-Yadav left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Vyom-Yadav left a comment

Choose a reason for hiding this comment

Uh oh!

Vyom-Yadav commented Aug 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Kevin222004 commented Jul 7, 2023 •

edited

Loading

romani commented Jul 29, 2023 •

edited

Loading