snapshot 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abe2a2114b41b71a5a3b0bf789737b74ed8eb269
-  data.tar.gz: 96a63f2703288bfb6026fd9ec337fe1fb2219159
+  metadata.gz: 054323cf6415d800521313446b8bea54920c4f2d
+  data.tar.gz: f763b832b5ae52d1f0f26def4447aafb28789b3e
 SHA512:
-  metadata.gz: 90bc75c631543a8d4506a9ab88de3c72c7399a0869b023212811f02b301949640ab4705377eaad0c70281984cdc8f520d4d940daa883eabfd5e3dff8ed6c9cb0
-  data.tar.gz: 4d20b097682c395cca61c67f69fbd8d4d5ef1cd38c43c01a4f616bf5356eb7cc9d61bb0559a53b5bd7e476d877a4ddd76854c26f308b4467517a636f202cac31
+  metadata.gz: af528678ff568a255bd2d53a898fbf8ce3a14758d602dcc096567605990b0e836e1356669699c731de45148e50446e95509c4cdc93c3717295c674a49ab9e18a
+  data.tar.gz: 7bac6cf670f207698a4f4f9a2772d4b6c22087007a46e0530d14853eb243d494db8f078939f4c91f75549d5a88ad93ffc1c3b8aff1ceca6d277bff8f3d7e20ed

data/README.md

@@ -131,6 +131,7 @@ Here a few links to get started:
 - [A first look into UI Tests](http://www.mokacoding.com/blog/xcode-7-ui-testing/)
 - [UI Testing in Xcode 7](http://masilotti.com/ui-testing-xcode-7/)
 - [HSTestingBackchannel : ‘Cheat’ by communicating directly with your app](https://github.com/ConfusedVorlon/HSTestingBackchannel)
+- [Automating App Store screenshots using fastlane snapshot and frameit](https://tisunov.github.io/2015/11/06/automating-app-store-screenshots-generation-with-fastlane-snapshot-and-sketch.html)
 
 **Note**: Since there is no official way to trigger a screenshot from UI Tests, `snapshot` uses a workaround (described in [How Does It Work?](#how-does-it-work)) to trigger a screenshot. If you feel like this should be done right, please duplicate radar [23062925](https://openradar.appspot.com/radar?id=5056366381105152).
 
@@ -242,15 +243,27 @@ snapshot reset_simulators
 
 You can use the environment variable `SNAPSHOT_FORCE_DELETE` to stop asking for confirmation before deleting.
 
+## Update snapshot helpers
+
+Some updates require the helper files to be updated. `snapshot` will automatically warn you and tell you how to update.
+
+Basically you can run 
+
+```
+snapshot update
+```
+
+to update your `SnapshotHelper.swift` files. In case you modified your `SnapshotHelper.swift` and want to manually update the file, check out [SnapshotHelper.swift](https://github.com/fastlane/snapshot/blob/master/lib/assets/SnapshotHelper.swift).
+
 # How does it work?
 
 The easiest solution would be to just render the UIWindow into a file. That's not possible because UI Tests don't run on a main thread. So `snapshot` uses a different approach:
 
-When you run unit tests in Xcode, the reporter generates a plist file, documenting all events that occured during the tests ([More Information](http://michele.io/test-logs-in-xcode)). Additionally, Xcode generates screenshots before, during and after each of these events. There seems to be no way to manually trigger a screenshot event. The screenshots and the plist files are stored in the DerivedData directory, which `snapshot` stores in a temporary folder.
+When you run unit tests in Xcode, the reporter generates a plist file, documenting all events that occured during the tests ([More Information](http://michele.io/test-logs-in-xcode)). Additionally, Xcode generates screenshots before, during and after each of these events. There is no way to manually trigger a screenshot event. The screenshots and the plist files are stored in the DerivedData directory, which `snapshot` stores in a temporary folder.
 
-When the user calls `snapshot(...)` in the UI Tests (Swift or Objective C) the script actually just does a swipe gesture outside of the screen bounds which doesn't make any sense. It has no effect to the application and is not something you would do in your tests. The goal was to find *some* event that a user would never trigger, so that we know it's from `snapshot`.
+When the user calls `snapshot(...)` in the UI Tests (Swift or Objective C) the script actually does a rotation to `.Invalid` which doesn't have any effect on the actual app, but is enough to trigger a screenshot. It has no effect to the application and is not something you would do in your tests. The goal was to find *some* event that a user would never trigger, so that we know it's from `snapshot`.
 
-`snapshot` then iterates through all test events and check where we did this weird gesture. Once `snapshot` has all events triggered by `snapshot` it collects a ordered list of all the file names of the actual screenshots of the application. 
+`snapshot` then iterates through all test events and check where we did this weird rotation. Once `snapshot` has all events triggered by `snapshot` it collects a ordered list of all the file names of the actual screenshots of the application. 
 
 In the test output, the Swift `snapshot` function will print out something like this
 

data/bin/snapshot

@@ -49,6 +49,16 @@ class SnapshotApplication
       end
     end
 
+    command :update do |c|
+      c.syntax = 'snapshot update'
+      c.description = "Updates your SnapshotHelper.swift to the latest version"
+
+      c.action do |args, options|
+        require 'snapshot/update'
+        Snapshot::Update.new.update
+      end
+    end
+
     command :reset_simulators do |c|
       c.syntax = 'snapshot reset_simulators'
       c.description = "This will remove all your existing simulators and re-create new ones"

data/lib/assets/SnapfileTemplate

@@ -7,6 +7,7 @@
 #   "iPhone 5",
 #   "iPhone 4s",
 #   "iPad Retina"
+#   "iPad Pro"
 # ])
 
 languages([

data/lib/assets/SnapshotHelper.swift

@@ -16,7 +16,7 @@ func setLanguage(app: XCUIApplication)
     Snapshot.setLanguage(app)
 }
 
-func snapshot(name: String, waitForLoadingIndicator: Bool = true)
+func snapshot(name: String, waitForLoadingIndicator: Bool = false)
 {
     Snapshot.snapshot(name, waitForLoadingIndicator: waitForLoadingIndicator)
 }
@@ -28,7 +28,7 @@ func snapshot(name: String, waitForLoadingIndicator: Bool = true)
     class func setLanguage(app: XCUIApplication)
     {
         let path = "/tmp/language.txt"
-        
+
         do {
             let locale = try NSString(contentsOfFile: path, encoding: NSUTF8StringEncoding) as String
             deviceLanguage = locale.substringToIndex(locale.startIndex.advancedBy(2, limit:locale.endIndex))
@@ -46,11 +46,8 @@ func snapshot(name: String, waitForLoadingIndicator: Bool = true)
         }
         print("snapshot: \(name)") // more information about this, check out https://github.com/krausefx/snapshot
         
-        let view = XCUIApplication()
-        let start = view.coordinateWithNormalizedOffset(CGVectorMake(32.10, 30000))
-        let finish = view.coordinateWithNormalizedOffset(CGVectorMake(31, 30000))
-        start.pressForDuration(0, thenDragToCoordinate: finish)
-        sleep(1)
+        sleep(1) // Waiting for the animation to be finished (kind of)
+        XCUIDevice.sharedDevice().orientation = .Unknown
     }
     
     class func waitForLoadingIndicatorToDisappear()
@@ -63,3 +60,7 @@ func snapshot(name: String, waitForLoadingIndicator: Bool = true)
         }
     }
 }
+
+// Please don't remove the lines below
+// They are used to detect outdated configuration files
+// SnapshotHelperVersion [[1.0]]

data/lib/snapshot.rb

@@ -10,6 +10,8 @@ require 'snapshot/test_command_generator'
 require 'snapshot/error_handler'
 require 'snapshot/collector'
 require 'snapshot/options'
+require 'snapshot/update'
+require 'snapshot/fixes/simulator_zoom_fix'
 
 require 'fastlane_core'
 

data/lib/snapshot/collector.rb

@@ -46,8 +46,8 @@ module Snapshot
             (subtest["Subtests"] || []).each do |subtest2|
               (subtest2["Subtests"] || []).each do |subtest3|
                 (subtest3["ActivitySummaries"] || []).each do |activity|
-                  # We now check if it's the drag gesture with a negative value
-                  was_snapshot = activity["Title"].match(/Press and drag from Target Application.*\[32.10.*\].*/)
+                  # We now check if it's the rotation gesture, because that's the only thing we care about
+                  was_snapshot = activity["Title"] == "Set device orientation to Unknown"
                   activities << activity if was_snapshot
                 end
               end
@@ -61,7 +61,7 @@ module Snapshot
       to_store = [] # contains the names of all the attachments we want to use
       activities.each do |activity|
         # We do care about this, all "Long press Target" events mean screenshots
-        attachment_entry = activity["SubActivities"].last # the latest event is fine
+        attachment_entry = activity
         to_store << attachment_entry["Attachments"].last["FileName"]
       end
 

data/lib/snapshot/fixes/README.md

@@ -0,0 +1,5 @@
+### Fixes
+
+This directory contains all the files we don't actually want to have, but are necessary due to open radars, e.g.
+- [#5056366381105152](https://openradar.appspot.com/radar?id=5056366381105152): Trigger screenshots from UI Tests
+- [#6127019184095232](https://openradar.appspot.com/radar?id=6127019184095232): Screenshots are broken when simulator is not scaled at 100%

data/lib/snapshot/fixes/simulator_zoom_fix.rb

@@ -0,0 +1,30 @@
+module Snapshot
+  module Fixes
+    # This fix is needed due to a bug in UI Tests that creates invalid screenshots when the
+    # simulator is not scaled to a 100%
+    # Issue: https://github.com/fastlane/snapshot/issues/249
+    # Radar: https://openradar.appspot.com/radar?id=6127019184095232
+
+    class SimulatorZoomFix
+      def self.patch
+        # First we need to kill the simulator
+        `killall iOS Simulator &> /dev/null`
+
+        Helper.log.debug "Patching '#{config_path}' to scale simulator to 100%"
+
+        FastlaneCore::Simulator.all.each do |simulator|
+          simulator_name = simulator.name.tr(" ", "-")
+          key = "SimulatorWindowLastScale-com.apple.CoreSimulator.SimDeviceType.#{simulator_name}"
+
+          command = "defaults write '#{config_path}' '#{key}' '1.0'"
+          puts command.yellow if $debug
+          `#{command}`
+        end
+      end
+
+      def self.config_path
+        File.join(File.expand_path("~"), "Library", "Preferences", "com.apple.iphonesimulator.plist")
+      end
+    end
+  end
+end

data/lib/snapshot/reports_generator.rb

@@ -56,6 +56,7 @@ module Snapshot
         'iPhone6' => "iPhone 6",
         'iPhone5' => "iPhone 5",
         'iPhone4' => "iPhone 4",
+        'iPadPro' => "iPad Pro",
         'iPad' => "iPad",
         'Mac' => "Mac"
       }

data/lib/snapshot/runner.rb

@@ -14,6 +14,8 @@ module Snapshot
         sleep 3 # to be sure the user sees this, as compiling clears the screen
       end
 
+      verify_helper_is_current
+
       FastlaneCore::PrintTable.print_values(config: Snapshot.config, hide_keys: [], title: "Summary for snapshot #{Snapshot::VERSION}")
 
       clear_previous_screenshots if Snapshot.config[:clear_previous_screenshots]
@@ -48,6 +50,8 @@ module Snapshot
 
       File.write("/tmp/language.txt", language)
 
+      Fixes::SimulatorZoomFix.patch
+
       command = TestCommandGenerator.generate(device_type: device_type)
 
       Helper.log_alert("#{device_type} - #{language}")
@@ -70,7 +74,7 @@ module Snapshot
                                                 ErrorHandler.handle_test_error(output, return_code)
 
                                                 # no exception raised... that means we need to retry
-                                                Helper.log.info "Cought error... #{return_code}".red
+                                                Helper.log.info "Caught error... #{return_code}".red
 
                                                 self.number_of_retries += 1
                                                 if self.number_of_retries < 20
@@ -92,5 +96,20 @@ module Snapshot
         File.delete(current)
       end
     end
+
+    # rubocop:disable Style/Next
+    def verify_helper_is_current
+      helper_files = Update.find_helper
+      helper_files.each do |path|
+        content = File.read(path)
+
+        if content.include?("start.pressForDuration(0, thenDragToCoordinate: finish)")
+          Helper.log.error "Your '#{path}' is outdated, please run `snapshot update`".red
+          Helper.log.error "to update your Helper file".red
+          raise "Please update your Snapshot Helper file".red
+        end
+      end
+    end
+    # rubocop:enable Style/Next
   end
 end

data/lib/snapshot/setup.rb

@@ -12,7 +12,7 @@ module Snapshot
       File.write(snapfile_path, File.read("#{gem_path}/lib/assets/SnapfileTemplate"))
       File.write(File.join(path, 'SnapshotHelper.swift'), File.read("#{gem_path}/lib/assets/SnapshotHelper.swift"))
 
-      puts "Successfully created SnapshotHelper.js '#{File.join(path, 'SnapshotHelper.swift')}'".green
+      puts "Successfully created SnapshotHelper.swift '#{File.join(path, 'SnapshotHelper.swift')}'".green
       puts "Successfully created new Snapfile at '#{snapfile_path}'".green
 
       puts "-------------------------------------------------------".yellow

data/lib/snapshot/update.rb

@@ -0,0 +1,32 @@
+module Snapshot
+  # Migrate helper files
+  class Update
+    # @return [Array] A list of helper files (usually just one)
+    def self.find_helper
+      Dir["./**/SnapshotHelper.swift"]
+    end
+
+    def update
+      gem_path = Helper.gem_path("snapshot")
+      paths = self.class.find_helper
+
+      Helper.log.info "Found the following SnapshotHelper:"
+      puts ''
+      paths.each { |p| Helper.log.info "\t#{p}" }
+      puts ''
+      Helper.log.info "Are you sure you want to automatically update the helpers listed above?"
+      Helper.log.info "This will overwrite all its content with the latest code."
+      Helper.log.info "The underlying API will not change. You can always migrate manually by looking at"
+      Helper.log.info "https://github.com/fastlane/snapshot/blob/master/lib/assets/SnapshotHelper.swift"
+
+      return 1 unless agree("Overwrite configuration files? (y/n)".red, true)
+
+      paths.each do |path|
+        Helper.log.info "Updating '#{path}'..."
+        File.write(path, File.read("#{gem_path}/lib/assets/SnapshotHelper.swift"))
+      end
+
+      Helper.log.info "Successfully updated helper files".green
+    end
+  end
+end

data/lib/snapshot/version.rb

@@ -1,4 +1,4 @@
 module Snapshot
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
   DESCRIPTION = "Automate taking localized screenshots of your iOS app on every device"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshot
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastimage
@@ -216,6 +216,8 @@ files:
 - lib/snapshot/dependency_checker.rb
 - lib/snapshot/detect_values.rb
 - lib/snapshot/error_handler.rb
+- lib/snapshot/fixes/README.md
+- lib/snapshot/fixes/simulator_zoom_fix.rb
 - lib/snapshot/latest_ios_version.rb
 - lib/snapshot/options.rb
 - lib/snapshot/page.html.erb
@@ -226,6 +228,7 @@ files:
 - lib/snapshot/screenshot_rotate.rb
 - lib/snapshot/setup.rb
 - lib/snapshot/test_command_generator.rb
+- lib/snapshot/update.rb
 - lib/snapshot/version.rb
 homepage: https://fastlane.tools
 licenses:
@@ -247,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.4.0
 signing_key: 
 specification_version: 4
 summary: Automate taking localized screenshots of your iOS app on every device