feat: Implementation of Chromium driver plus capabilities

src/main/java/io/appium/java_client/chromium/ChromiumDriver.java

@@ -0,0 +1,140 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appium.java_client.chromium;
+
+import io.appium.java_client.AppiumClientConfig;
+import io.appium.java_client.AppiumDriver;
+import io.appium.java_client.remote.AutomationName;
+import io.appium.java_client.service.local.AppiumDriverLocalService;
+import io.appium.java_client.service.local.AppiumServiceBuilder;
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.remote.HttpCommandExecutor;
+import org.openqa.selenium.remote.http.ClientConfig;
+import org.openqa.selenium.remote.http.HttpClient;
+
+import java.net.URL;
+
+/**
+ * <p>ChromiumDriver is an officially supported Appium driver created to automate Mobile browsers
+ * and web views based on the Chromium engine. The driver uses W3CWebDriver protocol and is built
+ * on top of chromium driver server.</p>
+ * <br>
+ * <p>Read <a href='https://github.com/appium/appium-chromium-driver'>appium-chromium-driver</a>
+ * for more details on how to configure and use it.</p>
+ */
+public class ChromiumDriver extends AppiumDriver {
+    private static final String AUTOMATION_NAME = AutomationName.CHROMIUM;
+
+    public ChromiumDriver(HttpCommandExecutor executor, Capabilities capabilities) {
+        super(executor, ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    public ChromiumDriver(URL remoteAddress, Capabilities capabilities) {
+        super(remoteAddress, ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    public ChromiumDriver(URL remoteAddress, HttpClient.Factory httpClientFactory, Capabilities capabilities) {
+        super(remoteAddress, httpClientFactory, ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    public ChromiumDriver(AppiumDriverLocalService service, Capabilities capabilities) {
+        super(service, ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    public ChromiumDriver(AppiumDriverLocalService service, HttpClient.Factory httpClientFactory,
+                          Capabilities capabilities) {
+        super(service, httpClientFactory, ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    public ChromiumDriver(AppiumServiceBuilder builder, Capabilities capabilities) {
+        super(builder, ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    public ChromiumDriver(AppiumServiceBuilder builder, HttpClient.Factory httpClientFactory,
+                          Capabilities capabilities) {
+        super(builder, httpClientFactory, ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    public ChromiumDriver(HttpClient.Factory httpClientFactory, Capabilities capabilities) {
+        super(httpClientFactory, ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    /**
+     * This is a special constructor used to connect to a running driver instance.
+     * It does not do any necessary verifications, but rather assumes the given
+     * driver session is already running at `remoteSessionAddress`.
+     * The maintenance of driver state(s) is the caller's responsibility.
+     * !!! This API is supposed to be used for **debugging purposes only**.
+     *
+     * @param remoteSessionAddress The address of the **running** session including the session identifier.
+     * @param platformName The name of the target platform.
+     */
+    public ChromiumDriver(URL remoteSessionAddress, String platformName) {
+        super(remoteSessionAddress, platformName, AUTOMATION_NAME);
+    }
+
+    /**
+     * Creates a new instance based on the given ClientConfig and {@code capabilities}.
+     * The HTTP client is default client generated by {@link HttpCommandExecutor#getDefaultClientFactory}.
+     * For example:
+     *
+     * <pre>
+     *
+     * ClientConfig clientConfig = ClientConfig.defaultConfig()
+     *     .baseUri(URI.create("WebDriver URL"))
+     *     .readTimeout(Duration.ofMinutes(5));
+     * ChromiumOptions options = new ChromiumOptions();
+     * ChromiumDriver driver = new ChromiumDriver(clientConfig, options);
+     *
+     * </pre>
+     *
+     * @param clientConfig take a look at {@link ClientConfig}
+     * @param capabilities take a look at {@link Capabilities}
+     *
+     */
+    public ChromiumDriver(ClientConfig clientConfig, Capabilities capabilities) {
+        super(AppiumClientConfig.fromClientConfig(clientConfig), ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    /**
+     * Creates a new instance based on the given ClientConfig and {@code capabilities}.
+     * The HTTP client is default client generated by {@link HttpCommandExecutor#getDefaultClientFactory}.
+     * For example:
+     *
+     * <pre>
+     *
+     * AppiumClientConfig appiumClientConfig = AppiumClientConfig.defaultConfig()
+     *     .directConnect(true)
+     *     .baseUri(URI.create("WebDriver URL"))
+     *     .readTimeout(Duration.ofMinutes(5));
+     * ChromiumOptions options = new ChromiumOptions();
+     * ChromiumDriver driver = new ChromiumDriver(options, appiumClientConfig);
+     *
+     * </pre>
+     *
+     * @param appiumClientConfig take a look at {@link AppiumClientConfig}
+     * @param capabilities take a look at {@link Capabilities}
+     *
+     */
+    public ChromiumDriver(AppiumClientConfig appiumClientConfig, Capabilities capabilities) {
+        super(appiumClientConfig, ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+
+    public ChromiumDriver(Capabilities capabilities) {
+        super(ensureAutomationName(capabilities, AUTOMATION_NAME));
+    }
+}

src/main/java/io/appium/java_client/chromium/options/ChromiumOptions.java

@@ -0,0 +1,58 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appium.java_client.chromium.options;
+
+import io.appium.java_client.remote.AutomationName;
+import io.appium.java_client.remote.options.BaseOptions;
+import io.appium.java_client.remote.options.SupportsBrowserNameOption;
+import org.openqa.selenium.Capabilities;
+
+import java.util.Map;
+
+/**
+ * <p>Options class that sets options for Chromium when testing websites.</p>
+ * <br>
+ * @see <a href='https://github.com/appium/appium-chromium-driver#usage'>appium-chromium-driver usage section</a>
+ */
+public class ChromiumOptions extends BaseOptions<ChromiumOptions> implements
+        SupportsBrowserNameOption<ChromiumOptions>,
+        SupportsChromeDrivePortOption<ChromiumOptions>,
+        SupportsExecutableOption<ChromiumOptions>,
+        SupportsExecutableDirOption<ChromiumOptions>,
+        SupportsVerboseOption<ChromiumOptions>,
+        SupportsLogPathOption<ChromiumOptions>,
+        SupportsBuildCheckOption<ChromiumOptions>,
+        SupportsAutodownloadOption<ChromiumOptions>,
+        SupportsUseSystemExecutableOption<ChromiumOptions> {
+    public ChromiumOptions() {
+        setCommonOptions();
+    }
+
+    public ChromiumOptions(Capabilities source) {
+        super(source);
+        setCommonOptions();
+    }
+
+    public ChromiumOptions(Map<String, ?> source) {
+        super(source);
+        setCommonOptions();
+    }
+
+    private void setCommonOptions() {
+        setAutomationName(AutomationName.CHROMIUM);
+    }
+}

src/main/java/io/appium/java_client/chromium/options/SupportsAutodownloadOption.java

@@ -0,0 +1,51 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appium.java_client.chromium.options;
+
+import io.appium.java_client.remote.options.BaseOptions;
+import io.appium.java_client.remote.options.CanSetCapability;
+import org.openqa.selenium.Capabilities;
+
+import java.util.Optional;
+
+import static io.appium.java_client.internal.CapabilityHelpers.toSafeBoolean;
+
+public interface SupportsAutodownloadOption<T extends BaseOptions<T>> extends
+        Capabilities, CanSetCapability<T> {
+    String AUTODOWNLOAD_ENABLED = "autodownloadEnabled";
+
+    /**
+     * Set to false for disabling automatic downloading of Chrome drivers.
+     * Unless disable build check preference has been user-set, the capability
+     * is present because the default value is true.
+     *
+     * @param autodownloadEnabled flag.
+     * @return self instance for chaining.
+     */
+    default T setAutodownloadEnabled(boolean autodownloadEnabled) {
+        return amend(AUTODOWNLOAD_ENABLED, autodownloadEnabled);
+    }
+
+    /**
+     * Get the auto download flag.
+     *
+     * @return auto download flag.
+     */
+    default Optional<Boolean> isAutodownloadEnabled() {
+        return Optional.ofNullable(toSafeBoolean(getCapability(AUTODOWNLOAD_ENABLED)));
+    }
+}

src/main/java/io/appium/java_client/chromium/options/SupportsBuildCheckOption.java

@@ -0,0 +1,51 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appium.java_client.chromium.options;
+
+import io.appium.java_client.remote.options.BaseOptions;
+import io.appium.java_client.remote.options.CanSetCapability;
+import org.openqa.selenium.Capabilities;
+
+import java.util.Optional;
+
+import static io.appium.java_client.internal.CapabilityHelpers.toSafeBoolean;
+
+public interface SupportsBuildCheckOption<T extends BaseOptions<T>> extends
+        Capabilities, CanSetCapability<T> {
+    String DISABLE_BUILD_CHECK = "disableBuildCheck";
+
+    /**
+     * Set to true to add the --disable-build-check flag when starting WebDriver.
+     * Unless disable build check preference has been user-set, the capability
+     * is not present because the default value is false.
+     *
+     * @param BuildCheckDisabled flag for --disable-build-check.
+     * @return self instance for chaining.
+     */
+    default T setBuildCheckDisabled(boolean BuildCheckDisabled) {
+        return amend(DISABLE_BUILD_CHECK, BuildCheckDisabled);
+    }
+
+    /**
+     * Get disable build check flag.
+     *
+     * @return disable build check flag.
+     */
+    default Optional<Boolean> isBuildCheckDisabled() {
+        return Optional.ofNullable(toSafeBoolean(getCapability(DISABLE_BUILD_CHECK)));
+    }
+}

src/main/java/io/appium/java_client/chromium/options/SupportsChromeDrivePortOption.java

@@ -0,0 +1,51 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appium.java_client.chromium.options;
+
+import io.appium.java_client.remote.options.BaseOptions;
+import io.appium.java_client.remote.options.CanSetCapability;
+import org.openqa.selenium.Capabilities;
+
+import java.util.Optional;
+
+import static io.appium.java_client.internal.CapabilityHelpers.toInteger;
+
+public interface SupportsChromeDrivePortOption<T extends BaseOptions<T>> extends
+        Capabilities, CanSetCapability<T> {
+    String CHROME_DRIVER_PORT = "chromedriverPort";
+
+    /**
+     * The port to start WebDriver processes on. Unless the chrome drive port preference
+     * has been user-set, it will listen on port 9515, which is the default
+     * value for this capability.
+     *
+     * @param port port number in range 0..65535.
+     * @return self instance for chaining.
+     */
+    default T setChromeDriverPort(int port) {
+        return amend(CHROME_DRIVER_PORT, port);
+    }
+
+    /**
+     * Get the number of the port for the chrome driver to listen on.
+     *
+     * @return Chrome driver port value.
+     */
+    default Optional<Integer> getChromeDriverPort() {
+        return Optional.ofNullable(toInteger(getCapability(CHROME_DRIVER_PORT)));
+    }
+}