com.paypal.selion.annotations.MobileTest Maven / Gradle / Ivy

Go to download
/*-------------------------------------------------------------------------------------------------------------------*\
|  Copyright (C) 2014-15 PayPal                                                                                       |
|                                                                                                                     |
|  Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance     |
|  with the License.                                                                                                  |
|                                                                                                                     |
|  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 com.paypal.selion.annotations;

import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Interface creates annotation MobileTest and specified parameters

 * Annotation @MobileTest will let Grid know to open a session on a mobile device/simulator. This can be used both in
 * the Test method and the Test Class. When used in the class, then all the tests within the class share the same
 * session (Session Sharing)
 */
@Retention(RUNTIME)
@Target({ CONSTRUCTOR, METHOD, TYPE })
public @interface MobileTest {
    /**
     * Establish application name to use. This is mandatory for all defaults apps. Example
     * 
     *      * @Test()
     * @MobileTest(appName = "Safari")
     * public void webtest2() {
     *     Grid.open("http://paypal.com");
     * }
     * 
     * 
     * App version can be specified as part of the appName as:
     * 
     *      * appName = "Safari:7.0"
     * 
     */
    String appName() default "";

    /**
     * Establish the type of device to be used (android, iphone, etc). No default. Platform version can be specified as
     * part of the device as:
     * 
     *      * device = "iphone:7.1"
     * 
     */
    String device() default "";

    /**
     * Establish the application's language that is to be used. For example; en for English. Defaults to
     * the language chosen by Selendroid / ios-driver / Appium
     */
    String language() default "";

    /**
     * Establish the application's locale that is to be used. For example; en_US for US English. Defaults
     * to the locale chosen by Selendroid / ios-driver / Appium
     */
    String locale() default "";

    /**
     * Device Serial to be used. Defaults to the device/emulator chosen by Selendroid / ios-driver / Appium
     */
    String deviceSerial() default "";

    /**
     * Establish the type of device to be used (Nexus5, Iphone5s, etc). Defaults to the device/emulator chosen by
     * Selendroid / ios-driver / Appium
     */
    String deviceType() default "";

    /**
     * Provide additional capabilities that you may wish to add as a name value pair. Values of true or false will be
     * treated as Boolean capabilities unless you surround the value with '
     * 
     *      * {@literal @}Test
     * {@literal @}MobileTest(additionalCapabilities={"key1:value1","key2:value2"})
     * public void testMethod(){
     *     // flow
     * }
     * 
     */
    String[] additionalCapabilities() default {};

    /**
     * This parameter represents the fully qualified path of the app that is to be spawned. For app exist in the local
     * disk this should be an absolute path, for app exist in the remote location it should be http URL and for app
     * exist in sauce cloud it can be sauce storage "sauce-storage:testApp.apk". This is mandatory for installable apps
     * running on Appium. appPath cannot be used along with the appName.
     * 
     *      *  for app in local disk it can be like appPath = C:\\test\\testApp.apk;
     * or for app in http location it can be like appPath = http://server/downloads/testApp.apk
     * or for app in sauce cloud it can be like appPath = sauce-storage:testApp.zip
     * 
     */
    String appPath() default "";

    /**
     * This parameter specifies to execute mobile test cases using respective mobile driver.
     */
    String mobileNodeType() default "";

}