StatusHtmlReport.java

package musicxmltestsuite.report;

import com.xenoage.utils.jse.io.JseFileUtils;
import com.xenoage.utils.jse.io.JseStreamUtils;
import musicxmltestsuite.tests.base.Base;

import java.time.Instant;
import java.util.List;

import static com.xenoage.utils.collections.CollectionUtils.alist;
import static java.util.Comparator.comparing;
import static musicxmltestsuite.MusicXmlTestSuiteHtmlReport.dirReport;

/**
 * Creates an HTML report of the MusicXML implementation status
 * of the subprojects, based on the given tests.
 * 
 * @author Andreas Wenger
 */
public class StatusHtmlReport {
	
	public static final String[] projects = { "musicxml", "musicxml-in", "layout", "midi-out"};
	
	private List<TestRow> rows = alist();
	
	
	public void report(String testName, String project, TestStatus status) {
		getRow(testName).set(project, status);
	}
	
	public void report(String testName, TestStatus status) {
		getRow(testName).setDefaultStatus(status);
	}
	
	private TestRow getRow(String testName) {
		//find existing row for test
		for (TestRow r : rows)
			if (r.getTestName().equals(testName))
				return r;
		//not found, so add one
		TestRow r = new TestRow(testName);
		rows.add(r);
		return r;
	}
	
	public void writeToHtmlFile() {
		rows.sort(comparing(TestRow::getTestName));
		String html = createHtmlReport();
		JseFileUtils.writeFile(html, getHtmlFilePath());
	}
	
	private String getHtmlFilePath() {
		return dirReport + "index.html";
	}
	
	private String createHtmlReport() {
		String html = loadHtmlTemplate("template");
		html = html.replace("[[date]]", Instant.now().toString());
		html = html.replace("[[legend]]", createHtmlLegend());
		html = html.replace("[[rows]]", createHtmlRows());
		return html;
	}

	private String loadHtmlTemplate(String name) {
		return JseStreamUtils.readToString(
			getClass().getResourceAsStream("templates/status/" + name + ".html"));
	}
	
	private String createHtmlLegend() {
		String item = loadHtmlTemplate("legenditem");
		StringBuilder ret = new StringBuilder();
		for (TestStatus status : TestStatus.values())
			ret.append(item.replace("[[status]]", ""+status).replace("[[description]]", status.description));
		return ret.toString();
	}

	private String createHtmlRows() {
		StringBuilder ret = new StringBuilder();
		for (TestRow row : rows)
			ret.append(createHtmlRow(row));
		return ret.toString();
	}

	private String createHtmlRow(TestRow row) {
		String template = loadHtmlTemplate("row");
		String testLink = createTestLink(row.getTestName());
		template = template.replace("[[test]]", testLink);
		for (String project : projects) {
			String cellHtml = createHtmlCell(row, project);
			template = template.replace("[[" + project + "]]", cellHtml);
		}
		return template;
	}
	
	private String createTestLink(String testName) {
		return "<a href=\"" + Base.onlinePath + "#" + testName + "\">" + testName + "</a>";
	}

	private String createHtmlCell(TestRow row, String project) {
		String template = loadHtmlTemplate("cell");
		TestStatus status = row.get(project);
		template = template.replace("[[status]]", ""+status);
		return template;
	}
	
}