• Home
• info.novatec.testit
• webtester-core
• 2.9.0
• source code
• BaseConfiguration.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

info.novatec.testit.webtester.config.BaseConfiguration Maven / Gradle / Ivy

package info.novatec.testit.webtester.config;

import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;

import org.openqa.selenium.remote.BrowserType;
import org.openqa.selenium.support.Color;

import lombok.extern.slf4j.Slf4j;

import info.novatec.testit.webtester.config.builders.BaseConfigurationBuilder;
import info.novatec.testit.webtester.config.exceptions.InvalidValueTypeException;
import info.novatec.testit.webtester.config.exceptions.SetNullValuesException;
import info.novatec.testit.webtester.internal.configuration.NamedProperties;


/**
 * This is the base implementation of a {@link Configuration configuration}.
 * 

 * It can be initialized using a {@link BaseConfigurationBuilder base configuration builder}. And provides defaults for all
 * major named properties in case no {@link ConfigurationAdapter adapters} are used to construct the configuration.
 * 

 * Examples:

 * new BaseConfigurationBuilder().build();

 * new BaseConfigurationBuilder().withAdapter(adapter).build();
 *
 * @see Configuration
 * @see ConfigurationBuilder
 * @see ConfigurationAdapter
 * @see BaseConfigurationBuilder
 * @since 2.0
 */
@Slf4j
public class BaseConfiguration implements Configuration {

    private static final Set> ALLOWED_TYPES =
        asSet(String.class, Integer.class, Long.class, Float.class, Double.class, Boolean.class);

    private final Map properties = new HashMap<>();
    private final List configurationExporters = new ArrayList<>();

    /* named properties */

    @Override
    public long getActionDeceleration() {
        return getLongProperty(key(NamedProperties.ACTIONS_DECELERATION), 0L);
    }

    @Override
    public Configuration setActionDeceleration(long value) {
        return setProperty(key(NamedProperties.ACTIONS_DECELERATION), value);
    }

    @Override
    public boolean isEventSystemEnabled() {
        return getBooleanProperty(key(NamedProperties.EVENTS), Boolean.TRUE);
    }

    @Override
    public Configuration setEventSystemEnabled(boolean enabled) {
        return setProperty(key(NamedProperties.EVENTS), enabled);
    }

    @Override
    public Optional getDefaultEntryPoint() {
        return getStringProperty(key(NamedProperties.DEFAULTS_ENTRY_POINT));
    }

    @Override
    public BaseConfiguration setDefaultEntryPoint(String entryPoint) {
        return setProperty(key(NamedProperties.DEFAULTS_ENTRY_POINT), entryPoint);
    }

    @Override
    public File getScreenshotFolder() {
        return new File(getStringProperty(key(NamedProperties.FOLDERS_SCREENSHOT), "screenshots"));
    }

    @Override
    public BaseConfiguration setScreenshotFolder(File folder) {
        return setProperty(key(NamedProperties.FOLDERS_SCREENSHOT), folder.getAbsolutePath());
    }

    @Override
    public File getPageSourceFolder() {
        return new File(getStringProperty(key(NamedProperties.FOLDERS_PAGE_SOURCE), "sourcecode"));
    }

    @Override
    public BaseConfiguration setPageSourceFolder(File folder) {
        return setProperty(key(NamedProperties.FOLDERS_PAGE_SOURCE), folder.getAbsolutePath());
    }

    @Override
    public File getLogFolder() {
        return new File(getStringProperty(key(NamedProperties.FOLDERS_LOG), "logs"));
    }

    @Override
    public BaseConfiguration setLogFolder(File folder) {
        return setProperty(key(NamedProperties.FOLDERS_LOG), folder.getAbsolutePath());
    }

    @Override
    public boolean isMarkingsEnabled() {
        return getBooleanProperty(key(NamedProperties.MARKINGS), Boolean.FALSE);
    }

    @Override
    public BaseConfiguration setMarkingsEnabled(boolean activated) {
        return setProperty(key(NamedProperties.MARKINGS), activated);
    }

    @Override
    public Color getMarkingsColorUsedBackground() {
        return Color.fromString(getStringProperty(key(NamedProperties.MARKINGS_USED_BACKGROUND), "#ffd2a5"));
    }

    @Override
    public BaseConfiguration setMarkingsColorUsedBackground(Color color) {
        return setProperty(key(NamedProperties.MARKINGS_USED_BACKGROUND), color.asHex());
    }

    @Override
    public Color getMarkingsColorUsedOutline() {
        return Color.fromString(getStringProperty(key(NamedProperties.MARKINGS_USED_OUTLINE), "#916f22"));
    }

    @Override
    public BaseConfiguration setMarkingsColorUsedOutline(Color color) {
        return setProperty(key(NamedProperties.MARKINGS_USED_OUTLINE), color.asHex());
    }

    @Override
    public Color getMarkingsColorReadBackground() {
        return Color.fromString(getStringProperty(key(NamedProperties.MARKINGS_READ_BACKGROUND), "#90ee90"));
    }

    @Override
    public Configuration setMarkingsColorReadBackground(Color color) {
        return setProperty(key(NamedProperties.MARKINGS_READ_BACKGROUND), color.asHex());
    }

    @Override
    public Color getMarkingsColorReadOutline() {
        return Color.fromString(getStringProperty(key(NamedProperties.MARKINGS_READ_OUTLINE), "#008000"));
    }

    @Override
    public Configuration setMarkingsColorReadOutline(Color color) {
        return setProperty(key(NamedProperties.MARKINGS_READ_OUTLINE), color.asHex());
    }

    @Override
    public int getWaitTimeout() {
        return getIntegerProperty(key(NamedProperties.WAIT_TIMEOUT), 2);
    }

    @Override
    public BaseConfiguration setWaitTimeout(int waitTimeout) {
        return setProperty(key(NamedProperties.WAIT_TIMEOUT), waitTimeout);
    }

    @Override
    public long getWaitInterval() {
        return getLongProperty(key(NamedProperties.WAIT_INTERVAL), 100L);
    }

    @Override
    public BaseConfiguration setWaitInterval(long waitInterval) {
        return setProperty(key(NamedProperties.WAIT_INTERVAL), waitInterval);
    }

    @Override
    public String getRemoteBrowserName() {
        return getStringProperty(key(NamedProperties.REMOTE_BROWSER_NAME), BrowserType.FIREFOX);
    }

    @Override
    public Configuration setRemoteBrowserName(String name) {
        return setProperty(key(NamedProperties.REMOTE_BROWSER_NAME), name);
    }

    @Override
    public String getRemoteBrowserVersion() {
        return getStringProperty(key(NamedProperties.REMOTE_BROWSER_VERSION), "");
    }

    @Override
    public Configuration setRemoteBrowserVersion(String version) {
        return setProperty(key(NamedProperties.REMOTE_BROWSER_VERSION), version);
    }

    @Override
    public boolean getRemoteFirefoxMarionette() {
        return getBooleanProperty(key(NamedProperties.REMOTE_FIREFOX_MARIONETTE), true);
    }

    @Override
    public Configuration setRemoteFirefoxMarionette(boolean marionette) {
        return setProperty(key(NamedProperties.REMOTE_FIREFOX_MARIONETTE), marionette);
    }

    @Override
    public String getRemoteHost() {
        return getStringProperty(key(NamedProperties.REMOTE_HOST), "localhost");
    }

    @Override
    public Configuration setRemoteHost(String host) {
        return setProperty(key(NamedProperties.REMOTE_HOST), host);
    }

    @Override
    public int getRemotePort() {
        return getIntegerProperty(key(NamedProperties.REMOTE_PORT), 4444);
    }

    @Override
    public Configuration setRemotePort(int port) {
        return setProperty(key(NamedProperties.REMOTE_PORT), port);
    }

    private String key(NamedProperties property) {
        return property.getKey();
    }

    /* low-level function */

    @Override
    public BaseConfiguration removeProperty(String key) {
        properties.remove(key);
        log.debug("removed property '{}'", key);
        return this;
    }

    @Override
    public BaseConfiguration setProperty(String key, Object value) {

        assertNotNull(key, value);
        assertAllowedType(value);

        changeValue(key, value);
        exportProperty(key, value);

        return this;

    }

    private void assertNotNull(String key, Object value) {
        if (value == null) {
            throw new SetNullValuesException(key);
        }
    }

    private void assertAllowedType(Object value) {
        if (!ALLOWED_TYPES.contains(value.getClass())) {
            throw new InvalidValueTypeException(value.getClass(), ALLOWED_TYPES);
        }
    }

    private void changeValue(String key, Object value) {
        properties.put(key, String.valueOf(value));
        log.debug("changed value of property '{}' to: {}", key, value);
    }

    private void exportProperty(String key, Object value) {
        if (!configurationExporters.isEmpty()) {
            log.debug("exporting change of property '{}' to exporters", key);
            for (ConfigurationExporter exporter : configurationExporters) {
                log.trace("exporting change of property '{}'='{}' to {}", key, value, exporter);
                exporter.export(key, value);
            }
        }
    }

    @Override
    public Optional getStringProperty(String key) {
        return Optional.ofNullable(properties.get(key)).map(String::valueOf);
    }

    @Override
    public String getStringProperty(String key, String defaultValue) {
        return getStringProperty(key).orElse(defaultValue);
    }

    @Override
    public Optional getIntegerProperty(String key) {
        return Optional.ofNullable(properties.get(key)).map(Integer::valueOf);
    }

    @Override
    public Integer getIntegerProperty(String key, Integer defaultValue) {
        return getIntegerProperty(key).orElse(defaultValue);
    }

    @Override
    public Optional getLongProperty(String key) {
        return Optional.ofNullable(properties.get(key)).map(Long::valueOf);
    }

    @Override
    public Long getLongProperty(String key, Long defaultValue) {
        return getLongProperty(key).orElse(defaultValue);
    }

    @Override
    public Optional getFloatProperty(String key) {
        return Optional.ofNullable(properties.get(key)).map(Float::valueOf);
    }

    @Override
    public Float getFloatProperty(String key, Float defaultValue) {
        return getFloatProperty(key).orElse(defaultValue);
    }

    @Override
    public Optional getDoubleProperty(String key) {
        return Optional.ofNullable(properties.get(key)).map(Double::valueOf);
    }

    @Override
    public Double getDoubleProperty(String key, Double defaultValue) {
        return getDoubleProperty(key).orElse(defaultValue);
    }

    @Override
    public Optional getBooleanProperty(String key) {
        return Optional.ofNullable(properties.get(key)).map(Boolean::valueOf);
    }

    @Override
    public Boolean getBooleanProperty(String key, Boolean defaultValue) {
        return getBooleanProperty(key).orElse(defaultValue);
    }

    @Override
    public Optional