Introduction

Thank you for choosing to Test Drive OpenRefactory’s Intelligent Code Repair (iCR). Test Drive iCR combines source level static analysis and machine learning for examining programs to detect security, reliability, and compliance issues and suggests fixes to create safe and reliable corrections for those flaws. This results in code free from many serious security vulnerabilities and programming errors.

Test Drive iCR is offered as a cloud-based SaaS service to help developers, who may be new to iCR, to try it for themselves. Test Drive iCR supports most of the features available in the standard iCR service which is available for deployment on private servers where the Intellectual Property embodied in your source code is protected. Test Drive is intended to help developers analyze any Open Source project which is accessible through GitHub. These may Open Source contributions from the developers themselves or those offered by others. Currently, Test Drive iCR supports analysis for projects written in Java, Python and Go. Other languages are in development and will be offered on Test Drive iCR in the future.

This User Guide will provide details on how to access and use Test Drive iCR free of charge.

To access Test Drive iCR, you must have a GitHub login ID. Test Drive iCR uses GitHub to authenticate the developer and gives them access to their source code repositories. Once logged into GitHub, Test Drive iCR presents a list of all available public repositories. These repositories are available for analysis if they are written in Java, Python or Go.

iCR consists of three main components: the iCR Navigator, the Analysis Engines and the Reviewer. You use the Navigator to help you to select the projects that you want to make available for processing. The Navigator launches the Analysis Engine as determined by the chosen GitHub repository and the Reviewer is used to browse through the errors that were detected. Potential fixes for many of the errors are also presented. The Reviewer uses a “diff” window so that you can see the original code alongside the fixes that were generated. You can also use the Reviewer to browse all the source in the affected file if you wish.

The remainder of this guide provides further details on how to access Test Drive iCR, select a project for analysis and review the results.