itms_automation 2.5 → 2.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c949a4fee0d3f3f851f06b470d163e1236a12a293660d69540c3eae8f1fd5697
-  data.tar.gz: 5debc5fedc12757ad0b6269df5781e5b00cb7e6feb16ce6d3ad038a20f93297c
+  metadata.gz: 583b36e2ec92b94f520492dc60d2e6664b258f37033c793a6b5898aabca7685b
+  data.tar.gz: ee00d5a2d671302e486317afbd252014a12ef04ed64fe707ec5cf2ba166fc9ce
 SHA512:
-  metadata.gz: 72e9ad58e4ce0e62a773a33775988570bf219ef23ef216ef97e5e5523359a9bbddd9b7095e7b468f2d9f711da4f84583c3b4c0b45a5102d3d57623bfdcb4feb1
-  data.tar.gz: 555252c6ab5940546771d2bb240e5182884ff2d7cde227cb975859013532e25fc0b06360e179714d0cbcde70cad3ff512b34138b6b280b5ce32b94b26c9b4ec7
+  metadata.gz: 50903bb26b4a64cac5b3fe53e14851de2917462605d52eba2e54c8ebfc9a2146440be7bb3f85ee7f61a7b099c395d0b44a5920cfede8a153f2f5323ac992d397
+  data.tar.gz: 6aaf390948a96cbb711e3a04e14e9002ec3c3dc2c26457ceaa8fc4a790d977cd95cd1123b36b6ff830b145a36c3d873982bc32e2f8d7a9924764ada53dce56e1

data/bin/generate.rb

@@ -1,7 +1,6 @@
-
 def itms_automation_scaffold
   if File.exists?(@features_dir)
-    puts 'There is already cucumber directory. Please move existing cucumber directory to carry on '
+    puts "A features directory already exists. Stopping..."
     exit 1
   end
   msg("Question") do
@@ -13,41 +12,8 @@ def itms_automation_scaffold
 
   FileUtils.cp_r(@source_dir, @features_dir)
 
-  msg('Info') do
-    puts "iTMS Automation is creating 'cucumber' framework. Please have a look which files are being created\n"
-  end
-  msg('Gemfile') do
-    puts "iTMS Automation created Gemfile containing all required Gems\n"
-  end
-  msg('cucumber.yml') do
-    puts "iTMS Automation created cucumber.yml file with profiles of all needed configurations\n"
-  end
-  msg('config/chrome_headless_options.yaml') do
-    puts "iTMS Automation created chrome_headless_options.yml file with profiles of all needed configurations\n"
-  end
-  msg('config/firefox_headless_options.yaml') do
-    puts "iTMS Automation created firefox_headless_options.yml file with profiles of all needed configurations\n"
-  end
-  msg('config/chrome_options.yaml') do
-    puts "iTMS Automation created chrome_options.yml file with profiles of all needed configurations\n"
-  end
-  msg('config/firefox_options.yaml') do
-    puts "iTMS Automation created firefox_options.yml file with profiles of all needed configurations\n"
-  end
-  msg('config/ie_options.yaml') do
-    puts "iTMS Automation created ie_options.yml file with profiles of all needed configurations\n"
-  end
-  msg('config/remote_options.yaml') do
-    puts "iTMS Automation created remote_options.yml file with profiles of all needed configurations\n"
-  end
-  msg('config/safari_options.yaml') do
-    puts "iTMS Automation created safari_options.yml file with profiles of all needed configurations\n"
-  end
-  msg('README.md') do
-    puts "iTMS Automation created README.md file with template usage\n"
-  end
-  msg('Info') do
-    puts "All Config files created. \n"
+  msg("Info") do
+    puts "features subdirectory created. \n"
   end
 
 end

data/bin/helper.rb

@@ -3,15 +3,31 @@ require 'json'
 require "rubygems"
 
 def msg(title, &block)
-  puts "\n" + '-' * 10 + title + '-' * 10
-  yield
-  puts '-' * 10 + '-------' + '-' * 10 + "\n"
-  sleep 1
+  puts "\n" + "-"*10 + title + "-"*10
+  block.call
+  puts "-"*10 + "-------" + "-"*10 + "\n"
+end
+
+def print_usage
+  puts <<EOF
+
+  Usage: itms_automation <command-name> [parameters] [options]
+
+  <command-name> can be one of
+    help
+      prints more detailed help information.
+    gen
+      generate a features folder structure.
+    version
+      prints the gem version
+
+  <options> can be
+     -v, --verbose   Turns on verbose logging
+EOF
 end
 
 def print_help
   puts <<EOF
-  Author: iTMS
 
   Usage: itms_automation <command-name> [parameters] [options]
 
@@ -19,19 +35,16 @@ def print_help
     help
     gen
     version
-    ls
 
     Commands:
       help : prints more detailed help information.
 
-      gen  : creates a features dir. This is usually used once when
-             setting up itms_automation to ensure that the features folder contains
+      gen  : creates a skeleton features dir. This is usually used once when
+             setting up selnium-cucumber to ensure that the features folder contains
              the right step definitions and environment to run with cucumber.
 
       version : prints the gem version
 
-      ls: list all steps name of itms_automation framework
-
   <Options>
       -v, --verbose  Turns on verbose logging
 EOF

data/bin/itms_automation

@@ -1,32 +1,27 @@
 #!/usr/bin/env ruby
+
 require_relative 'helper.rb'
 require_relative 'generate.rb'
-require_relative 'documentation_generator.rb'
 require 'itms_automation/version'
 
-@features_dir = File.join(FileUtils.pwd, "project")
-@source_dir = File.join(File.dirname(__FILE__), '..', 'project')
-
-search_string = ARGV.shift
-case search_string
-  when /version/
-    puts ItmsAutomation::VERSION
-  when /gen/
-    itms_automation_scaffold
-  when /ls/
-    ORDERED_KINDS = %w[Given When Then]
-    heading = 'All itms_automation steps'
+@features_dir = File.join(FileUtils.pwd, "features")
+@support_dir = File.join(@features_dir, "support")
+@support_dir = File.join(@features_dir, "screenshots")
+@source_dir = File.join(File.dirname(__FILE__), '..', 'features-skeleton')
 
-# collect
-    steps_glob = File.expand_path('../../lib/itms_automation/*_steps.rb', __FILE__)
-    step_names = `cat #{steps_glob}`.split($/).select { |line| line =~ /^\s*(Given|When|Then)/ }
+if (ARGV.length == 0)
+  print_usage
+else
+  cmd = ARGV.shift
 
-# Output
-    puts "\e[4;34m\n# #{heading}\e[0m" # blue underline
-    puts step_names
-  else
-    print_help
+  if cmd == "help"
+      print_help
+  elsif cmd == "gen"
+      itms_automation_scaffold
+  elsif cmd == "version"
+    puts ITMS::Automation::VERSION
+    else
+      print_usage
+  end
 end
 
-
-

data/doc/installation.md

@@ -0,0 +1,16 @@
+Installation
+============
+### Prerequisites
+You need to have Ruby installed.
+Verify your installation by running ruby -v in a terminal - it should print "ruby 1.9.3" (or higher).
+
+You need to have DevKit installed.
+
+You can get Ruby and DevKit from [RubyInstaller.org](http://rubyinstaller.org/)
+
+### Installation
+
+Install `itms_automation` gem by running
+
+- `gem install itms_automation`
+

data/doc/itms-automation-API.md

@@ -0,0 +1,103 @@
+itms_automation Ruby API's
+============================
+
+If you are writing code for your custom steps you can use the following methods :
+
+Note : For some of the API paramtere values are fixed. Such values for paramaters are mentioned below.
+
+Navigation API's
+----------------
+
+	navigate_to("link")
+
+	navigate(direction)  # direction => "back" / "forward"
+
+	close_driver()
+
+
+Browser Interaction API's
+-------------------------
+
+	resize_browser(width, height)
+
+	scroll_page(to)	     # to => "top" / "end"
+
+	scroll_to_element(by, access_value)
+
+	zoom_in_out(in_out)  # in_out => "add" / "subtract"
+
+	zoom_in_out_till_element_display(by, in_out, access_value) # in_out => "add" / "subtract"
+
+
+Input API's
+------------
+
+	click(element)
+
+	double_click(element)
+
+	click_forcefully(element)
+
+	enter_text(element, text)
+
+	clear_text(element)
+
+	check_checkbox(element)
+
+	uncheck_checkbox(element)
+
+	toggle_checkbox(element)
+
+	select_radio_button(element)
+
+	get_page_title()
+
+	get_element_text(element)
+
+	get_element_attribute(element, attribute)
+
+	is_element_enabled(element)
+
+	is_element_displayed(element)
+
+	hover_over_element(element)
+
+	by => "locators type" ("id", "name", "class", "xpath", "css")
+
+	access_value => "locator value"
+
+
+Javascript Handling API
+-----------------------
+
+	handle_alert(decision) 		# decision => "accept" / "dismiss"
+
+	get_alert_text
+
+
+Progress API's
+--------------
+
+	wait(time_in_sec)
+
+	wait_for_element_to_display(element, duration)
+
+	wait_for_element_to_enable(element, duration)
+
+
+	by => "locators type" ("id", "name", "class", "xpath", "css")
+
+	access_value => "locator value"
+
+	duration => duration in seconds.
+
+
+Screenshot API
+--------------
+	take_screenshots
+
+
+Configuration API
+-----------------
+
+	print_congifugartion

data/doc/itms-automation-help.md

@@ -0,0 +1,18 @@
+
+Usage: itms_automation <command-name> [parameters] [options]
+
+  <command-name> can be one of
+    help
+    gen
+    version
+
+  Commands:
+    help : prints more detailed help information.
+
+    gen  : creates a skeleton features dir. This is usually used once when
+           setting up selnium-cucumber to ensure that the features folder contains
+           the right step definitions and environment to run with cucumber.
+
+    version : prints the gem version
+
+    Options:  -v, --verbose  Turns on verbose logging

data/example/android/android_app/android_app_calculator/features/calculator.feature

@@ -0,0 +1,36 @@
+Feature: Verify Calculator functionalities
+ 
+  Scenario: Click on OK button 
+    Then I click on element having id "com.android2.calculator3:id/cling_dismiss"
+
+  Scenario: Addirion
+    Then I click on element having id "com.android2.calculator3:id/digit5"
+    Then I click on element having id "com.android2.calculator3:id/plus"
+    Then I click on element having id "com.android2.calculator3:id/digit9"
+    When I click on element having id "com.android2.calculator3:id/equal"
+    Then element having xpath "//android.widget.EditText[@index=0]" should have text as "14"
+
+
+  Scenario: Substraction
+    Then I click on element having id "com.android2.calculator3:id/digit9"
+    Then I click on element having id "com.android2.calculator3:id/minus"
+    Then I click on element having id "com.android2.calculator3:id/digit5"
+    When I click on element having id "com.android2.calculator3:id/equal"
+    Then element having xpath "//android.widget.EditText[@index=0]" should have text as "4"
+
+  Scenario: Multiplication
+    Then I click on element having id "com.android2.calculator3:id/digit9"
+    Then I click on element having id "com.android2.calculator3:id/mul"
+    Then I click on element having id "com.android2.calculator3:id/digit5"
+    When I click on element having id "com.android2.calculator3:id/equal"
+    Then element having xpath "//android.widget.EditText[@index=0]" should have text as "45"
+
+  Scenario: Division
+    Then I click on element having id "com.android2.calculator3:id/digit8"
+    Then I click on element having id "com.android2.calculator3:id/div"
+    Then I click on element having id "com.android2.calculator3:id/digit2"
+    When I click on element having id "com.android2.calculator3:id/equal"
+    Then element having xpath "//android.widget.EditText[@index=0]" should have text as "4"
+
+  Scenario: Clear output
+   Then I click on element having id "com.android2.calculator3:id/clear"

data/example/android/android_app/android_app_calculator/features/my_first.feature

@@ -0,0 +1,13 @@
+#Scenario: Division
+#    Then I click on element having id "com.android2.calculator3:id/digit8"
+#    Then I click on element having id "com.android2.calculator3:id/div"
+#    Then I click on element having id "com.android2.calculator3:id/digit4"
+#    When I click on element having id "com.android2.calculator3:id/equal"
+#    Then element having xpath "//android.widget.EditText[@index=0]" should have text as "2"
+
+#  Scenario: Multiplication
+#    Then I click on element having id "com.android2.calculator3:id/digit6"
+#    Then I click on element having id "com.android2.calculator3:id/mul"
+#    Then I click on element having id "com.android2.calculator3:id/digit5"
+#    When I click on element having id "com.android2.calculator3:id/equal"
+#    Then element having xpath "//android.widget.EditText[@index=0]" should have text as "30"

data/example/android/android_app/android_app_calculator/features/step_definitions/custom_steps.rb

@@ -0,0 +1,5 @@
+require 'itms_automation'
+
+# Do Not Remove This File
+# Add your custom steps here
+# $driver is instance of webdriver use this instance to write your custom code

data/example/android/android_app/android_app_calculator/features/support/env.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'itms_automation'
+
+# Store command line arguments
+$browser_type = ENV['BROWSER'] || 'ff'
+$platform = ENV['PLATFORM'] || 'desktop'
+$os_version = ENV['OS_VERSION']
+$device_name = ENV['DEVICE_NAME']
+$udid = ENV['UDID']
+$app_path = ENV['APP_PATH']
+
+# check for valid parameters
+validate_parameters $platform, $browser_type, $app_path
+
+# If platform is android or ios create driver instance for mobile browser
+if $platform == 'android' or $platform == 'iOS'
+
+  if $browser_type == 'native'
+    $browser_type = "Browser"
+  end
+
+  if $platform == 'android'
+    $device_name, $os_version = get_device_info
+  end
+
+  desired_caps = {
+    caps:       {
+      platformName:  $platform,
+      browserName: $browser_type,
+      versionNumber: $os_version,
+      deviceName: $device_name,
+      udid: $udid,
+      app: ".//#{$app_path}"
+      },
+      appium_lib: { server_url: 'http://localhost:4723/wd/hub' }
+    }
+
+  begin
+    $driver = Appium::Driver.new(desired_caps).start_driver
+  rescue Exception => e
+    puts e.message
+    Process.exit(0)
+  end
+else # else create driver instance for desktop browser
+  begin
+    $driver = Selenium::WebDriver.for(:"#{$browser_type}")
+    $driver.manage().window().maximize()
+  rescue Exception => e
+    puts e.message
+    Process.exit(0)
+  end
+end

data/example/android/android_app/android_app_calculator/features/support/hooks.rb

@@ -0,0 +1,26 @@
+#Cucumber provides a number of hooks which allow us to run blocks at various points in the Cucumber test cycle
+
+Before do
+  # Do something before each scenario.
+end
+
+Before do |scenario|
+  # The +scenario+ argument is optional, but if you use it, you can get the title,
+  # description, or name (title + description) of the scenario that is about to be
+  # executed.
+end
+
+After do
+  # Do something after each scenario.
+end
+
+After do |scenario|
+  # Do something after each scenario.
+  # The +scenario+ argument is optional, but
+  # if you use it, you can inspect status with
+  # the #failed?, #passed? and #exception methods.
+
+  if(scenario.failed?)
+    #Do something if scenario fails.
+  end
+end