danger-cobertura 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e6fa67d8f8fec2cba6c8e40ad5439c24e65f9809b5318a599730a67d5ff09a2
-  data.tar.gz: 3654409caf400866f143fc18fb8f0eb45c185c7b50831e3d624963601baee55d
+  metadata.gz: 54cd31fcfbf7c468f938017681d52dc70fcdd505cd33c528b020692767ce6719
+  data.tar.gz: 107b6c289fbfec276e74b89d1320f7cfe65c3ffd65f645bca41788be495788cc
 SHA512:
-  metadata.gz: 93123d1eaa127811dfa0546fa2d81ddc03e1ea65f69e69addbce48e90f8ef7d911cc869107fc35023945ad8ed79a0d4e0fbea5b3ddeb8d84a0f61be5136e6300
-  data.tar.gz: 99ce509910af575ceeb1ad729aa1ff145e03de7dea945a1c50aa570db1cce3ba083851a15f25fb4aaf7b80b2b38243584e6fd80e7feb1b0e8f62b7237cb3e31a
+  metadata.gz: 57536d735a2acc38c2a6ae4e1c9a2d4ee5dec0599aa161e71e7583430bec64fc91ee6862d1ae48cf65ca6a436b2c1909c3e9875da7633159f26c148ec7f53bf0
+  data.tar.gz: f970cb6bbf6359721e5195797cc4ed28abe2520d1381ce26ee5a639dc61317bf8e3cebf334789ed8724bc8f5dfd59de467e769111b0e44d61eed9781d70ab4f7

data/CHANGELOG.md

@@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [1.3.0] - 2019-02-07
+### Added
+- `fail_if_file_less_than(percentage:)` Create a danger errors if a file has a lower coverage than defined   
 
 ## [1.2.0] - 2019-01-21
 ### Changed

data/README.md

@@ -18,6 +18,24 @@ This plugin allows parsing of an xml coverage report generated by __cobertura__
 _It inspects only modified and added files, deleted ones are not considered useful for this report._
 
 ## How it looks like
+### Errors about file coverage
+<table>
+  <thead>
+    <tr>
+      <th width="50"></th>
+      <th width="100%">
+          1 Error
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><g-emoji alias="no_entry_sign" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f6ab.png">🚫</g-emoji></td>
+      <td>example.py has less than 50% coverage</td>
+    </tr>
+  </tbody>
+</table>
+
 ### Warnings about file coverage
 <table>
   <thead>
@@ -95,7 +113,8 @@ cobertura.show_coverage
 <blockquote>Combine all reports 
 <pre>
 cobertura.report = build/reports/coverage.xml
-cobertura.warn_if_file_less_than(percentage: 50.0)
+cobertura.warn_if_file_less_than(percentage: 60.0)
+cobertura.warn_if_file_less_than(percentage: 30.0)
 cobertura.show_coverage
 </pre>
 </blockquote>  
@@ -112,6 +131,8 @@ __`filename_prefix`__ - Path prefix to be added to both, the cobertura issue fil
 
 __`warn_if_file_less_than(percentage:)`__ - Add a danger warning for each file with a lower total coverage as given.
 
+__`fail_if_file_less_than(percentage:)`__ - Add a danger error for each file with a lower total coverage as given.
+
 __`show_coverage`__ - Show a markdown table including the coverage for all (modified / added) files.
 
 ## Development

data/lib/cobertura/gem_version.rb

@@ -1,3 +1,3 @@
 module Cobertura
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.0".freeze
 end

data/lib/cobertura/plugin.rb

@@ -44,6 +44,18 @@ module Danger
       end
     end
 
+    # Fail if a modified file has a lower total coverage than defined.
+    #
+    # @param percentage [Float] The minimum code coverage required for a file.
+    # @return [Array<String>] Fail warnings of files with a lower coverage.
+    def fail_if_file_less_than(percentage:)
+      filtered_items.each do |item|
+        next unless item.total_percentage < percentage
+
+        fail "#{item.name} has less than #{percentage}% coverage"
+      end
+    end
+
     # Show markdown table of modified and added files.
     # TODO remove * wildcard to accept all parameter: `danger local` bug - https://github.com/danger/danger/issues/1041
     # @return [Array<String>] A markdown report of modified files and their coverage report.

data/spec/cobertura_spec.rb

@@ -264,6 +264,109 @@ module Danger
           expect(@dangerfile.status_report[:markdowns]).not_to be_empty
         end
       end
+
+      describe "fail_if_file_less_than" do
+        it "raises error if file attribute is nil" do
+          @my_plugin.report = nil
+          expect do
+            @my_plugin.fail_if_file_less_than(percentage: 50.0)
+          end.to raise_error(DangerCobertura::ERROR_FILE_NOT_SET)
+        end
+
+        it "raises error if file attribute is empty" do
+          @my_plugin.report = ""
+          expect do
+            @my_plugin.fail_if_file_less_than(percentage: 50.0)
+          end.to raise_error(DangerCobertura::ERROR_FILE_NOT_SET)
+        end
+
+        it "raises error if file is not found" do
+          @my_plugin.report = "cant/find/my/file.xml"
+          expect do
+            @my_plugin.fail_if_file_less_than(percentage: 50.0)
+          end.to raise_error(/#{@my_plugin.report}/)
+        end
+
+        it "adds fail if total coverage lower than given" do
+          @dangerfile.git.stubs(:modified_files).returns(%w(sub_folder/sub_two.py top_level_one.py))
+          @my_plugin.fail_if_file_less_than(percentage: 90.0)
+
+          expect(@dangerfile.status_report[:errors]).to include(SUB_TWO_WARNING)
+          expect(@dangerfile.status_report[:errors]).not_to include("top_level_one.py has less than 90.0% coverage")
+        end
+
+        it "does not add warn if coverage not" do
+          @dangerfile.git.stubs(:modified_files).returns(SUB_TWO)
+          @my_plugin.fail_if_file_less_than(percentage: 10.0)
+
+          expect(@dangerfile.status_report[:errors]).to be_empty
+        end
+
+        it "adds warn for modified files" do
+          @dangerfile.git.stubs(:modified_files).returns(SUB_TWO)
+          @my_plugin.fail_if_file_less_than(percentage: 90.0)
+
+          expect(@dangerfile.status_report[:errors]).to include(SUB_TWO_WARNING)
+        end
+
+        it "adds warn for added files" do
+          @dangerfile.git.stubs(:added_files).returns(SUB_TWO)
+          @my_plugin.fail_if_file_less_than(percentage: 90.0)
+
+          expect(@dangerfile.status_report[:errors]).to include(SUB_TWO_WARNING)
+        end
+
+        it "adds warn for added and modified files" do
+          @dangerfile.git.stubs(:added_files).returns(SUB_TWO)
+          @dangerfile.git.stubs(:modified_files).returns(SUB_ONE)
+          @my_plugin.fail_if_file_less_than(percentage: 90.0)
+
+          expect(@dangerfile.status_report[:errors]).to include(SUB_TWO_WARNING)
+          expect(@dangerfile.status_report[:errors]).to include("sub_one.py has less than 90.0% coverage")
+        end
+
+        it "does not add if filename missing prefix" do
+          # sub_folder/sub_two.py in xml
+          @dangerfile.git.stubs(:added_files).returns(%w(not_including/sub_folder/sub_two.py))
+          expect(@my_plugin.filename_prefix).to be_nil
+
+          @my_plugin.fail_if_file_less_than(percentage: 90.0)
+
+          expect(@dangerfile.status_report[:errors]).not_to include(SUB_TWO_WARNING)
+        end
+
+        it "does add if issue filename prefix set" do
+          @dangerfile.git.stubs(:added_files).returns(PREFIX_TWO)
+          @my_plugin.filename_prefix = PREFIX
+          @my_plugin.fail_if_file_less_than(percentage: 90.0)
+
+          expect(@dangerfile.status_report[:errors]).to include(SUB_TWO_WARNING)
+        end
+
+        it "does add if git filename prefix set" do
+          @dangerfile.git.stubs(:added_files).returns(SUB_TWO)
+          @my_plugin.filename_prefix = PREFIX
+          @my_plugin.fail_if_file_less_than(percentage: 90.0)
+
+          expect(@dangerfile.status_report[:errors]).to include(SUB_TWO_WARNING)
+        end
+
+        it "ignores filename prefix slash" do
+          @dangerfile.git.stubs(:added_files).returns(PREFIX_TWO)
+          @my_plugin.filename_prefix = "#{PREFIX}/"
+          @my_plugin.fail_if_file_less_than(percentage: 90.0)
+
+          expect(@dangerfile.status_report[:errors]).to include(SUB_TWO_WARNING)
+        end
+
+        it "should not add name with $" do
+          @dangerfile.git.stubs(:added_files).returns(SUB_THREE)
+          @my_plugin.fail_if_file_less_than(percentage: 90.0)
+
+          expect(@dangerfile.status_report[:errors]).to include("sub_three.py has less than 90.0% coverage")
+          expect(@dangerfile.status_report[:errors]).not_to include("sub_three$.py has less than 90.0% coverage")
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-cobertura
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Kyaak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+date: 2019-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api