org.sonar.plugins.javascript.integrationtests.parser.SurefireStaxHandler.java Source code

Introduction

Here is the source code for org.sonar.plugins.javascript.integrationtests.parser.SurefireStaxHandler.java

Source

/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011 SonarSource and Eriks Nukis
 * sonarqube@googlegroups.com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.plugins.javascript.integrationtests.parser;

import org.apache.commons.lang.StringUtils;
import org.codehaus.staxmate.in.ElementFilter;
import org.codehaus.staxmate.in.SMEvent;
import org.codehaus.staxmate.in.SMHierarchicCursor;
import org.codehaus.staxmate.in.SMInputCursor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.utils.ParsingUtils;
import org.sonar.api.utils.StaxParser;

import javax.xml.stream.XMLStreamException;
import java.text.ParseException;
import java.util.Locale;

public class SurefireStaxHandler implements StaxParser.XmlStreamHandler {
    private static final Logger LOGGER = LoggerFactory.getLogger(SurefireStaxHandler.class);

    private final IntegrationTestIndex index;

    public SurefireStaxHandler(IntegrationTestIndex index) {
        this.index = index;
    }

    @Override
    public void stream(SMHierarchicCursor rootCursor) throws XMLStreamException {
        SMInputCursor testSuite = rootCursor.constructDescendantCursor(new ElementFilter("testsuite"));
        SMEvent testSuiteEvent;
        for (testSuiteEvent = testSuite.getNext(); testSuiteEvent != null; testSuiteEvent = testSuite.getNext()) {
            if (testSuiteEvent.compareTo(SMEvent.START_ELEMENT) == 0) {
                String testSuiteClassName = testSuite.getAttrValue("name");
                if (StringUtils.contains(testSuiteClassName, "$")) {
                    // test suites for inner classes are ignored
                    return;
                }
                SMInputCursor testCase = testSuite.childCursor(new ElementFilter("testcase"));
                SMEvent event;
                for (event = testCase.getNext(); event != null; event = testCase.getNext()) {
                    if (event.compareTo(SMEvent.START_ELEMENT) == 0) {
                        String testClassName = getClassname(testCase, testSuiteClassName);
                        IntegrationTestClassReport classReport = index.index(testClassName);
                        parseTestCase(testCase, classReport);
                    }
                }
            }
        }
    }

    private String getClassname(SMInputCursor testCaseCursor, String defaultClassname) throws XMLStreamException {
        String testClassName = testCaseCursor.getAttrValue("classname");
        return StringUtils.defaultIfBlank(testClassName, defaultClassname);
    }

    private void parseTestCase(SMInputCursor testCaseCursor, IntegrationTestClassReport report)
            throws XMLStreamException {
        report.add(parseTestResult(testCaseCursor));
    }

    private void setStackAndMessage(IntegrationTestResult result, SMInputCursor stackAndMessageCursor)
            throws XMLStreamException {
        result.setMessage(stackAndMessageCursor.getAttrValue("message"));
        String stack = stackAndMessageCursor.collectDescendantText();
        result.setStackTrace(stack);
    }

    private IntegrationTestResult parseTestResult(SMInputCursor testCaseCursor) throws XMLStreamException {
        IntegrationTestResult detail = new IntegrationTestResult();
        String name = getTestCaseName(testCaseCursor);
        detail.setName(name);

        String status = IntegrationTestResult.STATUS_OK;
        long duration = getTimeAttributeInMS(testCaseCursor);

        SMInputCursor childNode = testCaseCursor.descendantElementCursor();
        if (childNode.getNext() != null) {
            String elementName = childNode.getLocalName();
            if ("skipped".equals(elementName)) {
                status = IntegrationTestResult.STATUS_SKIPPED;
                // bug with surefire reporting wrong time for skipped tests
                duration = 0L;

            } else if ("failure".equals(elementName)) {
                status = IntegrationTestResult.STATUS_FAILURE;
                setStackAndMessage(detail, childNode);

            } else if ("error".equals(elementName)) {
                status = IntegrationTestResult.STATUS_ERROR;
                setStackAndMessage(detail, childNode);
            }
        }
        while (childNode.getNext() != null) {
            // make sure we loop till the end of the elements cursor
        }
        detail.setDurationMilliseconds(duration);
        detail.setStatus(status);
        return detail;
    }

    private long getTimeAttributeInMS(SMInputCursor testCaseCursor) throws XMLStreamException {
        String durationAsString = testCaseCursor.getAttrValue("time");
        if (durationAsString == null) {
            return 0;
        }
        Double time = 0.;
        try {
            // hardcoded to Locale.ENGLISH see http://jira.codehaus.org/browse/SONAR-602
            time = ParsingUtils.parseNumber(durationAsString, Locale.ENGLISH);
        } catch (ParseException e) {
            LOGGER.info("Unparseable duration for " + getTestCaseName(testCaseCursor) + ": " + durationAsString);
        }
        return !Double.isNaN(time) ? (long) ParsingUtils.scaleValue(time * 1000, 3) : 0L;
    }

    private String getTestCaseName(SMInputCursor testCaseCursor) throws XMLStreamException {
        String classname = testCaseCursor.getAttrValue("classname");
        String name = testCaseCursor.getAttrValue("name");
        if (StringUtils.contains(classname, "$")) {
            return StringUtils.substringAfter(classname, "$") + "/" + name;
        }
        return name;
    }
}