danger-app_size_report 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b365600ee021d284beda6dcbfbf0458f1a5a70e57e5602de4f90fa96a42e89d
-  data.tar.gz: 0c673c72637fd341e61c43ec044bdf9c5e2742e9571920269dfdacf8a2c97cb7
+  metadata.gz: 51678b949d92e02ba3e1a894123ac553027e7fad07dba8157877296e4177e6a2
+  data.tar.gz: '044917b9b27fe9bb6677649051d1757ffebe2cc42df99e02266cf5f8608d73c9'
 SHA512:
-  metadata.gz: df752062c2f4f08a90f1ccaf9d153f25e1c782e4c342c22529175989a44dd0187470abeeabc88e726b8d0cd31f14df9abafd6c7f22b3c7b8d2e672f2556fde82
-  data.tar.gz: 414f43733a1c575c051ed0bfce2a9bf9e28438facb30c361080fef18d58c4ecb58d12ad86806ce17feefa0ab8f8f52137a8a9e71bb91a2a1986003d392ee9b23
+  metadata.gz: 922c09c181eec687676307efd9031bc4634f4965388f2513431829c115d631c70f475a8f26f7a4f5f9e36e76f51d3c8035b1e0736ad9e8cb2d62537abc606b76
+  data.tar.gz: 7d8d16cc6a68d75ba094b5ba20da98cd119b8f4264c64f8c52b1f8b49a0618317370241cd280da71f73212bf9c79234ef01f40fb3b6ae70f81400e76db1bc5b0

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6.0
+Layout/LineLength:
+  Max: 250
+Metrics/MethodLength:
+  Max: 65
+Metrics/BlockLength:
+  Max: 60
+Metrics/PerceivedComplexity:
+  Max: 20
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/AbcSize:
+  Max: 70
+Metrics/ClassLength:
+  Max: 200
+Metrics/ParameterLists:
+  Max: 11
+Style/Documentation:
+  AllowedConstants: [Danger]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-app_size_report (0.0.2)
+    danger-app_size_report (0.0.4)
       danger-plugin-api (~> 1.0)
 
 GEM
@@ -19,7 +19,7 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (8.4.2)
+    danger (8.6.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -35,7 +35,7 @@ GEM
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.5.0)
-    faraday (1.9.3)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -62,7 +62,7 @@ GEM
     faraday-retry (1.0.3)
     ffi (1.15.5)
     formatador (1.1.0)
-    git (1.10.2)
+    git (1.11.0)
       rchardet (~> 1.8)
     guard (2.18.0)
       formatador (>= 0.2.4)
@@ -78,7 +78,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -98,35 +98,35 @@ GEM
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.6)
+    public_suffix (4.0.7)
     rainbow (3.1.1)
     rake (10.5.0)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rchardet (1.8.0)
-    regexp_parser (2.2.0)
+    regexp_parser (2.3.1)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.2)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.25.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -135,8 +135,8 @@ GEM
       rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     sawyer (0.8.2)
@@ -153,6 +153,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-darwin-21
 
 DEPENDENCIES
   bundler (~> 2.0)

data/README.md

@@ -1,6 +1,6 @@
 # danger-app_size_report
 
-A [Danger](https://github.com/danger/danger) plugin for reporting iOS app size violations. A valid [App Thinning Size Report](https://developer.apple.com/documentation/xcode/reducing-your-app-s-size) must be passed to the plugin for accurate functionality.
+A [Danger](https://github.com/danger/danger) plugin for reporting iOS and Android app size violations.
 
 ## Installation
 
@@ -8,34 +8,40 @@ A [Danger](https://github.com/danger/danger) plugin for reporting iOS app size v
 
 ## Usage
 
-### `flag_violations`
+### `flag_ios_violations`
 
-Report app size violations given a valid App Thinning Size Report.
+Report **iOS** app size violations given a valid App Thinning Size Report. A valid [App Thinning Size Report](https://developer.apple.com/documentation/xcode/reducing-your-app-s-size) must be passed to the plugin for accurate functionality.
 
     // Dangerfile
 
     report_path = "/Path/to/AppSizeReport.txt"
-    app_size_report.flag_violations(
-        report_path, 
-        build_type: 'App', 
-        size_limit: 4, 
-        limit_unit: 'GB', 
+    app_size_report.flag_ios_violations(
+        report_path,
+        build_type: 'App',
+        size_limit: 4,
+        limit_unit: 'GB',
         fail_on_warning: false
     )
 
+The list of variants with their sizes and any violations will be displayed in the PR report as seen below. Supported variant descriptors are placed under collapsible sections.
+
+<p align="center">
+  <img src="Resources/Images/app_thinning_size_report.png">
+</p>
+
 #### Parameters
 
 - `report_path` [String, required] Path to valid App Thinning Size Report text file.
-- `build_type` [String, optional] [Default: 'App'] Specify whether the report corresponds to an App or an App Clip. 
+- `build_type` [String, optional] [Default: 'App'] Specify whether the report corresponds to an App or an App Clip.
   - Supported values: 'App', 'Clip'
-- `size_limit` [Numeric, optional] [Default: 4] Specify the app size limit. 
+- `size_limit` [Numeric, optional] [Default: 4] Specify the app size limit.
 - `limit_unit` [String, optional] [Default: 'GB'] Specific the unit for the given size limit.
   - Supported values: 'KB', 'MB', 'GB'
-- `fail_on_warning` [Boolean, optional] [Default: false] Specify whether the PR should fail if one or more app variants exceed the given size limit. By default, the plugin issues a warning in this case. 
+- `fail_on_warning` [Boolean, optional] [Default: false] Specify whether the PR should fail if one or more app variants exceed the given size limit. By default, the plugin issues a warning in this case.
 
 ### `report_json`
 
-Returns a JSON string representation of the given App Thinning Size Report.
+Returns a JSON string representation of the given iOS App Thinning Size Report.
 
     // Dangerfile
 
@@ -46,10 +52,62 @@ Returns a JSON string representation of the given App Thinning Size Report.
 
 - `report_path` [String, required] Path to valid App Thinning Size Report text file.
 
-## Development
+### `flag_android_violations`
+
+Report <b>Android</b> app size violations given a valid Android App Bundle (AAB). 
+
+    // Dangerfile
+
+    aab_path = "/Path/to/app.aab"
+    ks_path = "/Path/to/keyStore"
+    ks_alias = "KeyAlias"
+    ks_password = "Key Password"
+    ks_alias_password = "Key Alias Password"
+    app_size_report.flag_android_violations(
+        aab_path,
+        ks_path,
+        ks_alias,
+        ks_password,
+        ks_alias_password,
+        screen_densities: ["MDPI", "HDPI", "XHDPI", "XXHDPI", "XXXHDPI"],
+        languages: ["en", "de", "da", "es", "fr", "it", "nb", "nl", "sv"],
+        build_type: 'Instant',
+        size_limit: 4,
+        limit_unit: 'MB',
+        fail_on_warning: false
+    )
+
+The top 25 violations will be displayed in the PR report with any remaining violations and variants under the size limit placed under collapsible sections as seen below.
 
-1. Clone this repo
+<p align="center">
+  <img src="Resources/Images/android_instant_size_report.png">
+</p>
+
+#### Parameters
+
+- `aab_path` [String, required] Path to valid AAB file.
+- `ks_path` [String, required] Path to valid signing key file.
+- `ks_alias` [String, required] Alias of signing key.
+- `ks_password` [String, required] Password of signing key.
+- `ks_alias_password` [String, required] Alias Password of signing key.
+- `screen_densities` [Array, optional] [Default: ["MDPI", "HDPI", "XHDPI", "XXHDPI", "XXXHDPI"]] Array of screen densities to check APK size.
+- `languages` [Array, optional] [Default: ["en"]] Array of languages to check APK size
+- `build_type` [String, optional] [Default: 'App'] Specify whether the report corresponds to an App or an Instant.
+  - Supported values: 'App', 'Instant'
+- `size_limit` [Numeric, optional] [Default: 150] Specify the app size limit.
+- `limit_unit` [String, optional] [Default: 'MB'] Specific the unit for the given size limit.
+  - Supported values: 'KB', 'MB', 'GB'
+- `fail_on_warning` [Boolean, optional] [Default: false] Specify whether the PR should fail if one or more app variants exceed the given size limit. By default, the plugin issues a warning in this case.
+
+## Contribute
+
+1. Fork this repo.
 2. Run `bundle install` to setup dependencies.
 3. Run `bundle exec rake spec` to run the tests.
 4. Use `bundle exec guard` to automatically have tests run as you make changes.
 5. Make your changes.
+6. Submit a pull request with your desired changes to be merged on review.
+
+## More Info
+
+[Open an issue](https://github.com/ChargePoint/danger-app_size_report/issues) if you have any questions!

data/danger-app_size_report.gemspec

@@ -8,13 +8,14 @@ require 'app_size_report/gem_version'
 Gem::Specification.new do |spec|
   spec.name          = 'danger-app_size_report'
   spec.version       = AppSizeReport::VERSION
-  spec.authors       = ['Rishab Sukumar']
+  spec.authors       = ['Rishab Sukumar', 'Bharath Thakkallapally', 'Vido Shaweddy']
   spec.email         = ['rishab.sukumar@chargepoint.com']
-  spec.description   = 'A Danger plugin for reporting iOS app size violations.'
-  spec.summary       = 'A Danger plugin for reporting iOS app size violations. A valid App Thinning Size Report must be passed to the plugin for accurate functionality.'
+  spec.description   = 'A Danger plugin for reporting iOS and Android app size violations.'
+  spec.summary       = 'A Danger plugin for reporting iOS and Android app size violations. A valid App Thinning Size Report or Android App Bundle must be passed to the plugin for accurate functionality.'
   spec.homepage      = 'https://github.com/ChargePoint/danger-app_size_report'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.6.0'
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
@@ -48,4 +49,5 @@ Gem::Specification.new do |spec|
   #
   # This will stop test execution and let you inspect the results
   spec.add_development_dependency 'pry', '~> 0.14.1'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/app_size_report/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppSizeReport
-  VERSION = '0.0.3'
+  VERSION = '1.0.0'
 end

data/lib/app_size_report/plugin.rb

@@ -2,18 +2,24 @@
 
 module Danger
   require 'json'
+  require 'open-uri'
+  require 'fileutils'
+
   require_relative '../converter/parser/report_parser'
   require_relative '../converter/helper/memory_size'
+  require_relative '../converter/helper/android_utils'
 
-  # A Danger plugin for reporting iOS app size violations.
+  # A Danger plugin for reporting iOS and Android app size violations.
+  #
+  #
   # A valid App Thinning Size Report must be passed to the plugin
-  # for accurate functionality.
+  # for accurate functionality in case of iOS.
   #
-  # @example Report app size violations if one or more App variants
+  # @example Report iOS app size violations if one or more App variants
   # exceed 4GB.
   #
   #          report_path = "/Path/to/AppSize/Report.txt"
-  #          app_size_report.flag_violations(
+  #          app_size_report.flag_ios_violations(
   #             report_path,
   #             build_type: 'App',
   #             size_limit: 4,
@@ -21,11 +27,11 @@ module Danger
   #             fail_on_warning: false
   #          )
   #
-  # @example Report app size violations if one or more App Clip variants
+  # @example Report iOS app size violations if one or more App Clip variants
   # exceed 8MB.
   #
   #          report_path = "/Path/to/AppSize/Report.txt"
-  #          app_size_report.flag_violations(
+  #          app_size_report.flag_ios_violations(
   #             report_path,
   #             build_type: 'Clip',
   #             size_limit: 8,
@@ -33,10 +39,10 @@ module Danger
   #             fail_on_warning: false
   #          )
   #
-  # @example Fail PR if one or more App Clip variants exceed 8MB.
+  # @example Fail PR if one or more iOS App Clip variants exceed 8MB.
   #
   #          report_path = "/Path/to/AppSize/Report.txt"
-  #          app_size_report.flag_violations(
+  #          app_size_report.flag_ios_violations(
   #             report_path,
   #             build_type: 'Clip',
   #             size_limit: 8,
@@ -44,16 +50,79 @@ module Danger
   #             fail_on_warning: true
   #          )
   #
-  # @example Get JSON string representation of app thinning size report
+  # @example Get JSON string representation of iOS app thinning size report
   #
   #          report_path = "/Path/to/AppSize/Report.txt"
   #          app_size_json = app_size_report.report_json(report_path)
   #
+  # @example Report Android app size violations if one or more App variants
+  #
+  #          aab_path = "/Path/to/app.aab"
+  #          ks_path = "/Path/to/keyStore"
+  #          ks_alias = "KeyAlias"
+  #          ks_password = "Key Password"
+  #          ks_alias_password = "Key Alias Password"
+  #          app_size_report.flag_android_violations(
+  #             aab_path,
+  #             ks_path,
+  #             ks_alias,
+  #             ks_password,
+  #             ks_alias_password,
+  #             screen_densities: ["MDPI", "HDPI", "XHDPI", "XXHDPI", "XXXHDPI"],
+  #             languages: ["en", "de", "da", "es", "fr", "it", "nb", "nl", "sv"],
+  #             build_type: 'App',
+  #             size_limit: 14,
+  #             limit_unit: 'MB',
+  #             fail_on_warning: false
+  #          )
+  #
+  # @example Report Android Instant app size violations if one or more App variants
+  #
+  #          aab_path = "/Path/to/app.aab"
+  #          ks_path = "/Path/to/keyStore"
+  #          ks_alias = "KeyAlias"
+  #          ks_password = "Key Password"
+  #          ks_alias_password = "Key Alias Password"
+  #          app_size_report.flag_android_violations(
+  #             aab_path,
+  #             ks_path,
+  #             ks_alias,
+  #             ks_password,
+  #             ks_alias_password,
+  #             screen_densities: ["MDPI", "HDPI", "XHDPI", "XXHDPI", "XXXHDPI"],
+  #             languages: ["en", "de", "da", "es", "fr", "it", "nb", "nl", "sv"],
+  #             build_type: 'Instant',
+  #             size_limit: 4,
+  #             limit_unit: 'MB',
+  #             fail_on_warning: false
+  #          )
+  #
+  # @example Fail PR if one or more Android Instant App variants exceed 4MB.
+  #
+  #          aab_path = "/Path/to/app.aab"
+  #          ks_path = "/Path/to/keyStore"
+  #          ks_alias = "KeyAlias"
+  #          ks_password = "Key Password"
+  #          ks_alias_password = "Key Alias Password"
+  #          app_size_report.flag_android_violations(
+  #             aab_path,
+  #             ks_path,
+  #             ks_alias,
+  #             ks_password,
+  #             ks_alias_password,
+  #             screen_densities: ["MDPI", "HDPI", "XHDPI", "XXHDPI", "XXXHDPI"],
+  #             languages: ["en", "de", "da", "es", "fr", "it", "nb", "nl", "sv"],
+  #             build_type: 'Instant',
+  #             size_limit: 4,
+  #             limit_unit: 'MB',
+  #             fail_on_warning: true
+  #          )
+  #
   # @see  ChargePoint/danger-app_size_report
   # @tags ios, xcode, appclip, thinning, size
   #
   class DangerAppSizeReport < Plugin
-    # Reports app size violations given a valid App Thinning Size Report.
+    # Reports IOS app size violations given a valid App Thinning Size Report.
     # @param [String, required] report_path
     #        Path to valid App Thinning Size Report text file.
     # @param [String, optional] build_type
@@ -74,30 +143,97 @@ module Danger
     #        Default: 'false'
     # @return   [void]
     #
-    def flag_violations(report_path, build_type: 'App', size_limit: 4, limit_unit: 'GB', fail_on_warning: false)
+    def flag_ios_violations(report_path, build_type: 'App', size_limit: 4, limit_unit: 'GB', fail_on_warning: false)
       report_text = File.read(report_path)
       variants = ReportParser.parse(report_text)
 
-      unless %w[App Clip].include? build_type
-        raise ArgumentError, "The 'build_type' argument only accepts the values \"App\" and \"Clip\""
-      end
+      raise ArgumentError, "The 'build_type' argument only accepts the values \"App\" and \"Clip\"" unless %w[App Clip].include? build_type
 
       raise ArgumentError, "The 'size_limit' argument only accepts numeric values" unless size_limit.is_a? Numeric
 
       limit_unit.upcase!
-      unless %w[KB MB GB].include? limit_unit
-        raise ArgumentError, "The 'build_type' argument only accepts the values \"KB\", \"MB\" and \"GB\""
-      end
+      raise ArgumentError, "The 'build_type' argument only accepts the values \"KB\", \"MB\" and \"GB\"" unless %w[KB MB GB].include? limit_unit
 
-      unless [true, false].include? fail_on_warning
-        raise ArgumentError, "The 'fail_on_warning' argument only accepts the values 'true' and 'false'"
-      end
+      raise ArgumentError, "The 'fail_on_warning' argument only accepts the values 'true' and 'false'" unless [true, false].include? fail_on_warning
 
       generate_size_report_markdown(variants, build_type, size_limit, limit_unit, fail_on_warning)
       generate_variant_descriptors_markdown(variants)
       generate_ads_label_markdown
     end
 
+    # Reports Android app size violations given a valid AAB.
+    # @param [String, required] aab_path
+    #        Path to valid AAB file.
+    # @param [String, required] ks_path
+    #        Path to valid signing key file.
+    # @param [String, required] ks_alias
+    #        Alias of signing key
+    # @param [String, required] ks_password
+    #        Password of signing key
+    # @param [String, required] ks_alias_password
+    #        Alias Password of signing key.
+    # @param [Array, optional] screen_densities
+    #        Array of screen densities to check APK size
+    #        Default: ["MDPI", "HDPI", "XHDPI", "XXHDPI", "XXXHDPI"]
+    # @param [Array, optional] languages
+    #        Array of languages to check APK size
+    #        Default: ["en"]
+    # @param [String, optional] build_type
+    #        Specify whether the report corresponds to an App, Instant.
+    #        Default: 'App'
+    #        Supported values: 'App', 'Instant'
+    # @param [Numeric, optional] size_limit
+    #        Specify the app size limit.
+    #        Default: 150
+    # @param [String, optional] limit_unit
+    #        Specific the unit for the given size limit.
+    #        Default: 'MB'
+    #        Supported values: 'KB', 'MB', 'GB'
+    # @param [Boolean, optional] fail_on_warning
+    #        Specify whether the PR should fail if one or more app variants
+    #        exceed the given size limit. By default, the plugin issues
+    #        a warning in this case.
+    #        Default: 'false'
+    # @return   [void]
+    #
+    def flag_android_violations(aab_path, ks_path, ks_alias, ks_password, ks_alias_password, screen_densities: %w[MDPI HDPI XHDPI XXHDPI XXXHDPI], languages: ['en'], build_type: 'App', size_limit: 150, limit_unit: 'MB', fail_on_warning: false)
+      project_root = Dir.pwd
+      temp_path = "#{project_root}/temp"
+      apks_path = "#{temp_path}/output.apks"
+      size_csv_path = "#{temp_path}/output.csv"
+      bundletool_path = "#{temp_path}/bundletool.jar"
+      bundletool_version = '1.8.2'
+      variants_limit = 25
+
+      raise ArgumentError, "The 'build_type' argument only accepts the values \"App\" and \"Instant\"" unless %w[App Instant].include? build_type
+
+      raise ArgumentError, "The 'size_limit' argument only accepts numeric values" unless size_limit.is_a? Numeric
+
+      limit_unit.upcase!
+      raise ArgumentError, "The 'limit_unit' argument only accepts the values \"KB\", \"MB\" and \"GB\"" unless %w[KB MB GB].include? limit_unit
+
+      raise ArgumentError, "The 'fail_on_warning' argument only accepts the values 'true' and 'false'" unless [true, false].include? fail_on_warning
+
+      create_temp_dir(temp_path)
+
+      unless AndroidUtils.download_bundletool(bundletool_version, bundletool_path)
+        clean_temp!
+        return
+      end
+
+      AndroidUtils.generate_apks(aab_path, ks_path, ks_alias, ks_password, ks_alias_password, apks_path,
+                                 bundletool_path)
+      AndroidUtils.generate_estimated_sizes(apks_path, size_csv_path, bundletool_path, build_type)
+      filtered_sizes = AndroidUtils.filter_estimated_sizes(size_csv_path, screen_densities, languages)
+      sorted_sizes = AndroidUtils.sort_estimated_sizes(filtered_sizes)
+
+      clean_temp!(temp_path)
+
+      generate_android_size_report_markdown(sorted_sizes, build_type, size_limit, limit_unit, fail_on_warning,
+                                            variants_limit)
+      generate_ads_label_markdown
+    end
+
     # Returns a JSON string representation of the given App Thinning Size Report.
     # @param [String, required] report_path
     #        Path to valid App Thinning Size Report text file.
@@ -111,6 +247,96 @@ module Danger
 
     private
 
+    def create_temp_dir(temp_path)
+      Dir.mkdir temp_path
+    end
+
+    def clean_temp!(temp_path)
+      FileUtils.rm_rf(temp_path)
+    end
+
+    def generate_android_size_report_markdown(sorted_sizes, build_type, size_limit, limit_unit, fail_on_warning, variants_limit)
+      limit_size = MemorySize.new("#{size_limit}#{limit_unit}")
+
+      if build_type == 'Instant' && limit_size.megabytes > 4
+        message "The size limit was set to 4 MB as the given limit of #{size_limit} #{limit_unit} exceeds Android Instant App size restrictions"
+        size_limit = 4
+        limit_unit = 'MB'
+        limit_size.kilobytes = 4 * 1024
+      elsif build_type == 'App' && limit_size.megabytes > 150
+        message "The size limit was set to 150 MB as the given limit of #{size_limit} #{limit_unit} exceeds Android App size restrictions"
+        size_limit = 150
+        limit_unit = 'MB'
+        limit_size.kilobytes = 150 * 1024
+      end
+
+      violation_count = AndroidUtils.violations_count(sorted_sizes, limit_size.bytes)
+
+      if violation_count.positive?
+        if fail_on_warning
+          failure "The size limit of #{size_limit} #{limit_unit.upcase} has been exceeded by #{violation_count} variants"
+        else
+          warn "The size limit of #{size_limit} #{limit_unit.upcase} has been exceeded by #{violation_count} variants"
+        end
+      end
+
+      exceed_size_report = "| Under Limit | SDK | ABI | Screen Density | Language | Size (Bytes) |\n"
+      exceed_size_report << "| :-: | :-: | :-: | :-: | :-: | :-: |\n"
+
+      more_exceed_size_report = "| Under Limit | SDK | ABI | Screen Density | Language | Size (Bytes) |\n"
+      more_exceed_size_report << "| :-: | :-: | :-: | :-: | :-: | :-: |\n"
+
+      under_size_report = "| Under Limit | SDK | ABI | Screen Density | Language | Size (Bytes) |\n"
+      under_size_report << "| :-: | :-: | :-: | :-: | :-: | :-: |\n"
+
+      counter = sorted_sizes.length - 1
+      exceed_counter = 1
+      under_counter = 1
+
+      while counter >= 0
+        variant = sorted_sizes[counter]
+        is_violating = variant.max > limit_size.bytes ? '❌' : '✅'
+        variant_report = "#{is_violating} | #{variant.sdk} | #{variant.abi} | #{variant.screen_density} | #{variant.language} | #{variant.max} |\n"
+
+        if variant.max > limit_size.bytes
+          if exceed_counter <= variants_limit
+            exceed_counter += 1
+            exceed_size_report << variant_report
+          else
+            more_exceed_size_report << variant_report
+          end
+        elsif under_counter <= variants_limit
+          under_counter += 1
+          under_size_report << variant_report
+        end
+
+        counter -= 1
+      end
+
+      size_report = "# Android #{build_type} Size Report\n"
+      size_report << "### Size limit = #{size_limit} #{limit_unit.upcase}\n\n"
+
+      if violation_count.positive?
+        size_report << "## Variants exceeding the size limit\n\n"
+        size_report << exceed_size_report
+        size_report << "\n"
+
+        if violation_count > variants_limit
+          size_report << "<details>\n<summary>Click to view more violating variants!</summary>\n\n"
+          size_report << more_exceed_size_report
+          size_report << "</details>\n\n"
+        end
+      end
+
+      size_report << "## Variants under or equal to the size limit\n\n"
+      size_report << "<details>\n<summary>Click to expand!</summary>\n\n"
+
+      size_report << under_size_report
+      size_report << "</details>\n"
+
+      markdown size_report
+    end
+
     def generate_size_report_markdown(variants, build_type, size_limit, limit_unit, fail_on_warning)
       limit_size = MemorySize.new("#{size_limit}#{limit_unit}")
 
@@ -128,9 +354,7 @@ module Danger
 
       flagged_variant_names = []
       variants.each do |variant|
-        if variant.app_size.uncompressed.value > limit_size.megabytes || variant.on_demand_resources_size.uncompressed.value > limit_size.megabytes
-          flagged_variant_names.append(variant.variant)
-        end
+        flagged_variant_names.append(variant.variant) if variant.app_size.uncompressed.value > limit_size.megabytes || variant.on_demand_resources_size.uncompressed.value > limit_size.megabytes
       end
 
       if flagged_variant_names.length.positive?
@@ -178,7 +402,7 @@ module Danger
     end
 
     def generate_ads_label_markdown
-      ads_label = 'Powered by [danger-app_size_report](https://github.com/ChargePoint)'
+      ads_label = 'Powered by [danger-app_size_report](https://github.com/ChargePoint/danger-app_size_report)'
       markdown ads_label
     end
   end

data/lib/converter/helper/android_utils.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'open3'
+
+require_relative '../models/android_variant_model'
+
+# Used to obtain and parse Android app size information
+class AndroidUtils
+  def self.filter_estimated_sizes(path, screen_densities, languages)
+    filtered_sizes = []
+    CSV.foreach(path, headers: true) do |row|
+      sdk = row[AndroidVariant::PARSING_KEYS[:sdk]]
+      abi = row[AndroidVariant::PARSING_KEYS[:abi]]
+      screen_density = row[AndroidVariant::PARSING_KEYS[:screen_density]]
+      language = row[AndroidVariant::PARSING_KEYS[:language]]
+      texture_compression_format = row[AndroidVariant::PARSING_KEYS[:texture_compression_format]]
+      device_tire = row[AndroidVariant::PARSING_KEYS[:device_tire]]
+      min = row[AndroidVariant::PARSING_KEYS[:min]]
+      max = row[AndroidVariant::PARSING_KEYS[:max]]
+
+      if screen_densities.include?(screen_density) && languages.include?(language)
+        filtered_sizes << AndroidVariant.new(sdk, abi, screen_density, language, texture_compression_format,
+                                             device_tire, min, max)
+      end
+    end
+    filtered_sizes
+  end
+
+  def self.sort_estimated_sizes(size_arr)
+    size_arr.sort { |o1, o2| o1.max <=> o2.max }
+  end
+
+  def self.violations_count(sorted_arr, limit)
+    lb = -1
+    ub = sorted_arr.length
+    while ub - lb > 1
+      mid = (lb + ub) / 2
+      if sorted_arr[mid].max <= limit
+        lb = mid
+      else
+        ub = mid
+      end
+    end
+    sorted_arr.length - ub
+  end
+
+  def self.generate_apks(aab_path, ks_path, ks_alias, ks_password, ks_alias_password, apks_path, bundletool_path)
+    keystore_params = "--ks=\"#{ks_path}\" --ks-key-alias=\"#{ks_alias}\" --ks-pass=\"pass:#{ks_password}\" --key-pass=\"pass:#{ks_alias_password}\""
+    cmd = "java -jar #{bundletool_path} build-apks --bundle=\"#{aab_path}\" --output=\"#{apks_path}\" #{keystore_params}"
+    Open3.popen3(cmd) do |_, _, stderr, wait_thr|
+      exit_status = wait_thr.value
+      raise stderr.read unless exit_status.success?
+    end
+  end
+
+  def self.generate_estimated_sizes(apks_path, size_csv_path, bundletool_path, build_type)
+    bundletool_cmd = "java -jar #{bundletool_path} get-size total --apks=\"#{apks_path}\" --dimensions=ALL"
+    bundletool_cmd += ' --instant' if build_type == 'Instant'
+    cmd = "#{bundletool_cmd} > #{size_csv_path}"
+    Open3.popen3(cmd) do |_, _, stderr, wait_thr|
+      exit_status = wait_thr.value
+      raise stderr.read unless exit_status.success?
+    end
+  end
+
+  def self.download_bundletool(version, bundletool_path)
+    URI.open("https://github.com/google/bundletool/releases/download/#{version}/bundletool-all-#{version}.jar") do |bundletool|
+      File.binwrite(bundletool_path, bundletool.read)
+    end
+  rescue OpenURI::HTTPError
+    false
+  end
+end

data/lib/converter/helper/json_converter.rb

@@ -2,6 +2,7 @@
 
 require 'json'
 
+# Generate pretty JSON from list of variants
 class JSONConverter
   def to_json(_options = {})
     hash = {}

data/lib/converter/helper/memory_size.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: false
 
 require_relative '../helper/json_converter'
+# Defines memory size object to be used to parse the App Thinning Size Report
 class MemorySize < JSONConverter
   attr_accessor :kilobytes
 

data/lib/converter/helper/result_factory.rb

@@ -4,6 +4,7 @@ require_relative '../parser/variant_parser'
 require_relative '../parser/variant_descriptor_parser'
 require_relative '../parser/app_size_parser'
 
+# Used to parse sections of the App Thinning Size Report using different parsers
 class ResultFactory
   def self.parse(from_text: '', parser: nil)
     result = nil
@@ -16,15 +17,7 @@ class ResultFactory
       variant_descriptor_parser = VariantDescriptorParser.new(from_text)
       variant_descriptor_parser.parse
       result = variant_descriptor_parser.result
-    when :app_on_demand_resources_size
-      app_size_parser = AppSizeParser.new(from_text)
-      app_size_parser.parse
-      result = app_size_parser.result
-    when :app_size
-      app_size_parser = AppSizeParser.new(from_text)
-      app_size_parser.parse
-      result = app_size_parser.result
-    when :on_demand_resources_size
+    when :app_on_demand_resources_size, :app_size, :on_demand_resources_size
       app_size_parser = AppSizeParser.new(from_text)
       app_size_parser.parse
       result = app_size_parser.result

data/lib/converter/models/android_variant_model.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Android variant model
+class AndroidVariant
+  attr_reader :sdk, :abi, :screen_density, :language, :texture_compression_format, :device_tire, :min, :max
+
+  PARSING_KEYS = {
+    sdk: 'SDK',
+    abi: 'ABI',
+    screen_density: 'SCREEN_DENSITY',
+    language: 'LANGUAGE',
+    texture_compression_format: 'TEXTURE_COMPRESSION_FORMAT',
+    device_tire: 'DEVICE_TIER',
+    min: 'MIN',
+    max: 'MAX'
+  }.freeze
+
+  def initialize(sdk, abi, screen_density, language, texture_compression_format, device_tire, min, max)
+    @sdk = sdk
+    @abi = abi
+    @screen_density = screen_density
+    @language = language
+    @texture_compression_format = texture_compression_format
+    @device_tire = device_tire
+    @min = min.to_i
+    @max = max.to_i
+  end
+end

data/lib/converter/models/app_size_model.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative '../helper/json_converter'
+
+# App Size Model
+# @example 'App size: 6.6 MB compressed, 12.9 MB uncompressed'
 class AppSizeModel < JSONConverter
   attr_reader :compressed, :uncompressed
 
@@ -16,6 +19,7 @@ class AppSizeModel < JSONConverter
   end
 end
 
+# Size Model
 class SizeModel < JSONConverter
   attr_reader :raw_value, :value, :unit
 

data/lib/converter/models/device_model.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative '../helper/json_converter'
+
+# Device Model
+# @example 'device: iPhone10,3, os-version: 14.0'
 class DeviceModel < JSONConverter
   attr_reader :device, :os_version
 

data/lib/converter/models/variant_model.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative '../helper/json_converter'
+
+# Variant Model
 class VariantModel < JSONConverter
   attr_reader :variant, :supported_variant_descriptors, :app_on_demand_resources_size, :app_size,
               :on_demand_resources_size

data/lib/converter/parser/app_size_parser.rb

@@ -4,6 +4,7 @@ require_relative '../models/app_size_model'
 require_relative '../helper/memory_size'
 require_relative './model_parser'
 
+# Parser for App Size section of App Thinning Size Report
 class AppSizeParser < ModelParser
   attr_reader :standardized_unit
 

data/lib/converter/parser/model_parser.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: false
 
+# Parent class for parsers
 class ModelParser
   attr_reader :text, :result
 

data/lib/converter/parser/report_parser.rb

@@ -4,6 +4,7 @@ require 'securerandom'
 require_relative '../models/variant_model'
 require_relative '../helper/result_factory'
 
+# Parses App Thinning Size Report in its entirety
 class ReportParser
   def self.parse(text)
     splitter_id = SecureRandom.uuid

data/lib/converter/parser/variant_descriptor_parser.rb

@@ -4,6 +4,7 @@ require_relative '../models/device_model'
 require 'securerandom'
 require_relative './model_parser'
 
+# Parser for Variant descriptor section of App Thinning Size Report
 class VariantDescriptorParser < ModelParser
   def parse
     @text = @text.strip

data/lib/converter/parser/variant_parser.rb

@@ -2,6 +2,8 @@
 
 require_relative './model_parser'
 
+# Parse Variant section of App Thinning Size Report
+# @example 'Variant: ChargePointAppClip-35AD0331-EA57-4B82-B8E6-029D7786B9B7.ipa'
 class VariantParser < ModelParser
   def parse
     @text = @text.strip

data/spec/app_size_report_spec.rb

@@ -22,8 +22,8 @@ module Danger
         expect(json_string).to eq(expected_json)
       end
 
-      it 'Generates App Size Danger Report' do
-        @app_size_report.flag_violations(
+      it 'Generates IOS App Size Danger Report' do
+        @app_size_report.flag_ios_violations(
           "#{File.dirname(__dir__)}/Resources/App\ Thinning\ Size\ Report.txt",
           build_type: 'Clip',
           size_limit: 12,
@@ -32,6 +32,23 @@ module Danger
 
         expect(@dangerfile.status_report[:warnings]).to eq(['The size limit of 10 MB has been exceeded by one or more variants'])
       end
+
+      it 'Generates Android App Size Danger Report' do
+        @app_size_report.flag_android_violations(
+          "#{File.dirname(__dir__)}/Resources/app.aab",
+          "#{File.dirname(__dir__)}/Resources/testKey1",
+          'testKey1',
+          'testKey1',
+          'testKey1',
+          screen_densities: %w[MDPI HDPI XHDPI XXHDPI XXXHDPI],
+          languages: %w[en de da es fr it nb nl sv],
+          build_type: 'Instant',
+          size_limit: 1.459,
+          limit_unit: 'MB'
+        )
+
+        expect(@dangerfile.status_report[:warnings]).to eq(['The size limit of 1.459 MB has been exceeded by 18 variants'])
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -22,6 +22,7 @@ RSpec.configure do |config|
   config.filter_gems_from_backtrace 'bundler'
   config.color = true
   config.tty = true
+  config.formatter = :documentation
 end
 
 require 'danger_plugin'

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: danger-app_size_report
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Rishab Sukumar
+- Bharath Thakkallapally
+- Vido Shaweddy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -150,7 +152,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.1
-description: A Danger plugin for reporting iOS app size violations.
+description: A Danger plugin for reporting iOS and Android app size violations.
 email:
 - rishab.sukumar@chargepoint.com
 executables: []
@@ -158,6 +160,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -165,13 +168,19 @@ files:
 - README.md
 - Rakefile
 - Resources/App Thinning Size Report.txt
+- Resources/Images/android_instant_size_report.png
+- Resources/Images/app_thinning_size_report.png
+- Resources/app.aab
 - Resources/expectedReportJSON.json
+- Resources/testKey1
 - danger-app_size_report.gemspec
 - lib/app_size_report/gem_version.rb
 - lib/app_size_report/plugin.rb
+- lib/converter/helper/android_utils.rb
 - lib/converter/helper/json_converter.rb
 - lib/converter/helper/memory_size.rb
 - lib/converter/helper/result_factory.rb
+- lib/converter/models/android_variant_model.rb
 - lib/converter/models/app_size_model.rb
 - lib/converter/models/device_model.rb
 - lib/converter/models/variant_model.rb
@@ -187,7 +196,8 @@ files:
 homepage: https://github.com/ChargePoint/danger-app_size_report
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -196,7 +206,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -206,8 +216,9 @@ requirements: []
 rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
-summary: A Danger plugin for reporting iOS app size violations. A valid App Thinning
-  Size Report must be passed to the plugin for accurate functionality.
+summary: A Danger plugin for reporting iOS and Android app size violations. A valid
+  App Thinning Size Report or Android App Bundle must be passed to the plugin for
+  accurate functionality.
 test_files:
 - spec/app_size_report_spec.rb
 - spec/spec_helper.rb