fastlane 1.111.0 → 2.0.1

data/fastlane_core/lib/fastlane_core/ipa_file_analyser.rb

@@ -0,0 +1,55 @@
+require 'zip'
+require 'plist'
+
+module FastlaneCore
+  class IpaFileAnalyser
+    # Fetches the app identifier (e.g. com.facebook.Facebook) from the given ipa file.
+    def self.fetch_app_identifier(path)
+      plist = self.fetch_info_plist_file(path)
+      return plist['CFBundleIdentifier'] if plist
+      return nil
+    end
+
+    # Fetches the app version from the given ipa file.
+    def self.fetch_app_version(path)
+      plist = self.fetch_info_plist_file(path)
+      return plist['CFBundleShortVersionString'] if plist
+      return nil
+    end
+
+    # Fetches the app platform from the given ipa file.
+    def self.fetch_app_platform(path)
+      plist = self.fetch_info_plist_file(path)
+      platform = "ios"
+      platform = plist['DTPlatformName'] if plist
+      platform = "ios" if platform == "iphoneos" # via https://github.com/fastlane/spaceship/issues/247
+      return platform
+    end
+
+    def self.fetch_info_plist_file(path)
+      UI.user_error!("Could not find file at path '#{path}'") unless File.exist?(path)
+      Zip::File.open(path) do |zipfile|
+        file = zipfile.glob('**/Payload/*.app/Info.plist').first
+        return nil unless file
+
+        # We can not be completely sure, that's the correct plist file, so we have to try
+        begin
+          # The XML file has to be properly unpacked first
+          tmp_path = "/tmp/deploytmp.plist"
+          File.write(tmp_path, zipfile.read(file))
+          system("plutil -convert xml1 #{tmp_path}")
+          result = Plist.parse_xml(tmp_path)
+          File.delete(tmp_path)
+
+          if result['CFBundleIdentifier'] or result['CFBundleVersion']
+            return result
+          end
+        rescue
+          # We don't really care, look for another XML file
+        end
+      end
+
+      nil
+    end
+  end
+end

data/fastlane_core/lib/fastlane_core/ipa_upload_package_builder.rb

@@ -0,0 +1,44 @@
+require "digest/md5"
+
+module FastlaneCore
+  # Builds a package for the binary ready to be uploaded with the iTunes Transporter
+  class IpaUploadPackageBuilder
+    METADATA_FILE_NAME = "metadata.xml"
+
+    attr_accessor :package_path
+
+    def generate(app_id: nil, ipa_path: nil, package_path: nil, platform: nil)
+      self.package_path = File.join(package_path, "#{app_id}.itmsp")
+      FileUtils.rm_rf self.package_path if File.directory?(self.package_path)
+      FileUtils.mkdir_p self.package_path
+
+      ipa_path = copy_ipa(ipa_path)
+      @data = {
+        apple_id: app_id,
+        file_size: File.size(ipa_path),
+        ipa_path: File.basename(ipa_path), # this is only the base name as the ipa is inside the package
+        md5: Digest::MD5.hexdigest(File.read(ipa_path)),
+        archive_type: "bundle",
+        platform: (platform || "ios") # pass "appletvos" for Apple TV's IPA
+      }
+
+      xml_path = File.join(FastlaneCore::ROOT, "lib/assets/XMLTemplate.xml.erb")
+      xml = ERB.new(File.read(xml_path)).result(binding) # http://www.rrn.dk/rubys-erb-templating-system
+
+      File.write(File.join(self.package_path, METADATA_FILE_NAME), xml)
+      UI.success("Wrote XML data to '#{self.package_path}'") if $verbose
+
+      return package_path
+    end
+
+    private
+
+    def copy_ipa(ipa_path)
+      ipa_file_name = Digest::MD5.hexdigest(ipa_path)
+      resulting_path = File.join(self.package_path, "#{ipa_file_name}.ipa")
+      FileUtils.cp(ipa_path, resulting_path)
+
+      return resulting_path
+    end
+  end
+end

data/fastlane_core/lib/fastlane_core/itunes_search_api.rb

@@ -0,0 +1,48 @@
+require 'open-uri'
+
+module FastlaneCore
+  # A wrapper around the Apple iTunes Search API to access app information like
+  # the app identifier of an app.
+  class ItunesSearchApi
+    # Fetch all information you can get from a specific AppleID of an app
+    # @param id (int) The AppleID of the given app. This usually consists of 9 digits.
+    # @param country (string) The optional ISO-2A country code
+    # @return (Hash) the response of the first result from Apple (https://itunes.apple.com/lookup?id=284882215[&country=FR])
+    # @example Response of Facebook App: https://itunes.apple.com/lookup?id=284882215[&country=FR]
+    #  {
+    #   ...
+    #   artistName: "Facebook, Inc.",
+    #   price: 0,
+    #   version: "14.9",
+    #   ...
+    #  }
+    def self.fetch(id, country = nil)
+      # Example: https://itunes.apple.com/lookup?id=284882215[&country=FR]
+      suffix = country.nil? ? nil : "&country=#{country}"
+      fetch_url("https://itunes.apple.com/lookup?id=#{id}#{suffix}")
+    end
+
+    def self.fetch_by_identifier(app_identifier, country = nil)
+      # Example: http://itunes.apple.com/lookup?bundleId=net.sunapps.1[&country=FR]
+      suffix = country.nil? ? nil : "&country=#{country}"
+      fetch_url("https://itunes.apple.com/lookup?bundleId=#{app_identifier}#{suffix}")
+    end
+
+    # This method only fetches the bundle identifier of a given app
+    # @param id (int) The AppleID of the given app. This usually consists of 9 digits.
+    # @return (String) the Bundle identifier of the app
+    def self.fetch_bundle_identifier(id)
+      self.fetch(id)['bundleId']
+    end
+
+    def self.fetch_url(url)
+      response = JSON.parse(open(url).read)
+      return nil if response['resultCount'] == 0
+
+      return response['results'].first
+    rescue
+      UI.error("Could not find object '#{url}' using the iTunes API")
+      nil
+    end
+  end
+end

data/fastlane_core/lib/fastlane_core/itunes_transporter.rb

@@ -0,0 +1,409 @@
+require 'pty'
+require 'shellwords'
+require 'fileutils'
+require 'credentials_manager/account_manager'
+
+module FastlaneCore
+  # The TransporterInputError occurs when you passed wrong inputs to the {Deliver::ItunesTransporter}
+  class TransporterInputError < StandardError
+  end
+  # The TransporterTransferError occurs when some error happens
+  # while uploading or downloading something from/to iTC
+  class TransporterTransferError < StandardError
+  end
+
+  # Used internally
+  class TransporterRequiresApplicationSpecificPasswordError < StandardError
+  end
+
+  # Base class for executing the iTMSTransporter
+  class TransporterExecutor
+    ERROR_REGEX = />\s*ERROR:\s+(.+)/
+    WARNING_REGEX = />\s*WARN:\s+(.+)/
+    OUTPUT_REGEX = />\s+(.+)/
+    RETURN_VALUE_REGEX = />\sDBG-X:\sReturning\s+(\d+)/
+
+    SKIP_ERRORS = ["ERROR: An exception has occurred: Scheduling automatic restart in 1 minute"]
+
+    private_constant :ERROR_REGEX, :WARNING_REGEX, :OUTPUT_REGEX, :RETURN_VALUE_REGEX, :SKIP_ERRORS
+
+    def execute(command, hide_output)
+      return command if Helper.is_test?
+
+      @errors = []
+      @warnings = []
+
+      if hide_output
+        # Show a one time message instead
+        UI.success("Waiting for iTunes Connect transporter to be finished.")
+        UI.success("iTunes Transporter progress... this might take a few minutes...")
+      end
+
+      begin
+        PTY.spawn(command) do |stdin, stdout, pid|
+          begin
+            stdin.each do |line|
+              parse_line(line, hide_output) # this is where the parsing happens
+            end
+          rescue Errno::EIO
+            # Exception ignored intentionally.
+            # https://stackoverflow.com/questions/10238298/ruby-on-linux-pty-goes-away-without-eof-raises-errnoeio
+          ensure
+            Process.wait(pid)
+          end
+        end
+      rescue => ex
+        @errors << ex.to_s
+      end
+
+      exit_status = $?.exitstatus
+      unless exit_status.zero?
+        @errors << "The call to the iTMSTransporter completed with a non-zero exit status: #{exit_status}. This indicates a failure."
+      end
+
+      if @warnings.count > 0
+        UI.important(@warnings.join("\n"))
+      end
+
+      if @errors.join("").include?("app-specific")
+        raise TransporterRequiresApplicationSpecificPasswordError
+      end
+
+      if @errors.count > 0
+        UI.error(@errors.join("\n"))
+      end
+
+      # this is to handle GitHub issue #1896, which occurs when an
+      #  iTMSTransporter file transfer fails; iTMSTransporter will log an error
+      #  but will then retry; if that retry is successful, we will see the error
+      #  logged, but since the status code is zero, we want to return success
+      if @errors.count > 0 && exit_status.zero?
+        UI.important("Although errors occurred during execution of iTMSTransporter, it returned success status.")
+      end
+
+      exit_status.zero?
+    end
+
+    private
+
+    def parse_line(line, hide_output)
+      # Taken from https://github.com/sshaw/itunes_store_transporter/blob/master/lib/itunes/store/transporter/output_parser.rb
+
+      output_done = false
+
+      re = Regexp.union(SKIP_ERRORS)
+      if line.match(re)
+        # Those lines will not be handle like errors or warnings
+
+      elsif line =~ ERROR_REGEX
+        @errors << $1
+        UI.error("[Transporter Error Output]: #{$1}")
+
+        # Check if it's a login error
+        if $1.include? "Your Apple ID or password was entered incorrectly" or
+           $1.include? "This Apple ID has been locked for security reasons"
+
+          unless Helper.is_test?
+            CredentialsManager::AccountManager.new(user: @user).invalid_credentials
+            UI.error("Please run this tool again to apply the new password")
+          end
+        elsif $1.include? "Redundant Binary Upload. There already exists a binary upload with build"
+          UI.error($1)
+          UI.error("You have to change the build number of your app to upload your ipa file")
+        end
+
+        output_done = true
+      elsif line =~ WARNING_REGEX
+        @warnings << $1
+        UI.important("[Transporter Warning Output]: #{$1}")
+        output_done = true
+      end
+
+      if line =~ RETURN_VALUE_REGEX
+        if $1.to_i != 0
+          UI.error("Transporter transfer failed.")
+          UI.important(@warnings.join("\n"))
+          UI.error(@errors.join("\n"))
+          UI.crash!("Return status of iTunes Transporter was #{$1}: #{@errors.join('\n')}")
+        else
+          UI.success("iTunes Transporter successfully finished its job")
+        end
+      end
+
+      if !hide_output and line =~ OUTPUT_REGEX
+        # General logging for debug purposes
+        unless output_done
+          UI.verbose("[Transporter]: #{$1}")
+        end
+      end
+    end
+  end
+
+  # Generates commands and executes the iTMSTransporter through the shell script it provides by the same name
+  class ShellScriptTransporterExecutor < TransporterExecutor
+    def build_upload_command(username, password, source = "/tmp", provider_short_name = "")
+      [
+        '"' + Helper.transporter_path + '"',
+        "-m upload",
+        "-u \"#{username}\"",
+        "-p #{shell_escaped_password(password)}",
+        "-f '#{source}'",
+        ENV["DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS"], # that's here, because the user might overwrite the -t option
+        "-t 'Signiant'",
+        "-k 100000",
+        ("-itc_provider #{provider_short_name}" unless provider_short_name.to_s.empty?)
+      ].compact.join(' ')
+    end
+
+    def build_download_command(username, password, apple_id, destination = "/tmp", provider_short_name = "")
+      [
+        '"' + Helper.transporter_path + '"',
+        "-m lookupMetadata",
+        "-u \"#{username}\"",
+        "-p #{shell_escaped_password(password)}",
+        "-apple_id #{apple_id}",
+        "-destination '#{destination}'",
+        ("-itc_provider #{provider_short_name}" unless provider_short_name.to_s.empty?)
+      ].compact.join(' ')
+    end
+
+    def handle_error(password)
+      # rubocop:disable Style/CaseEquality
+      unless /^[0-9a-zA-Z\.\$\_]*$/ === password
+        UI.error([
+          "Password contains special characters, which may not be handled properly by iTMSTransporter.",
+          "If you experience problems uploading to iTunes Connect, please consider changing your password to something with only alphanumeric characters."
+        ].join(' '))
+      end
+      # rubocop:enable Style/CaseEquality
+      UI.error("Could not download/upload from iTunes Connect! It's probably related to your password or your internet connection.")
+    end
+
+    private
+
+    def shell_escaped_password(password)
+      # because the shell handles passwords with single-quotes incorrectly, use gsub to replace ShellEscape'd single-quotes of this form:
+      #    \'
+      # with a sequence that wraps the escaped single-quote in double-quotes:
+      #    '"\'"'
+      # this allows us to properly handle passwords with single-quotes in them
+      # we use the 'do' version of gsub, because two-param version interprets the replace text as a pattern and does the wrong thing
+      password = Shellwords.escape(password).gsub("\\'") do
+        "'\"\\'\"'"
+      end
+
+      # wrap the fully-escaped password in single quotes, since the transporter expects a escaped password string (which must be single-quoted for the shell's benefit)
+      "'" + password + "'"
+    end
+  end
+
+  # Generates commands and executes the iTMSTransporter by invoking its Java app directly, to avoid the crazy parameter
+  # escaping problems in its accompanying shell script.
+  class JavaTransporterExecutor < TransporterExecutor
+    def build_upload_command(username, password, source = "/tmp", provider_short_name = "")
+      [
+        Helper.transporter_java_executable_path.shellescape,
+        "-Djava.ext.dirs=#{Helper.transporter_java_ext_dir.shellescape}",
+        '-XX:NewSize=2m',
+        '-Xms32m',
+        '-Xmx1024m',
+        '-Xms1024m',
+        '-Djava.awt.headless=true',
+        '-Dsun.net.http.retryPost=false',
+        "-classpath #{Helper.transporter_java_jar_path.shellescape}",
+        'com.apple.transporter.Application',
+        '-m upload',
+        "-u #{username.shellescape}",
+        "-p #{password.shellescape}",
+        "-f #{source.shellescape}",
+        ENV["DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS"], # that's here, because the user might overwrite the -t option
+        '-t Signiant',
+        '-k 100000',
+        ("-itc_provider #{provider_short_name}" unless provider_short_name.to_s.empty?),
+        '2>&1' # cause stderr to be written to stdout
+      ].compact.join(' ') # compact gets rid of the possibly nil ENV value
+    end
+
+    def build_download_command(username, password, apple_id, destination = "/tmp", provider_short_name = "")
+      [
+        Helper.transporter_java_executable_path.shellescape,
+        "-Djava.ext.dirs=#{Helper.transporter_java_ext_dir.shellescape}",
+        '-XX:NewSize=2m',
+        '-Xms32m',
+        '-Xmx1024m',
+        '-Xms1024m',
+        '-Djava.awt.headless=true',
+        '-Dsun.net.http.retryPost=false',
+        "-classpath #{Helper.transporter_java_jar_path.shellescape}",
+        'com.apple.transporter.Application',
+        '-m lookupMetadata',
+        "-u #{username.shellescape}",
+        "-p #{password.shellescape}",
+        "-apple_id #{apple_id.shellescape}",
+        "-destination #{destination.shellescape}",
+        ("-itc_provider #{provider_short_name}" unless provider_short_name.to_s.empty?),
+        '2>&1' # cause stderr to be written to stdout
+      ].compact.join(' ')
+    end
+
+    def handle_error(password)
+      unless File.exist?(Helper.transporter_java_jar_path)
+        UI.error("The iTMSTransporter Java app was not found at '#{Helper.transporter_java_jar_path}'.")
+        UI.error("If you're using Xcode 6, please select the shell script executor by setting the environment variable "\
+          "FASTLANE_ITUNES_TRANSPORTER_USE_SHELL_SCRIPT=1")
+      end
+    end
+
+    def execute(command, hide_output)
+      # The Java command needs to be run starting in a working directory in the iTMSTransporter
+      # file area. The shell script takes care of changing directories over to there, but we'll
+      # handle it manually here for this strategy.
+      FileUtils.cd(Helper.itms_path) do
+        return super(command, hide_output)
+      end
+    end
+  end
+
+  class ItunesTransporter
+    TWO_STEP_HOST_PREFIX = "deliver.appspecific"
+
+    # This will be called from the Deliverfile, and disables the logging of the transporter output
+    def self.hide_transporter_output
+      @hide_transporter_output = !$verbose
+    end
+
+    def self.hide_transporter_output?
+      @hide_transporter_output
+    end
+
+    # Returns a new instance of the iTunesTransporter.
+    # If no username or password given, it will be taken from
+    # the #{CredentialsManager::AccountManager}
+    # @param use_shell_script if true, forces use of the iTMSTransporter shell script.
+    #                         if false, allows a direct call to the iTMSTransporter Java app (preferred).
+    #                         see: https://github.com/fastlane/fastlane/pull/4003
+    # @param provider_short_name The provider short name to be given to the iTMSTransporter to identify the
+    #                            correct team for this work. The provider short name is usually your Developer
+    #                            Portal team ID, but in certain cases it is different!
+    #                            see: https://github.com/fastlane/fastlane/issues/1524#issuecomment-196370628
+    #                            for more information about how to use the iTMSTransporter to list your provider
+    #                            short names
+    def initialize(user = nil, password = nil, use_shell_script = false, provider_short_name = nil)
+      # Xcode 6.x doesn't have the same iTMSTransporter Java setup as later Xcode versions, so
+      # we can't default to using the better direct Java invocation strategy for those versions.
+      use_shell_script ||= Helper.is_mac? && Helper.xcode_version.start_with?('6.')
+      use_shell_script ||= Feature.enabled?('FASTLANE_ITUNES_TRANSPORTER_USE_SHELL_SCRIPT')
+
+      # First, see if we have an application specific password
+      data = CredentialsManager::AccountManager.new(user: user,
+                                                  prefix: TWO_STEP_HOST_PREFIX)
+      @user = data.user
+      @password ||= data.password(ask_if_missing: false)
+
+      if @password.to_s.length == 0
+        # No specific password found, just using the iTC/Dev Portal one
+        # default to the given password here
+        data = CredentialsManager::AccountManager.new(user: user,
+                                                  password: password)
+        @user = data.user
+        @password ||= data.password
+      end
+      @transporter_executor = use_shell_script ? ShellScriptTransporterExecutor.new : JavaTransporterExecutor.new
+      @provider_short_name = provider_short_name
+    end
+
+    # Downloads the latest version of the app metadata package from iTC.
+    # @param app_id [Integer] The unique App ID
+    # @param dir [String] the path in which the package file should be stored
+    # @return (Bool) True if everything worked fine
+    # @raise [Deliver::TransporterTransferError] when something went wrong
+    #   when transfering
+    def download(app_id, dir = nil)
+      dir ||= "/tmp"
+
+      UI.message("Going to download app metadata from iTunes Connect")
+      command = @transporter_executor.build_download_command(@user, @password, app_id, dir, @provider_short_name)
+      UI.verbose(@transporter_executor.build_download_command(@user, 'YourPassword', app_id, dir, @provider_short_name))
+
+      begin
+        result = @transporter_executor.execute(command, ItunesTransporter.hide_transporter_output?)
+      rescue TransporterRequiresApplicationSpecificPasswordError => ex
+        handle_two_step_failure(ex)
+        return download(app_id, dir)
+      end
+
+      return result if Helper.is_test?
+
+      itmsp_path = File.join(dir, "#{app_id}.itmsp")
+      successful = result && File.directory?(itmsp_path)
+
+      if successful
+        UI.success("✅ Successfully downloaded the latest package from iTunes Connect to #{itmsp_path}")
+      else
+        handle_error(@password)
+      end
+
+      successful
+    end
+
+    # Uploads the modified package back to iTunes Connect
+    # @param app_id [Integer] The unique App ID
+    # @param dir [String] the path in which the package file is located
+    # @return (Bool) True if everything worked fine
+    # @raise [Deliver::TransporterTransferError] when something went wrong
+    #   when transfering
+    def upload(app_id, dir)
+      actual_dir = File.join(dir, "#{app_id}.itmsp")
+
+      UI.message("Going to upload updated app to iTunes Connect")
+      UI.success("This might take a few minutes. Please don't interrupt the script.")
+
+      command = @transporter_executor.build_upload_command(@user, @password, actual_dir, @provider_short_name)
+      UI.verbose(@transporter_executor.build_upload_command(@user, 'YourPassword', actual_dir, @provider_short_name))
+
+      begin
+        result = @transporter_executor.execute(command, ItunesTransporter.hide_transporter_output?)
+      rescue TransporterRequiresApplicationSpecificPasswordError => ex
+        handle_two_step_failure(ex)
+        return upload(app_id, dir)
+      end
+
+      if result
+        UI.success("-" * 102)
+        UI.success("Successfully uploaded package to iTunes Connect. It might take a few minutes until it's visible online.")
+        UI.success("-" * 102)
+
+        FileUtils.rm_rf(actual_dir) unless Helper.is_test? # we don't need the package any more, since the upload was successful
+      else
+        handle_error(@password)
+      end
+
+      result
+    end
+
+    private
+
+    # Tells the user how to get an application specific password
+    def handle_two_step_failure(ex)
+      a = CredentialsManager::AccountManager.new(user: @user,
+                                               prefix: TWO_STEP_HOST_PREFIX)
+      if a.password(ask_if_missing: false).to_s.length > 0
+        # user already entered one.. delete the old one
+        UI.error("Application specific password seems wrong")
+        UI.error("Please make sure to follow the instructions")
+        a.remove_from_keychain
+      end
+      UI.error("Your account has 2 step verification enabled")
+      UI.error("Please go to https://appleid.apple.com/account/manage")
+      UI.error("and generate an application specific password for")
+      UI.error("the iTunes Transporter, which is used to upload builds")
+      @password = a.password # to ask the user for the missing value
+
+      return true
+    end
+
+    def handle_error(password)
+      @transporter_executor.handle_error(password)
+    end
+  end
+end