Skip to main content

Eclipse-based IDEs - Installation

This section explains how to integrate the Kiuwan IDE Plug-In into Eclipse-based IDEs.

Kiuwan IDE Plug-In

The Kiuwan Plug-In for Eclipse IDEs is available in two modes:

  • Analyzer: Enables local code analysis.
  • Viewer: Allows browsing and managing results.

Further Reading: For more information, check this article Kiuwan for Developers Introduction

Kiuwan allows for a true shift-left approach by integrating with all the main development IDEs that facilitate and automate compliance with security normative, quality standards, and best practices for several languages.

Supported Eclipse-based IDEs

The Kiuwan IDE Plug-In has been successfully tested in the following IDEs and minimum versions:

  • Eclipse: Luna (4.4)
  • RAD (Rational Application Developer for WebSphere): 9.5
  • IBM Rational Developer for i Systems: 9.5, 9.6
  • IBM Rational Developer for z Systems: 9.5.1

For other IDEs and versions, please contact Kiuwan Technical Support.

Note for Eclipse 2019-12+

A custom setup is required due to changes in Eclipse core components.
1. Open the Window > Preferences dialog.
2. Select Install/Update > Available Software Sites option.
3. Click Add... A new dialog with two text fields will be shown.
4. Set the "Name" field to "Eclipse Oxygen.2"
5. Set the "Location" field to "http://download.oracle.com/otn_software/oepe/library/eclipse-oxygen.2"
6. Click the "Add" button. This will add the defined software site to your list.
7. Check the "Eclipse Oxygen.2" software site in the list if it is not already checked.
8. Follow the standard installation instructions.

Requirements

The Kiuwan IDE Plug-In requires Java 8 or above (either JDK or JRE), available here.

Note for Linux/Unix users: If you are running Eclipse under Linux/Unix you can experience problems due to some well-known problems with GTK3 used by Eclipse distributions. Please visit the following links for further information.
- https://askubuntu.com/questions/761604/eclipse-not-working-in-16-04
- https://bugs.eclipse.org/bugs/show_bug.cgi?id=4307

To solve this issue, please modify eclipse.ini :

Add to your eclipse.ini:

--launcher.GTK_version 
2 

before the line:  

--launcher.appendVmargs 

Installation

To install Kiuwan for Developers just follow the steps below:

  1. In Eclipse, go to Help > Install New Software...
  2. Click Add... and enter the following values:
    1. Name: Kiuwan
    2. Location: https://static.kiuwan.com/download/updatesite
  3. Click Ok to save the changes. Eclipse will query our server to retrieve available features and plugins
    The Kiuwan for Developers plugin will appear in the list

  4. Select the plug-in and click Next >

    Attention: If the plugin fails to install due to missing a requirement: org.eclipse.equinox.p2.iu, please refer to the instructions here.

  5. Read and accept our Terms of Use
  6. Accept the certificate used to sign our product
  7. Restart the IDE
     

Configuration

Connection Settings

After installation, you need to configure the Kiuwan Plug-In to connect to Kiuwan.

  1. Find the connection settings under Windows > Preferences > Kiuwan > Connection Settings.
  2. Enter your Kiuwan credentials and click Apply and Check Credentials to validate access.
  3. In case you are using a proxy, please configure Proxy Settings.
    Do not change the default server URL (https://www.kiuwan.com/saas )This URL is the address where Kiuwan is located.

Analysis Filters

Configure which files to include or exclude from the analysis. Please visit Source Code Filters for further help on this.

By default, only Exclude patterns are configured (containing a list of file patterns commonly containing non-relevant sources to be analyzed).

Also, you can modify the default extensions associated with available language engines.

Visualization Options

Under Visualization Options, you can configure:

  • Automatic remote defects synchronization
    If checked, the plug-in automatically updates the remote defects list when you select a project in Eclipse (mapped to a Kiuwan application).
  • Mark defects as 'potential match" …
    If the Kiuwan server reports a defect in which the source code text does not match the source code within your Eclipse project, that defect is a "potential match"
    If checked, the plug-in will mark those defects as a "potential match"

This configuration is general to the plug-in installation, but you can configure analysis filters per application. 

Go to Project > Properties > Kiuwan > Analysis Filters and check Enable project-specific settings.

Map your Eclipse project to Kiuwan Application

After the Kiuwan IDE Plug-In is installed and the connection is configured, you are ready to map your Eclipse project to a Kiuwan application.

To map your Eclipse project to Kiuwan:

  1. Go to Project > Properties
  2. Right-click on your project and select Configure > Convert to Kiuwan Project...
  3. Right-click on your project and select Properties.

The following dialog will open.

Mapping your Eclipse project to a Kiuwan Application allows executing a plug-in analysis synced to the Kiuwan Model defined at the application level.

This means that the plug-in analysis will be executed with the same Model (rules, configuration, etc.) defined for the Kiuwan application.

Also, mapping your project to a Kiuwan Application allows you to download the defect list found by Kiuwan servers to Eclipse, so you can work locally on fixing those defects.

Further reading: Please visit Models Manager User Guide for further help on Kiuwan Models.

Kiuwan Plug-In execution modes

The Kiuwan Plug-In can be configured to run in different execution modes:

  • Manual: You manually invoke the Kiuwan analysis
  • Automatic: Kiuwan analysis is executed automatically upon changes in the code.

By configuring the plug-in, you can decide when Kiuwan will be executed and which files will be analyzed.

Note: Analysis permissions - To be able to analyze in Eclipse, your Kiuwan user must have been configured with, at least, read permission on the Kiuwan application

Manual analysis

If your Eclipse project is NOT configured to "Build Automatically", Kiuwan will only run on-demand.

To manually execute the analysis, left-click on the selected item (file, folder, project) and select Run Kiuwan Analysis. Kiuwan will then execute the analysis on the selected item(s).

Automatic analysis

If your Eclipse project is configured to Build Automatically, Kiuwan will run automatically and you can configure when the analysis will run and on what files.

The Kiuwan IDE Plug-In execution mode is configured at Window > Preferences > Kiuwan > Analysis Options

Note: If your Eclipse project is configured to "Build Automatically and "Automatic quality analysis" is checked: Kiuwan will analyze a file after you save the file. Only the selected file will be analyzed.

Note: Build options - Do full builds.
If your Eclipse project is configured to Build Automatically and Do full builds is checked:
Kiuwan will analyze the complete project when you Clean the project.
Please note that this option is only available if Automatic quality analysis is checked.

Updates

The Kiuwan IDE Plug-In checks automatically for updates on Eclipse startup and after that, daily. If you need to check it manually, you have these options:

  • Through the standard Eclipse mechanisms, or
  • Go to Windows > Preferences > Kiuwan and press the Check for updates button in Plug-in updates section.

Although the central configuration is also automatically synchronized at IDE startup, it is possible to force its update using the Force update button in the Central Configuration Updates section.

 

Related to

Was this article helpful?
Powered by Zendesk