inteligr8/ootbee-beedk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
ootbee-beedk/beedk-ats-it-tile/README.md

3.9 KiB
Raw Permalink Blame History

BeeDK ATS Maven Tile for Integration Tests

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 Alfresco Transform Services for the integration testing of any ACS module, extension, service, or web application.

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-ats-it-tile -->
						<tile>com.inteligr8.ootbee:beedk-ats-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 which is automatically included in each of the following BeeDK Public API Maven Tiles.

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
alfresco.transform-aio.version not important The version of the Alfresco Transform Core Engine Docker Image.
alfresco-transform-router.version not important The version of the Alfresco Transform Router Docker Image.
alfresco.sfs.version not important The version of the Alfresco Shared File Store Engine Docker Image.

Other APIs

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

Results

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

This tile will result in the definition of the following Maven properties during the respective Maven phase.

Property Data Type Phase Description
beedk.deploy.ats.enabled Boolean At startup true, which signals other Maven Tiles