danger-warnings 0.0.1 → 0.1.0

data/spec/helper/severity_util_spec.rb

@@ -0,0 +1,70 @@
+require_relative '../spec_helper'
+require_relative '../../lib/warnings/helper/severity_util'
+
+module Warnings
+  describe SeverityUtil do
+    context 'rcwef_short' do
+      it 'maps unknown to low' do
+        expect(SeverityUtil.rcwef_short('U000')).to eq(SeverityUtil::LOW)
+        expect(SeverityUtil.rcwef_short('u000')).to eq(SeverityUtil::LOW)
+      end
+
+      it 'maps R/r to low' do
+        expect(SeverityUtil.rcwef_short('R000')).to eq(SeverityUtil::LOW)
+        expect(SeverityUtil.rcwef_short('r000')).to eq(SeverityUtil::LOW)
+      end
+
+      it 'maps C/c to low' do
+        expect(SeverityUtil.rcwef_short('C000')).to eq(SeverityUtil::LOW)
+        expect(SeverityUtil.rcwef_short('c000')).to eq(SeverityUtil::LOW)
+      end
+
+      it 'maps W/w to medium' do
+        expect(SeverityUtil.rcwef_short('W000')).to eq(SeverityUtil::MEDIUM)
+        expect(SeverityUtil.rcwef_short('w000')).to eq(SeverityUtil::MEDIUM)
+      end
+
+      it 'maps E/e to high' do
+        expect(SeverityUtil.rcwef_short('E000')).to eq(SeverityUtil::HIGH)
+        expect(SeverityUtil.rcwef_short('e000')).to eq(SeverityUtil::HIGH)
+      end
+
+      it 'maps F/f to high' do
+        expect(SeverityUtil.rcwef_short('F000')).to eq(SeverityUtil::HIGH)
+        expect(SeverityUtil.rcwef_short('f000')).to eq(SeverityUtil::HIGH)
+      end
+    end
+
+    context 'rcwef_full' do
+      it 'maps unknown to low' do
+        expect(SeverityUtil.rcwef_short('Unknown')).to eq(SeverityUtil::LOW)
+        expect(SeverityUtil.rcwef_short('unknown')).to eq(SeverityUtil::LOW)
+      end
+
+      it 'maps Refactor/refactor to low' do
+        expect(SeverityUtil.rcwef_short('Refactor')).to eq(SeverityUtil::LOW)
+        expect(SeverityUtil.rcwef_short('refactor')).to eq(SeverityUtil::LOW)
+      end
+
+      it 'maps Convention/convention to low' do
+        expect(SeverityUtil.rcwef_short('Convention')).to eq(SeverityUtil::LOW)
+        expect(SeverityUtil.rcwef_short('convention')).to eq(SeverityUtil::LOW)
+      end
+
+      it 'maps Warning/warning to medium' do
+        expect(SeverityUtil.rcwef_short('Warning')).to eq(SeverityUtil::MEDIUM)
+        expect(SeverityUtil.rcwef_short('warning')).to eq(SeverityUtil::MEDIUM)
+      end
+
+      it 'maps Error/error to high' do
+        expect(SeverityUtil.rcwef_short('Error')).to eq(SeverityUtil::HIGH)
+        expect(SeverityUtil.rcwef_short('error')).to eq(SeverityUtil::HIGH)
+      end
+
+      it 'maps Fatal/fatal to high' do
+        expect(SeverityUtil.rcwef_short('Fatal')).to eq(SeverityUtil::HIGH)
+        expect(SeverityUtil.rcwef_short('fatal')).to eq(SeverityUtil::HIGH)
+      end
+    end
+  end
+end

data/spec/parser/bandit_parser_spec.rb

@@ -3,31 +3,10 @@ require_relative '../../lib/warnings/parser/bandit_parser'
 
 module Warnings
   describe BanditParser do
-    FIRST_ISSUE = {
-      code: "2852         except ImportError:\n2853             import pickle\n2854         with open(filename, 'wb') as outf:\n",
-      filename: 'example/ply/yacc_1.py',
-      issue_confidence: 'HIGH',
-      issue_severity: :low,
-      issue_text: 'Consider possible security implications associated with pickle module.',
-      line_number: 2853,
-      line_range: [
-        2853
-      ],
-      more_info: 'https://bandit.readthedocs.io/en/latest/blacklists/blacklist_imports.html#b403-import-pickle',
-      test_id: 'B403',
-      test_name: 'blacklist'
-    }.freeze
-
     before do
       @parser = BanditParser.new
     end
 
-    context '#file_types' do
-      it 'include json' do
-        expect(@parser.file_types).to include(:json)
-      end
-    end
-
     context '#parse' do
       describe 'json' do
         context 'filled results' do
@@ -42,28 +21,24 @@ module Warnings
             expect(@parser.issues.count).to eq(3)
           end
 
-          it 'maps name' do
-            expect(@issue.file_name).to eq(FIRST_ISSUE[:filename])
+          it 'maps filename' do
+            expect(@issue.file_name).to eq(Assets::BANDIT_FIRST_ISSUE[:filename])
           end
 
-          it 'maps id' do
-            expect(@issue.id).to eq(FIRST_ISSUE[:test_id])
+          it 'maps id-name' do
+            expect(@issue.category).to eq("#{Assets::BANDIT_FIRST_ISSUE[:test_id]}-#{Assets::BANDIT_FIRST_ISSUE[:test_name]}")
           end
 
           it 'maps line' do
-            expect(@issue.line).to eq(FIRST_ISSUE[:line_number])
+            expect(@issue.line).to eq(Assets::BANDIT_FIRST_ISSUE[:line_number])
           end
 
           it 'maps severity' do
-            expect(@issue.severity).to eq(FIRST_ISSUE[:issue_severity])
+            expect(@issue.severity).to eq(Assets::BANDIT_FIRST_ISSUE[:issue_severity])
           end
 
           it 'maps message' do
-            expect(@issue.message).to eq(FIRST_ISSUE[:issue_text])
-          end
-
-          it 'maps name' do
-            expect(@issue.name).to eq(FIRST_ISSUE[:test_name])
+            expect(@issue.message).to eq(Assets::BANDIT_FIRST_ISSUE[:issue_text])
           end
         end
 
@@ -91,10 +66,7 @@ module Warnings
       describe 'unsupported type' do
         it 'raises error' do
           file_name = 'hello.txt'
-          ext = File.extname(file_name).delete('.')
-          expect { @parser.parse(file_name) }.to raise_error(format(Parser::ERROR_EXT_NOT_SUPPORTED,
-                                                                    ext,
-                                                                    @parser.class.name))
+          expect { @parser.parse(file_name) }.to raise_error(format(Parser::ERROR_EXT_NOT_JSON, file_name))
         end
       end
     end

data/spec/parser/parser_factory_spec.rb

@@ -16,18 +16,30 @@ module Warnings
         expect { ParserFactory.create('unknown') }.to raise_error('Parser \'unknown\' not supported.')
       end
 
-      context 'bandit' do
-        it 'symbol' do
-          result = ParserFactory.create(:bandit)
-          expect(result).not_to be_nil
-          expect(result).to be_a(BanditParser)
-        end
-
-        it 'string' do
-          result = ParserFactory.create('bandit')
-          expect(result).not_to be_nil
-          expect(result).to be_a(BanditParser)
-        end
+      it 'known symbol' do
+        expect(ParserFactory.create(:bandit)).to be_a(BanditParser)
+      end
+
+      it 'known string' do
+        expect(ParserFactory.create('bandit')).to be_a(BanditParser)
+      end
+
+      it 'bandit' do
+        result = ParserFactory.create(:bandit)
+        expect(result).not_to be_nil
+        expect(result).to be_a(BanditParser)
+      end
+
+      it 'pylint' do
+        result = ParserFactory.create(:pylint)
+        expect(result).not_to be_nil
+        expect(result).to be_a(PylintParser)
+      end
+
+      it 'rubocop' do
+        result = ParserFactory.create(:rubocop)
+        expect(result).not_to be_nil
+        expect(result).to be_a(RubocopParser)
       end
     end
   end

data/spec/parser/pylint_parser_spec.rb

@@ -0,0 +1,57 @@
+require_relative '../spec_helper'
+require_relative '../../lib/warnings/parser/pylint_parser'
+
+module Warnings
+  describe PylintParser do
+    before do
+      @parser = PylintParser.new
+    end
+
+    context '#parse' do
+      context 'filled results' do
+        before do
+          @parser.parse(Assets::PYLINT_TXT)
+          @issue = @parser.issues.first
+        end
+
+        it 'parses issues' do
+          expect(@parser.issues).not_to be_empty
+        end
+
+        it 'maps filename' do
+          expect(@issue.file_name).to eq(Assets::PYLINT_FIRST_ISSUE[:filename])
+        end
+
+        it 'maps id' do
+          expect(@issue.category).to eq(Assets::PYLINT_FIRST_ISSUE[:category])
+        end
+
+        it 'maps line' do
+          expect(@issue.line).to eq(Assets::PYLINT_FIRST_ISSUE[:line])
+        end
+
+        it 'maps message' do
+          expect(@issue.message).to eq(Assets::PYLINT_FIRST_ISSUE[:message])
+        end
+
+        it 'maps severity' do
+          expect(@issue.severity).to eq(:high)
+        end
+      end
+
+      context 'empty file' do
+        it 'has no issues' do
+          @parser.parse(Assets::EMPTY_FILE)
+          expect(@parser.issues).to be_empty
+        end
+      end
+
+      context 'missing file' do
+        it 'raises error' do
+          file_name = 'invalid'
+          expect { @parser.parse(file_name) }.to raise_error(format(Parser::ERROR_FILE_NOT_EXIST, file_name))
+        end
+      end
+    end
+  end
+end

data/spec/parser/rubocop_parser_spec.rb

@@ -0,0 +1,94 @@
+require_relative '../spec_helper'
+require_relative '../../lib/warnings/parser/rubocop_parser'
+
+module Warnings
+  describe RubocopParser do
+    before do
+      @parser = RubocopParser.new
+    end
+
+    context '#parse' do
+      context 'json' do
+        context 'default' do
+          before do
+            @parser.parse(Assets::RUBOCOP_JSON)
+            @issue = @parser.issues.first
+            @first_issue_offense = Assets::RUBOCOP_FIRST_ISSUE[:offenses].first
+          end
+
+          it 'parses issues' do
+            expect(@parser.issues).not_to be_empty
+          end
+
+          it 'maps path' do
+            expect(@issue.file_name).to eq(Assets::RUBOCOP_FIRST_ISSUE[:path])
+          end
+
+          it 'maps category' do
+            expect(@issue.category).to eq(@first_issue_offense[:cop_name])
+          end
+
+          it 'maps line' do
+            expect(@issue.line).to eq(@first_issue_offense[:location][:line])
+          end
+
+          it 'maps message' do
+            expect(@issue.message).to eq(@first_issue_offense[:message])
+          end
+
+          it 'maps severity' do
+            expect(@issue.severity).to eq(:low)
+          end
+        end
+
+        context 'multiple offenses' do
+          it 'parses multiple offenses' do
+            @parser.parse(Assets::RUBOCOP_MULTI_JSON)
+            expect(@parser.issues.count).to eq(11)
+          end
+        end
+
+        context 'empty issues' do
+          it 'has no issues' do
+            @parser.parse(Assets::EMPTY_FILE)
+            expect(@parser.issues).to be_empty
+          end
+        end
+      end
+
+      context 'simple' do
+        context 'default' do
+          before do
+            @parser.parse(Assets::RUBOCOP_SIMPLE)
+            @issue = @parser.issues.first
+            @first_issue_offense = Assets::RUBOCOP_FIRST_ISSUE[:offenses].first
+          end
+
+          it 'parses issues' do
+            expect(@parser.issues).not_to be_empty
+          end
+
+          it 'maps path' do
+            expect(@issue.file_name).to eq(Assets::RUBOCOP_FIRST_ISSUE[:path])
+          end
+
+          it 'maps category' do
+            expect(@issue.category).to be_nil
+          end
+
+          it 'maps line' do
+            expect(@issue.line).to eq(@first_issue_offense[:location][:line])
+          end
+
+          it 'maps message' do
+            expect(@issue.message).to eq(@first_issue_offense[:message])
+          end
+
+          it 'maps severity' do
+            expect(@issue.severity).to eq(:low)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/{reporter_spec.rb → report/reporter_spec.rb}

@@ -1,5 +1,5 @@
-require_relative 'spec_helper'
-require_relative '../lib/warnings/reporter'
+require_relative '../spec_helper'
+require_relative '../../lib/warnings/report/reporter'
 require 'danger'
 
 module Warnings
@@ -251,5 +251,45 @@ module Warnings
         end
       end
     end
+
+    context 'bandit' do
+      it 'runs markdown' do
+        @reporter.inline = false
+        @reporter.filter = false
+        @reporter.parser = :bandit
+        @reporter.file = Assets::BANDIT_JSON
+        @reporter.report
+        expect(@dangerfile.status_report[:markdowns]).not_to be_empty
+      end
+
+      it 'runs inline' do
+        @reporter.inline = true
+        @reporter.filter = false
+        @reporter.parser = :bandit
+        @reporter.file = Assets::BANDIT_JSON
+        @reporter.report
+        expect(@dangerfile.status_report[:warnings]).not_to be_empty
+      end
+    end
+
+    context 'pylint' do
+      it 'runs markdown' do
+        @reporter.inline = false
+        @reporter.filter = false
+        @reporter.parser = :pylint
+        @reporter.file = Assets::PYLINT_TXT
+        @reporter.report
+        expect(@dangerfile.status_report[:markdowns]).not_to be_empty
+      end
+
+      it 'runs inline' do
+        @reporter.inline = true
+        @reporter.filter = false
+        @reporter.parser = :pylint
+        @reporter.file = Assets::PYLINT_TXT
+        @reporter.report
+        expect(@dangerfile.status_report[:warnings]).not_to be_empty
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ require 'danger'
 require 'mocha'
 require 'simplecov'
 
-require_relative 'assets/assets'
+require_relative 'spec_helper/assets'
 
 SimpleCov.start
 

data/spec/spec_helper/assets.rb

@@ -0,0 +1,53 @@
+module Warnings
+  module Assets
+    ASSETS_DIR = Pathname.new(File.expand_path('../assets', __dir__))
+    EMPTY_FILE = "#{ASSETS_DIR}/empty.txt".freeze
+
+    BANDIT_JSON = "#{ASSETS_DIR}/bandit.json".freeze
+    BANDIT_EMPTY = "#{ASSETS_DIR}/bandit_empty.json".freeze
+    BANDIT_MISSING_RESULTS = "#{ASSETS_DIR}/bandit_missing_results.json".freeze
+    PYLINT_TXT = "#{ASSETS_DIR}/pylint.txt".freeze
+    RUBOCOP_JSON = "#{ASSETS_DIR}/rubocop.json".freeze
+    RUBOCOP_MULTI_JSON = "#{ASSETS_DIR}/rubocop_multi_offenses.json".freeze
+    RUBOCOP_SIMPLE = "#{ASSETS_DIR}/rubocop.txt".freeze
+
+    BANDIT_FIRST_ISSUE = {
+      code: "2852         except ImportError:\n2853             import pickle\n2854         with open(filename, 'wb') as outf:\n",
+      filename: 'example/ply/yacc_1.py',
+      issue_confidence: 'HIGH',
+      issue_severity: :low,
+      issue_text: 'Consider possible security implications associated with pickle module.',
+      line_number: 2853,
+      line_range: [
+        2853
+      ],
+      more_info: 'https://bandit.readthedocs.io/en/latest/blacklists/blacklist_imports.html#b403-import-pickle',
+      test_id: 'B403',
+      test_name: 'blacklist'
+    }.freeze
+
+    PYLINT_FIRST_ISSUE = {
+      filename: 'test_project/__init__.py',
+      line: '1',
+      category: 'F403',
+      message: "'from test_project import *' used; unable to detect undefined names"
+    }.freeze
+
+    RUBOCOP_FIRST_ISSUE = {
+      path: 'spec/lib/danger/danger_core/plugins/dangerfile_gitlab_plugin_spec.rb',
+      offenses: [
+        {
+          severity: 'convention',
+          message: 'Do not use semicolons to terminate expressions.',
+          cop_name: 'Style/Semicolon',
+          corrected: false,
+          location: {
+            line: 82,
+            column: 65,
+            length: 1
+          }
+        }
+      ]
+    }.freeze
+  end
+end