Issue #13321: Kill mutation for SummaryJavaDocCheck-3 by Kevin222004 · Pull Request #13313 · checkstyle/checkstyle

Kevin222004 · 2023-06-26T18:15:44Z

Issue #13321: Kill mutation for SummaryJavaDocCheck-3

Check :-

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

Mutation

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

Lines 885 to 901 in ce6a111

    
           <mutation unstable="false"> 
        
             <sourceFile>SummaryJavadocCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck</mutatedClass> 
        
             <mutatedMethod>getSummarySentence</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.NonVoidMethodCallMutator</mutator> 
        
             <description>removed call to com/puppycrawl/tools/checkstyle/api/DetailNode::getType</description> 
        
             <lineContent>if (child.getType() == JavadocTokenTypes.JAVADOC_TAG) {</lineContent> 
        
           </mutation> 
        
           <mutation unstable="false"> 
        
             <sourceFile>SummaryJavadocCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck</mutatedClass> 
        
             <mutatedMethod>getSummarySentence</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_ELSE</mutator> 
        
             <description>removed conditional - replaced equality check with false</description> 
        
             <lineContent>if (child.getType() == JavadocTokenTypes.JAVADOC_TAG) {</lineContent> 
        
           </mutation>

Explaination

getSummaryDentence is used only at validateUntaggedSummary

Removal of

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

Lines 674 to 676 in ce6a111

    
           if (child.getType() == JavadocTokenTypes.JAVADOC_TAG) { 
        
               break; 
        
           }

will not make any issue the loop run 1 time more.

https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#JAVADOC

according to this instead of loop stop at javadoc tag ot will stop at eof. and it doesn't effect output.

lets assume in case if we have code like this

    /** 
     *  Comment of java.
     *  
     *  @param a
     *  worst case test
     */
    public void foo1(int a) throws Exception {
    }

then worst case test become descripion which is also under javadoctag

    |   |   |   |       |--WS ->    [18:6]
    |   |   |   |       |--JAVADOC_TAG -> JAVADOC_TAG [18:8]
    |   |   |   |       |   |--PARAM_LITERAL -> @param [18:8]
    |   |   |   |       |   |--WS ->   [18:14]
    |   |   |   |       |   |--PARAMETER_NAME -> a [18:15]
    |   |   |   |       |   |--NEWLINE -> \n [18:16]
    |   |   |   |       |   `--DESCRIPTION -> DESCRIPTION [19:0]
    |   |   |   |       |       |--LEADING_ASTERISK ->      * [19:0]
    |   |   |   |       |       |--TEXT ->   worst case test [19:6]
    |   |   |   |       |       |--NEWLINE -> \n [19:23]
    |   |   |   |       |       `--TEXT ->       [20:0]
    |   |   |   |       `--EOF -> <EOF> [20:5]

Regression :-

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

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

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: change-config-Regression-1

Kevin222004 · 2023-06-26T18:15:58Z

Github, generate report

github-actions · 2023-06-26T20:46:02Z

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

Kevin222004 · 2023-06-28T07:20:51Z

Github, generate report

Kevin222004 · 2023-06-28T09:09:26Z

Github, generate report

github-actions · 2023-06-28T09:25:15Z

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

github-actions · 2023-06-28T10:57:54Z

change-config-Regression-2:
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/58c7e7f_2023105658/reports/diff/index.html

Kevin222004 · 2023-06-28T12:59:08Z

Github, generate report

github-actions · 2023-06-28T16:31:10Z

change-config-Regression-1:
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/58c7e7f_2023162747/reports/diff/index.html

rdiachenko · 2023-06-28T20:54:01Z

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

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+


What's the reason for empty lines?

Some sort of avoiding conflicts

rdiachenko

lgtm

romani

Ok to merge

Vyom-Yadav

LGTM!

Kevin222004 changed the title ~~Issue #13109: Kill mutation for SummaryJavaDocCheck-3~~ Issue #13321: Kill mutation for SummaryJavaDocCheck-3 Jun 28, 2023

Kevin222004 mentioned this pull request Jun 28, 2023

Resolve pitest survivals in modules - 2 #13321

Closed

41 tasks

Kevin222004 force-pushed the s3 branch from 1ff2f00 to 1cc44da Compare June 28, 2023 07:19

Kevin222004 marked this pull request as ready for review June 28, 2023 07:19

Issue checkstyle#13321: Kill mutation for SummaryJavaDocCheck-3

58c7e7f

Kevin222004 force-pushed the s3 branch from 1cc44da to 58c7e7f Compare June 28, 2023 07:55

romani assigned rdiachenko Jun 28, 2023

romani requested review from Vyom-Yadav, rdiachenko and romani June 28, 2023 12:41

rdiachenko reviewed Jun 28, 2023

View reviewed changes

rdiachenko approved these changes Jun 29, 2023

View reviewed changes

rdiachenko assigned Vyom-Yadav and unassigned rdiachenko Jun 29, 2023

romani approved these changes Jun 29, 2023

View reviewed changes

Vyom-Yadav approved these changes Jul 2, 2023

View reviewed changes

Vyom-Yadav assigned romani and unassigned Vyom-Yadav Jul 2, 2023

romani merged commit 46651a2 into checkstyle:master Jul 2, 2023

Kevin222004 mentioned this pull request Aug 2, 2023

storage Kevin222004/GitHub-action#3

Closed

	<mutation unstable="false">
	<sourceFile>SummaryJavadocCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck</mutatedClass>
	<mutatedMethod>getSummarySentence</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.NonVoidMethodCallMutator</mutator>
	<description>removed call to com/puppycrawl/tools/checkstyle/api/DetailNode::getType</description>
	<lineContent>if (child.getType() == JavadocTokenTypes.JAVADOC_TAG) {</lineContent>
	</mutation>

	<mutation unstable="false">
	<sourceFile>SummaryJavadocCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck</mutatedClass>
	<mutatedMethod>getSummarySentence</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_ELSE</mutator>
	<description>removed conditional - replaced equality check with false</description>
	<lineContent>if (child.getType() == JavadocTokenTypes.JAVADOC_TAG) {</lineContent>
	</mutation>

	if (child.getType() == JavadocTokenTypes.JAVADOC_TAG) {
	break;
	}

Uh oh!

Conversation

Kevin222004 commented Jun 26, 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 26, 2023

Uh oh!

github-actions bot commented Jun 26, 2023

Uh oh!

Kevin222004 commented Jun 28, 2023

Uh oh!

Kevin222004 commented Jun 28, 2023

Uh oh!

github-actions bot commented Jun 28, 2023

Uh oh!

github-actions bot commented Jun 28, 2023

Uh oh!

Kevin222004 commented Jun 28, 2023

Uh oh!

github-actions bot commented Jun 28, 2023

Uh oh!

rdiachenko Jun 28, 2023

Choose a reason for hiding this comment

Uh oh!

romani Jun 29, 2023

Choose a reason for hiding this comment

Uh oh!

rdiachenko left a comment

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Kevin222004 commented Jun 26, 2023 •

edited

Loading