Issue #13109: Kill mutation for CustomImportOrderCheck 4 by Kevin222004 · Pull Request #13212 · checkstyle/checkstyle

Kevin222004 · 2023-06-13T13:21:37Z

Issue #13109: Kill mutation for CustomImportOrderCheck 4

check

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

Mutation

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

Lines 30 to 37 in 79d3c55

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

Explaination

This is setter for

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

Line 726 in 79d3c55

private String customImportOrderRules = "";

which is

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

Lines 809 to 817 in 79d3c55

    
           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; 
        
           }

we are not directly using this property hence all the rule will be first stored in

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

Line 720 in 79d3c55

private final List<String> customOrderRules = new ArrayList<>();

hence in all the code wherever we define the property all the logic has been written using

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

Line 720 in 79d3c55

private final List<String> customOrderRules = new ArrayList<>();

so no test case is possible

Regression

Diff Regression config: https://gist.githubusercontent.com/Kevin222004/2463f07cae06e0317712d3aae38b3d0b/raw/42a3cd2e7a12eb3b02ccac0906aace21ddaa02ce/custom.xml
Diff Regression projects: https://gist.githubusercontent.com/Kevin222004/9600f179b602d4c971bdb0a050099005/raw/360a95ed7bb60d7a0956e531199d484c4d6f6617/test-projects.properties
Report label: Report 1

Kevin222004 · 2023-06-13T13:21:55Z

Github, generate report

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

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

Kevin222004 · 2023-06-14T07:51:38Z

Github, generate report

github-actions · 2023-06-14T10:01:52Z

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

romani · 2023-06-14T14:09:21Z

Yes, we do not use user defined values, as we convert it to collection, and use only collection in logic.
Previously I considered as good practice to store value as it is defined by user. But I am ok to sacrifice this practice in favor of pitest.

romani

Ok to merge

rdiachenko · 2023-06-14T18:30:48Z

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

     */
    public final void setCustomImportOrderRules(final String inputCustomImportOrder) {
-        if (!customImportOrderRules.equals(inputCustomImportOrder)) {
+        if (!CUSTOM_IMPORT_ORDER_RULES.equals(inputCustomImportOrder)) {


I don't get it :) Why do we need CUSTOM_IMPORT_ORDER_RULES when we just compare the input with empty string in this place only?

We have fields as constants for default values of all users accessible properties.
But I agree it looked weird even for me.

If expression as inputCustomImportOrder.isEmpty will looks better.

Naming constant as DEFAULT_xxxxxx would make it more clear, but all other default value constants are not named like this. Should we rename all of them to be more explicit?

But end up in gray area of ... What is default value of property for this module, as for user it is String.
https://checkstyle.org/config_imports.html#CustomImportOrder_Properties

I see, so it's a Checkstyle's requirement that the user's property field must be present even though it is not actually used. This allows setter to be called and use incoming value in the way we want.

I don't see we use DEFAULT_xxx that much in other checks, but I agree that DEFAULT_CUSTOM_IMPORT_ORDER_RULES.equals(inputCustomImportOrder) is more readable than CUSTOM_IMPORT_ORDER_RULES.equals(inputCustomImportOrder)

Ok then I have changed name as DEFAULT_CUSTOM_IMPORT_ORDER_RULES

It is not a requirement, but end up our pattern for most of Checks.

@rdiachenko @romani ping

rdiachenko

lgtm

Vyom-Yadav

LGTM!

Kevin222004 force-pushed the cic4 branch from 4e1f51d to 7d64495 Compare June 14, 2023 07:45

Kevin222004 marked this pull request as ready for review June 14, 2023 07:51

Kevin222004 force-pushed the cic4 branch from 7d64495 to 0fa04dc Compare June 14, 2023 08:28

romani approved these changes Jun 14, 2023

View reviewed changes

romani requested review from Vyom-Yadav and rdiachenko June 14, 2023 14:10

romani assigned rdiachenko Jun 14, 2023

rdiachenko reviewed Jun 14, 2023

View reviewed changes

Issue checkstyle#13109: Kill mutation for CustomImportOrderCheck 4

ee9d13c

Kevin222004 force-pushed the cic4 branch from 0fa04dc to ee9d13c Compare June 15, 2023 21:22

rdiachenko approved these changes Jun 16, 2023

View reviewed changes

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

Vyom-Yadav approved these changes Jun 16, 2023

View reviewed changes

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

romani merged commit 7d35a52 into checkstyle:master Jun 19, 2023

Kevin222004 mentioned this pull request Jun 29, 2023

Resolve pitest survivals in modules #13109

Closed

40 tasks

smita1078 added a commit to smita1078/checkstyle that referenced this pull request Jan 25, 2025

Issue checkstyle#13212: remove OK from javadocblocktaglocation

307d994

MohamedMetwalli5 mentioned this pull request Feb 18, 2025

Issue #13213: removed //ok from InputRegexpCheck #16362

Merged

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

	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;
	}

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!

romani commented Jun 14, 2023

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

rdiachenko Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

romani Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

rdiachenko Jun 15, 2023

Choose a reason for hiding this comment

Uh oh!

Kevin222004 Jun 15, 2023

Choose a reason for hiding this comment

Uh oh!

romani Jun 16, 2023

Choose a reason for hiding this comment

Uh oh!

Kevin222004 Jun 19, 2023

Choose a reason for hiding this comment

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