fastlane 1.111.0 → 2.0.1

data/pilot/lib/pilot/commands_generator.rb

@@ -0,0 +1,136 @@
+require "commander"
+require "pilot/options"
+require "fastlane_core"
+
+HighLine.track_eof = false
+
+module Pilot
+  class CommandsGenerator
+    include Commander::Methods
+
+    FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options)
+
+    def self.start
+      new.run
+    end
+
+    def convert_options(options)
+      o = options.__hash__.dup
+      o.delete(:verbose)
+      o
+    end
+
+    def handle_multiple(action, args, options)
+      mgr = Pilot::TesterManager.new
+      config = FastlaneCore::Configuration.create(Pilot::Options.available_options, convert_options(options))
+      args.push(config[:email]) if config[:email] && args.empty?
+      args.push(UI.input("Email address of the tester: ")) if args.empty?
+      failures = []
+      args.each do |address|
+        config[:email] = address
+        begin
+          mgr.public_send(action, config)
+        rescue => ex
+          failures.push(address)
+          UI.message("[#{address}]: #{ex}")
+        end
+      end
+      UI.user_error!("Some operations failed: #{failures}") unless failures.empty?
+    end
+
+    def run
+      program :name, 'pilot'
+      program :version, Fastlane::VERSION
+      program :description, Pilot::DESCRIPTION
+      program :help, "Author", "Felix Krause <pilot@krausefx.com>"
+      program :help, "Website", "https://fastlane.tools"
+      program :help, "GitHub", "https://github.com/fastlane/fastlane/tree/master/pilot"
+      program :help_formatter, :compact
+
+      global_option("--verbose") { $verbose = true }
+
+      command :upload do |c|
+        c.syntax = "pilot upload"
+        c.description = "Uploads a new binary to Apple TestFlight"
+        c.action do |args, options|
+          config = FastlaneCore::Configuration.create(Pilot::Options.available_options, convert_options(options))
+          Pilot::BuildManager.new.upload(config)
+        end
+      end
+
+      command :distribute do |c|
+        c.syntax = "pilot distribute"
+        c.description = "Distribute a previously uploaded binary to Apple TestFlight"
+        c.action do |args, options|
+          config = FastlaneCore::Configuration.create(Pilot::Options.available_options, convert_options(options))
+          config[:distribute_external] = true
+          Pilot::BuildManager.new.distribute(config)
+        end
+      end
+
+      command :builds do |c|
+        c.syntax = "pilot builds"
+        c.description = "Lists all builds for given application"
+        c.action do |args, options|
+          config = FastlaneCore::Configuration.create(Pilot::Options.available_options, convert_options(options))
+          Pilot::BuildManager.new.list(config)
+        end
+      end
+
+      command :add do |c|
+        c.syntax = "pilot add"
+        c.description = "Adds new external tester(s) to a specific app (if given). This will also add an existing tester to an app."
+        c.action do |args, options|
+          handle_multiple('add_tester', args, options)
+        end
+      end
+
+      command :list do |c|
+        c.syntax = "pilot list"
+        c.description = "Lists all registered testers, both internal and external"
+        c.action do |args, options|
+          config = FastlaneCore::Configuration.create(Pilot::Options.available_options, convert_options(options))
+          Pilot::TesterManager.new.list_testers(config)
+        end
+      end
+
+      command :find do |c|
+        c.syntax = "pilot find"
+        c.description = "Find tester(s) (internal or external) by their email address"
+        c.action do |args, options|
+          handle_multiple('find_tester', args, options)
+        end
+      end
+
+      command :remove do |c|
+        c.syntax = "pilot remove"
+        c.description = "Remove external tester(s) by their email address"
+        c.action do |args, options|
+          handle_multiple('remove_tester', args, options)
+        end
+      end
+
+      command :export do |c|
+        c.syntax = "pilot export"
+        c.description = "Exports all external testers to a CSV file"
+        c.action do |args, options|
+          config = FastlaneCore::Configuration.create(Pilot::Options.available_options, convert_options(options))
+          Pilot::TesterExporter.new.export_testers(config)
+        end
+      end
+
+      command :import do |c|
+        c.syntax = "pilot import"
+        c.description = "Create external testers from a CSV file"
+        c.action do |args, options|
+          config = FastlaneCore::Configuration.create(Pilot::Options.available_options, convert_options(options))
+          Pilot::TesterImporter.new.import_testers(config)
+        end
+      end
+
+      default_command :help
+
+      run!
+    end
+  end
+end

data/pilot/lib/pilot/manager.rb

@@ -0,0 +1,71 @@
+require "fastlane_core"
+
+module Pilot
+  class Manager
+    def start(options)
+      return if @config # to not login multiple times
+      @config = options
+      login
+    end
+
+    def login
+      config[:username] ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+      UI.message("Login to iTunes Connect (#{config[:username]})")
+      Spaceship::Tunes.login(config[:username])
+      Spaceship::Tunes.select_team
+      UI.message("Login successful")
+    end
+
+    # The app object we're currently using
+    def app
+      @apple_id ||= fetch_app_id
+
+      @app ||= Spaceship::Application.find(@apple_id)
+      unless @app
+        UI.user_error!("Could not find app with #{(config[:apple_id] || config[:app_identifier])}")
+      end
+      return @app
+    end
+
+    # Access the current configuration
+    attr_reader :config
+
+    # Config Related
+    ################
+
+    def fetch_app_id
+      return @apple_id if @apple_id
+      config[:app_identifier] = fetch_app_identifier
+
+      if config[:app_identifier]
+        @app ||= Spaceship::Application.find(config[:app_identifier])
+        UI.user_error!("Couldn't find app '#{config[:app_identifier]}' on the account of '#{config[:username]}' on iTunes Connect") unless @app
+        app_id ||= @app.apple_id
+      end
+
+      app_id ||= UI.input("Could not automatically find the app ID, please enter it here (e.g. 956814360): ")
+
+      return app_id
+    end
+
+    def fetch_app_identifier
+      result = config[:app_identifier]
+      result ||= FastlaneCore::IpaFileAnalyser.fetch_app_identifier(config[:ipa])
+      result ||= UI.input("Please enter the app's bundle identifier: ")
+      UI.verbose("App identifier (#{result})")
+      return result
+    end
+
+    def fetch_app_platform(required: true)
+      result = config[:app_platform]
+      result ||= FastlaneCore::IpaFileAnalyser.fetch_app_platform(config[:ipa]) if config[:ipa]
+      if required
+        result ||= ask("Please enter the app's platform (appletvos, ios, osx): ")
+        UI.user_error!("App Platform must be ios, appletvos, or osx") unless ['ios', 'appletvos', 'osx'].include? result
+        UI.verbose("App Platform (#{result})")
+      end
+      return result
+    end
+  end
+end

data/pilot/lib/pilot/options.rb

@@ -0,0 +1,161 @@
+require "fastlane_core"
+require "credentials_manager"
+
+module Pilot
+  class Options
+    def self.available_options
+      user = CredentialsManager::AppfileConfig.try_fetch_value(:itunes_connect_id)
+      user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+      [
+        FastlaneCore::ConfigItem.new(key: :username,
+                                     short_option: "-u",
+                                     env_name: "PILOT_USERNAME",
+                                     description: "Your Apple ID Username",
+                                     default_value: user),
+        FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                     short_option: "-a",
+                                     env_name: "PILOT_APP_IDENTIFIER",
+                                     description: "The bundle identifier of the app to upload or manage testers (optional)",
+                                     optional: true,
+                                     default_value: ENV["TESTFLIGHT_APP_IDENTITIFER"] || CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)),
+        FastlaneCore::ConfigItem.new(key: :app_platform,
+                                     short_option: "-m",
+                                     env_name: "PILOT_PLATFORM",
+                                     description: "The platform to use (optional)",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("The platform can only be ios, appletvos, or osx") unless ['ios', 'appletvos', 'osx'].include? value
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :ipa,
+                                     short_option: "-i",
+                                     optional: true,
+                                     env_name: "PILOT_IPA",
+                                     description: "Path to the ipa file to upload",
+                                     default_value: Dir["*.ipa"].first,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Could not find ipa file at path '#{value}'") unless File.exist? value
+                                       UI.user_error!("'#{value}' doesn't seem to be an ipa file") unless value.end_with? ".ipa"
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :changelog,
+                                     short_option: "-w",
+                                     optional: true,
+                                     env_name: "PILOT_CHANGELOG",
+                                     description: "Provide the what's new text when uploading a new build"),
+        FastlaneCore::ConfigItem.new(key: :beta_app_description,
+                                     short_option: "-d",
+                                     optional: true,
+                                     env_name: "PILOT_BETA_APP_DESCRIPTION",
+                                     description: "Provide the beta app description when uploading a new build"),
+        FastlaneCore::ConfigItem.new(key: :beta_app_feedback_email,
+                                     short_option: "-n",
+                                     optional: true,
+                                     env_name: "PILOT_BETA_APP_FEEDBACK",
+                                     description: "Provide the beta app email when uploading a new build"),
+        FastlaneCore::ConfigItem.new(key: :skip_submission,
+                                     short_option: "-s",
+                                     env_name: "PILOT_SKIP_SUBMISSION",
+                                     description: "Skip the distributing action of pilot and only upload the ipa file",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :skip_waiting_for_build_processing,
+                                     short_option: "-z",
+                                     env_name: "PILOT_SKIP_WAITING_FOR_BUILD_PROCESSING",
+                                     description: "Don't wait for the build to process. If set to true, the changelog won't be set",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :update_build_info_on_upload,
+                                     short_option: "-x",
+                                     env_name: "PILOT_UPDATE_BUILD_INFO_ON_UPLOAD",
+                                     description: "Update build info immediately after validation. This will set the changelog even if PILOT_SKIP_SUBMISSION is set, but will have no effect if PILOT_SKIP_WAITING_FOR_BUILD_PROCESSING is set",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :apple_id,
+                                     short_option: "-p",
+                                     env_name: "PILOT_APPLE_ID",
+                                     description: "The unique App ID provided by iTunes Connect",
+                                     optional: true,
+                                     default_value: ENV["TESTFLIGHT_APPLE_ID"]),
+        FastlaneCore::ConfigItem.new(key: :distribute_external,
+                                     is_string: false,
+                                     env_name: "PILOT_DISTRIBUTE_EXTERNAL",
+                                     description: "Should the build be distributed to external testers?",
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :first_name,
+                                     short_option: "-f",
+                                     env_name: "PILOT_TESTER_FIRST_NAME",
+                                     description: "The tester's first name",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :last_name,
+                                     short_option: "-l",
+                                     env_name: "PILOT_TESTER_LAST_NAME",
+                                     description: "The tester's last name",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :email,
+                                     short_option: "-e",
+                                     env_name: "PILOT_TESTER_EMAIL",
+                                     description: "The tester's email",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Please pass a valid email address") unless value.include? "@"
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :testers_file_path,
+                                     short_option: "-c",
+                                     env_name: "PILOT_TESTERS_FILE",
+                                     description: "Path to a CSV file of testers",
+                                     default_value: "./testers.csv",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :wait_processing_interval,
+                                     short_option: "-k",
+                                     env_name: "PILOT_WAIT_PROCESSING_INTERVAL",
+                                     description: "Interval in seconds to wait for iTunes Connect processing",
+                                     default_value: 30,
+                                     type: Integer,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Please enter a valid positive number of seconds") unless value.to_i > 0
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :team_id,
+                                     short_option: "-q",
+                                     env_name: "PILOT_TEAM_ID",
+                                     description: "The ID of your iTunes Connect team if you're in multiple teams",
+                                     optional: true,
+                                     is_string: false, # as we also allow integers, which we convert to strings anyway
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_ITC_TEAM_ID"] = value.to_s
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :team_name,
+                                     short_option: "-r",
+                                     env_name: "PILOT_TEAM_NAME",
+                                     description: "The name of your iTunes Connect team if you're in multiple teams",
+                                     optional: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name),
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_ITC_TEAM_NAME"] = value.to_s
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :dev_portal_team_id,
+                                     env_name: "PILOT_DEV_PORTAL_TEAM_ID",
+                                     description: "The short ID of your team in the developer portal, if you're in multiple teams. Different from your iTC team ID!",
+                                     optional: true,
+                                     is_string: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_TEAM_ID"] = value.to_s
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :itc_provider,
+                                     env_name: "PILOT_ITC_PROVIDER",
+                                     description: "The provider short name to be used with the iTMSTransporter to identify your team",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :groups,
+                                     short_option: "-g",
+                                     env_name: "PILOT_GROUPS",
+                                     description: "Associate tester to one group or more by group name / group id. E.g. '-g \"Team 1\",\"Team 2\"'",
+                                     optional: true,
+                                     type: Array,
+                                     verify_block: proc do |value|
+                                       UI.user_error!("Could not evaluate array from '#{value}'") unless value.kind_of?(Array)
+                                     end)
+      ]
+    end
+  end
+end

data/pilot/lib/pilot/tester_exporter.rb

@@ -0,0 +1,37 @@
+require "fastlane_core"
+require "pilot/tester_util"
+
+module Pilot
+  class TesterExporter < Manager
+    def export_testers(options)
+      UI.user_error!("Export file path is required") unless options[:testers_file_path]
+
+      start(options)
+      require 'csv'
+
+      app_filter = (config[:apple_id] || config[:app_identifier])
+      if app_filter
+        app = Spaceship::Application.find(app_filter)
+        testers = Spaceship::Tunes::Tester::External.all_by_app(app.apple_id)
+      else
+        testers = Spaceship::Tunes::Tester::External.all
+      end
+
+      file = config[:testers_file_path]
+
+      CSV.open(file, "w") do |csv|
+        csv << ['First', 'Last', 'Email', 'Groups', 'Devices', 'Installed Version', 'Install Date']
+
+        testers.each do |tester|
+          group_names = tester.groups_list(';') || ""
+          install_version = tester.full_version || ""
+          pretty_date = tester.pretty_install_date || ""
+
+          csv << [tester.first_name, tester.last_name, tester.email, group_names, tester.devices.count, install_version, pretty_date]
+        end
+
+        UI.success("Successfully exported CSV to #{file}")
+      end
+    end
+  end
+end

data/pilot/lib/pilot/tester_importer.rb

@@ -0,0 +1,51 @@
+require "fastlane_core"
+
+module Pilot
+  class TesterImporter < Manager
+    def import_testers(options)
+      UI.user_error!("Import file path is required") unless options[:testers_file_path]
+
+      start(options)
+
+      require 'csv'
+
+      file = config[:testers_file_path]
+      tester_manager = Pilot::TesterManager.new
+      imported_tester_count = 0
+
+      groups = options[:groups]
+
+      CSV.foreach(file, "r") do |row|
+        first_name, last_name, email, testing_groups = row
+
+        unless email
+          UI.error("No email found in row: #{row}")
+          next
+        end
+
+        unless email.index("@")
+          UI.error("No email found in row: #{row}")
+          next
+        end
+
+        # Add this the existing config hash to pass it to the TesterManager
+        config[:first_name] = first_name
+        config[:last_name] = last_name
+        config[:email] = email
+        config[:groups] = groups
+        if testing_groups
+          config[:groups] = testing_groups.split(";")
+        end
+
+        begin
+          tester_manager.add_tester(config)
+          imported_tester_count += 1
+        rescue
+          # do nothing, move on to the next row
+        end
+      end
+
+      UI.success("Successfully imported #{imported_tester_count} testers from #{file}")
+    end
+  end
+end