How to use boolean expressions in MatchXpath

[polyanskih]

I need to find methods (marked with @Test annotation) which has @Retry annotation on it and groups field doesn't have RETRY group inside (or vice versa)

public class ExampleTests {

    @Test(
            description = "This is test with retry annotation and group",
            groups = {BASE, RETRY}
    )
    @Retry
    public void testWithRetryAnnotationAndGroup() {

    }

    @Test(
            description = "This is test with retry annotation but without retry group",
            groups = {BASE}
    )
    @Retry
    public void testWithoutRetryGroup() {

    }

    @Test(
            description = "This is test with retry group but without retry annotation",
            groups = {BASE, RETRY}
    )
    public void testWithoutRetryAnnotation() {

    }
}

in this example, I need to find the last two methods:

• testWithoutRetryGroup, because it has @Retry annotation on it, and doesn't have group RETRY inside groups property of @Test annotation
• testWithoutRetryAnnotation, because it has group RETRY, and doesn't have @Retry annotation

Could you please advise me how to combine queries through boolean expression?

[nrmancuso]

Please extend your example to contain code and share your entire MatchXpath module(s).

[polyanskih]

and here is queries which I use to find both conditions separately

query to find method with @Retry annotation

<property name="query" value="//CLASS_DEF[./IDENT[ends-with(@text, 'Tests')]]/OBJBLOCK/METHOD_DEF/MODIFIERS/ANNOTATION/IDENT[@text='Retry']"/>

query to find method with @Test annotation, but without RETRY inside groups property

<property name="query" value="//METHOD_DEF/MODIFIERS//ANNOTATION[./IDENT[@text='Test']]/ANNOTATION_MEMBER_VALUE_PAIR[./IDENT[@text='groups']]/ANNOTATION_ARRAY_INIT[count(EXPR/IDENT[@text='RETRY'])=0]"/>

module example (here it is with both queries and will not work)

        <module name="MatchXpath">
            <property name="id" value="RetryAnnotationShouldBeWithRetryGroup" />
            <property name="query" value="//CLASS_DEF[./IDENT[ends-with(@text, 'Tests')]]/OBJBLOCK/METHOD_DEF/MODIFIERS/ANNOTATION/IDENT[@text='Retry']"/>
            <property name="query" value="//METHOD_DEF/MODIFIERS//ANNOTATION[./IDENT[@text='Test']]/ANNOTATION_MEMBER_VALUE_PAIR[./IDENT[@text='groups']]/ANNOTATION_ARRAY_INIT[count(EXPR/IDENT[@text='RETRY'])=0]"/>
            <message key="matchxpath.match" value="Test with @Retry annotation should have RETRY group"/>
        </module>

[polyanskih]

this is how I use checkstyle

java -classpath checkstyle-10.13.0-all.jar  com.puppycrawl.tools.checkstyle.Main  -c ../config/checkstyle/checkstyle.xml ExampleTests.java

[polyanskih]

if I use first query (to find methods with @Retry annotation), it will output this

[WARN] ExampleTests.java:11:6: Test with @Retry annotation should have RETRY group [RetryAnnotationShouldBeWithRetryGroup]
[WARN] ExampleTests.java:20:6: Test with @Retry annotation should have RETRY group [RetryAnnotationShouldBeWithRetryGroup]

that's OK, it finds testWithRetryAnnotationAndGroup and testWithoutRetryGroup methods

[polyanskih]

if I use second query (to find methods without RETRY in groups property of @Test), it will output this

[WARN] ExampleTests.java:18:22: Test with @Retry annotation should have RETRY group [RetryAnnotationShouldBeWithRetryGroup]

that's OK, it finds testWithoutRetryGroup method

[polyanskih]

but the question is, how to combine this two checks to find methods (marked with @Test annotation) which has @Retry annotation on it and groups property doesn't have RETRY group inside (or vice versa) ?

sorry, I've tried multiple ways to use boolean expressions here and can't find the right one, also documentation/stackoverflow/Googling doesn't help, seems I'm not familiar with syntax or even stupid, please help :)

[nrmancuso]

I can definitely help the next time I am able to reach my laptop. Few things to consider in the meantime:

• If I understand what you want to do correctly, ANDing these two expressions you have created won't help you, because there is no intersection of warnings in your examples.
• Please consolidate all your information (concisely) into your original post to make it easier for others to read in the future.

[nrmancuso]

@polyanskih this should do it:

➜  src cat ExampleTests.java 
public class ExampleTests {

    private static final String BASE = "base";
    private static final String RETRY = "retry";

    @Test(
            description = "This is test with retry annotation and group",
            groups = {BASE, RETRY}
    )
    @Retry
    public void testWithRetryAnnotationAndGroup() {

    }

    @Test(
            description = "This is test with retry annotation but without retry group",
            groups = {BASE}
    )
    @Retry
    public void testWithoutRetryGroup() {

    }

    @Test(
            description = "This is test with retry group but without retry annotation",
            groups = {BASE, RETRY}
    )
    public void testWithoutRetryAnnotation() {

    }
}

@interface Retry {
}
@interface Test {
    String description();
    String[] groups();
}

➜  src javac ExampleTests.java 

➜  src cat config.xml 
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
  <module name="TreeWalker">
        <module name="MatchXpath">
            <property name="id" value="RetryAnnotationShouldBeWithRetryGroup" />
            <property name="query" value="
                //CLASS_DEF[./IDENT[ends-with(@text, 'Tests')]]/OBJBLOCK/METHOD_DEF/MODIFIERS
                  [./ANNOTATION/IDENT[@text='Retry']
                    and not(./ANNOTATION[./IDENT[@text='Test']]//ANNOTATION_MEMBER_VALUE_PAIR
                      [./IDENT[@text='groups']]/ANNOTATION_ARRAY_INIT//EXPR/IDENT[@text='RETRY'])
                  or ./ANNOTATION[./IDENT[@text='Test']]//ANNOTATION_MEMBER_VALUE_PAIR[./IDENT
                      [@text='groups']]/ANNOTATION_ARRAY_INIT//EXPR/IDENT[@text='RETRY']
                    and not(./ANNOTATION/IDENT[@text='Retry'])
            ]"/>
            <message key="matchxpath.match" value="Test with @Retry annotation should have RETRY group"/>
        </module>
  </module>
</module>

➜  src java -jar checkstyle-10.13.0-all.jar -c config.xml ExampleTests.java
Starting audit...
[ERROR] /home/nick/IdeaProjects/tester/src/ExampleTests.java:15:5: Test with @Retry annotation should have RETRY group [RetryAnnotationShouldBeWithRetryGroup]
[ERROR] /home/nick/IdeaProjects/tester/src/ExampleTests.java:24:5: Test with @Retry annotation should have RETRY group [RetryAnnotationShouldBeWithRetryGroup]
Audit done.
Checkstyle ends with 2 errors.

[polyanskih]

thank you so much @nrmancuso, this is just what I needed!
I will edit (a little later) the original post
thank you very much for your help and for your time :)

[polyanskih]

initial description updated