de.qfs.apps.qftest.junit5

Class QFTest

java.lang.Object

de.qfs.apps.qftest.junit5.QFTest

All Implemented Interfaces:

java.lang.Iterable<DynamicNode>

public class QFTest
extends java.lang.Object
implements java.lang.Iterable<DynamicNode>

This class provides the annotation QFTest.Test, which can be used to embed QF-Test test suites and/or run logs in JUnit 5 Tests.

Technically, QF-test is started in batch mode to execute the specified test suites, and the generated run logs are then transformed into the JUnit 5 test results.

Example:

 import de.qfs.apps.qftest.junit5.QFTest

 public class QFTestDummyTest
 {
     @QFTest.Test
     QFTest blaTest() throws Exception {
         return QFTest.runSuites("/tmp/err.qft#unbenannt.unbenannt2",
                                 "/tmp/test.qft",
                                 "initializeTests_2203112117_own_w10t6_3.qzp");
     }
 }
 

To include the QFTest tests into your JUnit 5 test run, include these libs from the QF-Test installation directory into your test run classpath:

• lib/truezip.jar
• qflib/qflib.jar
• qflib/qfshared.jar
• qflib/qftest.jar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QFTest.Error
static class	QFTest.SystemProperties System properties which can be used to globally modify parameters for the QF-Test run.
static interface	QFTest.Test The annotation to use with a JUnit 5 test method, which returns an object of QFTest as result.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QFTest()

Method Summary

Modifier and Type	Method and Description
static java.io.File	getQFTestBinary() Helper method to return the QF-Test binary used to run th QF-Test tests.
static java.io.File	getVersionDir() Helper method to get the property of "qftest:dir.version".
java.util.Iterator<DynamicNode>	iterator()
static boolean	openReport(java.io.File reportPath) Helper method to open a report in the browser.
static boolean	openReport(java.nio.file.Path reportPath) Helper method to open a report in the browser.
static boolean	openReport(java.lang.String reportPath) Helper method to open a report in the browser.
QFTest	paths(java.lang.String... testsuitePaths) Add the specified test suites or run logs to the test run.
static QFTest	runSuite(java.io.File testsuite) Run the specified test suite during the JUnit test run.
static QFTest	runSuite(java.nio.file.Path testsuite) Run the specified test suite during the JUnit test run.
static QFTest	runSuite(java.lang.String testsuitePath) Run the specified test suite during the JUnit test run.
static QFTest	runSuites(java.io.File... testsuites) Run the specified test suites during the JUnit test run.
static QFTest	runSuites(java.nio.file.Path... testsuites) Run the specified test suites during the JUnit test run.
static QFTest	runSuites(java.lang.String... testsuitePaths) Run the specified test suites during the JUnit test run.
static java.lang.String	startProcess(java.lang.String... args) Deprecated.
static java.lang.String	startQFTestProcess(java.lang.String... args) Helper method, starts a QF-Test process with the given arguments and returns the process output.
QFTest	suites(java.lang.String... testsuitePaths) Add the specified test suites to the test run.
QFTest	withArgument(java.lang.String argument) Adds a QF-Test arguments to the test run.
QFTest	withArguments(java.lang.String... arguments) Adds QF-Test arguments to the test run.
QFTest	withLicense(java.io.File licenseFile) Specifies an explicit license to use for the test run (similar to the -license argument).
QFTest	withLicense(java.nio.file.Path licenseFile) Specifies an explicit license to use for the test run (similar to the -license argument).
QFTest	withLicense(java.lang.String license) Specifies an explicit license to use for the test run.
QFTest	withOption(java.lang.String optionName, java.lang.String optionValue) Sets a QF-Test option for the test run.
QFTest	withOptions(java.lang.String... optionNamesAndValues) Sets multiple QF-Test option for the test run.
QFTest	withReport() Enables report generation after the tests have been executed.
QFTest	withReport(java.io.File reportDir, java.lang.String... reportArguments) Enables report generation after the tests have been executed.
QFTest	withReport(java.nio.file.Path reportDir, java.lang.String... reportArguments) Enables report generation after the tests have been executed.
QFTest	withReport(java.lang.String reportDir, java.lang.String... reportArguments) Enables report generation after the tests have been executed.
QFTest	withReportOpen() If specified, a report is generated after the tests are run, and the report will be opened in the browser, if possible.
QFTest	withRunLogPath(java.io.File runLogDirOrFile) Specify the directory where created QF-Test run logs will be stored, or the run log file directly.
QFTest	withRunLogPath(java.io.File runLogDirOrFile, boolean keepSuccessfullRunLog) Specify the directory where created QF-Test run logs will be stored, or the run log file directly.
QFTest	withRunLogPath(java.nio.file.Path runLogDirOrFile) Specify the directory where created QF-Test run logs will be stored, or the run log file directly.
QFTest	withRunLogPath(java.nio.file.Path runLogDirOrFile, boolean keepSuccessfullRunLog) Specify the directory where created QF-Test run logs will be stored, or the run log file directly.
QFTest	withRunLogPath(java.lang.String runLogPathname) Specify the directory where created QF-Test run logs will be stored, or the run log file directly.
QFTest	withRunLogPath(java.lang.String runLogPathname, boolean keepSuccessfullRunLog) Specify the directory where created QF-Test run logs will be stored, or the run log file directly.
QFTest	withVariable(java.lang.String variableName, java.lang.String variableValue) Sets a QF-Test variable for the test run.
QFTest	withVariables(java.lang.String... variableNamesAndValues) Sets multiple QF-Test variables for the test run.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

QFTest

protected QFTest()

Method Detail

runSuite

public static QFTest runSuite(java.lang.String testsuitePath)

Run the specified test suite during the JUnit test run.

Parameters:

testsuitePath - The path of the test suite to run or run log to include

Returns:

An instance of QFTest, which can be returned by a test method to include the test suites into the JUnit 5 test run

runSuite

public static QFTest runSuite(java.io.File testsuite)

Run the specified test suite during the JUnit test run.

Parameters:

testsuites - The test suite to run or run log to include

Returns:

An instance of QFTest, which can be returned by a test method to include the test suites into the JUnit 5 test run

runSuite

public static QFTest runSuite(java.nio.file.Path testsuite)

Run the specified test suite during the JUnit test run.

Parameters:

testsuite - The path of the test suite to run or run log to include

Returns:

An instance of QFTest, which can be returned by a test method to include the test suites into the JUnit 5 test run

runSuites

public static QFTest runSuites(java.lang.String... testsuitePaths)

Run the specified test suites during the JUnit test run.

Parameters:

testsuitePaths - The paths of the test suites to run or run logs to include

Returns:

An instance of QFTest, which can be returned by a test method to include the test suites into the JUnit 5 test run

runSuites

public static QFTest runSuites(java.io.File... testsuites)

Run the specified test suites during the JUnit test run.

Parameters:

testsuites - The test suites to run or run logs to include

Returns:

An instance of QFTest, which can be returned by a test method to include the test suites into the JUnit 5 test run

runSuites

public static QFTest runSuites(java.nio.file.Path... testsuites)

Run the specified test suites during the JUnit test run.

Parameters:

testsuites - The paths of the test suites to run or run logs to include

Returns:

An instance of QFTest, which can be returned by a test method to include the test suites into the JUnit 5 test run

getQFTestBinary

public static java.io.File getQFTestBinary()

Helper method to return the QF-Test binary used to run th QF-Test tests.

Returns:

The detected binary file

startQFTestProcess

public static java.lang.String startQFTestProcess(java.lang.String... args)
                                           throws de.qfs.lib.util.ProcessManager.RunProcessException

Helper method, starts a QF-Test process with the given arguments and returns the process output. The STDERR and STDOUT is also forwarded to the current output pipes.

Parameters:

args - The arguments to start QF-Test with

Returns:

The process output

Throws:

de.qfs.lib.util.ProcessManager.RunProcessException - Thrown if an error occurs during execution

startProcess

@Deprecated
public static java.lang.String startProcess(java.lang.String... args)
                                                 throws de.qfs.lib.util.ProcessManager.RunProcessException

Deprecated.

Throws:

de.qfs.lib.util.ProcessManager.RunProcessException

getVersionDir

public static java.io.File getVersionDir()

Helper method to get the property of "qftest:dir.version".

Returns:

The value of "qftest:dir.version"

openReport

public static boolean openReport(java.lang.String reportPath)

Helper method to open a report in the browser.

Parameters:

reportPath - The path to the report directory or HTML file

Returns:

true, when the report could be opened, false otherwise

openReport

public static boolean openReport(java.io.File reportPath)

Helper method to open a report in the browser.

Parameters:

reportPath - The file of the report directory or HTML file

Returns:

true, when the report could be opened, false otherwise

openReport

public static boolean openReport(java.nio.file.Path reportPath)

Helper method to open a report in the browser.

Parameters:

reportPath - The path to the report directory or HTML file

Returns:

true, when the report could be opened, false otherwise

paths

public QFTest paths(java.lang.String... testsuitePaths)

Add the specified test suites or run logs to the test run.

Parameters:

testsuitePaths - the files to add to the test run

Returns:

this for method chaining

suites

public QFTest suites(java.lang.String... testsuitePaths)

Add the specified test suites to the test run.

Parameters:

testsuitePaths - the files to add to the test run

Returns:

this for method chaining

withArgument

public QFTest withArgument(java.lang.String argument)

Adds a QF-Test arguments to the test run.

Parameters:

argument - The QF-Test argument to add

Returns:

this for method chaining

withArguments

public QFTest withArguments(java.lang.String... arguments)

Adds QF-Test arguments to the test run.

Parameters:

arguments - The QF-Test arguments to add

Returns:

this for method chaining

withLicense

public QFTest withLicense(java.lang.String license)

Specifies an explicit license to use for the test run. If used with a filename, it is identical to the -license argument, but you can also provide directly the text content of the license file.

Parameters:

license - The QF-Test license to use

Returns:

this for method chaining

withLicense

public QFTest withLicense(java.io.File licenseFile)

Specifies an explicit license to use for the test run (similar to the -license argument).

Parameters:

license - The QF-Test license file to use

Returns:

this for method chaining

withLicense

public QFTest withLicense(java.nio.file.Path licenseFile)

Specifies an explicit license to use for the test run (similar to the -license argument).

Parameters:

license - The QF-Test license file to use

Returns:

this for method chaining

withOption

public QFTest withOption(java.lang.String optionName,
                         java.lang.String optionValue)

Sets a QF-Test option for the test run. The option name can be either the name from the config file, or the Options constant name

Parameters:

optionName - The name of the option to set

optionValue - The option value to use

Returns:

this for method chaining

withOptions

public QFTest withOptions(java.lang.String... optionNamesAndValues)

Sets multiple QF-Test option for the test run. The option names can be either the names from the config file, or the Options constant names

Parameters:

optionNamesAndValues - Option names and values alternating.

Returns:

this for method chaining

withVariable

public QFTest withVariable(java.lang.String variableName,
                           java.lang.String variableValue)

Sets a QF-Test variable for the test run.

Parameters:

variableName - The name of the variable to set

variableValue - The variable value to use

Returns:

this for method chaining

withVariables

public QFTest withVariables(java.lang.String... variableNamesAndValues)

Sets multiple QF-Test variables for the test run.

Parameters:

variableNamesAndValues - Variable names and values alternating.

Returns:

this for method chaining

withRunLogPath

public QFTest withRunLogPath(java.lang.String runLogPathname)

Specify the directory where created QF-Test run logs will be stored, or the run log file directly. Also run logs of successful executions will be stored there.

Parameters:

runLogPathname - The path name of the file or directory to use for the run log

Returns:

this for method chaining

withRunLogPath

public QFTest withRunLogPath(java.io.File runLogDirOrFile)

Specify the directory where created QF-Test run logs will be stored, or the run log file directly. Also run logs of successful executions will be stored there.

Parameters:

runLogDirOrFile - The file or directory to use for the run log

Returns:

this for method chaining

withRunLogPath

public QFTest withRunLogPath(java.nio.file.Path runLogDirOrFile)

Specify the directory where created QF-Test run logs will be stored, or the run log file directly. Also run logs of successful executions will be stored there.

Parameters:

runLogPathname - The path of the file or director to use for the run log

Returns:

this for method chaining

withRunLogPath

public QFTest withRunLogPath(java.lang.String runLogPathname,
                             boolean keepSuccessfullRunLog)

Specify the directory where created QF-Test run logs will be stored, or the run log file directly.

Parameters:

runLogPathname - The path name of the file or directory to use for the run log

keepSuccessfullRunLog - If true, logs of successful executions will be kept, otherwise they will be removed after the test run.

Returns:

this for method chaining

withRunLogPath

public QFTest withRunLogPath(java.io.File runLogDirOrFile,
                             boolean keepSuccessfullRunLog)

Specify the directory where created QF-Test run logs will be stored, or the run log file directly.

Parameters:

runLogDirOrFile - The file or directory to use for the run log

keepSuccessfullRunLog - If true, logs of successful executions will be kept, otherwise they will be removed after the test run.

Returns:

this for method chaining

withRunLogPath

public QFTest withRunLogPath(java.nio.file.Path runLogDirOrFile,
                             boolean keepSuccessfullRunLog)

Specify the directory where created QF-Test run logs will be stored, or the run log file directly.

Parameters:

runLogDirOrFile - The path of the file or directory to use for the run log

keepSuccessfullRunLog - If true, logs of successful executions will be kept, otherwise they will be removed after the test run.

Returns:

this for method chaining

withReport

public QFTest withReport()

Enables report generation after the tests have been executed. The report will be generated for all test suites and run logs selected for this test run.

Returns:

this for method chaining

withReport

public QFTest withReport(java.lang.String reportDir,
                         java.lang.String... reportArguments)

Enables report generation after the tests have been executed. The report will be generated for all test suites and run logs selected for this test run.

Parameters:

reportDir - The pathname of the target directory for the report. If null, a temporary directory will be created and used

reportArguments - Additional QF-Test arguments which will be used during report generation

Returns:

this for method chaining

withReport

public QFTest withReport(java.io.File reportDir,
                         java.lang.String... reportArguments)

Enables report generation after the tests have been executed. The report will be generated for all test suites and run logs selected for this test run.

Parameters:

reportDir - The target directory for the report. If null, a temporary directory will be created and used

reportArguments - Additional QF-Test arguments which will be used during report generation

Returns:

this for method chaining

withReport

public QFTest withReport(java.nio.file.Path reportDir,
                         java.lang.String... reportArguments)

Enables report generation after the tests have been executed. The report will be generated for all test suites and run logs selected for this test run.

Parameters:

reportDir - The path of a target directory for the report. If null, a temporary directory will be created and used

reportArguments - Additional QF-Test arguments which will be used during report generation

Returns:

this for method chaining

withReportOpen

public QFTest withReportOpen()

If specified, a report is generated after the tests are run, and the report will be opened in the browser, if possible.

Returns:

this for method chaining

iterator

public java.util.Iterator<DynamicNode> iterator()

Specified by:

iterator in interface java.lang.Iterable<DynamicNode>