Issue #13501: Kill mutation for MissingJavadocMethodCheck2 by Kevin222004 · Pull Request #13561 · checkstyle/checkstyle

Kevin222004 · 2023-08-17T15:18:03Z

Issue #13501: Kill mutation for MissingJavadocMethodCheck2

Check :-

https://checkstyle.org/checks/javadoc/missingjavadocmethod.html#MissingJavadocMethod

Mutation

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

Lines 660 to 694 in d2c985e

    
           <mutation unstable="false"> 
        
             <sourceFile>MissingJavadocMethodCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck</mutatedClass> 
        
             <mutatedMethod>isContentsAllowMissingJavadoc</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_ELSE</mutator> 
        
             <description>removed conditional - replaced equality check with false</description> 
        
             <lineContent>return (ast.getType() == TokenTypes.METHOD_DEF</lineContent> 
        
           </mutation> 
        
           <mutation unstable="false"> 
        
             <sourceFile>MissingJavadocMethodCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck</mutatedClass> 
        
             <mutatedMethod>isContentsAllowMissingJavadoc</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_IF</mutator> 
        
             <description>removed conditional - replaced equality check with true</description> 
        
             <lineContent>|| ast.getType() == TokenTypes.COMPACT_CTOR_DEF)</lineContent> 
        
           </mutation> 
        
           <mutation unstable="false"> 
        
             <sourceFile>MissingJavadocMethodCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck</mutatedClass> 
        
             <mutatedMethod>isContentsAllowMissingJavadoc</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_ELSE</mutator> 
        
             <description>removed conditional - replaced equality check with false</description> 
        
             <lineContent>|| ast.getType() == TokenTypes.CTOR_DEF</lineContent> 
        
           </mutation> 
        
           <mutation unstable="false"> 
        
             <sourceFile>MissingJavadocMethodCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck</mutatedClass> 
        
             <mutatedMethod>shouldCheck</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_IF</mutator> 
        
             <description>removed conditional - replaced equality check with true</description> 
        
             <lineContent>return (excludeScope == null</lineContent> 
        
           </mutation>

Explaination

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

Lines 432 to 438 in d832cae

    
           private boolean isContentsAllowMissingJavadoc(DetailAST ast) { 
        
               return (ast.getType() == TokenTypes.METHOD_DEF 
        
                       || ast.getType() == TokenTypes.CTOR_DEF 
        
                       || ast.getType() == TokenTypes.COMPACT_CTOR_DEF) 
        
                       && (getMethodsNumberOfLine(ast) <= minLineCount 
        
                           || AnnotationUtil.containsAnnotation(ast, allowedAnnotations)); 
        
           }

In this all the ast.getType == .. are use less because they are the only tokens which is accepted so any token is going to be one of them because this method is called by

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

Lines 418 to 423 in d832cae

    
           private boolean isMissingJavadocAllowed(final DetailAST ast) { 
        
               return allowMissingPropertyJavadoc 
        
                       && (CheckUtil.isSetterMethod(ast) || CheckUtil.isGetterMethod(ast)) 
        
                   || matchesSkipRegex(ast) 
        
                   || isContentsAllowMissingJavadoc(ast); 
        
           }

in which the ast is not modified and this method is called by visitToken

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

Lines 380 to 388 in d832cae

    
           public final void visitToken(DetailAST ast) { 
        
               final Scope theScope = ScopeUtil.getScope(ast); 
        
               if (shouldCheck(ast, theScope)) { 
        
                   final FileContents contents = getFileContents(); 
        
                   final TextBlock textBlock = contents.getJavadocBefore(ast.getLineNo()); 
        
                   if (textBlock == null && !isMissingJavadocAllowed(ast)) { 
        
                       log(ast, MSG_JAVADOC_MISSING); 
        
                   }

where ast is not changing.

Second

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

Lines 468 to 476 in d832cae

    
           private boolean shouldCheck(final DetailAST ast, final Scope nodeScope) { 
        
               final Scope surroundingScope = ScopeUtil.getSurroundingScope(ast); 
        
               return (excludeScope == null 
        
                       || nodeScope != excludeScope 
        
                       && surroundingScope != excludeScope) 
        
                   && nodeScope.isIn(scope) 
        
                   && surroundingScope.isIn(scope); 
        
           }

exclude == null is also useless it is accepting both null and not null if it is not null then we have condition of that in logical Operators that's exclude == null is useless

Regression

Report-1 :-

Report-2 :-

Diff Regression config: https://gist.githubusercontent.com/Kevin222004/e68ff3727846e014d16ab79850e397c9/raw/ed2a46a684de49b6e500e30c1e1a5f867c6c6695/MissingJavadocMethodCheck.xml
Diff Regression projects: https://gist.githubusercontent.com/Kevin222004/9600f179b602d4c971bdb0a050099005/raw/360a95ed7bb60d7a0956e531199d484c4d6f6617/test-projects.properties
Report label: Regression-1

romani · 2023-08-17T15:43:16Z

All javadoc Checks that are not based on AST

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

Line 264 in d832cae

public class MissingJavadocMethodCheck extends AbstractCheck {

Will pass less strict review, as most of them very buggy, so extra regression is ok.
So empty regression diff report is good enough.

Kevin222004 · 2023-08-17T15:51:51Z

Github, generate report

Kevin222004 · 2023-08-17T15:55:18Z

Github, generate report

github-actions · 2023-08-17T17:50:50Z

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

github-actions · 2023-08-17T19:08:57Z

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

romani

Ok to merge

Vyom-Yadav

item:

Vyom-Yadav · 2023-08-22T07:55:28Z

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

-        return (ast.getType() == TokenTypes.METHOD_DEF
-                || ast.getType() == TokenTypes.CTOR_DEF
-                || ast.getType() == TokenTypes.COMPACT_CTOR_DEF)
-                && (getMethodsNumberOfLine(ast) <= minLineCount
-                    || AnnotationUtil.containsAnnotation(ast, allowedAnnotations));
+        return getMethodsNumberOfLine(ast) <= minLineCount
+                || AnnotationUtil.containsAnnotation(ast, allowedAnnotations);


In this all the ast.getType == .. are use less because they are the only tokens which is accepted so any token is going to be one of them because this method is called by

I see TokenTypes.ANNOTATION_FIELD_DEF in the list of accepted tokens, maybe it is a filter for that. Please see https://stackoverflow.com/a/48729302/15412365 and verify the removal.

good catch, such conditions were added at 8179a34

so we need to have javadoc on record - #8497

Done.
Sorry for taking too quick a decision on this pr. I have made the decision with some simple annotations. instead of ANNOTATION_FIELD_DEF

romani · 2023-08-29T04:42:08Z

@Kevin222004 , please generate diff report to double prove that it is good.

Kevin222004 · 2023-08-29T05:32:34Z

Github, generate report

github-actions · 2023-08-29T06:56:59Z

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

Kevin222004 · 2023-08-29T07:38:42Z

Github, generate report

github-actions · 2023-08-29T08:45:34Z

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

romani

Ok to merge

rdiachenko

lgtm

rdiachenko · 2023-08-30T19:43:19Z

rebased

Kevin222004 mentioned this pull request Aug 17, 2023

Resolve pitest survivals in modules - 3 #13501

Closed

61 tasks

romani approved these changes Aug 17, 2023

View reviewed changes

romani requested review from Vyom-Yadav and rdiachenko August 17, 2023 20:23

romani assigned Vyom-Yadav Aug 17, 2023

Vyom-Yadav reviewed Aug 22, 2023

View reviewed changes

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

romani self-requested a review August 22, 2023 13:03

Kevin222004 force-pushed the MissingJavadocMethodCheck2 branch from 5247e0c to bbdd034 Compare August 28, 2023 20:03

romani approved these changes Aug 29, 2023

View reviewed changes

romani assigned rdiachenko and unassigned romani Aug 29, 2023

rdiachenko approved these changes Aug 30, 2023

View reviewed changes

Issue checkstyle#13501: Kill mutation for MissingJavadocMethodCheck2

b0261cd

rdiachenko force-pushed the MissingJavadocMethodCheck2 branch from bbdd034 to b0261cd Compare August 30, 2023 19:43

rdiachenko assigned romani and unassigned rdiachenko Aug 30, 2023

romani merged commit d39e244 into checkstyle:master Aug 31, 2023

	<mutation unstable="false">
	<sourceFile>MissingJavadocMethodCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck</mutatedClass>
	<mutatedMethod>isContentsAllowMissingJavadoc</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_ELSE</mutator>
	<description>removed conditional - replaced equality check with false</description>
	<lineContent>return (ast.getType() == TokenTypes.METHOD_DEF</lineContent>
	</mutation>

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

	<mutation unstable="false">
	<sourceFile>MissingJavadocMethodCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck</mutatedClass>
	<mutatedMethod>isContentsAllowMissingJavadoc</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_ELSE</mutator>
	<description>removed conditional - replaced equality check with false</description>
	<lineContent>\|\| ast.getType() == TokenTypes.CTOR_DEF</lineContent>
	</mutation>

	<mutation unstable="false">
	<sourceFile>MissingJavadocMethodCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck</mutatedClass>
	<mutatedMethod>shouldCheck</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.RemoveConditionalMutator_EQUAL_IF</mutator>
	<description>removed conditional - replaced equality check with true</description>
	<lineContent>return (excludeScope == null</lineContent>
	</mutation>

	private boolean isContentsAllowMissingJavadoc(DetailAST ast) {
	return (ast.getType() == TokenTypes.METHOD_DEF
	\|\| ast.getType() == TokenTypes.CTOR_DEF
	\|\| ast.getType() == TokenTypes.COMPACT_CTOR_DEF)
	&& (getMethodsNumberOfLine(ast) <= minLineCount
	\|\| AnnotationUtil.containsAnnotation(ast, allowedAnnotations));
	}

	private boolean isMissingJavadocAllowed(final DetailAST ast) {
	return allowMissingPropertyJavadoc
	&& (CheckUtil.isSetterMethod(ast) \|\| CheckUtil.isGetterMethod(ast))
	\|\| matchesSkipRegex(ast)
	\|\| isContentsAllowMissingJavadoc(ast);
	}

	public final void visitToken(DetailAST ast) {
	final Scope theScope = ScopeUtil.getScope(ast);
	if (shouldCheck(ast, theScope)) {
	final FileContents contents = getFileContents();
	final TextBlock textBlock = contents.getJavadocBefore(ast.getLineNo());

	if (textBlock == null && !isMissingJavadocAllowed(ast)) {
	log(ast, MSG_JAVADOC_MISSING);
	}

	private boolean shouldCheck(final DetailAST ast, final Scope nodeScope) {
	final Scope surroundingScope = ScopeUtil.getSurroundingScope(ast);

	return (excludeScope == null
	\|\| nodeScope != excludeScope
	&& surroundingScope != excludeScope)
	&& nodeScope.isIn(scope)
	&& surroundingScope.isIn(scope);
	}

Uh oh!

Conversation

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

Uh oh!

Check :-

Mutation

Explaination

Regression

Uh oh!

romani commented Aug 17, 2023

Uh oh!

Kevin222004 commented Aug 17, 2023

Uh oh!

Kevin222004 commented Aug 17, 2023

Uh oh!

github-actions bot commented Aug 17, 2023

Uh oh!

github-actions bot commented Aug 17, 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!

Vyom-Yadav Aug 22, 2023

Choose a reason for hiding this comment

Uh oh!

romani Aug 22, 2023

Choose a reason for hiding this comment

Uh oh!

Kevin222004 Aug 28, 2023

Choose a reason for hiding this comment

Uh oh!

romani commented Aug 29, 2023

Uh oh!

Kevin222004 commented Aug 29, 2023

Uh oh!

github-actions bot commented Aug 29, 2023

Uh oh!

Kevin222004 commented Aug 29, 2023

Uh oh!

github-actions bot commented Aug 29, 2023

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

rdiachenko left a comment

Choose a reason for hiding this comment

Uh oh!

rdiachenko commented Aug 30, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Kevin222004 commented Aug 17, 2023 •

edited

Loading