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

Kevin222004 · 2023-06-26T18:34:26Z

Issue #13321: Kill mutation for SummaryJavaDocCheck-7

Check :-

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

Mutation

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

Lines 925 to 932 in 08da65a

    
           <mutation unstable="false"> 
        
             <sourceFile>SummaryJavadocCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.SummaryJavadocCheck</mutatedClass> 
        
             <mutatedMethod>isInlineTagWithName</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_IF</mutator> 
        
             <description>removed conditional - replaced equality check with true</description> 
        
             <lineContent>return child[1].getType() == JavadocTokenTypes.CUSTOM_NAME</lineContent> 
        
           </mutation>

Explaination

this method is used by two method

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

Lines 464 to 475 in 08da65a

    
               private static boolean isSummaryTag(DetailNode javadocInlineTag) { 
        
                   return isInlineTagWithName(javadocInlineTag, SUMMARY_TEXT); 
        
               } 
        
               /** 
        
                * Checks if the first tag inside ast is {@code {@return}} tag. 
        
                * 
        
                * @param javadocInlineTag node of type {@link JavadocTokenTypes#JAVADOC_INLINE_TAG} 
        
                * @return {@code true} if first tag is return tag. 
        
                */ 
        
               private static boolean isInlineReturnTag(DetailNode javadocInlineTag) { 
        
                   return isInlineTagWithName(javadocInlineTag, RETURN_TEXT);

Please guide if this is wrong. as per https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#CUSTOM_NAME whatever the tag will come it will always be true.

another and main reason the method is returning

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

Line 484 in 08da65a

* @return {@code true} if first tag is a tag with the given name.

the tag with given name then that task is already done by only

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

Line 493 in 08da65a

&& name.equals(child[1].getText());

if they don't match it is false.

Regression :-

Diff Regression config: https://gist.githubusercontent.com/Kevin222004/61eaa69fe98585b6ee1882ca082362bc/raw/316ca02ce9fd290119d9bfc560f2b11e84a1b685/Summary.xml
Diff Regression projects: https://gist.githubusercontent.com/Kevin222004/9600f179b602d4c971bdb0a050099005/raw/360a95ed7bb60d7a0956e531199d484c4d6f6617/test-projects.properties
Report label: Regression-2

Kevin222004 · 2023-06-26T18:34:40Z

Github, generate report

github-actions · 2023-06-26T20:41:44Z

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

Kevin222004 · 2023-06-29T05:25:05Z

Github, generate report

github-actions · 2023-06-29T07:47:47Z

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

Kevin222004 · 2023-06-29T07:50:03Z

Github, generate report

github-actions · 2023-06-29T09:28:23Z

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

romani · 2023-06-29T12:56:59Z

Pitest are failing .
Restated

romani · 2023-07-01T00:54:53Z

Not all tags are Custom named.
Please review https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html#JAVADOC_INLINE_TAG

There are bunch of standard inline tags please make test with recognized inlined tag or show existing line in Input and explain why it doesn't help to kill survival

Kevin222004 · 2023-07-02T13:33:26Z

#13317 (comment) Thanks for clarifying @romani
but the main reason to remove is

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

Lines 486 to 494 in 3142055

    
           private static boolean isInlineTagWithName(DetailNode javadocInlineTag, String name) { 
        
               final DetailNode[] child = javadocInlineTag.getChildren(); 
        
               // Checking size of ast is not required, since ast contains 
        
               // children of Inline Tag, as at least 2 children will be present which are 
        
               // RCURLY and LCURLY. 
        
               return child[1].getType() == JavadocTokenTypes.CUSTOM_NAME 
        
                   && name.equals(child[1].getText()); 
        
           }

this method check 2 condition that the name of inline tag should be match to child1.getText() which is text of JavadocInline Tag so if they mismatch then it will be false.

Know this method is only called by 2 method which are

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

Lines 464 to 466 in 3142055

    
           private static boolean isSummaryTag(DetailNode javadocInlineTag) { 
        
               return isInlineTagWithName(javadocInlineTag, SUMMARY_TEXT); 
        
           }

and

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

Lines 474 to 476 in 3142055

    
           private static boolean isInlineReturnTag(DetailNode javadocInlineTag) { 
        
               return isInlineTagWithName(javadocInlineTag, RETURN_TEXT); 
        
           }

in which as a name parameter already we are passing the name as @summary and @return as form of Summary_text and Return_text

so if this name will not match with the name of javadoc tag then method return false and in return statment both the condition are in && so if the removed statement is true still it will fail

romani · 2023-07-02T19:32:59Z

@Kevin222004 , Please resolve conflict meanwhile

romani · 2023-07-02T19:46:13Z

Yes, we check only predefined inline tags
Like

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

Line 262 in 3142055

private static final String RETURN_TEXT = "@return";

, and all of them are Custom for us.
So we do not need this extra condition.

romani

Ok to merge

Vyom-Yadav

LGTM!

rdiachenko · 2023-07-05T20:38:58Z

@Kevin222004 please resolve a conflict

rdiachenko

lgtm

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

Kevin222004 mentioned this pull request Jun 29, 2023

Resolve pitest survivals in modules - 2 #13321

Closed

41 tasks

Kevin222004 force-pushed the s7 branch from b5778e3 to 5307a10 Compare June 29, 2023 05:24

Kevin222004 marked this pull request as ready for review June 29, 2023 05:25

Kevin222004 force-pushed the s7 branch 2 times, most recently from a11781f to 1bb370a Compare June 30, 2023 18:00

romani requested review from Vyom-Yadav and rdiachenko July 2, 2023 19:46

romani assigned Vyom-Yadav Jul 2, 2023

romani self-requested a review July 2, 2023 19:46

romani approved these changes Jul 2, 2023

View reviewed changes

Kevin222004 force-pushed the s7 branch from 1bb370a to 4d1d091 Compare July 2, 2023 20:05

Vyom-Yadav approved these changes Jul 3, 2023

View reviewed changes

Vyom-Yadav assigned rdiachenko and unassigned Vyom-Yadav Jul 3, 2023

Issue checkstyle#13321: Kill mutation for SummaryJavaDocCheck-7

9597ac4

Kevin222004 force-pushed the s7 branch from 4d1d091 to 9597ac4 Compare July 6, 2023 02:52

rdiachenko approved these changes Jul 7, 2023

View reviewed changes

rdiachenko merged commit 86b95ff into checkstyle:master Jul 7, 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>isInlineTagWithName</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_IF</mutator>
	<description>removed conditional - replaced equality check with true</description>
	<lineContent>return child[1].getType() == JavadocTokenTypes.CUSTOM_NAME</lineContent>
	</mutation>

	private static boolean isSummaryTag(DetailNode javadocInlineTag) {
	return isInlineTagWithName(javadocInlineTag, SUMMARY_TEXT);
	}

	/**
	* Checks if the first tag inside ast is {@code {@return}} tag.
	*
	* @param javadocInlineTag node of type {@link JavadocTokenTypes#JAVADOC_INLINE_TAG}
	* @return {@code true} if first tag is return tag.
	*/
	private static boolean isInlineReturnTag(DetailNode javadocInlineTag) {
	return isInlineTagWithName(javadocInlineTag, RETURN_TEXT);

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 29, 2023

Uh oh!

github-actions bot commented Jun 29, 2023

Uh oh!

Kevin222004 commented Jun 29, 2023

Uh oh!

github-actions bot commented Jun 29, 2023

Uh oh!

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

Uh oh!

Uh oh!

romani commented Jul 1, 2023

Uh oh!

Kevin222004 commented Jul 2, 2023

Uh oh!

romani commented Jul 2, 2023

Uh oh!

romani commented Jul 2, 2023

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!

rdiachenko commented Jul 5, 2023

Uh oh!

rdiachenko 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

romani commented Jun 29, 2023 •

edited

Loading