com.googlecode.openbox.testu.tester.exporters.InternHtmlExporter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of testu Show documentation
TestU is for common RESTful API test framework
The newest version!
package com.googlecode.openbox.testu.tester.exporters;

import java.io.IOException;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLConnection;
import java.util.LinkedList;
import java.util.List;

import org.apache.commons.lang3.StringUtils;
import org.uncommons.reportng.ReportNGUtils;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.googlecode.openbox.common.IOUtils;
import com.googlecode.openbox.common.UtilsAPI;
import com.googlecode.openbox.common.context.CommonContext;
import com.googlecode.openbox.config.ContentLoader;
import com.googlecode.openbox.testu.TestUException;
import com.googlecode.openbox.testu.tester.ActualResults;
import com.googlecode.openbox.testu.tester.Bugs;
import com.googlecode.openbox.testu.tester.CaseDescriptions;
import com.googlecode.openbox.testu.tester.ExpectedResults;
import com.googlecode.openbox.testu.tester.InternTestCasesExporter;
import com.googlecode.openbox.testu.tester.OverallTestResult;
import com.googlecode.openbox.testu.tester.Owner;
import com.googlecode.openbox.testu.tester.Preconditions;
import com.googlecode.openbox.testu.tester.Steps;
import com.googlecode.openbox.testu.tester.TestCase;
import com.googlecode.openbox.testu.tester.TestCaseResults;
import com.googlecode.openbox.testu.tester.TestCaseResults.Result;

public class InternHtmlExporter implements InternTestCasesExporter {
	private static final ReportNGUtils HELPER = new ReportNGUtils();

	public static final String CONTEXT_ID = "OverallTestResult";
	private String exportLocalFile;
	private List bugList;

	private InternHtmlExporter(String exportLocalFile) {
		this.exportLocalFile = exportLocalFile;
		this.bugList = new LinkedList();
	}

	public static InternHtmlExporter newInstance(String location) {
		return new InternHtmlExporter(location);
	}

	@Override
	public String export(TestCase root, CommonContext context) {
		if (StringUtils.isEmpty(exportLocalFile)) {
			exportLocalFile = UtilsAPI.getCurrentWorkingPath()
					+ IOUtils.PATH_SPLIT + "testreport";
		}

		URL url = getClass().getClassLoader().getResource("reporter/html");
		URLConnection urlConnection = null;
		try {
			urlConnection = url.openConnection();
		} catch (IOException e) {
			throw TestUException.create(
					"get reporter/html url from target or jar error !", e);
		}

		if (urlConnection instanceof JarURLConnection) {
			try {
				IOUtils.copyFolderFromJar((JarURLConnection) urlConnection,
						exportLocalFile);
			} catch (IOException e) {
				throw TestUException
						.create("copy testu html report framework resource from jar error !",
								e);
			}
		} else {
			IOUtils.copyFolder(url.getFile(), exportLocalFile);
		}

		String appJsFile = exportLocalFile + IOUtils.PATH_SPLIT + "app.js";
		IOUtils.deleteFile(appJsFile);

		String header = ContentLoader.getContent("reporter/html/header.fm");
		IOUtils.appendContentToFile(appJsFile, header);

		Object object = context.getAttribute(CONTEXT_ID);
		if (null == object) {
			throw TestUException
					.create("HtmlTextExporter need a context object as ID-- OverallTestResult ,Please check it for your caller ! ");
		}
		TestCaseVO testCaseVO = convertToTestCaseVO(root);

		OverallTestResult overallTestResult = (OverallTestResult) object;
		overallTestResult.setBugList(bugList);
		IOUtils.appendContentToFile(appJsFile,
				overallTestResult.getHtmlReport());

		String start = ContentLoader.getContent("reporter/html/start.fm");
		IOUtils.appendContentToFile(appJsFile, start);

		testCaseVO.setName(root.getDisplayName());
		Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation()
				.create();
		String content = gson.toJson(testCaseVO);
		IOUtils.appendContentToFile(appJsFile, content.replaceAll("'", "\'"));

		String end = ContentLoader.getContent("reporter/html/end.fm");
		IOUtils.appendContentToFile(appJsFile, end);
		return getExportIndexFile();
	}

	private TestCaseVO convertToTestCaseVO(TestCase testCase) {

		if (null == testCase) {
			return null;
		}

		TestCaseVO testCaseVO = new TestCaseVO();
		testCaseVO.setName(testCase.getDisplayName());
		testCaseVO.setDescriptions(getCaseDescriptions(testCase));
		testCaseVO.setResult(getResult(testCase));
		testCaseVO.setMsg(getMessage(testCase));
		testCaseVO.setDuration(getDuration(testCase));
		testCaseVO.setLogs(handleSpecialCharacters(testCase.getLogs()));
		testCaseVO.setOwner(getOwner(testCase));
		testCaseVO.setBugs(getBugs(testCase));
		testCaseVO.setExpanded(testCase.isExpand());
		bugList.addAll(testCase.getBugList());
		List children = testCase.getChildren();
		if (null != children && children.size() > 0) {
			testCaseVO.setLeaf(false);
			for (TestCase child : children) {
				TestCaseVO childTestCaseVO = convertToTestCaseVO(child);
				testCaseVO.addChild(childTestCaseVO);
			}
		} else {
			testCaseVO.setLeaf(true);
		}
		return testCaseVO;
	}

	private String getOwner(TestCase testCase) {
		Owner owner = testCase.getOwner();
		String display = "E-mailer";
		String email = "";
		if (null != owner) {
			display = owner.name();
			email = owner.email();
			if (StringUtils.isBlank(email)) {
				email = "";
			}
		} else if (testCase.isSuite()) {
			return "";
		}
		String emailAddr = email.replace("+", "%2B");
		String subject = getEncodeStr(testCase.getDisplayName());
		String body = getEncodeStr(generateEmailBody(testCase));
		return String
				.format("%s",
						emailAddr, subject, body, display);
	}

	private static String getEncodeStr(String orignal) {
		return orignal;
	}

	private String generateEmailBody(TestCase testCase) {
		String split = "\n\n";
		StringBuilder sb = new StringBuilder();
		sb.append("Hello ,").append(split).append("Case Name : [ ")
				.append(testCase.getDisplayName()).append(" ]").append(split)
				.append(getCaseDescriptions(testCase)).append(split)
				.append(split).append("Best regards!").append(split)
				.append("--TestU Report");
		return StringUtils.replaceEach(sb.toString(), new String[] { "
",
				"\n", "&", "@" }, new String[] { "%0D%0A", "%0D%0A", "%26",
				"%40" });
	}

	private String getResult(TestCase testCase) {
		if (testCase.isSuite()) {
			return _getSuiteResult(testCase);
		}
		TestCaseResults testCaseResult = testCase.getActualResults();
		if (null != testCaseResult) {
			return _getTestCaseResult(testCaseResult.getResult());
		}
		if (testCase.getChildren().size() > 0) {
			return _getSuiteResult(testCase);
		}
		return "";
	}

	private String formatTestStatus(int number) {
		return String.format("%3d", number).replaceAll(" ", "  ");
	}

	private String _getSuiteResult(TestCase testCase) {

		int passRate = 100;
		if (testCase.getTotalTested() > 0) {
			passRate = testCase.getTotalPassed() * 100
					/ testCase.getTotalTested();
		}
		String passRateStr = formatTestStatus(passRate);
		String totalPassedStr = formatTestStatus(testCase.getTotalPassed());
		String totalFailedStr = formatTestStatus(testCase.getTotalFailed());
		String totalSkipedStr = formatTestStatus(testCase.getTotalSkiped());
		return "" + passRateStr + "%"
				+ "[" + totalPassedStr + ""
				+ "|"
				+ totalFailedStr + "" + "|"
				+ totalSkipedStr + "]";
	}

	private String _getTestCaseResult(Result result) {
		switch (result) {
		case SKIP:
			return "" + result.name() + "";
		case SUCCESS:
			return "" + result.name() + "";
		case FAILURE:
			return "" + result.name() + "";
		case SUCCESS_PERCENTAGE_FAILURE:
			return "" + result.name() + "";
		case STARTED:
			return "" + result.name() + "";
		default:
			return "" + result.name() + "";
		}

	}

	private String getMessage(TestCase testCase) {
		TestCaseResults testCaseResult = testCase.getActualResults();
		StringBuilder msgBuilder = new StringBuilder();

		if (null != testCaseResult) {
			ActualResults actualResults = testCaseResult.getActualResults();
			if (null != actualResults) {
				msgBuilder.append("Actual Result:\n");
				for (String actualResult : actualResults.value()) {
					msgBuilder.append(actualResult).append("\n");
				}
			}
			String msg = testCaseResult.getMsg();
			if (null != msg) {
				msgBuilder.append(msg);
			}
		}
		return handleSpecialCharacters(msgBuilder.toString());
	}

	private String getDuration(TestCase testCase) {
		if (testCase.isSuite()) {
			return HELPER.formatDuration(testCase.getTotalDuration()) + " s";
		}
		return testCase.getTotalDuration() + " ms";
	}

	private String getBugs(TestCase testCase) {
		StringBuilder builder = new StringBuilder();
		Bugs bugs = testCase.getBugs();
		if (null != bugs) {
			for (String bugLink : bugs.value()) {
				builder.append("")
						.append(UtilsAPI.getLastPath(bugLink))
						.append("
");
			}
		}
		return builder.toString();
	}

	private String getCaseDescriptions(TestCase testCase) {
		StringBuilder descriptionsBuilder = new StringBuilder();
//		String[] caseObjectives = testCase.getCaseObjectives();
//		if (null != caseObjectives) {
//			for (int i = 0; i < caseObjectives.length; i++) {
//				if (0 == i) {
//					descriptionsBuilder.append("Case Objectives : 
");
//				}
//				descriptionsBuilder.append(caseObjectives[i]);
//				if ((caseObjectives.length - 1) > i) {
//					descriptionsBuilder.append(" , ");
//				} else {
//					descriptionsBuilder.append("

");
//				}
//			}
//		}
		CaseDescriptions caseDescriptions = testCase.getCaseDescriptions();
		if (null != caseDescriptions) {
			for (String description : caseDescriptions.value()) {
				descriptionsBuilder.append(description).append("
");
			}
			descriptionsBuilder.append("
");
		}
		Preconditions preconditions = testCase.getPreconditions();
		if (null != preconditions) {
			descriptionsBuilder.append("Preconditions : 
");
			for (String precondition : preconditions.value()) {
				descriptionsBuilder.append(precondition).append("
");
			}
			descriptionsBuilder.append("
");
		}

		Steps steps = testCase.getSteps();
		if (null != steps) {
			descriptionsBuilder.append("Steps : 
");
			for (String step : steps.value()) {
				descriptionsBuilder.append(step).append("
");
			}
			descriptionsBuilder.append("
");
		}

		ExpectedResults expectedResults = testCase.getExpectedResults();
		if (null != expectedResults) {
			descriptionsBuilder.append("Expected Results : 
");
			for (String expectedResult : expectedResults.value()) {
				descriptionsBuilder.append(expectedResult).append("
");
			}
			descriptionsBuilder.append("
");
		}
		return descriptionsBuilder.toString();
	}

	private static String handleSpecialCharacters(String input) {
		if (null == input) {
			return "";
		}
		return StringUtils.replaceEach(input, new String[] { "'", "\"", "\n",
				"\r" }, new String[] { "", "", "\\n", "\\r" });
	}

	public String getExportIndexFile() {
		return exportLocalFile + IOUtils.PATH_SPLIT + "index.html";
	}
}