danger-android_permissions_checker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fdf24f242e47cdb8747df24c5bd11582e1d39fc796c9b69594dd8557f7422be0
+  data.tar.gz: c4613888afe9b9d5cd19cd01ad8f899473f79361f8c012f9cb27523e15bcbb75
+SHA512:
+  metadata.gz: fd9a62832f25f7e35ecacd1540ffeceae187dc088f94856581cb890bcfee70f947073bcd8a6ce8a4220cee1b7d88d00ca912fd7cdcf3104eb0b54d3891478f69
+  data.tar.gz: 28fb881a56412ecebe8d938440f917a3cca6c03a3ca0ea42accce1cb74fad5b63d255b8fcd36bff633478018541c35c80b37d4bb766b09413117c9d49a884c35

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+pkg
+.idea/
+.yardoc
+vendor/
+.bundle/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,152 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  TargetRubyVersion: 2.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/IndentHash:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-android_permissions_checker.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018 Takuma Homma <nagomimatcha@gmail.com>
+
+MIT License
+
+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,40 @@
+# danger-android_permissions_checker
+
+A [Danger](https://danger.systems/ruby) plugin to check diff of android apk permissions.
+
+## Installation
+
+    $ gem install danger-android_permissions_checker
+
+## How to check
+
+Check permissions between current permissions and apk generated on CI service. if changed, show permissions which added or deleted.
+
+## Usage
+
+Create permission list file of your apk using aapt, like this.
+
+```bash
+$ aapt d permissions /path/to/release_apk > permissions.txt
+```
+
+Add this to Dangerfile. Specify apk generated by CI service and permission list file generated by above command.
+
+```
+android_permissions_checker.check(
+  apk: '/path/to/generated_apk_by_CI',
+  permission_list_file: /path/to/generated_permission_list
+)
+```
+
+## 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.
+
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Make your changes.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-android_permissions_checker.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'android_permissions_checker/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-android_permissions_checker'
+  spec.version       = AndroidPermissionsChecker::VERSION
+  spec.authors       = ['mataku']
+  spec.email         = ['sfprhythnn@gmail.com']
+  spec.description   = %q{A Danger plugin to check diff of android apk permissions.}
+  spec.summary       = %q{A Danger plugin to check diff of android apk permissions.}
+  spec.homepage      = 'https://github.com/mataku/danger-android_permissions_checker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'pry'
+end

data/lib/android_permissions_checker/gem_version.rb

@@ -0,0 +1,3 @@
+module AndroidPermissionsChecker
+  VERSION = "0.0.1".freeze
+end

data/lib/android_permissions_checker/plugin.rb

@@ -0,0 +1,47 @@
+require 'fileutils'
+
+module Danger
+  class DangerAndroidPermissionsChecker < Plugin
+    def check(apk: nil, permission_list_file: nil)
+      if apk.nil? || !File.exist?(apk)
+        raise "Can\'t find apk: #{apk}"
+      end
+
+      if permission_list_file.nil? || !File.exist?(permission_list_file)
+        raise "Can't find permission list file: #{permission_list_file}\n"
+      end
+
+      unless system 'which aapt > /dev/null 2>&1'
+        raise 'Can\'t find required command: aapt. Set PATH to Android Build-tools.'
+      end
+
+      generated_permissions = `aapt d permissions #{apk}`.split("\n")
+      current_permissions = File.open(permission_list_file).readlines.map(&:chomp)
+
+      deleted = current_permissions - generated_permissions
+      added = generated_permissions - current_permissions
+      message = ""
+      
+      if deleted.length > 0
+        message += "### Deleted permissions\n"
+        deleted.each do |v|
+          message += "- #{v}\n"
+        end
+        message += "\n"
+      end
+
+      if added.length > 0
+        message += "### Added Permissions\n"
+
+        added.each do |v|
+          message += "- #{v}\n"
+        end
+      end
+
+      unless message.empty?
+        markdown(message)
+        warn('APK permissions changed, see below.')
+      end
+    end
+  end
+end

data/lib/danger_android_permissions_checker.rb

@@ -0,0 +1 @@
+require "android_permissions_checker/gem_version"

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require "android_permissions_checker/plugin"

data/spec/android_permissions_checker_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+module Danger
+  describe Danger::DangerAndroidPermissionsChecker do
+    let(:dangerfile) { testing_dangerfile }
+    let(:plugin) { dangerfile.android_permissions_checker }
+    
+    it "should be a plugin" do
+      expect(Danger::DangerAndroidPermissionsChecker.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe "#check" do
+
+      let(:tmp_file) { '/tmp/permissions.txt' }
+      let(:current_permission_file) { 'permissions.txt' }
+      let(:apk) { '/tmp/app.apk' }
+      let(:aapt_command) { "aapt d permissions #{apk}" }
+      let(:generated_permissions) do
+        "package: com.mataku.scrobscrob.dev\nuses-permission: name='android.permission.INTERNET'\n"
+      end
+
+      let(:current_permission_list) do
+        [
+          "package: com.mataku.scrobscrob.dev\n",
+          "uses-permission: name='android.permission.INTERNET'\n"
+        ]
+      end
+
+      before do
+        allow(current_permission_file).to receive(:nil?).and_return(false) 
+        allow(apk).to receive(:nil?).and_return(false)
+        allow(File).to receive(:exist?).with(current_permission_file).and_return(true)
+        allow(File).to receive(:exist?).with(apk).and_return(true)
+        allow_any_instance_of(Kernel).to receive(:system).with('which aapt > /dev/null 2>&1').and_return(true)
+        allow_any_instance_of(Kernel).to receive(:`).with(aapt_command).and_return(generated_permissions)
+        allow(File).to receive_message_chain(:open, :readlines).with(current_permission_file).with(no_args).and_return(current_permission_list)
+      end
+
+      it do
+        plugin.check(apk: apk, permission_list_file: current_permission_file)
+        expect(dangerfile.status_report[:warnings].length).to eq(0)
+      end
+
+      context 'Permission added' 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 do
+          plugin.check(apk: apk, permission_list_file: current_permission_file)
+          expect(dangerfile.status_report[:warnings].length).to eq(1)
+          expect(dangerfile.status_report[:warnings][0]).to eq('APK permissions changed, see below.')
+          expect(dangerfile.status_report[:markdowns][0].message).not_to include('Deleted')
+          expect(dangerfile.status_report[:markdowns][0].message).to include('Added')
+
+        end
+      end
+
+      context 'Permission deleted' do
+        let(:generated_permissions) do
+          "package: com.mataku.scrobscrob.dev\n"
+        end
+
+        it do
+          plugin.check(apk: apk, permission_list_file: current_permission_file)
+          expect(dangerfile.status_report[:warnings].length).to eq(1)
+          expect(dangerfile.status_report[:warnings][0]).to eq('APK permissions changed, see below.')
+          expect(dangerfile.status_report[:markdowns][0].message).to include('Deleted')
+          expect(dangerfile.status_report[:markdowns][0].message).not_to include('Added')
+        end
+      end
+
+      context 'Permission added' do
+        let(:generated_permissions) do
+          "package: com.mataku.scrobscrob.dev\nuses-permission: name='com.mataku.INTERNET'"
+        end
+
+        it do
+          plugin.check(apk: apk, permission_list_file: current_permission_file)
+          expect(dangerfile.status_report[:warnings].length).to eq(1)
+          expect(dangerfile.status_report[:warnings][0]).to eq('APK permissions changed, see below.')
+          expect(dangerfile.status_report[:markdowns][0].message).to include('Deleted')
+          expect(dangerfile.status_report[:markdowns][0].message).to include('Added')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require "pathname"
+ROOT = Pathname.new(File.expand_path("../../", __FILE__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ''
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: danger-android_permissions_checker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mataku
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  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
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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'
+description: A Danger plugin to check diff of android apk permissions.
+email:
+- sfprhythnn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-android_permissions_checker.gemspec
+- lib/android_permissions_checker/gem_version.rb
+- lib/android_permissions_checker/plugin.rb
+- lib/danger_android_permissions_checker.rb
+- lib/danger_plugin.rb
+- spec/android_permissions_checker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mataku/danger-android_permissions_checker
+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.6
+signing_key: 
+specification_version: 4
+summary: A Danger plugin to check diff of android apk permissions.
+test_files:
+- spec/android_permissions_checker_spec.rb
+- spec/spec_helper.rb