ivy:stop-test-engine

Full name:

com.axonivy.ivy.ci:project-build-plugin:13.2.1-SNAPSHOT:stop-test-engine

Description:

Stops the Axon Ivy Engine after integration testing

Attributes:

Requires a Maven project to be executed.
The goal is not marked as thread-safe and thus does not support parallel builds.
Since version: 6.2.0.

Required Parameters

Name	Type	Since	Description
`<ivyVersion>`	`String`	`-`	The ivy Engine version or version-range that must be used. Must be equal or higher than "13.2.0" Examples: "`6.1.2`" means ivyVersion = 6.1.2 "`[6.1.0,7.0.0)`" means 6.1.0 <= ivyVersion < 7.0.0 "`(6.0.0,]`" means ivyVersion > 6.0.0 Default: `13.2.0` User Property: `ivy.engine.version`

Optional Parameters

Name	Type	Since	Description
`<additionalClasspath>`	`String`	`-`	Additional classpath entries for the JVM that stops the Engine User Property: `ivy.engine.stop.additional.classpath`
`<additionalVmArgs>`	`List<String>`	`-`	Additional arguments for the JVM that runs the Engine. To modify the classpath or the max heap use the provided properties.
`<additionalVmOptions>`	`String`	`-`	Deprecated. use `additionalVmArgs` Additional options for the JVM that stops the Engine. To modify the classpath or the max heap use the provided properties. User Property: `ivy.engine.stop.additional.vmoptions`
`<engineCacheDirectory>`	`Path`	`-`	Location where ivy engines in required version can be extracted to. If the Engine does not yet exist, it can be automatically downloaded. Default: `${settings.localRepository}/.cache/ivy` User Property: `ivy.engine.cache.directory`
`<engineDirectory>`	`Path`	`-`	Location where an unpacked (may pre-configured) ivy Engine in the `required version` exists. If parameter is not set it will be a sub-directory of the `ch.ivyteam.ivy.maven.AbstractEngineMojo.engineCacheDirectory`. If the Engine does not yet exist, it can be automatically downloaded. User Property: `ivy.engine.directory`
`<maxmem>`	`String`	`-`	The maximum heap (-Xmx) that is used for stopping the Engine Default: `128m` User Property: `ivy.engine.stop.maxmem`
`<skipTest>`	`boolean`	`-`	Set to `true` to skip the engine stop. Default: `false` User Property: `maven.test.skip`
`<stopTimeoutInSeconds>`	`Integer`	`-`	The maximum amount of seconds that we wait for a engine to stop Default: `45` User Property: `ivy.engine.stop.timeout.seconds`
`<testEngine>`	`String`	`8.0.4`	Configure if the test engine gets copied to the maven target folder. With this you can start each test cycle with a clean engine. Integration tests may leave resources like deployed projects behind which may lead to unwanted side effects on the next test cycle. `COPY_FROM_CACHE` = copy the engine if it comes from the `ch.ivyteam.ivy.maven.AbstractEngineMojo.engineCacheDirectory`. `MODIFY_EXISTING` = don't copy the engine, this could lead to unforeseen behaviour if the same engine is used multiple times. `COPY_FROM_TEMPLATE` = always copy the engine. If you have a preconfigured engine in the `ch.ivyteam.ivy.maven.AbstractEngineMojo.engineDirectory` it will be copied as well. Note: that we advise you to move the configuration of such engine to the build cycle itself instead of using a preconfigured one. Default: `COPY_FROM_CACHE` User Property: `ivy.test.engine`
`<useLatestMinor>`	`Boolean`	`-`	If set to true it will download the latest available minor version Default: `false` User Property: `ivy.engine.version.latest.minor`

Parameter Details

<additionalClasspath>

Additional classpath entries for the JVM that stops the Engine

Type: java.lang.String
Required: No
User Property: ivy.engine.stop.additional.classpath

<additionalVmArgs>

Additional arguments for the JVM that runs the Engine. To modify the classpath or the max heap use the provided properties.

Type: java.util.List<java.lang.String>
Required: No

<additionalVmOptions>

Deprecated.
use additionalVmArgs

Additional options for the JVM that stops the Engine. To modify the classpath or the max heap use the provided properties.

Type: java.lang.String
Required: No
User Property: ivy.engine.stop.additional.vmoptions

<engineCacheDirectory>

Location where ivy engines in required version can be extracted to.

If the Engine does not yet exist, it can be automatically downloaded.

Type: java.nio.file.Path
Required: No
User Property: ivy.engine.cache.directory
Default: ${settings.localRepository}/.cache/ivy

<engineDirectory>

Location where an unpacked (may pre-configured) ivy Engine in the required version exists.

If parameter is not set it will be a sub-directory of the ch.ivyteam.ivy.maven.AbstractEngineMojo.engineCacheDirectory.

If the Engine does not yet exist, it can be automatically downloaded.

Type: java.nio.file.Path
Required: No
User Property: ivy.engine.directory

<ivyVersion>

The ivy Engine version or version-range that must be used. Must be equal or higher than "13.2.0" Examples:

"6.1.2" means ivyVersion = 6.1.2
"[6.1.0,7.0.0)" means 6.1.0 <= ivyVersion < 7.0.0
"(6.0.0,]" means ivyVersion > 6.0.0

Type: java.lang.String
Required: Yes
User Property: ivy.engine.version
Default: 13.2.0

<maxmem>

The maximum heap (-Xmx) that is used for stopping the Engine

Type: java.lang.String
Required: No
User Property: ivy.engine.stop.maxmem
Default: 128m

<skipTest>

Set to true to skip the engine stop.

Type: boolean
Required: No
User Property: maven.test.skip
Default: false

<stopTimeoutInSeconds>

The maximum amount of seconds that we wait for a engine to stop

Type: java.lang.Integer
Required: No
User Property: ivy.engine.stop.timeout.seconds
Default: 45

<testEngine>

Configure if the test engine gets copied to the maven target folder. With this you can start each test cycle with a clean engine. Integration tests may leave resources like deployed projects behind which may lead to unwanted side effects on the next test cycle.

COPY_FROM_CACHE = copy the engine if it comes from the ch.ivyteam.ivy.maven.AbstractEngineMojo.engineCacheDirectory.
MODIFY_EXISTING = don't copy the engine, this could lead to unforeseen behaviour if the same engine is used multiple times.
COPY_FROM_TEMPLATE = always copy the engine. If you have a preconfigured engine in the ch.ivyteam.ivy.maven.AbstractEngineMojo.engineDirectory it will be copied as well.
- Note: that we advise you to move the configuration of such engine to the build cycle itself instead of using a preconfigured one.

Type: java.lang.String
Since: 8.0.4
Required: No
User Property: ivy.test.engine
Default: COPY_FROM_CACHE

<useLatestMinor>

If set to true it will download the latest available minor version

Type: java.lang.Boolean
Required: No
User Property: ivy.engine.version.latest.minor
Default: false