dev.gradleplugins.grava.testing.util

Class ProjectTestUtils

java.lang.Object

dev.gradleplugins.grava.testing.util.ProjectTestUtils

public final class ProjectTestUtils
extends java.lang.Object

Test utilities to access various Gradle services useful during testing as well as Project instances.

Method Summary

Modifier and Type	Method and Description
static org.gradle.api.Project	createChildProject(org.gradle.api.Project parent) Creates a child project instance with the specified parent project.
static org.gradle.api.Project	createChildProject(org.gradle.api.Project parent, java.lang.String name) Creates a child project instance with the specified parent project and name.
static org.gradle.api.Project	createChildProject(org.gradle.api.Project parent, java.lang.String name, java.io.File projectDirectory) Creates a child project instance with the specified parent project, name and directory.
static org.gradle.api.Project	createChildProject(org.gradle.api.Project parent, java.lang.String name, java.nio.file.Path projectDirectory) Creates a child project instance with the specified parent project, name and directory.
static org.gradle.api.artifacts.Dependency	createDependency(java.lang.Object notation) Creates a Dependency instance for the specified notation.
static org.gradle.api.Project	createRootProject(java.io.File rootDirectory) Creates a new root project instance for the given project directory.
static org.gradle.api.Project	createRootProject(java.nio.file.Path rootDirectory) Creates a new root project instance for the given project directory.
static org.gradle.api.Project	evaluate(org.gradle.api.Project project) Force the evaluation of the specified Gradle project.
static org.gradle.api.model.ObjectFactory	objectFactory() Returns an functional ObjectFactory instance.
static org.gradle.api.provider.ProviderFactory	providerFactory() Returns a functional ProviderFactory instance.
static org.gradle.api.Project	rootProject() Creates a new root project instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

objectFactory

public static org.gradle.api.model.ObjectFactory objectFactory()

Returns an functional ObjectFactory instance. The project associated to the returned ObjectFactory is unspecified meaning tests should not depend on it. This particularity means that each file related operation that would spawn from this ObjectFactory will be resolved from an unspecified, but valid, file system location. If the file resolution needs to be specified, create a Project instance using createRootProject(File).

Returns:

a ObjectFactory instance, never null

providerFactory

public static org.gradle.api.provider.ProviderFactory providerFactory()

Returns a functional ProviderFactory instance.

Returns:

a ProviderFactory instance, never null

createDependency

public static org.gradle.api.artifacts.Dependency createDependency(java.lang.Object notation)

Creates a Dependency instance for the specified notation.

Parameters:

notation - dependency notation, must not be null

Returns:

a Dependency instance for the notation, never null

rootProject

public static org.gradle.api.Project rootProject()

Creates a new root project instance.

Returns:

a new Project instance, never null

createRootProject

public static org.gradle.api.Project createRootProject(java.io.File rootDirectory)

Creates a new root project instance for the given project directory.

Parameters:

rootDirectory - a project directory for the root project, must not be null

Returns:

a new Project instance, never null

createRootProject

public static org.gradle.api.Project createRootProject(java.nio.file.Path rootDirectory)

Creates a new root project instance for the given project directory.

Parameters:

rootDirectory - a project directory for the root project, must not be null

Returns:

a new Project instance, never null

createChildProject

public static org.gradle.api.Project createChildProject(org.gradle.api.Project parent)

Creates a child project instance with the specified parent project. The child project name and directory defaults to test and

${parent.projectDir}/test

respectively.

Parameters:

parent - the parent project for the child project, must not be null

Returns:

a new child Project instance of the specified parent project, never null

createChildProject

public static org.gradle.api.Project createChildProject(org.gradle.api.Project parent,
                                                        java.lang.String name)

Creates a child project instance with the specified parent project and name. The child project directory defaults to

${parent.projectDir}/${name}

.

Parameters:

parent - the parent project for the child project, must not be null

name - the child project name, must not be null

Returns:

a new child Project instance of the specified parent project, never null

createChildProject

public static org.gradle.api.Project createChildProject(org.gradle.api.Project parent,
                                                        java.lang.String name,
                                                        java.io.File projectDirectory)

Creates a child project instance with the specified parent project, name and directory.

Parameters:

parent - the parent project for the child project, must not be null

name - the child project name, must not be null

projectDirectory - the child project directory, must not be null

Returns:

a new child Project instance of the specified parent project, never null

createChildProject

public static org.gradle.api.Project createChildProject(org.gradle.api.Project parent,
                                                        java.lang.String name,
                                                        java.nio.file.Path projectDirectory)

Creates a child project instance with the specified parent project, name and directory.

Parameters:

parent - the parent project for the child project, must not be null

name - the child project name, must not be null

projectDirectory - the child project directory, must not be null

Returns:

a new child Project instance of the specified parent project, never null

evaluate

public static org.gradle.api.Project evaluate(org.gradle.api.Project project)

Force the evaluation of the specified Gradle project. It will execute all Project.afterEvaluate(Action) configuration action. Note: It is generally preferable to write functional test using Gradle Runner Kit to test after evaluate behavior. Implementation Note: It uses a call to an internal Gradle API, e.g. ProjectInternal.evaluate().

Parameters:

project - the project to evaluate, must not be null

Returns:

the specified project, never null