io.github.selcukes.extent.report.ExtentService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of selcukes-extent-reports Show documentation
Selcukes Adapter for Extent Reports
The newest version!
/*
 *
 *  Copyright (c) Ramesh Babu Prudhvi.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package io.github.selcukes.extent.report;

import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.observer.ExtentObserver;
import com.aventstack.extentreports.reporter.ExtentSparkReporter;
import com.aventstack.extentreports.reporter.ReporterConfigurable;
import com.aventstack.extentreports.reporter.configuration.ViewName;
import io.github.selcukes.collections.Clocks;
import io.github.selcukes.collections.Maps;
import io.github.selcukes.collections.Resources;
import io.github.selcukes.collections.StringHelper;
import io.github.selcukes.databind.properties.PropertiesMapper;
import lombok.Getter;

import java.io.IOException;
import java.util.Arrays;
import java.util.Map;
import java.util.Objects;

import static io.github.selcukes.collections.Clocks.DATE_TIME_FILE_FORMAT;
import static io.github.selcukes.collections.StringHelper.isNonEmpty;
import static io.github.selcukes.commons.properties.SelcukesTestProperties.THUMBNAIL_REPORT;
import static io.github.selcukes.commons.properties.SelcukesTestProperties.TIMESTAMP_REPORT;
import static java.util.Optional.ofNullable;

public class ExtentService {

    private static final String SYS_INFO_MARKER = "systeminfo.";
    private static final String OUTPUT_PATH = "target/";
    private static final String INIT_SPARK_KEY = "extent.reporter.spark.start";
    private static final String CONFIG_SPARK_KEY = "extent.reporter.spark.config";
    private static final String OUT_SPARK_KEY = "extent.reporter.spark.out";
    private static final String VIEW_ORDER_SPARK_KEY = "extent.reporter.spark.vieworder";
    private static final String REPORT_NAME = "Automation Report";
    private static final String REPORT_TITLE = "Automation Report";
    @Getter
    private final ExtentReports extentReports;
    private final Map propertiesMap;

    public ExtentService(ExtentReports extentReports) {
        this.extentReports = extentReports;
        propertiesMap = initProperties();
        if (getBooleanProperty(INIT_SPARK_KEY)) {
            initSpark();
        }
        addSystemInfo();
    }

    private Map initProperties() {
        try {
            return PropertiesMapper.parse(Resources.ofTest("extent.properties"));
        } catch (Exception e) {
            return Maps.of(System.getProperties());
        }
    }

    private String getProperty(String propertyKey) {
        return ofNullable(System.getProperty(propertyKey))
                .orElse(propertiesMap.get(propertyKey));
    }

    private String getOutputPath() {
        return ofNullable(getProperty(OUT_SPARK_KEY))
                .filter(StringHelper::isNonEmpty)
                .orElse(OUTPUT_PATH + OUT_SPARK_KEY.split("\\.")[2] + "/");
    }

    private boolean getBooleanProperty(String propertyKey) {
        String value = getProperty(propertyKey);
        return (isNonEmpty(value)
                && value.equalsIgnoreCase("true"));
    }

    private void initSpark() {
        String out = getOutputPath();
        if (getBooleanProperty(TIMESTAMP_REPORT)) {
            out = Objects.requireNonNull(out).replace(".", Clocks.dateTime(DATE_TIME_FILE_FORMAT) + ".");
        }
        var spark = new ExtentSparkReporter(out);
        spark.config().setReportName(REPORT_NAME);
        spark.config().setDocumentTitle(REPORT_TITLE);
        spark.config().thumbnailForBase64(getBooleanProperty(THUMBNAIL_REPORT));
        sparkReportViewOrder(spark);
        attach(spark);
    }

    private void sparkReportViewOrder(ExtentSparkReporter spark) {
        try {
            var viewOrder = Arrays.stream(getProperty(VIEW_ORDER_SPARK_KEY).split(","))
                    .map(String::toUpperCase)
                    .map(ViewName::valueOf)
                    .toList();
            spark.viewConfigurer().viewOrder().as(viewOrder).apply();
        } catch (Exception ignored) {
            // Gobble exception
        }
    }

    private void attach(ReporterConfigurable reporterConfigurable) {
        ofNullable(getProperty(CONFIG_SPARK_KEY))
                .filter(StringHelper::isNonEmpty)
                .ifPresent(configPath -> {
                    try {
                        reporterConfigurable.loadXMLConfig(configPath);
                    } catch (IOException ignored) {
                        // Gobble exception
                    }
                });
        extentReports.attachReporter((ExtentObserver) reporterConfigurable);
    }

    private void addSystemInfo() {
        propertiesMap.entrySet()
                .stream()
                .filter(e -> e.getKey().startsWith(SYS_INFO_MARKER))
                .map(e -> Map.entry(e.getKey().substring(SYS_INFO_MARKER.length()), e.getValue()))
                .forEach(e -> extentReports.setSystemInfo(e.getKey(), e.getValue()));
    }
}