alfresco:it

Full name:

org.alfresco.maven.plugin:alfresco-maven-plugin:4.2.0-SNAPSHOT:it

Description:

Alfresco Plugin mojo that are used when you want to run Integration Tests. It will package up all the Integration Test classes and execute contained tests with the Maven Failsafe plugin. The test classes will be added to the platform war so they can be executed remotely via the AlfrescoTestRunner.

The Alfresco RAD module is also added to the Platform WAR so the Alfresco Test runner classes are available.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 3.0.
  • Binds by default to the lifecycle phase: pre-integration-test.

Optional Parameters

Name Type Since Description
alfrescoApiExplorerArtifactId String 3.0 (no description)
Default value is: api-explorer.
User property is: alfresco.api.explorer.artifactId.
alfrescoApiExplorerVersion String 3.0 (no description)
Default value is: 6.0.7-ga.
User property is: alfresco.api.explorer.version.
alfrescoGroupId String 3.0 Maven GAV properties for standard Alfresco web applications.
Default value is: org.alfresco.
User property is: alfresco.groupId.
alfrescoPlatformVersion String 3.0 (no description)
Default value is: 6.0.7-ga.
User property is: alfresco.platform.version.
alfrescoPlatformWarArtifactId String 3.0 (no description)
Default value is: content-services-community.
User property is: alfresco.platform.war.artifactId.
alfrescoShareVersion String 3.0 (no description)
Default value is: 6.0.7-ga.
User property is: alfresco.share.version.
alfrescoShareWarArtifactId String 3.0 (no description)
Default value is: share.
User property is: alfresco.share.war.artifactId.
copyHotswapAgentConfig boolean 3.0 Enable or disable generation of Hotswap Agent configuration
Default value is: true.
User property is: maven.alfresco.copyHotswapAgentConfig.
enableApiExplorer boolean 3.0 Switch to enable/disable the Alfresco REST API Explorer (api-explorer.war) when running embedded Tomcat.
Default value is: false.
User property is: maven.alfresco.enableApiExplorer.
enablePlatform boolean 3.0 Switch to enable/disable the Platform/Repository (alfresco.war) when running embedded Tomcat.
Default value is: true.
User property is: maven.alfresco.enablePlatform.
enableShare boolean 3.0 Switch to enable/disable the Share (share.war) when running embedded Tomcat.
Default value is: true.
User property is: maven.alfresco.enableShare.
enableTestProperties boolean 3.0 Switch to enable/disable test properties when running embedded Tomcat.
Default value is: true.
User property is: maven.alfresco.enableTestProperties.
mavenTomcatPort String 3.0 Legacy to be compatible with maven.tomcat.port
User property is: maven.tomcat.port.
platformModules List 3.0 JARs and AMPs that should be overlayed/applied to the Platform/Repository WAR (i.e. alfresco.war)
User property is: maven.alfresco.platform.modules.
shareContextPath String 3.0 Enables the use of custom context path for the Share webapp. Some solution integrators uses a custom context path for Share in their projects. This property enables them to continue to do that in SDK 3 without having to completely override the Maven Tomcat plugin configuration, or not use it at all and go back the good old runner project again...
Default value is: /share.
User property is: maven.alfresco.shareContextPath.
shareModules List 3.0 JARs and AMPs that should be overlayed/applied to the Share WAR (i.e. share.war)
User property is: maven.alfresco.share.modules.
startTomcat boolean 3.0 Control if Tomcat 7 Plugin should be kicked off and start Apache Tomcat
Default value is: true.
User property is: maven.alfresco.startTomcat.
testFolder String 3.0 Directory containing test files that should be used when running embedded Tomcat
Default value is: src/test/properties/${env}.
User property is: maven.alfresco.testFolder.
testInclude String 3.0 Test files in testFolder that should be included when running embedded Tomcat
Default value is: **.
User property is: maven.alfresco.testInclude.
tomcatCustomWebapps List 3.0 Custom webapps that should be deployed to the embedded Tomcat engine. Normally there would not be any extra webapps, but we could run a bigger project that uses some custom webapp.
User property is: maven.alfresco.tomcat.custom.webapps.
tomcatDependencies List 3.0 Tomcat Dependencies that should be added to the Embedded Tomcat configuration before start. Normally there would not be any extra dependencies, but could be if you run an Enterprise database such as Oracle, for which there's no quick config, such as enableH2, enableMySQL, or enablePostgreSQL.
User property is: maven.alfresco.tomcat.dependencies.
tomcatPort String 3.0 Port to run Tomcat on
Default value is: 8080.
User property is: maven.alfresco.tomcat.port.
tomcatSystemProperties Map 3.0 System Properties to feed the Tomcat plugin before start. Normally there would not be any extra dependencies, but we could run a custom webapp that needed a custom sys prop set.
User property is: maven.alfresco.tomcat.system.properties.
useCustomShareLog4jConfig boolean 3.0 Share Log4j.properties configuration cannot be customized via extension put on the classpath, like on the platform side. So we need to override the log4j.properties in share/WEB-INF/classes to be able to log from custom code. This property can be used to turn off this overriding, to produce a WAR with the standard Share log4j.properties file.
Default value is: true.
User property is: maven.alfresco.useCustomShareLog4jConfig.

Parameter Details

alfrescoApiExplorerArtifactId:

(no description)
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: alfresco.api.explorer.artifactId
  • Default: api-explorer

alfrescoApiExplorerVersion:

(no description)
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: alfresco.api.explorer.version
  • Default: 6.0.7-ga

alfrescoGroupId:

Maven GAV properties for standard Alfresco web applications.
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: alfresco.groupId
  • Default: org.alfresco

alfrescoPlatformVersion:

(no description)
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: alfresco.platform.version
  • Default: 6.0.7-ga

alfrescoPlatformWarArtifactId:

(no description)
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: alfresco.platform.war.artifactId
  • Default: content-services-community

alfrescoShareVersion:

(no description)
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: alfresco.share.version
  • Default: 6.0.7-ga

alfrescoShareWarArtifactId:

(no description)
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: alfresco.share.war.artifactId
  • Default: share

copyHotswapAgentConfig:

Enable or disable generation of Hotswap Agent configuration
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.copyHotswapAgentConfig
  • Default: true

enableApiExplorer:

Switch to enable/disable the Alfresco REST API Explorer (api-explorer.war) when running embedded Tomcat.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.enableApiExplorer
  • Default: false

enablePlatform:

Switch to enable/disable the Platform/Repository (alfresco.war) when running embedded Tomcat.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.enablePlatform
  • Default: true

enableShare:

Switch to enable/disable the Share (share.war) when running embedded Tomcat.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.enableShare
  • Default: true

enableTestProperties:

Switch to enable/disable test properties when running embedded Tomcat.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.enableTestProperties
  • Default: true

mavenTomcatPort:

Legacy to be compatible with maven.tomcat.port
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: maven.tomcat.port

platformModules:

JARs and AMPs that should be overlayed/applied to the Platform/Repository WAR (i.e. alfresco.war)
  • Type: java.util.List
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.platform.modules

shareContextPath:

Enables the use of custom context path for the Share webapp. Some solution integrators uses a custom context path for Share in their projects. This property enables them to continue to do that in SDK 3 without having to completely override the Maven Tomcat plugin configuration, or not use it at all and go back the good old runner project again...
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.shareContextPath
  • Default: /share

shareModules:

JARs and AMPs that should be overlayed/applied to the Share WAR (i.e. share.war)
  • Type: java.util.List
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.share.modules

startTomcat:

Control if Tomcat 7 Plugin should be kicked off and start Apache Tomcat
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.startTomcat
  • Default: true

testFolder:

Directory containing test files that should be used when running embedded Tomcat
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.testFolder
  • Default: src/test/properties/${env}

testInclude:

Test files in testFolder that should be included when running embedded Tomcat
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.testInclude
  • Default: **

tomcatCustomWebapps:

Custom webapps that should be deployed to the embedded Tomcat engine. Normally there would not be any extra webapps, but we could run a bigger project that uses some custom webapp.
  • Type: java.util.List
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.tomcat.custom.webapps

tomcatDependencies:

Tomcat Dependencies that should be added to the Embedded Tomcat configuration before start. Normally there would not be any extra dependencies, but could be if you run an Enterprise database such as Oracle, for which there's no quick config, such as enableH2, enableMySQL, or enablePostgreSQL.
  • Type: java.util.List
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.tomcat.dependencies

tomcatPort:

Port to run Tomcat on
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.tomcat.port
  • Default: 8080

tomcatSystemProperties:

System Properties to feed the Tomcat plugin before start. Normally there would not be any extra dependencies, but we could run a custom webapp that needed a custom sys prop set.
  • Type: java.util.Map
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.tomcat.system.properties

useCustomShareLog4jConfig:

Share Log4j.properties configuration cannot be customized via extension put on the classpath, like on the platform side. So we need to override the log4j.properties in share/WEB-INF/classes to be able to log from custom code. This property can be used to turn off this overriding, to produce a WAR with the standard Share log4j.properties file.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.alfresco.useCustomShareLog4jConfig
  • Default: true