Issue #13321: Kill mutation for JavadocMethod-7 by Kevin222004 · Pull Request #13342 · checkstyle/checkstyle

Kevin222004 · 2023-07-02T20:55:26Z

Issue #13321: Kill mutation for JavadocMethod-7

Check :-

https://checkstyle.org/checks/javadoc/javadocmethod.html#JavadocMethod

Mutation

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

Lines 147 to 163 in d4b1aec

    
           <mutation unstable="false"> 
        
             <sourceFile>JavadocMethodCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck</mutatedClass> 
        
             <mutatedMethod>getMethodTags</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.NonVoidMethodCallMutator</mutator> 
        
             <description>removed call to com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck::calculateTagColumn</description> 
        
             <lineContent>final int col = calculateTagColumn(noargCurlyMatcher, i, startColumnNumber);</lineContent> 
        
           </mutation> 
        
           <mutation unstable="false"> 
        
             <sourceFile>JavadocMethodCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck</mutatedClass> 
        
             <mutatedMethod>getMethodTags</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.ArgumentPropagationMutator</mutator> 
        
             <description>replaced call to com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck::calculateTagColumn with argument</description> 
        
             <lineContent>final int col = calculateTagColumn(noargCurlyMatcher, i, startColumnNumber);</lineContent> 
        
           </mutation>

Explaination

no argsCurlyMatcher will execute and add the @inheritdoc in tags list.

getMethodsTag is called by only checkComment method in which all the condition in if and else use only ast.getline no not tag's coloum is used any where which we make it to 0

so their is no such use of tag column here

Regression :-

Diff Regression config: https://gist.githubusercontent.com/Kevin222004/df2ff7a8f9969bb2c68d7251a97ffa8b/raw/6a4e81a624fa36483f23b0adcf1fc513ca6df350/JavadocMethod.xml
Diff Regression projects: https://gist.githubusercontent.com/Kevin222004/c16e31ce9283effe5b7ca057999d1b58/raw/b7eda4dd43b3b3c0d9eeba3030e1a22993123b04/github-action-projects2.properties
Report label: Project-list-3

Kevin222004 · 2023-07-02T20:55:56Z

Github, generate report

github-actions · 2023-07-02T22:49:47Z

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

Kevin222004 · 2023-07-04T04:57:48Z

Github, generate report

github-actions · 2023-07-04T06:19:46Z

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

nrmancuso · 2023-08-23T01:35:52Z

@Kevin222004 what do we need to do to get this PR out of draft mode?

Kevin222004 · 2023-11-08T18:52:57Z

Github, generate report

github-actions · 2023-11-08T19:46:12Z

Project-list-1:
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/2919a5a_2023194528/reports/diff/index.html

Kevin222004 · 2023-11-08T19:51:58Z

Github, generate report

github-actions · 2023-11-08T20:24:52Z

Project-list-2:
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/2919a5a_2023202425/reports/diff/index.html

Kevin222004 · 2023-11-08T20:40:25Z

Github, generate report

github-actions · 2023-11-08T21:21:25Z

Project-list-3:
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/2919a5a_2023212058/reports/diff/index.html

romani · 2023-11-09T00:09:30Z

@Kevin222004 , please update Checker suppression and convert PR to ready for review.

This is good example how we follow pitest to remove extra code in non AST based checks if regression can not find anything.
Such Checks will be rewritten in future projects. Java code will not be reused so this pitest activity extends our test base (that will be reused) or main code is shrinking.

This PR is referencing old issue, it is ok.

I put this PR as example to #13999

romani

ok to merge

romani · 2023-11-11T14:09:10Z

hmm, unrelated pitest:
https://github.com/checkstyle/checkstyle/actions/runs/6831156451/job/18580202698?pr=13342#step:7:15

patch -p1 << EOF
diff --git a/config/pitest-suppressions/pitest-common-suppressions.xml b/config/pitest-suppressions/pitest-common-suppressions.xml
index fe31289..47a734a 100644
--- a/config/pitest-suppressions/pitest-common-suppressions.xml
+++ b/config/pitest-suppressions/pitest-common-suppressions.xml
@@ -9,6 +9,15 @@
     <lineContent>final String stripped = CommonUtil.relativizeAndNormalizePath(basedir, fileName);</lineContent>
   </mutation>
 
+  <mutation unstable="false">
+    <sourceFile>Checker.java</sourceFile>
+    <mutatedClass>com.puppycrawl.tools.checkstyle.Checker</mutatedClass>
+    <mutatedMethod>finishLocalSetup</mutatedMethod>
+    <mutator>org.pitest.mutationtest.engine.gregor.mutators.VoidMethodCallMutator</mutator>
+    <description>removed call to com/puppycrawl/tools/checkstyle/LocalizedMessage::setLocale</description>
+    <lineContent>LocalizedMessage.setLocale(locale);</lineContent>
+  </mutation>
+
   <mutation unstable="false">
     <sourceFile>Checker.java</sourceFile>
     <mutatedClass>com.puppycrawl.tools.checkstyle.Checker</mutatedClass>
EOF

Kevin222004 · 2023-11-11T14:09:57Z

I am looking on that #13342 (comment)

Kevin222004 · 2023-11-11T14:17:22Z

In my local no new surviving is found so probably it will pass as it is re-run

nrmancuso

Provided explanation is incorrect, we use the column number from the collection of tags in a bunch of places. Examples:

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

Line 798 in 50c6672

log(tag.getLineNo(), tag.getColumnNo(), MSG_UNUSED_TAG,
checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java

Line 926 in 50c6672

.getColumnNo());
checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java

Line 886 in 50c6672

log(javadocTag.getLineNo(), javadocTag.getColumnNo(),

I see no real evidence that this mutation can't be killed by test input.

However, I am good to merge this update; we have a bunch of clean regression tests, and potential ROI for finding some obscure test case in probably not worth it.

Kevin222004 force-pushed the JDM7 branch 2 times, most recently from 52722d2 to ad14bb7 Compare July 5, 2023 07:27

Kevin222004 marked this pull request as ready for review July 5, 2023 07:47

Kevin222004 marked this pull request as draft July 6, 2023 09:05

rnveach assigned Vyom-Yadav Aug 31, 2023

romani unassigned Vyom-Yadav Sep 8, 2023

Kevin222004 force-pushed the JDM7 branch 2 times, most recently from 3355bad to 2919a5a Compare November 8, 2023 18:13

Kevin222004 force-pushed the JDM7 branch from 2919a5a to 007e6ed Compare November 9, 2023 16:48

Kevin222004 marked this pull request as ready for review November 9, 2023 16:48

Kevin222004 force-pushed the JDM7 branch from 007e6ed to a93113b Compare November 9, 2023 18:14

minor: remove extra spaces in pitest suppression

33fbfea

romani mentioned this pull request Nov 11, 2023

Resolve Pitest Suppression in Pitest-Javadoc Profile #13999

Closed

53 tasks

Issue checkstyle#13321: Kill mutation for JavadocMethod-7

0eae90a

romani force-pushed the JDM7 branch from a93113b to 0eae90a Compare November 11, 2023 00:59

romani requested a review from rnveach November 11, 2023 01:05

romani assigned rnveach Nov 11, 2023

romani approved these changes Nov 11, 2023

View reviewed changes

rnveach requested a review from nrmancuso November 11, 2023 21:25

rnveach assigned nrmancuso and unassigned rnveach Nov 11, 2023

nrmancuso approved these changes Nov 13, 2023

View reviewed changes

nrmancuso assigned rnveach and unassigned nrmancuso Nov 13, 2023

rnveach merged commit 26d37d2 into checkstyle:master Nov 13, 2023

	<mutation unstable="false">
	<sourceFile>JavadocMethodCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck</mutatedClass>
	<mutatedMethod>getMethodTags</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.NonVoidMethodCallMutator</mutator>
	<description>removed call to com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck::calculateTagColumn</description>
	<lineContent>final int col = calculateTagColumn(noargCurlyMatcher, i, startColumnNumber);</lineContent>
	</mutation>

	<mutation unstable="false">
	<sourceFile>JavadocMethodCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck</mutatedClass>
	<mutatedMethod>getMethodTags</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.ArgumentPropagationMutator</mutator>
	<description>replaced call to com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck::calculateTagColumn with argument</description>
	<lineContent>final int col = calculateTagColumn(noargCurlyMatcher, i, startColumnNumber);</lineContent>
	</mutation>

Uh oh!

Conversation

Kevin222004 commented Jul 2, 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 Jul 2, 2023

Uh oh!

github-actions Bot commented Jul 2, 2023

Uh oh!

Kevin222004 commented Jul 4, 2023

Uh oh!

github-actions Bot commented Jul 4, 2023

Uh oh!

nrmancuso commented Aug 23, 2023

Uh oh!

Kevin222004 commented Nov 8, 2023

Uh oh!

github-actions Bot commented Nov 8, 2023

Uh oh!

Kevin222004 commented Nov 8, 2023

Uh oh!

github-actions Bot commented Nov 8, 2023

Uh oh!

Kevin222004 commented Nov 8, 2023

Uh oh!

github-actions Bot commented Nov 8, 2023

Uh oh!

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

Uh oh!

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

romani commented Nov 11, 2023

Uh oh!

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

Uh oh!

Uh oh!

Kevin222004 commented Nov 11, 2023

Uh oh!

nrmancuso left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Kevin222004 commented Jul 2, 2023 •

edited

Loading

romani commented Nov 9, 2023 •

edited

Loading

Kevin222004 commented Nov 11, 2023 •

edited

Loading