vltpack:IT-server-ready

Full name:

net.adamcin:vltpack-maven-plugin:1.3.0:IT-server-ready

Description:

Waits for server readiness before continuing on to integration-test phase. Fails the build if the configured timeout is exceeded.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.0.
  • Binds by default to the lifecycle phase: pre-integration-test.

Optional Parameters

Name Type Since Description
context String 1.0.0
Granite Servlet context by which JCR paths are appended

Default value is: /.
User property is: vltpack.context.
expectedContent String 1.0.0
The content that is expected anywhere in the response text.

Default value is: QUICKSTART_HOMEPAGE.
host String 1.0.0
Hostname for the Granite server

Default value is: localhost.
User property is: vltpack.host.
https boolean 1.0.0
Whether to use an SSL connection instead of a normal HTTP connection. Does not affect the configured TCP port

User property is: vltpack.https.
noProxy boolean 1.0.0
Set to true to completely disable HTTP proxy connections for this plugin. Overrides any other HTTP proxy configuration

User property is: vltpack.proxy.noProxy.
pass String 1.0.0
Password to use in connection credentials

Default value is: admin.
User property is: vltpack.pass.
port Integer 1.0.0
TCP Port for the Granite server

Default value is: 4502.
User property is: vltpack.port.
proxyHost String 1.0.0
The HTTP Proxy hostname

Default value is: localhost.
User property is: vltpack.proxy.host.
proxyPass String 1.0.0
The HTTP Proxy password

User property is: vltpack.proxy.pass.
proxyPort int 1.0.0
The HTTP Proxy port. Set to -1 to use the default proxy port.

User property is: vltpack.proxy.port.
proxyProtocol String 1.0.0
The HTTP Proxy protocol

Default value is: http.
User property is: vltpack.proxy.protocol.
proxySet boolean 1.0.0
Set to true to override the proxy configuration in the user's Maven Settings with the associated mojo parameter alternatives

User property is: vltpack.proxy.set.
proxyUser String 1.0.0
The HTTP Proxy username

User property is: vltpack.proxy.user.
serverReadyPath String 1.0.0
The server path to ping.

Default value is: /libs/granite/core/content/login.html.
skip boolean 1.0.0
Set to true to skip this goal

User property is: vltpack.skip.IT-server-ready.
skipITs boolean 1.0.0
By convention, this parameter is used to disable execution of the maven-failsafe-plugin. It is recognized by vltpack to disable uploading of test artifacts and integration test reporting goals.

User property is: skipITs.
skipTests boolean 1.0.0
By convention, this parameter is used to disable execution of maven-surefire-plugin-derived goals. It is recognized by vltpack to disable uploading of test artifacts and integration test reporting goals.

User property is: skipTests.
supportITs boolean 1.0.0
Set this property to true to enable the pre-integration-test goals (vltpack-maven-plugin:IT-*)

User property is: supportITs.
timeout int 1.0.0
Number of seconds to wait while pinging the configured IT server for the expected response

Default value is: 60.
user String 1.0.0
Specify the CQ username associated with package creation and installation

Default value is: admin.
User property is: vltpack.user.

Parameter Details

context:

Granite Servlet context by which JCR paths are appended
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.context
  • Default: /

expectedContent:

The content that is expected anywhere in the response text.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • Default: QUICKSTART_HOMEPAGE

host:

Hostname for the Granite server
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.host
  • Default: localhost

https:

Whether to use an SSL connection instead of a normal HTTP connection. Does not affect the configured TCP port
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.https

noProxy:

Set to true to completely disable HTTP proxy connections for this plugin. Overrides any other HTTP proxy configuration
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.proxy.noProxy

pass:

Password to use in connection credentials
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.pass
  • Default: admin

port:

TCP Port for the Granite server
  • Type: java.lang.Integer
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.port
  • Default: 4502

proxyHost:

The HTTP Proxy hostname
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.proxy.host
  • Default: localhost

proxyPass:

The HTTP Proxy password
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.proxy.pass

proxyPort:

The HTTP Proxy port. Set to -1 to use the default proxy port.
  • Type: int
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.proxy.port

proxyProtocol:

The HTTP Proxy protocol
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.proxy.protocol
  • Default: http

proxySet:

Set to true to override the proxy configuration in the user's Maven Settings with the associated mojo parameter alternatives
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.proxy.set

proxyUser:

The HTTP Proxy username
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.proxy.user

serverReadyPath:

The server path to ping.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • Default: /libs/granite/core/content/login.html

skip:

Set to true to skip this goal
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.skip.IT-server-ready

skipITs:

By convention, this parameter is used to disable execution of the maven-failsafe-plugin. It is recognized by vltpack to disable uploading of test artifacts and integration test reporting goals.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: skipITs

skipTests:

By convention, this parameter is used to disable execution of maven-surefire-plugin-derived goals. It is recognized by vltpack to disable uploading of test artifacts and integration test reporting goals.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: skipTests

supportITs:

Set this property to true to enable the pre-integration-test goals (vltpack-maven-plugin:IT-*)
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: supportITs

timeout:

Number of seconds to wait while pinging the configured IT server for the expected response
  • Type: int
  • Since: 1.0.0
  • Required: No
  • Default: 60

user:

Specify the CQ username associated with package creation and installation
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: vltpack.user
  • Default: admin