How to use CapabilitiesConfigurationPropertyRetriever class of org.fluentlenium.configuration package

Best FluentLenium code snippet using org.fluentlenium.configuration.CapabilitiesConfigurationPropertyRetriever

Source:PropertiesBackendConfiguration.java

...12     * Default properties prefix.13     */14    static final String PROPERTIES_PREFIX = "fluentlenium.";15    private final String[] prefixes;16    private CapabilitiesConfigurationPropertyRetriever capabilitiesRetriever;17    private PropertiesBackend propertiesBackend;18    /**19     * Creates a new abstract properties configuration, using default properties prefix.20     *21     * @param propertiesReader properties reader22     * @see #PROPERTIES_PREFIX23     */24    PropertiesBackendConfiguration(PropertiesBackend propertiesReader) {25        this(propertiesReader, PROPERTIES_PREFIX);26    }27    /**28     * Creates a new abstract properties configuration, using given properties prefixes.29     *30     * @param propertiesReader properties reader31     * @param prefixes         array of allowed prefixes32     */33    PropertiesBackendConfiguration(PropertiesBackend propertiesReader, String... prefixes) {34        if (prefixes.length == 0) {35            throw new IllegalArgumentException("At least one configuration property prefix should be defined."36                    + "Alternatively you can call the PropertiesBackendConfiguration(PropertiesBackend) constructor"37                    + "to have the default 'fluentlenium.' prefix configured.");38        }39        propertiesBackend = propertiesReader;40        this.prefixes = prefixes;41        capabilitiesRetriever = new CapabilitiesConfigurationPropertyRetriever();42    }43    /**44     * Get the underlying properties backend.45     *46     * @return properties backend47     */48    PropertiesBackend getPropertiesBackend() {49        return propertiesBackend;50    }51    /**52     * Set the underlying properties backend.53     *54     * @param propertiesBackend properties backend55     */56    void setPropertiesBackend(PropertiesBackend propertiesBackend) {57        this.propertiesBackend = propertiesBackend;58    }59    /**60     * Get the property value used by underlying property storage.61     *62     * @param propertyName property key63     * @return property value64     */65    private String getPropertyImpl(String propertyName) {66        return propertiesBackend.getProperty(propertyName);67    }68    private String getProperty(String propertyName) {69        for (String prefix : prefixes) {70            String property = getPropertyImpl(prefix + propertyName);71            if (property != null) {72                return property;73            }74        }75        return null;76    }77    private boolean isValidProperty(String property) {78        return !StringUtils.isEmpty(property) && !"null".equalsIgnoreCase(property);79    }80    private String getStringProperty(String propertyName) {81        String property = getProperty(propertyName);82        if (!isValidProperty(property)) {83            return null;84        }85        return property;86    }87    private Long getLongProperty(String propertyName) {88        String property = getProperty(propertyName);89        if (!isValidProperty(property) || property == null) {90            return null;91        }92        try {93            return Long.parseLong(property);94        } catch (NumberFormatException e) {95            return null;96        }97    }98    private Boolean getBooleanProperty(String propertyName) {99        String property = getProperty(propertyName);100        if (!isValidProperty(property) || property == null) {101            return null;102        }103        return Boolean.parseBoolean(property);104    }105    private <T extends Enum<T>> T getEnumProperty(Class<T> enumClass, String propertyName) {106        String property = getProperty(propertyName);107        if (!isValidProperty(property) || property == null) {108            return null;109        }110        if ("DEFAULT".equalsIgnoreCase(propertyName)) {111            return null;112        }113        return Enum.valueOf(enumClass, property.toUpperCase(Locale.ENGLISH));114    }115    private <T> Class<T> getClassProperty(Class<T> clazz, String propertyName) {116        String property = getProperty(propertyName);117        if (!isValidProperty(property) || property == null) {118            return null;119        }120        try {121            Class<?> propertyClass = Class.forName(property);122            if (clazz.isAssignableFrom(propertyClass)) {123                return (Class<T>) propertyClass;124            }125        } catch (ClassNotFoundException e) { // NOPMD EmptyCatchBlock126        }127        return null;128    }129    @Override130    public Class<? extends ConfigurationFactory> getConfigurationFactory() {131        return getClassProperty(ConfigurationFactory.class, "configurationFactory");132    }133    @Override134    public Class<? extends ConfigurationProperties> getConfigurationDefaults() {135        return getClassProperty(ConfigurationDefaults.class, "configurationDefaults");136    }137    @Override138    public String getWebDriver() {139        return getStringProperty("webDriver");140    }141    @Override142    public String getRemoteUrl() {143        return getStringProperty("remoteUrl");144    }145    @Override146    public Capabilities getCapabilities() {147        String capabilities = getProperty("capabilities");148        if (isValidProperty(capabilities)) {149            return capabilitiesRetriever.getCapabilitiesProperty(capabilities, getGlobalConfiguration());150        }151        return null;152    }153    @Override154    public DriverLifecycle getDriverLifecycle() {155        return getEnumProperty(DriverLifecycle.class, "driverLifecycle");156    }157    @Override158    public Long getBrowserTimeout() {159        return getLongProperty("browserTimeout");160    }161    @Override162    public Integer getBrowserTimeoutRetries() {163        Long browserTimeout = getLongProperty("browserTimeout");164        return (browserTimeout == null) ? null : browserTimeout.intValue();165    }166    @Override167    public Boolean getDeleteCookies() {168        return getBooleanProperty("deleteCookies");169    }170    @Override171    public String getBaseUrl() {172        return getStringProperty("baseUrl");173    }174    @Override175    public Boolean getEventsEnabled() {176        return getBooleanProperty("eventsEnabled");177    }178    @Override179    public Long getPageLoadTimeout() {180        return getLongProperty("pageLoadTimeout");181    }182    @Override183    public Long getImplicitlyWait() {184        return getLongProperty("implicitlyWait");185    }186    @Override187    public Long getScriptTimeout() {188        return getLongProperty("scriptTimeout");189    }190    @Override191    public Long getAwaitAtMost() {192        return getLongProperty("awaitAtMost");193    }194    @Override195    public Long getAwaitPollingEvery() {196        return getLongProperty("awaitPollingEvery");197    }198    @Override199    public String getScreenshotPath() {200        return getStringProperty("screenshotPath");201    }202    @Override203    public String getHtmlDumpPath() {204        return getStringProperty("htmlDumpPath");205    }206    @Override207    public TriggerMode getScreenshotMode() {208        return getEnumProperty(TriggerMode.class, "screenshotMode");209    }210    @Override211    public TriggerMode getHtmlDumpMode() {212        return getEnumProperty(TriggerMode.class, "htmlDumpMode");213    }214    @Override215    public String getCustomProperty(String propertyName) {216        return getStringProperty(propertyName);217    }218    @VisibleForTesting219    void setCapabilitiesRetriever(CapabilitiesConfigurationPropertyRetriever capabilitiesRetriever) {220        this.capabilitiesRetriever = capabilitiesRetriever;221    }222}...

Source:CapabilitiesConfigurationPropertyRetriever.java

...12/**13 * Provides {@link Capabilities} object based on the value and the kind of the value of the capabilities configuration14 * property.15 */16class CapabilitiesConfigurationPropertyRetriever {17    private final Json jsonConverter = new Json();18    /**19     * Returns a {@link Capabilities} object based on the argument property value.20     * <p>21     * It goes through the following fallback logic:22     * <ul>23     * <li>first it tries to retrieve the capabilities handling the argument property as a URL,</li>24     * <li>then if there's a {@link CapabilitiesFactory} registered for that capabilities value, it will create25     * and return the Capabilities object from that factory, optionally using the {@code globalConfiguration}</li>26     * <li>finally, if factory was found, it will try to handle the argument as a JSON string and convert ot27     * to a {@link DesiredCapabilities} object.</li>28     * </ul>29     *30     * @param capabilities        capabilities property value...

Source:CapabilitiesConfigurationPropertyRetrieverTest.java

...6import java.net.URL;7import static org.assertj.core.api.Assertions.assertThat;8import static org.assertj.core.api.Assertions.assertThatExceptionOfType;9/**10 * Unit test for {@link CapabilitiesConfigurationPropertyRetriever}.11 */12public class CapabilitiesConfigurationPropertyRetrieverTest {13    private CapabilitiesConfigurationPropertyRetriever retriever;14    @Before15    public void setup() {16        retriever = new CapabilitiesConfigurationPropertyRetriever();17    }18    @Test19    public void capabilities() {20        DesiredCapabilities capabilitiesJSEnabled = new DesiredCapabilities();21        capabilitiesJSEnabled.setJavascriptEnabled(true);22        Capabilities capabilities = retriever.getCapabilitiesProperty("{\"javascriptEnabled\": true}", null);23        assertThat(capabilities).isEqualTo(capabilitiesJSEnabled);24    }25    @Test26    public void shouldFailExceptionWhenJSONStringCannotBeConverted() {27        assertThatExceptionOfType(ConfigurationException.class)28                .isThrownBy(() -> retriever.getCapabilitiesProperty("{\"javascriptEnabled\": true", null))29                .withMessage("Can't convert JSON Capabilities to Object.");30    }...