SurfCustomCalabash 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2584314c724fb94ff419dd4513cf5ff7aff9cfa1aa096e57ee788b2f2f8eb14f
-  data.tar.gz: ba9ac40807f121a1dfab4e34b646528cc970c097cb1d32dcb08907231e88f1c7
+  metadata.gz: 10324a3851f0d2c8a774575861c3489d6519d9a6fed70ac48244565ed9c03da6
+  data.tar.gz: 70572d7c07b601e2407cc9cf8e0d3317a680b919afb56faca9be2d3cb9f68f04
 SHA512:
-  metadata.gz: 19a77b8a812760dfc779faf6580e315014ba9628919b6912744d63baab971bd6880edbd56a4c4d0466d57093b302bb2c49dcb42ecb7872e51607d55a6ec22495
-  data.tar.gz: b1e7895eade91dc479e2afffda0feabc4fb3cc639183e0f40e885827eac7a345f15e58f6a8ba1257fd7762019cc1d2c284516311bb8fb4578abb65b69a61cd78
+  metadata.gz: 4092df2ff8c18a451ad3e0132accbb3eae2c66ee24526e43d7c0adfa51f17e47234f8573999d248df0de0eb24a91f264fed8cd1310a8784309e44eb5776bdc57
+  data.tar.gz: 89d7c2269fd6aa04b72eb58ace406dad941a2dcaf2ae84559729802ff1ea65e65e39db5d1902577e70df131b35f5e4e13f8abdebfe3b2054e798caa336eac22d

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+
+## v1.0.0 - 28.08.2020
+### Added
+- Changelog.md
+- Added template file for initializing a new autotest project (use **SurfCustomCalabash gen**)
+
+### Changed
+- method close_keybord can now be called with optional parameters **x_start** and **y_start** (by default **x_start:** 100, **y_start:** 150) 

data/README.md

@@ -21,11 +21,75 @@ Or install it yourself as:
 
 This gem provides methods for easier use Calabash.
 
-Install gem in your project, add require 'SurfCustomCalabash/IosCommon' and 'SurfCustomCalabash/DroidCommon' in your ios or android ruby files.
+Install gem in your exist project, add in your ios or android ruby files.
 
-IosCommon contains custom swipe methods for ios.
+    $require 'SurfCustomCalabash/IosCommon' 
+    
+    $require 'SurfCustomCalabash/DroidCommon' 
+
+**IosCommon** contains custom swipe methods for ios.
+ 
+**DroidCommon** contains custom swipe methods for android.
+
+**CommonMethods** contains different methods (taps, swipes, waits and other) for both platforms.
+
+### Create new project
+You should move to the directory which would contains folder with your tests. 
+surf-calabash will create it by itself with the name **Change_it_to_your_own_project_name**: 
+    
+    $ SurfCustomCalabash gen
+    
+After that you'll see many folders inside them. Each of them will be describe below. 
+
+#### ci 
+
+It is used for all scripts for continuous integration. In Surfstudio we have .groovy files for them.
  
-DroidCommon contains custom swipe methods for android.
+ 
+#### config
+
+Contains only cucumber.yml file. It named arguments are called profiles - e.g. iOS or Android for run.
+
+
+#### features 
+
+Main folder of all project. Every feature, step definition, support files and page objects are here. You can read about it more in each file of this folder.
+
+
+#### irbrcs
+
+Our own shtick. We change calabash-android console and calabash-ios console a little, so you can write your own complex functions, which you'll implement in the step_definitions or in page objects. So for the correct work we had to change irbrc-files of gems too. 
+
+#### reports 
+
+Folder with screenshots of errors.
+
+
+#### test_servers
+
+Standard calabash-android folder with signed apk-files. 
+
+#### TestFolder 
+
+Contains some additional files, e.g. jpg-pictures or other data which can be used in tests. 
+
+#### Backdoors list
+
+We use backdoors for our applications for get around the limit of nativity of calabash.
+
+#### Gemfile 
+
+All required gems for surf-calabash. You should run installing all gems by bundle after initializing project when you rename **Change_it_to_your_own_project_name** to your own name.
+
+    $bundle install
+
+#### Scripts 
+
+Some shell scripts which can help to start tests faster because of typing smaller count of symbols. :) 
+Also it shows some integration with Xray Jira plugin. 
+
+#### start.sh
 
-CommonMethods contains different methods (taps, swipes, waits and other) for both platforms.
+Shell script for useful launch all helpful scripts of folder above.
 
+ 

data/SurfCustomCalabash.gemspec

@@ -32,9 +32,9 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  # spec.bindir        = "exe"
+  spec.executables   = ["SurfCustomCalabash"]
+  # spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"

data/bin/SurfCustomCalabash

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'rbconfig'
+
+# for ruby 1.9.1 and earlier
+unless defined? RbConfig.ruby
+  def RbConfig.ruby
+    File.join(RbConfig::CONFIG["bindir"], RbConfig::CONFIG["ruby_install_name"] + RbConfig::CONFIG["EXEEXT"])
+  end
+end
+
+require File.join(File.dirname(__FILE__), "surf-calabash-helpers")
+
+@hierarchy = File.join(FileUtils.pwd, "Change_it_to_your_own_project_name")
+@source_dir = File.join(File.dirname(__FILE__), '..', 'sources')
+
+if ARGV.length == 0
+  print_usage
+else
+  cmd = ARGV.shift
+
+  case cmd
+    when 'help'
+      print_help
+    when 'gen'
+      gen = File.join(File.dirname(__FILE__), "surf-calabash-gen")
+      require gen
+      surf_gen
+    when 'android_console'
+      require 'calabash-android/helpers'
+      require 'calabash-android/utils'
+      require 'calabash-android/java_keystore'
+      require 'calabash-android/env'
+      require File.join(File.dirname(__FILE__), "surf-calabash-console")
+
+      if ARGV.empty? or not is_apk_file?(ARGV.first)
+        Kernel.puts "The first parameter must be the path to the apk file."
+        exit 1
+      else
+        android_console(relative_to_full_path(ARGV.shift))
+      end
+
+    when 'ios_console'
+      require File.join(File.dirname(__FILE__), "surf-calabash-console")
+      ios_console
+    when 'version'
+      require_relative '../lib/SurfCustomCalabash/version'
+      Kernel.puts SurfCustomCalabash::VERSION
+    else
+      Kernel.puts "Invalid command '#{cmd}'"
+      print_usage
+  end
+end

data/bin/surf-calabash-console.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'rbconfig'
+
+def android_console(app_path = nil)
+  test_server_path = test_server_path(app_path)
+
+  path = ENV['CALABASH_IRBRC']
+  Kernel.puts(path)
+
+  unless path
+    if File.exist?('irbrc')
+      path = File.expand_path('irbrc')
+    end
+  end
+
+  unless path
+    path = File.expand_path(File.join(File.dirname(__FILE__), '../sources/irbrcs/android', 'irbrc'))
+  end
+
+  ENV['IRBRC'] = path
+  Kernel.puts(path)
+
+  unless ENV['APP_PATH']
+    ENV['APP_PATH'] = app_path
+  end
+
+  unless ENV['TEST_APP_PATH']
+    ENV['TEST_APP_PATH'] = test_server_path
+  end
+
+  build_test_server_if_needed(app_path)
+
+  Kernel.puts 'Starting calabash-android console...'
+  Kernel.puts "Loading #{ENV['IRBRC']}"
+  Kernel.puts 'Running irb...'
+  exec('irb')
+end
+
+def is_apk_file?(file_path)
+  file_path.end_with? ".apk" and File.exist? file_path
+end
+
+def relative_to_full_path(file_path)
+  File.expand_path(file_path)
+end
+
+def ios_console
+  path = ENV['CALABASH_IRBRC']
+  unless path
+    if File.exist?('.irbrc')
+      path = File.expand_path('.irbrc')
+    end
+  end
+  unless path
+    path = File.expand_path(File.join(File.dirname(__FILE__), '../sources/irbrcs/ios', 'irbrc'))
+  end
+  ENV['IRBRC'] = path
+  puts "Running irb..."
+  exec("irb")
+end

data/bin/surf-calabash-gen.rb

@@ -0,0 +1,17 @@
+def surf_gen
+  if File.exists?(@hierarchy)
+    Kernel.puts "hierarchy is already created. Stopping..."
+    exit 1
+  end
+  msg("Question") do
+    Kernel.puts "I'm about to create a subdirectory called sources."
+    Kernel.puts "Please change name of it to name of your own project."
+    Kernel.puts "Please hit return to confirm that's what you want."
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+
+  FileUtils.cp_r(@source_dir, @hierarchy)
+  msg("Info") do
+      Kernel.puts "hierarchy was created. \n"
+  end
+end

data/bin/surf-calabash-helpers.rb

@@ -0,0 +1,34 @@
+require 'tempfile'
+require 'json'
+require "rubygems"
+
+def msg(title, &block)
+  Kernel.puts "\n" + "-"*10 + title + "-"*10
+  block.call
+  Kernel.puts "-"*10 + "-------" + "-"*10 + "\n"
+end
+
+def print_usage
+  Kernel.puts <<EOF
+  Usage: SurfCustomCalabash <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
+  print_usage
+end
+
+def is_json?(str)
+  str[0..0] == '{'
+end

data/lib/SurfCustomCalabash/CommonMethods.rb

@@ -209,7 +209,7 @@ def remember(element, sleep_duration: 1, timeout_duration: 5)
   wait_element(element, sleep_duration: sleep_duration, timeout_duration: timeout_duration)
   name = query(element)
   save_name = name.first['text']
-  puts(save_name)
+  Kernel.puts(save_name)
   return save_name
 end
 
@@ -218,7 +218,7 @@ def remember_last_text(element, sleep_duration: 1, timeout_duration: 5)
   wait_element(element, sleep_duration: sleep_duration, timeout_duration: timeout_duration)
   name = query(element)
   save_name = name.last['text']
-  puts(save_name)
+  Kernel.puts(save_name)
   return save_name
 end
 
@@ -273,7 +273,7 @@ def cross_coordinate(element_front, element_behind, delta: 100)
       cross = false
     end
   end
-  # puts(cross)
+  # Kernel.puts(cross)
   return cross
 end
 

data/lib/SurfCustomCalabash/DroidMethods.rb

@@ -1,7 +1,8 @@
 require 'calabash-android'
 require 'SurfCustomCalabash/CommonMethods'
 
-def close_keyboard
+# close keyboard, parameters use ios only
+def close_keyboard(x_start: 0, y_start:0)
   if keyboard_visible?
     hide_soft_keyboard
   end

data/lib/SurfCustomCalabash/IosMethods.rb

@@ -2,9 +2,9 @@ require 'calabash-cucumber/ibase'
 require 'SurfCustomCalabash/CommonMethods'
 
 # close keyboard with a swipe of the screen
-def close_keyboard
+def close_keyboard(x_start: 100, y_start: 150)
   if keyboard_visible?
-    pan_coordinates({x: 100, y: 150}, {x: 100, y: 250})
+    pan_coordinates({x: x_start, y: y_start}, {x: x_start, y: y_start+100})
   end
 end
 

data/lib/SurfCustomCalabash/version.rb

@@ -1,3 +1,3 @@
 module SurfCustomCalabash
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/sources/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'calabash-android'
+gem 'cucumber'
+gem 'calabash-cucumber'
+gem 'require_all'
+gem 'rake'
+gem 'pry'
+gem 'parallel_calabash'
+gem 'json', '1.8.6'
+gem 'test-unit'
+gem 'CFPropertyList', '2.2.8'
+gem 'rest-client'
+gem 'syntax'
+gem 'httpclient', '2.8.3'
+gem 'run_loop', '>=4.4.1'
+gem 'SurfCustomCalabash'
+gem 'open3'
+gem 'timeout'
+gem 'process'
+gem 'rspec'
+gem 'streamio-ffmpeg'
+

data/sources/Scripts/and.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo "===== RUNNING TEST SUITE ANDROID====================="
+calabash-android run L.apk  -p android
+

data/sources/Scripts/ca.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo "===== RUNNING TEST CONSOLE ANDROID ====================="
+
+calabash-android console L.apk

data/sources/Scripts/ci.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo "===== RUNNING TEST CONSOLE IOS ====================="
+calabash-ios console
+

data/sources/Scripts/data

@@ -0,0 +1,7 @@
+login enter_login
+jira_pass enter_pass
+project_key enter_project_key
+project_name_jenkins enter_project_name
+jenkins_pass enter_jenkins_pass
+key_execution_and enter_key_test_exec
+key_execution_ios enter_key_test_exec

data/sources/Scripts/fa.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+echo "===== RUNNING TEST SUITE ANDROID====================="
+echo "$1"
+calabash-android run L.apk -p android features/scenarios/$1
+

data/sources/Scripts/fi.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo "===== RUNNING TEST SUITE IOS ====================="
+cucumber -p ios features/scenarios/$1
+

data/sources/Scripts/get_apk.rb

@@ -0,0 +1,68 @@
+require 'rest-client'
+require 'base64'
+require 'nokogiri'
+require 'open-uri'
+
+class GetApk
+
+  def initialize(path)
+    # хэш со всеми данными из файла scripts/data
+    @all_data = get_all_data
+
+    # название проекта в дженкинсе
+    @project = @all_data['project_name_jenkins']
+
+    # название джоба для сборки в дженкинсе
+    @job_name = "#{@project}_Android_TAG"
+
+    # адрес дженкинса
+    @host = "https://jenkins.surfstudio.ru/view/Projects/view/#{@project}/job/#{@job_name}/lastSuccessfulBuild"
+
+    # логин в дженкинсе
+    @login = @all_data['login']
+
+    # пароль дженкинса
+    @password = @all_data['jenkins_pass']
+
+    # путь до папки с автотестами
+    @path = path
+
+    # токен в дженкинсе
+    @auth = 'Basic ' + Base64.encode64( "#{@login}:#{@password}" ).chomp
+  end
+
+  # считываем данные пользователя из файла
+  def get_all_data
+    Hash[*File.read("#{@path}scripts/data").split(/[, \n]+/)]
+  end
+
+  def get_path_to_apk
+    url = "#{@host}/api/xml?tree=artifacts%5BrelativePath%5D"
+
+    response = RestClient.get url, {:Authorization => @auth}
+
+    xml_parse = Nokogiri::XML(response)
+
+    all_path = xml_parse.xpath("//relativePath")
+
+    all_path.each do |path|
+      @path_to_apk = path.content unless path.content[/qa.*\.apk$/].nil?
+    end
+
+    Kernel.puts(@path_to_apk)
+
+    return @path_to_apk
+  end
+
+  def download_apk
+    path = get_path_to_apk
+    url = "#{@host}/artifact/#{path}"
+
+    Kernel.puts('Start download')
+    File.open('L.apk', "wb") do |file|
+      file.write open(url, :http_basic_authentication => [@login, @password]).read
+    end
+
+    Kernel.puts('End download')
+  end
+end