Issue #13109: Kill mutation for CustomImport by Kevin222004 · Pull Request #13210 · checkstyle/checkstyle

Kevin222004 · 2023-06-13T13:08:50Z

Issue #13109: Kill mutation for CustomImport

Check:-

https://checkstyle.org/config_imports.html#CustomImportOrder

Mutation

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

Lines 3 to 19 in c7f3688

    
           <mutation unstable="false"> 
        
             <sourceFile>CustomImportOrderCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck</mutatedClass> 
        
             <mutatedMethod>&lt;init&gt;</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.MemberVariableMutator</mutator> 
        
             <description>Removed assignment to member variable samePackageMatchingDepth</description> 
        
             <lineContent>private int samePackageMatchingDepth = 2;</lineContent> 
        
           </mutation> 
        
           <mutation unstable="false"> 
        
             <sourceFile>CustomImportOrderCheck.java</sourceFile> 
        
             <mutatedClass>com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck</mutatedClass> 
        
             <mutatedMethod>getFirstDomainsFromIdent</mutatedMethod> 
        
             <mutator>org.pitest.mutationtest.engine.gregor.mutators.NonVoidMethodCallMutator</mutator> 
        
             <description>removed call to java/lang/StringBuilder::append</description> 
        
             <lineContent>builder.append(tokens.nextToken()).append(&apos;.&apos;);</lineContent> 
        
           </mutation>

Explaination

ok so there are 4 places where samePackageMatchingDepth is used let's talk about first in method addRulesToList

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java

Lines 1225 to 1234 in c7f3688

    
           else if (ruleStr.startsWith(SAME_PACKAGE_RULE_GROUP)) { 
        
               final String rule = ruleStr.substring(ruleStr.indexOf('(') + 1, 
        
                       ruleStr.indexOf(')')); 
        
               samePackageMatchingDepth = Integer.parseInt(rule); 
        
               if (samePackageMatchingDepth <= 0) { 
        
                   throw new IllegalArgumentException( 
        
                           "SAME_PACKAGE rule parameter should be positive integer: " + ruleStr); 
        
               } 
        
               customOrderRules.add(SAME_PACKAGE_RULE_GROUP); 
        
           }

know it will actually call by only a setter method which is setCustomImportOrderRules

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java

Lines 809 to 817 in c7f3688

    
           public final void setCustomImportOrderRules(final String inputCustomImportOrder) { 
        
               if (!customImportOrderRules.equals(inputCustomImportOrder)) { 
        
                   for (String currentState : GROUP_SEPARATOR_PATTERN.split(inputCustomImportOrder)) { 
        
                       addRulesToList(currentState); 
        
                   } 
        
                   customOrderRules.add(NON_GROUP_RULE_GROUP); 
        
               } 
        
               customImportOrderRules = inputCustomImportOrder; 
        
           }

know else if part only executes when condition ruleStr.startsWith(SAME_PACKAGE_RULE_GROUP) meet hence in this method user always defined such like SAME_PACKAGE(3)
know here we are reassigning samePackageMatchingDepth
with the value inside the bracket in SAME_PACKAGE hence whatever value of samePackageMatchingDepth doesn't matter because the further operation will be performed based on the new value.

append('.')

ok so basically the removal of append('.') is not creating an issue the reason is this method basically used in 2 methods 1) createSamePackageRegexp
https://github.com/checkstyle/checkstyle/blob/c7f3688f4380144bb712bee7ad6808cd075b327c/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java#L1249C1-L1252
which is actually called visitToken when

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java

Lines 844 to 849 in c7f3688

    
           public void visitToken(DetailAST ast) { 
        
               if (ast.getType() == TokenTypes.PACKAGE_DEF) { 
        
                   samePackageDomainsRegExp = createSamePackageRegexp( 
        
                           samePackageMatchingDepth, ast); 
        
               } 
        
               else {

ast is equal to PACKAGE_DEF.
so logically here samePackageDomainsRegExp will assign to the String which will be return by
our method getFirstDomainsFromIdent here if we remove
append('.') so let's suppose if
String with append('.') look like 'java.awt.button.'
look like javaawtbutton.

know the samePackageDomainsRegExp has a use case only in
getImportGroup

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java

Lines 1084 to 1090 in c7f3688

    
           else if (customOrderRules.contains(SAME_PACKAGE_RULE_GROUP)) { 
        
               final String importPathTrimmedToSamePackageDepth = 
        
                       getFirstDomainsFromIdent(samePackageMatchingDepth, importPath); 
        
               if (samePackageDomainsRegExp.equals(importPathTrimmedToSamePackageDepth)) { 
        
                   bestMatch.group = SAME_PACKAGE_RULE_GROUP; 
        
                   bestMatch.matchLength = importPath.length(); 
        
               }

at

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/CustomImportOrderCheck.java

Lines 1085 to 1087 in c7f3688

    
           final String importPathTrimmedToSamePackageDepth = 
        
                   getFirstDomainsFromIdent(samePackageMatchingDepth, importPath); 
        
           if (samePackageDomainsRegExp.equals(importPathTrimmedToSamePackageDepth)) {

in if statement know we are equaling samePackageDomainsRegExp with importPathTrimmedToSamePackageDepth and importPathTrimmedToSamePackageDepth will also call
getFirstDomainsFromIdent to get string so here if we remove append it will affect both
samePackageDomainsRegExp and importPathTrimmedToSamePackageDepth and remove doty from both so their will no issue appear here while comparing. apart from this, there is no usage of samePackageDomainsRegExp which will cause output/logging violation hence the test for append('.') is not possible.

and know rest two usage of samePackageMatchingDepth are here. while calling getFirstDomainsFromIdent
they always pass samePackageMatchingDepth with it. and that value of samePackageMatchingDepth will be updated
addRulesToList so it never be zero and update by the value provided by user in SAME_PACKAGE_RULE_GROUP
so no issue is their

Regression

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

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

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

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

Diff Regression config: https://gist.githubusercontent.com/Kevin222004/c77cb85c86c9676985cf8fb916591a94/raw/713375f8427445ec0297b481413a185f4afbe8dc/cic.xml
Diff Regression projects: https://gist.githubusercontent.com/Kevin222004/9600f179b602d4c971bdb0a050099005/raw/360a95ed7bb60d7a0956e531199d484c4d6f6617/test-projects.properties
Report label: New Report-2(2)

Kevin222004 · 2023-06-13T13:09:11Z

Github, generate report

github-actions · 2023-06-13T15:38:23Z

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

Kevin222004 · 2023-06-14T14:52:44Z

Github, generate report

github-actions · 2023-06-14T16:19:16Z

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

Kevin222004 · 2023-06-15T07:16:29Z

@romani I have tried to explain the whole thing, I hope i have covered all case, if you still have any doubt about it please ask me

Kevin222004 · 2023-06-15T07:17:24Z

Github, generate report

github-actions · 2023-06-15T08:35:30Z

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

Kevin222004 · 2023-06-15T08:47:40Z

Github, generate report

github-actions · 2023-06-15T10:53:19Z

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

Vyom-Yadav · 2023-06-16T09:58:58Z

@Kevin222004 Please put the final reports in the PR description.

Kevin222004 · 2023-06-16T10:47:04Z

@Vyom-Yadav done

Vyom-Yadav · 2023-06-16T11:04:20Z

@kevin Please generate a report with regex .*, I haven't seen the logic but regex matching everything is really valuable for checks using regular expressions as properties.

Kevin222004 · 2023-06-16T19:50:17Z

Github, generate report

github-actions · 2023-06-16T22:36:06Z

New Report-2(1):
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/1d4f30f_2023223348/reports/diff/index.html

Kevin222004 · 2023-06-17T04:51:44Z

Github, generate report

github-actions · 2023-06-17T05:54:12Z

New Report-2(2):
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/1d4f30f_2023055327/reports/diff/index.html

Kevin222004 · 2023-06-17T05:57:53Z

@Vyom-Yadav Reports are clean please go through the explanation

rdiachenko

lgtm

Vyom-Yadav

LGTM!

Kevin222004 force-pushed the cic2 branch from 6c04f08 to 1d4f30f Compare June 15, 2023 07:11

Kevin222004 marked this pull request as ready for review June 15, 2023 07:16

romani requested review from Vyom-Yadav, rdiachenko and romani June 15, 2023 13:35

romani assigned rdiachenko Jun 15, 2023

Issue checkstyle#13109: Kill mutation for CustomImport

f5a6bc6

Kevin222004 force-pushed the cic2 branch from 1d4f30f to f5a6bc6 Compare June 19, 2023 14:42

rdiachenko approved these changes Jun 20, 2023

View reviewed changes

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

Kevin222004 mentioned this pull request Jun 21, 2023

Issue #13109: Kill mutation for CustomImportOrderCheck 3 #13211

Closed

Vyom-Yadav approved these changes Jun 23, 2023

View reviewed changes

Vyom-Yadav assigned romani and unassigned Vyom-Yadav Jun 23, 2023

romani approved these changes Jun 24, 2023

View reviewed changes

romani merged commit dcedae6 into checkstyle:master Jun 24, 2023

Kevin222004 mentioned this pull request Jun 29, 2023

Resolve pitest survivals in modules #13109

Closed

40 tasks

	<mutation unstable="false">
	<sourceFile>CustomImportOrderCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck</mutatedClass>
	<mutatedMethod><init></mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.experimental.MemberVariableMutator</mutator>
	<description>Removed assignment to member variable samePackageMatchingDepth</description>
	<lineContent>private int samePackageMatchingDepth = 2;</lineContent>
	</mutation>

	<mutation unstable="false">
	<sourceFile>CustomImportOrderCheck.java</sourceFile>
	<mutatedClass>com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck</mutatedClass>
	<mutatedMethod>getFirstDomainsFromIdent</mutatedMethod>
	<mutator>org.pitest.mutationtest.engine.gregor.mutators.NonVoidMethodCallMutator</mutator>
	<description>removed call to java/lang/StringBuilder::append</description>
	<lineContent>builder.append(tokens.nextToken()).append('.');</lineContent>
	</mutation>

	else if (ruleStr.startsWith(SAME_PACKAGE_RULE_GROUP)) {
	final String rule = ruleStr.substring(ruleStr.indexOf('(') + 1,
	ruleStr.indexOf(')'));
	samePackageMatchingDepth = Integer.parseInt(rule);
	if (samePackageMatchingDepth <= 0) {
	throw new IllegalArgumentException(
	"SAME_PACKAGE rule parameter should be positive integer: " + ruleStr);
	}
	customOrderRules.add(SAME_PACKAGE_RULE_GROUP);
	}

	public final void setCustomImportOrderRules(final String inputCustomImportOrder) {
	if (!customImportOrderRules.equals(inputCustomImportOrder)) {
	for (String currentState : GROUP_SEPARATOR_PATTERN.split(inputCustomImportOrder)) {
	addRulesToList(currentState);
	}
	customOrderRules.add(NON_GROUP_RULE_GROUP);
	}
	customImportOrderRules = inputCustomImportOrder;
	}

	public void visitToken(DetailAST ast) {
	if (ast.getType() == TokenTypes.PACKAGE_DEF) {
	samePackageDomainsRegExp = createSamePackageRegexp(
	samePackageMatchingDepth, ast);
	}
	else {

	else if (customOrderRules.contains(SAME_PACKAGE_RULE_GROUP)) {
	final String importPathTrimmedToSamePackageDepth =
	getFirstDomainsFromIdent(samePackageMatchingDepth, importPath);
	if (samePackageDomainsRegExp.equals(importPathTrimmedToSamePackageDepth)) {
	bestMatch.group = SAME_PACKAGE_RULE_GROUP;
	bestMatch.matchLength = importPath.length();
	}

Uh oh!

Conversation

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

Uh oh!

github-actions bot commented Jun 13, 2023

Uh oh!

Kevin222004 commented Jun 14, 2023

Uh oh!

github-actions bot commented Jun 14, 2023

Uh oh!

Kevin222004 commented Jun 15, 2023

Uh oh!

Kevin222004 commented Jun 15, 2023

Uh oh!

github-actions bot commented Jun 15, 2023

Uh oh!

Kevin222004 commented Jun 15, 2023

Uh oh!

github-actions bot commented Jun 15, 2023

Uh oh!

Vyom-Yadav commented Jun 16, 2023

Uh oh!

Kevin222004 commented Jun 16, 2023

Uh oh!

Vyom-Yadav commented Jun 16, 2023

Uh oh!

Kevin222004 commented Jun 16, 2023

Uh oh!

github-actions bot commented Jun 16, 2023

Uh oh!

Kevin222004 commented Jun 17, 2023

Uh oh!

github-actions bot commented Jun 17, 2023

Uh oh!

Kevin222004 commented Jun 17, 2023

Uh oh!

rdiachenko 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 13, 2023 •

edited

Loading