JUnitCaseClassNameResultSeeker.java

/*
 * 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 jenkins.plugins.testopia.result;

import hudson.Extension;
import hudson.Launcher;
import hudson.model.BuildListener;
import hudson.model.Result;
import hudson.model.AbstractBuild;
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.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import jenkins.plugins.testopia.TestopiaSite;
import jenkins.plugins.testopia.util.Messages;

import org.kohsuke.stapler.DataBoundConstructor;
import org.mozilla.testopia.model.Status;

/**
 * <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
 * @since 1.3
 */
public class JUnitCaseClassNameResultSeeker extends ResultSeeker {

	private static final long serialVersionUID = -7504474094868139409L;

	/**
	 * @param includePattern Include pattern used when looking for results
	 */
	@DataBoundConstructor
	public JUnitCaseClassNameResultSeeker(String includePattern) {
		super(includePattern);
	}
	
	@Extension
	public static class DescriptorImpl extends ResultSeekerDescriptor {
		/*
		 * (non-Javadoc)
		 * 
		 * @see hudson.model.Descriptor#getDisplayName()
		 */
		@Override
		public String getDisplayName() {
			return Messages.Testopia_JUnit_ClassName();
		}
	}

	@Override
	public void seek(TestCaseWrapper[] automatedTestCases, AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener, TestopiaSite testopia) throws ResultSeekerException {
		listener.getLogger().println( Messages.Testopia_JUnit_LookingForTestClasses() );
		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) {
						if (!caseResult.isSkipped() && caseResult.getClassName().equals(automatedTestCase.getAlias())) {
							final Status status = this.getStatus(caseResult);
							automatedTestCase.setStatusId(status.getValue());
							classNameTestCase.put(Integer.valueOf(automatedTestCase.getId())+"#"+automatedTestCase.getAlias(), automatedTestCase);
						}
					}
				}
				
				// Here we update testopia with our findings
				for(Map.Entry<String, TestCaseWrapper> entry : classNameTestCase.entrySet()) {
					try {
						//listener.getLogger().println( Messages.Testopia_ResultSeeker_UpdateAutomatedTestCases() );
						testopia.updateTestCase(entry.getValue());
					} catch (RuntimeException e) {
						build.setResult(Result.UNSTABLE);
						e.printStackTrace(listener.getLogger());
					}
				}
			}
			
		} catch (IOException e) {
			throw new ResultSeekerException(e);
		} catch (InterruptedException e) {
			throw new ResultSeekerException(e);
		}
	}

	private Status getStatus(CaseResult caseResult) {
		if (caseResult.getStatus() == CaseResult.Status.PASSED) {
			return Status.PASSED;
		}
		if (caseResult.getStatus() == CaseResult.Status.FAILED) {
			return Status.FAILED;
		}
		if (caseResult.getStatus() == CaseResult.Status.SKIPPED) {
			return Status.BLOCKED;
		}
		return Status.IDLE;
	}

	/**
	 * @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();
			}
		}
	}
	
}