Merge pull request #2 from thedavidharris/master

chore: add Sonarqube XML exporter

Author: twittemb

Sources/Core/Commands/GenerateCommand.swift

@@ -14,12 +14,15 @@ public extension Xccov.Commands {
 public extension Xccov.Commands.Generate {
     enum Output: String, ExpressibleByArgument {
         case coberturaXml = "cobertura-xml"
+        case sonarqubeXml = "sonarqube-xml"
         case failable = "failable"
 
         var converter: Xccov.Converters.Converter {
             switch self {
             case .coberturaXml:
                 return Xccov.Converters.CoberturaXml.convert(coverageReport:)
+            case .sonarqubeXml:
+                return Xccov.Converters.SonarqubeXml.convert(coverageReport:)
             case .failable:
                 return Xccov.Converters.FailableConverter.convert(coverageReport:)
             }
@@ -29,8 +32,11 @@ public extension Xccov.Commands.Generate {
             switch self {
             case .coberturaXml:
                 return "cobertura.xml"
+            case .sonarqubeXml:
+                return "sonarqube.xml"
             case .failable:
                 return "failable.xml"
+            
             }
         }
     }

Sources/Core/Converters/CoberturaXmlConverter.swift

@@ -11,16 +11,6 @@ public extension Xccov.Converters {
     enum CoberturaXml {}
 }
 
-extension XMLNode {
-    static func nodeAttribute(withName name: String, stringValue value: String) -> XMLNode {
-        guard let attribute = XMLNode.attribute(withName: name, stringValue: value) as? XMLNode else {
-            return XMLNode()
-        }
-
-        return attribute
-    }
-}
-
 public extension Xccov.Converters.CoberturaXml {
     static func convert(coverageReport: CoverageReport) -> Result<String, Xccov.Error> {
         Self.convert(coverageReport: coverageReport,

Sources/Core/Converters/SonarqubeXmlConverter.swift

@@ -0,0 +1,63 @@
+//
+//  SonarqubeXmlConverter.swift
+//  
+//
+//  Created by Harris, David (D.A.) on 1/19/21.
+//
+
+import Foundation
+
+public extension Xccov.Converters {
+    enum SonarqubeXml {}
+}
+
+public extension Xccov.Converters.SonarqubeXml {
+    static func convert(coverageReport: CoverageReport) -> Result<String, Xccov.Error> {
+        let rootElement = XMLElement(name: "coverage")
+        rootElement.addAttribute(XMLNode.nodeAttribute(withName: "version", stringValue: "1"))
+        
+        let doc = XMLDocument(rootElement: rootElement)
+
+        // Sort files to avoid duplicated packages
+        let allFiles = coverageReport.targets.flatMap { $0.files }.sorted { $0.path < $1.path }
+
+        
+        allFiles.forEach { fileCoverageReport in
+            let filePath = fileCoverageReport.path
+            
+            let fileElement = XMLElement(name: "file")
+            fileElement.addAttribute(XMLNode.nodeAttribute(withName: "path", stringValue: filePath))
+            
+            rootElement.addChild(fileElement)
+            
+            for functionCoverageReport in fileCoverageReport.functions {
+                for index in 0..<functionCoverageReport.executableLines {
+                    let lineElement = XMLElement(kind: .element, options: .nodeCompactEmptyElement)
+                    lineElement.name = "lineToCover"
+                    
+                    lineElement.addAttribute(XMLNode.nodeAttribute(withName: "lineNumber", stringValue: "\(functionCoverageReport.lineNumber + index)"))
+                    
+                    let lineHits: Int
+                    if index < functionCoverageReport.coveredLines {
+                        lineHits = functionCoverageReport.executionCount
+                    } else {
+                        lineHits = 0
+                    }
+                    
+                    if lineHits > 0 {
+                        lineElement.addAttribute(XMLNode.nodeAttribute(withName: "covered", stringValue: "true"))
+                    } else {
+                        lineElement.addAttribute(XMLNode.nodeAttribute(withName: "covered", stringValue: "false"))
+                    }
+                    
+                    fileElement.addChild(lineElement)
+                }
+            }
+            
+        }
+        
+
+        return .success(doc.xmlString(options: [.nodePrettyPrint]))
+    }
+}
+

Sources/Core/Converters/XmlNode+NodeAttribute.swift

@@ -0,0 +1,18 @@
+//
+//  XMLNode+NodeAttribute.swift
+//  
+//
+//  Created by Harris, David (D.A.) on 1/20/21.
+//
+
+import Foundation
+
+extension XMLNode {
+    static func nodeAttribute(withName name: String, stringValue value: String) -> XMLNode {
+        guard let attribute = XMLNode.attribute(withName: name, stringValue: value) as? XMLNode else {
+            return XMLNode()
+        }
+
+        return attribute
+    }
+}

Tests/CoreTests/Converters/CoberturaXmlConverterTests.swift

@@ -21,7 +21,7 @@ final class CoberturaXmlConverterTests: XCTestCase {
         let receivedResult = try! result.get()
 
         // Then: the xml is the expected one
-        XCTAssertEqual(receivedResult, converterFixtureCoverageXml)
+        XCTAssertEqual(receivedResult, coberturaFixtureCoverageXml)
     }
 
     static var allTests = [

Tests/CoreTests/Converters/Fixtures/ConverterCoverageXml.swift

@@ -5,7 +5,7 @@
 //  Created by Thibault Wittemberg on 2020-07-04.
 //
 
-let converterFixtureCoverageXml = """
+let coberturaFixtureCoverageXml = """
 <?xml version="1.0"?>
 <!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd" [
     <!ELEMENT coverage (sources?, packages)>