Fork me on GitHub
Built by Maven

ivy:stop-test-engine

Full name:

com.axonivy.ivy.ci:project-build-plugin:9.4.1: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 6.2.0 The ivy Engine version or version-range that must be used. Must be equal or higher than MINIMAL_COMPATIBLE_VERSION 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 value is: 9.4.0.
User property is: ivy.engine.version.

Optional Parameters

Name Type Since Description
<additionalClasspath> String 6.2.0 Additional classpath entries for the JVM that stops the Engine
User property is: ivy.engine.stop.additional.classpath.
<additionalVmOptions> String 6.2.0 Additional options for the JVM that stops the Engine. To modify the classpath or the max heap use the provided properties.
User property is: ivy.engine.stop.additional.vmoptions.
<engineCacheDirectory> File 6.2.0 Location where ivy engines in required version can be extracted to.

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


Default value is: ${settings.localRepository}/.cache/ivy.
User property is: ivy.engine.cache.directory.
<engineDirectory> File 6.2.0 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 engineCacheDirectory.

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


User property is: ivy.engine.directory.
<maxmem> String 6.2.0 The maximum heap (-Xmx) that is used for stopping the Engine
Default value is: 128m.
User property is: ivy.engine.stop.maxmem.
<skipTest> boolean 6.2.0 Set to true to skip the engine stop.
Default value is: false.
User property is: maven.test.skip.
<stopTimeoutInSeconds> Integer 6.2.0 The maximum amount of seconds that we wait for a engine to stop
Default value is: 45.
User property is: 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 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 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 value is: COPY_FROM_CACHE.
User property is: ivy.test.engine.

Parameter Details

<additionalClasspath>

Additional classpath entries for the JVM that stops the Engine
  • Type: java.lang.String
  • Since: 6.2.0
  • Required: No
  • User Property: ivy.engine.stop.additional.classpath

<additionalVmOptions>

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
  • Since: 6.2.0
  • 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.io.File
  • Since: 6.2.0
  • 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 engineCacheDirectory.

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

  • Type: java.io.File
  • Since: 6.2.0
  • 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 MINIMAL_COMPATIBLE_VERSION 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
  • Since: 6.2.0
  • Required: Yes
  • User Property: ivy.engine.version
  • Default: 9.4.0

<maxmem>

The maximum heap (-Xmx) that is used for stopping the Engine
  • Type: java.lang.String
  • Since: 6.2.0
  • Required: No
  • User Property: ivy.engine.stop.maxmem
  • Default: 128m

<skipTest>

Set to true to skip the engine stop.
  • Type: boolean
  • Since: 6.2.0
  • 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
  • Since: 6.2.0
  • 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 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 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