JUnit 4 - How to ignore all package with the tests?

Question

I run my JUnit and Mockito tests in a big project. I use them for testing my server-side components that connect to web-service. All these connections require some time and it is not neccessary for them to be executed during the build.

I would like that my tests would be ignored during the build.

I have about 10 classes with tests. So the obvious way is to annotate all the classes with @Ignore. However I should do this every time I commit my code to the project and then re-annotate all tests. Not the very best solution I think.

So is this possible somehow simply ignore all package (let say com.example.tests) with the tests? Or what might be the solution to ignore tests in the build in a simple way?

Answer 1

You can mention on your build.gradle what packages to exclude from tests

test {
    exclude '**/*IntegrationTest*'
}

same for maven:

must consider this notation:

By default, the Surefire Plugin will automatically include all test classes with the following wildcard patterns:

"**/Test*.java" - includes all of its subdirectories and all Java filenames that start with "Test".
"**/*Test.java" - includes all of its subdirectories and all Java filenames that end with "Test".
"**/*Tests.java" - includes all of its subdirectories and all Java filenames that end with "Tests".
"**/*TestCase.java" - includes all of its subdirectories and all Java filenames that end with "TestCase".


<project>
  [...]
 <build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.20</version>
            <configuration>
                <excludes>
                <exclude>*com.example.tests*/*Test.java</exclude>
                </excludes>
            </configuration>
        </plugin>
    </plugins>
</build>
  [...]
</project>

Another option is the old

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.19.1</version>
    <configuration>
        <skipTests>true</skipTests>
    </configuration>
</plugin>

or even when call it

mvn install -DskipTests

Answer 2

Using Categories seems to be an option that can come in handy

This is how you may add these to your Gradle script.

test {
    useJUnit {
        includeCategories 'org.gradle.junit.CategoryA'
        excludeCategories 'org.gradle.junit.CategoryB'
    }
}

A sample can be found here, adding it for a quick reference.

public interface FastTests 
{ 
    /* category marker */ 
}
public interface SlowTests 
{ 
    /* category marker */ 
}

public class A 
{
    @Category(SlowTests.class)
    @Test public void a() 
    {
    }
}

@Category(FastTests.class})
public class B 
{
    @Test public void b() 
    {
    }
}

@RunWith(Categories.class)
@IncludeCategory(SlowTests.class)
@ExcludeCategory(FastTests.class)
@SuiteClasses({ A.class, B.class })
public class SlowTestSuite 
{
}

Answer 3

I have found the solution for my case.

To disable all the tests during the build or even in any other context that you want the Spring annotation @IfProfileValue can be used. All tests with this annotation will be executed only in wanted context.

The example is this:

@IfProfileValue(name="enableTests", value="true")
public class DemoApplicationTests {

    @Test
    public void contextLoads() {

    ...

    }

}

In my IDE I can edit the configuration and set the variable by:

-DenableTests=true

This annotation can be used on the level of a class or on the level of a test also. All classes or tests annotated with such @IfProfileValue will be executed only in my environment and will be ignored during the build.

This approach is the best for me because it is not convenient in my project to change main pom.xml for my own test needs.

Addition. Also in Spring or Spring Boot you should add Runner. For example in Spring:

@RunWith(SpringJUnit4ClassRunner.class)
@IfProfileValue(name="enableTests", value="true")
@ContextConfiguration(classes = { YourClassConfig.class })

YourClassConfig might be empty:

@Configuration
public class YourClassConfig {
}