com.github.invictum.reportportal.LogsPreset Maven / Gradle / Ivy

Go to download
package com.github.invictum.reportportal;

import com.epam.ta.reportportal.ws.model.log.SaveLogRQ;
import com.github.invictum.reportportal.log.unit.*;
import com.github.invictum.reportportal.log.unit.Error;
import com.google.common.base.Preconditions;
import net.thucydides.model.domain.TestStep;

import java.util.Collection;
import java.util.function.Function;

/**
 * Describes a presets of predefined log units.
 */
@SuppressWarnings("unchecked")
public enum LogsPreset {

    /**
     * Default preset with pre-defined minimalistic set of log units.
     */
    DEFAULT {
        @Override
        public Function>[] logUnits() {
            return new Function[]{
                    Attachment.screenshots(),
                    Rest.restQuery(),
                    Error.basic(),
                    Attachment.evidences()
            };
        }
    },

    /**
     * Preset configured with all available out of the box log units.
     */
    FULL {
        @Override
        public Function>[] logUnits() {
            return new Function[]{
                    Attachment.screenshots(),
                    Rest.restQuery(),
                    Error.basic(),
                    Attachment.htmlSources(),
                    Attachment.evidences(),
                    Selenium.allLogs()
            };
        }
    },

    /**
     * Custom preset for manual configuration. By default returns an empty array of log units.
     */
    CUSTOM {

        private Function>[] units;

        @Override
        public Function>[] logUnits() {
            return units == null ? new Function[0] : units;
        }

        @Override
        @SafeVarargs
        final public LogsPreset register(Function>... units) {
            Preconditions.checkArgument(units != null, "Units list must not be null");
            this.units = units;
            return this;
        }
    };

    /**
     * Returns an array of log units associated with current preset
     */
    public abstract Function>[] logUnits();

    /**
     * Configures a preset to use a list of passed log units. Registration is allowed only for CUSTOM preset
     */
    public LogsPreset register(Function>... units) {
        throw new UnsupportedOperationException("Only CUSTOM preset allows to register log units");
    }
}