class Gym::Runner

Public Instance Methods

print_command(command, title) click to toggle source

@param [Array] An array containing all the parts of the command

run() click to toggle source

@return (String) The path to the resulting ipa

# File gym/lib/gym/runner.rb, line 16
def run
  unless Gym.config[:skip_build_archive]
    build_app
  end
  verify_archive unless Gym.config[:skip_archive]
  FileUtils.mkdir_p(File.expand_path(Gym.config[:output_directory]))

  if Gym.project.ios? || Gym.project.tvos?
    fix_generic_archive # See https://github.com/fastlane/fastlane/pull/4325
    return BuildCommandGenerator.archive_path if Gym.config[:skip_package_ipa]

    package_app
    compress_and_move_dsym
    path = move_ipa
    move_manifest
    move_app_thinning
    move_app_thinning_size_report
    move_apps_folder
  elsif Gym.project.mac?
    path = File.expand_path(Gym.config[:output_directory])
    compress_and_move_dsym
    if Gym.project.mac_app?
      copy_mac_app
      return path
    end
    copy_files_from_path(File.join(BuildCommandGenerator.archive_path, "Products/usr/local/bin/*")) if Gym.project.command_line_tool?
  end
  return path
end

Private Instance Methods

build_app() click to toggle source

Builds the app and prepares the archive

# File gym/lib/gym/runner.rb, line 90
def build_app
  command = BuildCommandGenerator.generate
  print_command(command, "Generated Build Command") if FastlaneCore::Globals.verbose?
  FastlaneCore::CommandExecutor.execute(command: command,
                                      print_all: true,
                                  print_command: !Gym.config[:silent],
                                          error: proc do |output|
                                            ErrorHandler.handle_build_error(output)
                                          end)

  mark_archive_as_built_by_gym(BuildCommandGenerator.archive_path)
  UI.success("Successfully stored the archive. You can find it in the Xcode Organizer.") unless Gym.config[:archive_path].nil?
  UI.verbose("Stored the archive in: " + BuildCommandGenerator.archive_path)

  post_build_app
end
compress_and_move_dsym() click to toggle source
# File gym/lib/gym/runner.rb, line 142
def compress_and_move_dsym
  return unless PackageCommandGenerator.dsym_path

  # Compress and move the dsym file
  containing_directory = File.expand_path("..", PackageCommandGenerator.dsym_path)
  bcsymbolmaps_directory = File.expand_path("../../BCSymbolMaps", PackageCommandGenerator.dsym_path)
  available_dsyms = Dir.glob("#{containing_directory}/*.dSYM")

  if Dir.exist?(bcsymbolmaps_directory)
    UI.message("Mapping dSYM(s) using generated BCSymbolMaps") unless Gym.config[:silent]
    available_dsyms.each do |dsym|
      command = []
      command << "dsymutil"
      command << "--symbol-map #{bcsymbolmaps_directory.shellescape}"
      command << dsym.shellescape
      Helper.backticks(command.join(" "), print: !Gym.config[:silent])
    end
  end

  UI.message("Compressing #{available_dsyms.count} dSYM(s)") unless Gym.config[:silent]

  output_path = File.expand_path(File.join(Gym.config[:output_directory], Gym.config[:output_name] + ".app.dSYM.zip"))
  command = "cd '#{containing_directory}' && zip -r '#{output_path}' *.dSYM"
  Helper.backticks(command, print: !Gym.config[:silent])
  puts("") # new line

  UI.success("Successfully exported and compressed dSYM file")
end
copy_files_from_path(path) click to toggle source

copys framework from temp folder:

# File gym/lib/gym/runner.rb, line 184
def copy_files_from_path(path)
  UI.success("Exporting Files:")
  Dir[path].each do |f|
    existing_file = File.join(File.expand_path(Gym.config[:output_directory]), File.basename(f))
    # If the target file already exists in output directory
    # we have to remove it first, otherwise cp_r fails even with remove_destination
    # e.g.: there are symlinks in the .framework
    if File.exist?(existing_file)
      UI.important("Removing #{File.basename(f)} from output directory") if FastlaneCore::Globals.verbose?
      FileUtils.rm_rf(existing_file)
    end
    FileUtils.cp_r(f, File.expand_path(Gym.config[:output_directory]), remove_destination: true)
    UI.message("\t ▸ #{File.basename(f)}")
  end
end
copy_mac_app() click to toggle source

Copies the .app from the archive into the output directory

# File gym/lib/gym/runner.rb, line 201
def copy_mac_app
  exe_name = Gym.project.build_settings(key: "EXECUTABLE_NAME")
  app_path = File.join(BuildCommandGenerator.archive_path, "Products/Applications/#{exe_name}.app")
  UI.crash!("Couldn't find application in '#{BuildCommandGenerator.archive_path}'") unless File.exist?(app_path)
  FileUtils.cp_r(app_path, File.expand_path(Gym.config[:output_directory]), remove_destination: true)
  app_path = File.join(Gym.config[:output_directory], File.basename(app_path))
  UI.success("Successfully exported the .app file:")
  UI.message(app_path)
  app_path
end
find_archive_path() click to toggle source
# File gym/lib/gym/runner.rb, line 260
def find_archive_path
  Dir.glob(File.join(BuildCommandGenerator.build_path, "*.ipa")).last
end
fix_generic_archive() click to toggle source

@!group The individual steps

# File gym/lib/gym/runner.rb, line 79
def fix_generic_archive
  return unless FastlaneCore::Env.truthy?("GYM_USE_GENERIC_ARCHIVE_FIX")
  Gym::XcodebuildFixes.generic_archive_fix
end
mark_archive_as_built_by_gym(archive_path) click to toggle source
# File gym/lib/gym/runner.rb, line 84
def mark_archive_as_built_by_gym(archive_path)
  escaped_archive_path = archive_path.shellescape
  system("xattr -w info.fastlane.generated_by_gym 1 #{escaped_archive_path}")
end
move_app_thinning() click to toggle source

Move the app-thinning.plist file into the output directory

# File gym/lib/gym/runner.rb, line 225
def move_app_thinning
  if File.exist?(PackageCommandGenerator.app_thinning_path)
    FileUtils.mv(PackageCommandGenerator.app_thinning_path, File.expand_path(Gym.config[:output_directory]), force: true)
    app_thinning_path = File.join(File.expand_path(Gym.config[:output_directory]), File.basename(PackageCommandGenerator.app_thinning_path))

    UI.success("Successfully exported the app-thinning.plist file:")
    UI.message(app_thinning_path)
    app_thinning_path
  end
end
move_app_thinning_size_report() click to toggle source

Move the App Thinning Size Report.txt file into the output directory

# File gym/lib/gym/runner.rb, line 237
def move_app_thinning_size_report
  if File.exist?(PackageCommandGenerator.app_thinning_size_report_path)
    FileUtils.mv(PackageCommandGenerator.app_thinning_size_report_path, File.expand_path(Gym.config[:output_directory]), force: true)
    app_thinning_size_report_path = File.join(File.expand_path(Gym.config[:output_directory]), File.basename(PackageCommandGenerator.app_thinning_size_report_path))

    UI.success("Successfully exported the App Thinning Size Report.txt file:")
    UI.message(app_thinning_size_report_path)
    app_thinning_size_report_path
  end
end
move_apps_folder() click to toggle source

Move the Apps folder to the output directory

# File gym/lib/gym/runner.rb, line 249
def move_apps_folder
  if Dir.exist?(PackageCommandGenerator.apps_path)
    FileUtils.mv(PackageCommandGenerator.apps_path, File.expand_path(Gym.config[:output_directory]), force: true)
    apps_path = File.join(File.expand_path(Gym.config[:output_directory]), File.basename(PackageCommandGenerator.apps_path))

    UI.success("Successfully exported Apps folder:")
    UI.message(apps_path)
    apps_path
  end
end
move_ipa() click to toggle source

Moves over the binary and dsym file to the output directory @return (String) The path to the resulting ipa file

# File gym/lib/gym/runner.rb, line 173
def move_ipa
  FileUtils.mv(PackageCommandGenerator.ipa_path, File.expand_path(Gym.config[:output_directory]), force: true)
  ipa_path = File.expand_path(File.join(Gym.config[:output_directory], File.basename(PackageCommandGenerator.ipa_path)))

  UI.success("Successfully exported and signed the ipa file:")
  UI.message(ipa_path)
  ipa_path
end
move_manifest() click to toggle source

Move the manifest.plist if exists into the output directory

# File gym/lib/gym/runner.rb, line 213
def move_manifest
  if File.exist?(PackageCommandGenerator.manifest_path)
    FileUtils.mv(PackageCommandGenerator.manifest_path, File.expand_path(Gym.config[:output_directory]), force: true)
    manifest_path = File.join(File.expand_path(Gym.config[:output_directory]), File.basename(PackageCommandGenerator.manifest_path))

    UI.success("Successfully exported the manifest.plist file:")
    UI.message(manifest_path)
    manifest_path
  end
end
package_app() click to toggle source
# File gym/lib/gym/runner.rb, line 130
def package_app
  command = PackageCommandGenerator.generate
  print_command(command, "Generated Package Command") if FastlaneCore::Globals.verbose?

  FastlaneCore::CommandExecutor.execute(command: command,
                                      print_all: false,
                                  print_command: !Gym.config[:silent],
                                          error: proc do |output|
                                            ErrorHandler.handle_package_error(output)
                                          end)
end
post_build_app() click to toggle source

Post-processing of build_app

# File gym/lib/gym/runner.rb, line 108
def post_build_app
  command = BuildCommandGenerator.post_build

  return if command.empty?

  print_command(command, "Generated Post-Build Command") if FastlaneCore::Globals.verbose?
  FastlaneCore::CommandExecutor.execute(command: command,
                                      print_all: true,
                                  print_command: !Gym.config[:silent],
                                          error: proc do |output|
                                            ErrorHandler.handle_build_error(output)
                                          end)
end
verify_archive() click to toggle source

Makes sure the archive is there and valid

# File gym/lib/gym/runner.rb, line 123
def verify_archive
  # from https://github.com/fastlane/fastlane/issues/3179
  if (Dir[BuildCommandGenerator.archive_path + "/*"]).count == 0
    ErrorHandler.handle_empty_archive
  end
end