danger-android_permissions_checker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26d593c45170d3f8e0d46bde541d8cefc81e5596c026cd58d6c1cf0c9254f930
-  data.tar.gz: a9f90f3673ba04bb47e51d3fdff462991fc0b375571520141ba4108764f8856a
+  metadata.gz: d3dfd424ff01cc47bc35d2a029331868bb399b8bd81a2987efcfc7022517bf63
+  data.tar.gz: 11b46f55ba9ed75a03d06bce4e9044e03c30d458744158246e00d1611ba3a88d
 SHA512:
-  metadata.gz: 5803cd6d6f55c62f8767d8cf08e1ccc89f3344bce3b4228dd32b8e36bc8f34f923b5982a300a45252b68aaed156d19c49e42cd96adbb01a850a805d8b348a410
-  data.tar.gz: ef06d442a6631b0f73646e14874f4ad18b4743aa5df45aeb66ea27f210aeab56e8f3efb694b170c083804cc78ea5522c474b6e945488f73a08286e4e26881fe7
+  metadata.gz: 33bdceb9b0d80317370b3d0f29f623a44c53575a46396141128808d4bc73630ad4da698e38e4aff4541ab7eee0f5ecaf5aa57e0da310643f2c09bf67dc5d7b9b
+  data.tar.gz: dda3f3d49fab08272cc73ef8ffd730be2aa05c59864e54c81276ff1b43d6957afbdd6def52983100ed230d2adfae83c333a57d413107d61a68921774ca3a72f5

data/ChangeLog.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+## v0.0.3
+
+- [Allow to specify report method](https://github.com/mataku/danger-android_permissions_checker/pull/2) by [@mathroule](https://github.com/mathroule)
+- [Use latest bundler](https://github.com/mataku/danger-android_permissions_checker/pull/3)
+
+## v0.0.2
+
+- [Notify to prefer to update list if permissions changed](https://github.com/mataku/danger-android_permissions_checker/pull/1)

data/README.md

@@ -8,7 +8,7 @@ A [Danger](https://danger.systems/ruby) plugin to check diff of android apk perm
 
 ## How to check
 
-Check permissions between current permissions and apk generated on CI service. if changed, show permissions which added or deleted.
+Check permissions between current permissions and apk generated on CI service. If changed, show permissions which added or deleted.
 
 ## Usage
 
@@ -18,7 +18,7 @@ Create current permission list file of your apk using aapt, like this.
 $ aapt d permissions /path/to/apk > permissions.txt
 ```
 
-Add this to Dangerfile. Specify apk generated by CI service and permission list file generated by above command.
+Add this to Dangerfile. Specify APK generated by CI service and permission list file generated by above command.
 
 ```
 android_permissions_checker.check(
@@ -27,10 +27,22 @@ android_permissions_checker.check(
 )
 ```
 
+To use specific report method (default is warn). Available options are: message, warn, fail.
+```
+android_permissions_checker.report_method = 'fail'
+android_permissions_checker.check(
+  apk: '/path/to/generated_apk_by_CI',
+  permission_list_file: /path/to/permissions.txt
+)
+```
+
 ## NOTE
 
 This gem uses `aapt`  command to parse permissions of generated apk, so you need to add /path/to/aapt (Android Build-tools) to $PATH on your CI service.
 
+## ChangeLog
+
+See [ChangeLog.md](https://github.com/mataku/danger-android_permissions_checker/blob/master/ChangeLog.md).
 
 ## Development
 

data/danger-android_permissions_checker.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
 
   # General ruby development
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '>= 1.3'
   spec.add_development_dependency 'rake', '~> 10.0'
 
   # Testing support

data/lib/android_permissions_checker/gem_version.rb

@@ -1,3 +1,3 @@
 module AndroidPermissionsChecker
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 end

data/lib/android_permissions_checker/plugin.rb

@@ -1,8 +1,39 @@
 module Danger
+  # Check permissions between current permissions and APK generated on CI service.
+  # If changed, show permissions which added or deleted.
+  #
+  # @example Running Android permissions checker with its basic configuration
+  #
+  #          android_permissions_checker.check(
+  #            apk: '/path/to/generated_apk_by_CI',
+  #            permission_list_file: /path/to/permissions.txt
+  #          )
+  #
+  # @example Running Android permissions checker with specific report method
+  #
+  #          android_permissions_checker.report_method = 'fail'
+  #          android_permissions_checker.check(
+  #            apk: '/path/to/generated_apk_by_CI',
+  #            permission_list_file: /path/to/permissions.txt
+  #          )
+  #
+  # @see mataku/danger-android_permissions_checker
+  # @tags android, permissions, apk
+
   class DangerAndroidPermissionsChecker < Plugin
+    REPORT_METHODS = %i(message warn fail).freeze
+
+    # *Optional*
+    # Set report method
+    #
+    # @return [String, Symbol] error by default
+    attr_accessor :report_method
+
+    # Calls permissions check.
+    # @return [void]
     def check(apk: nil, permission_list_file: nil)
       if apk.nil? || !File.exist?(apk)
-        raise "Can\'t find apk: #{apk}"
+        raise "Can't find apk: #{apk}"
       end
 
       if permission_list_file.nil? || !File.exist?(permission_list_file)
@@ -10,7 +41,12 @@ module Danger
       end
 
       unless system 'which aapt > /dev/null 2>&1'
-        raise 'Can\'t find required command: aapt. Set PATH to Android Build-tools.'
+        raise "Can't find required command: aapt. Set PATH to Android Build-tools."
+      end
+
+      @report_method = (report_method || :warn).to_sym
+      unless REPORT_METHODS.include?(report_method)
+        raise "Unknown report method: #{report_method}"
       end
 
       generated_permissions = `aapt d permissions #{apk}`.split("\n")
@@ -38,7 +74,7 @@ module Danger
 
       unless message.empty?
         markdown(message)
-        warn("APK permissions changed, see below. Should update `#{permission_list_file}` if it is intended change.")
+        send(report_method, "APK permissions changed, see below. Should update `#{permission_list_file}` if it is intended change.")
       end
     end
   end

data/spec/android_permissions_checker_spec.rb

@@ -52,7 +52,6 @@ module Danger
           expect(dangerfile.status_report[:warnings][0]).to eq("APK permissions changed, see below. Should update `#{current_permission_file}` if it is intended change.")
           expect(dangerfile.status_report[:markdowns][0].message).not_to include('Deleted')
           expect(dangerfile.status_report[:markdowns][0].message).to include('Added')
-
         end
       end
 
@@ -83,6 +82,68 @@ module Danger
           expect(dangerfile.status_report[:markdowns][0].message).to include('Added')
         end
       end
+
+      context 'Report method set to fail' do
+        let(:generated_permissions) do
+          "package: com.mataku.scrobscrob.dev\nuses-permission: name='android.permission.INTERNET'\nuses-permission: name='com.mataku.INTERNET'\n"
+        end
+
+        it 'should report errors' do
+          plugin.report_method = 'fail'
+          plugin.check(apk: apk, permission_list_file: current_permission_file)
+          expect(dangerfile.status_report[:errors].length).to eq(1)
+          expect(dangerfile.status_report[:errors][0]).to eq("APK permissions changed, see below. Should update `#{current_permission_file}` if it is intended change.")
+          expect(dangerfile.status_report[:messages].length).to eq(0)
+          expect(dangerfile.status_report[:warnings].length).to eq(0)
+          expect(dangerfile.status_report[:markdowns][0].message).not_to include('Deleted')
+          expect(dangerfile.status_report[:markdowns][0].message).to include('Added')
+        end
+      end
+
+      context 'Report method set to message' do
+        let(:generated_permissions) do
+          "package: com.mataku.scrobscrob.dev\nuses-permission: name='android.permission.INTERNET'\nuses-permission: name='com.mataku.INTERNET'\n"
+        end
+
+        it 'should report messages' do
+          plugin.report_method = 'message'
+          plugin.check(apk: apk, permission_list_file: current_permission_file)
+          expect(dangerfile.status_report[:errors].length).to eq(0)
+          expect(dangerfile.status_report[:messages].length).to eq(1)
+          expect(dangerfile.status_report[:messages][0]).to eq("APK permissions changed, see below. Should update `#{current_permission_file}` if it is intended change.")
+          expect(dangerfile.status_report[:warnings].length).to eq(0)
+          expect(dangerfile.status_report[:markdowns][0].message).not_to include('Deleted')
+          expect(dangerfile.status_report[:markdowns][0].message).to include('Added')
+        end
+      end
+
+      context 'Report method set to warn' do
+        let(:generated_permissions) do
+          "package: com.mataku.scrobscrob.dev\nuses-permission: name='android.permission.INTERNET'\nuses-permission: name='com.mataku.INTERNET'\n"
+        end
+
+        it 'should report warnings' do
+          plugin.report_method = 'warn'
+          plugin.check(apk: apk, permission_list_file: current_permission_file)
+          expect(dangerfile.status_report[:errors].length).to eq(0)
+          expect(dangerfile.status_report[:messages].length).to eq(0)
+          expect(dangerfile.status_report[:warnings].length).to eq(1)
+          expect(dangerfile.status_report[:warnings][0]).to eq("APK permissions changed, see below. Should update `#{current_permission_file}` if it is intended change.")
+          expect(dangerfile.status_report[:markdowns][0].message).not_to include('Deleted')
+          expect(dangerfile.status_report[:markdowns][0].message).to include('Added')
+        end
+      end
+
+      context 'Report method set to unknown' do
+        let(:generated_permissions) do
+          "package: com.mataku.scrobscrob.dev\nuses-permission: name='android.permission.INTERNET'\nuses-permission: name='com.mataku.INTERNET'\n"
+        end
+
+        it 'should fail' do
+          plugin.report_method = 'unknown'
+          expect { plugin.check(apk: apk, permission_list_file: current_permission_file) }.to raise_error("Unknown report method: unknown")
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-android_permissions_checker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - mataku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-26 00:00:00.000000000 Z
+date: 2020-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -28,14 +28,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -90,6 +90,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- ChangeLog.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -121,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A Danger plugin to check diff of android apk permissions.