Description
The Deploy Tools plug-in provides several steps that help verify the successful deployment of an application.
- Overview
- Documentation
- Version history
Quick Info
Product
HCL DevOps Deploy (HCL Launch)
Type
plugin
Compatibility
HCL Launch version 7.3.2.8 and later
Created by
HCLSoftware
Website
Published Date
Last Updated
Summary
Usage
Steps
Summary
The Tools for Deploy plugin provides automated post deployment verification steps to verify that applications are deployed to web sites. You can use the plugin to determine whether a deployment succeeded or failed. You can also specify application and component threshold processing time.
This plugin includes one or more steps, click Steps for step details and properties.
Compatibility
This pluin runs on all operating systems that the HCL Deploy agents supports, except for IBM z/OS.
Installation
See Installing plugins in HCL Deploy for installing and removing plugins.
History
The following table describes the changes made in each plugin version.
| Version | Description |
|---|---|
| 8 | Proxy compatibility added. Fix build issue related to a missing log4j library. |
| 7 | Fixed APAR PI35342 - compatibility defect with IBM Urbancode Deploy version 6.1.0.4 and later. |
| 6 | Added a property to the Verify Deployment Step which allows the user to specify a Character Encoding to use when reading the response body from a website. |
| 5 | Added a step to check the time elapsed since the start of an application or component process and fail if over a certain threshold. |
| 4 | Fixed infinite loop in wait for web page step when a failure is followed by success. |
| 3 | Added a step that can repeatedly hit a web page for a certain period and wait for a regular expression match. This step is useful if you want to wait for a website to come up before you continue with the next deployment steps. |
| 2 | Installing this plugin will give you access to the steps listed below. These steps can be used when designing a component process. |
| 1 | Initial release. |
Usage
Step palette
To access this plugin in the palette, click Quality > Functional Testing > Simple Web Test.
Steps
The following process steps are available in the Deploy Tools plugin.
- Check Total Application Process Execution Time
- Check Total Component Process Execution Time
- Verify Deployment
- Wait for web page
Check Total Application Process Execution Time
Check the run time of the application process. The step fails if the time is greater than the specified threshold.
| Name | Type | Description | Required |
|---|---|---|---|
| Component Process Request ID | String | Yes | |
| Timeout | String | The number of seconds that the application process is allowed to run. | Yes |
Check Total Component Process Execution Time
Check the run time of the component process. The step fails if the time is greater than a specified threshold.
| Name | Type | Description | Required |
|---|---|---|---|
| Component Process Request ID | String | The ID of the component process to check. | Yes |
| Timeout | String | The number of seconds that the component process is allowed to run. | Yes |
Verify Deployment
Verify the deployment of an application by using the HTTP interface.
| Name | Type | Description | Required |
|---|---|---|---|
| Charset | String | The character encoding for the file. The default value is UTF-8. | No |
| Fail if match found | Boolean | If selected, the process fails if a match is found. | No |
| Password | Password | The password to use for authentication. | No |
| Password Script | String | A script that returns the password to use for authentication. | No |
| Timeout | String | The time, in milliseconds, after which to fail the process. | No |
| URL | String | The URL to use to verify the deployment. | Yes |
| User Name | String | The user name to use for authentication. | No |
| Verification String | String | The string to search for in the response to verify the correct deployment. | Yes |
Wait for web page
Wait for a web page to become accessible and to contain specified text.
| Name | Type | Description | Required |
|---|---|---|---|
| Fail if match found | Boolean | If selected, the process fails if a match is found. | No |
| Maximum wait time (s) | String | The maximum number of seconds to wait for the conditions to be met. | Yes |
| Password | Password | The password to use for authentication. | No |
| Password Script | String | A script that returns the password to use for authentication. | No |
| Proxy Hostname | String | If you are connecting to a website through a proxy, specify the host name or IP address of the proxy server. For example: 192.0.2.8. | No |
| Proxy Password | String | If authentication is required, specify the password to use to authenticate with the proxy server. | No |
| Proxy Port Number | String | Specify the port number used by the proxy server for client connections. For example: 80. | No |
| Proxy Username | String | If authentication is required, specify the user name to use to authenticate with the proxy server. | No |
| Retry wait time (ms) | String | The number of milliseconds to wait between retries. | Yes |
| Timeout | String | The request timeout, in milliseconds. Use this field if the default wait time is too long. | No |
| URL | String | The URL to use to verify deployment. | Yes |
| User Name | String | The user name to use for authentication. | No |
| Verification String | String | The string to search for in the response to verify the correct deployment. | Yes |
