com.seleniumtests.reporter.reporters.BugTrackerReporter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grid-extensions Show documentation
There is a newer version: 4.23.18
package com.seleniumtests.reporter.reporters;

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

import org.testng.IReporter;
import org.testng.ITestContext;
import org.testng.ITestResult;

import com.seleniumtests.connectors.bugtracker.BugTracker;
import com.seleniumtests.connectors.bugtracker.IssueBean;
import com.seleniumtests.core.SeleniumTestsContext;
import com.seleniumtests.core.SeleniumTestsContextManager;
import com.seleniumtests.core.TestVariable;
import com.seleniumtests.core.utils.TestNGResultUtils;
import com.seleniumtests.reporter.info.HyperlinkInfo;
import com.seleniumtests.reporter.info.StringInfo;
import com.seleniumtests.reporter.logger.TestStep;

public class BugTrackerReporter extends CommonReporter implements IReporter {

	@Override
	protected void generateReport(Map> resultSet, String outdir, boolean optimizeReport) {
		generateReport(resultSet, outdir, optimizeReport, false);
	}
	
	@Override
	protected void generateReport(Map> resultSet, String outdir, boolean optimizeReport, boolean finalGeneration) {

		for (Map.Entry> entry: resultSet.entrySet()) {

			ITestContext context = entry.getKey();

			for (ITestResult testResult : entry.getValue()) {
				
				// record only when all executions of a test method are done so that intermediate results (a failed test which has been retried) are not present in list
				if (!Boolean.TRUE.equals(TestNGResultUtils.getNoMoreRetry(testResult)) || TestNGResultUtils.isBugtrackerReportCreated(testResult)) {
					continue;
				}
				
				// done in case it was null (issue #81)
				SeleniumTestsContext testContext = SeleniumTestsContextManager.setThreadContextFromTestResult(context, testResult);

				BugTracker bugtrackerServer = testContext.getBugTrackerInstance();
				if (bugtrackerServer == null) {
					return;
				} 
				
				// get all bugtracker options
				Map issueOptions = new HashMap<>();
				for (TestVariable variable: testContext.getConfiguration().values()) {
					if (variable.getName().startsWith("bugtracker.")) {
						issueOptions.put(variable.getName().replace("bugtracker.", ""), variable.getValue());
					}
				}
				
				// application data
				String application = testContext.getApplicationName();
				String environment = testContext.getTestEnv();
				String testNgName = testResult.getTestContext().getCurrentXmlTest().getName();
				String testName = TestNGResultUtils.getUniqueTestName(testResult);

				String description = String.format("Test '%s' failed\n", testName);

				if (testResult.getMethod().getDescription() != null && !testResult.getMethod().getDescription().trim().isEmpty()) {
					description += "Test goal: " + TestNGResultUtils.getTestDescription(testResult);
				}

				// search the last step to get screenshots and failure reason
				List testSteps = TestNGResultUtils.getSeleniumRobotTestContext(testResult).getTestStepManager().getTestSteps();
				if (testSteps == null) {
					return;
				}

				// create issue only for failed tests and if it has not been created before
				if (testResult.getStatus() == ITestResult.FAILURE) {
	
					IssueBean issueBean = bugtrackerServer.createIssue(
							application,
							environment,
							testNgName,
							testName,
							description,
							testSteps,
							issueOptions
							);
					
					// log information on issue
					if (issueBean != null) {
						if (issueBean.getId() != null && issueBean.getAccessUrl() != null) {
							TestNGResultUtils.setTestInfo(testResult, "Issue", new HyperlinkInfo(issueBean.getId(), issueBean.getAccessUrl()));
						} else if (issueBean.getId() != null) {
							TestNGResultUtils.setTestInfo(testResult, "Issue", new StringInfo(issueBean.getId()));
						}
						TestNGResultUtils.setTestInfo(testResult, "Issue date", new StringInfo(issueBean.getCreationDate()));
					}
					
					TestNGResultUtils.setBugtrackerReportCreated(testResult, true);
					
				// close issue if test is now OK and a previous issue has been created
				} else if (testResult.getStatus() == ITestResult.SUCCESS) {
					
					bugtrackerServer.closeIssue( 
							application,
							environment,
							testNgName,
							testName);
					
					TestNGResultUtils.setBugtrackerReportCreated(testResult, true);
				}
			}
		}
	}

	

}