snapshot 0.4.13 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d50d9664f7380c82a481684d7a6243278b5634e6
-  data.tar.gz: 41f40e3699e231b5e5432821319c036854152fb5
+  metadata.gz: 54a6a5e5c88121d5cd4642db73d3d91abda68652
+  data.tar.gz: eb8ccdeacbc9fe7e28eba1303ae893bfd7aa5b15
 SHA512:
-  metadata.gz: 4f8764ab6afc3acb42e6493290ff44e330f8362538f335431831b782733dcd87f1c7baacb042e7899409bf391b50435dcd9ce06a5e6c57556b9188cc8c4a132c
-  data.tar.gz: 0c32385f6d29872c0d1aa52f896379f1b766f8aa46445633442f34cb656ef00afb8361b08f14e51794286b97ded20ea6f73411053d96f2b206847da26942b1cd
+  metadata.gz: cc159b6a65bc09699e93ce6d6e2c07fd0e9f27a226475731c5baa9f42b77488046bc9216ad47447a2fb0e9f8916b8890475d07e7429e820df3ceeda15c72e262
+  data.tar.gz: 7cf3a8180e30074137ce70c01bcbe022cd5513eabce15a1cd9711206b51b147de2025244bc7b84f0924beb5f916fdfa701097b53a27e6b1e995f9497578b2047

data/README.md

@@ -259,24 +259,13 @@ This can be used to
 
 To run a shell script, just use ```system('./script.sh')```.
 ```ruby
-setup_for_device_change do |device, udid|
-  puts "Preparing device: #{device} with udid #{udid}"
-
-  # Completely reset the device before we start taking screenshots
-  system("xcrun simctl erase #{udid}")
-end
-
-setup_for_language_change do |lang, device|
-  puts "Running #{lang} on #{device}"
-  system("./populateDatabase.sh")
-end
-
-teardown_language do |lang, device|
-  puts "Finished with #{lang} on #{device}"
+setup_for_device_change do |device, udid, language|
+  puts "Running #{language} on #{device}"
+  system("./popuplateDatabase.sh")
 end
 
-teardown_device do |device|
-  puts "Cleaning device #{device}"
+teardown_device do |language, device|
+  puts "Finished with #{language} on #{device}"
   system("./cleanup.sh")
 end
 ```

data/bin/snapshot

@@ -34,6 +34,7 @@ class SnapshotApplication
       c.action do |args, options|
         path = (Snapshot::Helper.fastlane_enabled?? './fastlane' : '.')
         Dir.chdir(path) do # switch the context
+          Snapshot::DependencyChecker.check_simulators
           Snapshot::SnapshotConfig.shared_instance(options.snapfile)
           Snapshot::Runner.new.work(clean: !options.noclean)
         end
@@ -56,7 +57,7 @@ class SnapshotApplication
       c.option '-i', '--ios String', String, 'The iOS Version you want to use'
 
       c.action do |args, options|
-        version = options.ios || ENV["SNAPSHOT_IOS_VERSION"] || Snapshot::LatestIosVersion::VERSION
+        version = options.ios || Snapshot::LatestIosVersion.version
         require 'snapshot/reset_simulators'
 
         Snapshot::ResetSimulators.clear_everything!(version)

data/lib/assets/SnapfileTemplate

@@ -34,20 +34,12 @@ screenshots_path "./screenshots"
 
 # Custom Callbacks
 
-# setup_for_device_change do |device|
-#   puts "Preparing device: #{device}"
-# end
-
-# setup_for_language_change do |lang, device|
-#   puts "Running #{lang} on #{device}"
+# setup_for_device_change do |device, udid, language|
+#   puts "Running #{language} on #{device}"
 #   system("./popuplateDatabase.sh")
 # end
 
-# teardown_language do |lang, device|
-#   puts "Finished with #{lang} on #{device}"
-# end
-
-# teardown_device do |device|
-#   puts "Cleaning device #{device}"
+# teardown_device do |language, device|
+#   puts "Finished with #{language} on #{device}"
 #   system("./cleanup.sh")
 # end

data/lib/snapshot/dependency_checker.rb

@@ -2,7 +2,6 @@ module Snapshot
   class DependencyChecker
     def self.check_dependencies
       self.check_xcode_select
-      self.check_simulators
       self.check_xctool
       self.check_for_automation_subfolder
       self.check_simctl
@@ -24,7 +23,8 @@ module Snapshot
       if Simulators.available_devices.count < 1
         Helper.log.fatal '#############################################################'
         Helper.log.fatal "# You have to add new simulators using Xcode"
-        Helper.log.fatal "# Xcode => Window => Devices"
+        Helper.log.fatal "# You can let snapshot create new simulators: 'snapshot reset_simulators'"
+        Helper.log.fatal "# Manually: Xcode => Window => Devices"
         Helper.log.fatal "# Please run `instruments -s` to verify your xcode path"
         Helper.log.fatal '#############################################################'
         raise "Create the new simulators and run this script again"

data/lib/snapshot/latest_ios_version.rb

@@ -1,5 +1,15 @@
 module Snapshot
   class LatestIosVersion
-    VERSION = '8.1'
+    def self.version
+      return ENV["SNAPSHOT_IOS_VERSION"] if ENV["SNAPSHOT_IOS_VERSION"]
+
+      output = `xcodebuild -version -sdk`.split("Mac").last # don't care about the Mac Part
+      matched = output.match(/SDKVersion: ([\d\.]+)/)
+      if matched.length > 1
+        return matched[1]
+      else
+        raise "Could not determine installed iOS SDK version. Please pass it via the environment variable 'SNAPSHOT_IOS_VERSION'".red
+      end
+    end
   end
 end

data/lib/snapshot/reports_generator.rb

@@ -33,7 +33,9 @@ module Snapshot
       export_path = "#{screens_path}/screenshots.html"
       File.write(export_path, html)
 
-      Helper.log.info "Successfully created HTML file with an overview of all the screenshots: '#{File.expand_path(export_path)}'".green
+      export_path = File.expand_path(export_path)
+      Helper.log.info "Successfully created HTML file with an overview of all the screenshots: '#{export_path}'".green
+      system("open '#{export_path}'") unless ENV["SNAPSHOT_SKIP_OPEN_SUMMARY"]
     end
 
     private

data/lib/snapshot/reset_simulators.rb

@@ -15,12 +15,16 @@ module Snapshot
       device_types_output = `xcrun simctl list devicetypes`
       device_types = device_types_output.scan /(.*) \((.*)\)/
        
-      devices_output = `xcrun simctl list devices`
-      devices = devices_output.scan /\s\s\s\s(.*) \(([^)]+)\) (.*)/
+      devices_output = `xcrun simctl list devices`.split("\n")
 
-      devices.each do |device|
-        puts "Removing device #{device[0]} (#{device[1]})"
-        `xcrun simctl delete #{device[1]}`
+      devices_output.each do |line|
+        device = line.match(/\s+([\w\s]+)\(([\w\-]+)\)/)
+        if device and device.length == 3
+          name = device[1].strip
+          id = device[2]
+          puts "Removing device #{name} (#{id})"
+          `xcrun simctl delete #{id}`
+        end
       end
 
       device_types.each do |device_type|

data/lib/snapshot/runner.rb

@@ -1,4 +1,5 @@
 require 'pty'
+require 'shellwords'
 
 module Snapshot
   class Runner
@@ -8,7 +9,7 @@ module Snapshot
       SnapshotConfig.shared_instance.js_file # to verify the file can be found earlier
 
       Builder.new.build_app(clean: clean)
-      @app_path = Dir.glob("/tmp/snapshot/build/*.app").first
+      @app_path = determine_app_path
 
       counter = 0
       errors = []
@@ -16,22 +17,20 @@ module Snapshot
       FileUtils.rm_rf SnapshotConfig.shared_instance.screenshots_path if SnapshotConfig.shared_instance.clear_previous_screenshots
 
       SnapshotConfig.shared_instance.devices.each do |device|
-        
-        SnapshotConfig.shared_instance.blocks[:setup_for_device_change].call(device, udid_for_simulator(device))  # Callback
-
         SnapshotConfig.shared_instance.languages.each do |language|
-          SnapshotConfig.shared_instance.blocks[:setup_for_language_change].call(language, device) # Callback
-
           reinstall_app(device, language) unless ENV["SNAPSHOT_SKIP_UNINSTALL"]
+
+          prepare_simulator(device, language)
+          
           begin
             errors.concat(run_tests(device, language))
             counter += copy_screenshots(language)
           rescue => ex
             Helper.log.error(ex)
           end
-          SnapshotConfig.shared_instance.blocks[:teardown_language].call(language, device) # Callback
+
+          teardown_simulator(device, language)
         end
-        SnapshotConfig.shared_instance.blocks[:teardown_device].call(device) # Callback
       end
 
       `killall "iOS Simulator"` # close the simulator after the script is finished
@@ -55,6 +54,16 @@ module Snapshot
       FileUtils.mkdir_p(TRACE_DIR)
     end
 
+    def prepare_simulator(device, language)
+      SnapshotConfig.shared_instance.blocks[:setup_for_device_change].call(device, udid_for_simulator(device), language)  # Callback
+      SnapshotConfig.shared_instance.blocks[:setup_for_language_change].call(language, device) # deprecated
+    end
+
+    def teardown_simulator(device, language)
+      SnapshotConfig.shared_instance.blocks[:teardown_language].call(language, device) # Callback
+      SnapshotConfig.shared_instance.blocks[:teardown_device].call(device, language) # deprecated
+    end
+
     def udid_for_simulator(name) # fetches the UDID of the simulator type
       all = `instruments -s`.split("\n")
       all.each do |current|
@@ -65,12 +74,8 @@ module Snapshot
 
     def reinstall_app(device, language)
 
-      def app_identifier
-        @app_identifier ||= ENV["SNAPSHOT_APP_IDENTIFIER"] 
-        @app_identifier ||= `/usr/libexec/PlistBuddy -c 'Print CFBundleIdentifier' /tmp/snapshot/build/*.app/Info.plist`
-        @app_identifier ||= `/usr/libexec/PlistBuddy -c 'Print CFBundleIdentifier' /tmp/snapshot/build/*.app/*.plist`
-        @app_identifier.strip
-      end
+      app_identifier = ENV["SNAPSHOT_APP_IDENTIFIER"]
+      app_identifier ||= @app_identifier
 
       def com(cmd)
         puts cmd.magenta
@@ -86,7 +91,7 @@ module Snapshot
       com("xcrun simctl boot '#{udid}'")
       com("xcrun simctl uninstall booted '#{app_identifier}'")
       sleep 3
-      com("xcrun simctl install booted '#{@app_path}'")
+      com("xcrun simctl install booted '#{@app_path.shellescape}'")
       com("xcrun simctl shutdown booted")
     end
 
@@ -146,6 +151,21 @@ module Snapshot
       return errors
     end
 
+    def determine_app_path
+      # Determine the path to the actual app and not the WatchKit app
+      Dir.glob("/tmp/snapshot/build/*.app/*.plist").each do |path|
+        watchkit_enabled = `/usr/libexec/PlistBuddy -c 'Print WKWatchKitApp' '#{path}'`.strip
+        next if watchkit_enabled == 'true' # we don't care about WatchKit Apps
+
+        app_identifier = `/usr/libexec/PlistBuddy -c 'Print CFBundleIdentifier' '#{path}'`.strip
+        if app_identifier and app_identifier.length > 0
+          # This seems to be the valid Info.plist
+          @app_identifier = app_identifier
+          return File.expand_path("..", path) # the app
+        end
+      end
+    end
+
     def parse_test_line(line)
       if line =~ /.*Target failed to run.*/
         return :retry
@@ -188,7 +208,7 @@ module Snapshot
         "-w '#{device}'",
         "-D '#{TRACE_DIR}/trace'",
         "-t 'Automation'",
-        "'#{@app_path}'",
+        "#{@app_path.shellescape}",
         "-e UIARESULTSPATH '#{TRACE_DIR}'",
         "-e UIASCRIPT '#{script_path}'",
         "-AppleLanguages '(#{language})'",

data/lib/snapshot/snapfile_creator.rb

@@ -12,9 +12,9 @@ module Snapshot
       File.write([path, 'snapshot-iPad.js'].join('/'), File.read("#{gem_path}/lib/assets/snapshot.js"))
       File.write([path, 'SnapshotHelper.js'].join('/'), File.read("#{gem_path}/lib/assets/SnapshotHelper.js"))
 
-      puts "Successfully created SnapshotHelper.js '#{[path, 'SnapshotHelper.js'].join('/')}'".green
-      puts "Successfully created new UI Automation JS file at '#{[path, 'snapshot.js'].join('/')}'".green
-      puts "Successfully created new UI Automation JS file for iPad at '#{[path, 'snapshot-iPad.js'].join('/')}'".green
+      puts "Successfully created SnapshotHelper.js '#{File.join(path, 'SnapshotHelper.js')}'".green
+      puts "Successfully created new UI Automation JS file at '#{File.join(path, 'snapshot.js')}'".green
+      puts "Successfully created new UI Automation JS file for iPad at '#{File.join(path, 'snapshot-iPad.js')}'".green
       puts "Successfully created new Snapfile at '#{snapfile_path}'".green
     end
   end

data/lib/snapshot/snapshot_config.rb

@@ -51,6 +51,7 @@ module Snapshot
 
     # @param path (String) the path to the config file to use (including the file name)
     def initialize(path = nil)
+      DependencyChecker.check_simulators
       path ||= './Snapfile'
       set_defaults
 
@@ -73,7 +74,7 @@ module Snapshot
     end
 
     def set_defaults
-      self.ios_version = Snapshot::LatestIosVersion::VERSION
+      self.ios_version = Snapshot::LatestIosVersion.version
 
       self.languages = [
         'de-DE',

data/lib/snapshot/snapshot_file.rb

@@ -68,6 +68,7 @@ module Snapshot
         # Blocks
         when :setup_for_device_change, :teardown_device, :setup_for_language_change, :teardown_language
           raise "#{method_sym} needs to have a block provided." unless block_given?
+          Helper.log.warn("'setup_for_language_change' and 'teardown_language' are deprecated.".yellow) if [:setup_for_language_change, :teardown_language].include?method_sym
           @config.blocks[method_sym] = block
         else
           Helper.log.error "Unknown method #{method_sym}"

data/lib/snapshot/version.rb

@@ -1,3 +1,3 @@
 module Snapshot
-  VERSION = "0.4.13"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 0.4.13
+  version: 0.5.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastimage