Extracted Appium LocalServiceSettings to get them from settings.json (#12)

Extracted Appium LocalServiceSettings to get them from settings.json
Register implementation in container, add getter to AqualityServices
Add section to setting.json files

Author: mialeska

src/main/java/aquality/appium/mobile/application/AqualityServices.java

@@ -2,6 +2,7 @@
 
 import aquality.appium.mobile.configuration.IApplicationProfile;
 import aquality.appium.mobile.configuration.IConfiguration;
+import aquality.appium.mobile.configuration.ILocalServiceSettings;
 import aquality.appium.mobile.elements.interfaces.IElementFactory;
 import aquality.selenium.core.localization.ILocalizedLogger;
 import aquality.selenium.core.logging.Logger;
@@ -160,6 +161,15 @@ public static IApplicationProfile getApplicationProfile() {
         return get(IApplicationProfile.class);
     }
 
+    /**
+     * Gets AppiumDriverLocalService settings.
+     *
+     * @return AppiumDriverLocalService settings.
+     */
+    public static ILocalServiceSettings getLocalServiceSettings() {
+        return get(ILocalServiceSettings.class);
+    }
+
     /**
      * Provides interface to access all described configurations.
      *

src/main/java/aquality/appium/mobile/application/LocalApplicationFactory.java

@@ -1,5 +1,6 @@
 package aquality.appium.mobile.application;
 
+import aquality.appium.mobile.configuration.ILocalServiceSettings;
 import io.appium.java_client.AppiumDriver;
 import io.appium.java_client.service.local.AppiumDriverLocalService;
 import io.appium.java_client.service.local.AppiumServiceBuilder;
@@ -8,8 +9,10 @@ public class LocalApplicationFactory extends ApplicationFactory {
 
     @Override
     public Application getApplication() {
+        ILocalServiceSettings settings = AqualityServices.getLocalServiceSettings();
         AppiumServiceBuilder builder = new AppiumServiceBuilder()
-                .withArgument(() -> "--allow-insecure", "chromedriver_autodownload");
+                .withCapabilities(settings.getCapabilities());
+        settings.getArguments().forEach(builder::withArgument);
         AppiumDriverLocalService service = AppiumDriverLocalService.buildService(builder);
         service.start();
         AppiumDriver driver = getDriver(service.getUrl());

src/main/java/aquality/appium/mobile/application/MobileModule.java

@@ -3,6 +3,7 @@
 import aquality.appium.mobile.configuration.IApplicationProfile;
 import aquality.appium.mobile.configuration.IConfiguration;
 import aquality.appium.mobile.configuration.IConfigurationsModule;
+import aquality.appium.mobile.configuration.ILocalServiceSettings;
 import aquality.appium.mobile.elements.IElementsModule;
 import aquality.appium.mobile.elements.interfaces.IElementFactory;
 import aquality.selenium.core.applications.AqualityModule;
@@ -18,6 +19,7 @@ public MobileModule(Provider<Application> applicationProvider) {
     protected void configure() {
         super.configure();
         bind(IApplicationProfile.class).to(getApplicationProfileImplementation()).in(Singleton.class);
+        bind(ILocalServiceSettings.class).to(getLocalServiceSettingsImplementation()).in(Singleton.class);
         bind(IConfiguration.class).to(getConfigurationImplementation());
         bind(IElementFactory.class).to(getElementFactoryImplementation());
     }

src/main/java/aquality/appium/mobile/configuration/IConfigurationsModule.java

@@ -12,6 +12,13 @@ default Class<? extends IApplicationProfile> getApplicationProfileImplementation
         return ApplicationProfile.class;
     }
 
+    /**
+     * @return class which implements {@link ILocalServiceSettings}
+     */
+    default Class<? extends ILocalServiceSettings> getLocalServiceSettingsImplementation() {
+        return LocalServiceSettings.class;
+    }
+
     /**
      * @return class which implements {@link IConfiguration}
      */

src/main/java/aquality/appium/mobile/configuration/ILocalServiceSettings.java

@@ -0,0 +1,24 @@
+package aquality.appium.mobile.configuration;
+
+import io.appium.java_client.service.local.flags.ServerArgument;
+import org.openqa.selenium.remote.DesiredCapabilities;
+
+import java.util.Map;
+
+/**
+ * Describes AppiumDriverLocalService settings.
+ */
+public interface ILocalServiceSettings {
+    /**
+     * Gets appium driver local service arguments.
+     * @return arguments map.
+     */
+    Map<ServerArgument, String> getArguments();
+
+
+    /**
+     * Gets appium driver local service desired capabilities.
+     * @return initialized {@link DesiredCapabilities}.
+     */
+    DesiredCapabilities getCapabilities();
+}

src/main/java/aquality/appium/mobile/configuration/LocalServiceSettings.java

@@ -0,0 +1,35 @@
+package aquality.appium.mobile.configuration;
+
+import aquality.selenium.core.utilities.ISettingsFile;
+import com.google.inject.Inject;
+import io.appium.java_client.service.local.flags.ServerArgument;
+import org.openqa.selenium.remote.DesiredCapabilities;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class LocalServiceSettings implements ILocalServiceSettings {
+    private static final String SETTINGS_PATH = "/localServiceSettings";
+    private final ISettingsFile settingsFile;
+
+    @Inject
+    public LocalServiceSettings(ISettingsFile settingsFile) {
+        this.settingsFile = settingsFile;
+    }
+
+    @Override
+    public Map<ServerArgument, String> getArguments() {
+        Map<ServerArgument, String> argumentStringMap = new HashMap<>();
+        settingsFile.getMap(SETTINGS_PATH + "/arguments")
+                .forEach((key, value) -> argumentStringMap.put(() -> key, value.toString()));
+        return argumentStringMap;
+    }
+
+    @Override
+    public DesiredCapabilities getCapabilities() {
+        Map<String, Object> capabilitiesFromSettings = settingsFile.getMap(SETTINGS_PATH + "/capabilities");
+        DesiredCapabilities capabilities = new DesiredCapabilities();
+        capabilitiesFromSettings.forEach(capabilities::setCapability);
+        return capabilities;
+    }
+}

src/main/resources/settings.json

@@ -20,6 +20,13 @@
       }
     }
   },
+  "localServiceSettings": {
+    "arguments": {
+      "--allow-insecure": "chromedriver_autodownload"
+    },
+    "capabilities": {
+    }
+  },
   "timeouts": {
     "timeoutImplicit" : 0,
     "timeoutCondition" : 15,

src/test/resources/settings.androidwebsession.json

@@ -13,6 +13,13 @@
       }
     }
   },
+  "localServiceSettings": {
+    "arguments": {
+      "--allow-insecure": "chromedriver_autodownload"
+    },
+    "capabilities": {
+    }
+  },
   "timeouts": {
     "timeoutImplicit" : 0,
     "timeoutCondition" : 15,

src/test/resources/settings.json

@@ -23,6 +23,13 @@
       }
     }
   },
+  "localServiceSettings": {
+    "arguments": {
+      "--allow-insecure": "chromedriver_autodownload"
+    },
+    "capabilities": {
+    }
+  },
   "timeouts": {
     "timeoutImplicit" : 0,
     "timeoutCondition" : 15,