Junit5: @IncludePackages: specify the packages for test suite

@IncludePackages specifies the packages to be included when running a test suite on the JUnit Platform.

 

For example, below snippet runs all the test cases in the package "com.sample.app.dummy" and its subpackages.

@RunWith(JUnitPlatform.class)
@SuiteDisplayName("JUnit Platform Suite Demo")
@SelectPackages({"com.sample.app.dummy"})
public class IncludePackagesDemo {

}

What if you want to selectively run the packages?

You can use @IncludePackages and @ExcludePackages to explicitly include and exclude the packages.

 

Example

@RunWith(JUnitPlatform.class)
@SuiteDisplayName("JUnit Platform Suite Demo")
@SelectPackages({"com.sample.app.dummy"})
@IncludePackages({"com.sample.app.dummy.dummy1"})
public class IncludePackagesDemo {

}

Above snippet execute below test classes.

 

a.   Dummy1D1Test

b.   Dummy1D2Test

c.    Dummy1Test

 

Find the below working application.

 

DummyTest.java

package com.sample.app.dummy;

import static org.junit.jupiter.api.Assertions.assertTrue;

import org.junit.jupiter.api.Test;

public class DummyTest {

    @Test
    public void test1() {
        assertTrue(true);
    }
}

Dummy1Test.java

package com.sample.app.dummy.dummy1;

import static org.junit.Assert.assertTrue;

import org.junit.jupiter.api.Test;

public class Dummy1Test {
    @Test
    public void test1() {
        assertTrue(true);
    }
}

Dummy1D1Test.java

package com.sample.app.dummy.dummy1.d1;

import static org.junit.Assert.assertTrue;

import org.junit.jupiter.api.Test;

public class Dummy1D1Test {

    @Test
    public void test1() {
        assertTrue(true);
    }

}

Dummy1D2Test.java

package com.sample.app.dummy.dummy1.d2;

import static org.junit.Assert.assertTrue;

import org.junit.jupiter.api.Test;

public class Dummy1D2Test {
    @Test
    public void test1() {
        assertTrue(true);
    }
}

Dummy2D1Test.java

package com.sample.app.dummy.dummy2.d1;

import static org.junit.Assert.assertTrue;

import org.junit.jupiter.api.Test;

public class Dummy2D1Test {
    @Test
    public void test1() {
        assertTrue(true);
    }
}

IncludePackagesDemo.java

package com.sample.app.suite;

import org.junit.platform.runner.JUnitPlatform;
import org.junit.platform.suite.api.IncludePackages;
import org.junit.platform.suite.api.SelectPackages;
import org.junit.platform.suite.api.SuiteDisplayName;
import org.junit.runner.RunWith;

@RunWith(JUnitPlatform.class)
@SuiteDisplayName("JUnit Platform Suite Demo")
@SelectPackages({"com.sample.app.dummy"})
@IncludePackages({"com.sample.app.dummy.dummy1"})
public class IncludePackagesDemo {

}

Run ‘IncludePackagesDemo’ class, you will see the executed test methods result in junit report window.

Note

By default, @SelectPackages will only include test classes whose names either begin with Test or end with Test or Tests.

Previous                                                    Next                                                    Home