Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents

Table of Contents

Analysis Modes

ConceptDefinition
AnalysisStandard way to analyze the source code. The source code is analyzed and measures and issues are pushed to the SonarQube database. The results of the analysis can be browsed through the web interface.
Preview

The source code is analyzed but the measures and issues are not pushed to the SonarQube database. Therefore, they cannot be browsed through the web interface. This mode can be used with the Issues Report plugin, which generates an HTML issues report to local file.

IncrementalSame as Preview mode but only new or modified files (compared to the latest version available on the remote server) are analyzed. This is the default mode of the SonarQube Eclipse plugin and the SonarQube IntelliJ plugin.

Architecture

Client
ConceptDefinitionRelated Topics
Anchor
analyzer
analyzer
Analyzer
Batch A client application that analyzes the source code to compute snapshots.See Architecture Overview.
Anchor
clientclient

Batch that runs the analyzers.

See Architecture the SonarQube Platform Overview.
Anchor
database
database
Database

Stores:

  • configuration
  • snapshots
See Architecture the SonarQube Platform Overview.
Anchor
server
server
Server
 Web Server that  Web interface that is used to navigate the snapshots browse snapshot data and make configuration changesSee Architecture the SonarQube Platform Overview .

 

Quality

Issue
ConceptDefinitionRelated Topics
Check

Check = Coding Rule.

 
Anchor
codingRule
codingRule
Coding Rule

A good coding practice. Not complying to coding rules leads to quality flaws and creation of issues in SonarQubeTM.

Coding rules can check quality on files, unit tests or packages.

See Viewing Unit Tests > Issues TabPerspective
Anchor
resource
resource
Component
A piece of software (project, module/package, file) or a view or a developer. 
Anchor
issue
issue
Issue

When a component does not comply with a coding rule, an issue is logged (was violation prior to SonarQube 3.6) on the snapshot.

An issue can be logged on a source file or a unit test file.

 
Anchor
measure
measure
Measure

The value of a metric for a given component at a given time.

Examples:

  • 125 lines of code on class MyClass
  • Density of duplicated lines of 30.5% on project myProject
 
Anchor
metric
metric
Metric

A property type of a resource. measurement. Metrics can have varying values, or measures, over time. Examples: number of lines of code, complexity, etc.

A metric may be either:

  • qualitative: gives a quality indication on the resource component (ex: density of duplicated lines, line coverage by unit tests, etc.)
  • or quantitative: does not give a quality indication on the resource component (ex: number of lines of code, complexity, etc.)

The value of the metric for a given resource is called measure.

See detailed documentation on metrics.
Anchor
measuremeasure
Measure

The value of a metric for a given resource at a given time.

Examples:

  • 125 lines of code on class myClass
  • Density of duplicated lines of 30.5% on project myProject
 
Anchor
qualityProfile
qualityProfile
Quality Profile

A set of coding rules.

Each snapshot is based on a single quality profile.

See Quality Profiles.
Anchor
resourceresource
Resource
A piece of software. Examples: project, package, module, file, etc. 
Anchor
snaphshot
snaphshot
Snapshot

A set of measures and issues on a given resource component at a given time.

A snapshot is generated for each analysis.

 
Anchor
issueissue

When a resource does not comply with a coding rule, an issue is logged (was violation prior to SonarQubeTM 3.6) on the snapshot.

An issue can be logged on a source file or a unit test file.

Non-functional requirementNon-functional requirement = coding rule 

Web Interface

 

ConceptDefinitionRelated Topics
Anchor
dashboard
dashboard
Dashboard

Web page that provides a way to display any data stored in the database.

A dashboard is a set of widgets.

See Project Dashboards., Global Dashboards

Anchor
widget
widget
Widget

It is a box that displays data on a dashboard.

There are two types of widget:

  • Global widget that can display - displays data from multiple projects
  • Project widget that only - displays data from a specific project

 

 

http://docs.codehaus.org/display/SONAR/Documentation

Anchor
drilldown
drilldown
Drilldown
A file-specific presentation of measure data. Some metrics have specialized presentations.