Introduction
Kiuwan for Developers (K4D) is a plug-in for Eclipse IDE that facilitates and automates compliance with quality standards and best practices for several languages.
It provides the following benefits:
- Automatic Error Prevention – Coding standards are specific rules for a programming language. By implementing and monitoring compliance with these standards at the time the code is entered you can avoid errors and reduce the time and cost of debugging and testing activities.
- Adoption of Coding Standards – Ensuring the compliance of these standards by a development department can be a long and tedious task without the support of some sort of tool that will facilitate and automate this work. This plugin connects with Kiuwan and harness the power of its quality models to prevent errors and automatically standardise the code.
Kiuwan for Developers monitors and reports on the quality and efficiency of your code at the point that it is written. This immediate feedback provides you with the opportunity to improve your code before it is delivered.
Supported IDEs and Requeriments
Installation
To install Kiuwan for Developers just follow the steps below:
- Open Eclipse and, in the main menu, click on Help >> Install New Software...
- Select the Add... option and type the following values:
- Name: Kiuwan
- Location: https://www.kiuwan.com/pub/updatesite
- Pressing Ok will save this new update site and Eclipse will query our server to retrieve available features and plugins
- The Kiuwan for Developers feature will appear in the list below, check it and click on Next >
- Read and accept our Terms of Use
- Accept the certificate used to sign our product
- When the installation finishes and Eclipse asks to restart the IDE, please do so
If installation successfully completes, Kiuwan for Developers will be up and running upon restart!
Updates
Kiuwan for Developers checks automatically for updates on Eclipse startup and on a daily basis after that.
If you need to check it manually, you can do so through the standard Eclipse mechanisms, or by simply going to Window >> Preferences >> Kiuwan and pressing the Check for updates button.
Configuration
Connection Settings
Fill in you User and Password of your Kiuwan Account and click Check Credentials to validate access.
In case you are using a proxy, please configure Proxy Settings.
Analysis Filters
This configuration is general to K4D installation, but you can configure analysis filters per-application.
To do it, go to Project >> Properties >> Kiuwan >> Analysis Filters and click on Enable project specific settings
Mapping your Eclipse project to Kiuwan Application
After K4D is installed and connection is configured, you are ready to map your Eclipse project to a Kiuwan application.
To map your Eclipse project to Kiuwan, you can do it in several ways:
- Project >> Properties
- Right-click on your project and select Configure >> Convert to Kiuwan Project...
- Right-click on your project and select Properties.
Next dialog will be open.
To map your Eclipse project to a Kiuwan Application allows to execute K4D analysis synced to the Kiuwan Model defined at application level.
This means that K4D analysis will be executed with the same Model (rules, configuration, etc.) defined for for the Kiuwan application.
Please visit Models Manager User Guide for further help on Kiuwan Models.
Also, mapping your project to a Kiuwan Application allows to download defect list found by Kiuwan servers to you Eclipse, so you can work locally on fixing those defects.
K4D execution modes
Manual analysis
Automatic analysis
K4D Defects List
To view the analysis' defects list, go to Window >> Show View >> Other >> Kiuwan
Local defects list
Vulnerabilities details (Source and Sink)
Local Analysis Configuration
K4D will execute the analysis with the rules contained into the model associated to the mapped Kiuwan application.
But K4D also allows you to reduce the scope of the analysis to a subset of that model.
When you execute the local analysis on your Eclipse project, the number of defects can be quite large. If you are not going to work on all of them, you should consider to reduce the analysis to to let you concentrate on the most important subset of defects. K4D allows you to configure the local analysis to only report defects based on Priority, Characteristic, Language or even a subet of file (based on file path substring)
This would allow you to concentrate on a specific set of rules or files, reducing the number of defects that appear in the list. Only those defects matching the filters will be displayed.
You can access Local Analysis Configuration by clicking on 
icon of Local Defects list.
Note: All the options unchecked are equivalent to all checked.
Configuring Defects View
Regardless of you have configured the subset of defects of K4D analysis (see above), you can further reduce the defects view by defining additional filtering conditions.
Most important filter is Scope:
- File option will only display defects of the selected file in the Eclipse source file editor
- Project option will display the defects of the entire project
Additionally, you can define filters based on Priority, Characteristic and Language.
You can define view filters by clicking on 
icon of Local Defects list.
Note: All the options unchecked are equivalent to all checked.
Server defects list
- Your current source code could be different to the source code of the server (you or other might already have modified that version)
- The list of defects to be fixed will be more probably a subset of all defects found during the server analysis (more on this topic below)
In these cases, you will need to have access to server defects.
Source of Server defects list
- Last baseline analysis
- All the defects found during last complete application analysis (i.e. the Application Baseline)
- Action plan
- Defects included within an Action Plan (you can select the plan from the app's list of available action plans)
- Audit Delivery
- Defects that must be fixed so the Audit of a delivery can be successfull (you can select the delivery among the list of executed deliveries)
Please, visit Kiuwan Life Cycle documentation for a full explanation of Baseline, Delivery and Audit concepts).
You can access Source of Server defects by clicking on icon of Server Defects list.
Note: All the options unchecked are equivalent to all checked.
Besides to configure the source of server defects, you can further filter server defects to be downloaded based on Priority, Characteristic, Language or File Pattern
Configuring Filters
Besides to configure source and filters, you can further reduce the server defect list by defining additional filtering conditions.
You can define view filters by clicking on icon of Server Defects list.
Note: All the options unchecked are equivalent to all checked.
An important filter is Scope:
- File option will only display defects of the selected file in the Eclipse source file editor
- Project option will display the defects of the entire project
Additionally, you can define filters based on Priority, Characteristic and Language.
Because your source code could be different to the source code of the analysys server, it might happens that some server defects could not match your current source code.
In these cases, you can filter by Orphan defects to display only those defects matching your currrent source code (defects with associated local resource) or those that doesn't (defects without associated local resource), or all of them.
A server defect could have been muted (for exmple, because it's a false positive or because it's a so special condition that must not be fixed). In these cases, you can use the Muted filter.
Any server defect may have an associated Life Cycle Status (To Review, Reviewed, or None) . When server defects are downloaded, you can filter defects based on their status.
If you work on a to-review server defect, right-clicking on the defect you can "Mark as reviewed locally" that defect (see image below), and filter the defect list using Reviewed locally filter.
Then, that defect will be marked as "Reviewed locally"
Support and Troubleshooting
If you experience problems with the Kiuwan plugin for Eclipse, you can read Kiuwan Documentation to find a solution, or if you prefer you can collect troubleshooting information and send it to us.