The TestWheel Automation Plugin is a powerful plugin designed to integrate seamlessly with DevOps tools for continuous integration and deployment (CI/CD). This plugin automates the execution of TestWheel’s comprehensive testing frameworks within your CI/CD pipelines post-deployment, ensuring reliable testing throughout your development lifecycle.
To get started with the TestWheel Automation Plugin:
- Install the plugin from the Jenkins Marketplace.
- Integrate it with your CI/CD pipeline.
Before using the TestWheel Automation Plugin, ensure the following:
- You have an existing Jenkins CI server.
- You have a registered TestWheel account. Register or Login.
- Your application is registered in TestWheel, and you’ve obtained the following credentials:
- Secure ApiKey
- PrjctKey
These credentials are required to perform post-deployment test automation using the plugin.
- Navigate to Manage Jenkins → Manage Plugins.
- Go to the Available Plugins tab.
- Search for TestWheel Automation Plugin and install it.
- After installation, ensure you're logged into your TestWheel account within Jenkins.
You can integrate the plugin into your pipeline in two ways:
You can define a task in your CI/CD pipeline using the sample script below:
🔧 Note: Replace
<YOUR_STAGE_NAME>
,<YOUR_API_KEY>
, and<YOUR_PROJECT_KEY>
with your actual values.
pipeline {
agent any
stages {
stage('<YOUR_STAGE_NAME>') {
steps {
testwheelTrigger(apiKey: '<YOUR_API_KEY>', prjctKey: '<YOUR_PROJECT_KEY>')
}
}
}
}
This approach is recommended for teams using declarative pipelines and version-controlled Jenkinsfiles.
For Freestyle Jenkins Jobs:
- Go to your Jenkins job configuration.
- Click Add build step.
- Select TestWheelTrigger from the dropdown list.
- Enter your ApiKey and PrjctKey obtained from TestWheel.
This option is ideal for users who prefer Jenkins’ UI over code-based pipeline configuration.
Once integrated:
- Upon reaching the post-deployment stage, the plugin automatically triggers tests using the provided credentials.
- A test report will be generated:
- ✅ If tests pass — the pipeline proceeds to the next stage.
- ❌ If tests fail — the pipeline halts immediately to prevent faulty deployments.
We welcome feedback, suggestions, and bug reports.
Please use the Contact Us page on our website to reach out.