/*
* The MIT License
*
* Copyright (c) <2011> <Bruno P. Kinoshita>
*
* 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 hudson.plugins.testlink.result;
import hudson.Extension;
import hudson.Launcher;
import hudson.model.BuildListener;
import hudson.model.AbstractBuild;
import hudson.plugins.testlink.TestLinkSite;
import hudson.plugins.testlink.util.Messages;
import hudson.tasks.junit.JUnitParser;
import hudson.tasks.junit.SuiteResult;
import hudson.tasks.junit.TestResult;
import hudson.tasks.junit.CaseResult;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import org.kohsuke.stapler.DataBoundConstructor;
import br.eti.kinoshita.testlinkjavaapi.constants.ExecutionStatus;
/**
* <p>Seeks for test results matching each JUnit Case Result class name with
* the key custom field.</p>
*
* <p>Skips JUnit Case Results that were disabled.</p>
*
* @author Bruno P. Kinoshita - http://www.kinoshita.eti.br
* @author Oliver Merkel - Merkel.Oliver at web.de
* @since 3.1
*/
public class JUnitCaseClassNameResultSeeker extends AbstractJUnitResultSeeker {
private static final long serialVersionUID = -7504474094868139409L;
/**
* @param includePattern Include pattern used when looking for results
* @param keyCustomField Key custom field to match against the results
* @param attachJunitXML Bit that enables attaching result file to TestLink
*/
@DataBoundConstructor
public JUnitCaseClassNameResultSeeker(String includePattern, String keyCustomField, boolean attachJUnitXML, boolean includeNotes) {
super(includePattern, keyCustomField, attachJUnitXML, includeNotes);
}
@Extension
public static class DescriptorImpl extends ResultSeekerDescriptor {
/*
* (non-Javadoc)
*
* @see hudson.model.Descriptor#getDisplayName()
*/
@Override
public String getDisplayName() {
return "JUnit class name"; // TBD: i18n
}
}
/* (non-Javadoc)
* @see hudson.plugins.testlink.result.ResultSeeker#seekAndUpdate(hudson.plugins.testlink.result.TestCaseWrapper<?>[], hudson.model.AbstractBuild, hudson.Launcher, hudson.model.BuildListener, hudson.plugins.testlink.TestLinkSite, hudson.plugins.testlink.result.Report)
*/
@Override
public void seek(TestCaseWrapper[] automatedTestCases, AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener, TestLinkSite testlink) throws ResultSeekerException {
listener.getLogger().println( Messages.Results_JUnit_LookingForTestClasses() ); // i18n
try {
final JUnitParser parser = new JUnitParser(false);
final TestResult testResult = parser.parse(this.includePattern, build, launcher, listener);
for(final SuiteResult suiteResult : testResult.getSuites()) {
final List<CaseResult> caseResults = this.filter(suiteResult.getCases());
// We need this map because a class has many case results, so we create a map by class name
final Map<String, TestCaseWrapper> classNameTestCase = new HashMap<String, TestCaseWrapper>();
for(CaseResult caseResult : caseResults) {
for(TestCaseWrapper automatedTestCase : automatedTestCases) {
final String[] commaSeparatedValues = automatedTestCase.getKeyCustomFieldValues(this.keyCustomField);
for(String value : commaSeparatedValues) {
if(! caseResult.isSkipped() && caseResult.getClassName().equals(value)) {
// A class can have many case results, so we check if the class has failed anywhere
//final ExecutionStatus previousStatus = automatedTestCase.getCustomFieldAndStatus().get(value);
final ExecutionStatus status = this.getExecutionStatus(caseResult);
automatedTestCase.addCustomFieldAndStatus(value, status);
if(this.isIncludeNotes()) {
final String notes = this.getJUnitNotes(caseResult, build.number);
automatedTestCase.appendNotes(notes);
}
classNameTestCase.put(Integer.valueOf(automatedTestCase.getId())+"#"+Arrays.toString(commaSeparatedValues), automatedTestCase);
}
}
}
}
// Here we update testlink with our findings
for(Map.Entry<String, TestCaseWrapper> entry : classNameTestCase.entrySet()) {
super.handleResult(entry.getValue(), build, listener, testlink, suiteResult);
}
}
} catch (IOException e) {
throw new ResultSeekerException(e);
} catch (InterruptedException e) {
throw new ResultSeekerException(e);
}
}
/**
* @param cases
* @return
*/
private List<CaseResult> filter(List<CaseResult> cases) {
final List<CaseResult> filtered = new LinkedList<CaseResult>();
for(CaseResult caseResult : cases) {
final CaseResult c = this.find(filtered, caseResult);
if(c != null) {
if(c.getFailCount()<=0) { // didn't fail
this.remove(filtered, c);
filtered.add(caseResult);
}
} else {
filtered.add(caseResult);
}
}
return filtered;
}
/**
* @param filtered
* @param caseResult
* @return
*/
private CaseResult find(List<CaseResult> filtered, CaseResult caseResult) {
for(CaseResult c : filtered) {
if(c.getClassName().equals(caseResult.getClassName())) {
return c;
}
}
return null;
}
/**
* @param filtered
* @param caseResult
* @return
*/
private void remove(List<CaseResult> filtered, CaseResult caseResult) {
final Iterator<CaseResult> iterator = filtered.iterator();
while(iterator.hasNext()) {
CaseResult c = iterator.next();
if(c.getClassName().equals(caseResult.getClassName())) {
iterator.remove();
}
}
}
/**
* @param caseResult the case result
* @return NOT_RUN in case it is skipped, PASSED if it passed, and FAILED otherwise
*/
private ExecutionStatus getExecutionStatus(CaseResult caseResult) {
if(caseResult.isSkipped()) {
return ExecutionStatus.NOT_RUN;
} else if(caseResult.getFailCount() > 0) {
return ExecutionStatus.FAILED;
} else {
return ExecutionStatus.PASSED;
}
}
/**
* Retrieves the Notes about the JUnit test.
*
* @param testCase JUnit test.
* @return Notes about the JUnit test.
*/
private String getJUnitNotes( CaseResult testCase , int buildNumber)
{
StringBuilder notes = new StringBuilder();
notes.append(
Messages.Results_JUnit_NotesForTestClass(
testCase.getClassName(),
(testCase.getSuiteResult() != null ? testCase.getSuiteResult().getTimestamp() : null))
);
/* Added for appending build number and error message */
notes.append("\nBuild no : " + buildNumber );
if(null != testCase.getErrorDetails() ){
notes.append("\nError Message : " + testCase.getErrorDetails());
}
return notes.toString();
}
}