fastlane-plugin-android_channels 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78a1d2d5d451df8a32ec9f6f6fe05a80a67c6615158b97dfa371ba5e18ef3d50
+  data.tar.gz: '0908ad55264545f787a1f190155a480bff7dd71ba228b06c414a986b823cbb3c'
+SHA512:
+  metadata.gz: a2064057157aca710149bae18336e88ebf3070719eae6474f829383dbc6bd60f47f254bc05dccb6b13e9312511bdab11fb7c288abca9de80ad5547ef86d929ef
+  data.tar.gz: d2a6405e66c6b538ec4402b6c06f5b9833bf1a5c226c6952178e2773f799dce7283f2529e4d7014e4a3935020a1955f80fce69360b45423ae34e490d065abb97

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 icyleaf <icyleaf.cn@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,52 @@
+# android_channels plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-android_channels)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-android_channels`, add it to your project by running:
+
+```bash
+fastlane add_plugin android_channels
+```
+
+## About android_channels
+
+Package unsign apk with channels
+
+**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/android_channels/actions/android_channels_action.rb

@@ -0,0 +1,165 @@
+require 'fastlane/action'
+require 'fileutils'
+
+require_relative '../helper/android_channels_helper'
+
+module Fastlane
+  module Actions
+    class AndroidChannelsAction < Action
+      def self.run(params)
+        apk_file = Helper::AndroidChannelsHelper.determine_apk_file!(params)
+        channels = Helper::AndroidChannelsHelper.determine_channels!(params)
+        output_path = Helper::AndroidChannelsHelper.determine_output_path!(params)
+
+        signed = Helper::AndroidChannelsHelper.is_signed?(apk_file)
+        summary_params = {
+          apk_file: apk_file,
+          signed: signed,
+          channels: channels,
+          output_path: output_path,
+        }
+
+        unless signed
+          keystore = Helper::AndroidChannelsHelper.determine_keystore!(params)
+          apksigner = Helper::AndroidChannelsHelper.determine_apksigner!(params)
+          keystore_password = Helper::AndroidChannelsHelper.determine_keystore_password!(params)
+          key_alias = params[:key_alias]
+          key_password = params[:key_password]
+
+          summary_params.merge!({
+            apksigner: apksigner,
+            keystore: keystore,
+            keystore_password: keystore_password,
+            key_alias: key_alias,
+            key_password: key_password
+          })
+        end
+
+        FastlaneCore::PrintTable.print_values(
+          title: "Summary for android_channels #{AndroidChannels::VERSION}",
+          config: summary_params,
+          mask_keys: %i[keystore_password key_password]
+        )
+
+        if signed
+          UI.verbose "Packaging channel apk ..."
+          Helper::AndroidChannelsHelper.write_apk_with_channels(output_path, apk_file, channels)
+        else
+          UI.verbose "Signing apk ..."
+          signed_file = Helper::AndroidChannelsHelper.sign_apk(apksigner, keystore, keystore_password, apk_file, key_alias, key_password)
+
+          UI.verbose "Packaging channel apk ..."
+          Helper::AndroidChannelsHelper.write_apk_with_channels(output_path, signed_file.path, channels)
+          signed_file.unlink
+        end
+
+        total = Dir["#{output_path}/*"].size
+        UI.success "Packaged done, total: #{total} apk file(s)."
+
+        output_path
+      end
+
+      def self.description
+        "Package unsign apk with channels"
+      end
+
+      def self.authors
+        ["icyleaf"]
+      end
+
+      def self.return_value
+        'The output of signed apk path'
+      end
+
+      def self.details
+        "Apply for QYER mobile team for now"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :apk_file,
+                                  env_name: "ANDROID_CHANNELS_APK_FILE",
+                               description: "The path of apk file",
+                             default_value: Dir['**/*'].select{|f|f.end_with?('signed.apk')}.last,
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :channels,
+                                  env_name: "ANDROID_CHANNELS_CHANNELS",
+                               description: "The key password of keystore",
+                                  optional: false,
+                                      type: Array),
+          FastlaneCore::ConfigItem.new(key: :output_path,
+                                  env_name: "ANDROID_CHANNELS_OUTPUT_PATH",
+                               description: "The output path of channels apk files",
+                                  optional: true,
+                             default_value: "channels_apk",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :android_sdk_path,
+                                  env_name: "ANDROID_CHANNELS_ANDROID_SDK_PATH",
+                               description: "The path of android sdk",
+                             default_value: ENV["ANDROID_SDK_ROOT"] || ENV["ANDROID_HOME"],
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :build_tools_version,
+                                  env_name: "ANDROID_CHANNELS_BUILD_TOOLS_VERSION",
+                               description: "The version of build tools (by default, always use latest version)",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :keystore,
+                                  env_name: "ANDROID_CHANNELS_KEYSTORE",
+                               description: "The path of keystore file",
+                             default_value: Dir['**/*'].select{|f|f.end_with?('.keystore')}.last,
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :keystore_password,
+                                  env_name: "ANDROID_CHANNELS_KEYSTORE_PASSWORD",
+                               description: "The password of keystore",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :key_alias,
+                                  env_name: "ANDROID_CHANNELS_KEY_ALIAS",
+                               description: "The key alias of keystore",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :key_password,
+                                  env_name: "ANDROID_CHANNELS_KEY_PASSWORD",
+                               description: "The key password of keystore",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :clean,
+                                  env_name: "ANDROID_CHANNELS_CLEAN",
+                               description: "Should the signed files to be clean before signing it?",
+                                  optional: true,
+                             default_value: false,
+                                      type: Boolean)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:android].include?(platform)
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.example_code
+        [
+          'android_channels(
+            apk_file: "app-signed.apk",
+            channels: ["xiaomi", "huawei", "qq"],
+            output_path: "/tmp/output_path",
+          )',
+          'android_channels(
+            apk_file: "app-unsigned.apk",
+            signed: false,
+            channels: ["xiaomi", "huawei", "qq"],
+            keystore: "release.keystore",
+            keystore_password: "p@ssword",
+            clean: true
+          )'
+        ]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/android_channels/helper/android_channels_helper.rb

@@ -0,0 +1,145 @@
+require 'fastlane_core/ui/ui'
+require 'shellwords'
+require 'tempfile'
+require 'zip'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    module AndroidChannelsHelper
+      def self.sign_apk(apksigner, keystore, keystore_password, apk_file, key_alias = nil, key_password = nil)
+        signed_file = Tempfile.new([File.basename(apk_file.sub("unsigned", "signed")), File.extname(apk_file)])
+        FileUtils.cp(apk_file, signed_file.path)
+
+        command_args = [apksigner.shellescape, "sign", "--ks-pass", "pass:#{keystore_password}", "--ks", keystore.shellescape]
+        command_args << "--ks-key-alias" << key_alias unless key_alias.to_s.empty?
+        command_args << "--key-pass" << "pass:#{key_password}" unless key_password.to_s.empty?
+        command_args << signed_file.path
+        Action.sh(command_args.join(" "), print_command: FastlaneCore::Globals.verbose?)
+
+        signed_file
+      end
+
+      def self.write_apk_with_channels(output_path, apk, channels)
+        Zip.warn_invalid_date = false
+        with_channel_file do |file|
+          channels.each do |name|
+            write_channel_to_apk(output_path, apk, name, file.path)
+          end
+        end
+      end
+
+      def self.write_channel_to_apk(output_path, signed_file, name, channel_file)
+        output_file = File.join(output_path, "#{name}.apk")
+        FileUtils.cp(signed_file, output_file)
+
+        Zip::File.open(output_file, Zip::File::CREATE) do |zip_file|
+          zip_file.add("META-INF/cztchannel_#{name}", channel_file)
+        end
+      rescue Zip::EntryExistsError => ex
+        UI.build_failure!([ex.message].concat(ex.backtrace).join("\n"))
+      end
+
+      def self.with_channel_file(filename = "android_channel", &block)
+        Tempfile.open(filename) do |file|
+          yield file
+        end
+      end
+
+      def self.determine_apk_file!(params)
+        apk_file = find_file(params[:apk_file])
+        UI.user_error!("Not found apk file: #{params[:apk_file]}") unless apk_file
+        apk_file
+      end
+
+      def self.is_signed?(apk_file)
+        Zip.warn_invalid_date = false
+        Zip::File.open(apk_file, Zip::File::CREATE) do |zip_file|
+          file = zip_file.find_entry("META-INF/MANIFEST.MF")
+          if file
+            encrypt_keys = 0
+            file.get_input_stream do |io|
+              io.each_line do |line|
+                return true if encrypt_keys >= 2
+                encrypt_keys += 1 if line.start_with?("Name:")
+              end
+            end
+          end
+        end
+
+        false
+      end
+
+      def self.determine_keystore!(params)
+        keystore = find_file(params[:keystore])
+        UI.user_error!("Not found keystore file: #{params[:keystore]}") unless keystore
+        keystore
+      end
+
+      def self.determine_channels!(params)
+        channels = params[:channels]
+        UI.user_error!("Empty channels") if channels.size.zero?
+        channels
+      end
+
+      def self.determine_keystore_password!(params)
+        password = params[:keystore_password]
+        UI.user_error!("Missing keystore_password") unless password
+        password
+      end
+
+      def self.determine_output_path!(params)
+        output_path = params[:output_path]
+        if Dir.exist?(output_path)
+          if params[:clean]
+            FileUtils.rm_rf(output_path)
+          else
+            UI.user_error!("output path was exists: #{File.expand_path(output_path)}。 \nyou can use `clean:true` to force clean.")
+          end
+        end
+
+        FileUtils.mkdir_p(output_path)
+        output_path
+      end
+
+      def self.determine_apksigner!(params)
+        android_sdk_path = params[:android_sdk_path]
+        build_tools_version = params[:build_tools_version]
+        UI.user_error!("Not found android SDK path: #{android_sdk_path}") unless android_sdk_path
+
+        build_tools_path = build_tools_path(android_sdk_path, build_tools_version)
+        apksigner_path(build_tools_path)
+      end
+
+      def self.find_file(default_file)
+        return default_file if File.file?(default_file)
+
+        Dir['**/*'].each do |file|
+          return file if File.basename(file) == default_file
+        end
+
+        nil
+      end
+
+      def self.build_tools_path(android_sdk_path, version = nil)
+        build_tools_path = File.join(android_sdk_path, "build-tools")
+        unless version
+          latest_path = Dir.glob("#{build_tools_path}/*").inject {|latest, current| File.basename(latest) > File.basename(current) ? latest : current }
+          version = File.basename(latest_path)
+        end
+        path = File.join(build_tools_path, version)
+
+        UI.user_error!("Not found build tools path: #{build_tools_path}") unless path && Dir.exist?(path)
+        path
+      end
+
+      def self.apksigner_path(build_tools_path)
+        file = File.join(build_tools_path, "apksigner")
+
+        UI.user_error!("Not found apksigner: #{params[:android_sdk_path]}") unless file && File.file?(file)
+        file
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module AndroidChannels
+    VERSION = "0.2.0"
+  end
+end

data/lib/fastlane/plugin/android_channels.rb

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

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-android_channels
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- icyleaf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !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.107.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.107.0
+description: 
+email: icyleaf.cn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/android_channels.rb
+- lib/fastlane/plugin/android_channels/actions/android_channels_action.rb
+- lib/fastlane/plugin/android_channels/helper/android_channels_helper.rb
+- lib/fastlane/plugin/android_channels/version.rb
+homepage: https://github.com/icyleaf/fastlane-plugin-android_channels
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Package unsign apk with channels
+test_files: []