Scertify Refactoring Assessment adds a page in Sonar, linked from the left sidebar.
This page is accessible from any project/module (with a minimum of 1 line of code) in Sonar which has been analysed after installation of the plugin.
On the top you can see an header with information about TechDebt (projects, audits and lines of code analysed with the plugin), a click on these values redirects to TechDebt website.
On the right are shown your email address and the last analysis date of your project.
The plugin allows you to navigate between 5 subpages :
- Quality Profile
- Action plans
In general settings of Sonar, you can set several options for Scertify Refactoring Assessment :
- Project Name Encryption : Statistics of your project are transmitted to TechDebt. If you do not want people to see the name of your project in TechDebt website you can set this setting to true, your project will be seen as 'Anonymous Project'.
- Email : You have to provide a valid email address to fully benefit of the plugin. Your email address will never be published or shared.
- Language : The plugin is available in English and French. By default English is used, to get French version you can set 'fr' in this setting.
- Proxy : Internet connection is required to obtain information from Tocea databases. If your Sonar is under a proxy you have to set its information (host/port/user/password).
In order to provide you statistics that match for you at best, we need information about you and your applications.
These information can be set in the 'TechDebt' page of your projects (an authentication and permissions for these projects are required).
Two kind of information are requested :
- General information about you (business sector and firm size of your company)
- Project information, that can be different for every application, (Application type and development type for your application).
It is the page by default. It is divided in 4 parts wich represents the others subpages. Each subpage can be accessed by clicking the button on the bottom left of the corresponding box.
- Refactoring : It shows information about possible refactoring on your project using Scertify Code. Time saving is the percentage of time you can save if you would correct all the violations in your project and use Scertify Code to correct all violations which are automatically refactorable instead of correct them manually. Manual Refactoring is the time needed to correct manually all the violations, 1d=24h.Possible economy is the time saved using Scertify Code to correct violations on your project instead of correct them manually. The pie charts represent the repartition of all violations in the project, repartition by refactorability or classification of the violations. A click on the pie chart or legend redirects to the filtered refactoring subpage .
- Statistics : It shows the position of your project on several metrics relative to the others projects already analysed. The pie chart represents the repartition of extensions of files existing in the sources directory of your project.
- Quality profile : It shows information about the quality profile used in the last analysis of the project. The number of rules available in your Sonar, the number of rules used in the quality profile, the changes wich are recommended in your quality profile (see Quality profile subpage for more details). The table represents the repartition of the used rules in your quality profile by actual priority (in orange) and priority suggested by Sonar (in grey). A click on a bar redirects to the filtered quality profile subpage.
- Action plans : You can create an action plan in order to correct the violations of your project. See action plans subpage for more details.
Quality Profile subpage
This section helps you to create a quality profile well configured.
There are three kinds of modifications in order to improve the quality profile :
- add an available rule wich is not currently used from the quality profile
- remove a used rule from the quality profile
- change the priority of a used rule
These changes can be shown in tables. each table can be print, sort and filter. Plugin is the tool which detected the violation. Priority is the actual priority for the rule. Suggested is the priority suggested by Tocea for this rule. By clicking on the button "Suggested Quality Profile" you can access to the xml of the quality profile used wich take in account the recommended changes. To use this quality profile juste copy it in an xml file and import it in Sonar.
Action plans subpage
Here you can create action plans to correct your violations. These action plans take care of the time you have to do it and the weight you specify for classifications of violated rules (more stars there are for a classification more this classification is important according to you). This classification of rules is done by Tocea. Three types of action plans are available, those types define the sort of result (from most to least important) :
- Comprehensive : rule classification -> rule priority(from blocker to info) -> refactoring impact(from local to project) -> refactoring time(from min to max).
- Fast : refactoring time -> rule classification -> rule priority -> refactoring impact.
- Safe : refactoring impact -> rule classification -> rule priority -> refactoring time.
Your action plan can be print.
By double-clicking on a row of the action plan you can access to the source code of the violation.
This section shows information about the violated rules of the project. These information can be print, filter and sort.
By double clicking on a row you can access to the violation drilldown of the selected rule.
Here you can see statistical comparison of the Sonar metrics of the application relative to all projects already analysed by Scertify Refactoring Assessment.
The orange bar is the interval in wich your application is.
Moving the mouse over a bar shows the boundaries of this interval.
By clicking on your metric values you can access to the metric drilldown of the selected metric.