fastlane-plugin-android_channels 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78a1d2d5d451df8a32ec9f6f6fe05a80a67c6615158b97dfa371ba5e18ef3d50
-  data.tar.gz: '0908ad55264545f787a1f190155a480bff7dd71ba228b06c414a986b823cbb3c'
+  metadata.gz: e53b39ed711bb97fe656417eec498e5631621bdab69f93efcd8e32fad9b20151
+  data.tar.gz: 38082a02a372af9be715e6ef528362be2fd9b10a07add4c297837f71897d3194
 SHA512:
-  metadata.gz: a2064057157aca710149bae18336e88ebf3070719eae6474f829383dbc6bd60f47f254bc05dccb6b13e9312511bdab11fb7c288abca9de80ad5547ef86d929ef
-  data.tar.gz: d2a6405e66c6b538ec4402b6c06f5b9833bf1a5c226c6952178e2773f799dce7283f2529e4d7014e4a3935020a1955f80fce69360b45423ae34e490d065abb97
+  metadata.gz: 620e7c463d504063ddb04ee661c25bb4070061af25091f9a37c1224aa8106bbe447604bfc12eb4a70fd9c4ddb7f26319ca66bd1fc6219160d5998e2f3666e7ac
+  data.tar.gz: ddcd417932a5d239aae68a56fb2004d8dfc8fec3fca0df027c6d850458b0b345ce51b071b769f078c77e444eb6d2a81d12389c74db3d8c45a7da70c7eb9acf18

data/README.md

@@ -12,12 +12,56 @@ fastlane add_plugin android_channels
 
 ## About android_channels
 
-Package unsign apk with channels
+Package unsign apk with channels and write empty file to META-INF with channel in general way
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+## Configuration
+
+```
++-------------------------+-------------------------------------------------+------------------------------------------+-------------------------------------------------+
+|                                                                        android_channels Options                                                                        |
++-------------------------+-------------------------------------------------+------------------------------------------+-------------------------------------------------+
+| Key                     | Description                                     | Env Var                                  | Default                                         |
++-------------------------+-------------------------------------------------+------------------------------------------+-------------------------------------------------+
+| apk_file                | The path of apk file                            | ANDROID_CHANNELS_APK_FILE                | builds/output/apk/app-unsigned.apk              |
+| channels                | The key password of keystore                    | ANDROID_CHANNELS_CHANNELS                | []                                              |
+| channel_file            | The path of channel file, accepts json, yaml    | ANDROID_CHANNELS_CHANNEL_FILE            |                                                 |
+|                         | and plain text file (split with space, comma    |                                          |                                                 |
+|                         | and newline)                                    |                                          |                                                 |
+| channel_filename_prefix | The prefix of empty channel file to write to    | ANDROID_CHANNELS_CHANNEL_FILENAME_PREFIX |                                                 |
+|                         | METE-INF folder                                 |                                          |                                                 |
+| channel_filename_suffix | The suffix of empty channel file to write to    | ANDROID_CHANNELS_CHANNEL_FILENAME_SUFFIX |                                                 |
+|                         | METE-INF folder                                 |                                          |                                                 |
+| output_path             | The output path of channel apk files            | ANDROID_CHANNELS_OUTPUT_PATH             | channel_apks                                    |
+| android_sdk_path        | The path of android sdk                         | ANDROID_CHANNELS_ANDROID_SDK_PATH        | /usr/local/share/android-sdk                    |
+| build_tools_version     | The version of build tools (by default, always  | ANDROID_CHANNELS_BUILD_TOOLS_VERSION     |                                                 |
+|                         | use latest version)                             |                                          |                                                 |
+| keystore                | The path of keystore file                       | ANDROID_CHANNELS_KEYSTORE                | release.keystore                                |
+| keystore_password       | The password of keystore                        | ANDROID_CHANNELS_KEYSTORE_PASSWORD       |                                                 |
+| key_alias               | The key alias of keystore                       | ANDROID_CHANNELS_KEY_ALIAS               |                                                 |
+| key_password            | The key password of keystore                    | ANDROID_CHANNELS_KEY_PASSWORD            |                                                 |
+| apksigner_extra_args    | The extra arguments of apksigner command        | ANDROID_CHANNELS_APKSIGNER_EXTRA_ARGS    |                                                 |
+| verify                  | Do or not verify signed apk file                | ANDROID_CHANNELS_VERIFY                  | false                                           |
+| clean                   | Should the signed files to be clean before      | ANDROID_CHANNELS_CLEAN                   | false                                           |
+|                         | signing it?                                     |                                          |                                                 |
++-------------------------+-------------------------------------------------+------------------------------------------+-------------------------------------------------+
+* = default value is dependent on the user's system
+```
+
+Here has some example [channel files](examples/).
+
+## Return value
+
+```
++-------------------------------+
+| android_channels Return Value |
++-------------------------------+
+| The output of signed apk path |
++-------------------------------+
+```
 
 ## 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)

data/lib/fastlane/plugin/android_channels/actions/android_channels_action.rb

@@ -10,6 +10,8 @@ module Fastlane
         apk_file = Helper::AndroidChannelsHelper.determine_apk_file!(params)
         channels = Helper::AndroidChannelsHelper.determine_channels!(params)
         output_path = Helper::AndroidChannelsHelper.determine_output_path!(params)
+        apksigner = Helper::AndroidChannelsHelper.determine_apksigner!(params)
+        apksigner_args = nil
 
         signed = Helper::AndroidChannelsHelper.is_signed?(apk_file)
         summary_params = {
@@ -21,17 +23,12 @@ module Fastlane
 
         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]
+          apksigner_args = Helper::AndroidChannelsHelper.apksigner_args(params)
 
           summary_params.merge!({
-            apksigner: apksigner,
             keystore: keystore,
-            keystore_password: keystore_password,
-            key_alias: key_alias,
-            key_password: key_password
+            apksigner: apksigner,
+            apksigner_args: apksigner_args
           })
         end
 
@@ -41,17 +38,13 @@ module Fastlane
           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
+        Helper::AndroidChannelsHelper.packing_apk(apk_file, channels, output_path, {
+          apksigner: apksigner,
+          apksigner_args: apksigner_args,
+          prefix: params[:channel_filename_prefix],
+          suffix: params[:channel_filename_suffix],
+          verify: params[:verify]
+        })
 
         total = Dir["#{output_path}/*"].size
         UI.success "Packaged done, total: #{total} apk file(s)."
@@ -60,7 +53,11 @@ module Fastlane
       end
 
       def self.description
-        "Package unsign apk with channels"
+        "Package apk file with channels"
+      end
+
+      def self.details
+        "Write empty file to META-INF with channel in general way"
       end
 
       def self.authors
@@ -71,9 +68,6 @@ module Fastlane
         'The output of signed apk path'
       end
 
-      def self.details
-        "Apply for QYER mobile team for now"
-      end
 
       def self.available_options
         [
@@ -86,13 +80,29 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :channels,
                                   env_name: "ANDROID_CHANNELS_CHANNELS",
                                description: "The key password of keystore",
-                                  optional: false,
+                                  optional: true,
+                             default_value: [],
                                       type: Array),
+          FastlaneCore::ConfigItem.new(key: :channel_file,
+                                  env_name: "ANDROID_CHANNELS_CHANNEL_FILE",
+                               description: "The path of channel file, accepts json, yaml and plain text file (split with space, comma and newline)",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :channel_filename_prefix,
+                                  env_name: "ANDROID_CHANNELS_CHANNEL_FILENAME_PREFIX",
+                               description: "The prefix of empty channel file to write to METE-INF folder",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :channel_filename_suffix,
+                                  env_name: "ANDROID_CHANNELS_CHANNEL_FILENAME_SUFFIX",
+                               description: "The suffix of empty channel file to write to METE-INF folder",
+                                  optional: true,
+                                      type: String),
           FastlaneCore::ConfigItem.new(key: :output_path,
                                   env_name: "ANDROID_CHANNELS_OUTPUT_PATH",
-                               description: "The output path of channels apk files",
+                               description: "The output path of channel apk files",
                                   optional: true,
-                             default_value: "channels_apk",
+                             default_value: "channel_apks",
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :android_sdk_path,
                                   env_name: "ANDROID_CHANNELS_ANDROID_SDK_PATH",
@@ -126,6 +136,17 @@ module Fastlane
                                description: "The key password of keystore",
                                   optional: true,
                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :apksigner_extra_args,
+                                  env_name: "ANDROID_CHANNELS_APKSIGNER_EXTRA_ARGS",
+                               description: "The extra arguments of apksigner command",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :verify,
+                                  env_name: "ANDROID_CHANNELS_VERIFY",
+                               description: "Do or not verify signed apk file",
+                                  optional: true,
+                             default_value: false,
+                                      type: Boolean),
           FastlaneCore::ConfigItem.new(key: :clean,
                                   env_name: "ANDROID_CHANNELS_CLEAN",
                                description: "Should the signed files to be clean before signing it?",
@@ -146,17 +167,25 @@ module Fastlane
       def self.example_code
         [
           'android_channels(
-            apk_file: "app-signed.apk",
+            apk_file: "app.apk",
             channels: ["xiaomi", "huawei", "qq"],
             output_path: "/tmp/output_path",
+            verify: true
           )',
           'android_channels(
             apk_file: "app-unsigned.apk",
-            signed: false,
             channels: ["xiaomi", "huawei", "qq"],
             keystore: "release.keystore",
             keystore_password: "p@ssword",
             clean: true
+          )',
+          'android_channels(
+            apk_file: "app-unsigned.apk",
+            channels: ["xiaomi", "huawei", "qq"],
+            channel_filename_prefix: "channel_",
+            keystore: "release.keystore",
+            keystore_extra_args: "--ks-pass env:app.env --key-alias app",
+            clean: true
           )'
         ]
       end

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

@@ -1,6 +1,8 @@
 require 'fastlane_core/ui/ui'
 require 'shellwords'
 require 'tempfile'
+require 'json'
+require 'yaml'
 require 'zip'
 
 module Fastlane
@@ -8,51 +10,64 @@ module Fastlane
 
   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)
+      APKSIGNER_COMMAND_KEYS = {
+        keystore: "--ks",
+        keystore_password: "--ks-pass",
+        key_alias: "--ks-key-alias",
+        key_password: "--key-pass",
+      }
+
+      # 签名接收的各渠道包
+      def self.packing_apk(apk_file, channels, output_path, options = {})
         Zip.warn_invalid_date = false
-        with_channel_file do |file|
-          channels.each do |name|
-            write_channel_to_apk(output_path, apk, name, file.path)
+
+        UI.message "Packaing apk ..."
+        Tempfile.open("android_channel_name_file") do |empty_channel_file|
+          channels.each do |channel_name|
+            signed_and_write_channel_to_apk(apk_file, channel_name, output_path, empty_channel_file.path, options)
           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)
+      # 写入渠道并签名 apk 文件
+      def self.signed_and_write_channel_to_apk(apk_file, channel_name, output_path, write_file, options)
+        output_file = File.join(output_path, "#{channel_name}.apk")
+        Action.sh("cp #{apk_file} #{output_file}", print_command: false)
 
+        channel_filename = [options[:prefix], channel_name, options[:suffix]].compact.join("")
+        UI.verbose "Writing 'META-INF/#{channel_filename}' file to #{output_file}"
         Zip::File.open(output_file, Zip::File::CREATE) do |zip_file|
-          zip_file.add("META-INF/cztchannel_#{name}", channel_file)
+          zip_file.add("META-INF/#{channel_filename}", write_file)
+        end
+
+        UI.verbose "Signing ..."
+        sign_apk(output_file, options)
+
+        if options[:verify] && !verify_apk(output_file, options[:apksigner])
+          UI.build_failure! "Verify failure apk file: #{output_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
+      # 签名 apk 文件
+      def self.sign_apk(apk_file, options = {})
+        command = "#{options[:apksigner].shellescape} sign #{options[:apksigner_args]} #{apk_file}"
+        Action.sh(command, print_command: false, print_command_output: verbose?)
       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
+      # 验证 apk 签名是否正确
+      def self.verify_apk(apk_file, apksigner)
+        command_args = [apksigner.shellescape, "verify"]
+        command_args << "--verbose" if verbose?
+        command_args << apk_file
+
+        UI.verbose "Verifing ..."
+        result = Action.sh(command_args.join(" "), print_command: false, print_command_output: verbose?)
+        !result.include?("DOES NOT VERIFY")
       end
 
+      # 验证 apk 是否签名
       def self.is_signed?(apk_file)
         Zip.warn_invalid_date = false
         Zip::File.open(apk_file, Zip::File::CREATE) do |zip_file|
@@ -71,22 +86,55 @@ module Fastlane
         false
       end
 
-      def self.determine_keystore!(params)
-        keystore = find_file(params[:keystore])
-        UI.user_error!("Not found keystore file: #{params[:keystore]}") unless keystore
-        keystore
+      def self.verbose?
+        FastlaneCore::Globals.verbose?
+      end
+
+      # 解析并合并 apksigner 的参数， 额外的参数会覆盖之前设置过的值
+      def self.apksigner_args(params)
+        command = {}
+        params.all_keys.each do |key|
+          if APKSIGNER_COMMAND_KEYS.has_key?(key)
+            if command_value = params[key]
+              command_key = APKSIGNER_COMMAND_KEYS[key].to_s
+              command_value = "pass:#{command_value}" if command_key.end_with?("pass")
+              command[command_key] = command_value.shellescape
+            end
+          end
+        end
+
+        if extra_args = params[:apksigner_extra_args]
+          extra_args.split(" ").each_slice(2) do |part|
+            key = part[0].to_s.strip.shellescape
+            if value = part[1]
+              command[key.to_s] = value.strip.shellescape
+            end
+          end
+        end
+
+        command.flatten.join(" ")
+      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.determine_channels!(params)
         channels = params[:channels]
+        if (file = params[:channel_file]) && File.exist?(file)
+          channels.concat(load_channel_file(file))
+        end
+
         UI.user_error!("Empty channels") if channels.size.zero?
-        channels
+        channels.map{|n| n.strip}.uniq
       end
 
-      def self.determine_keystore_password!(params)
-        password = params[:keystore_password]
-        UI.user_error!("Missing keystore_password") unless password
-        password
+      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_output_path!(params)
@@ -122,6 +170,19 @@ module Fastlane
         nil
       end
 
+      def self.load_channel_file(file)
+        content = File.read(file)
+        case File.extname(file)
+        when ".json"
+          JSON.load(content).to_a
+        when ".yaml", ".yml"
+          YAML.load(content).to_a
+        else
+          # 安装纯文本解析
+          content.gsub(/(\s|\n)+/, ",").split(",").select {|n| n && !n.empty?}
+        end
+      end
+
       def self.build_tools_path(android_sdk_path, version = nil)
         build_tools_path = File.join(android_sdk_path, "build-tools")
         unless version

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-android_channels
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - icyleaf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-25 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -182,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Package unsign apk with channels