Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
1278a63
extracted ISettingsFile and added tests
knysh Jan 27, 2020
3cd01b3
Merge branch 'master' into Feature/10-implement-SettingsFile
knysh Jan 27, 2020
1c72731
added documentation for ISettingsFile
knysh Jan 28, 2020
1f0602a
extracted ILoggerConfiguration
knysh Jan 28, 2020
aee9151
extracted ITimeoutConfiguration
knysh Jan 28, 2020
3ede916
extracted IRetryConfiguration
knysh Jan 28, 2020
4e2b14f
renamed one test
knysh Jan 28, 2020
d4ec648
added empty end line and
knysh Jan 28, 2020
5dd1015
renamed constants to upper case
knysh Jan 28, 2020
b7c5b5f
removed redundant method from ISettingsFile
knysh Jan 28, 2020
0e62ec6
Merge remote-tracking branch 'origin/Feature/10-implement-SettingsFil…
knysh Jan 28, 2020
890314e
fixed naming and added empty line at the end of files
knysh Jan 28, 2020
5b47103
Merge branch 'Feature/11-LoggerConfiguration' into Feature/11-Timeout…
knysh Jan 28, 2020
5ad2519
fixed naming and added empty line at the end of files
knysh Jan 28, 2020
fc6cfdb
Merge branch 'Feature/11-TimeoutConfiguration' into Feature/11-IRetry…
knysh Jan 28, 2020
b2f48c8
fixed naming and added empty line at the end of files
knysh Jan 28, 2020
88b025a
Merge branch 'master' into Feature/10-implement-SettingsFile
knysh Jan 29, 2020
4619ac0
merged with master and added test for CustomSettingsFile
knysh Jan 29, 2020
ccac733
fix for the tests
knysh Jan 29, 2020
1abd298
Merge branch 'Feature/10-implement-SettingsFile' into Feature/11-Logg…
knysh Jan 29, 2020
d58605f
merge and small refactoring of tests
knysh Jan 29, 2020
4983e88
Merge branch 'Feature/11-LoggerConfiguration' into Feature/11-Timeout…
knysh Jan 29, 2020
7513559
merge from master
knysh Jan 29, 2020
cd4d3ed
Merge branch 'Feature/11-TimeoutConfiguration' into Feature/11-IRetry…
knysh Jan 29, 2020
a968e5c
merge from master
knysh Jan 29, 2020
792cda2
extracted IElementCacheConfiguration
knysh Jan 30, 2020
bd4b4fa
Merge branch 'master' into Feature/11-IRetryConfiguration
knysh Jan 30, 2020
a9ee1f3
merge and test fix
knysh Jan 30, 2020
6266fd3
removed SupportedLanguaged and added default language if configuratio…
knysh Jan 30, 2020
ee3383c
register configuration as singleton
knysh Jan 30, 2020
4244600
fixed comments
knysh Jan 30, 2020
327a682
moved SettingsFileUtil to ISettingsFile
knysh Jan 30, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
import aquality.selenium.core.logging.Logger;
import aquality.selenium.core.utilities.ISettingsFile;
import aquality.selenium.core.utilities.JsonSettingsFile;
import aquality.selenium.core.configurations.*;
import com.google.inject.AbstractModule;
import com.google.inject.Provider;
import com.google.inject.Singleton;

/**
* Describes all dependencies which is registered for the project.
Expand All @@ -25,6 +27,10 @@ protected void configure() {
bind(IApplication.class).toProvider(applicationProvider);
bind(ISettingsFile.class).toInstance(getSettings());
bind(Logger.class).toInstance(Logger.getInstance());
bind(ILoggerConfiguration.class).to(LoggerConfiguration.class).in(Singleton.class);
bind(ITimeoutConfiguration.class).to(TimeoutConfiguration.class).in(Singleton.class);
bind(IRetryConfiguration.class).to(RetryConfiguration.class).in(Singleton.class);
bind(IElementCacheConfiguration.class).to(ElementCacheConfiguration.class).in(Singleton.class);
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package aquality.selenium.core.configurations;

import aquality.selenium.core.utilities.ISettingsFile;
import com.google.inject.Inject;

public class ElementCacheConfiguration implements IElementCacheConfiguration{

private static final String IS_ENABLED_PATH = "/elementCache/isEnabled";
private boolean isEnabled;

@Inject
public ElementCacheConfiguration(ISettingsFile settingsFile){
isEnabled = settingsFile.isValuePresent(IS_ENABLED_PATH) && Boolean.valueOf(settingsFile.getValue(IS_ENABLED_PATH).toString());
}

@Override
public boolean isEnabled() {
return isEnabled;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package aquality.selenium.core.configurations;

/**
* Provides element's cache configuration.
*/
public interface IElementCacheConfiguration {

/**
* @return Is element caching allowed or not.
*/
boolean isEnabled();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package aquality.selenium.core.configurations;

/**
* Describes logger configuration.
*/
public interface ILoggerConfiguration {

/**
* Gets language used inside the library for logging.
* @return language used for logging.
*/
String getLanguage();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package aquality.selenium.core.configurations;

/**
* Describes retry configuration.
*/
public interface IRetryConfiguration {

/**
* Gets the number of attempts during retry.
*
* @return Number of retry attempts.
*/
int getNumber();

/**
* Gets the polling interval used in retry.
*
* @return Polling interval for retry.
*/
long getPollingInterval();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package aquality.selenium.core.configurations;

/**
* Provides timeouts configuration.
*/
public interface ITimeoutConfiguration {

/**
* Gets WedDriver ImplicitWait timeout.
*
* @return ImplicitWait timeout.
*/
long getImplicit();

/**
* Gets default ConditionalWait timeout.
*
* @return ConditionalWait timeout.
*/
long getCondition();

/**
* Gets ConditionalWait polling interval.
*
* @return polling interval.
*/
long getPollingInterval();

/**
* Gets Command timeout.
*
* @return Command timeout.
*/
long getCommand();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package aquality.selenium.core.configurations;

import aquality.selenium.core.utilities.ISettingsFile;
import com.google.inject.Inject;

public class LoggerConfiguration implements ILoggerConfiguration {

private static final String DEFAULT_LANGUAGE = "en";
private final ISettingsFile settingsFile;

@Inject
public LoggerConfiguration(ISettingsFile settingsFile){
this.settingsFile = settingsFile;
}

@Override
public String getLanguage() {
return settingsFile.getValueOrDefault("/logger/language", DEFAULT_LANGUAGE).toString();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package aquality.selenium.core.configurations;

import aquality.selenium.core.utilities.ISettingsFile;
import com.google.inject.Inject;

public class RetryConfiguration implements IRetryConfiguration {
private final int number;
private final long pollingInterval;

@Inject
public RetryConfiguration(ISettingsFile settingsFile) {
this.number = Integer.parseInt(settingsFile.getValue("/retry/number").toString());
this.pollingInterval = Long.parseLong(settingsFile.getValue("/retry/pollingInterval").toString());
}

@Override
public int getNumber() {
return number;
}

@Override
public long getPollingInterval() {
return pollingInterval;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
package aquality.selenium.core.configurations;

import aquality.selenium.core.utilities.ISettingsFile;
import com.google.inject.Inject;

public class TimeoutConfiguration implements ITimeoutConfiguration{

private final ISettingsFile settingsFile;
private final long condition;
private final long pollInterval;
private final long implicit;
private final long command;

@Inject
public TimeoutConfiguration(ISettingsFile settingsFile) {
this.settingsFile = settingsFile;
condition = getTimeout(TIMEOUT.CONDITION);
pollInterval = getTimeout(TIMEOUT.POLL_INTERVAL);
implicit = getTimeout(TIMEOUT.IMPLICIT);
command = getTimeout(TIMEOUT.COMMAND);
}

private long getTimeout(TIMEOUT timeout){
return Long.valueOf(settingsFile.getValue(timeout.getKey()).toString());
}

public long getImplicit(){
return implicit;
}

public long getCondition(){
return condition;
}

public long getPollingInterval(){
return pollInterval;
}

public long getCommand(){
return command;
}

private enum TIMEOUT {
IMPLICIT("/timeouts/timeoutImplicit"),
CONDITION("/timeouts/timeoutCondition"),
POLL_INTERVAL("/timeouts/timeoutPollingInterval"),
COMMAND("/timeouts/timeoutCommand");

private String key;
TIMEOUT(String key){
this.key = key;
}

private String getKey(){
return key;
}
}
}
11 changes: 11 additions & 0 deletions src/main/java/aquality/selenium/core/utilities/ISettingsFile.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,15 @@ public interface ISettingsFile {
* @return True if exists, false otherwise.
*/
boolean isValuePresent(String path);

/**
* Gets value from settings file or default value.
*
* @param path Path to the values. Depending on file format, it can be jsonPath, xpath etc.
* @param defaultValue will be returned if there is no value by path in settings file.
* @return Value from settings file or default value.
*/
default Object getValueOrDefault(String path, Object defaultValue) {
return this.isValuePresent(path) ? this.getValue(path) : defaultValue;
}
}
16 changes: 16 additions & 0 deletions src/main/resources/settings.json
Original file line number Diff line number Diff line change
@@ -1,2 +1,18 @@
{
"timeouts": {
"timeoutImplicit": 0,
"timeoutCondition": 30,
"timeoutPollingInterval": 300,
"timeoutCommand": 60
},
"retry": {
"number": 2,
"pollingInterval": 300
},
"logger": {
"language": "en"
},
"elementCache": {
"isEnabled": false
}
}
24 changes: 24 additions & 0 deletions src/test/java/tests/configurations/BaseProfileTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package tests.configurations;

import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeMethod;

public class BaseProfileTest {

protected static final String PROFILE_KEY = "profile";
private String previousProfile;

@BeforeMethod
public void saveProfile() {
previousProfile = System.getProperty(PROFILE_KEY);
}

@AfterMethod
public void restoreProfile() {
if (previousProfile == null) {
System.clearProperty(PROFILE_KEY);
} else {
System.setProperty(PROFILE_KEY, previousProfile);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package tests.configurations;

import aquality.selenium.core.configurations.IElementCacheConfiguration;
import org.testng.annotations.Test;
import tests.application.CustomAqualityServices;

import static org.testng.Assert.assertFalse;

public class ElementCacheConfigurationTests {

@Test
public void testShouldBePossibleCheckIsEnableElementCache() {
boolean isEnable = CustomAqualityServices.getServiceProvider().getInstance(IElementCacheConfiguration.class).isEnabled();
assertFalse(isEnable, "Element cache is disabled by default");
}
}
Loading