fastlane 1.111.0 → 2.0.1

data/gym/lib/gym/manager.rb

@@ -0,0 +1,17 @@
+module Gym
+  class Manager
+    def work(options)
+      Gym.config = options
+
+      # Also print out the path to the used Xcode installation
+      # We go 2 folders up, to not show "Contents/Developer/"
+      values = Gym.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 gym #{Fastlane::VERSION}")
+
+      return Runner.new.run
+    end
+  end
+end

data/gym/lib/gym/options.rb

@@ -0,0 +1,254 @@
+require "fastlane_core"
+require "credentials_manager"
+
+module Gym
+  class Options
+    def self.available_options
+      return @options if @options
+
+      @options = plain_options
+    end
+
+    def self.plain_options
+      [
+        FastlaneCore::ConfigItem.new(key: :workspace,
+                                     short_option: "-w",
+                                     env_name: "GYM_WORKSPACE",
+                                     optional: true,
+                                     description: "Path the workspace file",
+                                     verify_block: proc do |value|
+                                       v = File.expand_path(value.to_s)
+                                       UI.user_error!("Workspace file not found at path '#{v}'") unless File.exist?(v)
+                                       UI.user_error!("Workspace file invalid") unless File.directory?(v)
+                                       UI.user_error!("Workspace file is not a workspace, must end with .xcworkspace") unless v.include?(".xcworkspace")
+                                     end,
+                                     conflicting_options: [:project],
+                                     conflict_block: proc do |value|
+                                       UI.user_error!("You can only pass either a 'workspace' or a '#{value.key}', not both")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :project,
+                                     short_option: "-p",
+                                     optional: true,
+                                     env_name: "GYM_PROJECT",
+                                     description: "Path the project file",
+                                     verify_block: proc do |value|
+                                       v = File.expand_path(value.to_s)
+                                       UI.user_error!("Project file not found at path '#{v}'") unless File.exist?(v)
+                                       UI.user_error!("Project file invalid") unless File.directory?(v)
+                                       UI.user_error!("Project file is not a project file, must end with .xcodeproj") unless v.include?(".xcodeproj")
+                                     end,
+                                     conflicting_options: [:workspace],
+                                     conflict_block: proc do |value|
+                                       UI.user_error!("You can only pass either a 'project' or a '#{value.key}', not both")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :scheme,
+                                     short_option: "-s",
+                                     optional: true,
+                                     env_name: "GYM_SCHEME",
+                                     description: "The project's scheme. Make sure it's marked as `Shared`"),
+        FastlaneCore::ConfigItem.new(key: :clean,
+                                     short_option: "-c",
+                                     env_name: "GYM_CLEAN",
+                                     description: "Should the project be cleaned before building it?",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :output_directory,
+                                     short_option: "-o",
+                                     env_name: "GYM_OUTPUT_DIRECTORY",
+                                     description: "The directory in which the ipa file should be stored in",
+                                     default_value: "."),
+        FastlaneCore::ConfigItem.new(key: :output_name,
+                                     short_option: "-n",
+                                     env_name: "GYM_OUTPUT_NAME",
+                                     description: "The name of the resulting ipa file",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       value.gsub!(".ipa", "")
+                                       value.gsub!(File::SEPARATOR, "_")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :configuration,
+                                     short_option: "-q",
+                                     env_name: "GYM_CONFIGURATION",
+                                     description: "The configuration to use when building the app. Defaults to 'Release'",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :silent,
+                                     short_option: "-a",
+                                     env_name: "GYM_SILENT",
+                                     description: "Hide all information that's not necessary while building",
+                                     default_value: false,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :codesigning_identity,
+                                     short_option: "-i",
+                                     env_name: "GYM_CODE_SIGNING_IDENTITY",
+                                     description: "The name of the code signing identity to use. It has to match the name exactly. e.g. 'iPhone Distribution: SunApps GmbH'",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :include_symbols,
+                                     short_option: "-m",
+                                     env_name: "GYM_INCLUDE_SYMBOLS",
+                                     description: "Should the ipa file include symbols?",
+                                     is_string: false,
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :include_bitcode,
+                                     short_option: "-z",
+                                     env_name: "GYM_INCLUDE_BITCODE",
+                                     description: "Should the ipa include bitcode?",
+                                     is_string: false,
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :use_legacy_build_api,
+                                     env_name: "GYM_USE_LEGACY_BUILD_API",
+                                     description: "Don't use the new API because of https://openradar.appspot.com/radar?id=4952000420642816",
+                                     default_value: false,
+                                     is_string: false,
+                                     verify_block: proc do |value|
+                                       if value
+                                         UI.important "Using legacy build system - waiting for radar to be fixed: https://openradar.appspot.com/radar?id=4952000420642816"
+                                       end
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :export_method,
+                                     short_option: "-j",
+                                     env_name: "GYM_EXPORT_METHOD",
+                                     description: "Method used to export the archive. Valid values are: app-store, ad-hoc, package, enterprise, development, developer-id",
+                                     is_string: true,
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       av = %w(app-store ad-hoc package enterprise development developer-id)
+                                       UI.user_error!("Unsupported export_method, must be: #{av}") unless av.include?(value)
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :export_options,
+                                     env_name: "GYM_EXPORT_OPTIONS",
+                                     description: "Specifies path to export options plist. User xcodebuild -help to print the full set of available options",
+                                     is_string: false,
+                                     optional: true,
+                                     conflicting_options: [:use_legacy_build_api],
+                                     conflict_block: proc do |value|
+                                       UI.user_error!("'#{value.key}' must be false to use 'export_options'")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :export_xcargs,
+                                     env_name: "GYM_EXPORT_XCARGS",
+                                     description: "Pass additional arguments to xcodebuild for the package phase. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS=\"-ObjC -lstdc++\"",
+                                     optional: true,
+                                     conflicting_options: [:use_legacy_build_api],
+                                     conflict_block: proc do |value|
+                                       UI.user_error!("'#{value.key}' must be false to use 'export_xcargs'")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :skip_build_archive,
+                                     env_name: "GYM_SKIP_BUILD_ARCHIVE",
+                                     description: "Export ipa from previously build xarchive. Uses archive_path as source",
+                                     is_string: false,
+                                     optional: true),
+        # Very optional
+        FastlaneCore::ConfigItem.new(key: :build_path,
+                                     env_name: "GYM_BUILD_PATH",
+                                     description: "The directory in which the archive should be stored in",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :archive_path,
+                                     short_option: "-b",
+                                     env_name: "GYM_ARCHIVE_PATH",
+                                     description: "The path to the created archive",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :derived_data_path,
+                                     short_option: "-f",
+                                     env_name: "GYM_DERIVED_DATA_PATH",
+                                     description: "The directory where build products and other derived data will go",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :result_bundle,
+                                     short_option: "-u",
+                                     env_name: "GYM_RESULT_BUNDLE",
+                                     is_string: false,
+                                     description: "Produce the result bundle describing what occurred will be placed",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :buildlog_path,
+                                     short_option: "-l",
+                                     env_name: "GYM_BUILDLOG_PATH",
+                                     description: "The directory where to store the build log",
+                                     default_value: "#{FastlaneCore::Helper.buildlog_path}/gym"),
+        FastlaneCore::ConfigItem.new(key: :sdk,
+                                     short_option: "-k",
+                                     env_name: "GYM_SDK",
+                                     description: "The SDK that should be used for building the application",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :toolchain,
+                                     env_name: "GYM_TOOLCHAIN",
+                                     description: "The toolchain that should be used for building the application (e.g. com.apple.dt.toolchain.Swift_2_3, org.swift.30p620160816a)",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :provisioning_profile_path,
+                                     short_option: "-e",
+                                     env_name: "GYM_PROVISIONING_PROFILE_PATH",
+                                     description: "The path to the provisioning profile (optional)",
+                                     optional: true,
+                                     deprecated: 'Use target specific provisioning profiles instead',
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Provisioning profile not found at path '#{File.expand_path(value)}'") unless File.exist?(File.expand_path(value))
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :destination,
+                                     short_option: "-d",
+                                     env_name: "GYM_DESTINATION",
+                                     description: "Use a custom destination for building the app",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :export_team_id,
+                                     short_option: "-g",
+                                     env_name: "GYM_EXPORT_TEAM_ID",
+                                     description: "Optional: Sometimes you need to specify a team id when exporting the ipa file",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :xcargs,
+                                     short_option: "-x",
+                                     env_name: "GYM_XCARGS",
+                                     description: "Pass additional arguments to xcodebuild for the build phase. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS=\"-ObjC -lstdc++\"",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :xcconfig,
+                                     short_option: "-y",
+                                     env_name: "GYM_XCCONFIG",
+                                     description: "Use an extra XCCONFIG file to build your app",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("File not found at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :suppress_xcode_output,
+                                     short_option: "-r",
+                                     env_name: "SUPPRESS_OUTPUT",
+                                     description: "Suppress the output of xcodebuild to stdout. Output is still saved in buildlog_path",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :disable_xcpretty,
+                                     env_name: "DISABLE_XCPRETTY",
+                                     description: "Disable xcpretty formatting of build output",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :xcpretty_test_format,
+                                     env_name: "XCPRETTY_TEST_FORMAT",
+                                     description: "Use the test (RSpec style) format for build output",
+                                     optional: true,
+                                     is_string: false),
+        FastlaneCore::ConfigItem.new(key: :xcpretty_formatter,
+                                     env_name: "XCPRETTY_FORMATTER",
+                                     description: "A custom xcpretty formatter to use",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Formatter file not found at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :xcpretty_report_junit,
+                                     env_name: "XCPRETTY_REPORT_JUNIT",
+                                     description: "Have xcpretty create a JUnit-style XML report at the provided path",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Report output location not found at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :xcpretty_report_html,
+                                     env_name: "XCPRETTY_REPORT_HTML",
+                                     description: "Have xcpretty create a simple HTML report at the provided path",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Report output location not found at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :xcpretty_report_json,
+                                     env_name: "XCPRETTY_REPORT_JSON",
+                                     description: "Have xcpretty create a JSON compilation database at the provided path",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Report output location not found at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                     end)
+      ]
+    end
+  end
+end

data/gym/lib/gym/runner.rb

@@ -0,0 +1,256 @@
+require 'pty'
+require 'open3'
+require 'fileutils'
+require 'shellwords'
+
+module Gym
+  class Runner
+    # @return (String) The path to the resulting ipa
+    def run
+      unless Gym.config[:skip_build_archive]
+        clear_old_files
+        build_app
+      end
+      verify_archive if Gym.project.produces_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
+        package_app if Gym.project.produces_archive?
+        fix_package
+        compress_and_move_dsym
+        path = move_ipa if Gym.project.produces_archive?
+        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
+
+      if Gym.project.library? || Gym.project.framework?
+        base_framework_path = Gym.project.build_settings(key: "BUILD_ROOT")
+        base_framework_path = Gym.config[:derived_data_path] + "/Build/Products/" if Gym.config[:derived_data_path]
+
+        copy_files_from_path("#{base_framework_path}/*/*")
+        path = base_framework_path
+      end
+      path
+    end
+
+    #####################################################
+    # @!group Printing out things
+    #####################################################
+
+    # @param [Array] An array containing all the parts of the command
+    def print_command(command, title)
+      rows = command.map do |c|
+        current = c.to_s.dup
+        next unless current.length > 0
+
+        match_default_parameter = current.match(/(-.*) '(.*)'/)
+        if match_default_parameter
+          # That's a default parameter, like `-project 'Name'`
+          match_default_parameter[1, 2]
+        else
+          current.gsub!("| ", "\| ") # as the | will somehow break the terminal table
+          [current, ""]
+        end
+      end
+
+      puts Terminal::Table.new(
+        title: title.green,
+        headings: ["Option", "Value"],
+        rows: rows.delete_if { |c| c.to_s.empty? }
+      )
+    end
+
+    private
+
+    #####################################################
+    # @!group The individual steps
+    #####################################################
+
+    def clear_old_files
+      return unless Gym.config[:use_legacy_build_api]
+      if File.exist?(PackageCommandGenerator.ipa_path)
+        File.delete(PackageCommandGenerator.ipa_path)
+      end
+    end
+
+    def fix_generic_archive
+      return if ENV["GYM_USE_GENERIC_ARCHIVE_FIX"].nil?
+      Gym::XcodebuildFixes.generic_archive_fix
+    end
+
+    def fix_package
+      return unless Gym.config[:use_legacy_build_api]
+      Gym::XcodebuildFixes.swift_library_fix
+      Gym::XcodebuildFixes.watchkit_fix
+      Gym::XcodebuildFixes.watchkit2_fix
+    end
+
+    def mark_archive_as_built_by_gym(archive_path)
+      return if Gym.project.library? || Gym.project.framework?
+      escaped_archive_path = archive_path.shellescape
+      system("xattr -w info.fastlane.generated_by_gym 1 #{escaped_archive_path}")
+    end
+
+    # Builds the app and prepares the archive
+    def build_app
+      command = BuildCommandGenerator.generate
+      print_command(command, "Generated Build Command") if $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)
+    end
+
+    # Makes sure the archive is there and valid
+    def verify_archive
+      # from https://github.com/fastlane/gym/issues/115
+      if (Dir[BuildCommandGenerator.archive_path + "/*"]).count == 0
+        ErrorHandler.handle_empty_archive
+      end
+    end
+
+    def package_app
+      command = PackageCommandGenerator.generate
+      print_command(command, "Generated Package Command") if $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
+
+    def compress_and_move_dsym
+      return unless PackageCommandGenerator.dsym_path
+
+      # Compress and move the dsym file
+      containing_directory = File.expand_path("..", PackageCommandGenerator.dsym_path)
+
+      available_dsyms = Dir.glob("#{containing_directory}/*.dSYM")
+      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
+
+    # Moves over the binary and dsym file to the output directory
+    # @return (String) The path to the resulting ipa file
+    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
+
+    # copys framework from temp folder:
+
+    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 $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
+
+    # Copies the .app from the archive into the output directory
+    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
+
+    # Move the manifest.plist if exists into the output directory
+    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
+
+    # Move the app-thinning.plist file into the output directory
+    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 the App Thinning Size Report.txt file into the output directory
+    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 the Apps folder to the output directory
+    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
+
+    def find_archive_path
+      if Gym.config[:use_legacy_build_api]
+        BuildCommandGenerator.archive_path
+      else
+        Dir.glob(File.join(BuildCommandGenerator.build_path, "*.ipa")).last
+      end
+    end
+  end
+end