Issue #13672: Kill mutation for SummaryJavaDocCheck-11 by Kevin222004 · Pull Request #13329 · checkstyle/checkstyle

Kevin222004 · 2023-06-29T16:02:04Z

Issue #13672: Kill mutation for SummaryJavaDocCheck-11

Check :-

https://checkstyle.org/checks/javadoc/summaryjavadoc.html#SummaryJavadoc

Mutation

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

Lines 912 to 919 in 3d8ed42

    
           <mutation unstable="false"> 
        
             <sourceFile>SummaryJavadocCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck</mutatedClass> 
        
             <mutatedMethod>isInlineTagPresent</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_IF</mutator> 
        
             <description>removed conditional - replaced equality check with true</description> 
        
             <lineContent>|| ast.getType() == JavadocTokenTypes.HTML_ELEMENT</lineContent> 
        
           </mutation>

Explaination

The mutation is for (int i = 0; !found; i++) { to change !found == true which has been into for each loop and after making this changes The coverage of code will be missing as #13329 (comment) looks like #13329 (comment).

basically the extra code that has been changed is for the pattern like

    /** <h1> Some header </h1> {@inheritDoc} {@code bar1} text*/
    void bar2() {}

and

         /**
          * mm{@inheritDoc}
          */
         void foo7() {}

where their is some text before {@inheritDoc} so
instead of checking every node as per old code.

else if (child.getType() != JavadocTokenTypes.LEADING_ASTERISK
                    && !CommonUtil.isBlank(child.getText())) {

we can only check for

if ((child.getType() == JavadocTokenTypes.TEXT
                    || child.getType() == JavadocTokenTypes.HTML_ELEMENT)

as per AST they are the only two possible token in which their may be a extra text before {@inheritDoc}
using this we can get the code coverage as well mutation coverage

Regression :-

Diff Regression config: https://gist.githubusercontent.com/Kevin222004/61eaa69fe98585b6ee1882ca082362bc/raw/316ca02ce9fd290119d9bfc560f2b11e84a1b685/Summary.xml
Diff Regression projects: https://gist.githubusercontent.com/Kevin222004/21e3934e85f802e2fbd48af06d122364/raw/604256badd733d8568064f371d55657c04b00dfd/test-projects-2.properties
Report label: Report-2

Kevin222004 · 2023-06-29T16:02:41Z

Github, generate report

romani

Ok to merge

github-actions · 2023-06-29T16:43:41Z

Report generation failed on phase "make_report",
step "Prepare environment".
Link: https://github.com/checkstyle/checkstyle/actions/runs/5414343584

Vyom-Yadav

@Kevin222004 Please generate the reports and update the PR desc with the rationale and reports. Fix the CI failures too.

Kevin222004 · 2023-07-02T09:01:34Z

Code coverage report :- https://kevin222004.github.io/Regression/

Please go through https://kevin222004.github.io/Regression/com.puppycrawl.tools.checkstyle.checks.javadoc/SummaryJavadocCheck.java.html#L647

romani

I am recalling approval, something strange happening.

romani · 2023-07-02T13:43:55Z

@Kevin222004 , there is conflict and CI failures.

Kevin222004 · 2023-07-02T14:34:35Z

Yes I solve the conflict but this is strange #13329 (comment)

romani · 2023-07-02T14:39:02Z

CI failure:

[INFO] Analyzed bundle 'checkstyle' with 811 classes
[WARNING] Rule violated for class 
com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck: 
branches covered ratio is 0.99, but expected minimum is 1.00

Vyom-Yadav · 2023-07-03T05:59:18Z

@Kevin222004 See https://stackoverflow.com/a/53972675/15412365

romani · 2023-07-09T14:55:03Z

@Kevin222004 , please finish this PR, this is AST based javadoc Check.
If you stuck, please request explicit help from mentors.

Vyom-Yadav · 2023-07-12T11:28:20Z

@kevin The condition is redundant as:

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java

Lines 633 to 650 in 88486f7

    
           private static boolean startsWithInheritDoc(DetailNode root) { 
        
               boolean found = false; 
        
               final DetailNode[] children = root.getChildren(); 
        
               for (int i = 0; !found; i++) { 
        
                   final DetailNode child = children[i]; 
        
                   if (child.getType() == JavadocTokenTypes.JAVADOC_INLINE_TAG 
        
                           && child.getChildren()[1].getType() == JavadocTokenTypes.INHERIT_DOC_LITERAL) { 
        
                       found = true; 
        
                   } 
        
                   else if (child.getType() != JavadocTokenTypes.LEADING_ASTERISK 
        
                           && !CommonUtil.isBlank(child.getText())) { 
        
                       break; 
        
                   } 
        
               } 
        
               return found; 
        
           }

The no. of children is finite, so it would, at some time, stop on its own. (unless its really large, it would then take some time)
The condition child.getType() != JavadocTokenTypes.LEADING_ASTERISK && !CommonUtil.isBlank(child.getText()) will help break from the loop in most of the regular cases.

This is one of those cases where pitest prevents from saving time.

romani · 2023-07-21T05:18:04Z

@Kevin222004 , CI is red

Kevin222004 · 2023-07-21T05:19:55Z

@romani I fix this soon know in this case if pitest is happy then code coverage is not and if code coverage is happy then pitest is not. I update this.

Vyom-Yadav · 2023-07-31T17:04:11Z

@Kevin222004 Please finish this PR, please ping if some help is required.

Vyom-Yadav

Items:

Vyom-Yadav · 2023-08-09T08:40:41Z

src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java

        final DetailNode[] children = root.getChildren();

-        for (int i = 0; !found; i++) {
+        for (int i = 0; true; i++) {


Replace this with a for-each loop.

I am again facing

if i use for each loop

@Kevin222004 Replace this with a while loop, the condition:

child.getType() != JavadocTokenTypes.LEADING_ASTERISK && !CommonUtil.isBlank(child.getText())

would always be executed as every Javadoc tree has EOF.

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java

Line 1245 in a174e6e

* Last child is always {@link #EOF}.

@Kevin222004 , ping

@Kevin222004 , can we use findfirst pattern
https://stackoverflow.com/a/65074853/1015848

#13329 (comment)
The way how the logic is set in loop we can't use it

Kevin222004 · 2023-08-15T14:36:36Z

Github, generate report

Kevin222004 · 2023-08-15T14:51:39Z

Github, generate report

Kevin222004 · 2023-09-03T10:33:20Z

Github, generate report

github-actions · 2023-09-03T12:00:50Z

Report-2:
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/1a13176_2023120008/reports/diff/index.html

Kevin222004 · 2023-09-03T12:56:52Z

Github, generate report

romani

item:

src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java

github-actions · 2023-09-03T15:14:11Z

Report-2:
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/03ac7fb_2023151252/reports/diff/index.html

Kevin222004 · 2023-09-03T16:34:44Z

While running this command on local groovy ./.ci/checker-framework.groovy checker-index all the suppression is getting removed instead of new or unnecessary suppression changes. Anyone knows why this is happening

romani · 2023-09-03T17:54:25Z

@Kevin222004 , please try to workaround this failure in CI.
We can create separate issue to discuss this. Better to be not blocked by this unfortunate situation.

romani

Items

src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java

romani

items:

src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java

romani

items:

src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java

romani

Ok to merge

Vyom-Yadav

LGTM!

Agreed, only WS, TEXT, and HTML_ELEMENT can occur, out of which the latter two can only be non-empty.

rdiachenko

lgtm

rdiachenko · 2023-09-06T18:53:47Z

rebased

Kevin222004 mentioned this pull request Jun 29, 2023

Resolve pitest survivals in modules - 2 #13321

Closed

41 tasks

romani approved these changes Jun 29, 2023

View reviewed changes

romani requested review from Vyom-Yadav and rdiachenko June 29, 2023 16:22

romani assigned Vyom-Yadav Jun 29, 2023

Vyom-Yadav reviewed Jul 2, 2023

View reviewed changes

Kevin222004 force-pushed the s11 branch from 8e6c243 to 9f776d7 Compare July 2, 2023 08:36

romani requested changes Jul 2, 2023

View reviewed changes

Kevin222004 force-pushed the s11 branch from 9f776d7 to fcb63bf Compare July 5, 2023 08:44

Kevin222004 force-pushed the s11 branch from fcb63bf to b2f60f4 Compare July 16, 2023 17:53

This was referenced Aug 2, 2023

storage Kevin222004/GitHub-action#3

Closed

Resolve pitest survivals in modules - 3 #13501

Closed

Kevin222004 force-pushed the s11 branch from b2f60f4 to 3c5b821 Compare August 8, 2023 19:42

Vyom-Yadav suggested changes Aug 9, 2023

View reviewed changes

Kevin222004 force-pushed the s11 branch from 3c5b821 to cd37eaa Compare August 15, 2023 14:32

Kevin222004 force-pushed the s11 branch from cd37eaa to 796b0e5 Compare August 15, 2023 15:34

Kevin222004 force-pushed the s11 branch 2 times, most recently from 1a13176 to 03ac7fb Compare September 3, 2023 11:33

romani removed the awaiting response label Sep 3, 2023

romani requested changes Sep 3, 2023

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java Outdated Show resolved Hide resolved

Kevin222004 force-pushed the s11 branch from 03ac7fb to 37d40d6 Compare September 3, 2023 15:58

romani requested changes Sep 3, 2023

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java Show resolved Hide resolved

Kevin222004 force-pushed the s11 branch 2 times, most recently from 7222d8c to b5a670b Compare September 4, 2023 11:03

romani requested changes Sep 4, 2023

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java Outdated Show resolved Hide resolved

romani requested changes Sep 4, 2023

View reviewed changes

src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java Show resolved Hide resolved

Kevin222004 force-pushed the s11 branch from b5a670b to f0d0e7f Compare September 4, 2023 16:05

romani approved these changes Sep 4, 2023

View reviewed changes

romani assigned Vyom-Yadav and unassigned romani Sep 4, 2023

Vyom-Yadav approved these changes Sep 5, 2023

View reviewed changes

Vyom-Yadav assigned rdiachenko and unassigned Vyom-Yadav Sep 5, 2023

rdiachenko approved these changes Sep 6, 2023

View reviewed changes

Issue checkstyle#13672: Kill mutation for SummaryJavaDocCheck-11

7847000

rdiachenko force-pushed the s11 branch from f0d0e7f to 7847000 Compare September 6, 2023 18:53

rdiachenko assigned romani and unassigned rdiachenko Sep 6, 2023

romani merged commit 3a0f40e into checkstyle:master Sep 7, 2023

	<mutation unstable="false">
	<sourceFile>SummaryJavadocCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck</mutatedClass>
	<mutatedMethod>isInlineTagPresent</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_IF</mutator>
	<description>removed conditional - replaced equality check with true</description>
	<lineContent>\|\| ast.getType() == JavadocTokenTypes.HTML_ELEMENT</lineContent>
	</mutation>

Uh oh!

Conversation

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

Uh oh!

Check :-

Mutation

Explaination

Regression :-

Uh oh!

Kevin222004 commented Jun 29, 2023

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 29, 2023

Uh oh!

Vyom-Yadav left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kevin222004 commented Jul 2, 2023

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

romani commented Jul 2, 2023

Uh oh!

Kevin222004 commented Jul 2, 2023

Uh oh!

romani commented Jul 2, 2023

Uh oh!

Vyom-Yadav commented Jul 3, 2023

Uh oh!

romani commented Jul 9, 2023

Uh oh!

Vyom-Yadav commented Jul 12, 2023

Uh oh!

romani commented Jul 21, 2023

Uh oh!

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

Uh oh!

Uh oh!

Vyom-Yadav commented Jul 31, 2023

Uh oh!

Vyom-Yadav left a comment

Choose a reason for hiding this comment

Uh oh!

Vyom-Yadav Aug 9, 2023

Choose a reason for hiding this comment

Uh oh!

Kevin222004 Aug 9, 2023

Choose a reason for hiding this comment

Uh oh!

Vyom-Yadav Aug 9, 2023

Choose a reason for hiding this comment

Uh oh!

romani Aug 15, 2023

Choose a reason for hiding this comment

Uh oh!

romani Aug 17, 2023

Choose a reason for hiding this comment

Uh oh!

Kevin222004 Sep 3, 2023

Choose a reason for hiding this comment

Uh oh!

Kevin222004 commented Aug 15, 2023

Uh oh!

Kevin222004 commented Aug 15, 2023

Uh oh!

Kevin222004 commented Sep 3, 2023

Uh oh!

github-actions bot commented Sep 3, 2023

Uh oh!

Kevin222004 commented Sep 3, 2023

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Sep 3, 2023

Kevin222004 commented Jun 29, 2023 •

edited

Loading

Vyom-Yadav left a comment •

edited

Loading

Kevin222004 commented Jul 21, 2023 •

edited

Loading

Kevin222004 commented Sep 3, 2023 •

edited

Loading

Vyom-Yadav left a comment •

edited

Loading