PhpTestSuiteReader.java

/*
 * Sonar PHP Plugin
 * Copyright (C) 2010 Sonar PHP Plugin
 * dev@sonar.codehaus.org
 *
 * 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.php.phpunit;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.sonar.plugins.php.phpunit.xml.TestCase;
import org.sonar.plugins.php.phpunit.xml.TestSuite;

/**
 * The PhpTestSuiteParser .
 */
public class PhpTestSuiteReader {

  /**
  */
  private static final String TESTSUITE_CLASS_NAME_SEPARATOR = "::";
  /** The reports per class. */
  private Map<String, PhpUnitTestReport> reportsPerClass = new HashMap<String, PhpUnitTestReport>();

  /**
   * Cumulates test case details.
   * 
   * @param testCase
   *          the test case to analyse
   * @param report
   *          the report in which results will be added
   */
  private void cumulateTestCaseDetails(TestCase testCase, PhpUnitTestReport report) {

    if (TestCase.STATUS_SKIPPED.equals(testCase.getStatus())) {
      report.setSkipped(report.getSkipped() + 1);
    } else if (TestCase.STATUS_FAILURE.equals(testCase.getStatus())) {
      report.setFailures(report.getFailures() + 1);
    } else if (TestCase.STATUS_ERROR.equals(testCase.getStatus())) {
      report.setErrors(report.getErrors() + 1);
    }
    report.setTests(report.getTests() + 1);
    report.getDetails().add(testCase);
  }

  /**
   * Reads the given test suite.
   * 
   * Due to a inconsistent XML format in phpUnit, we have to parse enclosing testsuite name for generated testcases when a testcase holds
   * the annotation dataProvider.
   * 
   * @param testSuite
   *          the test suite
   * @return List<PhpUnitTestReport> A list containing on report per php class
   */
  public List<PhpUnitTestReport> readSuite(TestSuite testSuite, String parentFileName) {
    List<PhpUnitTestReport> result = new ArrayList<PhpUnitTestReport>();
    List<TestSuite> testSuites = testSuite.getTestSuites();
    if (testSuites != null) {
      for (TestSuite childSuite : testSuites) {
        readSuite(childSuite, testSuite.getFile());
      }
    }
    // For all cases
    List<TestCase> testCases = testSuite.getTestCases();
    if (testCases != null) {
      for (TestCase testCase : testCases) {
        String testClassName = testCase.getClassName();
        // For test cases with @dataProvider. we get the fileName in the enclosing testSuite in the name attribute before string "::"
        if (testClassName == null) {
          String name = testSuite.getName();
          int testSuiteClassIndex = name.indexOf(TESTSUITE_CLASS_NAME_SEPARATOR);
          if (testSuiteClassIndex > 0) {
            testClassName = name.substring(0, testSuiteClassIndex);
          }
        }
        PhpUnitTestReport report = reportsPerClass.get(testClassName);
        // If no reports exists for this class we create one
        if (report == null) {
          report = new PhpUnitTestReport();
          report.setDetails(new ArrayList<TestCase>());
          report.setClassKey(testClassName);
          String file = testCase.getFile();
          // test cases with @dataProvider, we get the file name in the parent test suite.
          if (file == null) {
            file = parentFileName;
          }
          report.setFile(file);
          // and add it to the map
          reportsPerClass.put(testClassName, report);
        }
        if (parentFileName == null) {
          report.setTime(testSuite.getTime());
        }
        cumulateTestCaseDetails(testCase, report);
      }
    }
    result.addAll(reportsPerClass.values());
    return result;
  }

}