fastlane_iac_publish 0.1.0

data/pilot/lib/pilot/commands_generator.rb

@@ -0,0 +1,174 @@
+require "commander"
+
+require 'fastlane_core/configuration/configuration'
+require_relative 'module'
+require_relative 'tester_importer'
+require_relative 'tester_exporter'
+require_relative 'tester_manager'
+require_relative 'build_manager'
+require_relative 'options'
+
+HighLine.track_eof = false
+
+module Pilot
+  class CommandsGenerator
+    include Commander::Methods
+
+    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 = create_config(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
+          # no need to show the email address in the message if only one specified
+          message = (args.count > 1) ? "[#{address}]: #{ex}" : ex
+          failures << message
+          UI.error(message)
+        end
+      end
+      UI.user_error!("Some operations failed: #{failures.join(', ')}") 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, "Documentation", "https://docs.fastlane.tools/actions/pilot/"
+      program :help_formatter, :compact
+
+      global_option("--verbose") { FastlaneCore::Globals.verbose = true }
+
+      command :upload do |c|
+        c.syntax = "fastlane pilot upload"
+        c.description = "Uploads a new binary to Apple TestFlight"
+
+        FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options, command: c)
+
+        c.action do |args, options|
+          config = create_config(options)
+          Pilot::BuildManager.new.upload(config)
+        end
+      end
+
+      command :distribute do |c|
+        c.syntax = "fastlane pilot distribute"
+        c.description = "Distribute a previously uploaded binary to Apple TestFlight"
+
+        FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options, command: c)
+
+        c.action do |args, options|
+          config = create_config(options)
+          Pilot::BuildManager.new.distribute(config)
+        end
+      end
+
+      command :builds do |c|
+        c.syntax = "fastlane pilot builds"
+        c.description = "Lists all builds for given application"
+
+        FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options, command: c)
+
+        c.action do |args, options|
+          config = create_config(options)
+          Pilot::BuildManager.new.list(config)
+        end
+      end
+
+      command :add do |c|
+        c.syntax = "fastlane 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."
+
+        FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options, command: c)
+
+        c.action do |args, options|
+          handle_multiple('add_tester', args, options)
+        end
+      end
+
+      command :list do |c|
+        c.syntax = "fastlane pilot list"
+        c.description = "Lists all registered testers, both internal and external"
+
+        FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options, command: c)
+
+        c.action do |args, options|
+          config = create_config(options)
+          UI.user_error!("You must include an `app_identifier` to list testers") unless config[:app_identifier]
+          Pilot::TesterManager.new.list_testers(config)
+        end
+      end
+
+      command :find do |c|
+        c.syntax = "fastlane pilot find"
+        c.description = "Find tester(s) (internal or external) by their email address"
+
+        FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options, command: c)
+
+        c.action do |args, options|
+          handle_multiple('find_tester', args, options)
+        end
+      end
+
+      command :remove do |c|
+        c.syntax = "fastlane pilot remove"
+        c.description = "Remove external tester(s) by their email address"
+
+        FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options, command: c)
+
+        c.action do |args, options|
+          handle_multiple('remove_tester', args, options)
+        end
+      end
+
+      command :export do |c|
+        c.syntax = "fastlane pilot export"
+        c.description = "Exports all external testers to a CSV file"
+
+        FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options, command: c)
+
+        c.action do |args, options|
+          config = create_config(options)
+          Pilot::TesterExporter.new.export_testers(config)
+        end
+      end
+
+      command :import do |c|
+        c.syntax = "fastlane pilot import"
+        c.description = "Import external testers from a CSV file called testers.csv"
+
+        FastlaneCore::CommanderGenerator.new.generate(Pilot::Options.available_options, command: c)
+
+        c.action do |args, options|
+          config = create_config(options)
+          Pilot::TesterImporter.new.import_testers(config)
+        end
+      end
+
+      default_command(:help)
+
+      run!
+    end
+
+    def create_config(options)
+      config = FastlaneCore::Configuration.create(Pilot::Options.available_options, convert_options(options))
+      return config
+    end
+  end
+end

data/pilot/lib/pilot/manager.rb

@@ -0,0 +1,80 @@
+require 'credentials_manager/appfile_config'
+
+require 'fastlane_core/print_table'
+require 'spaceship'
+require 'spaceship/tunes/tunes'
+require 'spaceship/tunes/members'
+require 'spaceship/test_flight'
+require 'fastlane_core/ipa_file_analyser'
+require_relative 'module'
+
+module Pilot
+  class Manager
+    def start(options, should_login: true)
+      return if @config # to not login multiple times
+      @config = options
+      login if should_login
+    end
+
+    def login
+      config[:username] ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+      UI.message("Login to App Store Connect (#{config[:username]})")
+      Spaceship::Tunes.login(config[:username])
+      Spaceship::Tunes.select_team(team_id: config[:team_id], team_name: config[:team_name])
+      UI.message("Login successful")
+    end
+
+    # The app object we're currently using
+    def app
+      @app_id ||= fetch_app_id
+
+      @app ||= Spaceship::ConnectAPI::App.get(app_id: @app_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
+      @app_id ||= config[:apple_id]
+      return @app_id if @app_id
+      config[:app_identifier] = fetch_app_identifier
+
+      if config[:app_identifier]
+        @app ||= Spaceship::ConnectAPI::App.find(config[:app_identifier])
+        UI.user_error!("Couldn't find app '#{config[:app_identifier]}' on the account of '#{config[:username]}' on App Store Connect") unless @app
+        @app_id ||= @app.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 ||= UI.input("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/module.rb

@@ -0,0 +1,11 @@
+require 'fastlane_core/helper'
+require 'fastlane/boolean'
+
+module Pilot
+  Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
+  UI = FastlaneCore::UI
+  Boolean = Fastlane::Boolean
+  ROOT = Pathname.new(File.expand_path('../../..', __FILE__))
+
+  DESCRIPTION = "The best way to manage your TestFlight testers and builds from your terminal"
+end

data/pilot/lib/pilot/options.rb

@@ -0,0 +1,266 @@
+require 'fastlane_core/configuration/config_item'
+require 'credentials_manager/appfile_config'
+
+require_relative 'module'
+
+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)
+
+      [
+        # app upload info
+        FastlaneCore::ConfigItem.new(key: :username,
+                                     short_option: "-u",
+                                     env_name: "PILOT_USERNAME",
+                                     description: "Your Apple ID Username",
+                                     default_value: user,
+                                     default_value_dynamic: true),
+        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,
+                                     code_gen_sensitive: true,
+                                     # This incorrect env name is here for backwards compatibility
+                                     default_value: ENV["TESTFLIGHT_APP_IDENTITIFER"] || CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier),
+                                     default_value_dynamic: true),
+        FastlaneCore::ConfigItem.new(key: :app_platform,
+                                     short_option: "-m",
+                                     env_name: "PILOT_PLATFORM",
+                                     description: "The platform to use (optional)",
+                                     optional: true,
+                                     default_value: 'ios',
+                                     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: :apple_id,
+                                     short_option: "-p",
+                                     env_name: "PILOT_APPLE_ID",
+                                     description: "Apple ID property in the App Information section in App Store Connect",
+                                     optional: true,
+                                     code_gen_sensitive: true,
+                                     default_value: ENV["TESTFLIGHT_APPLE_ID"],
+                                     default_value_dynamic: true,
+                                     type: String,
+                                     verify_block: proc do |value|
+                                       error_message = "`apple_id` value is incorrect. The correct value should be taken from Apple ID property in the App Information section in App Store Connect."
+
+                                       # Validate if the value is not an email address
+                                       UI.user_error!(error_message) if value =~ /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i
+
+                                       # Validate if the value is not a bundle identifier
+                                       UI.user_error!(error_message) if value =~ /^[A-Za-x]{2,6}((?!-)\.[A-Za-z0-9-]{1,63}(?<!-))+$/i
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :ipa,
+                                     short_option: "-i",
+                                     optional: true,
+                                     env_name: "PILOT_IPA",
+                                     description: "Path to the ipa file to upload",
+                                     code_gen_sensitive: true,
+                                     default_value: Dir["*.ipa"].sort_by { |x| File.mtime(x) }.last,
+                                     default_value_dynamic: true,
+                                     verify_block: proc do |value|
+                                       value = File.expand_path(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),
+
+        # app review info
+        FastlaneCore::ConfigItem.new(key: :demo_account_required,
+                                     type: Boolean,
+                                     env_name: "DEMO_ACCOUNT_REQUIRED",
+                                     description: "Do you need a demo account when Apple does review?",
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :beta_app_review_info,
+                                     type: Hash,
+                                     env_name: "PILOT_BETA_APP_REVIEW_INFO",
+                                     description: "Beta app review information for contact info and demo account",
+                                     optional: true,
+                                     verify_block: proc do |values|
+                                       valid_keys = %w(contact_email contact_first_name contact_last_name contact_phone demo_account_required demo_account_name demo_account_password notes)
+                                       values.keys.each { |value| UI.user_error!("Invalid key '#{value}'") unless valid_keys.include?(value.to_s) }
+                                     end),
+
+        # app detail
+        FastlaneCore::ConfigItem.new(key: :localized_app_info,
+                                     type: Hash,
+                                     env_name: "PILOT_LOCALIZED_APP_INFO",
+                                     description: "Localized beta app test info for description, feedback email, marketing url, and privacy policy",
+                                     optional: true,
+                                     verify_block: proc do |lang_values|
+                                       valid_keys = %w(feedback_email marketing_url privacy_policy_url tv_os_privacy_policy_url description)
+                                       lang_values.values.each do |values|
+                                         values.keys.each { |value| UI.user_error!("Invalid key '#{value}'") unless valid_keys.include?(value.to_s) }
+                                       end
+                                     end),
+        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"),
+
+        # build review info
+        FastlaneCore::ConfigItem.new(key: :localized_build_info,
+                                     type: Hash,
+                                     env_name: "PILOT_LOCALIZED_BUILD_INFO",
+                                     description: "Localized beta app test info for what's new",
+                                     optional: true,
+                                     verify_block: proc do |lang_values|
+                                       valid_keys = %w(whats_new)
+                                       lang_values.values.each do |values|
+                                         values.keys.each { |value| UI.user_error!("Invalid key '#{value}'") unless valid_keys.include?(value.to_s) }
+                                       end
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :changelog,
+                                     short_option: "-w",
+                                     optional: true,
+                                     env_name: "PILOT_CHANGELOG",
+                                     description: "Provide the 'What to Test' text when uploading a new build. `skip_waiting_for_build_processing: false` is required to set the changelog"),
+        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, `distribute_external` option won't work and no build will be distributed to testers. (You might want to use this option if you are using this action on CI and have to pay for 'minutes used' on your CI plan)",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :update_build_info_on_upload,
+                                     deprecated: true,
+                                     short_option: "-x",
+                                     env_name: "PILOT_UPDATE_BUILD_INFO_ON_UPLOAD",
+                                     description: "Update build info immediately after validation. This is deprecated and will be removed in a future release. App Store Connect no longer supports setting build info until after build processing has completed, which is when build info is updated by default",
+                                     is_string: false,
+                                     default_value: false),
+
+        # distribution
+        FastlaneCore::ConfigItem.new(key: :uses_non_exempt_encryption,
+                                     short_option: "-X",
+                                     env_name: "PILOT_USES_NON_EXEMPT_ENCRYPTION",
+                                     description: "Provide the 'Uses Non-Exempt Encryption' for export compliance. This is used if there is 'ITSAppUsesNonExemptEncryption' is not set in the Info.plist",
+                                     default_value: false,
+                                     type: Boolean),
+        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: :notify_external_testers,
+                                    is_string: false,
+                                    env_name: "PILOT_NOTIFY_EXTERNAL_TESTERS",
+                                    description: "Should notify external testers?",
+                                    default_value: true),
+
+        # testers
+        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: :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),
+
+        # app store connect teams
+        FastlaneCore::ConfigItem.new(key: :team_id,
+                                     short_option: "-q",
+                                     env_name: "PILOT_TEAM_ID",
+                                     description: "The ID of your App Store Connect team if you're in multiple teams",
+                                     optional: true,
+                                     is_string: false, # as we also allow integers, which we convert to strings anyway
+                                     code_gen_sensitive: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
+                                     default_value_dynamic: true,
+                                     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 App Store Connect team if you're in multiple teams",
+                                     optional: true,
+                                     code_gen_sensitive: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name),
+                                     default_value_dynamic: true,
+                                     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,
+                                     code_gen_sensitive: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
+                                     default_value_dynamic: true,
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_TEAM_ID"] = value.to_s
+                                     end),
+        # rubocop:disable Metrics/LineLength
+        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. This value will override the automatically detected provider short name. To get provider short name run `pathToXcode.app/Contents/Applications/Application\\ Loader.app/Contents/itms/bin/iTMSTransporter -m provider -u 'USERNAME' -p 'PASSWORD' -account_type itunes_connect -v off`. The short names of providers should be listed in the second column",
+                                     optional: true),
+        # rubocop:enable Metrics/LineLength
+
+        # waiting and uploaded build
+        FastlaneCore::ConfigItem.new(key: :wait_processing_interval,
+                                     short_option: "-k",
+                                     env_name: "PILOT_WAIT_PROCESSING_INTERVAL",
+                                     description: "Interval in seconds to wait for App Store 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: :wait_for_uploaded_build,
+                                     env_name: "PILOT_WAIT_FOR_UPLOADED_BUILD",
+                                     deprecated: "No longer needed with the transition over to the App Store Connect API",
+                                     description: "Use version info from uploaded ipa file to determine what build to use for distribution. If set to false, latest processing or any latest build will be used",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :reject_build_waiting_for_review,
+                                     short_option: "-b",
+                                     env_name: "PILOT_REJECT_PREVIOUS_BUILD",
+                                     description: "Expire previous if it's 'waiting for review'",
+                                     is_string: false,
+                                     default_value: false)
+      ]
+    end
+  end
+end