What does the plugin do?
Plain and simple, with the Kiuwan plugin for IBM UrbanCode Deploy you can add automatic code quality analysis in your deployment process. This plugin allows you to include a step in the design of the component deployment process, that will automatically launch a Kiuwan code analysis. The Kiuwan plugin never uploads your source code to Kiuwan servers. Instead, the analysis is run locally and just the quality results are uploaded to Kiuwan.
How to install?
First of all, you have to download the latest version of the plugin. Once you have it, access the IBM UrbanCode Deploy web interface. Then, go to Settings and click on Automation Plugins. Press the Load Plugin button and choose the ZIP file with the plugin.
IBM UrbanCode Deploy Agent's environment requirements
Kiuwan's plugin is executed in IBM UrbanCode Deploy agent's environments, so, for any given agent machine, you will need to satisfy these requirements:
- Windows or Linux as operative system.
- Java JRE installed in the system. You will need Java 1.8 or higher.
- Connection to Kiuwan server using HTTPS (https://www.kiuwan.com). The plugin needs to log in to Kiuwan server to synchronize the quality model, download analyzer upgrades and upload quality results.
How to design a component deployment process with a Kiuwan analysis step?
After a successful Kiuwan plugin for IBM Urban Code Deploy installation, you have a new process step available from the tools menu called Code Review/Kiuwan/Analyze, as you can see in the picture below:
Now, you can drag and drop this step in your process design area, and connect it to any other steps. For the step to work properly you need to fill out the following four required properties in the step's Edit Properties panel:
- Name: The name of the step in the process.
- Kiuwan application: When you run an analysis, you need to attach the results to an existing application on Kiuwan. If the application does not exist in your Kiuwan account, it will be automatically created the first time the step is executed.
- Kiuwan analysis label: A label that will help you identify the analysis in Kiuwan.
- Kiuwan user name: Your Kiuwan account user name.
- Kiuwan password: Your Kiuwan account password.
Additionally, only if your IBM UrbanCode Deploy server/agent machine needs a proxy to access the Internet, you have to specify your proxy details with the following optional properties:
- Kiuwan proxy protocol: The protocol to connect to your proxy server. HTTP and SOCKS proxies are supported.
- Kiuwan proxy host: Your proxy server host name or IP address.
- Kiuwan proxy authentication: If your proxy server requires basic authentication, you have to select it from the combo. Only basic authentication supported.
- Kiuwan proxy user: Your user to authenticate with the proxy.
- Kiuwan proxy password: Your password to authenticate with the proxy.
How does the plugin work?
The plugin encapsulates the Kiuwan Local Analyzer, which is basically doing all the work. You don't have to worry about Kiuwan local analyzer upgrades, it upgrades itself when necessary. So, what happens when your deployment process reaches the Kiuwan plugin step? First it connects to Kiuwan using the credentials specified in the properties.Then it downloads the quality model associated with the application you want to analyze (this association is done in Kiuwan) or the default quality model for applications that don't exist in Kiuwan yet (will be automatically created). The code analysis is run locally on the process' working directory. When finished, the results are uploaded to your Kiuwan account where you can access them anytime.
The step will return a success status upon completion of the analysis or a fail status if the analysis could not run. You can check the process execution log to diagnose the possible causes preventing the analysis.
Have fun analyzing continuously!!!