danger-jacoco-instacart 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d530223d70949352c71cbbe7a3dbc9b0d115be972c1d552b21db2038d087f95
-  data.tar.gz: d1d13f2a765308281c73c09d5d0be71e43b891105e7e282c2b875ca858b3b048
+  metadata.gz: 9360d314e746b8e23358b48545351a54693c9878bc1d50372e05e5993cd4436d
+  data.tar.gz: 2a07dd89fe99cf04811be5f2f5d7363cf6a08181bd397ffa99f2a235e2377f89
 SHA512:
-  metadata.gz: 36934680ed93f9ce29accbce38a1ce77471dd75eaf198ef96738f274b6d8edb05440beca43f500cedd99df42687c3b792b480784543686b4fedfff3f3eebf26d
-  data.tar.gz: 2a38f6f4ee1cfaf21301e2f1b5a36073eef9d26aa46ab3c4bae5cba03157e5602771333232e8d9366eb5aa74d3d8df7e1cf7131169414595944d6a96e084c82e
+  metadata.gz: 83392c62d27ccb28bfb4b345dc87e11e8f595e558c0339c50b592860c648b09c02e0a0830bb40f57fb1298f3f2c01b74fbfaa050892b15a3e62f66ce7f46d6ff
+  data.tar.gz: f64fc4aade681283072b6acc84c33ae9b2ecec84f0dec1d4bc19bcbc437a85e75175bf3d216a5fbad75e33fb8df8bf44a514380217eae4e99e825af8b8130d01

data/.yardoc/checksums

@@ -0,0 +1,15 @@
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/danger_jacoco.rb 38229d934b3315bb2a5a4eec18eb65f3c54d304f
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/gem_version.rb fc0b799df58ae240e5bc7ee0aeab413449d1b49f
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/plugin.rb faba0fa9900efd1df07bebd0571c4c9f02129b61
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/sax_parser.rb 370e2799f8dbdf7d642c820214e6ea84c30c9cb0
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/model/counter.rb 368f4a9811617b7a174ddf837a8fac49a4bc32a6
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/model/report.rb 7cf45ee71ff347a130320f6190ddb25525c7095d
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/model/class.rb 89c78fdda05e07a709ddfb1d5ae9fb2472eaa504
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/model/method.rb 37076c751eb37683c0071c154319b85a987a2708
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/model/group.rb 6a8ccb32c793842af49c5c2d0d015bf01b0ec537
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/model/sourcefile.rb 19ffc9500370f50807af91a6f177c42d5879aabd
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/model/session_info.rb 5c908a9f96bd054d202edfeb30f29dcb4b42a1c9
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/model/line.rb ff5d6fc5bf0bf808c46d4bafce0f3fc53c8fdd73
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/model/package.rb b865b8eca41323dfc832babc08179fb94b5dfb0f
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/jacoco/dom_parser.rb d08e0ca8531dd04bc9261a57fc03852b23883965
+/Users/alexanderbezverhni/workspace/junk/danger-jacoco/lib/danger_plugin.rb f5f82beb7e326604e1003f368e15da243263c0cf

data/README.md

@@ -23,6 +23,7 @@ jacoco.minimum_class_coverage_map = { # optional (default is empty)
   'com/package/more/specific/ClassName' => 15
 }
 jacoco.minimum_class_coverage_percentage = 75 # default 0
+jacoco.only_check_new_files = true # default false
 jacoco.files_extension = [".java"] # default [".kt", ".java"]
 jacoco.report("path/to/jacoco.xml", "http://jacoco-html-reports/")
 ```

data/lib/jacoco/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jacoco
-  VERSION = '0.1.9'
+  VERSION = '0.1.10'
 end

data/lib/jacoco/plugin.rb

@@ -20,17 +20,32 @@ module Danger
   # @tags jacoco, coverage, java, android, kotlin
   #
   class DangerJacoco < Plugin # rubocop:disable Metrics/ClassLength
-    attr_accessor :minimum_project_coverage_percentage, :minimum_class_coverage_percentage, :files_extension,
-                  :minimum_package_coverage_map, :minimum_class_coverage_map, :fail_no_coverage_data_found, :title
+    attr_accessor :minimum_project_coverage_percentage, :minimum_class_coverage_percentage, :only_check_new_files,
+                  :files_extension, :minimum_package_coverage_map, :minimum_class_coverage_map,
+                  :fail_no_coverage_data_found, :title, :class_column_title, :subtitle_success, :subtitle_failure
 
     # Initialize the plugin with configured parameters or defaults
     def setup
+      setup_minimum_coverages
+      setup_texts
+      @only_check_new_files = false unless only_check_new_files
+      @files_extension = ['.kt', '.java'] unless files_extension
+    end
+
+    # Initialize the plugin with configured optional texts
+    def setup_texts
+      @title = 'JaCoCo' unless title
+      @class_column_title = 'Class' unless class_column_title
+      @subtitle_success = 'All classes meet coverage requirement. Well done! :white_check_mark:' unless subtitle_success
+      @subtitle_failure = 'There are classes that do not meet coverage requirement :warning:' unless subtitle_failure
+    end
+
+    # Initialize the plugin with configured coverage minimum parameters or defaults
+    def setup_minimum_coverages
       @minimum_project_coverage_percentage = 0 unless minimum_project_coverage_percentage
       @minimum_class_coverage_percentage = 0 unless minimum_class_coverage_percentage
       @minimum_package_coverage_map = {} unless minimum_package_coverage_map
       @minimum_class_coverage_map = {} unless minimum_class_coverage_map
-      @files_extension = ['.kt', '.java'] unless files_extension
-      @title = 'JaCoCo' unless title
     end
 
     # Parses the xml output of jacoco to Ruby model classes
@@ -59,6 +74,7 @@ module Danger
     # Java => blah/blah/java/slashed_package/Source.java
     # Kotlin => blah/blah/kotlin/slashed_package/Source.kt
     #
+    # rubocop:disable Style/AbcSize
     def report(path, report_url = '', delimiter = %r{/java/|/kotlin/}, fail_no_coverage_data_found: true)
       @fail_no_coverage_data_found = fail_no_coverage_data_found
 
@@ -70,19 +86,24 @@ module Danger
 
       total_covered = total_coverage(path)
 
-      report_markdown = "### #{title} Code Coverage #{total_covered[:covered]}% #{total_covered[:status]}\n"
-      report_markdown += "| Class | Covered | Meta | Status |\n"
+      header = "### #{title} Code Coverage #{total_covered[:covered]}% #{total_covered[:status]}\n"
+      report_markdown = header
+      report_markdown += "| #{class_column_title} | Covered | Required | Status |\n"
       report_markdown += "|:---|:---:|:---:|:---:|\n"
       class_coverage_above_minimum = markdown_class(parser, report_markdown, report_url)
+      subtitle = class_coverage_above_minimum ? subtitle_success : subtitle_failure
+      report_markdown.insert(header.length, "#### #{subtitle}\n")
       markdown(report_markdown)
 
       report_fails(class_coverage_above_minimum, total_covered)
     end
+    # rubocop:enable Style/AbcSize
 
-    # Select modified and added files in this PR
+    # Select either only added files or modified and added files in this PR,
+    # depending on "only_check_new_files" attribute
     def classes(delimiter)
       git = @dangerfile.git
-      affected_files = git.modified_files + git.added_files
+      affected_files = only_check_new_files ? git.added_files : git.added_files + git.modified_files
       affected_files.select { |file| files_extension.reduce(false) { |state, el| state || file.end_with?(el) } }
                     .map { |file| file.split('.').first.split(delimiter)[1] }
     end
@@ -138,7 +159,8 @@ module Danger
     def coverage_status(coverage, minimum_percentage)
       if coverage < (minimum_percentage / 2) then ':skull:'
       elsif coverage < minimum_percentage then ':warning:'
-      else ':white_check_mark:'
+      else
+        ':white_check_mark:'
       end
     end
 

data/spec/fixtures/output_c.xml

@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.0//EN"
+        "report.dtd">
+<report name="test_report">
+  <sessioninfo id="test-id" start="1480057517395" dump="1480057526412"/>
+  <package name="com/example">
+    <class name="com/example/CachedRepository">
+      <method name="&lt;init&gt;" desc="()V" line="17">
+        <counter type="INSTRUCTION" missed="0" covered="11"/>
+        <counter type="LINE" missed="0" covered="5"/>
+        <counter type="COMPLEXITY" missed="0" covered="1"/>
+        <counter type="METHOD" missed="0" covered="1"/>
+      </method>
+      <counter type="INSTRUCTION" missed="0" covered="46"/>
+      <counter type="LINE" missed="0" covered="14"/>
+      <counter type="COMPLEXITY" missed="5" covered="7"/>
+      <counter type="METHOD" missed="0" covered="7"/>
+      <counter type="CLASS" missed="0" covered="1"/>
+      <counter type="BRANCH" missed="2" covered="2" />
+    </class>
+    <sourcefile name="CachedRepository.java">
+      <line nr="16" mi="0" ci="2" mb="0" cb="0"/>
+      <line nr="17" mi="0" ci="3" mb="0" cb="0"/>
+      <counter type="INSTRUCTION" missed="2" covered="98"/>
+      <counter type="LINE" missed="2" covered="19"/>
+      <counter type="COMPLEXITY" missed="2" covered="11"/>
+      <counter type="METHOD" missed="2" covered="11"/>
+      <counter type="CLASS" missed="2" covered="4"/>
+    </sourcefile>
+    <counter type="INSTRUCTION" missed="80" covered="324"/>
+    <counter type="BRANCH" missed="4" covered="4"/>
+    <counter type="LINE" missed="24" covered="68"/>
+    <counter type="COMPLEXITY" missed="11" covered="39"/>
+    <counter type="METHOD" missed="9" covered="37"/>
+    <counter type="CLASS" missed="2" covered="10"/>
+  </package>
+  <package name="io/sample">
+    <class name="io/sample/UseCase">
+      <method name="&lt;init&gt;" desc="()V" line="17">
+        <counter type="INSTRUCTION" missed="3" covered="8"/>
+        <counter type="LINE" missed="0" covered="7"/>
+        <counter type="COMPLEXITY" missed="0" covered="1"/>
+        <counter type="METHOD" missed="0" covered="1"/>
+      </method>
+      <counter type="INSTRUCTION" missed="0" covered="36"/>
+      <counter type="LINE" missed="0" covered="12"/>
+      <counter type="COMPLEXITY" missed="5" covered="8"/>
+      <counter type="METHOD" missed="0" covered="9"/>
+      <counter type="CLASS" missed="0" covered="1"/>
+      <counter type="BRANCH" missed="1" covered="2" />
+    </class>
+    <sourcefile name="UseCase.java">
+      <line nr="16" mi="0" ci="2" mb="0" cb="0"/>
+      <line nr="17" mi="0" ci="3" mb="0" cb="0"/>
+      <counter type="INSTRUCTION" missed="2" covered="48"/>
+      <counter type="LINE" missed="2" covered="9"/>
+      <counter type="COMPLEXITY" missed="2" covered="8"/>
+      <counter type="METHOD" missed="2" covered="7"/>
+      <counter type="CLASS" missed="2" covered="4"/>
+    </sourcefile>
+    <counter type="INSTRUCTION" missed="101" covered="201"/>
+    <counter type="BRANCH" missed="4" covered="4"/>
+    <counter type="LINE" missed="54" covered="78"/>
+    <counter type="COMPLEXITY" missed="21" covered="29"/>
+    <counter type="METHOD" missed="9" covered="37"/>
+    <counter type="CLASS" missed="2" covered="10"/>
+  </package>
+  <counter type="INSTRUCTION" missed="39399" covered="49321"/>
+  <counter type="BRANCH" missed="3463" covered="4039"/>
+  <counter type="LINE" missed="9611" covered="9974"/>
+  <counter type="COMPLEXITY" missed="5517" covered="6444"/>
+  <counter type="METHOD" missed="3382" covered="4120"/>
+  <counter type="CLASS" missed="491" covered="570"/>
+</report>

data/spec/jacoco_spec.rb

@@ -21,7 +21,7 @@ module Danger
         @my_plugin = @dangerfile.jacoco
 
         modified_files = ['src/java/com/example/CachedRepository.java']
-        added_files = ['src/java/Blah.java']
+        added_files = ['src/java/io/sample/UseCase.java']
 
         allow(@dangerfile.git).to receive(:modified_files).and_return(modified_files)
         allow(@dangerfile.git).to receive(:added_files).and_return(added_files)
@@ -38,7 +38,7 @@ module Danger
         expect(@dangerfile.status_report[:errors]).to eq(['Total coverage of 32.9%. Improve this to at least 50%',
                                                           'Class coverage is below minimum. Improve to at least 0%'])
         expect(@dangerfile.status_report[:markdowns][0].message).to include('### JaCoCo Code Coverage 32.9% :warning:')
-        expect(@dangerfile.status_report[:markdowns][0].message).to include('| Class | Covered | Meta | Status |')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| Class | Covered | Required | Status |')
         expect(@dangerfile.status_report[:markdowns][0].message).to include('|:---|:---:|:---:|:---:|')
         expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 100% | :warning: |')
       end
@@ -108,7 +108,7 @@ module Danger
         expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 100% | :warning: |')
       end
 
-      it 'test with overlapped package coverage and lowwer class coverage' do
+      it 'test with overlapped package coverage and lower class coverage' do
         path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
 
         @my_plugin.minimum_project_coverage_percentage = 50
@@ -123,6 +123,48 @@ module Danger
         expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 80% | :warning: |')
       end
 
+      it 'checks modified files when "only_check_new_files" attribute is false' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_c.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 50
+        @my_plugin.only_check_new_files = false
+
+        @my_plugin.report path_a
+
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('### JaCoCo Code Coverage 55.59% :white_check_mark:')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| Class | Covered | Required | Status |')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('|:---|:---:|:---:|:---:|')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 0% | :white_check_mark: |')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `io/sample/UseCase` | 66% | 0% | :white_check_mark: |')
+      end
+
+      it 'defaults "only_check_new_files" attribute to false' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_c.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 50
+
+        @my_plugin.report path_a
+
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `com/example/CachedRepository` | 50% | 0% | :white_check_mark: |')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `io/sample/UseCase` | 66% | 0% | :white_check_mark: |')
+      end
+
+      it 'does _not_ check modified files when "only_check_new_files" attribute is true' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_c.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 50
+        @my_plugin.minimum_class_coverage_percentage = 70
+        @my_plugin.only_check_new_files = true
+
+        @my_plugin.report path_a
+
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('### JaCoCo Code Coverage 55.59% :white_check_mark:')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| Class | Covered | Required | Status |')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('|:---|:---:|:---:|:---:|')
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| `io/sample/UseCase` | 66% | 70% | :warning: |')
+        expect(@dangerfile.status_report[:markdowns][0].message).not_to include('com/example/CachedRepository')
+      end
+
       it 'adds a link to report' do
         path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
 
@@ -169,6 +211,90 @@ module Danger
 
         expect { @my_plugin.report path_a, fail_no_coverage_data_found: false }.to_not raise_error(RuntimeError)
       end
+
+      it 'prints default success subtitle' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 30
+        @my_plugin.minimum_class_coverage_percentage = 40
+
+        @my_plugin.report path_a
+
+        expected = "### JaCoCo Code Coverage 32.9% :white_check_mark:\n"
+        expected += "#### All classes meet coverage requirement. Well done! :white_check_mark:\n"
+        expected += "| Class | Covered | Required | Status |\n"
+        expected += "|:---|:---:|:---:|:---:|\n"
+        expected += "| `com/example/CachedRepository` | 50% | 40% | :white_check_mark: |\n"
+        expect(@dangerfile.status_report[:markdowns][0].message).to include(expected)
+      end
+
+      it 'prints default failure subtitle' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 30
+        @my_plugin.minimum_class_coverage_percentage = 60
+
+        @my_plugin.report path_a
+
+        expected = "### JaCoCo Code Coverage 32.9% :white_check_mark:\n"
+        expected += "#### There are classes that do not meet coverage requirement :warning:\n"
+        expected += "| Class | Covered | Required | Status |\n"
+        expected += "|:---|:---:|:---:|:---:|\n"
+        expected += "| `com/example/CachedRepository` | 50% | 60% | :warning: |\n"
+        expect(@dangerfile.status_report[:markdowns][0].message).to include(expected)
+      end
+
+      it 'prints custom success subtitle' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 30
+        @my_plugin.minimum_class_coverage_percentage = 40
+        @my_plugin.subtitle_success = 'You rock! 🔥'
+
+        @my_plugin.report path_a
+
+        expected = "### JaCoCo Code Coverage 32.9% :white_check_mark:\n"
+        expected += "#### You rock! 🔥\n"
+        expected += "| Class | Covered | Required | Status |\n"
+        expected += "|:---|:---:|:---:|:---:|\n"
+        expected += "| `com/example/CachedRepository` | 50% | 40% | :white_check_mark: |\n"
+        expect(@dangerfile.status_report[:markdowns][0].message).to include(expected)
+      end
+
+      it 'prints custom failure subtitle' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
+
+        @my_plugin.minimum_project_coverage_percentage = 30
+        @my_plugin.minimum_class_coverage_percentage = 60
+        @my_plugin.subtitle_failure = 'Too bad :('
+
+        @my_plugin.report path_a
+
+        expected = "### JaCoCo Code Coverage 32.9% :white_check_mark:\n"
+        expected += "#### Too bad :(\n"
+        expected += "| Class | Covered | Required | Status |\n"
+        expected += "|:---|:---:|:---:|:---:|\n"
+        expected += "| `com/example/CachedRepository` | 50% | 60% | :warning: |\n"
+        expect(@dangerfile.status_report[:markdowns][0].message).to include(expected)
+      end
+
+      it 'prints default class column title' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
+
+        @my_plugin.report path_a
+
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| Class | Covered | Required | Status |')
+      end
+
+      it 'prints custom class column title' do
+        path_a = "#{File.dirname(__FILE__)}/fixtures/output_a.xml"
+
+        @my_plugin.class_column_title = 'New files'
+
+        @my_plugin.report path_a
+
+        expect(@dangerfile.status_report[:markdowns][0].message).to include('| New files | Covered | Required | Status |')
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-jacoco-instacart
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Anton Malinskiy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -179,6 +179,11 @@ files:
 - ".github/workflows/release.yaml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -202,6 +207,7 @@ files:
 - lib/jacoco/sax_parser.rb
 - spec/fixtures/output_a.xml
 - spec/fixtures/output_b.xml
+- spec/fixtures/output_c.xml
 - spec/jacoco_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/alexanderbezverhni/danger-jacoco
@@ -230,5 +236,6 @@ summary: A longer description of danger-jacoco.
 test_files:
 - spec/fixtures/output_a.xml
 - spec/fixtures/output_b.xml
+- spec/fixtures/output_c.xml
 - spec/jacoco_spec.rb
 - spec/spec_helper.rb