snapshot 0.10.2 → 1.0.1

data/bin/snapshot

@@ -4,12 +4,9 @@ $:.push File.expand_path("../../lib", __FILE__)
 
 require 'snapshot'
 require 'commander'
-require 'snapshot/snapfile_creator'
-require 'snapshot/snapshot_config'
 
 HighLine.track_eof = false
 
-
 class SnapshotApplication
   include Commander::Methods
 
@@ -21,38 +18,23 @@ class SnapshotApplication
     program :help, 'GitHub', 'https://github.com/krausefx/snapshot'
     program :help_formatter, :compact
 
-    global_option '--snapfile PATH', String, 'Custom path for your Snapfile.'
-    global_option '--nobuild', 'Skips the build process when running snapshot.'
-    global_option '--noclean', 'Skips the clean process of the build command when running snapshot.'
-    global_option('--verbose', 'Shows more output including all output printed by Instruments.') { $verbose = true }
+    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|
-        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, build: !options.nobuild)
-        end
-      end
-    end
-
-    command :test do |c|
-      c.syntax = 'snapshot test'
-      c.description = 'Runs the automated tests.'
+        o = options.__hash__.dup
+        o.delete(:verbose)
+        Snapshot.config = FastlaneCore::Configuration.create(Snapshot::Options.available_options, o)
 
-      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, build: !options.nobuild, take_snapshots: false)
-        end
+        Snapshot::DependencyChecker.check_simulators
+        Snapshot::Runner.new.work
       end
     end
 
@@ -61,8 +43,9 @@ class SnapshotApplication
       c.description = "Creates a new Snapfile in the current directory"
 
       c.action do |args, options|
-        path = (Snapshot::Helper.fastlane_enabled?? './fastlane' : '.')
-        Snapshot::SnapfileCreator.create(path)
+        require 'snapshot/setup'
+        path = (Snapshot::Helper.fastlane_enabled? ? './fastlane' : '.')
+        Snapshot::Setup.create(path)
       end
     end
 

data/lib/assets/SnapfileTemplate

@@ -6,45 +6,26 @@ devices([
   "iPhone 6 Plus",
   "iPhone 5",
   "iPhone 4s",
-  "iPad Air"
+  "iPad Retina"
 ])
 
 languages([
-  'en-US',
-  'de-DE',
-  'it-IT'
+  "en-US",
+  "de-DE",
+  "it-IT"
 ])
 
-# Where should the resulting screenshots be stored?
-screenshots_path "./screenshots"
-
-# clear_previous_screenshots # remove the '#'' to clear all previously generated screenshots before creating new ones
-
-# JavaScript UIAutomation file
-# js_file './snapshot.js'
-
-# The name of the project's scheme
-# scheme 'SchemeName'
-
-# Where is your project (or workspace)? Provide the full path here
-# project_path './YourProject.xcworkspace'
-
-# By default, the latest version should be used automatically. If you want to change it, do it here
-# ios_version '8.1'
-
-# Comment out the line below to add a `SNAPSHOT` preprocessor macro
-# More information available: https://github.com/krausefx/snapshot#custom-args-for-the-build-command
-# custom_build_args "GCC_PREPROCESSOR_DEFINITIONS='$(inherited) SNAPSHOT=1' OTHER_SWIFT_FLAGS='$(inherited) -D SNAPSHOT'"
+# The name of the scheme which contains the UI Tests
+# scheme "SchemeName"
 
+# Where should the resulting screenshots be stored?
+# screenshots_path "./screenshots"
 
-# Custom Callbacks
+# clear_previous_screenshots # remove the '#' to clear all previously generated screenshots before creating new ones
 
-# setup_for_device_change do |device, udid, language|
-#   puts "Running #{language} on #{device}"
-#   system("./populateDatabase.sh")
-# end
+# Choose which project/workspace to use
+# project "./Project.xcodeproj"
+# workspace "./Project.xcworkspace"
 
-# teardown_device do |language, device|
-#   puts "Finished with #{language} on #{device}"
-#   system("./cleanup.sh")
-# end
+# For more information about all available options run
+# snapshot --help

data/lib/assets/SnapshotHelper.swift

@@ -0,0 +1,50 @@
+//
+//  SnapshotHelper.swift
+//  Example
+//
+//  Created by Felix Krause on 10/8/15.
+//  Copyright © 2015 Felix Krause. All rights reserved.
+//
+
+import Foundation
+import XCTest
+
+var deviceLanguage = ""
+
+func setLanguage(app: XCUIApplication)
+{
+    let path = "/tmp/language.txt"
+    
+    do {
+        let locale = try NSString(contentsOfFile: path, encoding: NSUTF8StringEncoding) as String
+        deviceLanguage = locale
+        app.launchArguments = ["-AppleLanguages", "(\(locale))"]
+    } catch {
+        print("Couldn't detect/set language...")
+    }
+}
+
+func snapshot(name: String, waitForLoadingIndicator: Bool = true)
+{
+    if (waitForLoadingIndicator)
+    {
+        waitForLoadingIndicatorToDisappear()
+    }
+    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)
+}
+
+func waitForLoadingIndicatorToDisappear()
+{
+    let query = XCUIApplication().statusBars.childrenMatchingType(.Other).elementBoundByIndex(1).childrenMatchingType(.Other)
+    
+    while (query.count > 4) {
+        sleep(1)
+        print("Number of Elements in Status Bar: \(query.count)... waiting for status bar to disappear")
+    }
+}

data/lib/snapshot.rb

@@ -1,18 +1,37 @@
 require 'snapshot/version'
-require 'snapshot/snapshot_config'
 require 'snapshot/runner'
-require 'snapshot/builder'
-require 'snapshot/snapshot_file'
 require 'snapshot/reports_generator'
+require 'snapshot/detect_values'
 require 'snapshot/screenshot_flatten'
 require 'snapshot/screenshot_rotate'
-require 'snapshot/simulators'
 require 'snapshot/dependency_checker'
 require 'snapshot/latest_ios_version'
+require 'snapshot/test_command_generator'
+require 'snapshot/error_handler'
+require 'snapshot/collector'
+require 'snapshot/options'
 
 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
+
+    def config=(value)
+      @config = value
+      DetectValues.set_additional_default_values
+    end
+
+    def snapfile_name
+      "Snapfile"
+    end
+  end
+
   Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
 
   Snapshot::DependencyChecker.check_dependencies

data/lib/snapshot/collector.rb

@@ -0,0 +1,72 @@
+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)
+      # 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 matches.count != to_store.count
+        Helper.log.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], language)
+        FileUtils.mkdir_p(language_folder)
+
+        device_name = device_type.delete(" ")
+        output_path = File.join(language_folder, [device_name, name].join("-") + ".png")
+        from_path = File.join(attachments_path, filename)
+        if $verbose
+          Helper.log.info "Copying file '#{from_path}' to '#{output_path}'...".green
+        else
+          Helper.log.info "Copying '#{output_path}'...".green
+        end
+        FileUtils.cp(from_path, output_path)
+      end
+    end
+
+    def self.attachments(containing)
+      Helper.log.info "Collecting screenshots..."
+
+      plist_path = Dir[File.join(containing, "*.plist")].last # we clean the folder before each run
+      Helper.log.info "Loading up '#{plist_path}'..." if $verbose
+      report = Plist.parse_xml(plist_path)
+
+      activities = []
+      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|
+                  # 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.*\].*/)
+                  activities << activity if was_snapshot
+                end
+              end
+            end
+          end
+        end
+      end
+
+      Helper.log.info "Found #{activities.count} screenshots..."
+
+      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
+        to_store << attachment_entry["Attachments"].last["FileName"]
+      end
+
+      Helper.log.info "Found #{to_store.join(', ')}" if $verbose
+      return to_store
+    end
+  end
+end

data/lib/snapshot/dependency_checker.rb

@@ -2,13 +2,11 @@ module Snapshot
   class DependencyChecker
     def self.check_dependencies
       self.check_xcode_select
-      self.check_xctool
-      self.check_for_automation_subfolder
       self.check_simctl
     end
 
     def self.check_xcode_select
-      unless `xcode-select -v`.include?"xcode-select version "
+      unless `xcode-select -v`.include? "xcode-select version"
         Helper.log.fatal '#############################################################'
         Helper.log.fatal "# You have to install the Xcode commdand line tools to use snapshot"
         Helper.log.fatal "# Install the latest version of Xcode from the AppStore"
@@ -16,11 +14,21 @@ module Snapshot
         Helper.log.fatal '#############################################################'
         raise "Run 'xcode-select --install' and start snapshot again"
       end
+
+      if Snapshot::LatestIosVersion.version.to_f < 9 # to_f is bad, but should be good enough
+        Helper.log.fatal '#############################################################'
+        Helper.log.fatal "# Your xcode-select Xcode version is below 9.0"
+        Helper.log.fatal "# To use snapshot 1.0 and above you need at leat iOS 9"
+        Helper.log.fatal "# Set the path to the Xcode version that supports UI Tests"
+        Helper.log.fatal "# or downgrade to versions older than snapshot 1.0"
+        Helper.log.fatal '#############################################################'
+        raise "Run 'sudo xcode-select -s /Applications/Xcode-beta.app'"
+      end
     end
 
     def self.check_simulators
-      Helper.log.debug "Found #{Simulators.available_devices.count} simulators." if $verbose
-      if Simulators.available_devices.count < 1
+      Helper.log.debug "Found #{FastlaneCore::Simulator.all.count} simulators." if $verbose
+      if FastlaneCore::Simulator.all.count == 0
         Helper.log.fatal '#############################################################'
         Helper.log.fatal "# You have to add new simulators using Xcode"
         Helper.log.fatal "# You can let snapshot create new simulators: 'snapshot reset_simulators'"
@@ -31,28 +39,8 @@ module Snapshot
       end
     end
 
-    def self.xctool_installed?
-      return `which xctool`.length > 1
-    end
-
-    def self.check_xctool
-      if not self.xctool_installed?
-        Helper.log.info '#############################################################'
-        Helper.log.info "# xctool is recommended to build the apps"
-        Helper.log.info "# Install it using 'brew install xctool'"
-        Helper.log.info "# Falling back to xcodebuild instead "
-        Helper.log.info '#############################################################'
-      end
-    end
-
-    def self.check_for_automation_subfolder
-      if File.directory?"./Automation" or File.exists?"./Automation"
-        raise "Seems like you have an 'Automation' folder in the current directory. You need to delete/rename it!".red
-      end
-    end
-
     def self.check_simctl
-      unless `xcrun simctl`.include?"openurl"
+      unless `xcrun simctl`.include? "openurl"
         raise "Could not find `xcrun simctl`. Make sure you have the latest version of Xcode and Mac OS installed.".red
       end
     end

data/lib/snapshot/detect_values.rb

@@ -0,0 +1,33 @@
+module Snapshot
+  class DetectValues
+    # This is needed as these are more complex default values
+    def self.set_additional_default_values
+      config = Snapshot.config
+
+      FastlaneCore::Project.detect_projects(config)
+
+      Snapshot.project = FastlaneCore::Project.new(config)
+
+      # Go into the project's folder
+      Dir.chdir(File.expand_path("..", Snapshot.project.path)) do
+        config.load_configuration_file(Snapshot.snapfile_name)
+      end
+
+      Snapshot.project.select_scheme
+
+      # Devices
+      unless config[:devices]
+        config[:devices] = []
+
+        # We only care about a subset of the simulators
+        FastlaneCore::Simulator.all.each do |sim|
+          next if sim.name.include?("iPad") and !sim.name.include?("Retina") # we only need one iPad
+          next if sim.name.include?("6s") # same screen resolution
+          next if sim.name.include?("5s") # same screen resolution
+
+          config[:devices] << sim.name
+        end
+      end
+    end
+  end
+end

data/lib/snapshot/error_handler.rb

@@ -0,0 +1,31 @@
+module Snapshot
+  # This classes methods are called when something goes wrong in the building process
+  class ErrorHandler
+    class TestsFailedException < StandardError
+    end
+
+    class << self
+      # @param [Array] The output of the errored build (line by line)
+      # This method should raise an exception in any case, as the return code indicated a failed build
+      def handle_test_error(output, return_code)
+        # The order of the handling below is import
+
+        if return_code == 65
+          raise TestsFailedException.new, "Tests failed - check out the log above".red
+        end
+
+        case output
+        when /com\.apple\.CoreSimulator\.SimError/
+          print "The simulator failed to launch - retrying..."
+        end
+      end
+
+      private
+
+      # Just to make things easier
+      def print(text)
+        Helper.log.error text.red
+      end
+    end
+  end
+end

data/lib/snapshot/latest_ios_version.rb

@@ -5,9 +5,14 @@ module Snapshot
       return ENV["SNAPSHOT_IOS_VERSION"] if ENV["SNAPSHOT_IOS_VERSION"]
       return @version if @version
 
-      output = `xcodebuild -version -sdk`.split("Mac").last # don't care about the Mac Part
-      matched = output.match(/iPhoneSimulator([\d\.]+)\.sdk/)
-      
+      # We do all this, because we would get all kind of crap output generated by xcodebuild
+      # so we need to ignore stderror
+      output = ''
+      Open3.popen3('xcodebuild -version -sdk') do |stdin, stdout, stderr, wait_thr|
+        output = stdout.read
+      end
+
+      matched = output.match(/iOS ([\d\.]+) \(.*/)
       if matched.length > 1
         return @version ||= matched[1]
       else
@@ -15,4 +20,4 @@ module Snapshot
       end
     end
   end
-end
+end