fastlane-plugin-bundletool 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 163f2ddba8e6f8c3aba41b8310aa832d672dd3b93131b1aa3f7accb588721978
+  data.tar.gz: a6cd88f56cea3a410019d6d79f9e437d5d0c92ecbcae556adf506dc1dcfaf693
+SHA512:
+  metadata.gz: c178cd9227ccd548eb83502e68e1283655e288a59d2a5c9ee64bba0b1303d3b48991643b92c4dc51d40d916fca3d078e3c838111cc3cee3a5f7ecfcf86584948
+  data.tar.gz: 533afee2b9cc30b48e5c57585a68845ee646c11b9b75b6e6d712b5b09b917b51810ce30661bd6691b070fd250c76054388c4e00b14d16e826ab7704821e33a49

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Martin Gonzalez <martin.gonzalez@etermax.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,52 @@
+# bundletool plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-bundletool)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-bundletool`, add it to your project by running:
+
+```bash
+fastlane add_plugin bundletool
+```
+
+## About bundletool
+
+Extracts a universal apk from an .aab file
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## 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`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## 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/bundletool.rb

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

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

@@ -0,0 +1,205 @@
+require 'fastlane/action'
+require_relative '../helper/bundletool_helper'
+
+module Fastlane
+  module Actions
+    class BundletoolAction < Action
+      def self.run(params)
+        print_params(params)
+        @project_root = Dir.pwd
+        @bundletool_temp_path = "#{@project_root}/bundletool_temp"
+        @verbose = params[:verbose]
+        keystore_info = {}
+        unless (params[:ks_path].nil?)
+          keystore_info[:keystore_path] = params[:ks_path]
+          keystore_info[:keystore_password] = params[:ks_password]
+          keystore_info[:alias] = params[:ks_key_alias]
+          keystore_info[:alias_password] = params[:ks_key_alias_password]
+        end
+
+        bundletool_version = params[:bundletool_version]
+        aab_path = params[:aab_path]
+        output_path = params[:apk_output_path]
+
+        validate_aab!(aab_path) 
+        download_bundletool(bundletool_version)
+        extract_universal_apk_from(aab_path, output_path, keystore_info)
+      end
+
+      def self.validate_aab!(aab_path)
+        puts_message('Checking if .aab file exists...')
+        puts_error!(".aab file at #{aab_path} does not exist") unless File.file?(aab_path)
+        puts_success('Checking if .aab file exists')
+      end
+
+      def self.download_bundletool(version)
+        begin
+          puts_message("Downloading bundletool (#{version}) from https://github.com/google/bundletool/releases/download/#{version}/bundletool-all-#{version}.jar...")
+          Dir.mkdir "#{@project_root}/bundletool_temp"
+          open("https://github.com/google/bundletool/releases/download/#{version}/bundletool-all-#{version}.jar") do |bundletool|
+            File.open("#{@bundletool_temp_path}/bundletool.jar", "wb") do |file|
+              file.write(bundletool.read)
+            end
+          end
+          puts_success('Downloading bundletool')
+        rescue StandardError => e
+          puts_error!("Something went wrong when downloading bundletool version #{version}")
+        end
+      end
+
+      def self.extract_universal_apk_from(aab_path, apk_output_path, keystore_info)
+        begin
+          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)
+          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}")
+        ensure
+          clean_temp!
+        end
+      end
+
+      def self.run_bundletool!(aab_path, keystore_info)
+        puts_message("Extracting apk from #{aab_path}...")
+        output_path = "#{@bundletool_temp_path}/output.apks"
+        keystore_params = ''
+
+        unless (keystore_info.empty?)
+          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}"
+
+        Open3.popen3(cmd) do |_, _, stderr, wait_thr|
+          exit_status = wait_thr.value
+          raise stderr.read unless exit_status.success?
+        end
+        puts_success("Extracting apk from #{aab_path}")
+        output_path
+      end
+
+      def self.prepare_apk!(output_path, target_path)
+        puts_message("Preparing apk to #{target_path}...")
+        puts_important("Apk at path #{target_path} exists. Replacing it.") if File.file?(target_path)
+        target_dir_name = File.dirname(target_path)
+        unless Dir.exist?(target_dir_name)
+          puts_important("Creating path #{target_path} since does not exist")
+          Dir.mkdir target_dir_name
+        end
+        cmd = "mv #{output_path} #{@bundletool_temp_path}/output.zip &&
+        unzip #{@bundletool_temp_path}/output.zip -d #{@bundletool_temp_path} &&
+        mv #{@bundletool_temp_path}/universal.apk #{target_path}"
+        Open3.popen3(cmd) do |_, _, stderr, wait_thr|
+          exit_status = wait_thr.value
+          raise stderr.read unless exit_status.success?
+        end
+        puts_success("Preparing apk to #{target_path}")
+      end
+
+      def self.clean_temp!()
+        cmd = "rm -rf #{@project_root}/bundletool_temp"
+        Open3.popen3(cmd) do |_, _, stderr, wait_thr|
+          exit_status = wait_thr.value
+          raise stderr.read unless exit_status.success?
+        end
+      end
+
+      def self.puts_message(message)
+        UI.message message if @verbose
+      end
+
+      def self.puts_success(message)
+        UI.success "#{message} #{Fastlane::Helper::Emojis.green_checkmark}" if @verbose
+      end
+
+      def self.puts_important(message)
+        UI.important "#{message} #{Fastlane::Helper::Emojis.warning}" if @verbose
+      end
+
+      def self.puts_error!(message)
+        UI.user_error! message
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :ks_path,
+                                       description: 'Path to .jks file',
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :ks_password,
+                                       description: '.jks password',
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :ks_key_alias,
+                                       description: 'Alias for jks',
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :ks_key_alias_password,
+                                       description: 'Alias password for .jks',
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :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: :aab_path,
+                                       description: 'Path where the aab file is',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                                       unless value && !value.empty?
+                                                         UI.user_error!('You must set aab_path.')
+                                                       end
+                                                     end),
+          FastlaneCore::ConfigItem.new(key: :apk_output_path,
+                                       description: 'Path where the apk file is going to be placed',
+                                       is_string: true,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                                       unless value && !value.empty?
+                                                         UI.user_error!('You must set apk_output_path.')
+                                                       end
+                                                     end),
+          FastlaneCore::ConfigItem.new(key: :verbose,
+                                       description: 'Show every messages of the action',
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true,
+                                       default_value: false)
+
+        ]
+      end
+
+      def self.print_params(options)
+        table_title = "Params for bundletool #{Fastlane::Bundletool::VERSION}"
+        FastlaneCore::PrintTable.print_values(config: options,
+                                              mask_keys: [:ks_password, :ks_key_alias_password],
+                                              title: table_title)
+      end
+
+      def self.description
+        "Extracts an universal apk from an .aab file"
+      end
+
+      def self.authors
+        ["Martin Gonzalez"]
+      end
+
+      def self.details
+        "Using the google oficial bundletool to extract an universal apk from .aab file to distribute it"
+      end
+
+      def self.is_supported?(platform)
+        [:android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bundletool/helper/bundletool_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class BundletoolHelper
+      # class methods that you define here become available in your action
+      # as `Helper::BundletoolHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the bundletool plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/bundletool/helper/emojis.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Fastlane
+  module Helper
+    class Emojis #:nodoc:
+      def self.rocket
+        "🚀"
+      end
+
+      def self.green_checkmark
+        "✅"
+      end
+
+      def self.red_cross
+        "❌"
+      end
+
+      def self.warning
+        "⚠️"
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-bundletool
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Martin Gonzalez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.137.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.137.0
+description: 
+email: gonzalez.martin90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/bundletool.rb
+- lib/fastlane/plugin/bundletool/actions/bundletool_action.rb
+- lib/fastlane/plugin/bundletool/helper/bundletool_helper.rb
+- lib/fastlane/plugin/bundletool/helper/emojis.rb
+- lib/fastlane/plugin/bundletool/version.rb
+homepage: https://github.com/MartinGonzalez/fastlane-plugin-bundletool
+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: Extracts a universal apk from an .aab file
+test_files: []