fastlane 1.111.0 → 2.0.1

data/snapshot/lib/assets/SnapshotHelper2-3.swift

@@ -0,0 +1,140 @@
+//
+//  SnapshotHelper.swift
+//  Example
+//
+//  Created by Felix Krause on 10/8/15.
+//  Copyright © 2015 Felix Krause. All rights reserved.
+//
+
+// This file should be used if your UI Tests are written in Swift 2.3
+
+import Foundation
+import XCTest
+
+var deviceLanguage = ""
+var locale = ""
+
+@available(*, deprecated, message="use setupSnapshot: instead")
+func setLanguage(app: XCUIApplication) {
+    setupSnapshot(app)
+}
+
+func setupSnapshot(app: XCUIApplication) {
+    Snapshot.setupSnapshot(app)
+}
+
+func snapshot(name: String, waitForLoadingIndicator: Bool = true) {
+    Snapshot.snapshot(name, waitForLoadingIndicator: waitForLoadingIndicator)
+}
+
+public class Snapshot: NSObject {
+
+    public class func setupSnapshot(app: XCUIApplication) {
+        setLanguage(app)
+        setLocale(app)
+        setLaunchArguments(app)
+    }
+
+    class func setLanguage(app: XCUIApplication) {
+        guard let prefix = pathPrefix() else {
+            return
+        }
+
+        let path = prefix.stringByAppendingPathComponent("language.txt")
+
+        do {
+            let trimCharacterSet = NSCharacterSet.whitespaceAndNewlineCharacterSet()
+            deviceLanguage = try NSString(contentsOfFile: path, encoding: NSUTF8StringEncoding).stringByTrimmingCharactersInSet(trimCharacterSet) as String
+            app.launchArguments += ["-AppleLanguages", "(\(deviceLanguage))"]
+        } catch {
+            print("Couldn't detect/set language...")
+        }
+    }
+
+    class func setLocale(app: XCUIApplication) {
+        guard let prefix = pathPrefix() else {
+            return
+        }
+
+        let path = prefix.stringByAppendingPathComponent("locale.txt")
+
+        do {
+            let trimCharacterSet = NSCharacterSet.whitespaceAndNewlineCharacterSet()
+            locale = try NSString(contentsOfFile: path, encoding: NSUTF8StringEncoding).stringByTrimmingCharactersInSet(trimCharacterSet) as String
+        } catch {
+            print("Couldn't detect/set locale...")
+        }
+        if locale.isEmpty {
+            locale = NSLocale(localeIdentifier: deviceLanguage).localeIdentifier
+        }
+        app.launchArguments += ["-AppleLocale", "\"\(locale)\""]
+    }
+
+    class func setLaunchArguments(app: XCUIApplication) {
+        guard let prefix = pathPrefix() else {
+            return
+        }
+
+        let path = prefix.stringByAppendingPathComponent("snapshot-launch_arguments.txt")
+        app.launchArguments += ["-FASTLANE_SNAPSHOT", "YES", "-ui_testing"]
+
+        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...")
+        }
+    }
+
+    public class func snapshot(name: String, waitForLoadingIndicator: Bool = true) {
+        if waitForLoadingIndicator {
+            waitForLoadingIndicatorToDisappear()
+        }
+
+        print("snapshot: \(name)") // more information about this, check out https://github.com/fastlane/fastlane/tree/master/snapshot#how-does-it-work
+
+        sleep(1) // Waiting for the animation to be finished (kind of)
+
+        #if os(tvOS)
+            XCUIApplication().childrenMatchingType(.Browser).count
+        #else
+            XCUIDevice.sharedDevice().orientation = .Unknown
+        #endif
+    }
+
+    class func waitForLoadingIndicatorToDisappear() {
+        #if os(tvOS)
+            return
+        #endif
+
+        let query = XCUIApplication().statusBars.childrenMatchingType(.Other).elementBoundByIndex(1).childrenMatchingType(.Other)
+
+        while (0..<query.count).map({ query.elementBoundByIndex($0) }).contains({ $0.isLoadingIndicator }) {
+            sleep(1)
+            print("Waiting for loading indicator to disappear...")
+        }
+    }
+
+    class func pathPrefix() -> NSString? {
+        if let path = NSProcessInfo().environment["SIMULATOR_HOST_HOME"] as NSString? {
+            return path.stringByAppendingPathComponent("Library/Caches/tools.fastlane")
+        }
+        print("Couldn't find Snapshot configuration files at ~/Library/Caches/tools.fastlane")
+        return nil
+    }
+}
+
+extension XCUIElement {
+    var isLoadingIndicator: Bool {
+        return self.frame.size == CGSize(width: 10, height: 20)
+    }
+}
+
+// Please don't remove the lines below
+// They are used to detect outdated configuration files
+// SnapshotHelperVersion [1.2]

data/snapshot/lib/snapshot.rb

@@ -0,0 +1,59 @@
+require 'snapshot/runner'
+require 'snapshot/reports_generator'
+require 'snapshot/detect_values'
+require 'snapshot/screenshot_flatten'
+require 'snapshot/screenshot_rotate'
+require 'snapshot/dependency_checker'
+require 'snapshot/latest_os_version'
+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 'snapshot/fixes/hardware_keyboard_fix'
+
+require 'fastlane_core'
+
+require 'open3'
+
+module Snapshot
+  # Use this to just setup the configuration attribute and set it later somewhere else
+  class << self
+    attr_accessor :config
+
+    attr_accessor :project
+
+    attr_accessor :cache
+
+    def config=(value)
+      @config = value
+      DetectValues.set_additional_default_values
+      @cache = {}
+    end
+
+    def snapfile_name
+      "Snapfile"
+    end
+
+    def kill_simulator
+      `killall 'iOS Simulator' &> /dev/null`
+      `killall Simulator &> /dev/null`
+    end
+  end
+
+  Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
+  UI = FastlaneCore::UI
+  ROOT = Pathname.new(File.expand_path('../..', __FILE__))
+  DESCRIPTION = "Automate taking localized screenshots of your iOS and tvOS apps on every device"
+
+  Snapshot::DependencyChecker.check_dependencies
+
+  def self.xcode_version
+    `xcodebuild -version`.match(/Xcode (.*)/)[1]
+  end
+
+  def self.min_xcode7?
+    xcode_version.split(".").first.to_i >= 7
+  end
+end

data/snapshot/lib/snapshot/collector.rb

@@ -0,0 +1,92 @@
+module Snapshot
+  # Responsible for collecting the generated screenshots and copying them over to the output directory
+  class Collector
+    # Returns true if it succeeds
+    def self.fetch_screenshots(output, dir_name, 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")
+
+      to_store = attachments(containing)
+      matches = output.scan(/snapshot: (.*)/)
+
+      if to_store.count == 0 && matches.count == 0
+        return false
+      end
+
+      if matches.count != to_store.count
+        UI.error "Looks like the number of screenshots (#{to_store.count}) doesn't match the number of names (#{matches.count})"
+      end
+
+      matches.each_with_index do |current, index|
+        name = current[0]
+        filename = to_store[index]
+
+        language_folder = File.join(Snapshot.config[:output_directory], dir_name)
+        FileUtils.mkdir_p(language_folder)
+
+        device_name = device_type.delete(" ")
+        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
+          UI.success "Copying file '#{from_path}' to '#{output_path}'..."
+        else
+          UI.success "Copying '#{output_path}'..."
+        end
+        FileUtils.cp(from_path, output_path)
+      end
+
+      return true
+    end
+
+    def self.attachments(containing)
+      UI.message "Collecting screenshots..."
+      plist_path = Dir[File.join(containing, "*.plist")].last # we clean the folder before each run
+      return attachments_in_file(plist_path)
+    end
+
+    def self.attachments_in_file(plist_path)
+      UI.verbose "Loading up '#{plist_path}'..."
+      report = Plist.parse_xml(plist_path)
+
+      to_store = [] # contains the names of all the attachments we want to use
+
+      report["TestableSummaries"].each do |summary|
+        (summary["Tests"] || []).each do |test|
+          (test["Subtests"] || []).each do |subtest|
+            (subtest["Subtests"] || []).each do |subtest2|
+              (subtest2["Subtests"] || []).each do |subtest3|
+                (subtest3["ActivitySummaries"] || []).each do |activity|
+                  check_activity(activity, to_store)
+                end
+              end
+            end
+          end
+        end
+      end
+
+      UI.message "Found #{to_store.count} screenshots..."
+      UI.verbose "Found #{to_store.join(', ')}"
+      return to_store
+    end
+
+    def self.check_activity(activity, to_store)
+      # On iOS, we look for the "Unknown" rotation gesture that signals a snapshot was taken here.
+      # On tvOS, we look for "Browser" count.
+      # These are both events that are not normally triggered by UI testing, making it easy for us to
+      # locate where snapshot() was invoked.
+      if activity["Title"] == "Set device orientation to Unknown" || activity["Title"] == "Get number of matches for: Children matching type Browser"
+        if activity["Attachments"]
+          to_store << activity["Attachments"].last["FileName"]
+        else # Xcode 7.3 has stopped including 'Attachments', so we synthesize the filename manually
+          to_store << "Screenshot_#{activity['UUID']}.png"
+        end
+      end
+      (activity["SubActivities"] || []).each do |subactivity|
+        check_activity(subactivity, to_store)
+      end
+    end
+  end
+end

data/snapshot/lib/snapshot/commands_generator.rb

@@ -0,0 +1,108 @@
+require 'commander'
+
+HighLine.track_eof = false
+
+module Snapshot
+  class CommandsGenerator
+    include Commander::Methods
+
+    def self.start
+      self.new.run
+    end
+
+    def run
+      program :name, 'snapshot'
+      program :version, Fastlane::VERSION
+      program :description, 'CLI for \'snapshot\' - Automate taking localized screenshots of your iOS app on every device'
+      program :help, 'Author', 'Felix Krause <snapshot@krausefx.com>'
+      program :help, 'Website', 'https://fastlane.tools'
+      program :help, 'GitHub', 'https://github.com/fastlane/snapshot'
+      program :help_formatter, :compact
+
+      global_option('--verbose', 'Shows a more verbose output') { $verbose = true }
+
+      always_trace!
+
+      FastlaneCore::CommanderGenerator.new.generate(Snapshot::Options.available_options)
+
+      command :run do |c|
+        c.syntax = 'snapshot'
+        c.description = 'Take new screenshots based on the Snapfile.'
+
+        c.action do |args, options|
+          load_config(options)
+
+          Snapshot::DependencyChecker.check_simulators
+          Snapshot::Runner.new.work
+        end
+      end
+
+      command :init do |c|
+        c.syntax = 'snapshot init'
+        c.description = "Creates a new Snapfile in the current directory"
+
+        c.action do |args, options|
+          require 'snapshot/setup'
+          path = (Snapshot::Helper.fastlane_enabled? ? './fastlane' : '.')
+          Snapshot::Setup.create(path)
+        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"
+        c.option '-i', '--ios String', String, 'The comma separated list of iOS Versions you want to use'
+        c.option '--force', 'Disables confirmation prompts'
+
+        c.action do |args, options|
+          options.default ios_version: Snapshot::LatestOsVersion.ios_version
+          versions = options.ios_version.split(',') if options.ios_version
+          require 'snapshot/reset_simulators'
+
+          Snapshot::ResetSimulators.clear_everything!(versions, options.force)
+        end
+      end
+
+      command :clear_derived_data do |c|
+        c.syntax = 'snapshot clear_derived_data -f path'
+        c.description = "Clear the directory where build products and other derived data will go"
+
+        c.action do |args, options|
+          load_config(options)
+          derived_data_path = Snapshot.config[:derived_data_path]
+
+          if !derived_data_path
+            Snapshot::UI.user_error! "No derived_data_path"
+          elsif !Dir.exist?(derived_data_path)
+            Snapshot::UI.important "Path #{derived_data_path} does not exist"
+          else
+            FileUtils.rm_rf(derived_data_path)
+            Snapshot::UI.success "Removed #{derived_data_path}"
+          end
+        end
+      end
+
+      default_command :run
+
+      run!
+    end
+
+    private
+
+    def load_config(options)
+      o = options.__hash__.dup
+      o.delete(:verbose)
+      Snapshot.config = FastlaneCore::Configuration.create(Snapshot::Options.available_options, o)
+    end
+  end
+end

data/snapshot/lib/snapshot/dependency_checker.rb

@@ -0,0 +1,50 @@
+module Snapshot
+  class DependencyChecker
+    def self.check_dependencies
+      return if Helper.test?
+
+      self.check_xcode_select
+      self.check_simctl
+    end
+
+    def self.check_xcode_select
+      unless `xcode-select -v`.include? "xcode-select version"
+        UI.error '#############################################################'
+        UI.error "# You have to install Xcode command line tools to use snapshot"
+        UI.error "# Install the latest version of Xcode from the AppStore"
+        UI.error "# Run xcode-select --install to install the developer tools"
+        UI.error '#############################################################'
+        UI.user_error!("Run 'xcode-select --install' and start snapshot again")
+      end
+
+      if Snapshot::LatestOsVersion.ios_version.to_f < 9 # to_f is bad, but should be good enough
+        UI.error '#############################################################'
+        UI.error "# Your xcode-select Xcode version is below 7.0"
+        UI.error "# To use snapshot 1.0 and above you need at least iOS 9"
+        UI.error "# Set the path to the Xcode version that supports UI Tests"
+        UI.error "# or downgrade to versions older than snapshot 1.0"
+        UI.error '#############################################################'
+        UI.user_error!("Run 'sudo xcode-select -s /Applications/Xcode-beta.app'")
+      end
+    end
+
+    def self.check_simulators
+      UI.verbose("Found #{FastlaneCore::Simulator.all.count} simulators.")
+      if FastlaneCore::Simulator.all.count == 0
+        UI.error '#############################################################'
+        UI.error "# You have to add new simulators using Xcode"
+        UI.error "# You can let snapshot create new simulators: 'snapshot reset_simulators'"
+        UI.error "# Manually: Xcode => Window => Devices"
+        UI.error "# Please run `instruments -s` to verify your xcode path"
+        UI.error '#############################################################'
+        UI.user_error!("Create the new simulators and run this script again")
+      end
+    end
+
+    def self.check_simctl
+      unless `xcrun simctl`.include? "openurl"
+        UI.user_error!("Could not find `xcrun simctl`. Make sure you have the latest version of Xcode and Mac OS installed.")
+      end
+    end
+  end
+end