snapshot 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32db1081d69cbad7c990081eb4c4f99a85363077
-  data.tar.gz: 0b11785e5ed0fbb90c1bfbef0f43631d84e8fa39
+  metadata.gz: e5114ebf47b492efce73f8730742424c4210c9b2
+  data.tar.gz: 8cb4bc0486032d9bd4a465ff0a7bc70b40d71a0f
 SHA512:
-  metadata.gz: f0e22d665e9898bcbd52b8ef87e869e94ae4ba177578707f8bbc85c29e2faf5f0abea21cfdf2bee005dc464d37286dab1eb88bd11e48246643bd46583ab589ea
-  data.tar.gz: cf8379a5515e44c4db7ac5690fd74023bc70649df9f24db9b135c208633066de82fb10b928b157ea3f45ecdc88fd090e6e69cf3f7d3f9bbf6ab78117535ca948
+  metadata.gz: 142a574585e51be9ba67a72bb31257333c881430bfb26cf439aed0c1206e18c9c5b9b9c6344dbfdb622a5fa112318cd39a0e55a3aac8c7520c39e5742ff8b0e9
+  data.tar.gz: 6c026cea706c997b6809009a85d1231af7433c68361b764ed098ee9904cca80e0ec949ac061f21632b112b83dbf827d51028f9ee6996afa932197f613316aa4a

data/README.md

@@ -152,14 +152,14 @@ Here a few links to get started:
 **Swift**
 ```swift
 let app = XCUIApplication()
-setLanguage(app)
+setupSnapshot(app)
 app.launch()
 ```
 
 **Objective C**
 ```objective-c
 XCUIApplication *app = [[XCUIApplication alloc] init];
-[Snapshot setLanguage:app];
+[Snapshot setupSnapshot:app];
 [app launch];
 ```
 
@@ -225,6 +225,8 @@ languages([
   "es-ES"
 ])
 
+launch_arguments("-username Felix")
+
 # The directory in which the screenshots should be stored
 output_directory './screenshots'
 
@@ -255,6 +257,31 @@ 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).
 
+## Launch Arguments
+
+You can provide additional arguments to your app on launch. These strings will be available in your code through `NSProcessInfo.processInfo().arguments`. Alternatively use user-default syntax (`-key value`) and they will be available as key-value pairs in `NSUserDefaults.standardUserDefaults()`.
+
+`snapshot` includes `-FASTLANE_SNAPSHOT YES`, which will set a temporary user default for the key `FASTLANE_SNAPSHOT`, you may use this to detect when the app is run by `snapshot`.
+
+```swift
+if NSUserDefaults.standardUserDefaults().boolForKey("FASTLANE_SNAPSHOT") {
+    // runtime check that we are in snapshot mode
+}
+
+username.text = NSUserDefaults.standardUserDefaults().stringForKey("username")
+// username.text = "Felix"
+```
+
+Specify multiple argument strings and `snapshot` will generate screenshots for each combination of arguments, devices, and languages. This is useful for comparing the same screenshots with different feature flags, dynamic text sizes, and different data sets.
+
+```ruby
+# Snapfile for A/B Test Comparison
+launch_arguments([
+  "-secretFeatureEnabled YES",
+  "-secretFeatureEnabled NO"
+])
+```
+
 # 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:

data/lib/assets/SnapfileTemplate

@@ -16,6 +16,9 @@ languages([
   "it-IT"
 ])
 
+# Arguments to pass to the app on launch. See https://github.com/fastlane/snapshot#launch_arguments
+# launch_arguments("-favColor red")
+
 # The name of the scheme which contains the UI Tests
 # scheme "SchemeName"
 

data/lib/assets/SnapshotHelper.swift

@@ -11,8 +11,14 @@ import XCTest
 
 var deviceLanguage = ""
 
+@available(*, deprecated, message="use setupSnapshot: instead")
 func setLanguage(app: XCUIApplication) {
+    setupSnapshot(app)
+}
+
+func setupSnapshot(app: XCUIApplication) {
     Snapshot.setLanguage(app)
+    Snapshot.setLaunchArguments(app)
 }
 
 func snapshot(name: String, waitForLoadingIndicator: Bool = false) {
@@ -33,6 +39,24 @@ class Snapshot: NSObject {
         }
     }
     
+    class func setLaunchArguments(app: XCUIApplication) {
+        let path = "/tmp/snapshot-launch_arguments.txt"
+        
+        app.launchArguments += ["-FASTLANE_SNAPSHOT", "YES"]
+        
+        do {
+            let launchArguments = try NSString(contentsOfFile: path, encoding: NSUTF8StringEncoding) as String
+            let regex = try NSRegularExpression(pattern: "(\\\".+?\\\"|\\S+)", options: [])
+            let matches = regex.matchesInString(launchArguments, options: [], range: NSRange(location:0, length:launchArguments.characters.count))
+            let results = matches.map { result -> String in
+                (launchArguments as NSString).substringWithRange(result.range)
+            }
+            app.launchArguments += results
+        } catch {
+            print("Couldn't detect/set launch_arguments...")
+        }
+    }
+    
     class func snapshot(name: String, waitForLoadingIndicator: Bool = false) {
         if waitForLoadingIndicator {
             waitForLoadingIndicatorToDisappear()

data/lib/snapshot.rb

@@ -32,6 +32,10 @@ module Snapshot
     def snapfile_name
       "Snapfile"
     end
+
+    def kill_simulator
+      `killall iOS Simulator &> /dev/null`
+    end
   end
 
   Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore

data/lib/snapshot/collector.rb

@@ -1,7 +1,7 @@
 module Snapshot
   # Responsible for collecting the generated screenshots and copying them over to the output directory
   class Collector
-    def self.fetch_screenshots(output, language, device_type)
+    def self.fetch_screenshots(output, language, device_type, launch_arguments_index)
       # Documentation about how this works in the project README
       containing = File.join(TestCommandGenerator.derived_data_path, "Logs", "Test")
       attachments_path = File.join(containing, "Attachments")
@@ -21,7 +21,9 @@ module Snapshot
         FileUtils.mkdir_p(language_folder)
 
         device_name = device_type.delete(" ")
-        output_path = File.join(language_folder, [device_name, name].join("-") + ".png")
+        components = [device_name, launch_arguments_index, name].delete_if { |a| a.to_s.length == 0 }
+
+        output_path = File.join(language_folder, components.join("-") + ".png")
         from_path = File.join(attachments_path, filename)
         if $verbose
           Helper.log.info "Copying file '#{from_path}' to '#{output_path}'...".green

data/lib/snapshot/fixes/simulator_zoom_fix.rb

@@ -8,7 +8,7 @@ module Snapshot
     class SimulatorZoomFix
       def self.patch
         # First we need to kill the simulator
-        `killall iOS Simulator &> /dev/null`
+        Snapshot.kill_simulator
 
         Helper.log.debug "Patching '#{config_path}' to scale simulator to 100%"
 

data/lib/snapshot/options.rb

@@ -47,6 +47,13 @@ module Snapshot
                                      default_value: [
                                        'en-US'
                                      ]),
+        FastlaneCore::ConfigItem.new(key: :launch_arguments,
+                                     env_name: 'SNAPSHOT_LAUNCH_ARGUMENTS',
+                                     description: "A list of launch arguments which should be used",
+                                     is_string: false,
+                                     default_value: [
+                                       ''
+                                     ]),
         FastlaneCore::ConfigItem.new(key: :output_directory,
                                      short_option: "-o",
                                      env_name: "SNAPSHOT_OUTPUT_DIRECTORY",

data/lib/snapshot/runner.rb

@@ -24,19 +24,28 @@ module Snapshot
 
       self.number_of_retries = 0
       errors = []
+      results = {} # collect all the results for a nice table
+      launch_arguments_set = config_launch_arguments
       Snapshot.config[:devices].each do |device|
-        Snapshot.config[:languages].each do |language|
-          begin
-            launch(language, device)
-          rescue => ex
-            Helper.log.error ex # we should to show right here as well
-            errors << ex
-
-            raise ex if Snapshot.config[:stop_after_first_error]
+        launch_arguments_set.each do |launch_arguments|
+          Snapshot.config[:languages].each do |language|
+            results[device] ||= {}
+
+            begin
+              launch(language, device, launch_arguments)
+              results[device][language] = true
+            rescue => ex
+              Helper.log.error ex # we should to show right here as well
+              errors << ex
+              results[device][language] = false
+              raise ex if Snapshot.config[:stop_after_first_error]
+            end
           end
         end
       end
 
+      print_results(results)
+
       raise errors.join('; ') if errors.count > 0
 
       # Generate HTML report
@@ -46,16 +55,52 @@ module Snapshot
       FileUtils.rm_rf(TestCommandGenerator.derived_data_path)
     end
 
-    def launch(language, device_type)
+    def config_launch_arguments
+      launch_arguments = Array(Snapshot.config[:launch_arguments])
+      # if more than 1 set of arguments, use a tuple with an index
+      if launch_arguments.count == 1
+        [launch_arguments]
+      else
+        launch_arguments.map.with_index { |e, i| [i, e] }
+      end
+    end
+
+    def print_results(results)
+      return if results.count == 0
+
+      rows = []
+      results.each do |device, languages|
+        current = [device]
+        languages.each do |language, value|
+          current << (value == true ? " 💚" : " ❌")
+        end
+        rows << current
+      end
+
+      params = {
+        rows: rows,
+        headings: ["Device"] + results.values.first.keys,
+        title: "snapshot results"
+      }
+      puts ""
+      puts Terminal::Table.new(params)
+      puts ""
+    end
+
+    def launch(language, device_type, launch_arguments)
       screenshots_path = TestCommandGenerator.derived_data_path
       FileUtils.rm_rf(File.join(screenshots_path, "Logs"))
       FileUtils.rm_rf(screenshots_path) if Snapshot.config[:clean]
       FileUtils.mkdir_p(screenshots_path)
 
       File.write("/tmp/language.txt", language)
+      File.write("/tmp/snapshot-launch_arguments.txt", launch_arguments.last)
 
       Fixes::SimulatorZoomFix.patch
 
+      Snapshot.kill_simulator # because of https://github.com/fastlane/snapshot/issues/337
+      `xcrun simctl shutdown booted`
+
       command = TestCommandGenerator.generate(device_type: device_type)
 
       Helper.log_alert("#{device_type} - #{language}")
@@ -82,7 +127,7 @@ module Snapshot
 
                                                 self.number_of_retries += 1
                                                 if self.number_of_retries < 20
-                                                  launch(language, device_type)
+                                                  launch(language, device_type, launch_arguments)
                                                 else
                                                   # It's important to raise an error, as we don't want to collect the screenshots
                                                   raise "Too many errors... no more retries...".red
@@ -90,7 +135,7 @@ module Snapshot
                                               end)
 
       raw_output = File.read(TestCommandGenerator.xcodebuild_log_path)
-      Collector.fetch_screenshots(raw_output, language, device_type)
+      Collector.fetch_screenshots(raw_output, language, device_type, launch_arguments.first)
     end
 
     def clear_previous_screenshots

data/lib/snapshot/setup.rb

@@ -19,10 +19,10 @@ module Snapshot
       puts "Open your Xcode project and make sure to do the following:".yellow
       puts "1) Add the ./SnapshotHelper.swift to your UI Test target".yellow
       puts "   You can move the file anywhere you want".yellow
-      puts "2) Call `setLanguage(app)` when launching your app".yellow
+      puts "2) Call `setupSnapshot(app)` when launching your app".yellow
       puts ""
       puts "  let app = XCUIApplication()"
-      puts "  setLanguage(app)"
+      puts "  setupSnapshot(app)"
       puts "  app.launch()"
       puts ""
       puts "3) Add `snapshot(\"0Launch\")` to wherever you want to create the screenshots".yellow

data/lib/snapshot/version.rb

@@ -1,4 +1,4 @@
 module Snapshot
-  VERSION = "1.2.2"
+  VERSION = "1.3.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.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastimage