briar 0.1.3.rc1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4f481d7fa3c5ff99d22180aa3833ebb3ee45ff4
-  data.tar.gz: 0aa2ee0d4af6dbfbf744792acc2c47428c958e15
+  metadata.gz: 01af1105eafa64b8a8e2763cf9f2e61196317422
+  data.tar.gz: 9fc4979cb92bf1d3045f99f2b685cd3c26b7e4cd
 SHA512:
-  metadata.gz: 60af1755b4ca4381fae9c80ffc49bf1242cbb8d9fee88edd1af3bd17246c87f4d7bedddcdf7dae62d6fd7fd904d67275960d0fd83096c90d29754ebdd60ef715
-  data.tar.gz: 6a38d56469f78a62f7f7bc051b5010a5e2c2c898026d577f1ced8aeb5e6e44281b24c4c4710bf22f52ff710f7f7ed478cf0a9c293b436479f76da62b97b333fd
+  metadata.gz: 16a81550bb111ba11b13c729e14fca3b357d7aadbc12f4acd7f357272766ccdc214e96354fadfe57b33aad2fe6b85fdcaf7720305cbff0e59310c1c14661c041
+  data.tar.gz: b37580bc3a4716308584c2d453a4b04744ea10b9d8d73da6e24467f22b16a54733ad6181e65b41049268873c652de9bc41b8e9540dd15c2238a470b0704476ec

data/README.md

@@ -36,6 +36,49 @@ I18n.enforce_available_locales = false
 To integrate briar and your calabash-ios console see: https://github.com/jmoody/briar/wiki/Integrating-Briar-Into-Your-Calabash-Console
 
 
+## briar binary
+
+The briar binary provides useful commands to improve your calabash workflow.
+
+There is detailed help about how to use the .xamarin convention and dotenv to setup your environment.
+
+```
+# help
+$ briar help
+$ briar help console
+$ briar help .xamarin
+
+# open a console against simulators
+$ briar console sim6            <== against the current simulator
+$ briar console sim7 ipad_r_64  <== changes the default simulator
+
+# open a console against named devices
+$ briar console venus
+$ briar console neptune
+
+# install the calabash server from a local repo and remove all stale simulator targets in one command
+$ briar install calabash-server
+
+# do a clean install of your .ipa on named device
+$ briar install pluto
+$ briar install earp
+
+# open a cucumber html report in your default browser
+$ briar report       <== last run against the simulator
+$ briar report venus <== last run against venus
+
+# remove all *-cal targets from the simulator (without resetting the device)
+$ briar rm sim-targets
+
+# resolve APP_BUNDLE_PATH auto-detection problems by removing spurious DerivedData directories
+$ briar rm dups 
+$ briar rm dups briar-ios-example 
+
+# change the simulator version
+$ briar sim ipad_r
+$ briar sim iphone_4in
+```
+
 ## Xamarin Test Cloud
 
 There is currently an issue with using briar predefined steps on the XTC:

data/bin/briar

@@ -1,141 +1,110 @@
 #!/usr/bin/env ruby
 #http://tech.natemurray.com/2007/03/ruby-shell-commands.html
 require 'find'
+require 'rainbow'
+require 'require_relative'
+require 'ansi/logger'
 
+@log = ANSI::Logger.new(STDOUT)
 
-require File.join(File.dirname(__FILE__), 'briar_helpers')
-require File.join(File.dirname(__FILE__), 'briar_resign')
+require 'dotenv'
+Dotenv.load
 
-if ARGV.length == 0
-  print_usage
-  exit 0
-end
-
-if ARGV.length == 2
-  arg1 = ARGV[0]
-  unless arg1 == BRIAR_CMD_INSTALL
-    print_usage
-    exit 1
-  end
-  allowed =  [BRIAR_INSTALL_GEM, BRIAR_INSTALL_CALABASH_GEM, BRIAR_INSTALL_CALABASH_SERVER]
-  arg2 = ARGV[1]
-  unless allowed.include?(arg2)
-    print_usage
-    exit 1
-  end
-
-  if arg2 == BRIAR_INSTALL_GEM
-
-    puts 'will install briar gem'
-    gem_dir = "#{ENV['HOME']}/git/briar"
-    unless File.exists?(gem_dir)
-      puts "expected gem '#{gem_dir}' - cannot install the briar gem"
-      exit 1
-    end
-    system("cd #{gem_dir}; rake install")
-    exit 0
-  elsif arg2 == BRIAR_INSTALL_CALABASH_GEM
-
-    puts 'will install calabash-cucumber gem'
-    gem_dir = "#{ENV['HOME']}/git/calabash-ios/calabash-cucumber"
-    unless File.exists?(gem_dir)
-      puts "expected gem '#{gem_dir}' - cannot install the calabash-cucumber gem"
-      exit 1
-    end
-    system("cd #{gem_dir}; rake install")
-    exit 0
-  elsif arg2 == BRIAR_INSTALL_CALABASH_SERVER
-
-    puts 'will install calabash-ios server'
-    cal_framework = 'calabash.framework'
-    unless File.exists?(cal_framework)
-      puts "expected '#{cal_framework}' to be in the local directory."
-      puts "run this command in the directory that contins '#{cal_framework}'"
-      exit 1
-    end
-
-    gem_dir = "#{ENV['HOME']}/git/calabash-ios/calabash-cucumber"
-    unless File.exists?(gem_dir)
-      puts "expected gem '#{gem_dir}' - cannot install the calabash server"
-      exit 1
-    end
-
-    server_dir = "#{ENV['HOME']}/git/calabash-ios-server"
-    unless File.exists?(server_dir)
-      puts "expected calabash-ios server to be in dir '#{server_dir}'"
-      puts "will not be able run '#{gem_dir}/rake build_server'"
-      exit 1
-    end
+require_relative './briar_help'
+require_relative './briar_resign'
+require_relative './briar_install'
+require_relative './briar_console'
+require_relative './briar_rm'
+require_relative './briar_xtc'
+require_relative './briar_report'
+require_relative './briar_sim'
 
-    version_file = File.read("#{server_dir}/calabash/Classes/FranklyServer/Routes/LPVersionRoute.h")
-    tokens = version_file.split(/define kLPCALABASHVERSION/)
-    line = tokens[1].split("\n").first
-    version = line.tr('^A-Za-z0-9.\-\_', '')
+num_args = ARGV.length
 
-    puts "building calabash server using 'rake build_server'"
-    system("cd #{gem_dir}; rake build_server")
-    puts 'remove old cal simulator targets'
-    system('briar rm-cal-targets')
-    puts 'copying new framework to ./'
-    system("cp #{gem_dir}/staticlib/#{cal_framework}.zip ./")
-    puts 'removing old framework'
-    system("rm -rf #{cal_framework}")
-    puts 'unzipping new framework'
-    system("unzip #{cal_framework}.zip")
-    puts 'cleaning up'
-    system("rm -rf #{cal_framework}.zip")
-    puts "installed new server version '#{version}'"
 
-    exit 0
-  end
-  puts 'fell through install conditional'
-  exit 1
+def briar_version
+  Briar::VERSION
 end
 
-cmd = ARGV.shift
-if cmd == 'help'
+if num_args == 0
   print_usage
   exit 0
-elsif cmd == BRIAR_VERSION_CMD
-  puts "#{Briar::VERSION}"
-elsif cmd == BRIAR_RM_CAL_TARGETS
-  puts 'quiting the simulator'
-  `/usr/bin/osascript -e 'tell application "iPhone Simulator" to quit'`
-  sim_dir="#{ENV['HOME']}/Library/Application Support/iPhone Simulator"
+end
 
- # `find "#{sim_dir}" -type d -name '*-cal.app' | sed 's#\(.*\)/.*#\1#' | xargs -I{} rm -rf {}`
-  cal_targets = []
-  Find.find(sim_dir) do |path|
-    if path =~  /.*\-cal.app/
-      puts "found '#{File.basename(path)}' in '#{File.dirname(path)}'"
-      cal_targets << File.dirname(path)
-      Find.prune
-    end
+if num_args == 1 and (ARGV[0] == 'help' or ARGV[0] == 'version')
+  command = ARGV[0]
+  case command
+    when 'help'
+      print_usage
+    when 'version'
+      briar_version
+    else
+      @log.error{"'#{command}' is not defined"}
+      @log.error('can you try something else?')
+      exit 1
   end
+  exit 0
+end
 
-  if cal_targets.empty?
-    puts "found no *-cal.app targets in '#{sim_dir}'"
-    exit 0
+if num_args == 2 and ARGV[0] == 'help'
+  command = ARGV[1]
+  case command
+    when 'console'
+      print_console_help
+    when 'cucumber-reports'
+      print_cucumber_reports_help
+    when 'install'
+      print_install_help
+    when 'resign'
+      print_resign_help
+    when 'report'
+      print_report_help
+    when 'rm'
+      print_rm_help
+    when 'sim'
+      print_sim_help
+    when 'version'
+      print_version_help
+    when '.xamarin'
+      print_dot_xamarin_help
+    when 'xtc'
+      print_xtc_help
+    when 'xtc-profiles'
+      print_xtc_profiles_help
+    else
+      @log.error("'#{command}' is not defined, so there is no help for you")
+      exit 1
   end
+  exit 0
+end
 
-  cal_targets.each do |path|
-    FileUtils.rm_r path
-  end
 
-elsif cmd == BRIAR_INSTALL_CALABASH_GEM
-  puts "use 'briar install calabash-gem'"
-  exit 1
-elsif cmd == BRIAR_INSTALL_GEM
-  puts "use 'briar install gem'"
-  exit 1
-elsif cmd == BRIAR_INSTALL_CALABASH_SERVER
-  puts "use 'briar install calabash-server'"
-  exit 1
-elsif cmd == BRIAR_RESIGN_IPA
-  puts 'will resign'
-  briar_resign(ARGV)
-  exit 0
-else
-  print_usage
-  exit 1
+
+command = ARGV[0]
+args = ARGV.drop(1)
+case command
+  when 'console'
+    briar_console(args)
+  when 'install'
+    briar_install(args)
+  when 'report'
+    briar_report(args)
+  when 'resign'
+    briar_resign(args)
+  when 'rm'
+    briar_rm(args)
+  when 'sim'
+    briar_sim(args)
+  when 'xtc'
+    briar_xtc(args)
+
+  # deprecated
+  when BRIAR_RM_CAL_TARGETS
+    puts Rainbow('DEPRECATED 0.1.3 - replaced with $ briar rm sim-targets').yellow
+    briar_rm(['sim-targets'])
+  else
+    @log.error{"'#{command}' is not defined"}
+    @log.error('can you try something else?')
+    exit 1
 end
+exit 0

data/bin/briar_console.rb

@@ -0,0 +1,126 @@
+require_relative './briar_dot_xamarin'
+require_relative './briar_env'
+
+require 'ansi/logger'
+@log = ANSI::Logger.new(STDOUT)
+
+# returns an iOS version string based on a canonical key
+#
+# the iOS version string is used to control which version of the simulator is
+# launched.  use this to set the +SDK_VERSION+.
+#
+# IMPORTANT: launching an iOS 5 simulator is not support in Xcode 5 or greater
+# IMPORTANT: Instruments 5.0 cannot be used to launch an app on an iOS 5 device
+def sdk_versions
+  {:ios5 => '5.1',
+   :ios6 => '6.1',
+   :ios7 => '7.0'}
+end
+
+# returns a hash with default arguments for various launch and irb functions
+def default_console_opts
+  {:sdk_version => sdk_versions[:ios7],
+   :irbrc => ENV['IRBRC'] || './.irbrc',
+   :bundle_exec =>  ENV['BUNDLE_EXEC'] == '1'
+  }
+end
+
+def screenshot_path
+  path = ENV['SCREENSHOT_PATH'] || './screenshots'
+  # *** trailing slash required ***
+  ENV['SCREENSHOT_PATH'] = "#{path}/"
+  # make a screenshot directory if one does not exist
+  FileUtils.mkdir(path) unless File.exists?(path)
+  path
+end
+
+def logging_level
+  {'DEBUG' => ENV['DEBUG'] || '1',
+   'CALABASH_FULL_CONSOLE_OUTPUT' => ENV['CALABASH_FULL_CONSOLE_OUTPUT'] || '1'}
+end
+
+def simulator_variables(sdk_version)
+  {'DEVICE_TARGET' => 'simulator',
+   'SKD_VERSION' => sdk_version}
+end
+
+def device_variables(device)
+  {'DEVICE_TARGET' => read_device_info(device, :udid),
+   'DEVICE_ENDPOINT' => read_device_info(device, :ip),
+   'BUNDLE_ID' => expect_bundle_id()
+  }
+end
+
+
+# returns a string that can be use to launch a <tt>calabash-ios console</tt>
+# that is configured using the opts hash
+#
+#   ios_console_cmd('neptune') # => a command to launch an irb against neptune
+#
+def ios_console_cmd(device, opts={})
+  default_opts = default_console_opts()
+  opts = default_opts.merge(opts)
+
+  env = ["SCREENSHOT_PATH=#{screenshot_path}"]
+
+  logging_level.each { |key,value|
+    env << "#{key}=#{value}"
+  }
+
+  if device.eql? :simulator
+    simulator_variables(opts[:sdk_version]).each { |key,value|
+      env << "#{key}=#{value}"
+    }
+  else
+    device_variables(device).each { |key,value|
+      env << "#{key}=#{value}"
+    }
+  end
+
+  env << "IRBRC=#{opts[:irbrc]}"
+  env << 'bundle exec' if opts[:bundle_exec]
+  env << 'irb'
+  env.join(' ')
+end
+
+# starts a console using the opts hash
+def console(device, opts={})
+
+  ### unexpected ###
+  # do not be tempted to use IRB.start
+  # this can cause some terrible problems at > exit
+  ##################
+
+default_opts = default_console_opts()
+  opts = default_opts.merge(opts)
+  cmd = ios_console_cmd(device, opts)
+  puts Rainbow(cmd).green
+  exec cmd
+end
+
+
+def briar_console(args)
+  arg_len = args.length
+  if arg_len == 0
+    print_console_help
+    exit 0
+  end
+
+  where = args[0]
+
+  sim = arg_len == 2 ? args[1] : nil
+
+  case where
+    when 'sim6'
+      set_default_simulator sim.to_sym if sim
+      console(:simulator, {:sdk_version => sdk_versions[:ios6]})
+    when 'sim7'
+      set_default_simulator sim.to_sym if sim
+      console(:simulator, {:sdk_version => sdk_versions[:ios7]})
+    else
+      if arg_len != 1
+        @log.warn { "expected only one arg but found '#{args}' - ignoring extra input" }
+      end
+      console(where)
+  end
+end

data/bin/briar_dot_xamarin.rb

@@ -0,0 +1,74 @@
+require 'ansi/logger'
+
+@log = ANSI::Logger.new(STDOUT)
+
+# return the device info by reading and parsing the relevant file in the
+# ~/.xamarin directory
+#
+#   read_device_info('neptune', :udid) # => reads the neptune udid (iOS)
+#   read_device_info('earp', :ip)      # => reads the earp udid (iOS)
+#   read_device_info('r2d2', :serial)  # => read the r2d2 serial number (android)
+def read_device_info (device, kind)
+  kind = kind.to_sym
+  kinds = [:ip, :udid, :serial]
+  unless kinds.include?(kind)
+    raise "illegal argument '#{kind}' - must be one of '#{kinds}'"
+  end
+
+  path = File.expand_path("~/.xamarin/devices/#{device}/#{kind}")
+
+  unless File.exist?(path)
+    @log.fatal{"cannot read device information for '#{device}'"}
+    @log.fatal{"file '#{path}' does not exist"}
+    exit 1
+  end
+
+  begin
+    IO.readlines(path).first.strip
+  rescue Exception => e
+    @log.fatal{"cannot read device information for '#{device}'"}
+    @log.fatal{e}
+    exit 1
+  end
+end
+
+# return a +Hash+ of XTC device sets where the key is some arbitrary description
+# and the value is a <tt>XTC device set</tt>
+def read_device_sets(path='~/.xamarin/test-cloud/ios-sets.csv')
+  ht = Hash.new
+  begin
+    File.read(File.expand_path(path)).split("\n").each do |line|
+      # not 1.8 compat
+      # unless line[0].eql?('#')
+      unless line.chars.to_a.first.eql?('#')
+        tokens = line.split(',')
+        if tokens.count == 2
+          ht[tokens[0].strip] = tokens[1].strip
+        end
+      end
+    end
+    ht
+  rescue Exception => e
+    @log.fatal{'cannot read device set information'}
+    @log.fatal{e}
+    exit 1
+  end
+end
+
+def read_api_token(account_name)
+  path = File.expand_path("~/.xamarin/test-cloud/#{account_name}")
+
+  unless File.exist?(path)
+    @log.fatal{"cannot read account information for '#{account_name}'"}
+    @log.fatal{"file '#{path}' does not exist"}
+    exit 1
+  end
+
+  begin
+    IO.readlines(path).first.strip
+  rescue Exception => e
+    @log.fatal{"cannot read account information for '#{account_name}'"}
+    @log.fatal{e}
+    exit 1
+  end
+end