fastlane_iac_publish 0.1.0

data/snapshot/lib/snapshot/reports_generator.rb

@@ -0,0 +1,125 @@
+require_relative 'module'
+
+module Snapshot
+  class ReportsGenerator
+    require 'erb'
+    require 'fastimage'
+
+    def generate
+      UI.message("Generating HTML Report")
+
+      screens_path = Snapshot.config[:output_directory]
+
+      @data_by_language = {}
+      @data_by_screen = {}
+
+      Dir[File.join(screens_path, "*")].sort.each do |language_folder|
+        language = File.basename(language_folder)
+        Dir[File.join(language_folder, '*.png')].sort.each do |screenshot|
+          file_name = File.basename(screenshot)
+          available_devices.each do |key_name, output_name|
+            next unless file_name.include?(key_name)
+            # This screenshot is from this device
+
+            @data_by_language[language] ||= {}
+            @data_by_language[language][output_name] ||= []
+
+            screen_name = file_name.sub(key_name + '-', '').sub('.png', '')
+            @data_by_screen[screen_name] ||= {}
+            @data_by_screen[screen_name][output_name] ||= {}
+
+            resulting_path = File.join('.', language, file_name)
+            @data_by_language[language][output_name] << resulting_path
+            @data_by_screen[screen_name][output_name][language] = resulting_path
+            break # to not include iPhone 6 and 6 Plus (name is contained in the other name)
+          end
+        end
+      end
+
+      html_path = File.join(Snapshot::ROOT, "lib", "snapshot/page.html.erb")
+      html = ERB.new(File.read(html_path)).result(binding) # https://web.archive.org/web/20160430190141/www.rrn.dk/rubys-erb-templating-system
+
+      export_path = "#{screens_path}/screenshots.html"
+      File.write(export_path, html)
+
+      export_path = File.expand_path(export_path)
+      UI.success("Successfully created HTML file with an overview of all the screenshots: '#{export_path}'")
+      system("open '#{export_path}'") unless Snapshot.config[:skip_open_summary]
+    end
+
+    def xcode_8_and_below_device_name_mappings
+      # The order IS important, since those names are used to check for include?
+      # and the iPhone 6 is included in the iPhone 6 Plus
+      {
+        'AppleTV1080p' => 'Apple TV',
+        'iPhone7Plus' => "iPhone7Plus (5.5-Inch)",
+        'iPhone7' => "iPhone7 (4.7-Inch)",
+        'iPhone6sPlus' => "iPhone6sPlus (5.5-Inch)",
+        'iPhone6Plus' => "iPhone6Plus (5.5-Inch)",
+        'iPhone6s' => "iPhone6s (4.7-Inch)",
+        'iPhone6' => "iPhone6 (4.7-Inch)",
+        'iPhone5' => "iPhone5 (4-Inch)",
+        'iPhone4' => "iPhone4 (3.5-Inch)",
+        'iPhoneSE' => "iPhone SE",
+        'iPad2' => "iPad2",
+        'iPadAir2' => 'iPad Air 2',
+        'iPadPro(12.9-inch)' => 'iPad Air Pro (12.9-inch)',
+        'iPadPro(9.7-inch)' => 'iPad Air Pro (9.7-inch)',
+        'iPadPro(9.7inch)' => "iPad Pro (9.7-inch)",
+        'iPadPro(12.9inch)' => "iPad Pro (12.9-inch)",
+        'iPadPro' => "iPad Pro",
+        'iPad' => "iPad",
+        'Mac' => "Mac"
+      }
+    end
+
+    def xcode_9_and_above_device_name_mappings
+      {
+        # snapshot in Xcode 9 saves screenshots with the SIMULATOR_DEVICE_NAME
+        # which includes spaces
+        'iPhone XS Max' => "iPhone XS Max",
+        'iPhone XS' => "iPhone XS",
+        'iPhone XR' => "iPhone XR",
+        'iPhone 8 Plus' => "iPhone 8 Plus",
+        'iPhone 8' => "iPhone 8",
+        'iPhone X' => "iPhone X",
+        'iPhone 7 Plus' => "iPhone 7 Plus (5.5-Inch)",
+        'iPhone 7' => "iPhone 7 (4.7-Inch)",
+        'iPhone 6s Plus' => "iPhone 6s Plus (5.5-Inch)",
+        'iPhone 6 Plus' => "iPhone 6 Plus (5.5-Inch)",
+        'iPhone 6s' => "iPhone 6s (4.7-Inch)",
+        'iPhone 6' => "iPhone 6 (4.7-Inch)",
+        'iPhone 5s' => "iPhone 5s (4-Inch)",
+        'iPhone 5' => "iPhone 5 (4-Inch)",
+        'iPhone SE' => "iPhone SE",
+        'iPhone 4s' => "iPhone 4s (3.5-Inch)",
+        'iPad 2' => 'iPad 2',
+        'iPad Air 2' => 'iPad Air 2',
+        'iPad Air' => 'iPad Air',
+        'iPad (5th generation)' => 'iPad (5th generation)',
+        'iPad Pro (9.7-inch)' => 'iPad Pro (9.7-inch)',
+        'iPad Pro (9.7 inch)' => 'iPad Pro (9.7-inch)', # iOS 10.3.1 simulator
+        'iPad Pro (10.5-inch)' => 'iPad Pro (10.5-inch)',
+        'iPad Pro (11-inch)' => 'iPad Pro (11-inch)',
+        'iPad Pro (12.9-inch) (3rd generation)' => 'iPad Pro (12.9-inch) (3rd generation)',
+        'iPad Pro (12.9-inch) (2nd generation)' => 'iPad Pro (12.9-inch) (2nd generation)',
+        'iPad Pro (12.9-inch)' => 'iPad Pro (12.9-inch)',
+        'iPad Pro (12.9 inch)' => 'iPad Pro (12.9-inch)', # iOS 10.3.1 simulator
+        'iPad Pro' => 'iPad Pro (12.9-inch)', # iOS 9.3 simulator
+        'Apple TV 1080p' => 'Apple TV',
+        'Apple TV 4K (at 1080p)' => 'Apple TV 4K (at 1080p)',
+        'Apple TV 4K' => 'Apple TV 4K',
+        'Apple TV' => 'Apple TV',
+        'Mac' => 'Mac'
+      }
+    end
+
+    def available_devices
+      if Helper.xcode_at_least?("9.0")
+        return xcode_9_and_above_device_name_mappings
+      else
+        return xcode_8_and_below_device_name_mappings
+      end
+    end
+  end
+end

data/snapshot/lib/snapshot/reset_simulators.rb

@@ -0,0 +1,122 @@
+require 'fastlane_core/device_manager'
+require_relative 'module'
+
+module Snapshot
+  class ResetSimulators
+    def self.clear_everything!(ios_versions, force = false)
+      # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+      # !! Warning: This script will remove all your existing simulators !!
+      # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+      sure = true if FastlaneCore::Env.truthy?("SNAPSHOT_FORCE_DELETE") || force
+      begin
+        sure = UI.confirm("Are you sure? All your simulators will be DELETED and new ones will be created! (You can use `SNAPSHOT_FORCE_DELETE` to skip this confirmation)") unless sure
+      rescue => e
+        UI.user_error!("Please make sure to pass the `--force` option to reset simulators when running in non-interactive mode") unless UI.interactive?
+        raise e
+      end
+
+      UI.abort_with_message!("User cancelled action") unless sure
+
+      if ios_versions
+        ios_versions.each do |version|
+          FastlaneCore::Simulator.delete_all_by_version(os_version: version)
+        end
+      else
+        FastlaneCore::Simulator.delete_all
+      end
+
+      FastlaneCore::SimulatorTV.delete_all
+      FastlaneCore::SimulatorWatch.delete_all
+
+      all_runtime_type = runtimes
+      # == Runtimes ==
+      # iOS 9.3 (9.3 - 13E233) (com.apple.CoreSimulator.SimRuntime.iOS-9-3)
+      # iOS 10.0 (10.0 - 14A345) (com.apple.CoreSimulator.SimRuntime.iOS-10-0)
+      # iOS 10.1 (10.1 - 14B72) (com.apple.CoreSimulator.SimRuntime.iOS-10-1)
+      # iOS 10.2 (10.2 - 14C89) (com.apple.CoreSimulator.SimRuntime.iOS-10-2)
+      # tvOS 10.1 (10.1 - 14U591) (com.apple.CoreSimulator.SimRuntime.tvOS-10-1)
+      # watchOS 3.1 (3.1 - 14S471a) (com.apple.CoreSimulator.SimRuntime.watchOS-3-1)
+      #
+      # Xcode 9 changed the format
+      # == Runtimes ==
+      # iOS 11.0 (11.0 - 15A5361a) - com.apple.CoreSimulator.SimRuntime.iOS-11-0
+      # tvOS 11.0 (11.0 - 15J5368a) - com.apple.CoreSimulator.SimRuntime.tvOS-11-0
+      # watchOS 4.0 (4.0 - 15R5363a) - com.apple.CoreSimulator.SimRuntime.watchOS-4-0
+      ios_versions_ids = filter_runtimes(all_runtime_type, 'iOS', ios_versions)
+      tv_version_ids = filter_runtimes(all_runtime_type, 'tvOS')
+      watch_versions_ids = filter_runtimes(all_runtime_type, 'watchOS')
+
+      all_device_types = `xcrun simctl list devicetypes`.scan(/(.*)\s\((.*)\)/)
+      # == Device Types ==
+      # iPhone 4s (com.apple.CoreSimulator.SimDeviceType.iPhone-4s)
+      # iPhone 5 (com.apple.CoreSimulator.SimDeviceType.iPhone-5)
+      # iPhone 5s (com.apple.CoreSimulator.SimDeviceType.iPhone-5s)
+      # iPhone 6 (com.apple.CoreSimulator.SimDeviceType.iPhone-6)
+      all_device_types.each do |device_type|
+        if device_type.join(' ').include?("Watch")
+          create(device_type, watch_versions_ids, 'watchOS')
+        elsif device_type.join(' ').include?("TV")
+          create(device_type, tv_version_ids, 'tvOS')
+        else
+          create(device_type, ios_versions_ids)
+        end
+      end
+
+      make_phone_watch_pair
+    end
+
+    def self.create(device_type, os_versions, os_name = 'iOS')
+      os_versions.each do |os_version|
+        puts("Creating #{device_type[0]} for #{os_name} version #{os_version[0]}")
+        command = "xcrun simctl create '#{device_type[0]}' #{device_type[1]} #{os_version[1]}"
+        UI.command(command) if FastlaneCore::Globals.verbose?
+        `#{command}`
+      end
+    end
+
+    def self.filter_runtimes(all_runtimes, os = 'iOS', versions = [])
+      all_runtimes.select { |v, id| v[/^#{os}/] }.select { |v, id| v[/#{versions.join("|")}$/] }.uniq
+    end
+
+    def self.devices
+      all_devices = Helper.backticks('xcrun simctl list devices', print: FastlaneCore::Globals.verbose?)
+      # == Devices ==
+      # -- iOS 9.0 --
+      #   iPhone 4s (32246EBC-33B0-47F9-B7BB-5C23C550DF29) (Shutdown)
+      #   iPhone 5 (4B56C101-6B95-43D1-9485-3FBA0E127FFA) (Shutdown)
+      #   iPhone 5s (6379C204-E82A-4FBD-8A22-6A01C7791D62) (Shutdown)
+      # -- Unavailable: com.apple.CoreSimulator.SimRuntime.iOS-8-4 --
+      #   iPhone 4s (FE9D6F85-1C51-4FE6-8597-FCAB5286B869) (Shutdown) (unavailable, runtime profile not found)
+
+      result = all_devices.lines.map do |line|
+        (line.match(/\s+(.+?)\s\(([\w\-]+)\).*/) || []).to_a
+      end
+
+      result.select { |parsed| parsed.length == 3 } # we don't care about those headers
+    end
+
+    def self.runtimes
+      Helper.backticks('xcrun simctl list runtimes', print: FastlaneCore::Globals.verbose?).scan(/(.*)\s\(\d.*(com\.apple[^)\s]*)/)
+    end
+
+    def self.make_phone_watch_pair
+      phones = []
+      watches = []
+      devices.each do |device|
+        full_line, name, id = device
+        phones << id if name.start_with?('iPhone 6') && device_line_usable?(full_line)
+        watches << id if name.end_with?('mm') && device_line_usable?(full_line)
+      end
+
+      if phones.any? && watches.any?
+        puts("Creating device pair of #{phones.last} and #{watches.last}")
+        Helper.backticks("xcrun simctl pair #{watches.last} #{phones.last}", print: FastlaneCore::Globals.verbose?)
+      end
+    end
+
+    def self.device_line_usable?(line)
+      !line.include?("unavailable")
+    end
+  end
+end

data/snapshot/lib/snapshot/runner.rb

@@ -0,0 +1,146 @@
+require 'shellwords'
+require 'plist'
+require 'os'
+require 'thread'
+require 'terminal-table'
+
+require 'fastlane_core/print_table'
+require_relative 'module'
+require_relative 'update'
+require_relative 'test_command_generator'
+require_relative 'reports_generator'
+require_relative 'simulator_launchers/simulator_launcher'
+require_relative 'simulator_launchers/simulator_launcher_xcode_8'
+require_relative 'simulator_launchers/launcher_configuration'
+
+module Snapshot
+  class Runner
+    def work
+      if File.exist?("./fastlane/snapshot.js") || File.exist?("./snapshot.js")
+        UI.error("Found old snapshot configuration file 'snapshot.js'")
+        UI.error("You updated to snapshot 1.0 which now uses UI Automation")
+        UI.error("Please follow the migration guide: https://github.com/fastlane/fastlane/blob/master/snapshot/MigrationGuide.md")
+        UI.error("And read the updated documentation: https://docs.fastlane.tools/actions/snapshot/")
+        sleep(3) # to be sure the user sees this, as compiling clears the screen
+      end
+
+      Snapshot.config[:output_directory] = File.expand_path(Snapshot.config[:output_directory])
+
+      verify_helper_is_current
+
+      # Also print out the path to the used Xcode installation
+      # We go 2 folders up, to not show "Contents/Developer/"
+      values = Snapshot.config.values(ask: false)
+      values[:xcode_path] = File.expand_path("../..", FastlaneCore::Helper.xcode_path)
+      FastlaneCore::PrintTable.print_values(config: values, hide_keys: [], title: "Summary for snapshot #{Fastlane::VERSION}")
+
+      clear_previous_screenshots if Snapshot.config[:clear_previous_screenshots]
+
+      UI.success("Building and running project - this might take some time...")
+
+      launcher_config = SimulatorLauncherConfiguration.new(snapshot_config: Snapshot.config)
+
+      if Helper.xcode_at_least?(9)
+        launcher = SimulatorLauncher.new(launcher_configuration: launcher_config)
+        results = launcher.take_screenshots_simultaneously
+      else
+        launcher = SimulatorLauncherXcode8.new(launcher_configuration: launcher_config)
+        results = launcher.take_screenshots_one_simulator_at_a_time
+      end
+
+      print_results(results)
+
+      UI.test_failure!(launcher.collected_errors.uniq.join('; ')) if launcher.collected_errors.count > 0
+
+      # Generate HTML report
+      ReportsGenerator.new.generate
+
+      # Clear the Derived Data
+      unless Snapshot.config[:derived_data_path]
+        # this should actually be launcher.derived_data_path
+        FileUtils.rm_rf(TestCommandGeneratorBase.derived_data_path)
+      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: FastlaneCore::PrintTable.transform_output(rows),
+        headings: ["Device"] + results.values.first.keys,
+        title: "snapshot results"
+      }
+      puts("")
+      puts(Terminal::Table.new(params))
+      puts("")
+    end
+
+    def clear_previous_screenshots
+      UI.important("Clearing previously generated screenshots")
+      path = File.join(Snapshot.config[:output_directory], "*", "*.png")
+      Dir[path].each do |current|
+        UI.verbose("Deleting #{current}")
+        File.delete(current)
+      end
+    end
+
+    # Depending on the Xcode version, the return value is different
+    def self.path_to_helper_file_from_gem
+      runner_dir = File.dirname(__FILE__)
+
+      if Helper.xcode_at_least?("9.0")
+        return File.expand_path('../assets/SnapshotHelper.swift', runner_dir)
+      else
+        return File.expand_path('../assets/SnapshotHelperXcode8.swift', runner_dir)
+      end
+    end
+
+    def version_of_bundled_helper
+      asset_path = self.class.path_to_helper_file_from_gem
+      regex_to_use = Helper.xcode_at_least?("9.0") ? /\n.*SnapshotHelperVersion \[.+\]/ : /\n.*SnapshotHelperXcode8Version \[.+\]/
+
+      bundled_helper = File.read(asset_path)
+      current_version = bundled_helper.match(regex_to_use)[0]
+
+      # Something like "// SnapshotHelperVersion [1.2]", but be relaxed about whitespace
+      return current_version.gsub(%r{^//\w*}, '').strip
+    end
+
+    # rubocop:disable Style/Next
+    def verify_helper_is_current
+      return if Snapshot.config[:skip_helper_version_check]
+      current_version = version_of_bundled_helper
+      UI.verbose("Checking that helper files contain #{current_version}")
+
+      helper_files = Update.find_helper
+      if helper_files.empty?
+        UI.error("Your Snapshot Helper file is missing, please place a copy")
+        UI.error("in your project directory")
+        UI.message("More information about Snapshot setup can be found here:")
+        UI.message("https://docs.fastlane.tools/actions/snapshot/#quick-start")
+        UI.user_error!("Please add a Snapshot Helper file to your project")
+        return
+      end
+
+      helper_files.each do |path|
+        content = File.read(path)
+
+        unless content.include?(current_version)
+          UI.error("Your '#{path}' is outdated, please run `fastlane snapshot update`")
+          UI.error("to update your Helper file")
+          UI.user_error!("Please update your Snapshot Helper file using `fastlane snapshot update`")
+        end
+      end
+    end
+    # rubocop:enable Style/Next
+  end
+end

data/snapshot/lib/snapshot/screenshot_flatten.rb

@@ -0,0 +1,20 @@
+require_relative 'module'
+
+module Snapshot
+  # This class takes care of removing the alpha channel of the generated screenshots
+  class ScreenshotFlatten
+    # @param (String) The path in which the screenshots are located in
+    def run(path)
+      UI.message("Removing the alpha channel from generated png files")
+      flatten(path)
+    end
+
+    def flatten(path)
+      Dir.glob([path, '/**/*.png'].join('/')).each do |file|
+        UI.verbose("Removing alpha channel from '#{file}'")
+        `sips -s format bmp '#{file}' &> /dev/null` # &> /dev/null because there is warning because of the extension
+        `sips -s format png '#{file}'`
+      end
+    end
+  end
+end

data/snapshot/lib/snapshot/screenshot_rotate.rb

@@ -0,0 +1,36 @@
+require_relative 'module'
+require 'fastlane_core/fastlane_pty'
+
+module Snapshot
+  # This class takes care of rotating images
+  class ScreenshotRotate
+    require 'shellwords'
+
+    # @param (String) The path in which the screenshots are located in
+    def run(path)
+      UI.verbose("Rotating the screenshots (if necessary)")
+      rotate(path)
+    end
+
+    def rotate(path)
+      Dir.glob([path, '/**/*.png'].join('/')).each do |file|
+        UI.verbose("Rotating '#{file}'")
+
+        command = nil
+        if file.end_with?("landscapeleft.png")
+          command = "sips -r -90 '#{file}'"
+        elsif file.end_with?("landscaperight.png")
+          command = "sips -r 90 '#{file}'"
+        elsif file.end_with?("portrait_upsidedown.png")
+          command = "sips -r 180 '#{file}'"
+        end
+
+        # Only rotate if we need to
+        next unless command
+
+        # Rotate
+        FastlaneCore::CommandExecutor.execute(command: command, print_all: false, print_command: false)
+      end
+    end
+  end
+end