fastlane 1.111.0 → 2.0.1

data/pem/lib/pem/options.rb

@@ -0,0 +1,79 @@
+require 'fastlane_core'
+require 'credentials_manager'
+
+module PEM
+  class Options
+    def self.available_options
+      user = CredentialsManager::AppfileConfig.try_fetch_value(:apple_dev_portal_id)
+      user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+      [
+        FastlaneCore::ConfigItem.new(key: :development,
+                                     env_name: "PEM_DEVELOPMENT",
+                                     description: "Renew the development push certificate instead of the production one",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :generate_p12,
+                                     env_name: "PEM_GENERATE_P12_FILE",
+                                     description: "Generate a p12 file additionally to a PEM file",
+                                     is_string: false,
+                                     default_value: true),
+        FastlaneCore::ConfigItem.new(key: :force,
+                                     env_name: "PEM_FORCE",
+                                     description: "Create a new push certificate, even if the current one is active for 30 more days",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :save_private_key,
+                                     short_option: "-s",
+                                     env_name: "PEM_SAVE_PRIVATEKEY",
+                                     description: "Set to save the private RSA key",
+                                     is_string: false,
+                                     default_value: true),
+        FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                     short_option: "-a",
+                                     env_name: "PEM_APP_IDENTIFIER",
+                                     description: "The bundle identifier of your app",
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)),
+        FastlaneCore::ConfigItem.new(key: :username,
+                                     short_option: "-u",
+                                     env_name: "PEM_USERNAME",
+                                     description: "Your Apple ID Username",
+                                     default_value: user),
+        FastlaneCore::ConfigItem.new(key: :team_id,
+                                     short_option: "-b",
+                                     env_name: "PEM_TEAM_ID",
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
+                                     description: "The ID of your Developer Portal team if you're in multiple teams",
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_TEAM_ID"] = value.to_s
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :team_name,
+                                     short_option: "-l",
+                                     env_name: "PEM_TEAM_NAME",
+                                     description: "The name of your Developer Portal team if you're in multiple teams",
+                                     optional: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_name),
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_TEAM_NAME"] = value.to_s
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :p12_password,
+                                     short_option: "-p",
+                                     env_name: "PEM_P12_PASSWORD",
+                                     sensitive: true,
+                                     description: "The password that is used for your p12 file",
+                                     default_value: ""),
+        FastlaneCore::ConfigItem.new(key: :pem_name,
+                                     short_option: "-o",
+                                     env_name: "PEM_FILE_NAME",
+                                     description: "The file name of the generated .pem file",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :output_path,
+                                     short_option: "-e",
+                                     env_name: "PEM_OUTPUT_PATH",
+                                     description: "The path to a directory in which all certificates and private keys should be stored",
+                                     default_value: ".")
+      ]
+    end
+  end
+end

data/pilot/README.md

@@ -0,0 +1,285 @@
+<h3 align="center">
+  <a href="https://github.com/fastlane/fastlane/tree/master/fastlane">
+    <img src="../fastlane/assets/fastlane.png" width="150" />
+    <br />
+    fastlane
+  </a>
+</h3>
+<p align="center">
+  <a href="https://github.com/fastlane/fastlane/tree/master/deliver">deliver</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/snapshot">snapshot</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/frameit">frameit</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/pem">pem</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/sigh">sigh</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/produce">produce</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/cert">cert</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/spaceship">spaceship</a> &bull;
+  <b>pilot</b> &bull;
+  <a href="https://github.com/fastlane/boarding">boarding</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/gym">gym</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/scan">scan</a> &bull;
+  <a href="https://github.com/fastlane/fastlane/tree/master/match">match</a>
+</p>
+-------
+
+<p align="center">
+  <img src="assets/PilotTextTransparentSmall.png" width="500">
+</p>
+
+Pilot
+============
+[![Twitter: @FastlaneTools](https://img.shields.io/badge/contact-@FastlaneTools-blue.svg?style=flat)](https://twitter.com/FastlaneTools)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/fastlane/blob/master/pilot/LICENSE)
+[![Gem](https://img.shields.io/gem/v/pilot.svg?style=flat)](http://rubygems.org/gems/pilot)
+
+
+###### The best way to manage your TestFlight testers and builds from your terminal
+
+Pilot makes it easier to manage your app on Apple’s TestFlight. You can:
+
+- Upload & distribute builds
+- Add & remove testers
+- Retrieve information about testers & devices
+- Import/export all available testers
+
+Get in contact with the developer on Twitter: [@FastlaneTools](https://twitter.com/FastlaneTools)
+
+`pilot` uses [spaceship.airforce](https://spaceship.airforce) to interact with iTunes Connect :rocket:
+
+-------
+<p align="center">
+    <a href="#installation">Installation</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#tips">Tips</a> &bull;
+    <a href="#need-help">Need help?</a>
+</p>
+
+-------
+
+<h5 align="center"><code>pilot</code> is part of <a href="https://fastlane.tools">fastlane</a>: The easiest way to automate beta deployments and releases for your iOS and Android apps.</h5>
+
+# Installation
+
+    sudo gem install fastlane
+
+# Usage
+
+For all commands you can specify the Apple ID to use using `-u felix@krausefx.com`. If you execute `pilot` in a project already using [fastlane](https://fastlane.tools) the username and app identifier will automatically be determined.
+
+## Uploading builds
+
+To upload a new build, just run
+
+```
+fastlane pilot upload
+```
+
+This will automatically look for an `ipa` in your current directory and tries to fetch the login credentials from your [fastlane setup](https://fastlane.tools).
+
+You'll be asked for any missing information. Additionally, you can pass all kinds of parameters:
+
+```
+fastlane pilot --help
+```
+
+You can pass a changelog using
+
+```
+fastlane pilot upload --changelog "Something that is new here"
+```
+
+You can also skip the submission of the binary, which means, the `ipa` file will only be uploaded and not distributed to testers:
+
+```
+fastlane pilot upload --skip_submission
+```
+
+`pilot` does all kinds of magic for you:
+
+- Automatically detects the bundle identifier from your `ipa` file
+- Automatically fetch the AppID of your app based on the bundle identifier
+
+`pilot` uses [spaceship](https://spaceship.airforce) to submit the build metadata and the iTunes Transporter to upload the binary.
+
+## List builds
+
+To list all builds for specific application use
+
+```
+fastlane pilot builds
+```
+
+The result lists all active builds and processing builds:
+
+```
++-----------+---------+----------+----------+----------+
+|                   Great App Builds                   |
++-----------+---------+----------+----------+----------+
+| Version # | Build # | Testing  | Installs | Sessions |
++-----------+---------+----------+----------+----------+
+| 0.9.13    | 1       | Expired  | 1        | 0        |
+| 0.9.13    | 2       | Expired  | 0        | 0        |
+| 0.9.20    | 3       | Expired  | 0        | 0        |
+| 0.9.20    | 4       | Internal | 5        | 3        |
++-----------+---------+----------+----------+----------+
+```
+
+## Managing beta testers
+
+### List of Testers
+
+This command will list all your testers, both internal and external.
+
+```
+fastlane pilot list
+```
+
+The output will look like this:
+
+```
++--------+--------+--------------------------+-----------+
+|                    Internal Testers                    |
++--------+--------+--------------------------+-----------+
+| First  | Last   | Email                    | # Devices |
++--------+--------+--------------------------+-----------+
+| Felix  | Krause | felix@krausefx.com       | 2         |
++--------+--------+--------------------------+-----------+
+
++-----------+---------+----------------------------+-----------+
+|                       External Testers                       |
++-----------+---------+----------------------------+-----------+
+| First     | Last    | Email                      | # Devices |
++-----------+---------+----------------------------+-----------+
+| Max       | Manfred | email@email.com            | 0         |
+| Detlef    | Müller  | detlef@krausefx.com        | 1         |
++-----------+---------+----------------------------+-----------+
+```
+
+### Add a new tester
+
+To add a new tester to both your iTunes Connect account and to your app (if given), use the `pilot add` command. This will create a new tester (if necessary) or add an existing tester to the app to test.
+
+```
+fastlane pilot add email@invite.com
+```
+
+Additionally you can specify the app identifier (if necessary):
+
+```
+fastlane pilot add email@email.com -a com.krausefx.app
+```
+
+### Find a tester
+
+To find a specific tester use
+
+```
+fastlane pilot find felix@krausefx.com
+```
+
+The resulting output will look like this:
+
+```
++---------------------+---------------------+
+|            felix@krausefx.com             |
++---------------------+---------------------+
+| First name          | Felix               |
+| Last name           | Krause              |
+| Email               | felix@krausefx.com  |
+| Latest Version      | 0.9.14 (23          |
+| Latest Install Date | 03/28/15 19:00      |
+| 2 Devices           | • iPhone 6, iOS 8.3 |
+|                     | • iPhone 5, iOS 7.0 |
++---------------------+---------------------+
+```
+
+### Remove a tester
+
+This command will only remove external beta testers.
+
+```
+fastlane pilot remove felix@krausefx.com
+```
+
+### Export testers
+
+To export all external testers to a CSV file. Useful if you need to import tester info to another system or a new account.
+
+```
+fastlane pilot export
+```
+
+### Import testers
+
+Add external testers from a CSV file. Sample CSV file available [here](https://itunesconnect.apple.com/itc/docs/tester_import.csv).
+
+```
+fastlane pilot import
+```
+
+You can also specify the directory using
+
+```
+fastlane pilot export -c ~/Desktop/testers.csv
+fastlane pilot import -c ~/Desktop/testers.csv
+ ```
+
+# Tips
+
+## [`fastlane`](https://fastlane.tools) Toolchain
+
+- [`fastlane`](https://fastlane.tools): The easiest way to automate beta deployments and releases for your iOS and Android apps
+- [`deliver`](https://github.com/fastlane/fastlane/tree/master/deliver): Upload screenshots, metadata and your app to the App Store
+- [`snapshot`](https://github.com/fastlane/fastlane/tree/master/snapshot): Automate taking localized screenshots of your iOS app on every device
+- [`frameit`](https://github.com/fastlane/fastlane/tree/master/frameit): Quickly put your screenshots into the right device frames
+- [`produce`](https://github.com/fastlane/fastlane/tree/master/produce): Create new iOS apps on iTunes Connect and Dev Portal using the command line
+- [`pem`](https://github.com/fastlane/fastlane/tree/master/pem): Automatically generate and renew your push notification profiles
+- [`sigh`](https://github.com/fastlane/fastlane/tree/master/sigh): Because you would rather spend your time building stuff than fighting provisioning
+- [`cert`](https://github.com/fastlane/fastlane/tree/master/cert): Automatically create and maintain iOS code signing certificates
+- [`spaceship`](https://github.com/fastlane/fastlane/tree/master/spaceship): Ruby library to access the Apple Dev Center and iTunes Connect
+- [`boarding`](https://github.com/fastlane/boarding): The easiest way to invite your TestFlight beta testers
+- [`gym`](https://github.com/fastlane/fastlane/tree/master/gym): Building your iOS apps has never been easier
+- [`scan`](https://github.com/fastlane/fastlane/tree/master/scan): The easiest way to run tests of your iOS and Mac app
+- [`match`](https://github.com/fastlane/fastlane/tree/master/match): Easily sync your certificates and profiles across your team using git
+
+##### [Like this tool? Be the first to know about updates and new fastlane tools](https://tinyletter.com/krausefx)
+
+## Debug information
+
+If you run into any issues you can use the `verbose` mode to get a more detailed output:
+
+    fastlane pilot --verbose
+
+## Firewall Issues
+
+`pilot` uses the iTunes Transporter to upload metadata and binaries. In case you are behind a firewall, you can specify a different transporter protocol from the command line using
+
+```
+DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS="-t DAV" pilot ...
+```
+
+If you are using `pilot` via the [fastlane action](https://docs.fastlane.tools/actions#pilot), add the following to your `Fastfile`
+
+```
+ENV["DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS"] = "-t DAV"
+pilot...
+```
+
+## Credentials Issues
+
+If your password contains special characters, `pilot` may throw a confusing error saying your "Your Apple ID or password was entered incorrectly". The easiest way to fix this error is to change your password to something that **does not** contains special characters.
+
+## How is my password stored?
+
+`pilot` uses the [CredentialsManager](https://github.com/fastlane/fastlane/tree/master/credentials_manager) from `fastlane`.
+
+# Need help?
+Please submit an issue on GitHub and provide information about your setup
+
+# Code of Conduct
+Help us keep `pilot` open and inclusive. Please read and follow our [Code of Conduct](https://github.com/fastlane/fastlane/blob/master/CODE_OF_CONDUCT.md).
+
+# License
+This project is licensed under the terms of the MIT license. See the LICENSE file.
+
+> This project and all fastlane tools are in no way affiliated with Apple Inc. This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. All fastlane tools run on your own computer or server, so your credentials or other sensitive information will never leave your own computer. You are responsible for how you use fastlane tools.

data/pilot/lib/pilot.rb

@@ -0,0 +1,22 @@
+# fastlane_core must be required before 'pilot/features' which depends on it for FastlaneCore::Feature
+require "fastlane_core"
+
+require "json"
+require 'pilot/features'
+require "pilot/options"
+require "pilot/manager"
+require "pilot/build_manager"
+require "pilot/tester_manager"
+require "pilot/tester_importer"
+require "pilot/tester_exporter"
+
+require "spaceship"
+require "terminal-table"
+
+module Pilot
+  Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
+  UI = FastlaneCore::UI
+  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/build_manager.rb

@@ -0,0 +1,209 @@
+module Pilot
+  class BuildManager < Manager
+    def upload(options)
+      start(options)
+
+      options[:changelog] = self.class.truncate_changelog(options[:changelog]) if options[:changelog]
+
+      UI.user_error!("No ipa file given") unless config[:ipa]
+
+      UI.success("Ready to upload new build to TestFlight (App: #{app.apple_id})...")
+
+      platform = fetch_app_platform
+      package_path = FastlaneCore::IpaUploadPackageBuilder.new.generate(app_id: app.apple_id,
+                                                                      ipa_path: config[:ipa],
+                                                                  package_path: "/tmp",
+                                                                      platform: platform)
+
+      transporter = FastlaneCore::ItunesTransporter.new(options[:username], nil, false, options[:itc_provider])
+      result = transporter.upload(app.apple_id, package_path)
+
+      unless result
+        UI.user_error!("Error uploading ipa file, for more information see above")
+      end
+
+      UI.message("Successfully uploaded the new binary to iTunes Connect")
+
+      if config[:skip_waiting_for_build_processing]
+        UI.important("Skip waiting for build processing")
+        UI.important("This means that no changelog will be set and no build will be distributed to testers")
+        return
+      end
+
+      UI.message("If you want to skip waiting for the processing to be finished, use the `skip_waiting_for_build_processing` option")
+      uploaded_build = wait_for_processing_build(options, platform) # this might take a while
+
+      distribute(options, uploaded_build)
+    end
+
+    def distribute(options, build = nil)
+      start(options)
+      if config[:apple_id].to_s.length == 0 and config[:app_identifier].to_s.length == 0
+        config[:app_identifier] = UI.input("App Identifier: ")
+      end
+
+      if build.nil?
+        platform = fetch_app_platform(required: false)
+        builds = app.all_processing_builds(platform: platform) + app.builds(platform: platform)
+        # sort by upload_date
+        builds.sort! { |a, b| a.upload_date <=> b.upload_date }
+        build = builds.last
+        if build.nil?
+          UI.user_error!("No builds found.")
+          return
+        end
+        if build.processing
+          UI.user_error!("Build #{build.train_version}(#{build.build_version}) is still processing.")
+          return
+        end
+        if build.testing_status == "External"
+          UI.user_error!("Build #{build.train_version}(#{build.build_version}) has already been distributed.")
+          return
+        end
+
+        UI.message("Distributing build #{build.train_version}(#{build.build_version}) from #{build.testing_status} -> External")
+      end
+
+      unless config[:update_build_info_on_upload]
+        if should_update_build_information(options)
+          build.update_build_information!(whats_new: options[:changelog], description: options[:beta_app_description], feedback_email: options[:beta_app_feedback_email])
+          UI.success "Successfully set the changelog and/or description for build"
+        end
+      end
+
+      return if config[:skip_submission]
+      distribute_build(build, options)
+      UI.message("Successfully distributed build to beta testers 🚀")
+    end
+
+    def list(options)
+      start(options)
+      if config[:apple_id].to_s.length == 0 and config[:app_identifier].to_s.length == 0
+        config[:app_identifier] = UI.input("App Identifier: ")
+      end
+
+      platform = fetch_app_platform(required: false)
+      builds = app.all_processing_builds(platform: platform) + app.builds(platform: platform)
+      # sort by upload_date
+      builds.sort! { |a, b| a.upload_date <=> b.upload_date }
+      rows = builds.collect { |build| describe_build(build) }
+
+      puts Terminal::Table.new(
+        title: "#{app.name} Builds".green,
+        headings: ["Version #", "Build #", "Testing", "Installs", "Sessions"],
+        rows: rows
+      )
+    end
+
+    def self.truncate_changelog(changelog)
+      max_changelog_length = 4000
+      if changelog && changelog.length > max_changelog_length
+        original_length = changelog.length
+        bottom_message = "..."
+        changelog = "#{changelog[0...max_changelog_length - bottom_message.length]}#{bottom_message}"
+        UI.important "Changelog has been truncated since it exceeds Apple's #{max_changelog_length} character limit. It currently contains #{original_length} characters."
+      end
+      return changelog
+    end
+
+    private
+
+    def describe_build(build)
+      row = [build.train_version,
+             build.build_version,
+             build.testing_status,
+             build.install_count,
+             build.session_count]
+
+      return row
+    end
+
+    def should_update_build_information(options)
+      options[:changelog].to_s.length > 0 or options[:beta_app_description].to_s.length > 0 or options[:beta_app_feedback_email].to_s.length > 0
+    end
+
+    # This method will takes care of checking for the processing builds every few seconds
+    # @return [Build] The build that we just uploaded
+    def wait_for_processing_build(options, platform)
+      # the upload date of the new buid
+      # we use it to identify the build
+      start = Time.now
+      wait_processing_interval = config[:wait_processing_interval].to_i
+      latest_build = nil
+      UI.message("Waiting for iTunes Connect to process the new build")
+      must_update_build_info = config[:update_build_info_on_upload]
+      loop do
+        sleep(wait_processing_interval)
+
+        # before we look for processing builds, we need to ensure that there
+        #  is a build train for this application; new applications don't
+        #  build trains right away, and if we don't do this check, we will
+        #  get break out of this loop and then generate an error later when we
+        #  have a nil build
+        if app.build_trains(platform: platform).count == 0
+          UI.message("New application; waiting for build train to appear on iTunes Connect")
+        else
+          builds = app.all_processing_builds(platform: platform)
+          break if builds.count == 0
+          latest_build = builds.last
+
+          if latest_build.valid and must_update_build_info
+            # Set the changelog and/or description if necessary
+            if should_update_build_information(options)
+              latest_build.update_build_information!(whats_new: options[:changelog], description: options[:beta_app_description], feedback_email: options[:beta_app_feedback_email])
+              UI.success "Successfully set the changelog and/or description for build"
+            end
+            must_update_build_info = false
+          end
+
+          UI.message("Waiting for iTunes Connect to finish processing the new build (#{latest_build.train_version} - #{latest_build.build_version})")
+        end
+      end
+
+      UI.user_error!("Error receiving the newly uploaded binary, please check iTunes Connect") if latest_build.nil?
+      full_build = nil
+
+      while full_build.nil? || full_build.processing
+        # The build's processing state should go from true to false, and be done. But sometimes it goes true -> false ->
+        # true -> false, where the second true is transient. This causes a spurious failure. Find build by build_version
+        # and ensure it's not processing before proceeding - it had to have already been false before, to get out of the
+        # previous loop.
+        full_build = app.build_trains(platform: platform)[latest_build.train_version].builds.find do |b|
+          b.build_version == latest_build.build_version
+        end
+
+        UI.message("Waiting for iTunes Connect to finish processing the new build (#{latest_build.train_version} - #{latest_build.build_version})")
+        sleep(wait_processing_interval)
+      end
+
+      if full_build && !full_build.processing && full_build.valid
+        minutes = ((Time.now - start) / 60).round
+        UI.success("Successfully finished processing the build")
+        UI.message("You can now tweet: ")
+        UI.important("iTunes Connect #iosprocessingtime #{minutes} minutes")
+        return full_build
+      else
+        UI.user_error!("Error: Seems like iTunes Connect didn't properly pre-process the binary")
+      end
+    end
+
+    def distribute_build(uploaded_build, options)
+      UI.message("Distributing new build to testers")
+
+      # Submit for review before external testflight is available
+      if options[:distribute_external]
+        uploaded_build.client.submit_testflight_build_for_review!(
+          app_id: uploaded_build.build_train.application.apple_id,
+          train: uploaded_build.build_train.version_string,
+          build_number: uploaded_build.build_version,
+          platform: uploaded_build.platform
+        )
+      end
+
+      # Submit for beta testing
+      type = options[:distribute_external] ? 'external' : 'internal'
+      uploaded_build.build_train.update_testing_status!(true, type, uploaded_build)
+      return true
+    end
+  end
+end