forked from appium/appium.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path04_java_appium_native_android_automation.html
1505 lines (1178 loc) · 78 KB
/
04_java_appium_native_android_automation.html
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
---
<!DOCTYPE html>
<html>
<head>
{% capture extra %}
<link href="../css/template.css" media="all" rel="stylesheet" type="text/css" />
<link href="../css/font-awesome-4.0.3/css/font-awesome.css" media="all" rel="stylesheet" type="text/css" />
<link href="../css/custom.css" media="all" rel="stylesheet" type="text/css" />{% endcapture %}
{% include head.html extra=extra %}
<link href="../css/template.css" media="all" rel="stylesheet" type="text/css" />
<link href="../css/font-awesome-4.0.3/css/font-awesome.css" media="all" rel="stylesheet" type="text/css" />
<link href="../css/custom.css" media="all" rel="stylesheet" type="text/css" />
</head>
<body>
{% include navbar.html %}
<div class="markdown-body">
<p><div class="toc"><div class="toc-title">Table of Contents</div><ul><ul><li><a href="#Module-4---Java-Appium-Native-Android-Automation">Module 4 - Java Appium Native Android Automation</a></li></ul></ul><ul><ul><ul><li><a href="#Chapter-1---Getting-started-with-appium">Chapter 1 - Getting started with appium</a></li></ul></ul></ul><ul><ul><ul><ul><li><a href="#Introduction">Introduction</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Install">Install</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Bash-Profile">Bash Profile</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Troubleshooting">Troubleshooting</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#SSL-Issues">SSL Issues</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Maven-on-OS-X-10.9">Maven on OS X 10.9</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Corrupt-ruby-gems">Corrupt ruby gems</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Java-IDE">Java IDE</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Install-Android">Install Android</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#2-Bash-Profile">Bash Profile</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#HAXM-on-OS-X-10.9">HAXM on OS X 10.9</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Helpful-Links">Helpful Links</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Summary">Summary</a></li></ul></ul></ul></ul><ul><ul><ul><li><a href="#Chapter-2---Appium-Ruby-Console">Chapter 2 - Appium Ruby Console</a></li></ul></ul></ul><ul><ul><ul><ul><li><a href="#2-Introduction">Introduction</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Compiling-the-Android-sample-app">Compiling the Android sample app</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Origin-of-Api-Demos">Origin of Api Demos</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Prebuilt-Android-Sample-App">Prebuilt Android Sample App</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Starting-the-console">Starting the console</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Page-Command">Page Command</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Ending-the-session">Ending the session</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Appium.app-Inspector">Appium.app Inspector</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#uiautomatorviewer">uiautomatorviewer</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#2-Helpful-Links">Helpful Links</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#2-Summary">Summary</a></li></ul></ul></ul></ul><ul><ul><ul><li><a href="#Chapter-3---Writing-your-first-test">Chapter 3 - Writing your first test</a></li></ul></ul></ul><ul><ul><ul><ul><li><a href="#3-Introduction">Introduction</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Automating-a-simple-action">Automating a simple action</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Page-Object-Pattern">Page Object Pattern</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Running-the-test-with-Maven">Running the test with Maven</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#3-Helpful-Links">Helpful Links</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#3-Summary">Summary</a></li></ul></ul></ul></ul><ul><ul><ul><li><a href="#Chapter-4---Running-tests">Chapter 4 - Running tests</a></li></ul></ul></ul><ul><ul><ul><ul><li><a href="#4-Introduction">Introduction</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Running-locally">Running locally</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Running-using-Jenkins-CI">Running using Jenkins CI</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Running-on-Sauce">Running on Sauce</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#4-Helpful-Links">Helpful Links</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#4-Summary">Summary</a></li></ul></ul></ul></ul><ul><ul><ul><li><a href="#Chapter-5---Conclusion">Chapter 5 - Conclusion</a></li></ul></ul></ul><ul><ul><ul><ul><li><a href="#5-Introduction">Introduction</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Additional-Resources">Additional Resources</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Community-Support">Community Support</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Professional-Support">Professional Support</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#Searching-the-Source-Code">Searching the Source Code</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#5-Helpful-Links">Helpful Links</a></li></ul></ul></ul></ul><ul><ul><ul><ul><li><a href="#5-Summary">Summary</a></li></ul></ul></ul></ul></div></p>
<h2><a class="anchor" id="Module-4---Java-Appium-Native-Android-Automation" href="#Module-4---Java-Appium-Native-Android-Automation"><i class="fa fa-link"></i></a>Module 4 - Java Appium Native Android Automation</h2>
<h3><a class="anchor" id="Chapter-1---Getting-started-with-appium" href="#Chapter-1---Getting-started-with-appium"><i class="fa fa-link"></i></a>Chapter 1 - Getting started with appium</h3>
<h4><a class="anchor" id="Introduction" href="#Introduction"><i class="fa fa-link"></i></a>Introduction</h4>
<p>Appium enables iOS and Android automation using Selenium WebDriver.
The same WebDriver bindings can be used across web and mobile.</p>
<ul><li>Open Source
<ul><li>Apache 2.0 License</li>
</ul></li>
<li>Cross Platform
<ul><li>Test Android on OS X, Windows, Linux</li>
<li>Test iOS on OS X</li>
</ul></li>
<li>Native, Hybrid, Mobile Web</li>
<li>Any language. Any framework.</li>
<li>No app changes or source code access required.</li>
</ul><p>In this chapter, we'll be preparing to automate a native Android application
using appium with Java.</p>
<hr /><h4><a class="anchor" id="Install" href="#Install"><i class="fa fa-link"></i></a>Install</h4>
<p>This document is written for OS X 10.9.2 or better.</p>
<table><thead><tr><th align="right">Tool</th>
<th align="left">Description</th>
</tr></thead><tbody><tr><td align="right">OS X</td>
<td align="left">The mac operating system</td>
</tr><tr><td align="right">Xcode</td>
<td align="left">Apple's integrated development environment</td>
</tr><tr><td align="right">rvm</td>
<td align="left">The ruby version manager. Helps install ruby</td>
</tr><tr><td align="right">gem</td>
<td align="left">The rubygems command. A package manager for Ruby</td>
</tr><tr><td align="right">Java</td>
<td align="left">A programming language and software development kit</td>
</tr><tr><td align="right">bundler</td>
<td align="left">Enables managing gem dependencies</td>
</tr><tr><td align="right">brew</td>
<td align="left">Helps install software on Macs</td>
</tr><tr><td align="right">npm</td>
<td align="left">Node's package manager</td>
</tr><tr><td align="right">grunt</td>
<td align="left">A command line task runner for node.js</td>
</tr><tr><td align="right">ant</td>
<td align="left">A java build system</td>
</tr><tr><td align="right">maven</td>
<td align="left">A java build system with improved dependency management</td>
</tr></tbody></table><p>Note that <a href="http://appium.io/">Appium.app</a> provides a ready to run version of
appium. If you're using Appium.app then there's no need to run from source unless
you want to use the latest and greatest.</p>
<p>Install <a href="https://developer.apple.com/downloads/index.action">Xcode 5.1 from the App Store</a>.</p>
<p>Install the command line build tools within Xcode. (Xcode -> Preferences -> Downloads).
Alternatively, download them directly from <a href="https://developer.apple.com/downloads/index.action">Apple</a>.</p>
<ul><li>Install <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">Java 7</a>.</li>
<li>Install the latest stable release of Ruby.</li>
</ul><pre>$ \curl -sSL https://get.rvm.io | bash -s stable
$ rvm install ruby</pre>
<ul><li>Make sure RVM is using the correct Ruby by default</li>
</ul><pre>$ rvm list
$ rvm --default use 2.1.1</pre>
<ul><li>If you have an old ruby/rvm, you can upgrade with</li>
</ul><pre>$ rvm get head
$ rvm autolibs homebrew
$ rvm install ruby</pre>
<ul><li>Check that it's installed properly by printing the ruby version.</li>
</ul><p><code>$ ruby --version</code></p>
<ul><li>Update RubyGems and Bundler.</li>
</ul><pre>gem update --system ;\
gem install --no-rdoc --no-ri bundler ;\
gem update ;\
gem cleanup</pre>
<ul><li>Check that RubyGems is >= 2.1.5</li>
</ul><pre>$ gem --version
2.2.2</pre>
<ul><li>Install <code>appium_console</code> gem.</li>
</ul><pre>gem uninstall -aIx appium_lib ;\
gem uninstall -aIx appium_console ;\
gem install --no-rdoc --no-ri appium_console</pre>
<ul><li>Install <a href="https://github.com/appium/flaky">flaky</a> gem.</li>
</ul><pre>gem uninstall -aIx flaky ;\
gem install --no-rdoc --no-ri flaky</pre>
<ul><li>Install <a href="http://mxcl.github.io/homebrew/">brew</a></li>
</ul><p><code>ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"</code></p>
<ul><li>Install <a href="http://nodejs.org/">nodejs</a> using brew.</li>
</ul><pre>brew update ;\
brew upgrade node ;\
brew install node</pre>
<ul><li>Node should be <code>v0.10.26</code> or better.
Don't use the big green install button on <a href="http://nodejs.org/">nodejs.org</a> or
all npm commands will require sudo.</li>
</ul><p><code>$ node --version</code></p>
<p><code>$ npm --version</code></p>
<ul><li>Install grunt.</li>
</ul><p><code>npm install -g grunt grunt-cli</code></p>
<ul><li>Run the version command from the appium folder. If you're not in that
folder, the grunt version will not display.</li>
</ul><pre>$ grunt --version
grunt-cli v0.1.13
grunt v0.4.2</pre>
<ul><li>Install <a href="http://ant.apache.org/">ant</a> if it's not already installed.</li>
<li>Install <a href="http://maven.apache.org/download.cgi">maven 3.1.1 or better</a> if
it's not already installed. Old maven will not work.</li>
</ul><pre>$ ant -version
Apache Ant(TM) version 1.8.2 compiled on June 20 2012
$ mvn -version
Apache Maven 3.1.1 (0728685237757ffbf44136acec0402957f723d9a; 2013-09-17 11:22:22-0400)</pre>
<ul><li>Clone appium</li>
</ul><p><code>$ git clone git://github.com/appium/appium.git</code></p>
<ul><li>Run reset.sh. When running reset.sh, make sure to be on Xcode 5.0.2 for
best results. You may have problems if you reset on Xcode 4.6.3 and then
switch to a newer Xcode.</li>
</ul><p><code>$ cd appium; ./reset.sh</code></p>
<p>If you see config errors, try cleaning git. <code>git clean -dfx; git reset --hard</code></p>
<p>You can also reset by platform. <code>./reset.sh --ios</code></p>
<ul><li>Authorize for testing. Must run reset.sh as mentioned above before
running the grunt task. If you're only testing Android, this can be skipped.</li>
</ul><blockquote>
<p>sudo `which grunt` authorize</p>
</blockquote>
<ul><li>Start appium.</li>
</ul><p><code>$ node .</code></p>
<h4><a class="anchor" id="Bash-Profile" href="#Bash-Profile"><i class="fa fa-link"></i></a>Bash Profile</h4>
<ul><li>You may have to add grunt as well <code>/usr/local/share/npm/bin/grunt</code></li>
</ul><pre>$ nano ~/.bash_profile
PATH=$PATH:/Applications/apache-ant-1.8.4/bin
PATH=$PATH:/usr/local/share/npm/bin/
export JAVA_HOME="`/System/Library/Frameworks/JavaVM.framework/Versions/Current/Commands/java_home`"
export PATH</pre>
<h4><a class="anchor" id="Troubleshooting" href="#Troubleshooting"><i class="fa fa-link"></i></a>Troubleshooting</h4>
<ul><li>If install fails, keep trying to install a few times.</li>
</ul><p>When using <code>Appium.app</code> make sure to set Appium -> Preferences... -> Check
"Use External Appium Package" and set it to the path of Appium cloned from GitHub.</p>
<p>Fix permission errors. npm shouldn't require sudo.</p>
<pre>$ brew uninstall node
$ brew install node
$ rm -rf ./node_modules
$ rm -rf "/Users/`whoami`/.npm"
$ rm -rf /usr/local/lib/node_modules/
$ ./reset.sh --ios
$ ./reset.sh --android</pre>
<ul><li><a href="https://gist.github.com/bootstraponline/5580587">Helper bash methods</a></li>
</ul><h4><a class="anchor" id="SSL-Issues" href="#SSL-Issues"><i class="fa fa-link"></i></a>SSL Issues</h4>
<blockquote>
<p>Unable to download data from <a href="https://rubygems.org/">https://rubygems.org/</a> - SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed</p>
</blockquote>
<ul><li><a href="http://railsapps.github.io/openssl-certificate-verify-failed.html">Fix SSL issues</a> with:</li>
</ul><pre>$ rvm osx-ssl-certs update all
$ rvm osx-ssl-certs status all</pre>
<h4><a class="anchor" id="Maven-on-OS-X-10.9" href="#Maven-on-OS-X-10.9"><i class="fa fa-link"></i></a>Maven on OS X 10.9</h4>
<pre>$ brew update
$ brew install maven</pre>
<h4><a class="anchor" id="Corrupt-ruby-gems" href="#Corrupt-ruby-gems"><i class="fa fa-link"></i></a>Corrupt ruby gems</h4>
<p>If you see:</p>
<blockquote>
<p>invalid gem: package is corrupt, exception while verifying: undefined method</p>
</blockquote>
<p>Then run <code>$ rm -rf ~/.rvm</code> and reinstall RVM.</p>
<h4><a class="anchor" id="Java-IDE" href="#Java-IDE"><i class="fa fa-link"></i></a>Java IDE</h4>
<p>Java has a number of popular editors. For this module,
we'll be using <code>IntelliJ IDEA Community Edition</code>, an open source IDE by
JetBrains. The software is available <a href="http://www.jetbrains.com/idea/download/">for free download at this link</a>.</p>
<p>If you already have a preferred editor, feel free to continue using it.</p>
<hr /><h4><a class="anchor" id="Install-Android" href="#Install-Android"><i class="fa fa-link"></i></a>Install Android</h4>
<p>The following instructions are specific to installing Android on OS X.</p>
<h4><a class="anchor" id="2-Bash-Profile" href="#2-Bash-Profile"><i class="fa fa-link"></i></a>Bash Profile</h4>
<ul><li>Add the Android SDK tools folder to your path so you can run <code>android</code>.</li>
<li>Define the <code>ANDROID_HOME</code> env var pointing to SDK root. On OS X place it in
<code>~/.bash_profile</code></li>
<li>You may have to add grunt as well <code>/usr/local/share/npm/bin/grunt</code></li>
</ul><pre># ~/.bash_profile
export ANDROID_HOME=$HOME/Downloads/android-sdk-macosx
export ANDROID_SDK=$ANDROID_HOME
PATH=$PATH:/Applications/apache-ant-1.8.4/bin
PATH=$PATH:/usr/local/share/npm/bin/
PATH=$PATH:$ANDROID_HOME/build-tools
PATH=$PATH:$ANDROID_HOME/platform-tools
PATH=$PATH:$ANDROID_HOME/tools
export JAVA_HOME="`/System/Library/Frameworks/JavaVM.framework/Versions/Current/Commands/java_home`"
export PATH</pre>
<ul><li>Run <code>android</code> to open the SDK manager.</li>
<li>Install the following packages:</li>
</ul><p><img src="android_sdk_manager.png" alt="" /></p>
<ul><li>Create a new Android virtual device.
Ensure <code>Use Host GPU</code> is checked.
Set <code>VM Heap</code> to <code>64</code>. <code>32</code> is too small.</li>
</ul><p><img src="avd_settings.png" alt="" /></p>
<p><code>android avd</code></p>
<ul><li><p>Launch the emulator with <code>emulator @tutorial</code></p></li>
<li><p>Check that <code>hax is working</code> If it's not, install hax
<a href="http://software.intel.com/en-us/articles/intel-hardware-accelerated-execution-manager">directly from Intel</a></p></li>
</ul><pre>$ emulator @tutorial
HAX is working and emulator runs in fast virt mode</pre>
<ul><li>After launching the emulator, check that it's listed in adb devices. Run
the following commands a few times until it's listed.</li>
</ul><p><code>adb kill-server; adb devices</code></p>
<p>If you see <code>error: protocol fault (no status)</code> just keep running the command
until the emulator is detected.</p>
<ul><li><p>With both the Android emulator running and the Appium server started,
it's time to launch the appium console. Make sure the ENV vars are exported.</p></li>
<li><p>Start appium console</p></li>
</ul><p><code>arc</code></p>
<ul><li>See <a href="https://github.com/appium/appium/blob/master/docs/running-on-osx.md">running on OS X</a></li>
</ul><h4><a class="anchor" id="HAXM-on-OS-X-10.9" href="#HAXM-on-OS-X-10.9"><i class="fa fa-link"></i></a>HAXM on OS X 10.9</h4>
<p>Install the <a href="http://software.intel.com/en-us/articles/intel-hardware-accelerated-execution-manager-end-user-license-agreement-macos-hotfix">HAXM 10.9 hotfix</a>.</p>
<hr /><h4><a class="anchor" id="Helpful-Links" href="#Helpful-Links"><i class="fa fa-link"></i></a>Helpful Links</h4>
<table><thead><tr><th align="right">Link</th>
<th align="left">Summary</th>
</tr></thead><tbody><tr><td align="right"><a href="https://www.npmjs.org/">npm</a></td>
<td align="left">The main registry for npm packages. Appium is published here.</td>
</tr><tr><td align="right"><a href="http://rubygems.org/">rubygems</a></td>
<td align="left">The main registry for Ruby gems. The appium ruby bindings are published here.</td>
</tr><tr><td align="right"><a href="http://rvm.io/">RVM</a></td>
<td align="left">RVM's homepage. Extensive documentation is available.</td>
</tr><tr><td align="right"><a href="https://www.ruby-lang.org/en/">Ruby</a></td>
<td align="left">The Ruby language homepage. Useful for keeping up to date with Ruby releases.</td>
</tr></tbody></table><hr /><h4><a class="anchor" id="Summary" href="#Summary"><i class="fa fa-link"></i></a>Summary</h4>
<p>We learned about the appium project and how it's useful for automating mobile
applications. Then we installed all the necessary software to begin
automation. Finally, helpful links were reviewed.</p>
<p>In the next chapter, we'll look at writing tests interactively using a console.</p>
<hr /><h3><a class="anchor" id="Chapter-2---Appium-Ruby-Console" href="#Chapter-2---Appium-Ruby-Console"><i class="fa fa-link"></i></a>Chapter 2 - Appium Ruby Console</h3>
<h4><a class="anchor" id="2-Introduction" href="#2-Introduction"><i class="fa fa-link"></i></a>Introduction</h4>
<p>A read-eval-print loop, REPL, is a great way to learn a new technology.
In this chapter, we'll be using the Appium Ruby Console (ARC) to write tests.</p>
<p>An open source mobile app will be used to demonstrate the standard test workflow.
We'll also look at a desktop app that makes writing tests a bit easier.</p>
<hr /><h4><a class="anchor" id="Compiling-the-Android-sample-app" href="#Compiling-the-Android-sample-app"><i class="fa fa-link"></i></a>Compiling the Android sample app</h4>
<p><code>cd</code> into the appium repository root. Running <code>./reset.sh --android --dev</code> will
build the sample AndroidApp app ApiDemos.</p>
<blockquote>
<ul><li>Configuring and cleaning/building Android test app: ApiDemos</li>
</ul></blockquote>
<p>After seeing <code>---- reset.sh completed successfully ----</code>,
you'll find appium's custom api demos at this location:</p>
<blockquote>
<p>/appium/sample-code/apps/ApiDemos/bin/ApiDemos-debug.apk</p>
</blockquote>
<p>Appium uses a modified ApiDemo app so make sure to use this version instead of
what's provided in the SDK. The Appium fork of API Demos is <a href="https://github.com/appium/android-apidemos">on GitHub</a>.</p>
<h4><a class="anchor" id="Origin-of-Api-Demos" href="#Origin-of-Api-Demos"><i class="fa fa-link"></i></a>Origin of Api Demos</h4>
<p>The ApiDemos app is <a href="http://developer.android.com/sdk/exploring.html">provided by Google</a>
in the Android SDK. Running the <code>$ android</code> command will allow you to download
<code>Samples for SDK</code> for each platform version. Once downloaded,
you can find the app at <code>$ANDROID_HOME/platforms/android-VERSION/samples/</code></p>
<hr /><h4><a class="anchor" id="Prebuilt-Android-Sample-App" href="#Prebuilt-Android-Sample-App"><i class="fa fa-link"></i></a>Prebuilt Android Sample App</h4>
<p>I have a compiled version of the Api Demos apk on GitHub.</p>
<blockquote>
<p><a href="https://github.com/appium/ruby_lib/raw/master/ruby_lib_android/api.apk">https://github.com/appium/ruby_lib/raw/master/ruby_lib_android/api.apk</a></p>
</blockquote>
<p>Downloading from the above link will be faster than building from source.</p>
<hr /><h4><a class="anchor" id="Starting-the-console" href="#Starting-the-console"><i class="fa fa-link"></i></a>Starting the console</h4>
<p>Appium Ruby Console needs a platform and app path to get started.</p>
<p>If you see the following warning, it's safe to ignore. <code>libdvm.so</code> is part of
the android platform and not something we control.</p>
<blockquote>
<p>WARNING: linker: libdvm.so has text relocations. This is wasting memory and
is a security risk. Please fix.</p>
</blockquote>
<p>We're developing locally, so create an appium.txt with the following:</p>
<pre>$ nano appium.txt
DEVICE="android"
APP_PATH="./api.apk"</pre>
<p>The appium.txt contains two important pieces of information.</p>
<p>DEVICE is the platform we're automating. In this case, we're using android.</p>
<p>APP_PATH is the path to api.apk. The ruby console is able to parse relative
paths. This path will then be converted to an absolute path which appium uses
to identify which app to install on the emulator.</p>
<p>In a new terminal tab, start the appium server using <code>node .</code> In a second
tab, launch the emulator using <code>emulator @tutorial</code>. In the final tab,
run the <code>arc</code> command from within the directory containing appium.txt.
The arc console will read appium.txt, connect the Android emulator,
and allow you to enter commands.</p>
<p>To assist with opening three tabs, I have a bash script on <a href="https://gist.github.com/bootstraponline/5580587">GitHub</a>
that starts appium, the emulator, and changes the working directory.</p>
<hr /><h4><a class="anchor" id="Page-Command" href="#Page-Command"><i class="fa fa-link"></i></a>Page Command</h4>
<p>With the console started, the next step is to begin automation.
The <code>page</code> command prints a list of elements that are of interest.</p>
<pre>> page
post /execute
{
:script => "mobile: getStrings"
}
get /source
View
class: android.view.View
resource_id: android:id/action_bar_overlay_layout
FrameLayout
class: android.widget.FrameLayout
resource_id: android:id/action_bar_container
View
class: android.view.View
resource_id: android:id/action_bar
ImageView
class: android.widget.ImageView
resource_id: android:id/home
TextView
class: android.widget.TextView
text: API Demos
resource_id: android:id/action_bar_title
id: activity_sample_code
FrameLayout
class: android.widget.FrameLayout
resource_id: android:id/content
ListView
class: android.widget.ListView
resource_id: android:id/list
TextView
class: android.widget.TextView
text, name: Accessibility
resource_id: android:id/text1
TextView
class: android.widget.TextView
text, name: Animation
resource_id: android:id/text1
TextView
class: android.widget.TextView
text, name: App
resource_id: android:id/text1
TextView
class: android.widget.TextView
text, name: Content
resource_id: android:id/text1
TextView
class: android.widget.TextView
text, name: Graphics
resource_id: android:id/text1
TextView
class: android.widget.TextView
text, name: Media
resource_id: android:id/text1
TextView
class: android.widget.TextView
text, name: NFC
resource_id: android:id/text1
TextView
class: android.widget.TextView
text, name: OS
resource_id: android:id/text1
TextView
class: android.widget.TextView
text, name: Preference
resource_id: android:id/text1
TextView
class: android.widget.TextView
text, name: Text
resource_id: android:id/text1
id: autocomplete_3_button_7
TextView
class: android.widget.TextView
text, name: Views
resource_id: android:id/text1</pre>
<p>Let's review in detail what this output means.</p>
<p><code>[1] pry(main)> page</code> The 1 tells us this is the first command we've entered
during this pry session. The terminal will show <code>[2] pry(main)></code> which means
it's ready for the second command. Pry is an open source
<a href="http://pryrepl.org/">runtime development console</a> that's used by appium
ruby console.</p>
<p>The next set of information is the network traffic.</p>
<pre>post /execute
{
:script => "mobile: getStrings"
}
get /source</pre>
<p>In response to the page command, two network requests were sent. The
<a href="http://rubygems.org/gems/selenium-webdriver">selenium-webdriver gem</a> is used
to generate these requests.</p>
<p>After that is the result of the page command.</p>
<pre>TextView
class: android.widget.TextView
text: API Demos
resource_id: android:id/action_bar_title
id: activity_sample_code</pre>
<p><code>TextView</code> is the <a href="http://developer.android.com/reference/android/widget/TextView.html">android specific class name</a>
for the element. Appium provides a set of shortcut names.</p>
<table><thead><tr><th align="right">Shortcut</th>
<th align="left">Android Name</th>
</tr></thead><tbody><tr><td align="right">abslist</td>
<td align="left">AbsListView</td>
</tr><tr><td align="right">absseek</td>
<td align="left">AbsSeekBar</td>
</tr><tr><td align="right">absspinner</td>
<td align="left">AbsSpinner</td>
</tr><tr><td align="right">absolute</td>
<td align="left">AbsoluteLayout</td>
</tr><tr><td align="right">adapterview</td>
<td align="left">AdapterView</td>
</tr><tr><td align="right">adapterviewanimator</td>
<td align="left">AdapterViewAnimator</td>
</tr><tr><td align="right">adapterviewflipper</td>
<td align="left">AdapterViewFlipper</td>
</tr><tr><td align="right">analogclock</td>
<td align="left">AnalogClock</td>
</tr><tr><td align="right">appwidgethost</td>
<td align="left">AppWidgetHostView</td>
</tr><tr><td align="right">autocomplete</td>
<td align="left">AutoCompleteTextView</td>
</tr><tr><td align="right">button</td>
<td align="left">Button</td>
</tr><tr><td align="right">breadcrumbs</td>
<td align="left">FragmentBreadCrumbs</td>
</tr><tr><td align="right">calendar</td>
<td align="left">CalendarView</td>
</tr><tr><td align="right">checkbox</td>
<td align="left">CheckBox</td>
</tr><tr><td align="right">checked</td>
<td align="left">CheckedTextView</td>
</tr><tr><td align="right">chronometer</td>
<td align="left">Chronometer</td>
</tr><tr><td align="right">compound</td>
<td align="left">CompoundButton</td>
</tr><tr><td align="right">datepicker</td>
<td align="left">DatePicker</td>
</tr><tr><td align="right">dialerfilter</td>
<td align="left">DialerFilter</td>
</tr><tr><td align="right">digitalclock</td>
<td align="left">DigitalClock</td>
</tr><tr><td align="right">drawer</td>
<td align="left">SlidingDrawer</td>
</tr><tr><td align="right">expandable</td>
<td align="left">ExpandableListView</td>
</tr><tr><td align="right">extract</td>
<td align="left">ExtractEditText</td>
</tr><tr><td align="right">fragmenttabhost</td>
<td align="left">FragmentTabHost</td>
</tr><tr><td align="right">frame</td>
<td align="left">FrameLayout</td>
</tr><tr><td align="right">gallery</td>
<td align="left">Gallery</td>
</tr><tr><td align="right">gesture</td>
<td align="left">GestureOverlayView</td>
</tr><tr><td align="right">glsurface</td>
<td align="left">GLSurfaceView</td>
</tr><tr><td align="right">grid</td>
<td align="left">GridView</td>
</tr><tr><td align="right">gridlayout</td>
<td align="left">GridLayout</td>
</tr><tr><td align="right">horizontal</td>
<td align="left">HorizontalScrollView</td>
</tr><tr><td align="right">image</td>
<td align="left">ImageView</td>
</tr><tr><td align="right">imagebutton</td>
<td align="left">ImageButton</td>
</tr><tr><td align="right">imageswitcher</td>
<td align="left">ImageSwitcher</td>
</tr><tr><td align="right">keyboard</td>
<td align="left">KeyboardView</td>
</tr><tr><td align="right">linear</td>
<td align="left">LinearLayout</td>
</tr><tr><td align="right">list</td>
<td align="left">ListView</td>
</tr><tr><td align="right">media</td>
<td align="left">MediaController</td>
</tr><tr><td align="right">mediaroutebutton</td>
<td align="left">MediaRouteButton</td>
</tr><tr><td align="right">multiautocomplete</td>
<td align="left">MultiAutoCompleteTextView</td>
</tr><tr><td align="right">numberpicker</td>
<td align="left">NumberPicker</td>
</tr><tr><td align="right">pagetabstrip</td>
<td align="left">PageTabStrip</td>
</tr><tr><td align="right">pagetitlestrip</td>
<td align="left">PageTitleStrip</td>
</tr><tr><td align="right">progress</td>
<td align="left">ProgressBar</td>
</tr><tr><td align="right">quickcontactbadge</td>
<td align="left">QuickContactBadge</td>
</tr><tr><td align="right">radio</td>
<td align="left">RadioButton</td>
</tr><tr><td align="right">radiogroup</td>
<td align="left">RadioGroup</td>
</tr><tr><td align="right">rating</td>
<td align="left">RatingBar</td>
</tr><tr><td align="right">relative</td>
<td align="left">RelativeLayout</td>
</tr><tr><td align="right">row</td>
<td align="left">TableRow</td>
</tr><tr><td align="right">rssurface</td>
<td align="left">RSSurfaceView</td>
</tr><tr><td align="right">rstexture</td>
<td align="left">RSTextureView</td>
</tr><tr><td align="right">scroll</td>
<td align="left">ScrollView</td>
</tr><tr><td align="right">search</td>
<td align="left">SearchView</td>
</tr><tr><td align="right">seek</td>
<td align="left">SeekBar</td>
</tr><tr><td align="right">space</td>
<td align="left">Space</td>
</tr><tr><td align="right">spinner</td>
<td align="left">Spinner</td>
</tr><tr><td align="right">stack</td>
<td align="left">StackView</td>
</tr><tr><td align="right">surface</td>
<td align="left">SurfaceView</td>
</tr><tr><td align="right">switch</td>
<td align="left">Switch</td>
</tr><tr><td align="right">tabhost</td>
<td align="left">TabHost</td>
</tr><tr><td align="right">tabwidget</td>
<td align="left">TabWidget</td>
</tr><tr><td align="right">table</td>
<td align="left">TableLayout</td>
</tr><tr><td align="right">text</td>
<td align="left">TextView</td>
</tr><tr><td align="right">textclock</td>
<td align="left">TextClock</td>
</tr><tr><td align="right">textswitcher</td>
<td align="left">TextSwitcher</td>
</tr><tr><td align="right">texture</td>
<td align="left">TextureView</td>
</tr><tr><td align="right">textfield</td>
<td align="left">EditText</td>
</tr><tr><td align="right">timepicker</td>
<td align="left">TimePicker</td>
</tr><tr><td align="right">toggle</td>
<td align="left">ToggleButton</td>
</tr><tr><td align="right">twolinelistitem</td>
<td align="left">TwoLineListItem</td>
</tr><tr><td align="right">video</td>
<td align="left">VideoView</td>
</tr><tr><td align="right">viewanimator</td>
<td align="left">ViewAnimator</td>
</tr><tr><td align="right">viewflipper</td>
<td align="left">ViewFlipper</td>
</tr><tr><td align="right">viewgroup</td>
<td align="left">ViewGroup</td>
</tr><tr><td align="right">viewpager</td>
<td align="left">ViewPager</td>
</tr><tr><td align="right">viewstub</td>
<td align="left">ViewStub</td>
</tr><tr><td align="right">viewswitcher</td>
<td align="left">ViewSwitcher</td>
</tr><tr><td align="right">web</td>
<td align="left">android.webkit.WebView</td>
</tr><tr><td align="right">window</td>
<td align="left">FrameLayout</td>
</tr><tr><td align="right">zoom</td>
<td align="left">ZoomButton</td>
</tr><tr><td align="right">zoomcontrols</td>
<td align="left">ZoomControls</td>
</tr></tbody></table><p>Under each element name is a list of properties.</p>
<pre>TextView
class: android.widget.TextView
text: API Demos
resource_id: android:id/action_bar_title
id: activity_sample_code</pre>
<p>In this case we see there's a class, text, resource_id,
and an id. To find by text we can use the text command.</p>
<pre>> text('API Demos')
#<:webdriver::element:0x7f5348cbb3447ff2 id="1"></:webdriver::element:0x7f5348cbb3447ff2></pre>
<p>The text command will look for any text on screen.</p>
<p>To find by resource_id, we'd use:</p>
<pre>> id('android:id/action_bar_title')
#<:webdriver::element:0x..fe9053092a74b142a id="2"></:webdriver::element:0x..fe9053092a74b142a></pre>
<p>To find by strings.xml id, we'd use:</p>
<pre>> id('activity_sample_code')
#<:webdriver::element:0x5c46252e10021cc id="4"></:webdriver::element:0x5c46252e10021cc></pre>
<p>Once we've found the element, attributes such as text can be accessed.</p>
<pre>> id('activity_sample_code').text
"API Demos"</pre>
<p>These helper methods <a href="https://github.com/appium/ruby_lib/tree/master/docs">are documented on GitHub</a>.</p>
<p>To view all possible elements, there's a <code>source</code> command. The <code>page_class</code>
command will give you an overview of what classes exist on the current page.</p>
<pre>> page_class
12x android.widget.TextView
4x android.widget.FrameLayout
2x android.widget.LinearLayout
2x android.view.View
1x android.widget.ListView
1x android.widget.ImageView</pre>
<p>The page command excels at identifying the elements you're most likely
interested in automating. I encourage you to read through the existing docs
and try the methods on different elements.</p>
<hr /><h4><a class="anchor" id="Ending-the-session" href="#Ending-the-session"><i class="fa fa-link"></i></a>Ending the session</h4>
<p>Once we're done with a testing session, it's very important to cleanly quit.
If a session is not terminated properly then appium will consider the session
to still be in progress. This blocks all future sessions from working.</p>
<p>In the appium ruby console, the best way to quit the session is by using the
<code>x</code> command. The <code>x</code> command first ends the webdriver session,
and then ends the console.</p>
<p>If you desire to end only the webdriver session and remain in the console,
use driver_quit.</p>
<p>It's also important to end sessions when running tests outside the console.
All the selenium bindings offer a quit method. This should be invoked once
the testing session is over.</p>
<hr /><h4><a class="anchor" id="Appium.app-Inspector" href="#Appium.app-Inspector"><i class="fa fa-link"></i></a>Appium.app Inspector</h4>
<p>We've covered finding elements using the page command on the terminal.
Appium also has a GUI tool on OS X called Appium.app.</p>
<p>Appium.app enables visual exploration of the application to identify elements.
In addition, gestures are supported and can be exported to working code.</p>
<p>When using Appium.app for the first time, click the checkbox button. This
will activate appium doctor. If you don't see all green checkmarks,
then something is incorrect with your system configuration. Make the
necessary changes, press the checkbox button again, and then proceed when
everything is passing.</p>
<p><img src="appium_doctor.png" alt="" /></p>
<p>By default Appium.app uses a bundled version of appium. If you're running the
newest appium version from source, then click <code>Appium</code> -> <code>Preferences</code> and
set <code>Use External Appium Package</code>.</p>
<p><img src="appium_external.png" alt="" /></p>
<p>While most interactions can be done completely within the console, Appium.app is
great for identifying the proper values for appium's gesture commands.</p>
<p>Appium.app's inspector works on Android. The data is based on the same source
as the page command that we used in the last lesson.</p>
<p><img src="inspector_android.png" alt="" /></p>
<hr /><h4><a class="anchor" id="uiautomatorviewer" href="#uiautomatorviewer"><i class="fa fa-link"></i></a>uiautomatorviewer</h4>
<p>Google includes the uiautomatorviewer tool in the Android SDK.
uiautomator requires API 16 (Android 4.1, Jelly Bean) or above. Appium's
uiautomator support works best on API 17 (Android 4.2,
Jelly Bean MR1) or above. For this tutorial, we're interested in API 19.</p>
<p>Run <code>android avd</code>, select your Android emulator, press Edit, then ensure that
'Use Host GPU' is not checked. If we're using the Host GPU then uiautomatorviewer
will be unable to capture screenshots.</p>
<p>Also ensure that no Android appium sessions are running. Appium uses uiautomator
internally and this will prevent uiautomatorviewer from working if they're both
running at the same time.</p>
<p>Manually launch the Api Demos activity on the emulator then click
<code>Device Screeshot with compressed Hierarchy</code>. The button has an image of a droid
with a red circle. The following is a screenshot of the end result:</p>
<p><img src="uiautomatorviewer.png" alt="" /></p>
<p>Once you're done with uiautomatorviewer, you may want to restore the Host GPU
option. The Android emulator is significantly faster with it enabled.</p>
<hr /><h4><a class="anchor" id="2-Helpful-Links" href="#2-Helpful-Links"><i class="fa fa-link"></i></a>Helpful Links</h4>
<table><thead><tr><th align="right">Link</th>
<th align="left">Summary</th>
</tr></thead><tbody><tr><td align="right"><a href="https://github.com/appium/appium/tree/master/docs">Appium</a></td>
<td align="left">New versions of Appium.app are available on the appium homepage.</td>
</tr><tr><td align="right"><a href="https://github.com/appium/ruby_lib">appium_lib gem</a></td>
<td align="left">Appium's ruby library is on GitHub.</td>
</tr><tr><td align="right"><a href="https://github.com/appium/ruby_console">appium_console gem</a></td>
<td align="left">Appium's Ruby Console is also on GitHub.</td>
</tr><tr><td align="right"><a href="https://code.google.com/p/selenium/wiki/JsonWireProtocol">Selenium JsonWireProtocol</a></td>
<td align="left">The network traffic displayed in the console conforms to the JSON Wire Protocol.</td>
</tr></tbody></table><hr /><h4><a class="anchor" id="2-Summary" href="#2-Summary"><i class="fa fa-link"></i></a>Summary</h4>
<p>We compiled the open source API Demos app from source. Then the Appium
Ruby Console was used find elements with the page command. After ending the
session, we looked at two visual tools. Appium.app is great for generating
gestures and uiautomatorviewer helps inspect elements on the page visually.</p>
<p>In the next chapter, we'll write our first test.</p>
<hr /><h3><a class="anchor" id="Chapter-3---Writing-your-first-test" href="#Chapter-3---Writing-your-first-test"><i class="fa fa-link"></i></a>Chapter 3 - Writing your first test</h3>
<h4><a class="anchor" id="3-Introduction" href="#3-Introduction"><i class="fa fa-link"></i></a>Introduction</h4>
<p>Now that we've looked at the commands in the console,
it's time to write our first test. This involves using a test framework,
following the page object pattern, and running the test automatically.</p>
<hr /><h4><a class="anchor" id="Automating-a-simple-action" href="#Automating-a-simple-action"><i class="fa fa-link"></i></a>Automating a simple action</h4>
<p>The commands in the test are exactly the same as those used in the console.
Code can be copied and pasted to and from the console to form production tests.</p>
<p>The basic structure of the Api Demos test app is that clicking on the text
brings you to a dedicated page about that text. Accessibility triggers the
Accessibility page, Animation triggers Animation, and so on.</p>
<p>Clone the git repository and copy the <a href="https://github.com/appium/tutorial/tree/master/modules/source/java_android">java_android</a>
directory to your computer.</p>
<blockquote>
<p>git clone <a href="https://github.com/appium/tutorial.git">https://github.com/appium/tutorial.git</a></p>
</blockquote>
<p>The project is setup using maven.</p>
<ul><li>To use with NetBeans, go to <code>File</code> then <code>Open Project</code> and select the folder.</li>
<li>To use with Eclipse, go to <code>File</code> then <code>Import</code> and select <code>Existing Maven Projects</code></li>
<li>To use with IntelliJ, go to <code>File</code> then <code>Open</code> and select the <code>pom.xml</code></li>
<li>To use with the command line, <code>mvn clean test</code> will run all the tests.</li>
</ul><p>We're going to verify each element brings us to the correct page.</p>
<div class="highlight"><pre><span class="c1"># ruby console</span>
<span class="n">s_text</span><span class="p">(</span><span class="s1">'Accessibility'</span><span class="p">)</span><span class="o">.</span><span class="n">click</span>
<span class="n">s_text_exact</span> <span class="s1">'Accessibility Node Provider'</span>
</pre></div>
<div class="highlight"><pre><span class="c1">// java</span>
<span class="n">s_text</span><span class="o">(</span><span class="s">"Accessibility"</span><span class="o">).</span><span class="na">click</span><span class="o">();</span>
<span class="n">s_text_exact</span><span class="o">(</span><span class="s">"Accessibility Node Provider"</span><span class="o">);</span>
</pre></div>
<p>For the first entry, we click on Accessibility and then assert that the
Accessibility page is displayed. The code is valid however there's an issue
related to timing.</p>
<p>In the console, the implicit wait is turned to zero for immediate feedback.
That means when an element isn't found the test ends immediately because an
element not found exception is raised.</p>
<p>To overcome these timing problems, the wait helper method is useful.</p>
<div class="highlight"><pre><span class="c1"># ruby console</span>
<span class="n">wait</span> <span class="p">{</span> <span class="n">s_text</span><span class="p">(</span><span class="s1">'Accessibility'</span><span class="p">)</span><span class="o">.</span><span class="n">click</span> <span class="p">}</span>
<span class="n">wait</span> <span class="p">{</span> <span class="n">s_text_exact</span> <span class="s1">'Accessibility Node Provider'</span> <span class="p">}</span>
</pre></div>
<div class="highlight"><pre><span class="c1">// java</span>
<span class="n">wait</span><span class="o">(</span><span class="n">for_s_text</span><span class="o">(</span><span class="s">"Accessibility"</span><span class="o">)).</span><span class="na">click</span><span class="o">();</span>
<span class="n">wait</span><span class="o">(</span><span class="n">for_s_text_exact</span><span class="o">(</span><span class="s">"Accessibility Node Provider"</span><span class="o">));</span>
</pre></div>
<p>Now the code will wait up to 30 seconds for the command to succeed. If it
succeeds then the next line is executed immediately. If the
command is still failing after 30 seconds, an error is raised. If this error
is not rescued then the test will end in failure.</p>
<p>Another problem with the test code is that we're depending on the exact text
value. When the app changes, our tests will break.</p>
<div class="highlight"><pre><span class="c1"># ruby console</span>
<span class="n">wait</span> <span class="p">{</span> <span class="n">s_text</span> <span class="mi">2</span> <span class="p">}</span><span class="o">.</span><span class="n">click</span>
<span class="n">wait</span> <span class="p">{</span> <span class="n">name_exact</span> <span class="s1">'Accessibility Node Provider'</span> <span class="p">}</span>
</pre></div>
<div class="highlight"><pre><span class="c1">// java</span>
<span class="n">wait</span><span class="o">(</span><span class="n">for_s_text</span><span class="o">(</span><span class="mi">2</span><span class="o">)).</span><span class="na">click</span><span class="o">();</span>
<span class="n">name_exact</span><span class="o">(</span><span class="s">"Accessibility Node Provider"</span><span class="o">);</span>
</pre></div>
<p>In this code, we're finding the first text by index. Index 2 contains the
first cell. Index 1 is the header <code>API Demo</code>. To verify we're on the
accessibility page after clicking, the name selector is used. Name is
implemented as a content description search when using uiautomator. Thia
allows the text to change while retaining the content description. The test
is now resilient to text changes. It'll break only when the elements are
reordered or the content description changes.</p>
<p>To conclude this lesson, we'll look at the code to automate all 12 cells.</p>
<div class="highlight"><pre><span class="c1"># ruby console</span>
<span class="n">cell_names</span> <span class="o">=</span> <span class="n">tags</span><span class="p">(</span><span class="s1">'text'</span><span class="p">)</span><span class="o">.</span><span class="n">map</span> <span class="p">{</span> <span class="o">|</span><span class="n">cell</span><span class="o">|</span> <span class="n">cell</span><span class="o">.</span><span class="n">name</span> <span class="p">}</span>
<span class="n">cell_names</span><span class="o">[</span><span class="mi">1</span><span class="o">.</span><span class="n">.</span><span class="o">-</span><span class="mi">1</span><span class="o">].</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">cell_name</span><span class="o">|</span>
<span class="n">wait</span> <span class="p">{</span> <span class="n">scroll_to_exact</span><span class="p">(</span><span class="n">cell_name</span><span class="p">)</span><span class="o">.</span><span class="n">click</span> <span class="p">}</span>
<span class="n">wait_true</span> <span class="p">{</span> <span class="o">!</span> <span class="n">exists</span> <span class="p">{</span> <span class="n">name_exact</span> <span class="n">cell_name</span> <span class="p">}</span> <span class="p">}</span>
<span class="n">wait</span> <span class="p">{</span> <span class="n">back</span> <span class="p">}</span>
<span class="n">wait</span> <span class="p">{</span> <span class="n">name_exact</span><span class="p">(</span><span class="s1">'Accessibility'</span><span class="p">);</span> <span class="n">name_exact</span><span class="p">(</span><span class="s1">'Animation'</span><span class="p">)</span> <span class="p">}</span>
<span class="k">end</span>
</pre></div>
<div class="highlight"><pre><span class="n">setWait</span><span class="o">(</span><span class="mi">0</span><span class="o">);</span>
<span class="n">List</span><span class="o"><</span><span class="n">String</span><span class="o">></span> <span class="n">cell_names</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ArrayList</span><span class="o"><</span><span class="n">String</span><span class="o">>();</span>
<span class="k">for</span> <span class="o">(</span><span class="n">WebElement</span> <span class="n">cell</span> <span class="o">:</span> <span class="n">tags</span><span class="o">(</span><span class="s">"text"</span><span class="o">))</span> <span class="o">{</span>
<span class="n">cell_names</span><span class="o">.</span><span class="na">add</span><span class="o">(</span><span class="n">cell</span><span class="o">.</span><span class="na">getAttribute</span><span class="o">(</span><span class="s">"name"</span><span class="o">));</span>
<span class="o">}</span>
<span class="c1">// delete title cell</span>
<span class="n">cell_names</span><span class="o">.</span><span class="na">remove</span><span class="o">(</span><span class="mi">0</span><span class="o">);</span>
<span class="k">for</span> <span class="o">(</span><span class="n">String</span> <span class="n">cell_name</span> <span class="o">:</span> <span class="n">cell_names</span><span class="o">)</span> <span class="o">{</span>
<span class="n">scroll_to_exact</span><span class="o">(</span><span class="n">cell_name</span><span class="o">).</span><span class="na">click</span><span class="o">();</span>
<span class="n">waitInvisible</span><span class="o">(</span><span class="n">for_s_text_exact</span><span class="o">(</span><span class="n">cell_name</span><span class="o">));</span>
<span class="n">back</span><span class="o">();</span>
<span class="n">wait</span><span class="o">(</span><span class="n">for_name_exact</span><span class="o">(</span><span class="s">"Accessibility"</span><span class="o">));</span>
<span class="n">wait</span><span class="o">(</span><span class="n">for_name_exact</span><span class="o">(</span><span class="s">"Animation"</span><span class="o">));</span>
<span class="o">}</span>
<span class="n">setWait</span><span class="o">(</span><span class="mi">30</span><span class="o">);</span> <span class="c1">// restore old implicit wait</span>
</pre></div>
<p>The implicit wait in the console is 0. Since we'll be checking for elements
that don't exist, the wait is set to 0 <code>setWait(0)</code>. Next all the text tags
(<code>android.widget.TextView</code>) are found using the shortcut tag name text. After
that, we're saving the names to the cell_names array.</p>
<pre> [ 0] "API Demos",
[ 1] "Accessibility",
[ 2] "Animation",
[ 3] "App",
[ 4] "Content",
[ 5] "Graphics",
[ 6] "Media",
[ 7] "NFC",
[ 8] "OS",
[ 9] "Preference",
[10] "Text",
[11] "Views"</pre>
<p>The first item in the array is the page header. That's discarded with
<code>cell_names.remove(0);</code>. For the remaining elements, we're scrolling to and
clicking each of them. To detect that the click was successful,
the code waits for the cell name to no longer be visible.</p>
<p><code>waitInvisible(for_s_text_exact(cell_name));</code></p>
<p>After that we're returning to the home page by using <code>back();</code>. The back method
will return even though the app hasn't finished transitioning. I recommend
disabling animations under in <code>Dev Settings</code>. This can also be <a href="https://code.google.com/p/android-test-kit/wiki/DisablingAnimations">done programmatically</a>.</p>
<p><img src="animation_off.png" alt="" /></p>
<p>Finally, we're checking to ensure we've returned to the homepage before
looking for the next element.</p>
<div class="highlight"><pre><span class="n">wait</span><span class="o">(</span><span class="n">for_name_exact</span><span class="o">(</span><span class="s">"Accessibility"</span><span class="o">));</span>
<span class="n">wait</span><span class="o">(</span><span class="n">for_name_exact</span><span class="o">(</span><span class="s">"Animation"</span><span class="o">));</span>
</pre></div>
<hr /><h4><a class="anchor" id="Page-Object-Pattern" href="#Page-Object-Pattern"><i class="fa fa-link"></i></a>Page Object Pattern</h4>
<p>Now that we have a test fully written, it's time to apply the
<a href="https://code.google.com/p/selenium/wiki/PageObjects">page object pattern</a>.
For this tutorial, we're going to implement the page object pattern using
abstract classes and static helper methods.</p>
<p>The page object pattern is language independent and applies to any Selenium
testing, not just appium. The idea is to create an abstraction at the page
level. Each page knows how to perform the relevant actions.</p>
<p>Clone the git repository and copy the <a href="https://github.com/appium/tutorial/tree/master/modules/source/java_android">java_android</a>
directory to your computer.</p>
<blockquote>
<p>git clone <a href="https://github.com/appium/tutorial.git">https://github.com/appium/tutorial.git</a></p>
</blockquote>
<p>The project is setup using maven.</p>
<ul><li>To use with NetBeans, go to <code>File</code> then <code>Open Project</code> and select the folder.</li>
<li>To use with Eclipse, go to <code>File</code> then <code>Import</code> and select <code>Existing Maven Projects</code></li>
<li>To use with IntelliJ, go to <code>File</code> then <code>Open</code> and select the <code>pom.xml</code></li>
<li>To use with the command line, <code>mvn clean test</code> will run all the tests.</li>
</ul><p>The pages are contained within the page folder, and the test inside specs.
The test code is:</p>
<div class="highlight"><pre><span class="c1">// PageObjectPatternTest.java</span>
<span class="n">home</span><span class="o">.</span><span class="na">accessibilityClick</span><span class="o">();</span>
<span class="n">back</span><span class="o">();</span>
<span class="n">home</span><span class="o">.</span><span class="na">animationClick</span><span class="o">();</span>
<span class="n">back</span><span class="o">();</span>
</pre></div>