ootbee-beedk/beedk-ate-it-tile/README.md

BeeDK Alfresco Transform Engine Maven Tile for Integration Test

This is a component within the proposed BeeDK. It is considered to be part of the Public API of the BeeDK.

Purpose

This project creates a Maven Tile that provides a Alfresco Transform Engine for the integration testing of any ATS or ACS module, exension, service, or web application.

For the development of the ATE itself, you can use the beedk-ate-springboot-test composite POM.

This does not currently support use with ATS. Only the ALTS (ACS Platform Local Transform Service).

Usage

To use this plugin, just reference it with the Maven Tiles plugin as shown in the following snippet. Do not forget the extensions element in the plugin configuration.

<project ...>
	...
	<build>
		...
		<plugins>
			<plugin>
				<groupId>io.repaint.maven</groupId>
				<artifactId>tiles-maven-plugin</artifactId>
				<version>[2.0,3.0)</version>
				<extensions>true</extensions>
				<configuration>
					<tiles>
						...
						<tile>com.inteligr8.ootbee:beedk-acs-<!-- See below -->-tile:[1.0.0,2.0.0)</tile>
						<!-- Documentation: https://git.inteligr8.com/inteligr8/ootbee-beedk/src/branch/stable/beedk-ate-it-tile -->
						<tile>com.inteligr8.ootbee:beedk-ate-it-tile:[1.0.0,2.0.0)</tile>
						...
					</tiles>
				</configuration>
			</plugin>
			...
		</plugins>
		...
	</build>
	...
</project>

This tile is meant to be used in conjunction with the beedk-acs-platform-it-tile tile. The beedk-acs-platform-it-tile tile is automatically included in each of the following BeeDK Public API Maven Tiles.

• beedk-acs-platform-module-tile
• beedk-acs-share-module-tile
• beedk-acs-platform-webapp-tile
• beedk-acs-share-webapp-tile

This Maven Tile should always be declared AFTER the Maven Tile used from the list above.

Configuration

In your Maven project, set the following properties to define the behavior of this Maven Tile. Unless otherwise stated, they can only be overridden in the project POM or other Maven Tiles loaded earlier than this Maven Tile.

Public API

The following properties are intended to be exposed by inheriting Public API Maven Tiles.

Maven Property	Required	Default	Description
ate.docker.image.name	Yes		The Docker image name of the ATE, including the Docker registry host if applicable.
ate.docker.image.tag		latest	The Docker image tag (version) of the ATE.
ate.port		8080	The port to expose on localhost for the developer; not for other applications.
ate.timeout		30000	The time to wait for the startup to complete, in milliseconds.

Other APIs

Additional less important configurations are inherited from the following Maven Tiles.

• beedk-run-tile

Results

The configured Alfresco Transform Engine will be started and stopped during the pre-integration-test and post-integration-test Maven phases, respectively.