danger-logging_lint 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9502be7bec98f9ac55351ec4b27e2ecac0140be3974d2be654400338633d3223
-  data.tar.gz: ecdde9f1dcc8c1807733f41aedbbb92e7465ddbc7dfb62b7375f11e52ea3e9a8
+  metadata.gz: a08e90afc0c447a3f28d9afe54ee806eff0c0f4b4baa203d006c850ee9f59f51
+  data.tar.gz: e4b1797375798f5e2c00bf6c51feec0292b343887d2f16719d238dc9bc0ded2c
 SHA512:
-  metadata.gz: 476adf208a82fb33e9b65d48749d7c9b0f267b5dbc46c231cb42027bae840285d264b3056a19740c07fd4e9c06c47ab6c2bd73bb9af2f88bb873fe2ebd27c907
-  data.tar.gz: 4583a38b9c4d22b94cdec222e545714519db132d52a8e526f270b9dc2fe7765bd947623c6a48cf926f8d60cb0d257039b2422cc90cf8efd46fd61532fd44b13f
+  metadata.gz: 685a9d6243a365cc2098b5f9ad36aeb097d55ed06e08b0a546675f9e9393675e1f01e097c89bfdeebc66dfe11fad1570fe1847eea338fdd927dad385b0202720
+  data.tar.gz: e2b4e4e4883faf5436c814cc5d0b2672ef9d8db7b1202737279aeda490f8f79195882fb839847d1fed93ccae7cf15e32d1f686c999b838842acc261cc6b9f77f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+### Version 0.0.4 (2022-04-28)
+
+- Fixed crash when changed file is a directory (filters them out).
+- Fixed crash when opening missing file (filters them out).
+- Split rspec into multiple files.
+- Added tests for linter with all variables set using Danger file.
+- Variables used in multiple tests are defined as constants in `spec_helper.rb`.
+
 ### Version 0.0.3 (2022-04-22)
 
 - Added deploy and test yaml for github workflow.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-logging_lint (0.0.3)
+    danger-logging_lint (0.0.4)
       danger-plugin-api (~> 1.0)
 
 GEM

data/README.md

@@ -1,7 +1,6 @@
 ## Logging Lint
 [![Gem Version](https://badge.fury.io/rb/danger-logging_lint.svg)](https://badge.fury.io/rb/danger-logging_lint) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/eManPrague/danger-logging_lint/blob/master/LICENSE.txt) [![Test](https://github.com/eManPrague/danger-logging_lint/actions/workflows/test.yml/badge.svg)](https://github.com/eManPrague/danger-logging_lint/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/eManPrague/danger-logging_lint/branch/master/graph/badge.svg?token=Z2RZKYNBVI)](https://codecov.io/gh/eManPrague/danger-logging_lint)
 
-
 This danger plugin can be used to check log lines in modified (added) files. It heavily relies on regex configuration which can be modified to search all kinds of parts of code in the files. Default configuration is set to support [Kotlin eMan Logger Library](https://github.com/eManPrague/logger-ktx). Ex: logInfo { "Info message $var" }.
 
 It works in two steps. First it searches for all log lines (multilines) in files. And then it applies line variable regex combined with line remove regex. Check `check_files` function for more information.

data/lib/logging_lint/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoggingLint
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/logging_lint/plugin.rb

@@ -191,28 +191,41 @@ module Danger
     #
     def log_lint
       if log_functions.nil? || log_functions.size <= 0
-        self.fail("No log functions are defined. Please check your Danger file.")
+        self.fail("Logging lint: No log functions are defined. Please check your Danger file.")
         return
       end
 
       if line_variable_regex.nil? || line_variable_regex.size <= 0
-        message("At least one variable index must be defined (using default). Please check your Danger file.")
+        message("Logging lint: At least one variable index must be defined (using default). Please check your Danger file.")
       end
 
       target_files = (git.modified_files - git.deleted_files) + git.added_files
+      target_files = target_files.reject { |filename| invalid_file?(filename) }
       if !file_extensions.nil? && file_extensions.size >= 0
         file_extensions_regex = "(.#{file_extensions.join('|.')})"
         target_files = target_files.grep(/#{file_extensions_regex}/)
       end
 
       if target_files.empty?
-        message("No files to check.")
+        message("Logging lint: No files to check.")
         return
       end
 
       check_files(target_files)
     end
 
+    #
+    # Checks if file is not valid. It will not be valid in two cases:
+    # 1) Files is a directory.
+    # 2) Files does not exist.
+    # In both cases we cannot open it and lint it. There is also no reason to lint them.
+    #
+    # @return [Boolean] true if invalid file
+    #
+    def invalid_file?(filename)
+      File.directory?(filename) || !File.exist?(filename)
+    end
+
     #
     # Checks all files for log violations based on log regex and log function. Each log function id extended by log
     # regex and searched for (format: #log_function#log_regex). Each of such found line is then checked if it contains a
@@ -224,6 +237,8 @@ module Danger
     def check_files(files)
       raw_file = ""
       files.each do |filename|
+        next if invalid_file?(filename)
+
         raw_file = File.read(filename)
         log_functions.each do |log_function|
           raw_file.scan(/#{log_function}#{log_regex}/m) do |c|

data/spec/logging_lint_no_run_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+#
+# Tests for situations when the linter does not run because of either configuration or there are no files to check.
+#
+
+module Danger
+  describe Danger::DangerLoggingLint do
+    #
+    # Defines linter, danger file and other variables used by the linter.
+    #
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @logging_lint = @dangerfile.logging_lint
+
+        mock_variables(@logging_lint)
+      end
+
+      #
+      # Test for logging lines in cases when linter does not run (either by config or file settings).
+      #
+
+      it "Error is printed when log functions are not configured" do
+        allow(@logging_lint).to receive(:log_functions).and_return([])
+        @logging_lint.log_lint
+        expect(@dangerfile.status_report[:errors]).to eq(["Logging lint: No log functions are defined. Please check your Danger file."])
+      end
+
+      it "Error is printed when log variable regex is not configured" do
+        allow(@logging_lint).to receive(:line_variable_regex).and_return([])
+        @logging_lint.log_lint
+        expect(@dangerfile.status_report[:messages][0]).to eq("Logging lint: At least one variable index must be defined (using default). Please check your Danger file.")
+      end
+
+      it "Nothing is printed when there are no files to check" do
+        @logging_lint.log_lint
+        expect(@dangerfile.status_report[:errors]).to eq([])
+        expect(@dangerfile.status_report[:messages][0]).to eq("Logging lint: No files to check.")
+      end
+
+      it "Nothing is printed when there are only folders to check" do
+        allow(@logging_lint).to receive(:file_extensions).and_return([])
+        allow(@logging_lint.git).to receive(:modified_files).and_return(%W(#{DIR_NAME}))
+        @logging_lint.log_lint
+        expect(@dangerfile.status_report[:errors]).to eq([])
+      end
+
+      it "Nothing is printed when there are no files to check (filtered by extensions)" do
+        allow(@logging_lint.git).to receive(:modified_files).and_return(MODIFIED_FILES)
+        allow(@logging_lint).to receive(:file_extensions).and_return(%w(unknownExtension))
+        @logging_lint.log_lint
+        expect(@dangerfile.status_report[:errors]).to eq([])
+      end
+    end
+  end
+end

data/spec/logging_lint_spec.rb

@@ -8,11 +8,6 @@ module Danger
       expect(Danger::DangerLoggingLint.new(nil)).to be_a Danger::Plugin
     end
 
-    dir_name = File.dirname(__FILE__)
-    modified_files = %W(#{dir_name}/fixtures/ModifiedFile.kt #{dir_name}/fixtures/IgnoredModifiedFile.txt)
-    added_files = %W(#{dir_name}/fixtures/NewFile.kt)
-    warning_text = "Does this log comply with security rules?"
-
     #
     # Defines linter, danger file and other variables used by the linter.
     #
@@ -25,48 +20,27 @@ module Danger
         allow(@logging_lint.git).to receive(:added_files).and_return([])
         allow(@logging_lint.git).to receive(:modified_files).and_return([])
         allow(@logging_lint).to receive(:file_extensions).and_return(%w(kt))
+        allow(@logging_lint).to receive(:log_functions).and_call_original
+        allow(@logging_lint).to receive(:warning_text).and_call_original
+        allow(@logging_lint).to receive(:log_regex).and_call_original
+        allow(@logging_lint).to receive(:line_variable_regex).and_call_original
+        allow(@logging_lint).to receive(:line_remove_regex).and_call_original
       end
 
       #
-      # Test for logging lines in cases when linter does not run (either by config or file settings).
+      # Test for logging lines in cases when linter does run.
       #
 
-      it "Error is printed when log functions are not configured" do
-        allow(@logging_lint).to receive(:log_functions).and_return([])
-        @logging_lint.log_lint
-        expect(@dangerfile.status_report[:errors]).to eq(["No log functions are defined. Please check your Danger file."])
-      end
-
-      it "Error is printed when log variable regex is not configured" do
-        allow(@logging_lint).to receive(:line_variable_regex).and_return([])
-        @logging_lint.log_lint
-        expect(@dangerfile.status_report[:messages][0]).to eq("At least one variable index must be defined (using default). Please check your Danger file.")
-      end
-
-      it "Nothing is printed when there are no files to check" do
-        @logging_lint.log_lint
-        expect(@dangerfile.status_report[:errors]).to eq([])
-      end
-
-      it "Nothing is printed when there are no files to check (filtered by extensions)" do
-        allow(@logging_lint.git).to receive(:modified_files).and_return(modified_files)
-        allow(@logging_lint).to receive(:file_extensions).and_return(%w(unknownExtension))
-        @logging_lint.log_lint
-        expect(@dangerfile.status_report[:errors]).to eq([])
-      end
-
-      it "Nothing is printed when log levels are not present" do
-        allow(@logging_lint).to receive(:log_functions).and_return(%w(missingLogLevel))
+      it "Nothing is printed when log functions are not present in files" do
+        allow(@logging_lint.git).to receive(:modified_files).and_return(MODIFIED_FILES)
+        allow(@logging_lint.git).to receive(:added_files).and_return(ADDED_FILES)
+        allow(@logging_lint).to receive(:log_functions).and_return(%w(unknownLogLevel))
         @logging_lint.log_lint
         expect(@dangerfile.status_report[:warnings]).to eq([])
       end
 
-      #
-      # Test for logging lines in cases when linter does run.
-      #
-
       it "Log with variables is warned for modified files (end line index)" do
-        allow(@logging_lint.git).to receive(:modified_files).and_return(modified_files)
+        allow(@logging_lint.git).to receive(:modified_files).and_return(MODIFIED_FILES)
         allow(@logging_lint).to receive(:line_index_position).and_return("end")
         @logging_lint.log_lint
         violation_lines = [63, 64, 73, 76, 88, 92, 97, 98, 101, 106, 107, 110]
@@ -74,7 +48,7 @@ module Danger
       end
 
       it "Log with variables is warned for modified files (start line index)" do
-        allow(@logging_lint.git).to receive(:modified_files).and_return(modified_files)
+        allow(@logging_lint.git).to receive(:modified_files).and_return(MODIFIED_FILES)
         allow(@logging_lint).to receive(:line_index_position).and_return("start")
         @logging_lint.log_lint
         violation_lines = [63, 64, 71, 74, 85, 89, 93, 98, 99, 102, 107, 108]
@@ -82,36 +56,39 @@ module Danger
       end
 
       it "Log with variables is warned for modified files (middle line index)" do
-        allow(@logging_lint.git).to receive(:modified_files).and_return(modified_files)
+        allow(@logging_lint.git).to receive(:modified_files).and_return(MODIFIED_FILES)
         allow(@logging_lint).to receive(:line_index_position).and_return("middle")
         @logging_lint.log_lint
         violation_lines = [63, 64, 73, 76, 88, 92, 97, 98, 101, 106, 107, 110]
         compare_warning_with_lines(violation_lines)
       end
 
-      it "Log with variables is warned for new files" do
-        allow(@logging_lint.git).to receive(:added_files).and_return(added_files)
+      it "Log with variables is warned for modified files without crashing due to missing files" do
+        allow(@logging_lint.git).to receive(:modified_files).and_return(MODIFIED_FILES + %W(#{DIR_NAME}/fixtures/MissingFile.kt))
         @logging_lint.log_lint
-        violation_lines = [47, 48, 57, 60, 72, 76]
+        violation_lines = [63, 64, 73, 76, 88, 92, 97, 98, 101, 106, 107, 110]
         compare_warning_with_lines(violation_lines)
       end
 
-      #
-      # Test for waning texts and links.
-      #
-
-      it "Log with variables is warned with link address" do
-        warning_link = "http://error.io"
-        allow(@logging_lint.git).to receive(:added_files).and_return(added_files)
-        allow(@logging_lint).to receive(:warning_description).and_return(warning_link)
+      it "Log with variables is warned for new files" do
+        allow(@logging_lint.git).to receive(:added_files).and_return(ADDED_FILES)
         @logging_lint.log_lint
-        expect(@dangerfile.status_report[:warnings][0]).to eq("#{warning_text} #{warning_link}")
+        violation_lines = [47, 48, 57, 60, 72, 76]
+        compare_warning_with_lines(violation_lines)
       end
 
-      it "Log with variables is warned without link address" do
-        allow(@logging_lint.git).to receive(:added_files).and_return(added_files)
+      it "Log with variables is warned for new files (with all params)" do
+        custom_warning_text = "Warning text"
+        allow(@logging_lint.git).to receive(:added_files).and_return(ADDED_FILES)
+        @logging_lint.log_functions = %w(logInfo)
+        @logging_lint.warning_text = custom_warning_text
+        @logging_lint.log_regex = '[ ]?[{(](?:\n?|.)["]?(?:\n?|.)["]?(?:\n?|.)+(?:[)}][ ]?\n)'
+        @logging_lint.line_variable_regex = ['[{(](\n| |\+)*([^\"]\w[^\"])+', '(\".*\$.*\")']
+        @logging_lint.line_remove_regex = ['(\+ )?\".*\"']
         @logging_lint.log_lint
-        expect(@dangerfile.status_report[:warnings][0]).to eq(warning_text)
+        violation_lines = [47, 48, 57, 60, 72, 76]
+        compare_warning_with_lines(violation_lines)
+        expect(@dangerfile.violation_report[:warnings][0].message).to eq(custom_warning_text)
       end
 
       #

data/spec/logging_lint_text_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+#
+# Tests for warning text creation. Text can contain description which can be defined in Danger file.
+#
+
+module Danger
+  describe Danger::DangerLoggingLint do
+    #
+    # Defines linter, danger file and other variables used by the linter.
+    #
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @logging_lint = @dangerfile.logging_lint
+
+        mock_variables(@logging_lint)
+      end
+
+      #
+      # Test for waning text and description (optional).
+      #
+
+      it "Log with variables is warned description (link address)" do
+        warning_description = "http://error.io"
+        allow(@logging_lint.git).to receive(:added_files).and_return(ADDED_FILES)
+        allow(@logging_lint).to receive(:warning_description).and_return(warning_description)
+        @logging_lint.log_lint
+        expect(@dangerfile.status_report[:warnings][0]).to eq("#{WARNING_TEXT} #{warning_description}")
+      end
+
+      it "Log with variables is warned without warning description" do
+        allow(@logging_lint.git).to receive(:added_files).and_return(ADDED_FILES)
+        @logging_lint.log_lint
+        expect(@dangerfile.status_report[:warnings][0]).to eq(WARNING_TEXT)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -71,3 +71,22 @@ def testing_dangerfile
   env = Danger::EnvironmentManager.new(testing_env)
   Danger::Dangerfile.new(env, testing_ui)
 end
+
+# Mocks linter variables. Should be called in "before" block.
+def mock_variables(logging_lint)
+  allow(logging_lint.git).to receive(:deleted_files).and_return([])
+  allow(logging_lint.git).to receive(:added_files).and_return([])
+  allow(logging_lint.git).to receive(:modified_files).and_return([])
+  allow(logging_lint).to receive(:file_extensions).and_return(%w(kt))
+  allow(logging_lint).to receive(:log_functions).and_call_original
+  allow(logging_lint).to receive(:warning_text).and_call_original
+  allow(logging_lint).to receive(:log_regex).and_call_original
+  allow(logging_lint).to receive(:line_variable_regex).and_call_original
+  allow(logging_lint).to receive(:line_remove_regex).and_call_original
+end
+
+# Defines test variables used in multiple text files.
+DIR_NAME = File.dirname(__FILE__)
+MODIFIED_FILES = %W(#{DIR_NAME}/fixtures/ModifiedFile.kt #{DIR_NAME}/fixtures/IgnoredModifiedFile.txt).freeze
+ADDED_FILES = %W(#{DIR_NAME}/fixtures/NewFile.kt).freeze
+WARNING_TEXT = "Does this log comply with security rules?"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-logging_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - David Sucharda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-22 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -192,7 +192,9 @@ files:
 - spec/fixtures/IgnoredModifiedFile.txt
 - spec/fixtures/ModifiedFile.kt
 - spec/fixtures/NewFile.kt
+- spec/logging_lint_no_run_spec.rb
 - spec/logging_lint_spec.rb
+- spec/logging_lint_text_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/eManPrague/danger-logging_lint
 licenses:
@@ -222,5 +224,7 @@ test_files:
 - spec/fixtures/IgnoredModifiedFile.txt
 - spec/fixtures/ModifiedFile.kt
 - spec/fixtures/NewFile.kt
+- spec/logging_lint_no_run_spec.rb
 - spec/logging_lint_spec.rb
+- spec/logging_lint_text_spec.rb
 - spec/spec_helper.rb