Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{iframe:src=http://updateredirect.sonarsource.orgcom/plugins/xml.html|width=700|height=250300|frameborder=0}
YourDocumentation browserhas doesbeen notmoved support iframes.
{iframe}

Description / Features

This plugin enables analysis of XML files within SonarQubeTM.

Some common use cases are:

  • Validation of XHTML files against schemas provided by the W3C (strict, transitional, and others)
  • Validation of XML files against a provided XML schema
  • Validation of rules in XML files (ex: validate the Maven pom files against coding standards)
It is compatible with the Issues Report plugin to run pre-commit local analysis.

Installation

  1. Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
  2. Restart the SonarQubeTM server

Usage

Run anAnalysis with the SonarQubeTM Runner (Recommended Way)

To run an analysis of your XML project, use the SonarQubeTM Runner.

A sample project is available on github that can be browsed or downloaded/projects/languages/xml/xml-sonar-runner.

Run an Analysis with the other Analyzers

Maven and Ant can also be used to launch analysis on XML projects.

Validating Files Against Specific Schemas

Files can be validated against specific schemas thanks to the XML Schema Validation rule.

Within the same project some files can be validated against schema 'S1', others against schema 'S2', others against schemas 'S3' and 'S4', and so on. So, this rule has to be copied and configured as many times as you have pairs of files/schemas.

Notes:

  • Schema validation is performed by the Xerces parser using XML schemas (XSDs).
  • For validation of XHTML files it is recommended to use autodetect, xhtml1-transitional or xhtml1-strict.

Custom Checks Using XPath Expressions

The XPath rule allows to define custom rules on XML documents using XPath expressions.

Within the same project some files can be checked against XPath rules 'R1', 'R2', etc., others against rules 'R6', 'R7', etc. and so on. So, this rule has to be copied and configured as many times as you have pairs of files/rule.

Metrics

See Metrics documentation page.

Change Log

JIRA Issues
anonymoustrue
titleRelease 1.0 (not yet released)
renderModestatic
width900
columnstype;key;summary;priority
urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=18452&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000

 

JIRA Issues
anonymoustrue
titleRelease 0.2
renderModestatic
width900
columnstype;key;summary;priority
urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=17353&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000

 

JIRA Issues
anonymoustrue
titleRelease 0.1
renderModestatic
width900
columnstype;key;summary;priority
urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=17345&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000

to [http://redirect.sonarsource.com/plugins/xml.html].
{iframe}