fastlane-plugin-bundletool 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a1ce147b19920327f7ca4a32519214316955aa906469ec9eb2edb5f249e9f72
-  data.tar.gz: abb7030269fda53b86f532da8a137a5fafc593c69be5fbb164f01157c5b5e36d
+  metadata.gz: 7fb3b3676492fd3f6a4bfc64426a28937f6c92bf98024ccacf761169d2443383
+  data.tar.gz: 861566dc3312e4cfe2199f773f0ae10a33a8e43bb096d5a0a0b194595d97c427
 SHA512:
-  metadata.gz: 0f6c1a75aa421ef5184da894a6ebdf2a15824698479b90927f86188d8953ddccaa55fcdd62276c18258a4f9beb6d9c4110335e69ecfc9711f693ac851f579d1d
-  data.tar.gz: eadcb068dd75527b1eb35ac1683c43e029d824a859202cff77d8a7de901b516b94243722e34f543cb8714822ae0a7ec9af5679efe6156d64be7f4bed759ba2c4
+  metadata.gz: 7b51d6b7495b427fb35c3c6f8c429299da981d7eae09847577af154735cde54d99ea1dda1e5eb3d4c12a0cbf27fabeaede25299a62696778ecdaa2fc52cf20dc
+  data.tar.gz: a06d8c3ab1aaf481295abe63a31c2afaa9fcdfce0eef51de05f8c5a246502883660ebd47a02d84ec418d488b96852d3cd1e5fca4f8ac023fcbcc279f2106ff56

data/README.md

@@ -13,7 +13,7 @@ fastlane add_plugin bundletool
 or in your Pluginfile under fastlane folder write the following line and run `bundle install`.
 
 ```
-gem 'fastlane-plugin-bundletool', '1.0.6'
+gem 'fastlane-plugin-bundletool', '1.0.8'
 ```
 
 ## About bundletool
@@ -37,12 +37,31 @@ bundletool(
   bundletool_version: '1.10.0', # For searching a specific version of bundletool visit https://github.com/google/bundletool/releases
   aab_path: aab_path,
   apk_output_path: apk_output_path,
-  verbose: true
+  verbose: true,
+  cache_path: cache_path
 )
 ```
 
 This will output the universal `.apk` in the output path you set.
 
+## Options
+
+| Key                   | Description                                             | Env Var(s)                      | Default |
+|-----------------------|---------------------------------------------------------|---------------------------------|---------|
+| ks_path               | Path to .jks file                                       | FL_BUNDLETOOL_KEYSTORE_FILE     |         |
+| ks_password           | .jks password                                           | FL_BUNDLETOOL_KEYSTORE_PASSWORD |         |
+| ks_key_alias          | Alias for jks                                           | FL_BUNDLETOOL_KEY_ALIAS         |         |
+| ks_key_alias_password | Alias password for .jks                                 | FL_BUNDLETOOL_KEY_PASSWORD      |         |
+| bundletool_version    | Version of bundletool to use, by default 0.11.0 will    | FL_BUNDLETOOL_VERSION           | 0.11.0  |
+|                       | be used                                                 |                                 |         |
+| download_url          | Url to download bundletool from, should point to a jar  | FL_BUNDLETOOL_DOWNLOAD_URL      |         |
+|                       | file                                                    |                                 |         |
+| aab_path              | Path where the aab file is                              | FL_BUNDLETOOL_AAB_PATH          |         |
+| apk_output_path       | Path where the apk file is going to be placed           | FL_BUNDLETOOL_APK_OUTPUT_PATH   | .       |
+| verbose               | Show every messages of the action                       | FL_BUNDLETOOL_VERBOSE           | false   |
+| cache_path            | Cache downloaded bundletool binary into the cache path  | FL_BUNDLETOOL_CACHE_PATH        |         |
+|-----------------------|---------------------------------------------------------|---------------------------------|---------|
+
 ## Use case
 
 Here you can find a post I did explaining why I have to create this action.

data/lib/fastlane/plugin/bundletool/actions/bundletool_action.rb

@@ -23,12 +23,33 @@ module Fastlane
         download_url = params[:download_url]
         aab_path = params[:aab_path]
         output_path = params[:apk_output_path] || '.'
+        cache_path = params[:cache_path]
 
         return unless validate_aab!(aab_path)
 
-        return unless download_bundletool(bundletool_version, download_url)
+        if(cache_path.nil?)
+          installation_path = @bundletool_temp_path
+        else
+          installation_path = Pathname.new(File.expand_path(cache_path)).to_s          
+        end
+
+        unless(Dir.exist?(installation_path))
+          Dir.mkdir(installation_path)
+        end
+
+        unless(Dir.exist?(@bundletool_temp_path))
+          Dir.mkdir(@bundletool_temp_path)
+        end
 
-        extract_universal_apk_from(aab_path, output_path, keystore_info)
+        unless download_url.nil?
+          bundletool_filename = "bundletool_#{id = Digest::SHA256.hexdigest(download_url)}.jar"
+        else
+          bundletool_filename = "bundletool_#{bundletool_version}.jar"
+        end
+
+        return unless download_bundletool(bundletool_version, download_url, bundletool_filename, installation_path)
+
+        extract_universal_apk_from(aab_path, output_path, keystore_info, bundletool_filename, installation_path)
       end
 
       def self.validate_aab!(aab_path)
@@ -41,29 +62,24 @@ module Fastlane
         return true
       end
 
-      def self.download_bundletool(version, download_url)
-        Dir.mkdir "#{@project_root}/bundletool_temp"
-
+      def self.download_bundletool(version, download_url, bundletool_filename, cache_path)              
         unless download_url.nil?          
-          puts "Downloading bundletool from #{download_url}"
-          puts_message("Downloading bundletool from #{download_url}")
-          download_and_write_bundletool(download_url)
+          download_and_write_bundletool(download_url, bundletool_filename, cache_path)
         else
-          puts_message("Downloading bundletool (#{version}) from https://github.com/google/bundletool/releases/download/#{version}/bundletool-all-#{version}.jar...")
-          download_and_write_bundletool("https://github.com/google/bundletool/releases/download/#{version}/bundletool-all-#{version}.jar")
-        end
-        puts_success('Downloaded bundletool')
-        true
+          bundletool_url = "https://github.com/google/bundletool/releases/download/#{version}/bundletool-all-#{version}.jar"
+          download_and_write_bundletool(bundletool_url, bundletool_filename, cache_path)
+        end        
+        return true
       rescue OpenURI::HTTPError => e
         clean_temp!
         puts_error!("Something went wrong when downloading bundletool version #{version}" + ". \nError message\n #{e.message}")
-        false
+        return false
       end      
 
-      def self.extract_universal_apk_from(aab_path, apk_output_path, keystore_info)
+      def self.extract_universal_apk_from(aab_path, apk_output_path, keystore_info, bundletool_filename, installation_path)
         aab_absolute_path = Pathname.new(File.expand_path(aab_path)).to_s
         apk_output_absolute_path = Pathname.new(File.expand_path(apk_output_path)).to_s
-        output_path = run_bundletool!(aab_absolute_path, keystore_info)
+        output_path = run_bundletool!(aab_absolute_path, keystore_info, bundletool_filename, installation_path)
         prepare_apk!(output_path, apk_output_absolute_path)
       rescue StandardError => e
         puts_error!("Bundletool could not extract universal apk from aab at #{aab_absolute_path}. \nError message\n #{e.message}")
@@ -71,7 +87,7 @@ module Fastlane
         clean_temp!
       end
 
-      def self.run_bundletool!(aab_path, keystore_info)
+      def self.run_bundletool!(aab_path, keystore_info, bundletool_filename, installation_path)
         puts_message("Extracting apk from #{aab_path}...")
         output_path = "#{@bundletool_temp_path}/output.apks"
         keystore_params = ''
@@ -80,7 +96,7 @@ module Fastlane
           keystore_params = "--ks='#{keystore_info[:keystore_path]}' --ks-pass='pass:#{keystore_info[:keystore_password]}' --ks-key-alias='#{keystore_info[:alias]}' --key-pass='pass:#{keystore_info[:alias_password]}'"
         end
 
-        cmd = "java -jar #{@bundletool_temp_path}/bundletool.jar build-apks --bundle=\"#{aab_path}\" --output=\"#{output_path}\" --mode=universal #{keystore_params}"
+        cmd = "java -jar #{installation_path}/#{bundletool_filename} build-apks --bundle=\"#{aab_path}\" --output=\"#{output_path}\" --mode=universal #{keystore_params}"
 
         Open3.popen3(cmd) do |_, _, stderr, wait_thr|
           exit_status = wait_thr.value
@@ -142,30 +158,37 @@ module Fastlane
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :ks_path,
+                                       env_name: 'FL_BUNDLETOOL_KEYSTORE_FILE',
                                        description: 'Path to .jks file',
                                        is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :ks_password,
+                                       env_name: 'FL_BUNDLETOOL_KEYSTORE_PASSWORD',
                                        description: '.jks password',
                                        is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :ks_key_alias,
+                                       env_name: 'FL_BUNDLETOOL_KEY_ALIAS',
                                        description: 'Alias for jks',
                                        is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :ks_key_alias_password,
+                                       env_name: 'FL_BUNDLETOOL_KEY_PASSWORD',
                                        description: 'Alias password for .jks',
                                        is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :bundletool_version,
+                                       env_name: 'FL_BUNDLETOOL_VERSION',
                                        description: 'Version of bundletool to use, by default 0.11.0 will be used',
                                        is_string: true,
                                        default_value: '0.11.0'),
           FastlaneCore::ConfigItem.new(key: :download_url,
+                                       env_name: 'FL_BUNDLETOOL_DOWNLOAD_URL',
                                        description: 'Url to download bundletool from, should point to a jar file',
                                        is_string: true,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :aab_path,
+                                       env_name: 'FL_BUNDLETOOL_AAB_PATH',
                                        description: 'Path where the aab file is',
                                        is_string: true,
                                        optional: false,
@@ -175,17 +198,23 @@ module Fastlane
                                          end
                                        end),
           FastlaneCore::ConfigItem.new(key: :apk_output_path,
+                                       env_name: 'FL_BUNDLETOOL_APK_OUTPUT_PATH',
                                        description: 'Path where the apk file is going to be placed',
                                        is_string: true,
                                        optional: true,
                                        default_value: '.'),
           FastlaneCore::ConfigItem.new(key: :verbose,
+                                       env_name: 'FL_BUNDLETOOL_VERBOSE',
                                        description: 'Show every messages of the action',
                                        is_string: false,
                                        type: Boolean,
                                        optional: true,
-                                       default_value: false)
-
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :cache_path,
+                                       env_name: 'FL_BUNDLETOOL_CACHE_PATH',
+                                       description: 'Cache downloaded bundletool binary into the cache path specified',
+                                       is_string: true,
+                                       optional: true)
         ]
       end
 
@@ -214,12 +243,21 @@ module Fastlane
 
       private
 
-      def self.download_and_write_bundletool(download_url)
+      def self.download_and_write_bundletool(download_url, bundletool_filename, installation_path)
+        if(File.exist?"#{installation_path}/#{bundletool_filename}")
+          puts_message("Using binary cached at #{installation_path}/#{bundletool_filename}")
+          return
+        end
+
+        puts_message("Downloading bundletool from #{download_url}")
+
         URI.open(download_url) do |bundletool|
-          File.open("#{@bundletool_temp_path}/bundletool.jar", 'wb') do |file|
+          File.open("#{installation_path}/#{bundletool_filename}", 'wb') do |file|
             file.write(bundletool.read)
           end
         end
+
+        puts_success('Downloaded bundletool')
       end
     end
   end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Bundletool
-    VERSION = "1.0.7"
+    VERSION = "1.0.9"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-bundletool
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.9
 platform: ruby
 authors:
 - Martin Gonzalez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry