appium_lib 0.24.1 → 1.0.0

data/docs_gen/make_docs.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'rubygems'
 require 'yard'
 
@@ -78,7 +76,7 @@ def globs paths
   paths.map! { |path| "#{Dir.pwd}#{path}" }
 end
 
-common_globs = '/lib/appium_lib/*.rb', '/lib/appium_lib/common/**/*.rb'
+common_globs = '/lib/appium_lib/*.rb', '/lib/appium_lib/device/*.rb', '/lib/appium_lib/common/**/*.rb'
 android_globs = common_globs + [ '/lib/appium_lib/android/**/*.rb' ]
 ios_globs = common_globs + [ '/lib/appium_lib/ios/**/*.rb' ]
 

data/ios_tests/Gemfile

@@ -0,0 +1 @@
+eval File.read('../Gemfile')

data/ios_tests/LICENSE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/ios_tests/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+task :default => :ios
+
+# Run sh and ignore exception
+def run_sh cmd
+  begin; sh cmd; rescue; end
+end
+
+# Run cmd. On failure run install and try again.
+def bash cmd
+  sh cmd do |successful, result|
+    # exitstatus 7 means bundle install failed
+    # exitstatus 1 means the test failed
+    if !successful && result.exitstatus === 7
+      Rake::Task['install'].execute
+      run_sh cmd
+    end
+  end
+end
+
+# Run a single test with:
+# rake ios['ios/element/generic']
+#
+# rake ios['driver']
+#
+# Run all tests with:
+# rake ios
+desc 'Run the iOS tests'
+task :ios, :args, :test_file do |args, test_file|
+  # rake android['ok']
+  # args = android
+  # test_file = {:args=>"ok"}
+  test_file = test_file[:args]
+  path = File.expand_path('appium.txt', Rake.application.original_dir)
+  ENV['APPIUM_TXT'] = path
+  puts "Rake appium.txt path is: #{path}"
+  cmd = 'bundle exec ruby ./lib/run.rb ios'
+  cmd += %Q( "#{test_file}") if test_file
+  bash cmd
+end
+
+desc 'Run bundle install'
+task :install do
+  sh 'bundle install'
+end

data/ios_tests/UICatalog.app/PkgInfo

@@ -0,0 +1 @@
+APPL????

data/ios_tests/appium.txt

@@ -0,0 +1,3 @@
+[caps]
+platformName = "ios"
+app = "./UICatalog.app"

data/ios_tests/flaky.txt

@@ -0,0 +1 @@
+ios = "lib/ios/specs/"

data/ios_tests/lib/format.rb

@@ -0,0 +1,25 @@
+# helper code useful for writing and verifying tests using Pry
+list = <<TXT
+alert_click
+alert_text
+alert_accept
+alert_accept_text
+alert_dismiss
+alert_dismiss_text
+TXT
+
+list.split("\n").each do |method|
+  puts "t '#{method}' do"
+  puts
+  puts 'end'
+  puts
+end
+
+=begin
+# for Pry
+class Object
+  def must_equal b
+    raise 'not equal' unless self == b
+  end
+end
+=end

data/ios_tests/lib/ios/specs/common/element/window.rb

@@ -0,0 +1,15 @@
+describe 'common/element/window' do
+  def before_first
+    screen.must_equal catalog
+  end
+
+  t 'before_first' do
+    before_first
+  end
+
+  t 'window_size' do
+    size = window_size
+    size.width.class.must_equal Fixnum
+    size.height.class.must_equal Fixnum
+  end
+end

data/ios_tests/lib/ios/specs/common/helper.rb

@@ -0,0 +1,204 @@
+# rake ios[common/helper]
+describe 'common/helper.rb' do
+  def before_first
+    screen.must_equal catalog
+  end
+
+  t 'before_first' do
+    before_first
+  end
+
+  wait_time = [0.2, 0.2] # max_wait, interval
+
+=begin
+There's no `must_not_raise` as the opposite of must_raise
+
+By default code is expected to not raise exceptions.
+must_not_raise is a no-op.
+=end
+
+  # wait is a success unless an error is raised
+  # max_wait=0 is infinity to use 0.1
+  t 'wait' do
+    # successful wait should not raise error
+    wait(*wait_time) { true }
+    wait(*wait_time) { false }
+    wait(*wait_time) { nil }
+
+    # failed wait should error
+    proc { wait(*wait_time) { raise } }.must_raise Timeout::Error
+
+    # regular rescue will not handle exceptions outside of StandardError hierarchy
+    # must rescue Exception explicitly to rescue everything
+    proc { wait(*wait_time) { raise NoMemoryError } }.must_raise Timeout::Error
+  end
+
+  t 'ignore' do
+    # ignore should rescue all exceptions
+    ignore { true }
+    ignore { false }
+    ignore { nil }
+    ignore { raise }
+    ignore { raise NoMemoryError }
+  end
+
+  # wait_true is a success unless the value is not true
+  t 'wait_true' do
+    # successful wait should not error
+    wait_true(*wait_time) { true }
+
+    # failed wait should error
+    proc { wait_true(*wait_time) { false } }.must_raise Timeout::Error
+    proc { wait_true(*wait_time) { nil } }.must_raise Timeout::Error
+
+    # raise should error
+    proc { wait_true(*wait_time) { raise } }.must_raise Timeout::Error
+
+    # regular rescue will not handle exceptions outside of StandardError hierarchy
+    # must rescue Exception explicitly to rescue everything
+    proc { wait(*wait_time) { raise NoMemoryError } }.must_raise Timeout::Error
+  end
+
+  # t 'id' # id is for Selendroid
+
+  t 'back' do
+    # start page
+    tag('UIANavigationBar').name.must_equal 'UICatalog'
+    # nav to new page.
+    wait_true { s_text('buttons').click; tag('UIANavigationBar').name == 'Buttons' }
+    tag('UIANavigationBar').name.must_equal 'Buttons'
+    # go back
+    back_click
+    # start page
+    tag('UIANavigationBar').name.must_equal 'UICatalog'
+  end
+
+  t 'session_id' do
+    # Sauce doesn't return '-' so make them optional.
+    session_id.must_match /\h{8}-?\h{4}-?\h{4}-?\h{4}-?\h{12}/
+  end
+
+  t 'xpath' do
+    xpath('//UIAStaticText').name.must_equal 'UICatalog'
+  end
+
+  t 'xpaths' do
+    xpaths('//UIAStaticText').length.must_equal 13
+  end
+
+  def uibutton_text
+    'Buttons, Various uses of UIButton'
+  end
+
+  t 'ele_index' do
+    ele_index('UIAStaticText', 2).name.must_equal uibutton_text
+  end
+
+  # todo: 'string_attr_exact'
+
+  t 'find_ele_by_attr' do
+    el_id = find_ele_by_attr('UIAStaticText', 'name', uibutton_text).instance_variable_get :@id
+    el_id.must_match /\d+/
+  end
+
+  t 'find_eles_by_attr' do
+    # '!' clears the input buffer in Pry so make sure there's
+    # no space after the !
+    set_wait 1
+    # empty array returned when no match
+    found = !find_eles_by_attr('UIAStaticText', 'name', uibutton_text).empty?
+    found.must_equal true
+
+    found = !find_eles_by_attr('UIAStaticText', 'name', 'zz').empty?
+    found.must_equal false
+    set_wait
+  end
+
+  # todo: 'string_attr_include'
+
+  t 'find_ele_by_attr_include' do
+    el_text = find_ele_by_attr_include('UIAStaticText', :name, 'button').text
+    el_text.must_equal ''
+
+    el_name = find_ele_by_attr_include('UIAStaticText', :name, 'button').name
+    el_name.must_equal uibutton_text
+  end
+
+  t 'find_eles_by_attr_include' do
+    ele_count = find_eles_by_attr_include('UIAStaticText', :name, 'e').length
+    ele_count.must_equal 12
+  end
+
+  t 'first_ele' do
+    first_ele('UIAStaticText').name.must_equal 'UICatalog'
+  end
+
+  t 'last_ele' do
+    el = last_ele('UIAStaticText')
+    el.text.must_equal ''
+    el.name.must_equal 'Transitions, Shows UIViewAnimationTransitions'
+  end
+
+  # t 'source' do # tested by get_source
+
+  t 'get_source' do
+    get_source.class.must_equal String
+  end
+
+  t 'id' do
+    id 'ButtonsExplain' # 'Various uses of UIButton'
+  end
+
+  t 'invalid id should error' do
+    begin
+      id 'does not exist'
+    rescue Exception => e
+      message = e.message
+    end
+    message.must_equal 'Invalid id `does not exist`'
+
+    # resource id should error on ios
+    begin
+      id 'android:id/text1'
+    rescue Exception => e
+      message = e.message
+    end
+    message.must_equal 'Invalid id `android:id/text1`'
+  end
+
+  t 'tag' do
+    tag('UIATableCell').name.must_equal 'Buttons, Various uses of UIButton'
+  end
+
+  t 'tags' do
+    tags('UIATableCell').length.must_equal 12
+  end
+
+  t 'find_eles_by_attr_include' do
+    find_eles_by_attr_include('UIATableCell', 'name', 'Use').length.must_equal 7
+  end
+
+  t 'get_page_class' do
+    # 8 local. 9 on sauce.
+    get_page_class.split("\n").length.must_be :>=, 8
+  end
+=begin
+todo:
+get_page_class
+page_class
+tag
+tags
+px_to_window_rel
+lazy_load_strings
+xml_keys
+xml_values
+resolve_id
+string_visible_contains
+xpath_visible_contains
+xpaths_visible_contains
+string_visible_exact
+xpath_visible_exact
+xpaths_visible_exact
+raise_no_element_error
+=end
+end