runtime-suite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #llm #go #golang #android #machine-learning #deep-learning #java #kubernetes #openai #open-source

(★ 15)

A JUnit suite class that finds and filters test classes at runtime.

runtime-suite Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Runtime Suite

A Runtime Suite is a class that finds candidate test classes at runtime, filters the candidate classes and their test methods for inclusion in the suite, and runs the surviving methods under JUnit.

`RuntimeSuite` is designed to make it easy for you to write your own finders and filters, and to create suites that use them.

The project also includes these finders and filters:

* `ClassesOnClasspath` class finder: Finds all classes on the given classpaths.
 * `ListedClasses` class finder: Finds the specified classes. This can be useful to construct a fixed list of test classes to be filtered by information gathered at runtime.
 * `IncludeClasses` class filter: Passes each specified class; rejects all other classes.
 * `ExcludeClasses` class filter: Passes each class except those specified.
 * `IncludeClassCategories` class filter: Passes each class in any of the specified categories; rejects all other classes.
 * `ExcludeClassCategories` class filter: Rejects each class in any of the specified categories; passes all other classes.
 * `IncludeMethodCategories` method filter: Passes each test method in any of the specified categories; rejects all other test methods.
 * `ExcludeMethodCategories` method filter: Rejects each test method in any of the specified categories; passes all other test methods.

## Declaring Runtime Suites

Declare a class to be a runtime suite by annotating it with `@RunWith(RuntimeSuite.class)`. For example:

@RunWith(RuntimeSuite.class)
    public static class MyClassFinderSuite {
        ...
    	@Finder public ClassFinder classFinder1 = new AClassFinder();
    	@Finder public ClassFinder classFinder2 = new AnotherClassFinder();
    	...
    	@Filter public ClassFilter classFilter1 = new AClassFilter();
    	@Filter public ClassFilter classFilter2 = new AnotherClassFilter();
    	...
    }

Conceptually, `RuntimeSuite` does the following:

* Call each class finder and accumulate the resulting candidate classes.
* Call each class filter and retain the classes that survive all filters.
* Call each method filter and retain the methods that survive all filters.
* Yield the surviving test methods to JUnit to run.

## Declaring Class Finders in Suites

In your suite class, declare one or more fields of type `ClassFinder` annotated with the `@Finder` annotation. For example:

@RunWith(RuntimeSuite.class)
    public static class MyClassFinderSuite {
        // Declare class finders
    	@Finder public ClassFinder classFinder1 = new AClassFinder();
    	@Finder public ClassFinder classFinder2 = new AnotherClassFinder();
    	...
    }

## Declaring Class Filters in Suites

In your suite class, declare one or more fields of type `ClassFilter` annotated with the `@Filter` annotation.

@RunWith(RuntimeSuite.class)
    public static class MyClassFinderSuite {
        // Declare class finders
        ...

// Declare class filters
    	@Filter public ClassFilter classFilter1 = new AClassFilter();
    	@Filter public ClassFilter classFilter2 = new AnotherClassFilter();
    	...
    }

## Declaring Method Filters in Suites

In your suite class, declare one or more fields of type `MethodFilter` annotated with the `@Filter` annotation.

@RunWith(RuntimeSuite.class)
    public static class MyClassFinderSuite {
        // Declare class finders and class filters
        ...
        
        // Declare method filters
        @Filter public MethodFilter methodFilter1 = new AMethodFilter();
        @Filter public Methodilter methodFilter2 = new AnotherMethodFilter();
        ...
    }

## Writing a Class Finder class

Write each class finder class to implement the `ClassFinder` interface:

public interface ClassFinder {
        Collection<Class<?>> find();
    }

`RuntimeSuite` calls the `find()` method to find classes to run.

Write your `find()` method to find test classes to be considered as candidates for inclusion in the suite. Return the list as the return value. `RuntimeSuite` will gather all candidate classes returned from all finders, filter them using the declared filters, and run the tests that survive the filters.

## Writing a Class Filter class

Write each class filter class to implement the `ClassFilter` interface:

public interface ClassFilter {
        boolean passes(Class<?> candidateClass);
    }

`RuntimeSuite` calls the `passes()` method once for each candidate test class.

Write your `passed()` method to determine whether to include the given class in the suite. Return `true` if the filter passes the class, `false` if the filter rejects the class. If this filter passes the class, `RuntimeSuite` will subject the class to other filters (if any are declared). The classes that survive all filters are considered part of the suite.

## Declaring Method Filters

Write each method filter class to implement the `MethodFilter` interface:

public interface MethodFilter {
        boolean passes(Method candidateMethod);
    }

Write your `passed()` method to determine whether to include the given method in the suite. Return `true` if the filter passes the method, `false` if the filter rejects the method. If this filter passes the method, `RuntimeSuite` will subject the method to other filters (if any are declared). The methods that survive all filters are considered part of the suite.

runtime-suite

runtime-suite Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

runtime-suite

runtime-suite Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README