fastlane-plugin-store_sizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac17078c20fbdb0299b160391ef7701138872932
+  data.tar.gz: 43390fda5a935830cd1aa8285438ab2af7a702d7
+SHA512:
+  metadata.gz: 4ca50f777806a64f2a180497a67c13150b2176787ffea51c340766faa1e88200fdcd0aa48bf57a80663e32fedf8f80e60104bd7145a60cb7ea3dd6c91a797619
+  data.tar.gz: c1bda9fefb87598c8ce702c6acdd5506753c6d76492d7b3811a0463653ad7085b4e8879bd1e19685fb5e167a847f4b0d44075c43e89bd59e3010e9edf83d1c79

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Marcelo Oliveira <capyvara@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,75 @@
+# store_sizer plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-store_sizer)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-store_sizer`, add it to your project by running:
+
+```bash
+fastlane add_plugin store_sizer
+```
+
+## About store_sizer
+
+Estimates download and install sizes for your app, optionally checks and raise an error if the size exceeds given thresholds.
+
+Some apps, specially games, struggle to keep their download sizes below the **100Mb** limit, due to carrier network download limits on iOS, however the way people usually get around it is to send the build to iTunesConnect and later check the sizes reported by Apple.
+
+It works by **simulating the Apple encryption** of the app executable (random bytes are written to the TEXT segments of the executable file), plus some artificially added files, followed by an ad-hoc export of the archive with the exportOptionsPlist thinning set to _thin-for-all-variants_
+
+Also check for Apple's [executable size constaints](https://developer.apple.com/library/content/documentation/LanguagesUtilities/Conceptual/iTunesConnect_Guide/Chapters/SubmittingTheApp.html)
+
+Requires the Xcode _.xcarchive_, currently only **iOS** is supported.
+
+### Actions
+#### `store_size_xcarchive`
+Simulates encryption and returns a hash containing the reported size for all variants plus some info about the executable.
+
+Parameters:
+- `archive_path`: path to your .xcarchive
+
+#### `store_size_xcarchive_check`
+Checks executable size constraints and max download size, raise an error if exceeded.
+
+Parameters:
+- `report`: hash reported by the `store_size_xcarchive` action
+- `ignore_universal`: should the universal variant be ignored? true per default (only devices <= iOS 8 uses the universal variant)
+- `max_wifi_size`: overrides default 100Mb size check, pass 0 to disable wi-fi download size check
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin.
+
+Unfortunately an example _.xcarchive_ can't be supplied since it will require distributing a signed executable, you will need to use your own.
+
+Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test archive_path:YourArchive.xcarchive`.
+
+## 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).

data/lib/fastlane/plugin/store_sizer.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/store_sizer/version'
+
+module Fastlane
+  module StoreSizer
+    # 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::StoreSizer.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/store_sizer/actions/store_size_xcarchive_action.rb

@@ -0,0 +1,102 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      SIZE_REPORT = :SIZE_REPORT
+    end
+
+    class StoreSizeXcarchiveAction < Action
+      EXTRA_FILE_SIZE = 2_000_000
+
+      def self.run(params)
+        require 'plist'
+
+        unless Fastlane::Helper.test?
+          UI.user_error!("xcodebuild not installed") if `which xcodebuild`.length == 0
+        end
+
+        archive_path = params[:archive_path] || Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE]
+        app_path = Dir.glob(File.join(archive_path, "Products", "Applications", "*.app")).first
+        UI.user_error!("No applications found in archive") if app_path.nil?
+
+        binary_name = File.basename(app_path, ".app")
+        binary_path = File.join(app_path, binary_name)
+        extra_file_path = File.join(app_path, "extradata_simulated")
+        result = {}
+
+        Dir.mktmpdir do |tmp_path|
+          binary_backup_path = File.join(tmp_path, binary_name)
+          export_path = File.join(tmp_path, "Export")
+          begin
+            FileUtils.mv(binary_path, binary_backup_path)
+            FileUtils.cp(binary_backup_path, binary_path)
+
+            macho_info = Helper::MachoInfo.new(binary_path)
+
+            Helper::StoreSizerHelper.write_random_segments(binary_path, macho_info.encryption_segments)
+            Helper::StoreSizerHelper.write_random_file(extra_file_path, EXTRA_FILE_SIZE)
+
+            export_options = {}
+            export_options[:method] = 'ad-hoc'
+            export_options[:thinning] = '<thin-for-all-variants>'
+            export_options_plist_path = File.join(tmp_path, "ExportOptions.plist")
+            File.write(export_options_plist_path, Plist::Emit.dump(export_options, false))
+
+            UI.message("Exporting all variants of #{archive_path} for estimation...")
+            Helper::StoreSizerHelper.xcode_export_package(archive_path, export_options_plist_path, export_path)
+
+            UI.verbose(File.read(File.join(export_path, "App Thinning Size Report.txt")))
+
+            result = Plist.parse_xml(File.join(export_path, "app-thinning.plist"))
+            result.merge!(macho_info.sizes_info)
+          ensure
+            FileUtils.rm_f(binary_path)
+            FileUtils.mv(binary_backup_path, binary_path)
+            FileUtils.rm_f(extra_file_path)
+          end
+        end
+
+        Actions.lane_context[SharedValues::SIZE_REPORT] = result
+        result
+      end
+
+      def self.description
+        "Estimates download and install sizes for your app"
+      end
+
+      def self.authors
+        ["Marcelo Oliveira"]
+      end
+
+      def self.output
+        [
+          ['SIZE_REPORT', 'The generated size report hash']
+        ]
+      end
+
+      def self.return_value
+        "Hash containing App Thinning report"
+      end
+
+      def self.details
+        "Compute estimated size of the .ipa after encryption and App Thinning for all variants"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :archive_path,
+                                       description: 'Path to your xcarchive file. Optional if you use the `xcodebuild` action',
+                                       default_value: Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE],
+                                       optional: true,
+                                       env_name: 'STORE_SIZE_ARCHIVE_PATH',
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find xcarchive file at path '#{value}'") if !Helper.test? && !File.exist?(value)
+                                       end)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/store_sizer/actions/store_size_xcarchive_check_action.rb

@@ -0,0 +1,90 @@
+module Fastlane
+  module Actions
+    class StoreSizeXcarchiveCheckAction < Action
+      # Apple sizes reference http://goo.gl/6A3nQK
+      MAX_TEXT_6_LESS = 80_000_000
+      MAX_SEGMENT_7_TO_8 = 60_000_000
+      MAX_TEXT_9_PLUS = 500_000_000
+      DEFAULT_MAX_WIFI_SIZE = 100_000_000
+
+      def self.run(params)
+        report = params[:report]
+
+        errors = 0
+        error = proc do |message|
+          errors += 1
+          UI.error(message)
+        end
+
+        unless report["min_os_version"].nil?
+          major_version = report["min_os_version"][0]
+          text_size = report["text_segments_size"]
+          max_slice_size = report["text_max_slice_size"]
+          error.call("__TEXT segments size #{text_size} greater than #{MAX_TEXT_6_LESS}") if major_version <= 6 && text_size > MAX_TEXT_6_LESS
+          error.call("__TEXT #{max_slice_size} greater than #{MAX_SEGMENT_7_TO_8}") if major_version.between?(7, 8) && max_slice_size > MAX_SEGMENT_7_TO_8
+          error.call("__TEXT segments size #{text_size} greater than #{MAX_TEXT_9_PLUS}") if major_version >= 9 && text_size > MAX_TEXT_9_PLUS
+        end
+
+        max_wifi_size = params[:max_wifi_size] || DEFAULT_MAX_WIFI_SIZE
+
+        if max_wifi_size > 0 && !report["variants"].nil?
+          report["variants"].each do |name, variant|
+            next if variant["variantIds"].nil? && params[:ignore_universal]
+
+            size = variant["sizeCompressedApp"]
+            error.call("Variant #{name} size #{size} greater than #{max_wifi_size}") if size > max_wifi_size
+          end
+        end
+
+        UI.test_failure!("Size check failed, #{errors} sizes exceeded the limits") if errors > 0
+
+        UI.success("App size check suceeded")
+      end
+
+      def self.description
+        "Checks if the size report fits the requirements"
+      end
+
+      def self.authors
+        ["Marcelo Oliveira"]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+        "Checks estimated size for all non-universal variants and maximum executable sizes"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :report,
+                                       description: 'Generated report. Optional if you use the `store_size_xcarchive` action',
+                                       default_value: Actions.lane_context[SharedValues::SIZE_REPORT],
+                                       type: Hash,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Invalid report!'") if !Helper.test? && value["variants"].nil?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ignore_universal,
+                                       description: 'True to ignore universal variant',
+                                       default_value: true,
+                                       is_string: false,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :max_wifi_size,
+                                       description: 'Max Wi-Fi download size, pass 0 to ignore',
+                                       default_value: DEFAULT_MAX_WIFI_SIZE,
+                                       type: Integer,
+                                       optional: true)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/store_sizer/helper/macho_info.rb

@@ -0,0 +1,52 @@
+require 'macho'
+
+module Fastlane
+  module Helper
+    class MachoInfo
+      attr_accessor :min_os_versions
+      attr_accessor :encryption_segments
+      attr_accessor :text_segment_sizes
+
+      def initialize(binary_path)
+        self.min_os_versions = []
+        self.encryption_segments = []
+        self.text_segment_sizes = []
+
+        file = MachO.open(binary_path)
+        if file.kind_of?(MachO::FatFile)
+          file.fat_archs.each_index do |arch_index|
+            macho_add(file.machos[arch_index], file.fat_archs[arch_index].offset)
+          end
+        elsif file.kind_of?(MachO::MachOFile)
+          macho_add(file, 0)
+        end
+      end
+
+      def self.split_version(version)
+        binary = format("%032b", version)
+        return [
+          binary[0..15], binary[16..23], binary[24..31]
+        ].map { |s| s.to_i(2) }
+      end
+
+      def sizes_info
+        result = {}
+        result["min_os_version"] = self.min_os_versions.first
+        result["text_segments_size"] = self.text_segment_sizes.flatten.reduce(0, :+)
+        result["text_max_slice_size"] = self.text_segment_sizes.flatten.max
+        result
+      end
+
+      def macho_add(macho, file_offset)
+        encryption_info = (macho.magic32? ? macho[:LC_ENCRYPTION_INFO] : macho[:LC_ENCRYPTION_INFO_64]).first
+        self.encryption_segments.push([file_offset + encryption_info.cryptoff, encryption_info.cryptsize]) unless encryption_info.nil?
+
+        min_version_info = macho[:LC_VERSION_MIN_IPHONEOS].first
+        self.min_os_versions.push(MachoInfo.split_version(min_version_info.version)) unless min_version_info.nil?
+
+        text_segments = macho.segments.select { |seg| seg.segname == "__TEXT" }
+        self.text_segment_sizes.push(text_segments.map(&:filesize)) unless text_segments.nil?
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/store_sizer/helper/store_sizer_helper.rb

@@ -0,0 +1,27 @@
+module Fastlane
+  module Helper
+    class StoreSizerHelper
+      def self.write_random_segments(file_path, segments)
+        File.open(file_path, "rb+") do |file|
+          segments.each do |segment|
+            file.pos = segment[0]
+            file.puts(SecureRandom.random_bytes(segment[1]))
+          end
+        end
+      end
+
+      def self.write_random_file(path, size)
+        IO.binwrite(path, SecureRandom.random_bytes(size))
+      end
+
+      def self.xcode_export_package(archive_path, export_options_plist_path, export_path)
+        command = "xcodebuild"
+        command << " -exportArchive"
+        command << " -exportOptionsPlist #{export_options_plist_path}"
+        command << " -archivePath #{archive_path}"
+        command << " -exportPath #{export_path}"
+        FastlaneCore::CommandExecutor.execute(command: command, print_command: false, print_all: false)
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-store_sizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Oliveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-29 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+  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.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.40.0
+- !ruby/object:Gem::Dependency
+  name: ruby-macho
+  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: plist
+  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: capyvara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/store_sizer.rb
+- lib/fastlane/plugin/store_sizer/actions/store_size_xcarchive_action.rb
+- lib/fastlane/plugin/store_sizer/actions/store_size_xcarchive_check_action.rb
+- lib/fastlane/plugin/store_sizer/helper/macho_info.rb
+- lib/fastlane/plugin/store_sizer/helper/store_sizer_helper.rb
+- lib/fastlane/plugin/store_sizer/version.rb
+homepage: https://github.com/capyvara/fastlane-plugin-store_sizer
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Estimates download and install sizes for your app
+test_files: []
+has_rdoc: