SurfCustomCalabash 0.1.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 719a47490b3ee7c43b29dfff52939628a76d8a3e
-  data.tar.gz: 9f0a757d2fa132e512298c31fdd49ae5cba54257
+SHA256:
+  metadata.gz: 642a2175dd5be63af09865c3e401256600b92e24e9d81b7acebb6a3431356c5f
+  data.tar.gz: cb0842d72f0a04b435f422b928869cbaa84aca0a14db4ea028e4c07d88b9bfb2
 SHA512:
-  metadata.gz: d9093b915c8bf382758cf40fb47358ea73f910129ff397bd97337adb40365f4a8ceab6e018434c41d684a7edbfd5cb6e58bc7bcef8949520c920d70d0b9bb462
-  data.tar.gz: 3a7d4fea4a6cd56da9e1e351df84dc52f23714a01a81e6cc0754ba8c61431e0499bbd916495e5fe39956fa632925d31667563a7d03bcb5e6e1ac5f381bf36a4f
+  metadata.gz: adfc4a77d09b27c5b2abd6094a49981763d9cd4dae2c033fd6602936d9ba3953e260424665511ed61b1b4dd152674c898ebea1bfb262ee45583797c39bfab31c
+  data.tar.gz: 35c47618c702ccc856c0bc5dcfe8e5a8ffaaf259609dd6e8ff758dde008f33a116814c91bab2ea2e6db8dc6fdd0bcf8018d0f5d34d111844f810e557e8e257d6

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## v1.1.0 - 08.10.2020
+### Added
+- File **files_for_update** with a list of files required for updating in your project with autotests. For update your project use **SurfCustomCalabash update**
+
+### Changed
+- In command **SurfCustomCalabash gen** you can immediately enter the name of the folder with your tests
+
+
+## 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/Gemfile

@@ -6,4 +6,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem 'calabash-android'
-gem 'rspec/expectations'
+gem 'rspec/expectations'
+gem 'diffy'

data/README.md

@@ -21,11 +21,80 @@ 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 and execute command and then enter folder 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
+
+Shell script for useful launch all helpful scripts of folder above.
+
+### Update infrastructure files
+
+To check the relevance of the infrastructure files of your project with autotests, execute command:
 
-CommonMethods contains different methods (taps, swipes, waits and other) for both platforms.
+    $ SurfCustomCalabash update
 
+If your project has files that are not up-to-date, you will be prompted to update them all or only those you need.

data/SurfCustomCalabash.gemspec

@@ -6,7 +6,7 @@ require "SurfCustomCalabash/version"
 Gem::Specification.new do |spec|
   spec.name          = "SurfCustomCalabash"
   spec.version       = SurfCustomCalabash::VERSION
-  spec.authors       = ["Alexey Hripunov"]
+  spec.authors       = ["Alexey Hripunov", "Igor Tolubaev"]
   spec.email         = ["hripunov@surfstudio.ru"]
 
   spec.summary       = "Custom methods for calabash ios and android"
@@ -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,63 @@
+#!/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, "features")
+@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
+    when 'update'
+      require File.join(File.dirname(__FILE__), "update_files")
+      if File.exists?(@hierarchy)
+        show_files_for_update
+      else
+        Kernel.puts("В текущей папке нет файлов автотестов, перейдите в нужную папку или создайте новый проект используя команду:")
+        Kernel.puts("SurfCustomCalabash gen")
+      end
+    else
+      Kernel.puts "Invalid command '#{cmd}'"
+      print_usage
+  end
+end

data/bin/files_for_update

@@ -0,0 +1,7 @@
+/sources/features/android/support
+/sources/features/ios/support
+/sources/features/net/screentest_api.rb
+/sources/Scripts
+/sources/find_id.rb
+/sources/group_steps.rb
+/sources/start.sh

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,19 @@
+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 hit return to confirm that's what you want."
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+
+  Kernel.puts("Please enter name autotest project:")
+  file_name = gets.chomp
+  file_name = "Change_it_to_your_own_project_name" if file_name == ""
+  FileUtils.cp_r(@source_dir, File.join(FileUtils.pwd, file_name))
+  msg("Info") do
+      Kernel.puts "hierarchy was created. \n"
+  end
+end

data/bin/surf-calabash-helpers.rb

@@ -0,0 +1,36 @@
+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.
+    update
+      update infrastructure files in your project
+    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/bin/update_files.rb

@@ -0,0 +1,202 @@
+require 'fileutils'
+require 'diffy'
+
+# for compare files use gem diffy https://github.com/samg/diffy
+
+CUR_FOLDER = FileUtils.pwd
+
+GEM_FOLDER = File.dirname(__FILE__)
+
+# list files for update
+FILES_FOR_UPDATE = File.join(GEM_FOLDER, 'files_for_update')
+
+# path to data file
+DATA_FILE = "/Scripts/data"
+
+# read from file, files that need update
+def read_file_to_arr(path_to_file)
+  arr_lines = Array.new
+  text = File.open(path_to_file).read
+  text.each_line do |line|
+    line.gsub!(/\n/, "")
+    arr_lines.push(line)
+  end
+  return arr_lines
+end
+
+# get list files from sourcec folder in gem
+def get_list_files_for_update
+  list_files = read_file_to_arr(FILES_FOR_UPDATE)
+  all_files = Array.new
+
+  list_files.each do |name|
+    path = File.join(GEM_FOLDER, '..', name)
+    if File.file?(path)
+      all_files.push(path)
+    elsif File.directory?(path)
+      Dir["#{path}/*"].each {|pth| all_files.push(pth)}
+    end
+  end
+
+  return all_files
+end
+
+# trim folder sources from path
+def get_list_for_search
+  all_files = get_list_files_for_update
+
+  all_files.each do |name|
+    name.sub! /.*sources/, ''
+  end
+
+  return all_files
+end
+
+# search files, then not exist in autotest folder
+def search_not_exists_files
+  not_exists_files = Array.new
+  get_list_for_search.each do |name|
+    not_exists_files.push(name) unless File.file?(CUR_FOLDER + name)
+  end
+
+  return not_exists_files
+end
+
+# search files, then exist in autotest folder
+def search_exists_files
+  exists_files = Array.new
+  get_list_for_search.each do |name|
+    exists_files.push(name) if File.file?(CUR_FOLDER + name)
+  end
+
+  # exclude file data from list, then to don't erase user data
+  exclude_str_from_arr(exists_files, DATA_FILE)
+  return exists_files
+end
+
+# copy files from gem to autotest folder
+def copy_files(list_for_copy)
+  list_for_copy.each do |name|
+    FileUtils.mkdir_p File.dirname(CUR_FOLDER + name)
+    FileUtils.cp(File.join(GEM_FOLDER, '../sources', name), File.dirname(CUR_FOLDER + name))
+  end
+end
+
+# add ccs style in html-report for readability
+def add_css_style(file)
+  file.puts("<style>")
+  file.puts(Diffy::CSS)
+  file.puts("</style>")
+end
+
+# compare files from gem and autotest folder
+# the result would be html file with differences in compare folder
+def compare_files
+  need_copy = Array.new
+  FileUtils.rm_rf(Dir[File.join(CUR_FOLDER, '/compare/*')])
+  search_exists_files.each do |name|
+    compare_result = Diffy::Diff.new(File.dirname(CUR_FOLDER + name), File.join(GEM_FOLDER, '../sources', name), :source => 'files', :format => :html)
+    unless compare_result.to_s(:text).empty?
+      need_copy.push(name)
+      FileUtils.mkdir_p 'compare'
+      File.open(File.join(CUR_FOLDER, '/compare/', "#{File.basename(name, ".*")}.html"), "w:UTF-8") do |file|
+        add_css_style(file)
+        file.puts(compare_result.to_s(:html))
+      end
+    end
+  end
+
+  return need_copy
+end
+
+# delete from array element match str_name
+def exclude_str_from_arr(input_arr, str_name)
+  result_arr = input_arr
+  need_del = result_arr.select { |el| el.include? str_name}
+  need_del.each do |value|
+    result_arr.delete(value)
+  end
+end
+
+# show files, then don't exixst in autotest folder
+def show_files_ready_for_copy
+  unless search_not_exists_files.empty?
+    Kernel.puts("Файлы которых нет в текущей папке с автотестами и они будут добавлены:")
+    Kernel.puts search_not_exists_files
+    Kernel.puts("\n")
+  end
+end
+
+# exclude files from list, then don't need update
+def excludes_files_for_update(input_arr, list_files)
+  all_files = list_files.split(/,\s*/)
+  list_files_for_update = input_arr
+  all_files.each do |name|
+    exclude_str_from_arr(list_files_for_update, name)
+  end
+
+  return list_files_for_update
+end
+
+# show files, then need update and update them
+def show_files_for_update
+  Kernel.puts("\n")
+
+  new_files = search_not_exists_files
+  exist_files = compare_files
+
+  if !new_files.empty? && exist_files.empty?
+    show_files_ready_for_copy
+    Kernel.puts("Скопировать все файлы? (y/n)")
+    answer = gets
+
+    if answer == "y\n"|| answer == "\n"
+      copy_files(new_files)
+      Kernel.puts("Файлы успешно добавлены!")
+    end
+  elsif !exist_files.empty?
+    show_files_ready_for_copy
+    Kernel.puts("Файлы которые уже есть в текущей папки с автотестами, но требуют обновления:")
+    Kernel.puts exist_files
+    Kernel.puts("\n")
+    Kernel.puts("Все изменения в указанных файлах можно посмотреть в папке compare")
+    Kernel.puts("Для каждого файла создан html-отчет с отображением изменений")
+    Kernel.puts("\n")
+    Kernel.puts("Скопировать все файлы или исключить некоторые файлы из обновления?")
+    Kernel.puts("1 - Скопировать все файлы")
+    Kernel.puts("2 - Исключить файлы из обновления")
+    answer = gets.chomp
+
+    if answer == "1"
+      copy_files(new_files)
+      copy_files(exist_files)
+      Kernel.puts("Файлы успешно добавлены!")
+    elsif answer == "2"
+      Kernel.puts("Введите в одной строке через запятую имена файлов, которые надо исключить из обновления:")
+      file_names = gets.chomp
+      files_for_update = excludes_files_for_update(exist_files,file_names)
+
+      if !files_for_update.empty? || !new_files.empty?
+        Kernel.puts("Список файлов для обновления:")
+        Kernel.puts files_for_update
+        Kernel.puts new_files
+        Kernel.puts("Скопировать все файлы? (y/n)")
+        answer = gets
+
+        if answer == "y\n"|| answer == "\n"
+          copy_files(new_files)
+          copy_files(files_for_update)
+          Kernel.puts("Файлы успешно добавлены!")
+        end
+      else
+        Kernel.puts("Нет файлов для обновлений!")
+      end
+    end
+  end
+
+  if new_files.empty? && compare_files.empty?
+    Kernel.puts("В текущей папке все инфраструктурные файлы актуальны!")
+  end
+
+  Kernel.puts("\n")
+end