danger-code_coverage 0.0.1

data/.travis.yml

@@ -0,0 +1,34 @@
+language: ruby
+
+cache:
+  directories:
+    - bundle
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+
+addons:
+  sonarcloud:
+    organization: "kyaak-github"
+    token:
+      secure: "fNNFlZXguNUDr28aUFwNVXw/u1ftl4bf3xD0lXRNIhKzFKcBNEKMa2h8isggtg6l45ok0rml1G9W0FNFBloMAvhkOgxaAin1oRt9aGePXDikikM0dFUKRIPHOKyfzbpJboMfzCln5VG8+IZTMt7fUppkcbsw25pwtu34VJzJKRzeylCR4I5/MWEkZqB+4iwPGkp5oJFs5laMUvIyXO0xZFGPHar/9d21WF3pegXN1ih6gkWPibaAPpPn5DVbjpQJ6tN88089zhOIbqK3CN01xTTVIkA+2DMtvquIHshHkbC2AwbQ7VmQjVeRFKtYqJjyN8WoXIuUDUMlKrGmcExNi/TtxgheFc7JQxTCaE6SGN/bR8jUwSayCBmXg9K75OJncewOMJ4OkMF5MDYqrko9PpmN+uauHZAoAzm/DLYGb0LYzrD02ztk1gakcbRr6sKwneHvmArEgSjrhYHdpZHN/cBngDMa+npcb89EpZ7W8ItZozWvl25oX1fQ/GvDCH3SE3s7w5PNqMs8QpdRAqgqkEE8CTmdgbzTE0eW7cZ6y2FNaeHC87TplUseL42qRjmpdgVFfQOtDkaWgZXRCkPr3pml1cZ54UbHoEmVPXyw/zk0SwfLoS/5hi1uJ8yDacG+fAtM/nTxCv3Iug+/2O/0eHDEqa8vTpLwDxMZOdZabUE="
+
+script:
+  - bundle exec rake spec
+  - sonar-scanner
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "aWKizbUpasC+1fVFBhGPHq8nFApCZKP87tSAlBl32Awh6gP1NicuUlUHkwArPxOS9iGLP6ZT/9YwD6OkZsjA5jGSikSUOHAh3Cz2iwbcgWYQlHWHyqikHehVS75rkAKBIOvmreesJ6ybiXwPksjjqOKW5wZFyXuqWWUFsc+StEcfsWyezwS50zndm3Z14Rtqh8bbuJIjknhGwXMxj3tnkbYnesDfhTf+7fy/hTNBSg/mt3D5UxeaKhL0nbbB/S10NMFBUlkdlPCxLn0lOaAC8bPvQkkhHbMWMlrBEOBGbx/CXuEdLfDchpFXm/5bT5+/FhW+jMxAZuqGuGxfZp4bCffU3WAKYt8rAw3HynsGR1EYJluGoP6U/KJVsmByMc6mOIzumjYbs6ZPrAoLbAIXCB9R62oyxeOOV4NSe/uLqA1bBvvMLA5EqU5ccng2Qtga2zvMf5zmWBAUMal4Oy0iGZgdseBaNkiBSyirPIzQ0DbQhc0pHh3pi0XtTDvyw/ZU1BMpobx8ZIjBXZD4Nt+YbtqVkMdEe9GD+tx0nkA5OGP+IaqYqhsuqdcsDCCp1t4O/1rGd7wxChIOnM7ajTT6m4EibzNpQH+UOUc21uQt5Bw+JGpVBtOcCIPf0cvCyEYdd1TNlaP6/xXhV8BzbMT9s5th2LHoTLSduBchJCNm+3c="
+  gem: danger-code_coverage
+  on:
+    branch: master
+    rvm: 2.6

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+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).
+
+## [0.0.1] - 2019-6-22
+### Added
+- Initial project

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source('https://rubygems.org')
+
+# Specify your gem's dependencies in danger-code_coverage.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Martin Schwamberger <kyaak.dev@gmail.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+<h1 align="center">danger-code_coverage</h1>
+
+<div align="center">
+  <!-- Sonar Cloud -->
+  <a href="https://sonarcloud.io/dashboard?id=Kyaak_danger-code_coverage">
+    <img src="https://sonarcloud.io/images/project_badges/sonarcloud-white.svg"
+      alt="Sonar Cloud" />
+  </a>
+</div>
+
+</br>
+
+<div align="center">
+  <!-- Version -->
+  <a href="https://badge.fury.io/rb/danger-code_coverage">
+    <img src="https://badge.fury.io/rb/danger-code_coverage.svg" alt="Version" />
+  </a>
+  <!-- Downloads -->
+  <a href="https://badge.fury.io/rb/danger-code_coverage">
+    <img src="https://img.shields.io/gem/dt/danger-code_coverage.svg" alt="Downloads" />
+  </a>
+</div>
+
+<div align="center">
+  <!-- Build Status -->
+  <a href="https://travis-ci.org/Kyaak/danger-code_coverage">
+    <img src="https://img.shields.io/travis/choojs/choo/develop.svg"
+      alt="Build Status" />
+  </a>
+  <!-- Coverage -->
+    <a href="https://sonarcloud.io/dashboard?id=Kyaak_danger-code_coverage">
+      <img src="https://sonarcloud.io/api/project_badges/measure?project=Kyaak_danger-code_coverage&metric=coverage"
+        alt="Coverage" />
+    </a>
+</div>
+
+<div align="center">
+  <!-- Reliability Rating -->
+  <a href="https://sonarcloud.io/dashboard?id=Kyaak_danger-code_coverage">
+    <img src="https://sonarcloud.io/api/project_badges/measure?project=Kyaak_danger-code_coverage&metric=reliability_rating"
+      alt="Reliability Rating" />
+  </a>
+  <!-- Security Rating -->
+  <a href="https://sonarcloud.io/dashboard?id=Kyaak_danger-code_coverage">
+    <img src="https://sonarcloud.io/api/project_badges/measure?project=Kyaak_danger-code_coverage&metric=security_rating"
+      alt="Security Rating" />
+  </a>
+  <!-- Maintainabiltiy -->
+  <a href="https://sonarcloud.io/dashboard?id=Kyaak_danger-code_coverage">
+    <img src="https://sonarcloud.io/api/project_badges/measure?project=Kyaak_danger-code_coverage&metric=sqale_rating"
+      alt="Maintainabiltiy" />
+  </a>
+</div>
+
+<div align="center">
+  <!-- Code Smells -->
+  <a href="https://sonarcloud.io/dashboard?id=Kyaak_danger-code_coverage">
+    <img src="https://sonarcloud.io/api/project_badges/measure?project=Kyaak_danger-code_coverage&metric=code_smells"
+      alt="Code Smells" />
+  </a>
+  <!-- Bugs -->
+  <a href="https://sonarcloud.io/dashboard?id=Kyaak_danger-code_coverage">
+    <img src="https://sonarcloud.io/api/project_badges/measure?project=Kyaak_danger-code_coverage&metric=bugs"
+      alt="Bugs" />
+  </a>
+  <!-- Vulnerabilities -->
+  <a href="https://sonarcloud.io/dashboard?id=Kyaak_danger-code_coverage">
+    <img src="https://sonarcloud.io/api/project_badges/measure?project=Kyaak_danger-code_coverage&metric=vulnerabilities"
+      alt="Vulnerabilities" />
+  </a>
+  <!-- Technical Dept -->
+  <a href="https://sonarcloud.io/dashboard?id=Kyaak_danger-code_coverage">
+    <img src="https://sonarcloud.io/api/project_badges/measure?project=Kyaak_danger-code_coverage&metric=sqale_index"
+      alt="Technical Dept" />
+  </a>
+</div>
+</br>
+
+This [danger](https://github.com/danger/danger) plugin generates a coverage overview for modified files :100: <br>
+
+This plugin is inspired and works only with the jenkins [code-coverage-api-plugin](https://github.com/jenkinsci/code-coverage-api-plugin) :bowing_man:
+
+## How it looks like
+
+### Code Coverage :100:
+
+|**File**|**Total**|**Method**|**Line**|**Conditional**|**Instruction**|
+|:-|:-:|:-:|:-:|:-:|:-:|
+|com/example/kyaak/myapplication/MyUtil.java|50.94|13.34|75.0|49.99|65.44|
+|com/example/kyaak/myapplication/MyController.java|19.94|13.34|30.0|20.99|15.44|
+|com/example/kyaak/myapplication/MainActivity.java|0.0|0.0|0.0|0.0|0.0|
+
+## Installation
+
+    $ gem install danger-code_coverage
+
+## Usage
+
+    code_coverage.report
+
+## Authentication
+
+If you run a jenkins server with required authentication you can pass them to `danger-code_coverage`.
+Create an API token with your CI user and do not pass normal password credentials.
+
+    code_coverage.report(
+        auth_user: "jenkins",
+        auth_token: "MY_TOKEN"
+    )

data/Rakefile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require('bundler/gem_tasks')
+require('rspec/core/rake_task')
+require('rubocop/rake_task')
+
+RSpec::Core::RakeTask.new(:specs)
+
+task(default: :specs)
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc('Run RuboCop on the lib/specs directory')
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = false
+  task.formatters = ['simple', 'json']
+  task.options = ['--out', 'rubocop-result.json']
+end
+
+desc('Ensure that the plugin passes `danger plugins lint`')
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-code_coverage.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require('code_coverage/gem_version.rb')
+
+Gem::Specification.new do |spec|
+  spec.name = 'danger-code_coverage'
+  spec.version = CodeCoverage::VERSION
+  spec.authors = ['Martin Schwamberger']
+  spec.email = ['kyaak.dev@gmail.com']
+  spec.description = 'Danger plugin for Jenkins-Code-Coverage-Api plugin.'
+  spec.summary = 'Read Jenkins code-coverage reports and comment pull request with coverage for changed files.'
+  spec.homepage = 'https://github.com/Kyaak/danger-code_coverage'
+  spec.license = 'MIT'
+
+  spec.files = %x(git ls-files).split($INPUT_RECORD_SEPARATOR)
+  spec.executables = spec.files.grep(%r{^bin/}) { |file| File.basename(file) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>=2.3.0'
+
+  spec.add_runtime_dependency('danger-plugin-api', '~> 1.0')
+
+  # General ruby development
+  spec.add_development_dependency('bundler', '~> 2.0')
+  spec.add_development_dependency('rake', '~> 12.3')
+
+  # Testing support
+  spec.add_development_dependency('mocha', '~> 1.8')
+  spec.add_development_dependency('rspec', '~> 3.8')
+  spec.add_development_dependency('simplecov', '~> 0.16')
+  spec.add_development_dependency('simplecov-console', '~> 0.4')
+
+  # Linting code and docs
+  spec.add_development_dependency('rubocop', '~> 0.68')
+  spec.add_development_dependency('rubocop-performance', '~> 1.2')
+  spec.add_development_dependency('rubocop-thread_safety', '~> 0.3')
+  spec.add_development_dependency('yard', '~> 0.9')
+end

data/lib/code_coverage/coverage_item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CodeCoverage
+  # Container class for coverage data per file.
+  class CoverageItem
+    attr_accessor :file,
+                  :line,
+                  :conditional,
+                  :method,
+                  :instruction,
+                  :total
+  end
+end

data/lib/code_coverage/coverage_parser.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require('code_coverage/coverage_item')
+require('json')
+
+module CodeCoverage
+  # Parse json files of code-coverage-api plugin and converts it into an array of [CoverageItem].
+  # Empty array if not parseable.
+  class CoverageParser
+    # Parse json string into [CoverageItem] array.
+    #
+    # @param content Json string to parse.
+    # @return [Array<CoverageItem>] Empty array of filled with [CoverageItem].
+    def parse(content)
+      raw_json =
+        begin
+          JSON.parse(content)
+        rescue JSON::ParserError
+          {}
+        end
+      parse_coverage(raw_json)
+    end
+
+    private
+
+    def parse_coverage(raw_json)
+      result = []
+      results = raw_json['results']
+      return result unless results
+
+      report_files = results['children']
+      return result unless report_files
+
+      report_files.each do |report|
+        projects = report['children']
+        projects.each do |project|
+          project['children'].each do |directory|
+            directory['children'].each do |file|
+              result << coverage_item(directory['name'], file)
+            end
+          end
+        end
+      end
+
+      result
+    end
+
+    def coverage_item(parent_name, file_json)
+      elements = file_json['elements']
+      file_name = file_json['name']
+      item_name = +''
+      item_name << "#{parent_name}/" if !dirs?(file_name) && !dots?(parent_name)
+      item_name << file_name
+
+      item = CoverageItem.new
+      item.file = item_name
+      item.method = find_element_ratio(elements, 'Method')
+      item.line = find_element_ratio(elements, 'Line')
+      item.conditional = find_element_ratio(elements, 'Conditional')
+      item.instruction = find_element_ratio(elements, 'Instruction')
+      item
+    end
+
+    def find_element_ratio(elements, name)
+      element = elements.select { |it| it['name'] == name }.first
+      element['ratio'].round(2) if element
+    end
+
+    def dirs?(value)
+      value =~ %r{.+\/\w+\..+}
+    end
+
+    def dots?(value)
+      value =~ %r{.*\..*}
+    end
+  end
+end

data/lib/code_coverage/gem_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CodeCoverage
+  VERSION = '0.0.1'
+end

data/lib/code_coverage/markdown_table.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module CodeCoverage
+  # Generate a markdown table.
+  class MarkdownTable
+    COLUMN_SEPARATOR = '|'
+    HEADER_SEPARATOR = '-'
+
+    # Initialize table generator.
+    def initialize
+      @header = COLUMN_SEPARATOR.dup
+      @header_separator = COLUMN_SEPARATOR.dup
+      @lines = []
+    end
+
+    # Add each entry to the table header
+    def header(*args)
+      args.each_with_index do |item, index|
+        @header << "#{item}#{COLUMN_SEPARATOR}"
+        @header_separator << if index.zero?
+                               ":#{HEADER_SEPARATOR}#{COLUMN_SEPARATOR}"
+                             else
+                               ":#{HEADER_SEPARATOR}:#{COLUMN_SEPARATOR}"
+                             end
+      end
+    end
+
+    # Return the number of lines without header items.
+    #
+    # @return [Integer] Number of lines.
+    def size
+      @lines.length
+    end
+
+    # Add a new line entry to the table.
+    #
+    # @param args [String]* Multiple comma separated strings for each column entry.
+    def line(*args)
+      line = COLUMN_SEPARATOR.dup
+      args.each do |item|
+        line << "#{item}#{COLUMN_SEPARATOR}"
+      end
+      @lines << line
+    end
+
+    # Combine all data to a markdown table string.
+    # @return [String] Table.
+    def to_markdown
+      result = +"#{@header}\n#{@header_separator}\n"
+      result << @lines.join("\n")
+    end
+  end
+end

data/lib/code_coverage/plugin.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Danger
+  # Generate code coverage reports on pull requests based on jenkins code-coverage-api-plugin.
+  #
+  # @example Generate report for each changed file.
+  #   code_coverage.report
+  #
+  # @example Use auth token.
+  #   code_coverage.report(
+  #     auth_user: 'user',
+  #     auth_token: 'token'
+  # )
+  #
+  # @see  Kyaak/danger-code_coverage
+  # @tags danger, jenkins, coverage, code-coverage, analysis
+  class DangerCodeCoverage < Plugin
+    require 'open-uri'
+    require 'code_coverage/markdown_table'
+    require 'code_coverage/coverage_parser'
+    require 'code_coverage/coverage_item'
+
+    EMPTY_COLUMN = '-'
+    TABLE_HEADER_TOTAL = '**Total**'
+    TABLE_HEADER_FILE = '**File**'
+    TABLE_HEADER_METHOD = '**Method**'
+    TABLE_HEADER_LINE = '**Line**'
+    TABLE_HEADER_CONDITIONAL = '**Conditional**'
+    TABLE_HEADER_INSTRUCTION = '**Instruction**'
+    TABLE_TITLE = '### Code Coverage :100:'
+
+    # Initialize code_coverage plugin.
+    def initialize(dangerfile)
+      @target_files = nil
+      @auth = nil
+      @table = CodeCoverage::MarkdownTable.new
+      @table.header(TABLE_HEADER_FILE,
+                    TABLE_HEADER_TOTAL,
+                    TABLE_HEADER_METHOD,
+                    TABLE_HEADER_LINE,
+                    TABLE_HEADER_CONDITIONAL,
+                    TABLE_HEADER_INSTRUCTION)
+      super(dangerfile)
+    end
+
+    # Create an overview report.
+    #
+    # @param args Configuration settings
+    # @return [void]
+    def report(*args)
+      options = args.first
+      check_auth(options)
+
+      items = coverage_items
+      items.select! { |item| file_in_changeset?(item.file) }
+      items.each(&method(:update_item))
+      items.sort_by!{|item| -item.total}
+      items.each(&method(:add_entry))
+
+      return if @table.size.zero?
+
+      markdown("#{TABLE_TITLE}\n\n#{@table.to_markdown}")
+    end
+
+    private
+
+    def update_item(item)
+      item.method = convert_entry(item.method)
+      item.line = convert_entry(item.line)
+      item.conditional = convert_entry(item.conditional)
+      item.instruction = convert_entry(item.instruction)
+      item.total = total(item)
+    end
+
+    def add_entry(item)
+      @table.line(item.file,
+                  item.total,
+                  item.method,
+                  item.line,
+                  item.conditional,
+                  item.instruction)
+    end
+
+    def convert_entry(value)
+      return EMPTY_COLUMN unless value
+
+      value
+    end
+
+    def total(item)
+      count = 0
+      sum = 0
+
+      unless convert_entry(item.method).eql?(EMPTY_COLUMN)
+        count += 1
+        sum += convert_entry(item.method)
+      end
+
+      unless convert_entry(item.line).eql?(EMPTY_COLUMN)
+        count += 1
+        sum += convert_entry(item.line)
+      end
+
+      unless convert_entry(item.conditional).eql?(EMPTY_COLUMN)
+        count += 1
+        sum += convert_entry(item.conditional)
+      end
+
+      unless convert_entry(item.instruction).eql?(EMPTY_COLUMN)
+        count += 1
+        sum += convert_entry(item.instruction)
+      end
+
+      (sum / count).round(2)
+    end
+
+    def auth_user(options)
+      options && !options[:auth_user].nil? ? options[:auth_user] : nil
+    end
+
+    def auth_token(options)
+      options && !options[:auth_token].nil? ? options[:auth_token] : nil
+    end
+
+    def check_auth(options)
+      user = auth_user(options)
+      token = auth_token(options)
+      return unless user && token
+
+      @auth = {
+        user: user,
+        token: token
+      }
+    end
+
+    def file_in_changeset?(file)
+      target_files.include?(file)
+    end
+
+    def target_files
+      @target_files ||= git.modified_files + git.added_files
+    end
+
+    def coverage_items
+      content = coverage_json
+      CodeCoverage::CoverageParser.new.parse(content)
+    end
+
+    def coverage_json
+      options = {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE}
+      options[:http_basic_authentication] = [@auth[:user], @auth[:token]] if @auth
+      OpenURI.open_uri("#{ENV['BUILD_URL']}/coverage/result/api/json?depth=5", options).read
+    end
+  end
+end