at.willhaben.willtest.util.TestReportFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Core classes with as few dependencies as possible
There is a newer version: 3.1.10
package at.willhaben.willtest.util;

import org.junit.jupiter.api.extension.ExtensionContext;

import java.io.File;
import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;

/**
 * Decides where are the report files saved. By default report files are saved into {@value #DEFAULT_REPORT_FOLDER},
 * which can be overridden by {@value #REPORT_FOLDER_SYSTEM_PROPERTY} system property. File names will generated
 * using the following schema:
 * 
 * "{@value COMMON_PREFIX_FOR_ALL_REPORT_FILES} + PREFIX_IF_ANY + CLASS_NAME + METHOD_NAME + TIMESTAMP + POSTFIX_IF_ANY
 */
public class TestReportFile {
    private static final String REPORT_FOLDER_SYSTEM_PROPERTY = "willtest.reportFolder";
    private static final String COMMON_PREFIX_FOR_ALL_REPORT_FILES = "TR_";
    private static final String DEFAULT_REPORT_FOLDER = "surefire-reports";

    private static final DateTimeFormatter DATE_FORMAT = DateTimeFormatter.ofPattern("yyyy.MM.dd-HH.mm.ss.SSS");

    private ExtensionContext testExtensionContext;
    private String prefix = "";
    private String postfix = "";

    public static Builder forTest(ExtensionContext context) {
        return new Builder(context);
    }

    /**
     * Gives back the {@link File} object, which can be used as target for report.
     *
     * @return the file which can be used as report file
     */
    public File getFile() {
        String reportFolderPath = getReportFolderDir();
        File reportFolder = new File(reportFolderPath);
        if (!reportFolder.exists() && !reportFolder.mkdirs()) {
            throw new RuntimeException("Could not create folder " + reportFolder + "!");
        }
        return new File(reportFolder, generateFileName());
    }

    public static String getReportFolderDir() {
        return Environment.getValue(REPORT_FOLDER_SYSTEM_PROPERTY, DEFAULT_REPORT_FOLDER);
    }

    private String getClassName() {
        return testExtensionContext.getRequiredTestClass().getSimpleName();
    }

    private String getMethodName() {
        return testExtensionContext.getRequiredTestMethod().getName();
    }

    public String getGeneratedName() {
        return generateFileName();
    }

    private String generateFileName() {
        String className = getClassName();
        String methodName = getMethodName();
        String timeStamp = DATE_FORMAT.format(ZonedDateTime.now());
        return escapeFileName(COMMON_PREFIX_FOR_ALL_REPORT_FILES + prefix + className +
                "_" + methodName + "-" + timeStamp + postfix);
    }

    private String escapeFileName(String originalName) {
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < originalName.length(); i++) {
            char c = originalName.charAt(i);
            if ((c >= '0' && c <= '9') ||
                    (c >= 'A' && c <= 'Z') ||
                    (c >= 'a' && c <= 'z') ||
                    (c == '.') ||
                    (c == '_') ||
                    (c == '-')) {
                sb.append(c);
            }
        }
        return sb.toString();
    }

    public static class Builder {
        private final TestReportFile testReportFile = new TestReportFile();

        Builder(ExtensionContext context) {
            testReportFile.testExtensionContext = context;
        }

        /**
         * @param prefix name prefix to be used. F.i. "PaymentModule"
         * @return this builder
         */
        public Builder withPrefix(String prefix) {
            testReportFile.prefix = prefix;
            return this;
        }

        /**
         * @param postfix name postfix to be used. F.i. ".png"
         * @return this builder
         */
        public Builder withPostix(String postfix) {
            testReportFile.postfix = postfix;
            return this;
        }

        public TestReportFile build() {
            return testReportFile;
        }
    }
}