danger-spotbugs 0.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('..', __dir__))
+$LOAD_PATH.unshift("#{ROOT}lib".to_s)
+$LOAD_PATH.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

data/spec/spotbugs_spec.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require File.expand_path('spec_helper', __dir__)
+
+module Danger
+  describe Danger::DangerSpotbugs do
+    it 'should be a plugin' do
+      expect(Danger::DangerSpotbugs.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @spotbugs = @dangerfile.spotbugs
+      end
+
+      it 'Check default Gradle task' do
+        expect(@spotbugs.gradle_task).to eq('spotbugsRelease')
+      end
+
+      it 'Set custom Gradle task' do
+        @spotbugs.gradle_task = 'spotbugsDebug'
+        expect(@spotbugs.gradle_task).to eq('spotbugsDebug')
+      end
+
+      it 'Check default skip Gradle task' do
+        expect(@spotbugs.skip_gradle_task).to be_falsey
+      end
+
+      it 'Set custom skip Gradle task' do
+        @spotbugs.skip_gradle_task = true
+        expect(@spotbugs.skip_gradle_task).to be_truthy
+      end
+
+      it 'Check default root path' do
+        expect(@spotbugs.root_path).to eq(Dir.pwd)
+      end
+
+      it 'Set custom root path' do
+        @spotbugs.root_path = '/Users/developer/project'
+        expect(@spotbugs.root_path).to eq('/Users/developer/project')
+      end
+
+      it 'Report with report file' do
+        # noinspection RubyLiteralArrayInspection
+        target_files = [
+          'app/src/main/java/com/github/sample/tools/Tools.java',
+          'app/src/main/java/com/github/sample/MainActivity.java',
+          'app/src/main/java/com/github/sample/model/Message.java',
+          'app/src/main/java/com/github/sample/model/User.java',
+          'app/src/main/java/com/github/sample/view/ConversationAdapter.java'
+        ]
+        allow_any_instance_of(Danger::DangerSpotbugs).to receive(:target_files).and_return(target_files)
+
+        @spotbugs.report_file = 'spec/fixtures/spotbugs_report.xml'
+        @spotbugs.root_path = '/Users/developer/project/sample/'
+        @spotbugs.skip_gradle_task = true
+
+        spotbugs_issues = @spotbugs.report
+        expect(spotbugs_issues).not_to be_nil
+        expect(spotbugs_issues.length).to be(7)
+
+        spotbugs_issue1 = spotbugs_issues[0]
+        expect(spotbugs_issue1.rank).to eq(6)
+        expect(spotbugs_issue1.line).to eq(29)
+        expect(spotbugs_issue1.type).to eq(:warn)
+        expect(spotbugs_issue1.absolute_path).to eq('/Users/developer/project/sample/app/src/main/java/com/github/sample/MainActivity.java')
+        expect(spotbugs_issue1.relative_path).to eq('app/src/main/java/com/github/sample/MainActivity.java')
+        expect(spotbugs_issue1.description).to eq('Possible null pointer dereference of MainActivity.conversationAdapter in com.github.sample.MainActivity.onCreate(Bundle)')
+
+        spotbugs_issue2 = spotbugs_issues[1]
+        expect(spotbugs_issue2.rank).to eq(6)
+        expect(spotbugs_issue2.line).to eq(31)
+        expect(spotbugs_issue2.type).to eq(:warn)
+        expect(spotbugs_issue2.absolute_path).to eq('/Users/developer/project/sample/app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue2.relative_path).to eq('app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue2.description).to eq('Possible null pointer dereference of Tools$Helper.string in com.github.sample.tools.Tools$Helper.setText(TextView)')
+
+        spotbugs_issue3 = spotbugs_issues[2]
+        expect(spotbugs_issue3.rank).to eq(8)
+        expect(spotbugs_issue3.line).to eq(32)
+        expect(spotbugs_issue3.type).to eq(:warn)
+        expect(spotbugs_issue3.absolute_path).to eq('/Users/developer/project/sample/app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue3.relative_path).to eq('app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue3.description).to eq('Read of unwritten field title in com.github.sample.tools.Tools$Helper.setText(TextView)')
+
+        spotbugs_issue4 = spotbugs_issues[3]
+        expect(spotbugs_issue4.rank).to eq(18)
+        expect(spotbugs_issue4.line).to eq(23)
+        expect(spotbugs_issue4.type).to eq(:warn)
+        expect(spotbugs_issue4.absolute_path).to eq('/Users/developer/project/sample/app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue4.relative_path).to eq('app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue4.description).to eq('Should com.github.sample.tools.Tools$Helper be a _static_ inner class?')
+
+        spotbugs_issue5 = spotbugs_issues[4]
+        expect(spotbugs_issue5.rank).to eq(12)
+        expect(spotbugs_issue5.line).to eq(32)
+        expect(spotbugs_issue5.type).to eq(:warn)
+        expect(spotbugs_issue5.absolute_path).to eq('/Users/developer/project/sample/app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue5.relative_path).to eq('app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue5.description).to eq('Unwritten field: com.github.sample.tools.Tools$Helper.title')
+
+        spotbugs_issue6 = spotbugs_issues[5]
+        expect(spotbugs_issue6.rank).to eq(18)
+        expect(spotbugs_issue6.line).to eq(15)
+        expect(spotbugs_issue6.type).to eq(:warn)
+        expect(spotbugs_issue6.absolute_path).to eq('/Users/developer/project/sample/app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue6.relative_path).to eq('app/src/main/java/com/github/sample/tools/Tools.java')
+        expect(spotbugs_issue6.description).to eq('Should com.github.sample.tools.Tools$Other be a _static_ inner class?')
+
+        spotbugs_issue7 = spotbugs_issues[6]
+        expect(spotbugs_issue7.rank).to eq(5)
+        expect(spotbugs_issue7.line).to eq(32)
+        expect(spotbugs_issue7.type).to eq(:warn)
+        expect(spotbugs_issue7.absolute_path).to eq('/Users/developer/project/sample/app/src/main/java/com/github/sample/view/ConversationAdapter.java')
+        expect(spotbugs_issue7.relative_path).to eq('app/src/main/java/com/github/sample/view/ConversationAdapter.java')
+        expect(spotbugs_issue7.description).to eq('Bad comparison of nonnegative value with -1 in com.github.sample.view.ConversationAdapter.setConversations(ArrayList)')
+      end
+
+      it 'Report with report file not in target files' do
+        # noinspection RubyLiteralArrayInspection
+        target_files = [
+          'app/src/main/java/com/github/sample/MainActivity.java',
+          'app/src/main/java/com/github/sample/model/Message.java',
+          'app/src/main/java/com/github/sample/model/User.java',
+          'app/src/main/java/com/github/sample/view/ConversationAdapter.java'
+        ]
+        allow_any_instance_of(Danger::DangerSpotbugs).to receive(:target_files).and_return(target_files)
+
+        @spotbugs.report_file = 'spec/fixtures/spotbugs_report.xml'
+        @spotbugs.root_path = '/Users/developer/project/sample/'
+        @spotbugs.skip_gradle_task = true
+
+        spotbugs_issues = @spotbugs.report
+        expect(spotbugs_issues).not_to be_nil
+        expect(spotbugs_issues.length).to be(2)
+
+        spotbugs_issue1 = spotbugs_issues[0]
+        expect(spotbugs_issue1.rank).to eq(6)
+        expect(spotbugs_issue1.line).to eq(29)
+        expect(spotbugs_issue1.type).to eq(:warn)
+        expect(spotbugs_issue1.absolute_path).to eq('/Users/developer/project/sample/app/src/main/java/com/github/sample/MainActivity.java')
+        expect(spotbugs_issue1.relative_path).to eq('app/src/main/java/com/github/sample/MainActivity.java')
+        expect(spotbugs_issue1.description).to eq('Possible null pointer dereference of MainActivity.conversationAdapter in com.github.sample.MainActivity.onCreate(Bundle)')
+
+        spotbugs_issue2 = spotbugs_issues[1]
+        expect(spotbugs_issue2.rank).to eq(5)
+        expect(spotbugs_issue2.line).to eq(32)
+        expect(spotbugs_issue2.type).to eq(:warn)
+        expect(spotbugs_issue2.absolute_path).to eq('/Users/developer/project/sample/app/src/main/java/com/github/sample/view/ConversationAdapter.java')
+        expect(spotbugs_issue2.relative_path).to eq('app/src/main/java/com/github/sample/view/ConversationAdapter.java')
+        expect(spotbugs_issue2.description).to eq('Bad comparison of nonnegative value with -1 in com.github.sample.view.ConversationAdapter.setConversations(ArrayList)')
+      end
+
+      it 'Report without Gradle' do
+        allow_any_instance_of(Danger::DangerSpotbugs).to receive(:target_files).and_return([])
+
+        @spotbugs.report_file = 'spec/fixtures/spotbugs_report.xml'
+        @spotbugs.skip_gradle_task = false
+
+        expect { @spotbugs.report }.to raise_error('Could not find `gradlew` inside current directory')
+      end
+
+      it 'Report without existing report file' do
+        allow_any_instance_of(Danger::DangerSpotbugs).to receive(:target_files).and_return([])
+
+        @spotbugs.report_file = 'spec/fixtures/custom/spotbugs_report.xml'
+        @spotbugs.skip_gradle_task = true
+
+        expect { @spotbugs.report }.to raise_error('Could not find matching SpotBugs report files for ["spec/fixtures/custom/spotbugs_report.xml"] inside current directory')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,249 @@
+--- !ruby/object:Gem::Specification
+name: danger-spotbugs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mathieu Rul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-23 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: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.14
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.2
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: A Danger plugin for SpotBugs.
+email:
+- mathroule@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- danger-spotbugs.gemspec
+- lib/danger_plugin.rb
+- lib/danger_spotbugs.rb
+- lib/spotbugs/entity/bug_instance.rb
+- lib/spotbugs/gem_version.rb
+- lib/spotbugs/plugin.rb
+- spec/entity/bug_instance_spec.rb
+- spec/fixtures/spotbugs_report.xml
+- spec/spec_helper.rb
+- spec/spotbugs_spec.rb
+homepage: https://github.com/mathroule/danger-spotbugs
+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: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A Danger plugin for SpotBugs, see https://spotbugs.github.io.
+test_files:
+- spec/entity/bug_instance_spec.rb
+- spec/fixtures/spotbugs_report.xml
+- spec/spec_helper.rb
+- spec/spotbugs_spec.rb