fastlane-plugin-repack_ios 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 231bb054a4432cab544fb6325aa60b06dbe0fd67
+  data.tar.gz: d6ed18ebe8d990ec51c0d96cc9a956b81ce9ea72
+SHA512:
+  metadata.gz: 3f56acda3c50944b24fcea153ca4c451c11a0b945199808a74a89019503724d7fedc93d7cfa03973d574ea1ab3b7deb36ef9e892a6898962787a795d45ca911b
+  data.tar.gz: 14618a0c843e60bbe900528de952566a319f9718d48dac0d46490bbd73f841a92cbb1f0ea42bb39b5327737685110b1904fc8d290045d5c766a780e82d886ac2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Omer Duzyol <omer@duzyol.net>
+
+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,50 @@
+# repack_ios plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-repack_ios)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-repack_ios`, add it to your project by running:
+
+```bash
+fastlane add_plugin repack_ios
+```
+
+## About repack_ios
+
+This plugin allows you to repack your existing .ipa packages with new assets or non-executable resources without rebuilding the native code. It supports fastlane's *sigh* and *match* actions to automatically detect provisioning profiles and certificates for resigning the modified ipa package. Also internally uses Gym configuration arguments to detect build related parameters like output directory etc.
+
+You can use this plugin to modify your react-native js bundle without re-compiling the entire XCode project from the beginning. It significantly reduces the compilation time, especially useful for CI/CD based processes and also for your test automation.
+
+## 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.
+
+## 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).
+
+## License
+
+MIT © [omerduzyol](https://github.com/omerduzyol)

data/lib/fastlane/plugin/repack_ios.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/repack_ios/version'
+
+module Fastlane
+  module RepackIos
+    # 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
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::RepackIos.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/repack_ios/actions/repack_ios_action.rb

@@ -0,0 +1,207 @@
+require 'fastlane/action'
+require_relative '../helper/repack_ios_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      REPACK_IOS_IPA_ORIGINAL = :REPACK_IOS_IPA_ORIGINAL
+    end
+
+    class RepackIosAction < Action
+      def self.run(params)
+        UI.important("Repack iOS started! 📦")
+
+        UI.message("Parameter Contents Path: #{params[:contents]}")
+        UI.message("Parameter IPA Path: #{params[:ipa]}")
+
+        if params[:ipa].nil?
+          UI.important("Parameter ipa is empty, trying to resolve Gym configuration...")
+
+          Gym.config = FastlaneCore::Configuration.create(Gym::Options.available_options, {})
+
+          output_directory = Gym.config[:output_directory]
+          output_name = Gym.config[:output_name]
+
+          ipa_path = "#{File.join(output_directory, output_name)}.ipa"
+
+          UI.important("Parameter ipa resolved as '#{ipa_path}'")
+
+          UI.user_error!("Resolved ipa file: #{File.expand_path(ipa_path)} is not exists. Please provide ipa path.") unless File.exist?(ipa_path)
+        else
+          ipa_path = params[:ipa]
+        end
+
+        ipa_original_path = Helper::RepackIosHelper.unpack_and_repack(output_name, ipa_path, params[:contents])
+
+        UI.message("Preparing to sign the new package")
+
+        sigh_profile_type = Actions.lane_context[SharedValues::SIGH_PROFILE_TYPE]
+
+        unless sigh_profile_type.nil?
+          UI.important("Match type parameters obtained from sigh profile context!")
+          params[:match_type] = sigh_profile_type.sub!('-', '')
+        end
+
+        # check match_type is passed?
+        if !params[:match_type].nil?
+          match_type = params[:match_type]
+
+          UI.message("Parameter Match Type: #{params[:match_type]}")
+
+          provisioning_profile_key = "sigh_#{params[:app_identifier]}_#{match_type}_profile-path"
+          # check if match has been executed before for the given app_identifier?
+          if ENV[provisioning_profile_key].nil?
+
+            UI.message("Trying to match certificates with given type...")
+
+            other_action.match(
+              type: match_type,
+              readonly: true
+            )
+          end
+
+          # read the provisioning_profile from sigh
+          provisioning_profile = ENV[provisioning_profile_key]
+
+        # otherwise, check provisioning_profile is not passed?
+        elsif !params[:provisioning_profile].nil?
+          UI.message("Parameter Provisioning Profile: #{params[:provisioning_profile]}")
+        end
+
+        UI.message("Resolving signing identity from provisioning profile...")
+
+        signing_identity = Helper::RepackIosHelper.get_signing_identity_from_provision_profile(provisioning_profile)
+
+        use_app_entitlements = params[:entitlements].nil?
+
+        other_action.resign(
+          ipa: File.expand_path(ipa_path),
+          signing_identity: signing_identity,
+          provisioning_profile: provisioning_profile,
+          use_app_entitlements: use_app_entitlements,
+          entitlements: params[:entitlements],
+          version: params[:version],
+          display_name: params[:display_name],
+          short_version: params[:short_version],
+          bundle_version: params[:bundle_version],
+          bundle_id: params[:bundle_id]
+        )
+
+        UI.important("iOS Repack completed! 📦 Original ipa can be found at '#{File.expand_path(ipa_original_path)}'")
+        Actions.lane_context[SharedValues::REPACK_IOS_IPA_ORIGINAL] = File.expand_path(ipa_original_path)
+      end
+
+      def self.description
+        "Enables your build pipeline to repack your pre-built ipa with new assets without rebuilding the native code."
+      end
+
+      def self.authors
+        ["Omer Duzyol", "Creaworks Labs"]
+      end
+
+      def self.output
+        [
+          ['REPACK_IOS_IPA_ORIGINAL', 'Contains the new path name for the original ipa file']
+        ]
+      end
+
+      def self.details
+        "This plugin allows you to repack your existing .ipa packages with new assets or non-executable resources without rebuilding the native code. It supports fastlane's sigh and match actions to automatically detect provisioning profiles and certificates for resigning the modified ipa package."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                     short_option: "-a",
+                                     env_name: "FL_REPACK_IOS_APP_IDENTIFIER",
+                                     description: "The bundle identifier of your app",
+                                     optional: true,
+                                     code_gen_sensitive: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier),
+                                     default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                      short_option: "-i",
+                                      optional: true,
+                                      env_name: "FL_REPACK_IOS_IPA",
+                                      description: "Path to your original ipa file to modify",
+                                      code_gen_sensitive: true,
+                                      default_value: Dir["*.ipa"].sort_by { |x| File.mtime(x) }.last,
+                                      default_value_dynamic: true,
+                                      verify_block: proc do |value|
+                                        UI.user_error!("Could not find ipa file at path '#{File.expand_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: :entitlements,
+                                      env_name: "FL_REPACK_IOS_ENTITLEMENTS",
+                                      description: "Path to the entitlement file to use, e.g. `myApp/MyApp.entitlements`",
+                                      is_string: true,
+                                      optional: true),
+          FastlaneCore::ConfigItem.new(key: :display_name,
+                                      env_name: "FL_REPACK_IOS_NAME",
+                                      description: "Display name to force resigned ipa to use",
+                                      is_string: true,
+                                      optional: true),
+          FastlaneCore::ConfigItem.new(key: :version,
+                                      env_name: "FL_REPACK_IOS_VERSION",
+                                      description: "Version number to force resigned ipa to use. Updates both `CFBundleShortVersionString` and `CFBundleVersion` values in `Info.plist`. Applies for main app and all nested apps or extensions",
+                                      conflicting_options: [:short_version, :bundle_version],
+                                      is_string: true,
+                                      optional: true),
+          FastlaneCore::ConfigItem.new(key: :short_version,
+                                      env_name: "FL_REPACK_IOS_SHORT_VERSION",
+                                      description: "Short version string to force resigned ipa to use (`CFBundleShortVersionString`)",
+                                      conflicting_options: [:version],
+                                      is_string: true,
+                                      optional: true),
+          FastlaneCore::ConfigItem.new(key: :bundle_version,
+                                      env_name: "FL_REPACK_IOS_BUNDLE_VERSION",
+                                      description: "Bundle version to force resigned ipa to use (`CFBundleVersion`)",
+                                      conflicting_options: [:version],
+                                      is_string: true,
+                                      optional: true),
+          FastlaneCore::ConfigItem.new(key: :bundle_id,
+                                      env_name: "FL_REPACK_IOS_BUNDLE_ID",
+                                      description: "Set new bundle ID during resign (`CFBundleIdentifier`)",
+                                      is_string: true,
+                                      optional: true),
+          FastlaneCore::ConfigItem.new(key: :match_type,
+                                      env_name: "FL_REPACK_IOS_MATCH_TYPE",
+                                      description: "Define the profile type, can be #{Match.environments.join(', ')} . Optional if you use _sigh_ or _match_",
+                                      is_string: true,
+                                      short_option: "-y",
+                                      verify_block: proc do |value|
+                                        unless Match.environments.include?(value)
+                                          UI.user_error!("Unsupported environment #{value}, must be in #{Match.environments.join(', ')}")
+                                        end
+                                      end),
+          FastlaneCore::ConfigItem.new(key: :provisioning_profile,
+                                      env_name: "FL_REPACK_IOS_PROVISIONING_PROFILE",
+                                      description: "Path to your provisioning_profile. Optional if you use _sigh_ or _match_",
+                                      default_value: Actions.lane_context[SharedValues::SIGH_PROFILE_PATH],
+                                      default_value_dynamic: true,
+                                      is_string: false,
+                                      verify_block: proc do |value|
+                                        files = case value
+                                                when Hash then value.values
+                                                when Enumerable then value
+                                                else [value]
+                                                end
+                                        files.each do |file|
+                                          UI.user_error!("Couldn't find provisiong profile at path '#{file}'") unless File.exist?(file)
+                                        end
+                                      end),
+          FastlaneCore::ConfigItem.new(key: :contents,
+                                      env_name: "FL_REPACK_IOS_CONTENTS", # The name of the environment variable
+                                      description: "Path for the new contents", # a short description of this parameter
+                                      verify_block: proc do |value|
+                                        UI.user_error!("No path argument found for the new contents, pass using `contents: 'path-to-new-contents-folder'`") unless value && !value.empty?
+                                      end)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/repack_ios/helper/repack_ios_helper.rb

@@ -0,0 +1,109 @@
+require 'fastlane_core/ui/ui'
+require 'zip'
+require 'fileutils'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class ZipFileGenerator
+      # Initialize with the directory to zip and the location of the output archive.
+      def initialize(input_dir, output_file)
+        @input_dir = input_dir
+        @output_file = output_file
+      end
+
+      # Zip the input directory.
+      def write
+        entries = Dir.entries(@input_dir) - %w[. ..]
+
+        ::Zip::File.open(@output_file, ::Zip::File::CREATE) do |zipfile|
+          write_entries(entries, '', zipfile)
+        end
+      end
+
+      private
+
+      # A helper method to make the recursion work.
+      def write_entries(entries, path, zipfile)
+        entries.each do |e|
+          zipfile_path = path == '' ? e : File.join(path, e)
+          disk_file_path = File.join(@input_dir, zipfile_path)
+
+          if File.directory?(disk_file_path)
+            recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
+          else
+            put_into_archive(disk_file_path, zipfile, zipfile_path)
+          end
+        end
+      end
+
+      def recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
+        zipfile.mkdir(zipfile_path)
+        subdir = Dir.entries(disk_file_path) - %w[. ..]
+        write_entries(subdir, zipfile_path, zipfile)
+      end
+
+      def put_into_archive(disk_file_path, zipfile, zipfile_path)
+        zipfile.add(zipfile_path, disk_file_path)
+      end
+    end
+
+    class RepackIosHelper
+      def self.get_signing_identity_from_provision_profile(provisioning_profile)
+        parsed_provision = FastlaneCore::ProvisioningProfile.parse(provisioning_profile)
+
+        cert = OpenSSL::X509::Certificate.new(parsed_provision["DeveloperCertificates"].first.string)
+
+        cert_info = cert.subject.to_s.gsub(/\s*subject=\s*/, "").tr("/", "\n")
+        out_array = cert_info.split("\n")
+
+        cert_info_map = out_array.each_with_object({}) do |str, h|
+          k, v = str.split("=")
+          h[k] = v
+        end
+
+        return cert_info_map['CN']
+      end
+
+      def self.patch_ipa_contents(src, dest, preserve = false, dereference_root = false)
+        FileUtils::Entry_.new(src, nil, dereference_root).wrap_traverse(proc do |ent|
+          destent = FileUtils::Entry_.new(dest, ent.rel, false)
+
+          UI.important("Overriding file #{destent.path.sub!(File.dirname(dest), '<NEW-IPA>')}") unless !ent.file? || !File.exist?(destent.path)
+          ent.copy(destent.path)
+        end, proc do |ent|
+          destent = FileUtils::Entry_.new(dest, ent.rel, false)
+          ent.copy_metadata(destent.path) if preserve
+        end)
+      end
+
+      def self.unpack_and_repack(output_name, ipa_path, contents)
+        ipa_original_path = File.join(File.dirname(ipa_path), "#{File.basename(ipa_path, '.ipa')}-original-#{Time.now.to_i}.ipa")
+        ipa_tmp_path = Dir.mktmpdir
+        begin
+          UI.message("Unpacking the ipa package...")
+          Zip::File.open(ipa_path) do |zipfile|
+            zipfile.each do |entry|
+              extraction_path = File.join(ipa_tmp_path, entry.name)
+              zipfile.extract(entry, extraction_path)
+            end
+          end
+
+          ipa_new_payload_path = "#{ipa_tmp_path}/Payload/#{output_name}.app/"
+
+          UI.message("Re-generating the ipa package with new contents...")
+          patch_ipa_contents(contents, ipa_new_payload_path, true)
+
+          UI.message("Backing-up the original ipa package...")
+          File.rename(ipa_path, ipa_original_path)
+
+          ZipFileGenerator.new(ipa_tmp_path, ipa_path).write
+        ensure
+          FileUtils.rm_rf(ipa_tmp_path)
+        end
+        return ipa_original_path
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module RepackIos
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-repack_ios
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Omer Duzyol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: 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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.120.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.120.0
+description: 
+email: omer@duzyol.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/repack_ios.rb
+- lib/fastlane/plugin/repack_ios/actions/repack_ios_action.rb
+- lib/fastlane/plugin/repack_ios/helper/repack_ios_helper.rb
+- lib/fastlane/plugin/repack_ios/version.rb
+homepage: https://github.com/creaworks-labs/fastlane-plugin-repack-ios
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Enables your build pipeline to repack your pre-built ipa with new assets
+  without rebuilding the native code.
+test_files: []