nl.praegus.fitnesse.reporting.ToolchainSuiteHtmlFormatter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolchain-fitnesse-plugin Show documentation
Auto-register autocomplete responder and add debug script table
There is a newer version: 2.0.24
Show newest version
package nl.praegus.fitnesse.reporting;

import fitnesse.html.HtmlTag;
import fitnesse.html.HtmlUtil;
import fitnesse.reporting.InteractiveFormatter;
import fitnesse.reporting.JavascriptUtil;
import fitnesse.testrunner.WikiTestPage;
import fitnesse.testsystems.ExecutionResult;
import fitnesse.testsystems.TestPage;
import fitnesse.testsystems.TestSummary;
import fitnesse.testsystems.TestSystem;
import fitnesse.util.TimeMeasurement;
import fitnesse.wiki.PathParser;
import fitnesse.wiki.WikiPage;
import fitnesse.wiki.WikiPageProperty;
import fitnesse.wiki.WikiSourcePage;

import java.io.Closeable;
import java.io.IOException;
import java.io.Writer;
import java.util.Arrays;

import static fitnesse.testsystems.ExecutionResult.getExecutionResult;

public class ToolchainSuiteHtmlFormatter extends InteractiveFormatter implements Closeable {
    private static final String TEST_SUMMARIES_ID = "test-summaries";

    private final TestSummary pageCounts = new TestSummary();
    private int currentTest = 0;

    private final String testBasePathName;
    private String testSystemName = null;
    private int totalTests = 1;
    private TimeMeasurement latestTestTime;
    private String testSummariesId = TEST_SUMMARIES_ID;
    private final boolean testSummariesPresent;
    private final TimeMeasurement totalTimeMeasurement;


    public ToolchainSuiteHtmlFormatter(WikiPage page, boolean testSummariesPresent, Writer writer) {
        super(page, writer);
        this.testSummariesPresent = testSummariesPresent;
        totalTimeMeasurement = new TimeMeasurement().start();
        testBasePathName = PathParser.render(page.getFullPath());
    }

    @Override
    public void announceNumberTestsToRun(int testsToRun) {
        super.announceNumberTestsToRun(testsToRun);
        totalTests = (testsToRun != 0) ? testsToRun : 1;
    }

    public void announceStartNewTest(String relativeName, String fullPathName) {
        currentTest++;
        updateSummaryDiv(getProgressHtml(relativeName));

        maybeWriteTestSystem();
        writeTestOutputDiv(relativeName, fullPathName);
    }

    private void writeTestOutputDiv(String relativeName, String fullPathName) {
        if (!testBasePathName.equals(fullPathName)) {
            HtmlTag title = new HtmlTag("h3");

            HtmlTag anchor = HtmlUtil.makeLink(fullPathName, relativeName);
            anchor.addAttribute("class", "test_name");
            title.add(anchor);

            HtmlTag name = new HtmlTag("a");
            name.addAttribute("name", relativeName + currentTest);
            title.add(name);

            HtmlTag topLink = HtmlUtil.makeLink("#", "Top");
            topLink.addAttribute("class", "top_of_page");

            title.add(new HtmlTag("small", topLink));
            writeData(title.html());
        }
        writeData("");
    }

    private void maybeWriteTestSystem() {
        if (testSystemName != null) {
            HtmlTag systemTitle = new HtmlTag("h2", String.format("Test System: %s", testSystemName));
            writeData(systemTitle.html());
            // once we write it out we don't need it any more
            testSystemName = null;
        }
    }

    @Override
    public void testStarted(TestPage testPage) {
        latestTestTime = new TimeMeasurement().start();
        super.testStarted(testPage);

        String fullPathName = testPage.getFullPath();

        announceStartNewTest(getRelativeName(), fullPathName);
    }

    private String getProgressHtml(String relativeName) {
        float percentFinished = (currentTest - 1) * 100f / totalTests;

        String text = "Running tests ... (" + currentTest + "/" + totalTests + ")";
        text = text.replaceAll(" ", " ");
        HtmlTag progressDiv = new HtmlTag("div", text);

        // need some results before we can check pageCounts for results
        ExecutionResult cssClass = (currentTest == 1) ? ExecutionResult.PASS : getExecutionResult(relativeName, this.pageCounts);
        progressDiv.addAttribute("id", "progressBar");
        progressDiv.addAttribute("class", cssClass.toString());
        progressDiv.addAttribute("style", "width:" + percentFinished + "%");

        return progressDiv.html();
    }

    public void processTestResults(String relativeName, TestSummary testSummary, String[] tags) {
        finishOutputForTest();

        getAssertionCounts().add(testSummary);

        if (hasTestSummaries()) {
            addToTestSummaries(relativeName, testSummary, tags);
        }
    }

    protected void addToTestSummaries(String relativeName, TestSummary testSummary, String[] suiteTags) {
        HtmlTag tag = new HtmlTag("li");

        tag.add(HtmlUtil.makeSpanTag("results " + getExecutionResult(relativeName, testSummary), testSummary.toString()));

        HtmlTag link = HtmlUtil.makeLink("#" + relativeName + currentTest, relativeName);
        link.addAttribute("class", "link");
        tag.add(link);

        if (latestTestTime != null) {
            tag.add(HtmlUtil.makeSpanTag("", String.format("(%.03f seconds)", latestTestTime.elapsedSeconds())));
        }

        Arrays.stream(suiteTags).filter(suiteTag -> suiteTag.trim().length() > 0)
                .map(suiteTag -> HtmlUtil.makeSpanTag("tag", suiteTag)).forEach(tag::add);

        pageCounts.add(getExecutionResult(relativeName, testSummary, wasInterrupted()));
        HtmlTag insertScript = JavascriptUtil.makeAppendElementScript(testSummariesId, tag.html());
        writeData(insertScript.html());
    }

    private void finishOutputForTest() {
        writeData("" + HtmlTag.endl);
    }

    @Override
    public void close() {
        latestTestTime = totalTimeMeasurement.stop();
        removeStopTestLink();
        AddLogLink();
        maybeMakeErrorNavigatorVisible();
        finishWritingOutput();
    }

    @Override
    public void testOutputChunk(String output) {
        writeData(output);
    }


    @Override
    public void testComplete(TestPage testPage, TestSummary testSummary) {
        latestTestTime.stop();
        super.testComplete(testPage, testSummary);
        String[] tags = new String[]{};
        if (testPage instanceof WikiTestPage) {
            WikiSourcePage source = new WikiSourcePage(((WikiTestPage) testPage).getSourcePage());
            tags = source.getProperty(WikiPageProperty.SUITES).split(", ");
        }
        processTestResults(getRelativeName(testPage), testSummary, tags);
        latestTestTime = null;
    }

    @Override
    public void testSystemStarted(TestSystem testSystem) {
        if (hasTestSummaries()) {
            testSystemName = testSystem.getName();
            testSummariesId = "test-system-" + testSystemName;
            String tag = String.format("%s
\n", testSystemName, testSummariesId);
            HtmlTag insertScript = JavascriptUtil.makeAppendElementScript(TEST_SUMMARIES_ID, tag);
            writeData(insertScript.html());
        }
    }

    @Override
    protected String makeSummaryContent() {
        String summaryContent = "Test Pages: " + pageCounts.toString() + "     ";
        if (latestTestTime != null) {
            summaryContent += String.format("Assertions: %s (%.03f seconds)", getAssertionCounts(), latestTestTime.elapsedSeconds());
        } else {
            summaryContent += String.format("Assertions: %s ", getAssertionCounts());
        }
        return summaryContent;
    }

    protected boolean hasTestSummaries() {
        return testSummariesPresent;
    }
}