sunomono 0.2.0.pre

data/lib/skeleton/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/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/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/features/android/support/app_installation_hooks.rb

@@ -0,0 +1,36 @@
+require 'calabash-android/management/app_installation'
+
+AfterConfiguration do
+  FeatureMemory.feature = nil
+end
+
+Before('@reinstall') do
+  uninstall_apps
+  install_app(ENV['TEST_APP_PATH'])
+  install_app(ENV['APP_PATH'])
+end
+
+Before do |scenario|
+  scenario = scenario.scenario_outline if
+    scenario.respond_to?(:scenario_outline)
+
+  feature = scenario.feature
+  if FeatureMemory.feature != feature || ENV['RESET_BETWEEN_SCENARIOS'] == '1'
+    if ENV['RESET_BETWEEN_SCENARIOS'] == '1'
+      log 'New scenario - reinstalling apps'
+    else
+      log 'First scenario in feature - reinstalling apps'
+    end
+
+    uninstall_apps
+    install_app(ENV['TEST_APP_PATH'])
+    install_app(ENV['APP_PATH'])
+
+    FeatureMemory.feature = feature
+    FeatureMemory.invocation = 1
+  else
+    FeatureMemory.invocation += 1
+  end
+end
+
+FeatureMemory = Struct.new(:feature, :invocation).new

data/lib/skeleton/features/android/support/app_life_cycle_hooks.rb

@@ -0,0 +1,11 @@
+require 'calabash-android/management/adb'
+require 'calabash-android/operations'
+
+Before do
+  start_test_server_in_background
+end
+
+After do |scenario|
+  screenshot_embed if scenario.failed?
+  shutdown_test_server
+end

data/lib/skeleton/features/ios/support/01_launch.rb

@@ -0,0 +1,94 @@
+########################################
+#                                      #
+#       Important Note                 #
+#                                      #
+#   When running calabash-ios tests at #
+#   www.xamarin.com/test-cloud         #
+#   the  methods invoked by            #
+#   CalabashLauncher are overridden.   #
+#   It will automatically ensure       #
+#   running on device, installing apps #
+#   etc.                               #
+#                                      #
+########################################
+
+require 'calabash-cucumber/launcher'
+
+module Calabash::Launcher
+  @@launcher = nil
+  def self.launcher
+    @@launcher ||= Calabash::Cucumber::Launcher.new
+  end
+
+  def self.launcher=(launcher)
+    @@launcher = launcher
+  end
+end
+
+AfterConfiguration do
+  FeatureMemory.feature = nil
+end
+
+Before do |scenario|
+  launcher = Calabash::Launcher.launcher
+  # Relaunch options
+  options = { timeout: 3000 }
+
+  scenario = scenario.scenario_outline if
+    scenario.respond_to?(:scenario_outline)
+  feature = scenario.feature
+
+  scenario_tags = scenario.source_tag_names
+  if FeatureMemory.feature != feature ||
+     ENV['RESET_BETWEEN_SCENARIOS'] == '1' ||
+     scenario_tags.include?('@reinstall')
+    reinstall_app
+    # Reset app if it is a new feature
+    options[:reset] = true
+
+    FeatureMemory.feature = feature
+    FeatureMemory.invocation = 1
+  else
+    FeatureMemory.invocation += 1
+  end
+
+  FeatureMemory.feature = feature
+  FeatureMemory.invocation = 1
+
+  launcher.relaunch(options)
+  # Avoid resetting when is not necessary
+  options[:reset] = false
+end
+
+After do
+  calabash_exit if launcher.quit_app_after_scenario?
+end
+
+def device?
+  # Check if UUID (ENV['DEVICE_TARGET']) is from a device or a simulator
+  # Getting all the simulator's UUID
+  uuids = `xcrun simctl list`
+  return false if uuids.include? ENV['DEVICE_TARGET']
+  return true
+end
+
+def reinstall_app
+  if device?
+    system "echo 'Installing the app...'"
+    # Trying to reinstall the app
+    success = system "ios-deploy -r -b #{ENV['APP_BUNDLE_PATH']} -i #{ENV['DEVICE_TARGET']} -t 5 > /dev/null"
+
+    # If the app is not installed the above command will throw an error
+    # So we just install the app
+    unless success
+      success = system "ios-deploy -b #{ENV['APP_BUNDLE_PATH']} -i #{ENV['DEVICE_TARGET']} -t 5 > /dev/null"
+      fail 'Error. Could not install the app.' unless
+        success # If there is any error raises an exception
+    end
+
+    system "echo 'Installed.'"
+    sleep(3) # Gives a time to finish the installation of the app in the device
+  end
+end
+
+FeatureMemory = Struct.new(:feature, :invocation).new

data/lib/skeleton/features/support/env.rb

@@ -0,0 +1,5 @@
+if ENV['PLATFORM'] == 'ios'
+  require 'calabash-cucumber/cucumber'
+elsif ENV['PLATFORM'] == 'android'
+  require 'calabash-android/cucumber'
+end

data/lib/skeleton/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.rb

@@ -0,0 +1,238 @@
+require 'sunomono/version'
+
+require 'thor'
+require 'thor/group'
+require 'i18n'
+require 'gherkin' # Used here as a translation source
+require 'json'
+require 'yaml'
+
+require_relative File.join('helpers', 'sunomono_helpers')
+
+module Sunomono
+  # Definition of all gem generators
+  class Generate < Thor
+    include Thor::Actions
+
+    desc 'feature [RESOURCE_NAME]', 'Generates an OS independent feature'
+    option :lang,
+           banner: 'any of the gherkin supported languages',
+           default: :en
+    def feature(name)
+      I18n.config.default_locale = options[:lang]
+      in_root_project_folder?
+
+      create_feature_file(name)
+      create_steps_file name
+      create_screen_file name, 'Android'
+      create_screen_file name, 'IOS'
+    end
+
+    desc 'android-feature [RESOURCE_NAME]',
+         'Generates an Android dependent feature'
+    option :lang,
+           banner: 'any of the gherkin supported languages',
+           default: :en
+    def android_feature(name)
+      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'
+    end
+
+    desc 'ios-feature [RESOURCE_NAME]', 'Generates an iOS dependent feature'
+    option :lang,
+           banner: 'any of the gherkin supported languages',
+           default: :en
+    def ios_feature(name)
+      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'
+    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?
+      create_steps_file name
+    end
+
+    desc 'android-step [RESOURCE_NAME]', 'Generates an Android dependent step'
+    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?
+      create_steps_file name, 'Android'
+    end
+
+    desc 'ios-step [RESOURCE_NAME]', 'Generates an iOS dependent step'
+    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]',
+         'Generates the Android and iOS dependent screens'
+    option :lang,
+           banner: 'any of the gherkin supported languages',
+           default: :en
+    def screen(name)
+      I18n.config.default_locale = options[:lang]
+      in_root_project_folder?
+      create_screen_file name, 'Android'
+      create_screen_file name, 'IOS'
+    end
+
+    desc 'android-screen [RESOURCE_NAME]',
+         'Generates an Android dependent screen'
+    option :lang,
+           banner: 'any of the gherkin supported languages',
+           default: :en
+    def android_screen(name)
+      I18n.config.default_locale = options[:lang]
+      in_root_project_folder?
+      create_screen_file name, 'Android'
+    end
+
+    desc 'ios-screen [RESOURCE_NAME]', 'Generates an iOS dependent screen'
+    option :lang,
+           banner: 'any of the gherkin supported languages',
+           default: :en
+    def ios_screen(name)
+      I18n.config.default_locale = options[:lang]
+      in_root_project_folder?
+      create_screen_file name, 'IOS'
+    end
+
+    desc 'aws-zip', 'Prepare a zip file for AWS Device Farm execution'
+    option 'skip-char-validation',
+           banner: 'skips the special chars validation that can cancel the zip creation',
+           type: :boolean,
+           lazy_default: true
+    def aws_zip
+      in_root_project_folder?
+
+      special_chars_in_exported_path? unless options['skip-char-validation']
+
+      # Temp folder that will hold the project files to be zipped
+      dir = Dir.mktmpdir
+      begin
+        copy_all_project_files(dir)
+        create_screen_shot_dirs(dir)
+        # Creating zip file
+        create_zip_folder(dir)
+      ensure
+        # remove the directory.
+        FileUtils.remove_entry_secure dir
+      end
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), '..', 'lib', 'templates')
+    end
+  end
+end
+
+module Sunomono
+  # Definition of the generators groups
+  class SunomonoRunner < Thor
+    include Thor::Actions
+
+    map '-v' => :version
+    map '--version' => :version
+
+    default_task :help
+
+    register Sunomono::Generate, 'generate',
+             'generate [GENERATOR] [RESOURCE_NAME]',
+             'Generates various resources'
+    register Sunomono::Generate, 'g',
+             'g [GENERATOR] [RESOURCE_NAME]',
+             'Generates various resources'
+
+    desc 'new PROJECT_NAME',
+         'Generates the structure of a new project that uses '\
+         'Calabash in both Android and iOS apps'
+    option :lang,
+           banner: 'any of the gherkin supported languages',
+           default: :en
+    def new(name)
+      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
+
+      # 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 ios screen base file with localization
+      template('ios_screen_base',
+               File.join(name, 'features', 'ios', 'ios_screen_base.rb'))
+    end
+
+    desc 'version', 'Shows the gem version'
+    def version
+      puts "Sunomono Version #{Sunomono::VERSION}"
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), '..', 'lib', 'templates')
+    end
+
+    # Overriding the initialize method to load all the
+    # translations supported by the gem gherkin
+    def initialize(*args)
+      super
+      # Loading gherkin accepted translations
+      translations_file_path = File.join(
+        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(/\|.*\"/, '"')
+      )
+      # Converting the translations to YAML and storing in a temp file
+      translations_temp_file = Tempfile.new(['translations', '.yml'])
+      File.write(translations_temp_file, translations_json.to_yaml)
+      # Loading the translations from gherkin and from the
+      # locales folder of this gem
+      locales_folder_path = File.join(
+        File.dirname(__FILE__),
+        '..', 'lib', 'sunomono', 'locales'
+      )
+      I18n.load_path = Dir[
+        translations_temp_file,
+        File.join(locales_folder_path, '*.yml')
+      ]
+      I18n.backend.load_translations
+      I18n.config.enforce_available_locales = true
+    end
+  end
+end