# mulesoft-catalyst/mule-sonarqube-plugin architecture

> Architecture diagram of the GitHub repository mulesoft-catalyst/mule-sonarqube-plugin, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mulesoft-catalyst/mule-sonarqube-plugin
- Repository: https://github.com/mulesoft-catalyst/mule-sonarqube-plugin

## Overview

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: [`src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java`](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java) (Plugin Registration), [`src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java`](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java) (DataWeave Sensor), [`src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java`](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java) (MUnit Coverage Import), [`src/main/java/com/mulesoft/services/tools/sonarqube/sensor/MuleSensor.java`](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/sensor/MuleSensor.java) (Mule XML Sensor)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_plugin["Plugin Setup"]
  node_plugin["Plugin Registration<br/>[MulePlugin.java]"]
  node_language["Mule Language<br/>[MuleLanguage.java]"]
  node_profiles["Quality Profiles"]
  node_properties["Plugin Properties"]
end

subgraph group_mule["Mule Analysis"]
  node_mulefilter["XML File Selection"]
  node_mulesensor["Mule XML Sensor<br/>[MuleSensor.java]"]
  node_scope["Rule Scopes<br/>[ScopeStrategy.java]"]
  node_locations["Issue Locations"]
end

subgraph group_dw["DataWeave Analysis"]
  node_dwsensor["DataWeave Sensor"]
  node_dwfilter["DataWeave File Selection"]
  node_dwdetector["Commented Code Detector"]
  node_dwutils["DataWeave Text Utilities"]
end

subgraph group_shared["Rule Evaluation"]
  node_muledefs["Mule Rule Definitions"]
  node_dwdefs["DataWeave Rule Definitions"]
  node_rulefactory["Rule Store Loader<br/>[RuleFactory.java]"]
  node_rulemodel["Rule Store Model<br/>[Ruleset.java]"]
  node_xpath["XPath Processor"]
  node_securexml["Hardened XML Parser"]
end

subgraph group_report["Measures and Coverage"]
  node_coverage["MUnit Coverage Import"]
  node_flowcoverage["Flow Coverage Counter"]
  node_metrics["Custom Metrics<br/>[MuleMetrics.java]"]
  node_configmetrics["Configuration Metrics"]
end

node_analyst(("Project Analysis"))
node_sonar(("SonarQube"))

node_analyst -->|"runs analysis"| node_plugin
node_plugin -->|"registers"| node_language
node_plugin -->|"registers"| node_muledefs
node_plugin -->|"registers"| node_dwdefs
node_plugin -->|"registers"| node_mulesensor
node_plugin -->|"registers"| node_dwsensor
node_plugin -->|"registers"| node_coverage
node_plugin -->|"registers"| node_profiles
node_muledefs -->|"loads rules"| node_rulefactory
node_dwdefs -->|"loads rules"| node_rulefactory
node_rulefactory -->|"builds model"| node_rulemodel
node_profiles -->|"loads rules"| node_rulefactory
node_mulesensor -.->|"evaluates scopes"| node_scope
node_scope -->|"evaluates expressions"| node_xpath
node_scope -->|"parses securely"| node_securexml
node_mulesensor -.->|"selects files"| node_mulefilter
node_dwsensor -->|"selects files"| node_dwfilter
node_dwsensor -->|"uses rule definitions"| node_dwdefs
node_dwsensor -->|"detects commented code"| node_dwdetector
node_dwsensor -->|"uses text utilities"| node_dwutils
node_coverage -->|"counts coverage"| node_flowcoverage
node_coverage -->|"selects files"| node_mulefilter
node_coverage -->|"imports coverage"| node_sonar
node_configmetrics -.->|"reports measures"| node_metrics
node_coverage -->|"reports coverage"| node_sonar
node_mulesensor -.->|"reports issues"| node_sonar
node_dwsensor -->|"reports issues"| node_sonar

click node_plugin "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java"
click node_language "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/language/MuleLanguage.java"
click node_profiles "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/profile/MuleQualityProfile.java"
click node_properties "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/properties/MuleProperties.java"
click node_mulefilter "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/filter/MuleFilePredicate.java"
click node_mulesensor "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/sensor/MuleSensor.java"
click node_scope "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/ScopeStrategy.java"
click node_locations "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/IssueLocations.java"
click node_muledefs "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/rule/MuleRulesDefinition.java"
click node_dwdefs "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/rule/DataWeaveRulesDefinition.java"
click node_rulefactory "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/validation/RuleFactory.java"
click node_rulemodel "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/validation/rules/Ruleset.java"
click node_xpath "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/xpath/XPathProcessor.java"
click node_securexml "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/xml/SecureSaxBuilder.java"
click node_dwsensor "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java"
click node_dwfilter "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/filter/DataWeaveFilePredicate.java"
click node_dwdetector "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/dataweave/DataWeaveCommentedOutCodeDetector.java"
click node_dwutils "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/dataweave/DataWeaveTextUtils.java"
click node_coverage "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java"
click node_flowcoverage "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/metrics/FlowCoverageCounter.java"
click node_metrics "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/metrics/MuleMetrics.java"
click node_configmetrics "https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/metrics/ConfigurationFilesSensor.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_plugin,node_language,node_profiles,node_properties toneBlue
class node_mulefilter,node_mulesensor,node_scope,node_locations toneAmber
class node_dwsensor,node_dwfilter,node_dwdetector,node_dwutils toneMint
class node_muledefs,node_dwdefs,node_rulefactory,node_rulemodel,node_xpath,node_securexml toneRose
class node_coverage,node_flowcoverage,node_metrics,node_configmetrics,node_analyst,node_sonar toneIndigo
```

## Components

### Plugin Setup

- [Plugin Registration](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java): `src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java`
- [Mule Language](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/language/MuleLanguage.java): `src/main/java/com/mulesoft/services/tools/sonarqube/language/MuleLanguage.java`
- [Quality Profiles](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/profile/MuleQualityProfile.java): `src/main/java/com/mulesoft/services/tools/sonarqube/profile/MuleQualityProfile.java`
- [Plugin Properties](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/properties/MuleProperties.java): `src/main/java/com/mulesoft/services/tools/sonarqube/properties/MuleProperties.java`

### Mule Analysis

- [XML File Selection](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/filter/MuleFilePredicate.java): `src/main/java/com/mulesoft/services/tools/sonarqube/filter/MuleFilePredicate.java`
- [Mule XML Sensor](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/sensor/MuleSensor.java): `src/main/java/com/mulesoft/services/tools/sonarqube/sensor/MuleSensor.java`
- [Rule Scopes](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/ScopeStrategy.java): `src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/ScopeStrategy.java`
- [Issue Locations](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/IssueLocations.java): `src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/IssueLocations.java`

### DataWeave Analysis

- [DataWeave Sensor](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java): `src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java`
- [DataWeave File Selection](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/filter/DataWeaveFilePredicate.java): `src/main/java/com/mulesoft/services/tools/sonarqube/filter/DataWeaveFilePredicate.java`
- [Commented Code Detector](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/dataweave/DataWeaveCommentedOutCodeDetector.java): `src/main/java/com/mulesoft/services/tools/sonarqube/dataweave/DataWeaveCommentedOutCodeDetector.java`
- [DataWeave Text Utilities](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/dataweave/DataWeaveTextUtils.java): `src/main/java/com/mulesoft/services/tools/sonarqube/dataweave/DataWeaveTextUtils.java`

### Rule Evaluation

- [Mule Rule Definitions](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/rule/MuleRulesDefinition.java): `src/main/java/com/mulesoft/services/tools/sonarqube/rule/MuleRulesDefinition.java`
- [DataWeave Rule Definitions](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/rule/DataWeaveRulesDefinition.java): `src/main/java/com/mulesoft/services/tools/sonarqube/rule/DataWeaveRulesDefinition.java`
- [Rule Store Loader](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/validation/RuleFactory.java): `src/main/java/com/mulesoft/services/tools/validation/RuleFactory.java`
- [Rule Store Model](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/validation/rules/Ruleset.java): `src/main/java/com/mulesoft/services/tools/validation/rules/Ruleset.java`
- [XPath Processor](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/xpath/XPathProcessor.java): `src/main/java/com/mulesoft/services/xpath/XPathProcessor.java`
- [Hardened XML Parser](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/xml/SecureSaxBuilder.java): `src/main/java/com/mulesoft/services/tools/sonarqube/xml/SecureSaxBuilder.java`

### Measures and Coverage

- [MUnit Coverage Import](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java): `src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java`
- [Flow Coverage Counter](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/metrics/FlowCoverageCounter.java): `src/main/java/com/mulesoft/services/tools/sonarqube/metrics/FlowCoverageCounter.java`
- [Custom Metrics](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/metrics/MuleMetrics.java): `src/main/java/com/mulesoft/services/tools/sonarqube/metrics/MuleMetrics.java`
- [Configuration Metrics](https://github.com/mulesoft-catalyst/mule-sonarqube-plugin/blob/master/src/main/java/com/mulesoft/services/tools/sonarqube/metrics/ConfigurationFilesSensor.java): `src/main/java/com/mulesoft/services/tools/sonarqube/metrics/ConfigurationFilesSensor.java`

### Other components

- **Project Analysis**
- **SonarQube**

## Connections

- Project Analysis → Plugin Registration: runs analysis (evidence: `README.md`)
- Plugin Registration → Mule Language: registers (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java`)
- Plugin Registration → Mule Rule Definitions: registers (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java`)
- Plugin Registration → DataWeave Rule Definitions: registers (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java`)
- Plugin Registration → Mule XML Sensor: registers (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java`)
- Plugin Registration → DataWeave Sensor: registers (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java`)
- Plugin Registration → MUnit Coverage Import: registers (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java`)
- Plugin Registration → Quality Profiles: registers (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/MulePlugin.java`)
- Mule Rule Definitions → Rule Store Loader: loads rules (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/rule/MuleRulesDefinition.java`)
- DataWeave Rule Definitions → Rule Store Loader: loads rules (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/rule/DataWeaveRulesDefinition.java`)
- Rule Store Loader → Rule Store Model: builds model (evidence: `src/main/java/com/mulesoft/services/tools/validation/RuleFactory.java`)
- Quality Profiles → Rule Store Loader: loads rules (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/profile/MuleQualityProfile.java`)
- Mule XML Sensor → Rule Scopes: evaluates scopes
- Rule Scopes → XPath Processor: evaluates expressions (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/FileStrategyScope.java`)
- Rule Scopes → Hardened XML Parser: parses securely (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/rule/scope/FileStrategyScope.java`)
- Mule XML Sensor → XML File Selection: selects files (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/sensor/MuleSensor.java`)
- DataWeave Sensor → DataWeave File Selection: selects files (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java`)
- DataWeave Sensor → DataWeave Rule Definitions: uses rule definitions (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java`)
- DataWeave Sensor → Commented Code Detector: detects commented code (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java`)
- DataWeave Sensor → DataWeave Text Utilities: uses text utilities (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/sensor/DataWeaveSensor.java`)
- MUnit Coverage Import → Flow Coverage Counter: counts coverage (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java`)
- MUnit Coverage Import → XML File Selection: selects files (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/metrics/CoverageSensor.java`)
- MUnit Coverage Import → SonarQube: imports coverage (evidence: `README.md`)
- Configuration Metrics → Custom Metrics: reports measures (evidence: `src/main/java/com/mulesoft/services/tools/sonarqube/metrics/ConfigurationFilesSensor.java`)
- MUnit Coverage Import → SonarQube: reports coverage (evidence: `README.md`)
- Mule XML Sensor → SonarQube: reports issues
- DataWeave Sensor → SonarQube: reports issues (evidence: `README.md`)
