sunomono 0.3.1 → 1.0.0

data/lib/skeleton_calabash/config/scripts/android/stop_emulators.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+# Author: Victor Nascimento
+
+SUFFIX=CALABASH_AVD_4.
+
+for AVD in $HOME/.android/avd/${SUFFIX}*.avd
+do 
+    AVD="$(basename ${AVD/.avd/})" 
+    echo chuck killing "$AVD"... 
+    pkill -9 -f "$AVD"
+done
+
+

data/lib/skeleton_calabash/config/scripts/break_build_if_failed.sh

@@ -0,0 +1,6 @@
+# Looking for errors on the report files and returns an error
+if [ $TESTS_RESULT == "Failed" ] 
+then
+    echo "Setting build as failed"
+    exit 1
+fi

data/lib/skeleton_calabash/config/scripts/check_if_tests_failed.sh

@@ -0,0 +1,11 @@
+# Looking for errors on the report files and returns an error
+cd "$WORKSPACE/reports-cal"
+
+export TESTS_RESULT="Ok"
+for folder in *
+do
+    if egrep '[0-9]+ failed' "$folder/reports.html"
+    then
+	export TESTS_RESULT="Failed"
+    fi
+done

data/lib/skeleton_calabash/config/scripts/ios/build_app.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+# ----------------------------------------------------------------------------
+#
+# $1 -> configuration environment (dev or jenkins)
+#
+#
+# REMEMBER to fill the configuration file build_app.yml
+
+require 'fileutils'
+require 'yaml'
+require 'pathname'
+
+# When running on CI
+# It is a good pratice to run pod install when executing this script
+# on the CI to avoid building problems
+# %x(pod install)
+
+# Parsing the yaml configuration file
+config = YAML.load_file(File.join(File.dirname(__FILE__), 'build_app.yml'))
+
+if ARGV.length != 1
+  puts 'Error: Wrong number of arguments!'
+  puts 'Usage: build_app.rb environment'
+  puts "Available Environments: #{config.keys.join(', ')}"
+  exit 1
+end
+
+if config[ARGV[0]].nil?
+  puts 'Error: Wrong configuration environment!'
+  puts "Available Environments: #{config.keys.join(', ')}"
+  exit 1
+else
+  config = config[ARGV[0]]
+end
+
+puts "Starting at #{Time.now.strftime('%H:%M:%S')}"
+
+# Creating a folder name from the destination configuration parameter
+folder_name = config['destination'].gsub('platform=', '').gsub('name=', '')
+              .tr(' ', '_').tr(',', '_')
+export_path = File.join(config['export_path'], folder_name)
+
+# Removing the folder where the .app will be stored if it already exists
+FileUtils.rm_r export_path if Dir.exist?(export_path)
+
+# Creating the folder where the .app will be stored
+FileUtils.mkdir_p export_path
+
+puts 'Building project'
+
+system <<eos
+  xcodebuild -workspace "#{config['xcworkspace']}" \
+  -scheme "#{config['scheme']}" -destination "#{config['destination']}" \
+  -configuration "#{config['configuration']}" clean build \
+  CONFIGURATION_BUILD_DIR="#{export_path}" | xcpretty
+eos
+
+# Getting the app folder that was created
+# Listing all folders on the export path folder
+folders = Pathname.new(export_path).children.select { |c| c.directory? }
+# Getting the folder which ends with .app
+app_pathname = folders.select { |f| f.to_s.match('.app$') }
+# Getting the app folder path
+app_path = app_pathname.first.to_s
+
+# Printing the APP_BUNDLE_PATH in the terminal
+puts "APP_BUNDLE_PATH=#{app_path}"
+
+puts "End: #{Time.now.strftime('%H:%M:%S')}"
+puts 'Bye!'

data/lib/skeleton_calabash/config/scripts/ios/build_app.yml

@@ -0,0 +1,13 @@
+dev:
+  xcworkspace: "Path_to_the_xcworkspace_folder"
+  scheme: TargetName
+  configuration: Debug
+  destination: "platform=iOS Simulator,name=iPhone 6"
+  export_path: "Path_to_export_app_folder"
+
+jenkins:
+  xcworkspace: <%= ENV['WORKSPACE']%>/Project.xcworkspace
+  scheme: TargetName
+  configuration: Debug
+  destination: "Any_platform_or_device_that_you_want"
+  export_path: <%= ENV['WORKSPACE']%>/releases/normal

data/lib/skeleton_calabash/config/scripts/ios/devices.txt

@@ -0,0 +1,4 @@
+# <DEVICE_TARGET (UUID)> | <DEVICE_ENDPOINT (IP)> | <DEVICE_NAME> | <DEVICE_TYPE> (Simulator or Device)
+000...000 | http://localhost:37265 | Device0 | Simulator
+111...111 | http://1.1.1.1:37265 | Device1 | Device
+# EOF - Never erase this comment or the script will have problems to read this file

data/lib/skeleton_calabash/config/scripts/ios/run_tests_all_devices.sh

@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+# ----------------------------------------------------------------------------
+# Uncomment the next line to enable debug
+# set -x
+#
+# $1 -> parameter with the path of the .app bundle for simulators
+# $2 -> parameter with the path of the .app bundle for devices
+
+## CODE BEGIN  #############################################################
+export LC_ALL="en_US.UTF-8"
+echo Start: $(date)
+
+# Exits if the app path was not informed
+[ $# -lt 2 ] && echo "Wrong number of parameters." && exit 1
+
+# Creating the reports path
+reports_path="$WORKSPACE/reports-cal"
+mkdir $reports_path
+
+# Changing relative to absolute path if that is the case
+# The simulator path
+original_path="$(pwd)" # Saving the original path where the command was executed
+cd "$1"
+SIMULATOR_APP_PATH="$(pwd)"
+# The device path
+cd "$original_path"
+cd "$2"
+DEVICE_APP_PATH="$(pwd)"
+
+cd $WORKSPACE # All tests should run from the root folder of the tests project
+
+cat config/scripts/ios/devices.txt |  ## Reading the devices.txt file
+grep -v "#" | ## Removing the command lines
+tr -d " " | ## Trimming all the spaces
+while IFS='|' read UUID IP NAME TYPE ## Defining pipe as the separator char and reading the three variable fields
+do 
+    # Creating the report folder for this device or simulator
+    mkdir "$reports_path"/"$NAME"
+
+    if [ $TYPE == "Simulator" ]
+    then
+	APP_PATH=$SIMULATOR_APP_PATH
+    else
+	APP_PATH=$DEVICE_APP_PATH
+    fi
+    
+    # Executing calabash for the device or simulator
+    APP_BUNDLE_PATH="$APP_PATH" DEVICE_TARGET="$UUID" DEVICE_ENDPOINT="$IP" cucumber -p ios SCREENSHOT_PATH="$reports_path"/"$NAME"/ -f 'Calabash::Formatters::Html' -o "$reports_path"/"$NAME/reports.html" -f junit -o "$reports_path"/"$NAME"
+
+    # Calabash has a problem with images relative path, the command above will replace all the images path on the
+    # html report file to be a relative path
+    sed -i.bak 's|'"$reports_path"/"$NAME"/'||g' "$reports_path"/"$NAME"/reports.html
+done
+
+echo End: $(date)
+echo 'Bye!'
+## CODE END  #############################################################

data/lib/skeleton_calabash/features/support/exceptions.rb

@@ -0,0 +1,11 @@
+class UnexpectedPageError < StandardError
+end
+
+class TouchElementError < StandardError
+end
+
+class ElementNotFoundError < StandardError
+end
+
+class ElementFoundError < StandardError
+end

data/lib/sunomono/version.rb

@@ -1,3 +1,3 @@
 module Sunomono
-  VERSION = '0.3.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/sunomono.rb

@@ -14,11 +14,12 @@ module Sunomono
   class Generate < Thor
     include Thor::Actions
 
-    desc 'feature [RESOURCE_NAME]', 'Generates an OS independent feature'
+    desc 'calabash_feature [RESOURCE_NAME]', 'Generates an OS independent feature'
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
-    def feature(name)
+
+    def calabash_feature(name)
       I18n.config.default_locale = options[:lang]
       in_root_project_folder?
 
@@ -28,37 +29,72 @@ module Sunomono
       create_screen_file name, 'IOS'
     end
 
-    desc 'android-feature [RESOURCE_NAME]',
+    desc 'appium_feature [RESOURCE_NAME]', 'Generates an OS independent feature'
+    option :lang,
+           banner: 'any of the gherkin supported languages',
+           default: :en
+
+    def appium_feature(name)
+      I18n.config.default_locale = options[:lang]
+      in_root_project_folder?
+
+      create_feature_file(name)
+      create_steps_file name
+      create_appium_screen_file name, 'Android'
+      create_appium_screen_file name, 'IOS'
+    end
+
+    desc 'android-feature [FRAMEWORK(calabash or appium)] [RESOURCE_NAME]',
          'Generates an Android dependent feature'
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
-    def android_feature(name)
+
+    def android_feature(framework, name)
+      framework_avaliable?(framework)
+
       I18n.config.default_locale = options[:lang]
       in_root_project_folder?
 
-      create_feature_file name, 'Android'
-      create_steps_file name, 'Android'
-      create_screen_file name, 'Android'
+      if framework.downcase == 'calabash'
+        create_feature_file name, 'Android'
+        create_steps_file name, 'Android'
+        create_screen_file name, 'Android'
+      else
+        create_feature_file name, 'Android'
+        create_steps_file name, 'Android'
+        create_appium_screen_file name, 'Android'
+      end
     end
 
-    desc 'ios-feature [RESOURCE_NAME]', 'Generates an iOS dependent feature'
+    desc 'ios-feature [FRAMEWORK(calabash or appium)] [RESOURCE_NAME]',
+         'Generates an iOS dependent feature'
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
-    def ios_feature(name)
+
+    def ios_feature(framework, name)
+      framework_avaliable?(framework)
+
       I18n.config.default_locale = options[:lang]
       in_root_project_folder?
 
-      create_feature_file name, 'IOS'
-      create_steps_file name, 'IOS'
-      create_screen_file name, 'IOS'
+      if framework.downcase == 'calabash'
+        create_feature_file name, 'IOS'
+        create_steps_file name, 'IOS'
+        create_screen_file name, 'IOS'
+      else
+        create_feature_file name, 'IOS'
+        create_steps_file name, 'IOS'
+        create_appium_screen_file name, 'IOS'
+      end
     end
 
     desc 'step [RESOURCE_NAME]', 'Generates an OS independent step'
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
+
     def step(name)
       I18n.config.default_locale = options[:lang]
       in_root_project_folder?
@@ -69,6 +105,7 @@ module Sunomono
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
+
     def android_step(name)
       I18n.config.default_locale = options[:lang]
       in_root_project_folder?
@@ -79,43 +116,70 @@ module Sunomono
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
+
     def ios_step(name)
       I18n.config.default_locale = options[:lang]
       in_root_project_folder?
       create_steps_file name, 'IOS'
     end
 
-    desc 'screen [RESOURCE_NAME]',
+    desc 'screen [FRAMEWORK(calabash or appium)] [RESOURCE_NAME]',
          'Generates the Android and iOS dependent screens'
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
-    def screen(name)
+
+    def screen(framework, name)
+      framework_avaliable?(framework)
+
       I18n.config.default_locale = options[:lang]
       in_root_project_folder?
-      create_screen_file name, 'Android'
-      create_screen_file name, 'IOS'
+
+      if framework.downcase == 'calabash'
+        create_screen_file name, 'Android'
+        create_screen_file name, 'IOS'
+      else
+        create_appium_screen_file name, 'Android'
+        create_appium_screen_file name, 'IOS'
+      end
     end
 
-    desc 'android-screen [RESOURCE_NAME]',
+    desc 'android-screen [FRAMEWORK(calabash or appium)] [RESOURCE_NAME]',
          'Generates an Android dependent screen'
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
-    def android_screen(name)
+
+    def android_screen(framework ,name)
+      framework_avaliable?(framework)
+
       I18n.config.default_locale = options[:lang]
       in_root_project_folder?
-      create_screen_file name, 'Android'
+
+      if framework.downcase == 'calabash'
+        create_screen_file name, 'Android'
+      else
+        create_appium_screen_file name, 'Android'
+      end
     end
 
-    desc 'ios-screen [RESOURCE_NAME]', 'Generates an iOS dependent screen'
+    desc 'ios-screen [FRAMEWORK(calabash or appium)] [RESOURCE_NAME]',
+         'Generates an iOS dependent screen'
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
-    def ios_screen(name)
+
+    def ios_screen(framework ,name)
+      framework_avaliable?(framework)
+
       I18n.config.default_locale = options[:lang]
       in_root_project_folder?
-      create_screen_file name, 'IOS'
+
+      if framework.downcase == 'calabash'
+        create_screen_file name, 'IOS'
+      else
+        create_appium_screen_file name, 'IOS'
+      end
     end
 
     desc 'aws-zip', 'Prepare a zip file for AWS Device Farm execution'
@@ -123,6 +187,7 @@ module Sunomono
            banner: 'skips the special chars validation that can cancel the zip creation',
            type: :boolean,
            lazy_default: true
+
     def aws_zip
       in_root_project_folder?
 
@@ -164,30 +229,52 @@ module Sunomono
              'g [GENERATOR] [RESOURCE_NAME]',
              'Generates various resources'
 
-    desc 'new PROJECT_NAME',
+    desc 'new FRAMEWORK(calabash or appium) PROJECT_NAME',
          'Generates the structure of a new project that uses '\
-         'Calabash in both Android and iOS apps'
+         'Calabash or Appium in both Android and iOS apps'
     option :lang,
            banner: 'any of the gherkin supported languages',
            default: :en
-    def new(name)
+
+    def new(platform, name)
+      if platform != 'calabash' && platform != 'appium'
+        puts "#{platform} is a invalid platform, please type calabash or appium"
+        exit 1
+      end
+
       I18n.config.default_locale = options[:lang]
       # Thor will be responsible to look for identical
       # files and possibles conflicts
-      directory File.join(File.dirname(__FILE__),
-                          '..', 'lib', 'skeleton'), name
+      if platform.downcase == 'calabash'
+        directory File.join(File.dirname(__FILE__),
+                            '..', 'lib', 'skeleton_'+ platform.to_s), name
 
-      # Copying base steps file with localization
-      template('base_steps', File.join(name, 'features', 'step_definitions',
-                                       'base_steps.rb'))
+        # Copying base steps file with localization
+        template('base_steps', File.join(name, 'features', 'step_definitions',
+                                         'base_steps.rb'))
 
-      # Copying android screen base file with localization
-      template('android_screen_base', File.join(name, 'features', 'android',
-                                                'android_screen_base.rb'))
+        # Copying android screen base file with localization
+        template('android_screen_base', File.join(name, 'features', 'android',
+                                                  'android_screen_base.rb'))
 
-      # Copying ios screen base file with localization
-      template('ios_screen_base',
-               File.join(name, 'features', 'ios', 'ios_screen_base.rb'))
+        # Copying ios screen base file with localization
+        template('ios_screen_base',
+                 File.join(name, 'features', 'ios', 'ios_screen_base.rb'))
+      else
+        I18n.config.default_locale = options[:lang]
+        # Thor will be responsible to look for identical
+        # files and possibles conflicts
+        directory File.join(File.dirname(__FILE__),
+                            '..', 'lib', 'skeleton_'+ platform.to_s), name
+
+        # Copying base steps file with localization
+        template('appium_base_steps', File.join(name, 'features', 'step_definitions',
+                                                'base_steps.rb'))
+
+        # Copying screen base file with localization
+        template('appium_base_screen', File.join(name, 'features', 'base_screen',
+                                                 'base_screen.rb'))
+      end
     end
 
     desc 'version', 'Shows the gem version'
@@ -205,18 +292,18 @@ module Sunomono
       super
       # Loading gherkin accepted translations
       translations_file_path = File.join(
-        Gem.loaded_specs['gherkin'].full_gem_path,
-        'lib',
-        'gherkin',
-        'i18n.json'
+          Gem.loaded_specs['gherkin'].full_gem_path,
+          'lib',
+          'gherkin',
+          'i18n.json'
       )
       # Parsing the JSON file
       # Removing the sequence *| and all the alternative
       # options for the gherkin translations
       translations_json = JSON.parse(
-        File.read(translations_file_path)
-        .gsub(/\*\|/, '')
-        .gsub(/\|.*\"/, '"')
+          File.read(translations_file_path)
+              .gsub(/\*\|/, '')
+              .gsub(/\|.*\"/, '"')
       )
       # Converting the translations to YAML and storing in a temp file
       translations_temp_file = Tempfile.new(['translations', '.yml'])
@@ -224,12 +311,12 @@ module Sunomono
       # Loading the translations from gherkin and from the
       # locales folder of this gem
       locales_folder_path = File.join(
-        File.dirname(__FILE__),
-        '..', 'lib', 'sunomono', 'locales'
+          File.dirname(__FILE__),
+          '..', 'lib', 'sunomono', 'locales'
       )
       I18n.load_path = Dir[
-        translations_temp_file,
-        File.join(locales_folder_path, '*.yml')
+          translations_temp_file,
+          File.join(locales_folder_path, '*.yml')
       ]
       I18n.backend.load_translations
       I18n.config.enforce_available_locales = true

data/lib/templates/appium_base_screen.tt

@@ -0,0 +1,13 @@
+require 'appium_lib'
+
+class BaseScreen
+   def self.element(element_name, &block)
+     define_method(element_name.to_s, *block)
+   end
+
+   class << self
+     alias_method :value, :element
+     alias_method :action, :element
+     alias_method :trait, :element
+   end
+end

data/lib/templates/appium_base_steps.tt

@@ -0,0 +1,46 @@
+######### <%= I18n.translate( :given ).upcase %> #########
+<%= I18n.translate( :given ).capitalize %>(/^<%= I18n.translate( "steps.drag_until" ) %>$/) do |direction, element|
+    pending
+end
+
+<%= I18n.translate( :given ).capitalize %>(/^<%= I18n.translate( "steps.page_contains" ) %>$/) do |page_text|
+  pending
+end
+
+######### <%= I18n.translate( :when ).upcase %> #########
+
+<%= I18n.translate( :when ).capitalize %>(/^<%= I18n.translate( "steps.drag_number_of_times" ) %>$/) do |direction, times|
+  pending
+end
+
+<%= I18n.translate( :when ).capitalize %>(/^<%= I18n.translate( "steps.touch_element" ) %>$/) do |element|
+  pending
+end
+
+<%= I18n.translate( :when ).capitalize %>(/^<%= I18n.translate( "steps.drag_screen" ) %>$/) do |direction|
+  pending
+end
+
+<%= I18n.translate( :when ).capitalize %>(/^<%= I18n.translate( "steps.restart_app" ) %>$/) do
+  pending
+end
+
+######### <%= I18n.translate( :then ).upcase %> #########
+
+<%= I18n.translate( :then ).capitalize %>(/^<%= I18n.translate "steps.wait_progress_bar" %>$/) do
+  pending
+end
+
+<%= I18n.translate( :then ).capitalize %>(/^<%= I18n.translate "steps.should_see_page" %>$/) do |page_text|
+ pending
+end
+
+<%= I18n.translate( :then ).capitalize %>(/^<%= I18n.translate "steps.should_see_page_that_contains" %>$/) do |page_text|
+  pending
+end
+<% unless I18n.config.default_locale == :en %>
+
+<%= I18n.translate( :then ).capitalize %>(/^<%= I18n.translate "steps.take_print" %>$/) do
+  pending
+end
+<% end %>

data/lib/templates/appium_screen.tt

@@ -0,0 +1,7 @@
+class <%= config[:name] %>Screen < BaseScreen
+  # <%= I18n.translate 'comments.trait' %>
+  #trait(:trait)                 { "'#{layout_name}'" }
+# <%= I18n.translate 'comments.elements' %>
+  # element(:layout_name)         { pending 'Insert button identificator' }
+  # element(:button)              { pending 'Insert button identificator' }
+end