fastlane-plugin-transporter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 542ddbabb35e33b1700003117d1c338fff524e26772bebf7820d7e95f34718a7
+  data.tar.gz: e8b06662f57faf0daab7e3ad262676c5dff7b453a202b48e33441ffb6fdc198f
+SHA512:
+  metadata.gz: 7f9a31c0163368c485266d87837f97c34853656210c96dcbb77393c6c4a949ea7a85d2c88540bd802eda0119b0da61f13cf7a89c97971b60059cfdb9ec230da1
+  data.tar.gz: 80f0c7e1e9dc31954d6fcb5f907bf99567ad71395ca502d68e0a13846acf72b3e4f453af20cad6708b65296abbbbcd4393f62a524b426692769c037294aac83b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Maksym Grebenets <mgrebenets@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# transporter plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-transporter)
+[![version](https://badge.fury.io/gh/mgrebenets%2Ffastlane-plugin-transporter.svg)](https://badge.fury.io/gh/mgrebenets%2Ffastlane-plugin-transporter)
+[![CircleCI](https://circleci.com/gh/mgrebenets/fastlane-plugin-transporter.svg?style=svg)](https://circleci.com/gh/mgrebenets/fastlane-plugin-transporter)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-transporter`, add it to your project by running:
+
+```bash
+fastlane add_plugin transporter
+```
+
+## About transporter
+
+Adds actions to manage Apple iTMSTransporter installation.
+
+Apart from installing Transporter, this plugin allows you to configure Transporter installation.
+This is very useful in enterprise environment, where you need to work with self-signed root CA and/or company proxy.
+
+⚠️ Only Mac OS X is supported at the moment.
+
+### install_transporter
+
+The `install_transporter` action downloads and unpacks Transporter package and installs it to specified path.
+
+Instead of downloading Transporter package from remote source a path to local copy of tarball can be specified or even a path to already unpacked Transporter directory.
+
+### configure_transporter
+
+The `configure_transporter` action allows configuring Transporter after installation.
+
+If you need to use Transporter in enterprise setup with self-signed root CA used to encrypt all your network traffic, you need to add this root CA certificate to Transporter's keystore using `root_ca` parameter. This parameter can be either a path to the certificate or certificate Common Name.
+
+To enable Basic authentication for Transporter network calls, set `enable_basic_auth` to `true`.
+
+### update_transporter_path
+
+This action updates `FASTLANE_ITUNES_TRANSPORTER_PATH` with the specified install path. This environment variable is used by Fastlane to run actions like `deliver` or `pilot`.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+The example lane installs Transporter to `~/itms`, then adds Apple iPhone Certification Authority certificate to Transporter keystore and finally sets the `FASTLANE_ITUNES_TRANSPORTER_PATH` environment variable so that Fastlane can use this custom installation.
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+### Linux and Windows Support
+
+Transporter package for Linux and Windows is different from the OS X version. The java binaries like `java/bin/java` and `java/bin/keytool` are actual executables compiled for target platform.
+
+To support Linux and Windows a different package would have to be downloaded and installed.
+The installation script is different from just unpack-and-copy version of Mac OS X.
+For example, [this is the Linux installation script](https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/resources/download/Transporter__linux/bin/).
+
+### Remove or Overwrite Root CA Certificates
+
+Q: Why is there no way to remove or overwrite existing root CA entry in Transporter's keystore?
+
+This is a valid option but root CA certs don't expire that often.
+There's always a workaround of just reinstalling Transporter.
+If such option becomes very important, it can be added in the future.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/transporter.rb

@@ -0,0 +1,120 @@
+require 'fastlane/plugin/transporter/version'
+
+module Fastlane
+  module Transporter
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+
+    # Default source URL.
+    DEFAULT_TRANSPORTER_SOURCE = "https://github.com/mgrebenets/fastlane-plugin-transporter/releases/download/0.0.1/iTMSTransporter_1.13.0.tgz"
+
+    # Default installation path.
+    DEFAULT_TRANSPORTER_INSTALL_PATH = File.expand_path("~/itms")
+
+    # Install transporter.
+    # @param source [String] Transporter tarball URL or path; or path to existing Transporter directory.
+    # @param install_path [String] Transporter install path.
+    # @param overwrite [Boolean] Overwrite existing installation. Default is `false`.
+    def self.install(
+      source: DEFAULT_TRANSPORTER_SOURCE,
+      install_path: DEFAULT_TRANSPORTER_INSTALL_PATH,
+      overwrite: false
+    )
+      if install_path.eql?(source)
+        FastlaneCore::UI.message("Source and install path are the same")
+        return
+      end
+
+      if File.exist?(install_path) && !overwrite
+        FastlaneCore::UI.message("Transporter is already installed at path: #{install_path.green}")
+        FastlaneCore::UI.message("Use 'overwrite:true' option to overwrite")
+        return
+      end
+
+      FileUtils.rm_rf(install_path)
+      FileUtils.mkdir_p(install_path)
+
+      if File.directory?(source)
+        FileUtils.cp_r(File.join(source, '.'), install_path)
+      else
+        tar_path = Helper::TransporterHelper.fetch_file(source)
+        result = Helper::TransporterHelper.extract_tarball(tar_path, install_path)
+        FastlaneCore::UI.user_error!("Failed to unpack tarball") unless result
+      end
+    end
+
+    # Add root CA to Transporter installation.
+    # @param install_path [String] Transporter install path.
+    # @param root_ca [String] Name or file path of Internal Root CA certificate to add to Transporter's Java certificate keystore.
+    def self.add_root_ca(
+      install_path: DEFAULT_TRANSPORTER_INSTALL_PATH,
+      root_ca:
+    )
+      check_install_path(install_path: install_path)
+
+      root_ca_file = Helper::TransporterHelper.find_root_ca(root_ca)
+      cert_alias = File.basename(root_ca_file)
+
+      cmd = [
+        "#{install_path}/java/bin/keytool",
+        "-list",
+        "-keystore #{install_path}/java/lib/security/cacerts",
+        "-storepass changeit",
+        "-alias #{cert_alias}"
+      ].join(" ")
+      cert_exists = system(cmd)
+      if cert_exists
+        FastlaneCore::UI.message("Transporter is already configured for this root CA.")
+        return
+      end
+
+      # Patch the transporter with internal root CA.
+      cmd = [
+        "#{install_path}/java/bin/keytool",
+        "-import",
+        "-trustcacerts",
+        "-alias #{cert_alias}",
+        "-file #{root_ca_file}",
+        "-keystore #{install_path}/java/lib/security/cacerts",
+        "-storepass changeit",
+        "-noprompt",
+        "-v"
+      ].join(" ")
+      system(cmd)
+
+      FastlaneCore::UI.success("Added root CA certificate to keystore")
+    end
+
+    # Enable basic authentication for Transporter installation.
+    # @param install_path [String] Transporter install path.
+    def self.enable_basic_auth(install_path: DEFAULT_TRANSPORTER_INSTALL_PATH)
+      check_install_path(install_path: install_path)
+      properties_file = "#{install_path}/java/lib/net.properties"
+      content = File.read(properties_file).gsub("=Basic", "")
+      File.open(properties_file, "w") { |f| f.puts(content) }
+      FastlaneCore::UI.success("Basic authentication is enabled")
+    end
+
+    # Update Fastlane's Transporter path environment variable.
+    # @param path [String] Transporter path.
+    def self.update_path(path: DEFAULT_TRANSPORTER_INSTALL_PATH)
+      check_install_path(install_path: path)
+      ENV["FASTLANE_ITUNES_TRANSPORTER_PATH"] = path
+    end
+
+    # Check if Transporter is installed at given path.
+    # @param install_path [String] Transporter install path.
+    def self.check_install_path(install_path:)
+      FastlaneCore::UI.user_error!("No Transporter installation found at path: #{install_path.red}") unless File.exist?(install_path)
+    end
+    private_class_method :check_install_path
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Transporter.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/transporter/actions/configure_transporter_action.rb

@@ -0,0 +1,58 @@
+require 'fastlane/action'
+require_relative '../helper/transporter_helper'
+require_relative '../../transporter'
+
+module Fastlane
+  module Actions
+    class ConfigureTransporterAction < Action
+      def self.run(params)
+        Transporter.add_root_ca(install_path: params[:install_path], root_ca: params[:root_ca]) if params[:root_ca]
+        Transporter.enable_basic_auth(install_path: params[:install_path]) if params[:enable_basic_auth]
+      end
+
+      def self.description
+        "Configure Apple iTMSTransporter installation"
+      end
+
+      def self.authors
+        ["Maksym Grebenets"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        [
+          "- Add self-signed root Certificate Authority certificate to Transporter keystore",
+          "- Enable basic authentication"
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :install_path,
+                                  env_name: "CONFIGURE_TRANSPORTER_INSTALL_PATH",
+                               description: "Transporter install path",
+                             default_value: Transporter::DEFAULT_TRANSPORTER_INSTALL_PATH,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :root_ca,
+                                  env_name: "CONFIGURE_TRANSPORTER_ROOT_CA",
+                               description: "Add specified root CA to Transporter's keystore",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :enable_basic_auth,
+                                  env_name: "CONFIGURE_TRANSPORTER_ENABLE_BASIC_AUTH",
+                               description: "Enable basic authentication in Transporter configuration",
+                             default_value: false,
+                                  optional: true,
+                                      type: Boolean)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/transporter/actions/install_transporter_action.rb

@@ -0,0 +1,56 @@
+require 'fastlane/action'
+require_relative '../helper/transporter_helper'
+require_relative '../../transporter'
+
+module Fastlane
+  module Actions
+    class InstallTransporterAction < Action
+      def self.run(params)
+        Transporter.install(
+          source: params[:source],
+          install_path: params[:install_path],
+          overwrite: params[:overwrite]
+        )
+      end
+
+      def self.description
+        "Install Apple iTMSTransporter"
+      end
+
+      def self.authors
+        ["Maksym Grebenets"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :source,
+                                  env_name: "INSTALL_TRANSPORTER_SOURCE",
+                               description: "A path or URI to Transporter tarball or directory",
+                             default_value: Transporter::DEFAULT_TRANSPORTER_SOURCE,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :install_path,
+                                  env_name: "INSTALL_TRANSPORTER_INSTALL_PATH",
+                               description: "Transporter install path",
+                             default_value: Transporter::DEFAULT_TRANSPORTER_INSTALL_PATH,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :overwrite,
+                                  env_name: "INSTALL_TRANSPORTER_OVERWRITE",
+                               description: "Overwrite existing installation",
+                             default_value: false,
+                                      type: Boolean)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/transporter/actions/update_transporter_path_action.rb

@@ -0,0 +1,44 @@
+require 'fastlane/action'
+require_relative '../helper/transporter_helper'
+require_relative '../../transporter'
+
+module Fastlane
+  module Actions
+    class UpdateTransporterPathAction < Action
+      def self.run(params)
+        Transporter.update_path(path: params[:path])
+      end
+
+      def self.description
+        "Configure Fastlane to use custom Transporter installation"
+      end
+
+      def self.authors
+        ["Maksym Grebenets"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "Sets the FASTLANE_ITUNES_TRANSPORTER_PATH environment variable"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :path,
+                                  env_name: "UPDATE_TRANSPORTER_PATH",
+                               description: "Transporter install path",
+                             default_value: Transporter::DEFAULT_TRANSPORTER_INSTALL_PATH,
+                                  optional: true,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/transporter/helper/transporter_helper.rb

@@ -0,0 +1,65 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class TransporterHelper
+      # class methods that you define here become available in your action
+      # as `Helper::TransporterHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the transporter plugin helper!")
+      end
+
+      # Check if shell command exists.
+      def self.command_exist?(cmd)
+        `which #{cmd} 2>/dev/null`.chomp != ""
+      end
+
+      # Check if string is a correct URI.
+      def self.uri?(string)
+        uri = URI.parse(string)
+        %w[http https file].include?(uri.scheme)
+      rescue URI::BadURIError
+        false
+      rescue URI::InvalidURIError
+        false
+      end
+
+      # Fetch file from URI or return path if it's local.
+      def self.fetch_file(path)
+        return path if path.nil? || !uri?(path)
+
+        UI.message("Downloading #{path}...")
+        target_path = Tempfile.new(File.basename(path)).path
+        cmd = "curl --progress-bar -L #{path.shellescape} -o #{target_path.shellescape}"
+        result = system(cmd) # Won't get progress showing if using Action.sh here.
+        FastlaneCore::UI.user_error!("Failed to fetch file: #{path}") unless result
+
+        File.expand_path(target_path)
+      end
+
+      # Find Root CA certificate with given name or path.
+      def self.find_root_ca(name)
+        expanded_name = File.expand_path(name)
+        return expanded_name if File.exist?(expanded_name)
+
+        root_ca_file = Tempfile.new("root_ca.pem").path
+        if FastlaneCore::Helper.is_mac?
+          result = system("security find-certificate -c #{name.shellescape} -p >#{root_ca_file}")
+          FastlaneCore::UI.user_error!("Could not find certificate: #{name}") unless result
+        else
+          FastlaneCore::UI.user_error!("Certificate lookup is not supported on OS other than Mac yet")
+        end
+
+        root_ca_file
+      end
+
+      def self.extract_tarball(tarball, destination)
+        warning_args = "--warning=no-unknown-keyword" unless FastlaneCore::Helper.is_mac?
+        system("tar #{warning_args} -xzf #{tarball} -C #{destination} --strip-components=1")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/transporter/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Transporter
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-transporter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Maksym Grebenets
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.121.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.121.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.56.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.56.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: mgrebenets@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/transporter.rb
+- lib/fastlane/plugin/transporter/actions/configure_transporter_action.rb
+- lib/fastlane/plugin/transporter/actions/install_transporter_action.rb
+- lib/fastlane/plugin/transporter/actions/update_transporter_path_action.rb
+- lib/fastlane/plugin/transporter/helper/transporter_helper.rb
+- lib/fastlane/plugin/transporter/version.rb
+homepage: https://github.com/mgrebenets/fastlane-plugin-transporter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Manage Apple iTMSTransporter installation
+test_files: []