io.appium.java_client.ios.options.wda.SupportsUseXctestrunFileOption Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
Java client for Appium Mobile Webdriver
There is a newer version: 9.3.0
/*
 * 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.ios.options.wda;

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 SupportsUseXctestrunFileOption> extends
        Capabilities, CanSetCapability {
    String USE_XCTESTRUN_FILE_OPTION = "useXctestrunFile";

    /**
     * Enforce usage of .xctestrun file to launch WDA.
     *
     * @return self instance for chaining.
     */
    default T useXctestrunFile() {
        return amend(USE_XCTESTRUN_FILE_OPTION, true);
    }

    /**
     * Use Xctestrun file to launch WDA. It will search for such file in bootstrapPath.
     * Expected name of file is WebDriverAgentRunner_iphoneos<sdkVersion>-arm64.xctestrun for
     * real device and WebDriverAgentRunner_iphonesimulator<sdkVersion>-x86_64.xctestrun for
     * simulator. One can do build-for-testing for WebDriverAgent project for simulator and
     * real device and then you will see Product Folder like this and you need to copy content
     * of this folder at bootstrapPath location. Since this capability expects that you have
     * already built WDA project, it neither checks whether you have necessary dependencies to
     * build WDA nor will it try to build project. Defaults to false. Tips: Xcodebuild builds for the
     * target platform version. We'd recommend you to build with minimal OS version which you'd
     * like to run as the original WDA module. e.g. If you build WDA for 12.2, the module cannot
     * run on iOS 11.4 because of loading some module error on simulator. A module built with 11.4
     * can work on iOS 12.2. (This is xcodebuild's expected behaviour.)
     *
     * @param value Whether to use .xctestrun file to launch WDA.
     * @return self instance for chaining.
     */
    default T setUseXctestrunFile(boolean value) {
        return amend(USE_XCTESTRUN_FILE_OPTION, value);
    }

    /**
     * Get whether to use of .xctestrun file to launch WDA
     *
     * @return True or false.
     */
    default Optional doesUseXctestrunFile() {
        return Optional.ofNullable(toSafeBoolean(getCapability(USE_XCTESTRUN_FILE_OPTION)));
    }
}