calabash 1.2.1 → 1.9.9.pre1

data/lib/calabash/cli/generate.rb

@@ -0,0 +1,110 @@
+require 'fileutils'
+
+module Calabash
+  # @!visibility private
+  module CLI
+    # @!visibility private
+    module Generate
+      def parse_generate_arguments!
+        type = @arguments.shift
+
+        if type.nil?
+          msg("Question") do
+            puts "Calabash is about to create a subdirectory called features and config,"
+            puts "features will contain all your calabash tests."
+            puts "Please hit return to confirm that's what you want."
+          end
+
+          unless STDIN.gets.chomp == ''
+            exit 2
+          end
+
+          if File.exist?('features')
+            puts "A features directory already exists. Please remove this to continue."
+            exit 1
+          end
+
+          if File.exist?('config')
+            puts "A config directory already exists. Please remove this to continue."
+            exit 1
+          end
+
+          reset_between = nil
+          reset_method = nil
+
+          puts "Do you want to reset the app by default? ((n)ever/between (s)cenarios/between (f)eatures) "
+          input = STDIN.gets.chomp.downcase
+
+          case input
+            when 'n'
+              reset_between = :never
+            when 's'
+              reset_between = :scenarios
+            when 'f'
+              reset_between = :features
+            else
+              puts "Invalid input '#{input}'"
+              exit(3)
+          end
+
+          unless reset_between == :never
+            puts "How would you like to reset the app by default? ((c)learing/(r)einstalling) "
+            input = STDIN.gets.chomp.downcase
+
+            case input
+              when 'c'
+                reset_method = :clear
+              when 'r'
+                reset_method = :reinstall
+              else
+                puts "Invalid input '#{input}'"
+                exit(4)
+            end
+          end
+
+          cucumber_config = File.read(file(File.join('config', 'cucumber.yml')))
+
+          env = File.read(file(File.join('features', 'support', 'env.rb')))
+          sample_feature = File.read(file(File.join('features', 'sample.feature')))
+          calabash_steps = File.read(file(File.join('features', 'step_definitions', 'calabash_steps.rb')))
+
+          hooks = File.read(file(File.join('features', 'support', 'hooks.rb')))
+          hooks.sub!("#!DEFAULT_RESET_BETWEEN#!", ":#{reset_between}")
+
+          if reset_method.nil?
+            hooks.sub!("#!DEFAULT_RESET_METHOD#!", 'nil')
+          else
+            hooks.sub!("#!DEFAULT_RESET_METHOD#!", ":#{reset_method}")
+          end
+
+          FileUtils.mkdir('config')
+
+          File.open(File.join('config', 'cucumber.yml'), 'w') {|file| file.write(cucumber_config) }
+
+          FileUtils.mkdir('features')
+          FileUtils.mkdir('features/step_definitions')
+          FileUtils.mkdir('features/support')
+
+          File.open(File.join('features', 'sample.feature'), 'w') {|file| file.write(sample_feature) }
+          File.open(File.join('features', 'step_definitions', 'calabash_steps.rb'), 'w') {|file| file.write(calabash_steps) }
+          File.open(File.join('features', 'support', 'hooks.rb'), 'w') {|file| file.write(hooks) }
+          File.open(File.join('features', 'support', 'env.rb'), 'w') {|file| file.write(env) }
+        else
+          fail("Invalid argument #{type}", :gen)
+        end
+      end
+
+      def file(file)
+        File.join(Calabash::Environment::SKELETON_DIR_PATH, file)
+      end
+
+      def msg(title, &block)
+        puts "\n" + "-"*10 + title + "-"*10
+        block.call
+        puts "-"*10 + "-------" + "-"*10 + "\n"
+      end
+
+
+    end
+  end
+end

data/lib/calabash/cli/helpers.rb

@@ -0,0 +1,130 @@
+module Calabash
+  # @!visibility private
+  module CLI
+    # @!visibility private
+    module Helpers
+      HELP = {
+          help: 'help',
+          gen: 'gen',
+          run: 'run [application] [cucumber options]',
+          console: 'console [application]',
+          version: 'version',
+          setup_keystore: 'setup-keystore',
+          resign: 'resign <apk>',
+          build: 'build <apk>'
+      }
+
+      def key_for_command(command)
+        HELP.each do |key, value|
+          if value.split(' ').first == command
+            return key
+          end
+        end
+
+        nil
+      end
+
+      def print_usage_for(key, output=STDOUT)
+        if key.nil? || HELP[key].nil?
+          output.write <<EOF
+No such command '#{command}'
+EOF
+        else
+          output.write <<EOF
+Usage:
+  calabash [options] #{HELP[key]}
+EOF
+        end
+      end
+
+      def print_usage(output=STDOUT)
+          output.write <<EOF
+  Usage: calabash [options] <command-name> [command specific options]
+  <command-name> can be one of
+    #{HELP[:help]} [command]
+      print help information.
+
+    #{HELP[:gen]}
+      generate a features folder structure.
+
+    #{HELP[:run]}
+      runs Cucumber in the current folder with the environment needed.
+      the cucumber options will be passed unchanged to cucumber
+
+    #{HELP[:console]}
+      starts an interactive console to interact with your app via Calabash
+
+    #{HELP[:version]}
+      prints the gem version
+
+    Android specific commands
+      #{HELP[:setup_keystore]}
+        sets up a non-default keystore to use with this test project.
+
+      #{HELP[:resign]}
+        resigns the app with the currently configured keystore.
+
+      #{HELP[:build]}
+        builds the test server that will be used when testing the app.
+
+    iOS specific commands
+      setup <path>
+        setup your XCode project for calabash-ios (EXPERIMENTAL)
+
+      check <{path to .ipa|<path to .app}>
+        check whether an app or ipa is linked with calabash.framework (EXPERIMENTAL)
+
+      download
+        install latest compatible version of calabash.framework
+
+      check <{path to .ipa|path to .app}>
+        check whether an app or ipa is linked with calabash.framework
+
+      sim locale <lang> [region]
+        change locale and regional settings in all iOS Simulators
+
+      sim location <{on|off}> [path to .app]
+        set allow location on/off for current project or app
+
+      sim reset
+        reset content and settings in all iOS Simulators
+
+      sim acc
+        enable accessibility in all iOS Simulators
+
+      sim device {iPad|iPad_Retina|iPhone|iPhone_Retina|iPhone_Retina_4inch}
+        change the default iOS Simulator device.
+
+  [options] can be
+    -v, --verbose
+      Turns on verbose logging
+EOF
+      end
+
+      def help
+        file_name = File.join(File.dirname(__FILE__), '..', 'doc', 'calabash_help.txt')
+        system("less \"#{file_name}\"")
+      end
+
+      def fail(reason, command=nil)
+        STDERR.write("#{reason}\n")
+
+        if command != nil
+          print_usage_for(command)
+        end
+
+        exit(1)
+      end
+    end
+  end
+end
+
+# Removed commands
+=begin
+iOS:
+    update [target]
+      updates one of the following targets: hooks
+
+
+
+=end

data/lib/calabash/cli/resign.rb

@@ -0,0 +1,33 @@
+module Calabash
+  # @!visibility private
+  module CLI
+    # @!visibility private
+    module Resign
+      def parse_resign_arguments!
+        fail('Can only resign Android applications') unless @platform.nil? || @platform == :android
+
+        application = @arguments.shift
+
+        if application.nil?
+          fail('Must supply application as first parameter to resign', :resign)
+        elsif !File.exists?(application)
+          fail("File '#{application}' does not exist", :resign)
+        else
+          extension = File.extname(application)
+
+          case extension
+            when '.apk'
+              set_platform!(:android)
+              Calabash::Android::Build::Resigner.new(application).resign!
+            when '.ipa', '.app'
+              set_platform!(:ios)
+              fail('Can only resign Android applications (apk)')
+            else
+              fail('Application must be an apk', :resign)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/calabash/cli/run.rb

@@ -0,0 +1,99 @@
+module Calabash
+  # @!visibility private
+  module CLI
+    # @!visibility private
+    module Run
+      def parse_run_arguments!
+        first_argument = @arguments.first # Do not remove the entry from the arguments yet - it might be a cucumber arg
+
+        if first_argument.nil? || first_argument.start_with?('-') || first_argument =~ /\.feature(\:\d*|\z)/
+          # If the argument begins with a dash, we assume the user meant
+          # to specify a cucumber argument, not an application
+          # If the argument ends with .feature, we assume the user meant
+          # to specify a cucumber argument, not an application.
+          Logger.info("No application specified. Using default application specified by env variable CAL_APP")
+          application = Environment::APP_PATH
+          Logger.debug("New application: '#{application}'")
+
+          fail("No application given and env variable CAL_APP is not set.", :run) if application.nil?
+        else
+          # If the argument does not begin with a dash, we assume the user meant
+          # to specify an application, not a cucumber argument
+          application = @arguments.shift
+        end
+
+        if File.exists?(application)
+          extension = File.extname(application)
+          application_path = File.expand_path(application)
+
+          case extension
+            when '.apk'
+              set_platform!(:android)
+
+              # Create the test server if it does not exist
+              test_server = Android::Build::TestServer.new(application_path)
+
+              unless test_server.exists?
+                Logger.info('Test server does not exist. Creating test server.')
+                Calabash::Android::Build::Builder.new(application_path).build
+              end
+
+              run(application_path, @arguments)
+            when '.ipa'
+              set_platform!(:ios)
+              # TODO: Extract ID from ipa
+              raise 'FOR NOW WE CANT DO THIS'
+            when '.app'
+              set_platform!(:ios)
+              run(application_path, @arguments)
+            else
+              fail('Application must be either an .apk, .ipa or .app', :run)
+          end
+        else
+          fail("File '#{application}' does not exist", :run)
+        end
+      end
+
+      def run(application_path, cucumber_arguments)
+        cucumber_environment = {}
+        cucumber_environment['CAL_DEBUG'] = Environment::DEBUG ? '1' : '0'
+
+        if @options[:verbose]
+          cucumber_environment['CAL_DEBUG'] = '1'
+        end
+
+        if @platform == :android
+          cucumber_environment['CAL_APP'] = application_path
+
+          if Environment::TEST_SERVER_PATH
+            cucumber_environment['CAL_TEST_SERVER'] = Environment::TEST_SERVER_PATH
+          else
+            test_server = Android::Build::TestServer.new(application_path)
+
+            raise 'Cannot locate test-server' unless test_server.exists?
+
+            cucumber_environment['CAL_TEST_SERVER'] = test_server.path
+          end
+        elsif @platform == :ios
+          cucumber_environment['CAL_APP'] = application_path
+        else
+          raise "Invalid platform '#{@platform}'"
+        end
+
+        begin
+          require 'cucumber'
+        rescue LoadError => _
+          unless Object.const_defined?(:Bundler)
+            $stderr.puts "Warning! Could not load cucumber. Make sure it is installed."
+          end
+        end
+
+        arguments = ['-S', 'cucumber', '-p', @platform.to_s, *cucumber_arguments]
+
+        Logger.debug("Starting Ruby with arguments: #{arguments.join(', ')} and environment #{cucumber_environment.to_s}")
+
+        exec(cucumber_environment, RbConfig.ruby, *arguments)
+      end
+    end
+  end
+end

data/lib/calabash/cli/setup_keystore.rb

@@ -0,0 +1,39 @@
+require 'json'
+require 'awesome_print'
+require 'io/console'
+
+module Calabash
+  module CLI
+    # @!visibility private
+    module SetupKeystore
+      def parse_setup_keystore_arguments!
+        set_platform!(:android)
+
+        settings = {}
+
+        puts "Please enter keystore information to use a custom keystore instead of the default"
+
+        settings[:keystore_location] = File.expand_path(prompt('Please enter a path to the keystore'))
+        settings[:keystore_store_password] = prompt('Please enter the password for the keystore (storepass)', true)
+        settings[:keystore_alias] = prompt('Please enter the alias. Leave blank for auto-detection.')
+        settings[:keystore_key_password] = prompt('Please enter the password for the key (keypass). Leave blank if it is the same as the store password.', true)
+
+        File.open(Android::Build::JavaKeystore::CALABASH_KEYSTORE_SETTINGS_FILENAME, 'w') do |file|
+          file.puts(JSON.pretty_generate(settings))
+        end
+
+        puts "Saved your settings to '#{Android::Build::JavaKeystore::CALABASH_KEYSTORE_SETTINGS_FILENAME}'. You can edit the settings manually or run this setup script again"
+      end
+
+      def prompt(message, secure = false)
+        puts message
+
+        if secure
+          STDIN.noecho(&:gets).chomp
+        else
+          STDIN.gets.chomp
+        end
+      end
+    end
+  end
+end

data/lib/calabash/color.rb

@@ -0,0 +1,32 @@
+module Calabash
+  # @!visibility private
+  module Color
+    def self.colorize(string, color)
+      "\e[#{color}m#{string}\e[0m"
+    end
+
+    def self.red(string)
+      colorize(string, 31)
+    end
+
+    def self.green(string)
+      colorize(string, 32)
+    end
+
+    def self.yellow(string)
+      colorize(string, 33)
+    end
+
+    def self.blue(string)
+      colorize(string, 34)
+    end
+
+    def self.magenta(string)
+      colorize(string, 35)
+    end
+
+    def self.cyan(string)
+      colorize(string, 36)
+    end
+  end
+end