Package com.soebes.itf.jupiter.maven

Class MavenProjectResult

java.lang.Object

com.soebes.itf.jupiter.maven.MavenProjectResult

@API(status=EXPERIMENTAL,
     since="0.12.0")
public class MavenProjectResult
extends Object

Author:

Karl Heinz Marbaise

Implementation Note:

The return types of the methods: getTargetProjectDirectory(), getTargetBaseDirectory() and getTargetCacheDirectory() has been changed from File into Path in release 0.12.0.

Constructor Summary

Constructors

Constructor	Description
MavenProjectResult(Path targetBaseDirectory, Path targetProjectDirectory, Path targetCacheDirectory, org.apache.maven.model.Model model)	The source structure looks usually like this:

Method Summary

Modifier and Type	Method	Description
org.apache.maven.model.Model	getModel()
Path	getTargetBaseDirectory()
Path	getTargetCacheDirectory()
Path	getTargetProjectDirectory()

Methods inherited from class java.lang.Object

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

Constructor Details

MavenProjectResult

public MavenProjectResult(Path targetBaseDirectory,
 Path targetProjectDirectory,
 Path targetCacheDirectory,
 org.apache.maven.model.Model model)

The source structure looks usually like this:

   src/test/java/../
      +--- FirstIT.java
             +--- test_case_one
   src/test/resources-its/.../
      +--- FirstIT/
              +--- test_case_one
                      +--- src/...
                      +--- pom.xml
 

during the execution of the integration tests the following will be generated:

   target/maven-it/
      .../FirstIT
           +--- test_case_one            <-- targetBaseDirectory
                   +--- .m2/             <-- targetCacheDirectory
                   +--- project          <-- targetProjectDirectory
                           +--- src/
                           +--- pom.xml  <-- model
                   +--- mvn-stdout.log
                   +--- mvn-stderr.log
 

Parameters:

targetBaseDirectory - This represents the root directory of test case in target directory.

targetProjectDirectory - This represents the root directory in the target structure.

targetCacheDirectory - This represents the root directory in the cache structure.

model - The model read from pom.xml file in the target structure.

Implementation Note:

Currently we only read the single pom.xml file. An existing multimodul structure with it's pom.xml files will not being read.

Method Details

getTargetBaseDirectory

@API(status=EXPERIMENTAL,
     since="0.12.0")
public Path getTargetBaseDirectory()

Returns:

The base directory of the test case within target directory.

Since:

0.12.0 The return type has been changed from File into Path

getTargetProjectDirectory

@API(status=EXPERIMENTAL,
     since="0.12.0")
public Path getTargetProjectDirectory()

Returns:

The project directory of the test case.

Since:

0.12.0 The return type has been changed from File into Path

getTargetCacheDirectory

@API(status=EXPERIMENTAL,
     since="0.10.0")
public Path getTargetCacheDirectory()

Returns:

The cache directory of the test case.

Since:

0.12.0 The return type has been changed from File into Path

getModel

public org.apache.maven.model.Model getModel()