How to use setKeystoreConfig method of io.appium.java_client.android.options.signing.SupportsKeystoreOptions class

1/*
2 * Licensed under the Apache License, Version 2.0 (the "License");
3 * you may not use this file except in compliance with the License.
4 * See the NOTICE file distributed with this work for additional
5 * information regarding copyright ownership.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package io.appium.java_client.android.options.signing;
18
19import io.appium.java_client.remote.options.BaseOptions;
20import io.appium.java_client.remote.options.CanSetCapability;
21import org.openqa.selenium.Capabilities;
22
23import java.util.Optional;
24
25import static io.appium.java_client.internal.CapabilityHelpers.toSafeBoolean;
26
27public interface SupportsKeystoreOptions<T extends BaseOptions<T>> extends
28        Capabilities, CanSetCapability<T> {
29    String USE_KEYSTORE_OPTION = "useKeystore";
30    String KEYSTORE_PATH_OPTION = "keystorePath";
31    String KEYSTORE_PASSWORD_OPTION = "keystorePassword";
32    String KEY_ALIAS_OPTION = "keyAlias";
33    String KEY_PASSWORD_OPTION = "keyPassword";
34
35    /**
36     * Use a custom keystore to sign the app under test.
37     *
38     * @param keystoreConfig The keystore config to use.
39     * @return self instance for chaining.
40     */
41    default T setKeystoreConfig(KeystoreConfig keystoreConfig) {
42        return amend(USE_KEYSTORE_OPTION, true)
43                .amend(KEYSTORE_PATH_OPTION, keystoreConfig.getPath())
44                .amend(KEYSTORE_PASSWORD_OPTION, keystoreConfig.getPassword())
45                .amend(KEY_ALIAS_OPTION, keystoreConfig.getKeyAlias())
46                .amend(KEY_PASSWORD_OPTION, keystoreConfig.getKeyPassword());
47    }
48
49    /**
50     * Get whether to use a custom keystore.
51     *
52     * @return True or false.
53     */
54    default Optional<Boolean> doesUseKeystore() {
55        return Optional.ofNullable(toSafeBoolean(getCapability(USE_KEYSTORE_OPTION)));
56    }
57
58    /**
59     * Get the custom keystore config.
60     *
61     * @return The keystore config.
62     */
63    default Optional<KeystoreConfig> getKeystoreConfig() {
64        if (!doesUseKeystore().orElse(false)) {
65            return Optional.empty();
66        }
67        return Optional.of(new KeystoreConfig(
68                (String) getCapability(KEYSTORE_PATH_OPTION),
69                (String) getCapability(KEYSTORE_PASSWORD_OPTION),
70                (String) getCapability(KEY_ALIAS_OPTION),
71                (String) getCapability(KEY_PASSWORD_OPTION)
72        ));
73    }
74}
75

Source: SupportsKeystoreOptions.java

/*
 * 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.android.options.signing;

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 SupportsKeystoreOptions<T extends BaseOptions<T>> extends
        Capabilities, CanSetCapability<T> {
    String USE_KEYSTORE_OPTION = "useKeystore";
    String KEYSTORE_PATH_OPTION = "keystorePath";
    String KEYSTORE_PASSWORD_OPTION = "keystorePassword";
    String KEY_ALIAS_OPTION = "keyAlias";
    String KEY_PASSWORD_OPTION = "keyPassword";

    /**
     * Use a custom keystore to sign the app under test.
     *
     * @param keystoreConfig The keystore config to use.
     * @return self instance for chaining.
     */
    default T setKeystoreConfig(KeystoreConfig keystoreConfig) {
        return amend(USE_KEYSTORE_OPTION, true)
                .amend(KEYSTORE_PATH_OPTION, keystoreConfig.getPath())
                .amend(KEYSTORE_PASSWORD_OPTION, keystoreConfig.getPassword())
                .amend(KEY_ALIAS_OPTION, keystoreConfig.getKeyAlias())
                .amend(KEY_PASSWORD_OPTION, keystoreConfig.getKeyPassword());
    }

    /**
     * Get whether to use a custom keystore.
     *
     * @return True or false.
     */
    default Optional<Boolean> doesUseKeystore() {
        return Optional.ofNullable(toSafeBoolean(getCapability(USE_KEYSTORE_OPTION)));
    }

    /**
     * Get the custom keystore config.
     *
     * @return The keystore config.
     */
    default Optional<KeystoreConfig> getKeystoreConfig() {
        if (!doesUseKeystore().orElse(false)) {
            return Optional.empty();
        }
        return Optional.of(new KeystoreConfig(
                (String) getCapability(KEYSTORE_PATH_OPTION),
                (String) getCapability(KEYSTORE_PASSWORD_OPTION),
                (String) getCapability(KEY_ALIAS_OPTION),
                (String) getCapability(KEY_PASSWORD_OPTION)
        ));
    }
}