View Javadoc
1   /*
2    * The MIT License (MIT)
3    *
4    * Copyright (c) 2013-2026 The Coveralls Maven Plugin Project Contributors:
5    *     https://github.com/hazendaz/coveralls-maven-plugin/graphs/contributors
6    *
7    * Permission is hereby granted, free of charge, to any person obtaining a copy
8    * of this software and associated documentation files (the "Software"), to deal
9    * in the Software without restriction, including without limitation the rights
10   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11   * copies of the Software, and to permit persons to whom the Software is
12   * furnished to do so, subject to the following conditions:
13   *
14   * The above copyright notice and this permission notice shall be included in
15   * all copies or substantial portions of the Software.
16   *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23   * THE SOFTWARE.
24   */
25  package org.eluder.coveralls.maven.plugin.parser;
26  
27  import java.io.File;
28  import java.io.IOException;
29  
30  import javax.xml.stream.XMLStreamException;
31  import javax.xml.stream.XMLStreamReader;
32  
33  import org.eluder.coveralls.maven.plugin.ProcessingException;
34  import org.eluder.coveralls.maven.plugin.domain.Source;
35  import org.eluder.coveralls.maven.plugin.source.SourceCallback;
36  import org.eluder.coveralls.maven.plugin.source.SourceLoader;
37  
38  /**
39   * The Class CoberturaParser.
40   *
41   * @deprecated As Cobertura is no longer maintained, this parser may be dropped in a future release.
42   */
43  @Deprecated(since = "5.0.0", forRemoval = true)
44  public class CoberturaParser extends AbstractXmlEventParser {
45  
46      /** The source. */
47      protected Source source;
48  
49      /** The in methods. */
50      protected boolean inMethods;
51  
52      /** The branch id. */
53      private int branchId;
54  
55      /**
56       * Instantiates a new cobertura parser.
57       *
58       * @param coverageFile
59       *            the coverage file
60       * @param sourceLoader
61       *            the source loader
62       */
63      public CoberturaParser(final File coverageFile, final SourceLoader sourceLoader) {
64          super(coverageFile, sourceLoader);
65      }
66  
67      @Override
68      protected void onEvent(final XMLStreamReader xml, final SourceCallback callback)
69              throws XMLStreamException, ProcessingException, IOException {
70          if (this.isStartElement(xml, "class")) {
71              this.source = this.loadSource(xml.getAttributeValue(null, "filename"));
72              final var className = xml.getAttributeValue(null, "name");
73              final var classifierPosition = className.indexOf('$');
74              if (classifierPosition > 0) {
75                  this.source.setClassifier(className.substring(classifierPosition + 1));
76              }
77              this.branchId = 0;
78          } else if (this.isStartElement(xml, "methods") && this.source != null) {
79              this.inMethods = true;
80          } else if (this.isEndElement(xml, "methods") && this.source != null) {
81              this.inMethods = false;
82          } else if (this.isStartElement(xml, "line") && !this.inMethods && this.source != null) {
83              final var nr = Integer.parseInt(xml.getAttributeValue(null, "number"));
84              this.source.addCoverage(nr, Integer.valueOf(xml.getAttributeValue(null, "hits")));
85              if (Boolean.parseBoolean(xml.getAttributeValue(null, "branch"))) {
86                  final var value = xml.getAttributeValue(null, "condition-coverage");
87  
88                  // Is "condition-coverage" attribute always here?
89                  if (value == null) {
90                      return;
91                  }
92  
93                  // C'mon Cobertura, human readable format for XML ?
94                  final var values = value // 50% (2/4)
95                          .replace(" ", "") // 50%(2/4)
96                          .replace("%", "/") // 50/(2/4)
97                          .replace("(", "") // 50/2/4)
98                          .replace(")", "") // 50/2/4
99                          .split("/", -1);
100 
101                 final var cb = Integer.parseInt(values[1]);
102                 final var tb = Integer.parseInt(values[2]);
103                 final var mb = tb - cb;
104 
105                 // add branches. unfortunately, there is NO block number and
106                 // branch number will NOT be unique between coverage changes.
107                 for (var b = 0; b < cb; b++) {
108                     this.source.addBranchCoverage(nr, 0, this.branchId++, 1);
109                 }
110                 for (var b = 0; b < mb; b++) {
111                     this.source.addBranchCoverage(nr, 0, this.branchId++, 0);
112                 }
113             }
114         } else if (this.isEndElement(xml, "class") && this.source != null) {
115             callback.onSource(this.source);
116             this.source = null;
117         }
118     }
119 
120 }