17 |
18 |
--------------------------------------------------------------------------------
/app/src/test/kotlin/com/zoonref/appium/LoginTest.kt:
--------------------------------------------------------------------------------
1 | package com.zoonref.appium
2 |
3 | import com.zoonref.appium.page.MainPage
4 | import com.zoonref.appium.util.AppiumTest
5 | import org.junit.Assert.*
6 | import org.junit.Test
7 |
8 | /**
9 | * Created by zoonooz on 2017/11/17.
10 | * Test login process
11 | */
12 | class LoginTest : AppiumTest() {
13 |
14 | /**
15 | * User should be able to login
16 | *
17 | * Given: I am at login page
18 | * Then I login with my name
19 | * I should see success status
20 | */
21 | @Test
22 | fun login() {
23 | val mainPage = MainPage(driver!!)
24 | mainPage.loginWith("appium", "1234")
25 | assertTrue(mainPage.isLoginSuccess())
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 |
3 | # IDE (e.g. Android Studio) users:
4 | # Gradle settings configured through the IDE *will override*
5 | # any settings specified in this file.
6 |
7 | # For more details on how to configure your build environment visit
8 | # http://www.gradle.org/docs/current/userguide/build_environment.html
9 |
10 | # Specifies the JVM arguments used for the daemon process.
11 | # The setting is particularly useful for tweaking memory settings.
12 | org.gradle.jvmargs=-Xmx1536m
13 |
14 | # When configured, Gradle will run in incubating parallel mode.
15 | # This option should only be used with decoupled projects. More details, visit
16 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
17 | # org.gradle.parallel=true
18 |
--------------------------------------------------------------------------------
/app/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
22 |
--------------------------------------------------------------------------------
/app/src/test/kotlin/com/zoonref/appium/page/MainPage.kt:
--------------------------------------------------------------------------------
1 | package com.zoonref.appium.page
2 |
3 | import io.appium.java_client.AppiumDriver
4 | import io.appium.java_client.MobileElement
5 | import io.appium.java_client.pagefactory.*
6 |
7 | /**
8 | * Created by zoonooz on 2017/11/17.
9 | * Main page
10 | */
11 | class MainPage(driver: AppiumDriver<*>) : Page(driver) {
12 |
13 | @AndroidFindBy(id = "userEditText")
14 | @iOSFindBy(xpath = "//XCUIElementTypeApplication/XCUIElementTypeWindow[1]/XCUIElementTypeOther/XCUIElementTypeTextField")
15 | private var userTextField: MobileElement? = null
16 |
17 | @AndroidFindBy(id = "passwordEditText")
18 | @iOSFindBy(xpath = "//XCUIElementTypeApplication/XCUIElementTypeWindow[1]/XCUIElementTypeOther/XCUIElementTypeSecureTextField")
19 | private var passwordTextField: MobileElement? = null
20 |
21 | @AndroidFindBy(id = "loginButton")
22 | @iOSFindBy(accessibility = "Login")
23 | private var loginButton: MobileElement? = null
24 |
25 | @AndroidFindBy(id = "statusTextView")
26 | @iOSFindBy(xpath = "//XCUIElementTypeApplication/XCUIElementTypeWindow[1]/XCUIElementTypeOther/XCUIElementTypeStaticText")
27 | private var statusTextView: MobileElement? = null
28 |
29 | fun loginWith(username: String, password: String): MainPage {
30 | userTextField?.setValue(username)
31 | passwordTextField?.setValue(password)
32 | driver.hideKeyboard()
33 | loginButton?.click()
34 | return this
35 | }
36 |
37 | fun isLoginSuccess(): Boolean {
38 | return statusTextView?.text == "Login Successfully"
39 | }
40 | }
41 |
--------------------------------------------------------------------------------
/.idea/misc.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Using Appium with Kotlin
2 | ========================
3 |
4 | This project is the example of how to setup Appium with Kotlin to test your app in both iOS and Android.
5 |
6 | ## Running the test
7 |
8 | ### Install Appium Server
9 | Install Appium server using node.js
10 | ```
11 | npm install -g appium
12 | ```
13 | or download the Application from https://bitbucket.org/appium/appium.app/downloads/
14 |
15 | then start the server.
16 |
17 | ### Android setup
18 | Appium will use the first device that connected to ADB so please check `adb devices` and make sure that at lease one device is connected.
19 |
20 | For more information https://github.com/appium/appium/blob/master/docs/en/drivers/android-uiautomator2.md
21 |
22 | ### iOS setup
23 | If you see some permission error, you might need to use `authorize-ios` before running the test in simulator.
24 |
25 | ```
26 | npm install -g authorize-ios
27 | sudo authorize-ios
28 | ```
29 |
30 | Appium will use device name in the capabilites to find simulator.
31 | Use the following command to find all available names.
32 | ```
33 | xcrun simctl list devices
34 | ```
35 |
36 | For more information https://github.com/appium/appium/blob/master/docs/en/drivers/ios-xcuitest.md
37 |
38 | ### Run the test
39 | Start appium server then use the test task like normal gradle project. You also can specify the platform you want to test (`ANDROID` or `IOS`)
40 | ```
41 | ./gradlew test -Pplatform=ANDROID
42 | ```
43 |
44 | ## Writing the test
45 |
46 | ### Finding the element ID
47 | If you are using Appium desktop app, it comes with the inspector tool that you can use to find element reference such as XPath or ID.
48 |
49 | Android has the tool that you can use to find element informations as well.
50 | ```
51 | {ANDROID_SDK}/tools/uiautomatorviewer
52 | ```
53 |
54 | ### PageObject Pattern
55 | Page Object is a Design Pattern which has become popular in test automation for enhancing test maintenance and reducing code duplication. I recommend you to read and understand how to design the test before start writing.
56 |
57 | - https://martinfowler.com/bliki/PageObject.html
58 | - https://github.com/SeleniumHQ/selenium/wiki/PageObjects
--------------------------------------------------------------------------------
/app/src/test/kotlin/com/zoonref/appium/util/AppiumTest.kt:
--------------------------------------------------------------------------------
1 | package com.zoonref.appium.util
2 |
3 | import org.junit.After
4 | import org.junit.Before
5 | import org.openqa.selenium.remote.DesiredCapabilities
6 | import io.appium.java_client.android.AndroidDriver
7 | import java.net.URL
8 | import java.nio.file.Paths
9 | import io.appium.java_client.AppiumDriver
10 | import io.appium.java_client.MobileElement
11 | import io.appium.java_client.ios.IOSDriver
12 | import io.appium.java_client.remote.MobileCapabilityType
13 | import java.util.concurrent.TimeUnit
14 |
15 |
16 | /**
17 | * Created by zoonooz on 2017/11/17.
18 | * Base test class for Appium
19 | */
20 | open class AppiumTest {
21 |
22 | var os: OS = OS.ANDROID
23 | var driver: AppiumDriver? = null
24 |
25 | @Before
26 | fun setup() {
27 | os = OS.valueOf(System.getProperty("platform", OS.ANDROID.name))
28 | val capabilities = DesiredCapabilities()
29 | val userDir = System.getProperty("user.dir")
30 | val serverAddress = URL("http://127.0.0.1:4723/wd/hub")
31 |
32 | if (os == OS.ANDROID) {
33 | capabilities.setCapability(MobileCapabilityType.APPIUM_VERSION, "1.7.1")
34 | capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, "Android")
35 | capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "Android")
36 |
37 | val localApp = "android.apk"
38 | val appPath = Paths.get(userDir, localApp).toAbsolutePath().toString()
39 | capabilities.setCapability(MobileCapabilityType.APP, appPath)
40 |
41 | driver = AndroidDriver(serverAddress, capabilities)
42 | } else {
43 | capabilities.setCapability(MobileCapabilityType.APPIUM_VERSION, "1.7.1")
44 | capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, "iOS")
45 | capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "iPhone SE")
46 | capabilities.setCapability(MobileCapabilityType.AUTOMATION_NAME, "XCUITest")
47 |
48 | val localApp = "ios.app"
49 | val appPath = Paths.get(userDir, localApp).toAbsolutePath().toString()
50 | capabilities.setCapability("app", appPath)
51 |
52 | driver = IOSDriver(serverAddress, capabilities)
53 | }
54 |
55 | driver?.let {
56 | it.manage()?.timeouts()?.implicitlyWait(30, TimeUnit.SECONDS)
57 | }
58 | }
59 |
60 | @After
61 | fun tearDown() {
62 | driver?.quit()
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
12 | set DEFAULT_JVM_OPTS=
13 |
14 | set DIRNAME=%~dp0
15 | if "%DIRNAME%" == "" set DIRNAME=.
16 | set APP_BASE_NAME=%~n0
17 | set APP_HOME=%DIRNAME%
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windowz variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 | if "%@eval[2+2]" == "4" goto 4NT_args
53 |
54 | :win9xME_args
55 | @rem Slurp the command line arguments.
56 | set CMD_LINE_ARGS=
57 | set _SKIP=2
58 |
59 | :win9xME_args_slurp
60 | if "x%~1" == "x" goto execute
61 |
62 | set CMD_LINE_ARGS=%*
63 | goto execute
64 |
65 | :4NT_args
66 | @rem Get arguments from the 4NT Shell from JP Software
67 | set CMD_LINE_ARGS=%$
68 |
69 | :execute
70 | @rem Setup the command line
71 |
72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
73 |
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
76 |
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if "%ERRORLEVEL%"=="0" goto mainEnd
80 |
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
85 | exit /b 1
86 |
87 | :mainEnd
88 | if "%OS%"=="Windows_NT" endlocal
89 |
90 | :omega
91 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
10 | DEFAULT_JVM_OPTS=""
11 |
12 | APP_NAME="Gradle"
13 | APP_BASE_NAME=`basename "$0"`
14 |
15 | # Use the maximum available, or set MAX_FD != -1 to use that value.
16 | MAX_FD="maximum"
17 |
18 | warn ( ) {
19 | echo "$*"
20 | }
21 |
22 | die ( ) {
23 | echo
24 | echo "$*"
25 | echo
26 | exit 1
27 | }
28 |
29 | # OS specific support (must be 'true' or 'false').
30 | cygwin=false
31 | msys=false
32 | darwin=false
33 | case "`uname`" in
34 | CYGWIN* )
35 | cygwin=true
36 | ;;
37 | Darwin* )
38 | darwin=true
39 | ;;
40 | MINGW* )
41 | msys=true
42 | ;;
43 | esac
44 |
45 | # Attempt to set APP_HOME
46 | # Resolve links: $0 may be a link
47 | PRG="$0"
48 | # Need this for relative symlinks.
49 | while [ -h "$PRG" ] ; do
50 | ls=`ls -ld "$PRG"`
51 | link=`expr "$ls" : '.*-> \(.*\)$'`
52 | if expr "$link" : '/.*' > /dev/null; then
53 | PRG="$link"
54 | else
55 | PRG=`dirname "$PRG"`"/$link"
56 | fi
57 | done
58 | SAVED="`pwd`"
59 | cd "`dirname \"$PRG\"`/" >/dev/null
60 | APP_HOME="`pwd -P`"
61 | cd "$SAVED" >/dev/null
62 |
63 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
64 |
65 | # Determine the Java command to use to start the JVM.
66 | if [ -n "$JAVA_HOME" ] ; then
67 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
68 | # IBM's JDK on AIX uses strange locations for the executables
69 | JAVACMD="$JAVA_HOME/jre/sh/java"
70 | else
71 | JAVACMD="$JAVA_HOME/bin/java"
72 | fi
73 | if [ ! -x "$JAVACMD" ] ; then
74 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
75 |
76 | Please set the JAVA_HOME variable in your environment to match the
77 | location of your Java installation."
78 | fi
79 | else
80 | JAVACMD="java"
81 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
82 |
83 | Please set the JAVA_HOME variable in your environment to match the
84 | location of your Java installation."
85 | fi
86 |
87 | # Increase the maximum file descriptors if we can.
88 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
89 | MAX_FD_LIMIT=`ulimit -H -n`
90 | if [ $? -eq 0 ] ; then
91 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
92 | MAX_FD="$MAX_FD_LIMIT"
93 | fi
94 | ulimit -n $MAX_FD
95 | if [ $? -ne 0 ] ; then
96 | warn "Could not set maximum file descriptor limit: $MAX_FD"
97 | fi
98 | else
99 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
100 | fi
101 | fi
102 |
103 | # For Darwin, add options to specify how the application appears in the dock
104 | if $darwin; then
105 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
106 | fi
107 |
108 | # For Cygwin, switch paths to Windows format before running java
109 | if $cygwin ; then
110 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
111 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
112 | JAVACMD=`cygpath --unix "$JAVACMD"`
113 |
114 | # We build the pattern for arguments to be converted via cygpath
115 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
116 | SEP=""
117 | for dir in $ROOTDIRSRAW ; do
118 | ROOTDIRS="$ROOTDIRS$SEP$dir"
119 | SEP="|"
120 | done
121 | OURCYGPATTERN="(^($ROOTDIRS))"
122 | # Add a user-defined pattern to the cygpath arguments
123 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
124 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
125 | fi
126 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
127 | i=0
128 | for arg in "$@" ; do
129 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
130 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
131 |
132 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
133 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
134 | else
135 | eval `echo args$i`="\"$arg\""
136 | fi
137 | i=$((i+1))
138 | done
139 | case $i in
140 | (0) set -- ;;
141 | (1) set -- "$args0" ;;
142 | (2) set -- "$args0" "$args1" ;;
143 | (3) set -- "$args0" "$args1" "$args2" ;;
144 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
145 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
146 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
147 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
148 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
149 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
150 | esac
151 | fi
152 |
153 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
154 | function splitJvmOpts() {
155 | JVM_OPTS=("$@")
156 | }
157 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
158 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
159 |
160 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
161 |
--------------------------------------------------------------------------------