io.github.selcukes.extent.report.Reporter 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 io.github.selcukes.commons.helper.SingletonContext;
import io.github.selcukes.commons.logging.LogRecordListener;
import io.github.selcukes.commons.logging.LoggerFactory;
import io.github.selcukes.snapshot.Snapshot;
import io.github.selcukes.snapshot.SnapshotImpl;
import org.openqa.selenium.WebDriver;

import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.stream.Collectors;

import static io.github.selcukes.collections.StringHelper.isNonEmpty;

public class Reporter {
    private static final SingletonContext REPORTER_CONTEXT = SingletonContext.with(Reporter::new);
    private static final String EMPTY_LOGS = " 

";
    private static final String OPEN_TAG = " ";
    private static final String CLOSE_TAG = "

";
    private static final String LOGS_DETAILS = "View Logs
%s

";

    private Snapshot snapshot;
    private LogRecordListener logRecordListener;

    public static void log(String message) {
        SelcukesExtentAdapter.addTestStepLog(message);
    }

    public static Reporter getReporter() {
        return REPORTER_CONTEXT.get();
    }

    protected Reporter start() {
        logRecordListener = new LogRecordListener();
        LoggerFactory.addListener(logRecordListener);
        return this;
    }

    public void initSnapshot(WebDriver driver) {
        snapshot = new SnapshotImpl(driver);
    }

    public String getLogRecords() {
        if (logRecordListener != null) {
            return logRecordListener.getLogRecords()
                    .filter(logRecord -> logRecord.getLevel() == Level.INFO || logRecord.getLevel() == Level.SEVERE)
                    .filter(logRecord -> isNonEmpty(logRecord.getMessage()))
                    .map(this::mapLogMessage)
                    .collect(Collectors.joining("", OPEN_TAG, CLOSE_TAG));
        }
        return "";
    }

    private String mapLogMessage(LogRecord logRecord) {
        String message = logRecord.getMessage().replace("\n", "
");
        return (logRecord.getLevel() == Level.SEVERE) ? "" + message + "" : message;
    }

    private Reporter attachLog() {
        String infoLogs = getLogRecords();
        if (!infoLogs.equalsIgnoreCase(EMPTY_LOGS)) {
            Reporter.log(String.format(LOGS_DETAILS, infoLogs));
        }
        return this;
    }

    private Reporter stop() {
        if (logRecordListener != null) {
            LoggerFactory.removeListener(logRecordListener);
        }
        return this;
    }

    void removeReporter() {
        REPORTER_CONTEXT.remove();
    }

    void attachAndClear() {
        attachLog().stop();

    }

    void attachAndRestart() {
        attachLog().stop().start();
    }

    public void attachScreenshot() {
        SelcukesExtentAdapter.attachScreenshot(snapshot.shootPageAsBytes());
    }

    public void attachVisiblePageScreenshot() {
        SelcukesExtentAdapter.attachScreenshot(snapshot.shootVisiblePageAsBytes());
    }
}