How mulesoft-catalyst/mule-sonarqube-plugin works
This is a SonarQube plugin for inspecting Mule configuration and DataWeave code. The main workflow registers Mule language/rules, scans Mule XML and .dwl files, evaluates rules, and reports issues and measures to SonarQube. Separate branches import MUnit coverage and calculate configuration metrics. Relationships below are limited to README statements and source-index references; unsampled modules are represented only where the tree supports their paths.
Main entry points: MulePlugin.java Plugin Registration · DataWeaveSensor.java DataWeave Sensor · CoverageSensor.java MUnit Coverage Import · MuleSensor.java Mule XML Sensor
Components 24
Plugin Setup
- Plugin Registration
src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java - Mule Language
src/main/java/com/mulesoft/services/tools/sonarqube/language/MuleLanguage.java - Quality Profiles
src/main/java/com/mulesoft/services/tools/sonarqube/profile/MuleQualityProfile.java - Plugin Properties
src/main/java/com/mulesoft/services/tools/sonarqube/properties/MuleProperties.java
Mule Analysis
- XML File Selection
src/main/java/com/mulesoft/services/tools/sonarqube/filter/MuleFilePredicate.java - Mule XML Sensor
src/main/java/com/mulesoft/services/tools/sonarqube/sensor/MuleSensor.java - Rule Scopes
src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/ScopeStrategy.java - Issue Locations
src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/IssueLocations.java
DataWeave Analysis
- DataWeave Sensor
src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java - DataWeave File Selection
src/main/java/com/mulesoft/services/tools/sonarqube/filter/DataWeaveFilePredicate.java - Commented Code Detector
src/main/java/com/mulesoft/services/tools/sonarqube/dataweave/DataWeaveCommentedOutCodeDetector.java - DataWeave Text Utilities
src/main/java/com/mulesoft/services/tools/sonarqube/dataweave/DataWeaveTextUtils.java
Rule Evaluation
- Mule Rule Definitions
src/main/java/com/mulesoft/services/tools/sonarqube/rule/MuleRulesDefinition.java - DataWeave Rule Definitions
src/main/java/com/mulesoft/services/tools/sonarqube/rule/DataWeaveRulesDefinition.java - Rule Store Loader
src/main/java/com/mulesoft/services/tools/validation/RuleFactory.java - Rule Store Model
src/main/java/com/mulesoft/services/tools/validation/rules/Ruleset.java - XPath Processor
src/main/java/com/mulesoft/services/xpath/XPathProcessor.java - Hardened XML Parser
src/main/java/com/mulesoft/services/tools/sonarqube/xml/SecureSaxBuilder.java
Measures and Coverage
- MUnit Coverage Import
src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java - Flow Coverage Counter
src/main/java/com/mulesoft/services/tools/sonarqube/metrics/FlowCoverageCounter.java - Custom Metrics
src/main/java/com/mulesoft/services/tools/sonarqube/metrics/MuleMetrics.java - Configuration Metrics
src/main/java/com/mulesoft/services/tools/sonarqube/metrics/ConfigurationFilesSensor.java
Other components
- Project Analysis
- SonarQube
Connections 27
- Project Analysis → Plugin Registration: runs analysis
README.md - Plugin Registration → Mule Language: registers
src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java - Plugin Registration → Mule Rule Definitions: registers
src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java - Plugin Registration → DataWeave Rule Definitions: registers
src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java - Plugin Registration → Mule XML Sensor: registers
src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java - Plugin Registration → DataWeave Sensor: registers
src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java - Plugin Registration → MUnit Coverage Import: registers
src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java - Plugin Registration → Quality Profiles: registers
src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java - Mule Rule Definitions → Rule Store Loader: loads rules
src/main/java/com/mulesoft/services/tools/sonarqube/rule/MuleRulesDefinition.java - DataWeave Rule Definitions → Rule Store Loader: loads rules
src/main/java/com/mulesoft/services/tools/sonarqube/rule/DataWeaveRulesDefinition.java - Rule Store Loader → Rule Store Model: builds model
src/main/java/com/mulesoft/services/tools/validation/RuleFactory.java - Quality Profiles → Rule Store Loader: loads rules
src/main/java/com/mulesoft/services/tools/sonarqube/profile/MuleQualityProfile.java - Mule XML Sensor → Rule Scopes: evaluates scopes
- Rule Scopes → XPath Processor: evaluates expressions
src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/FileStrategyScope.java - Rule Scopes → Hardened XML Parser: parses securely
src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/FileStrategyScope.java - Mule XML Sensor → XML File Selection: selects files
src/main/java/com/mulesoft/services/tools/sonarqube/sensor/MuleSensor.java - DataWeave Sensor → DataWeave File Selection: selects files
src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java - DataWeave Sensor → DataWeave Rule Definitions: uses rule definitions
src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java - DataWeave Sensor → Commented Code Detector: detects commented code
src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java - DataWeave Sensor → DataWeave Text Utilities: uses text utilities
src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java - MUnit Coverage Import → Flow Coverage Counter: counts coverage
src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java - MUnit Coverage Import → XML File Selection: selects files
src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java - MUnit Coverage Import → SonarQube: imports coverage
README.md - Configuration Metrics → Custom Metrics: reports measures
src/main/java/com/mulesoft/services/tools/sonarqube/metrics/ConfigurationFilesSensor.java - MUnit Coverage Import → SonarQube: reports coverage
README.md - Mule XML Sensor → SonarQube: reports issues
- DataWeave Sensor → SonarQube: reports issues
README.md