Support universal APK as input as well

AliSoftware · AliSoftware · commit a36b67b4f896 · 2022-05-24T12:35:38.000+02:00
diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_send_app_size_metrics.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_send_app_size_metrics.rb
@@ -10,6 +10,9 @@ def self.run(params)
         if (api_token.nil? || api_token.empty?) && !api_url.is_a?(URI::File)
           UI.user_error!('An API token is required when using an `api_url` with a scheme other than `file://`')
         end
+        if params[:aab_path].nil? && params[:universal_apk_path].nil?
+          UI.user_error!('You must provide at least an `aab_path` or an `universal_apk_path`, or both')
+        end
 
         # Build the payload base
         metrics_helper = Fastlane::Helper::AppSizeMetricsHelper.new(
@@ -21,28 +24,31 @@ def self.run(params)
           'Build Type': params[:build_type],
           Source: params[:source]
         )
-        metrics_helper.add_metric(name: 'AAB File Size', value: File.size(params[:aab_path]))
+        # Add AAB file size
+        metrics_helper.add_metric(name: 'AAB File Size', value: File.size(params[:aab_path])) unless params[:aab_path].nil?
+        # Add Universal APK file size
+        metrics_helper.add_metric(name: 'Universal APK File Size', value: File.size(params[:universal_apk_path])) unless params[:universal_apk_path].nil?
 
-        # Add device-specific 'splits' metrics to the payload if a `:include_split_sizes` is enabled
+        # Add optimized file and download sizes for each split `.apk` metrics to the payload if a `:include_split_sizes` is enabled
         if params[:include_split_sizes]
-          check_bundletool_installed!
-          apkanalyzer_bin = find_apkanalyzer_binary!
-          UI.message("[App Size Metrics] Generating the various APK splits from #{params[:aab_path]}...")
-          Dir.mktmpdir('release-toolkit-android-app-size-metrics') do |tmp_dir|
-            Action.sh('bundletool', 'build-apks', '--bundle', params[:aab_path], '--output-format', 'DIRECTORY', '--output', tmp_dir)
-            apks = Dir.glob('splits/*.apk', base: tmp_dir).map { |f| File.join(tmp_dir, f) }
-            UI.message("[App Size Metrics] Generated #{apks.length} APKs.")
-
-            apks.each do |apk|
-              UI.message("[App Size Metrics] Computing file and download size of #{File.basename(apk)}...")
-              split_name = File.basename(apk, '.apk')
-              file_size = Action.sh(apkanalyzer_bin, 'apk', 'file-size', apk, print_command: false, print_command_output: false).chomp.to_i
-              download_size = Action.sh(apkanalyzer_bin, 'apk', 'download-size', apk, print_command: false, print_command_output: false).chomp.to_i
-              metrics_helper.add_metric(name: 'APK File Size', value: file_size, metadata: { split: split_name })
-              metrics_helper.add_metric(name: 'Download Size', value: download_size, metadata: { split: split_name })
+          unless params[:aab_path].nil?
+            check_bundletool_installed!
+            UI.message("[App Size Metrics] Generating the various APK splits from #{params[:aab_path]}...")
+            Dir.mktmpdir('release-toolkit-android-app-size-metrics') do |tmp_dir|
+              Action.sh('bundletool', 'build-apks', '--bundle', params[:aab_path], '--output-format', 'DIRECTORY', '--output', tmp_dir)
+              apks = Dir.glob('splits/*.apk', base: tmp_dir).map { |f| File.join(tmp_dir, f) }
+              UI.message("[App Size Metrics] Generated #{apks.length} APKs.")
+
+              apks.each do |apk|
+                split_name = File.basename(apk, '.apk')
+                add_apk_size_metrics(helper: metrics_helper, apk: apk, split_name: split_name)
+              end
+
+              UI.message('[App Size Metrics] Done computing splits sizes.')
             end
-
-            UI.message('[App Size Metrics] Done computing splits sizes.')
+          end
+          unless params[:universal_apk_path].nil?
+            add_apk_size_metrics(helper: metrics_helper, apk: params[:universal_apk_path], split_name: 'Universal')
           end
         end
 
@@ -61,13 +67,24 @@ def self.check_bundletool_installed!
         raise
       end
 
-      def self.find_apkanalyzer_binary!
+      def self.apkanalyzer_binary!
+        Action.sh('command', '-v', 'apkanalyzer')
+      rescue StandardError
         sdk_root = ENV['ANDROID_SDK_ROOT'] || ENV['ANDROID_HOME']
-        apkanalyzer_bin = sdk_root.nil? ? Action.sh('command', '-v', 'apkanalyzer') : File.join(sdk_root, 'cmdline-tools', 'latest', 'bin', 'apkanalyzer')
-        UI.user_error!('Unable to find apkanalyzer executable. Make sure you installed the Android SDK Command-line Tools') unless File.executable?(apkanalyzer_bin)
+        UI.user_error!('Unable to find ANDROID_SDK_ROOT / ANDROID_HOME') if sdk_root.nil?
+        apkanalyzer_bin = File.join(sdk_root, 'cmdline-tools', 'latest', 'bin', 'apkanalyzer')
+        UI.user_error!('Unable to find `apkanalyzer` executable. Make sure you installed the Android SDK Command-line Tools') unless File.executable?(apkanalyzer_bin)
         apkanalyzer_bin
       end
 
+      def self.add_apk_size_metrics(helper:, apk:, split_name:)
+        UI.message("[App Size Metrics] Computing file and download size of #{File.basename(apk)}...")
+        file_size = Action.sh(apkanalyzer_binary!, 'apk', 'file-size', apk, print_command: false, print_command_output: false).chomp.to_i
+        download_size = Action.sh(apkanalyzer_binary!, 'apk', 'download-size', apk, print_command: false, print_command_output: false).chomp.to_i
+        helper.add_metric(name: 'APK File Size', value: file_size, metadata: { split: split_name })
+        helper.add_metric(name: 'Download Size', value: download_size, metadata: { split: split_name })
+      end
+
       #####################################################
       # @!group Documentation
       #####################################################
@@ -157,7 +174,7 @@ def self.available_options
             env_name: 'FL_ANDROID_SEND_APP_SIZE_METRICS_AAB_PATH',
             description: 'The path to the .aab to extract size information from',
             type: String,
-            optional: false,
+            optional: true, # We can have `aab_path` only, or `universal_apk_path` only, or both (but not none)
             verify_block: proc do |value|
               UI.user_error!('You must provide an path to an existing `.aab` file') unless File.exist?(value)
             end
@@ -170,6 +187,16 @@ def self.available_options
             type: FastlaneCore::Boolean,
             default_value: true
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :universal_apk_path,
+            env_name: 'FL_ANDROID_SEND_APP_SIZE_METRICS_UNIVERSAL_APK_PATH',
+            description: 'The path to the Universal .apk to extract size information from',
+            type: String,
+            optional: true, # We can have `aab_path` only, or `universal_apk_path` only, or both (but not none)
+            verify_block: proc do |value|
+              UI.user_error!('You must provide an path to an existing `.apk` file') unless File.exist?(value)
+            end
+          ),
         ]
       end
 
diff --git a/spec/android_send_app_size_metrics_spec.rb b/spec/android_send_app_size_metrics_spec.rb
@@ -13,9 +13,8 @@ def test_app_size_action(fake_aab_size:, fake_apks:, expected_payload:, **other_
 
       if other_action_args[:include_split_sizes] != false
         # Arrange: fake that apkanalyzer exists
-        ENV['ANDROID_SDK_ROOT'] = '__ANDROID_SDK_ROOT__FOR_TESTS__'
-        apkanalyzer_bin = File.join('__ANDROID_SDK_ROOT__FOR_TESTS__', 'cmdline-tools', 'latest', 'bin', 'apkanalyzer')
-        allow(File).to receive(:executable?).with(apkanalyzer_bin).and_return(true)
+        fake_apkanalyzer_path = './fake_apkanalyzer_bin'
+        allow(described_class).to receive(:apkanalyzer_binary!).and_return(fake_apkanalyzer_path)
 
         # Arrange: fake that bundletool exists and mock its call to create fake apks with corresponding apkanalyzer calls mocks
         allow(Fastlane::Action).to receive(:sh).with('command', '-v', 'bundletool', anything)
@@ -25,8 +24,8 @@ def test_app_size_action(fake_aab_size:, fake_apks:, expected_payload:, **other_
           fake_apks.each do |apk_name, sizes|
             apk_path = File.join(bundletool_tmpdir, 'splits', apk_name.to_s)
             File.write(apk_path, "Fake APK file (#{sizes})")
-            allow(Fastlane::Action).to receive(:sh).with(apkanalyzer_bin, 'apk', 'file-size', apk_path, anything).and_return(sizes[0].to_s)
-            allow(Fastlane::Action).to receive(:sh).with(apkanalyzer_bin, 'apk', 'download-size', apk_path, anything).and_return(sizes[1].to_s)
+            allow(Fastlane::Action).to receive(:sh).with(fake_apkanalyzer_path, 'apk', 'file-size', apk_path, anything).and_return(sizes[0].to_s)
+            allow(Fastlane::Action).to receive(:sh).with(fake_apkanalyzer_path, 'apk', 'download-size', apk_path, anything).and_return(sizes[1].to_s)
           end
         end
       end
@@ -51,87 +50,107 @@ def test_app_size_action(fake_aab_size:, fake_apks:, expected_payload:, **other_
   end
 
   context 'when `include_split_sizes` is turned off' do
-    it 'generates the expected payload compressed by default' do
-      expected = {
-        meta: [
-          { name: 'Platform', value: 'Android' },
-          { name: 'App Name', value: 'my-app' },
-          { name: 'App Version', value: '10.2-rc-3' },
-          { name: 'Product Flavor', value: 'Vanilla' },
-          { name: 'Build Type', value: 'Release' },
-          { name: 'Source', value: 'unit-test' },
-        ],
-        metrics: [
-          { name: 'AAB File Size', value: 123_456 },
-        ]
-      }
-
-      test_app_size_action(
-        fake_aab_size: 123_456,
-        fake_apks: {},
-        expected_payload: expected,
-        app_name: 'my-app',
-        app_version_name: '10.2-rc-3',
-        product_flavor: 'Vanilla',
-        build_type: 'Release',
-        source: 'unit-test',
-        include_split_sizes: false
-      )
+    context 'when only providing an `aab_path`' do
+      it 'generates the expected payload compressed by default' do
+        expected = {
+          meta: [
+            { name: 'Platform', value: 'Android' },
+            { name: 'App Name', value: 'my-app' },
+            { name: 'App Version', value: '10.2-rc-3' },
+            { name: 'Product Flavor', value: 'Vanilla' },
+            { name: 'Build Type', value: 'Release' },
+            { name: 'Source', value: 'unit-test' },
+          ],
+          metrics: [
+            { name: 'AAB File Size', value: 123_456 },
+          ]
+        }
+
+        test_app_size_action(
+          fake_aab_size: 123_456,
+          fake_apks: {},
+          expected_payload: expected,
+          app_name: 'my-app',
+          app_version_name: '10.2-rc-3',
+          product_flavor: 'Vanilla',
+          build_type: 'Release',
+          source: 'unit-test',
+          include_split_sizes: false
+        )
+      end
+
+      it 'generates the expected payload uncompressed when disabling gzip' do
+        expected = {
+          meta: [
+            { name: 'Platform', value: 'Android' },
+            { name: 'App Name', value: 'my-app' },
+            { name: 'App Version', value: '10.2-rc-3' },
+            { name: 'Product Flavor', value: 'Vanilla' },
+            { name: 'Build Type', value: 'Release' },
+            { name: 'Source', value: 'unit-test' },
+          ],
+          metrics: [
+            { name: 'AAB File Size', value: 123_456 },
+          ]
+        }
+
+        test_app_size_action(
+          fake_aab_size: 123_456,
+          fake_apks: {},
+          expected_payload: expected,
+          app_name: 'my-app',
+          app_version_name: '10.2-rc-3',
+          product_flavor: 'Vanilla',
+          build_type: 'Release',
+          source: 'unit-test',
+          include_split_sizes: false,
+          use_gzip_content_encoding: false
+        )
+      end
     end
 
-    it 'generates the expected payload uncompressed when disabling gzip' do
-      expected = {
-        meta: [
-          { name: 'Platform', value: 'Android' },
-          { name: 'App Name', value: 'my-app' },
-          { name: 'App Version', value: '10.2-rc-3' },
-          { name: 'Product Flavor', value: 'Vanilla' },
-          { name: 'Build Type', value: 'Release' },
-          { name: 'Source', value: 'unit-test' },
-        ],
-        metrics: [
-          { name: 'AAB File Size', value: 123_456 },
-        ]
-      }
-
-      test_app_size_action(
-        fake_aab_size: 123_456,
-        fake_apks: {},
-        expected_payload: expected,
-        app_name: 'my-app',
-        app_version_name: '10.2-rc-3',
-        product_flavor: 'Vanilla',
-        build_type: 'Release',
-        source: 'unit-test',
-        include_split_sizes: false,
-        use_gzip_content_encoding: false
-      )
+    context 'when only providing an `universal_apk_path`' do
+      it 'generates the expected payload containing the apk file size'
+    end
+
+    context 'when providing both an `aab_path` and an `universal_apk_path`' do
+      it 'generates the expected payload containing the aab and universal apk file size'
     end
   end
 
   context 'when keeping the default value of `include_split_sizes` turned on' do
-    it 'generates the expected payload containing the aab file size and optimized split sizes' do
-      expected_fixture = File.join(test_data_dir, 'android-metrics-payload.json')
-      expected = JSON.parse(File.read(expected_fixture))
-
-      test_app_size_action(
-        fake_aab_size: 987_654_321,
-        fake_apks: {
-          'base-arm64_v8a.apk': [164_080, 64_080],
-          'base-arm64_v8a_2.apk': [164_082, 64_082],
-          'base-armeabi.apk': [150_000, 50_000],
-          'base-armeabi_2.apk': [150_002, 50_002],
-          'base-armeabi_v7a.apk': [150_070, 50_070],
-          'base-armeabi_v7a_2.apk': [150_072, 50_072]
-        },
-        expected_payload: expected,
-        app_name: 'wordpress',
-        app_version_name: '19.8-rc-3',
-        app_version_code: 1214,
-        product_flavor: 'Vanilla',
-        build_type: 'Release',
-        source: 'unit-test'
-      )
+    context 'when only providing an `aab_path`' do
+      it 'generates the expected payload containing the aab file size and optimized split sizes' do
+        expected_fixture = File.join(test_data_dir, 'android-metrics-payload.json')
+        expected = JSON.parse(File.read(expected_fixture))
+
+        test_app_size_action(
+          fake_aab_size: 987_654_321,
+          fake_apks: {
+            'base-arm64_v8a.apk': [164_080, 64_080],
+            'base-arm64_v8a_2.apk': [164_082, 64_082],
+            'base-armeabi.apk': [150_000, 50_000],
+            'base-armeabi_2.apk': [150_002, 50_002],
+            'base-armeabi_v7a.apk': [150_070, 50_070],
+            'base-armeabi_v7a_2.apk': [150_072, 50_072]
+          },
+          expected_payload: expected,
+          app_name: 'wordpress',
+          app_version_name: '19.8-rc-3',
+          app_version_code: 1214,
+          product_flavor: 'Vanilla',
+          build_type: 'Release',
+          source: 'unit-test'
+        )
+      end
+    end
+
+    context 'when only providing an `universal_apk_path`' do
+      it 'generates the expected payload containing the apk file size and optimized file and download sizes'
+    end
+
+    context 'when providing both an `aab_path` and an `universal_apk_path`' do
+      it 'generates the expected payload containing the aab and universal apk file size and optimized file and download sizes for all splits'
     end
   end
 end
