CoberturaParser.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2013-2026 The Coveralls Maven Plugin Project Contributors:
 *     https://github.com/hazendaz/coveralls-maven-plugin/graphs/contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.eluder.coveralls.maven.plugin.parser;

import java.io.File;
import java.io.IOException;

import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;

import org.eluder.coveralls.maven.plugin.ProcessingException;
import org.eluder.coveralls.maven.plugin.domain.Source;
import org.eluder.coveralls.maven.plugin.source.SourceCallback;
import org.eluder.coveralls.maven.plugin.source.SourceLoader;

/**
 * The Class CoberturaParser.
 *
 * @deprecated As Cobertura is no longer maintained, this parser may be dropped in a future release.
 */
@Deprecated(since = "5.0.0", forRemoval = true)
public class CoberturaParser extends AbstractXmlEventParser {

    /** The source. */
    protected Source source;

    /** The in methods. */
    protected boolean inMethods;

    /** The branch id. */
    private int branchId;

    /**
     * Instantiates a new cobertura parser.
     *
     * @param coverageFile
     *            the coverage file
     * @param sourceLoader
     *            the source loader
     */
    public CoberturaParser(final File coverageFile, final SourceLoader sourceLoader) {
        super(coverageFile, sourceLoader);
    }

    @Override
    protected void onEvent(final XMLStreamReader xml, final SourceCallback callback)
            throws XMLStreamException, ProcessingException, IOException {
        if (this.isStartElement(xml, "class")) {
            this.source = this.loadSource(xml.getAttributeValue(null, "filename"));
            final var className = xml.getAttributeValue(null, "name");
            final var classifierPosition = className.indexOf('$');
            if (classifierPosition > 0) {
                this.source.setClassifier(className.substring(classifierPosition + 1));
            }
            this.branchId = 0;
        } else if (this.isStartElement(xml, "methods") && this.source != null) {
            this.inMethods = true;
        } else if (this.isEndElement(xml, "methods") && this.source != null) {
            this.inMethods = false;
        } else if (this.isStartElement(xml, "line") && !this.inMethods && this.source != null) {
            final var nr = Integer.parseInt(xml.getAttributeValue(null, "number"));
            this.source.addCoverage(nr, Integer.valueOf(xml.getAttributeValue(null, "hits")));
            if (Boolean.parseBoolean(xml.getAttributeValue(null, "branch"))) {
                final var value = xml.getAttributeValue(null, "condition-coverage");

                // Is "condition-coverage" attribute always here?
                if (value == null) {
                    return;
                }

                // C'mon Cobertura, human readable format for XML ?
                final var values = value // 50% (2/4)
                        .replace(" ", "") // 50%(2/4)
                        .replace("%", "/") // 50/(2/4)
                        .replace("(", "") // 50/2/4)
                        .replace(")", "") // 50/2/4
                        .split("/", -1);

                final var cb = Integer.parseInt(values[1]);
                final var tb = Integer.parseInt(values[2]);
                final var mb = tb - cb;

                // add branches. unfortunately, there is NO block number and
                // branch number will NOT be unique between coverage changes.
                for (var b = 0; b < cb; b++) {
                    this.source.addBranchCoverage(nr, 0, this.branchId++, 1);
                }
                for (var b = 0; b < mb; b++) {
                    this.source.addBranchCoverage(nr, 0, this.branchId++, 0);
                }
            }
        } else if (this.isEndElement(xml, "class") && this.source != null) {
            callback.onSource(this.source);
            this.source = null;
        }
    }

}