Difference between revisions of "Globalyzer Dashboard FAQ"

From Lingoport Wiki
Jump to: navigation, search
(Limit files uploaded to the Dashboard to be only the files scanned by Globalyzer)
(Limit files uploaded to the Dashboard to be files scanned by Globalyzer)
 
(19 intermediate revisions by 2 users not shown)
Line 35: Line 35:
   
   
= Limit files uploaded to the Dashboard to be only the files scanned by Globalyzer =
+
= Limit files uploaded to the Dashboard to be files scanned by Globalyzer and associated Resource Files =
   
 
A project is made up of one or more scans, and each scan processes source files with configured file extensions.
 
A project is made up of one or more scans, and each scan processes source files with configured file extensions.
 
The issues found via scanning are reflected on the Dashboard.
 
The issues found via scanning are reflected on the Dashboard.
By default, all files found within the project's base path are uploaded to the Dashboard, even ones that aren't scanned.
+
By default, all files found within your project's base path (the default setting of <b>sonar.sources</b>) are uploaded to the Dashboard, even ones that aren't scanned.
To limit what is uploaded, you can configure the sonar.inclusions property in the sonar-project.properties file for your project.
+
To limit what is uploaded, you can configure the <b>sonar.inclusions</b> property in the <b>sonar-project.properties</b> file for your project.
  +
Note: For a project named Acme.Widget, the file would be typically located under ''~jenkins/Lingoport_Data/Dashboard/Projects/Acme.Widget/sonar-project.properties.''
   
If your project contains a Java scan, JavaScript scan, and HTML scan, then you would set your sonar-project.properties to include the extensions for all three languages.
+
You need to include all the extensions for all the scans in your project and the extensions for the resource files (.properties, .resx, etc.).
  +
For example, for a project containing only a Java scan, you would add the following line to your sonar-project.properties file:
Below is the list of languages and the sonar.inclusions property set to their default file extensions. It is important to note that source file extensions are configurable in rule sets, so if extensions are added or removed in the rule set, they should be added or removed in the sonar-project.properties; that is, they should match.
 
  +
sonar.inclusions=**/*.java,**/*.jsp,**/*.jspf,**/*.jspx,**/*.properties
  +
if the resource files are .properties files.
   
For example, if your project contained only a Java scan, you would add the following line to your sonar-project.properties file:
+
For a project containing a Java scan and a JavaScript scan, you would add the following line to your sonar-project.properties file:
<code>sonar.inclusions=**/*.java,**/*.jsp,**/*.jspf,**/*.jspx</code>
+
sonar.inclusions=**/*.as,**/*.asax,**/*.ascx,**/*.asp,**/*.aspx,**/*.cshtml,**/*.ejs,**/*.htm,**/*.html,**/*.java,**/*.js,**/*.jsp,**/*.spf,**/*.jspx,**/*.mas,**/*.mi,**/*.php,**/*.xhtml,**/*.json,**/*.properties
  +
if the resource files are .json and .properties files.
  +
  +
Below is the list of rule set languages and their corresponding sonar.inclusions property. It is important to note that source file extensions are configurable in rule sets, so if extensions are added or removed in the rule set, they should be added or removed in the sonar-project.properties file; that is, they should match.
   
 
{| class="wikitable"
 
{| class="wikitable"

Latest revision as of 23:55, 4 December 2018

Mapping of Rule Set Rules to Dashboard Rules

Rules in Globalyzer Rule Sets have both an associated category, and an associated priority. Issue detection categories include:

  • Embedded Strings
  • Locale Sensitive Methods
  • General Patterns
  • Static File References.

Rules for all categories may have priorities of 1-5. Additionally, Embedded String detections may be set to priority 0, which indicates a concatenation issue.

The Lingoport Dashboard's rules include the same categories as above. However, the priorities only go from 1-3. The mapping between these priorities is as follows:

Globalyzer Priority Dashboard Priority
0 (Embedded String) Concatenation
1 1
2 2
3-5 3

Determining the number of issues created/fixed in a given time period

It is possible to view detailed information about the number of issues created or fixed during a given time period. This can be done using the Dashboard's inbuilt api. See the REST API#Issue_tracking section on this wiki for more information.


Limit files uploaded to the Dashboard to be files scanned by Globalyzer and associated Resource Files

A project is made up of one or more scans, and each scan processes source files with configured file extensions. The issues found via scanning are reflected on the Dashboard. By default, all files found within your project's base path (the default setting of sonar.sources) are uploaded to the Dashboard, even ones that aren't scanned. To limit what is uploaded, you can configure the sonar.inclusions property in the sonar-project.properties file for your project. Note: For a project named Acme.Widget, the file would be typically located under ~jenkins/Lingoport_Data/Dashboard/Projects/Acme.Widget/sonar-project.properties.

You need to include all the extensions for all the scans in your project and the extensions for the resource files (.properties, .resx, etc.). For example, for a project containing only a Java scan, you would add the following line to your sonar-project.properties file:

sonar.inclusions=**/*.java,**/*.jsp,**/*.jspf,**/*.jspx,**/*.properties

if the resource files are .properties files.

For a project containing a Java scan and a JavaScript scan, you would add the following line to your sonar-project.properties file:

sonar.inclusions=**/*.as,**/*.asax,**/*.ascx,**/*.asp,**/*.aspx,**/*.cshtml,**/*.ejs,**/*.htm,**/*.html,**/*.java,**/*.js,**/*.jsp,**/*.spf,**/*.jspx,**/*.mas,**/*.mi,**/*.php,**/*.xhtml,**/*.json,**/*.properties

if the resource files are .json and .properties files.

Below is the list of rule set languages and their corresponding sonar.inclusions property. It is important to note that source file extensions are configurable in rule sets, so if extensions are added or removed in the rule set, they should be added or removed in the sonar-project.properties file; that is, they should match.

Rule Set Language sonar.inclusions=
Actionscript **/*.as,**/*.mxml
C# **/*.asax,**/*.ascx,**/*.ashx,**/*.aspx,**/*.cs,**/*.cshtml
C++ **/*.c,**/*.cc,**/*.cpp,**/*.cxx,**/*.h,**/*.hpp,**/*.hxx,**/*.qml
Delphi **/*.dfm,**/*.dpk,**/*.dpr,**/*.pas
HTML **/*.asa,**/*.asax,**/*.ascx,**/*.cxx,**/*.ashx,**/*.asmx,**/*.asp,**/*.aspx,**/*.axd,**/*.cshtml,**/*.ejs,**/*.htm,**/*.html,**/*.inc,**/*.jsp,**/*.jspf,**/*.jspx,**/*.mas,**/*.master,**/*.mi,**/*.php,**/*.shtml,**/*.skin,**/*.svg,**/*.tag,**/*.vm,**/*.xhtml
Java **/*.java,**/*.jsp,**/*.jspf,**/*.jspx
JavaScript **/*.as,**/*.asax,**/*.ascx,**/*.asp,**/*.aspx,**/*.cshtml,**/*.ejs,**/*.htm,**/*.html,**/*.js,**/*.jsp,**/*.jspf,**/*.jspx,**/*.mas,**/*.mi,**/*.php,**/*.xhtml
Objective-C **/*.h,**/*.m,**/*.mm
Perl **/*.mas,**/*.mi,**/*.perl,**/*.pl,**/*.plx,**/*.pm
PHP **/*.inc,**/*.php
SQL **/*.sqc,**/*.sql,**/*.sqx
Swift2 **/*.swift
VB **/*.ascx,**/*.asp,**/*.aspx,**/*.bas,**/*.cls,**/*.ctl,**/*.dob,**/*.dsr,**/*.frm,**/*.pag,**/*.vb
VBscript **/*.asax,**/*.ascx,**/*.asp,**/*.aspx,**/*.htm,**/*.html,**/*.vbs,**/*.xhtml
XML **/*.jspx,**/*.mxml,**/*.storyboard,**/*.tld,**/*.vcxproj,**/*.wsdd,**/*.wsdl,**/*.xaml,**/*.xhtml,**/*.xib,**/*.xlf,**/*.xml,**/*.xsd,**/*.xsl,**/*.xslt,**/*.xul