danger-shroud 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f3ffc4824ad6bfa00483d31b2205bf7cefb8e32
+  data.tar.gz: ac67e86ed5ae5a83741838ceeec93da4fddb6fa4
+SHA512:
+  metadata.gz: f255150c99519afe159b75524eaba76bfaf98d911d89fbf0448691e0ae6bba8f13616d5b21376e90ca2db44b3548cd0df70dee2de9b6f5365f24fd05852438a5
+  data.tar.gz: a26d7f2ad1322fb83345a0cd8ec6fea67677d506bcc44a4672e3ccf73b6b63756f333dacb43ccc49e99234bc5415cd28c7d52472a5a6abaa8d032eebc8caf29d

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+.idea/
+.yardoc

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in danger-shroud.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    danger-shroud (0.0.1)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    claide (1.0.2)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (6.0.9)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.5)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.0.0)
+      faraday (~> 0.8)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    git (1.5.0)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.2)
+    kramdown (2.1.0)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+    yard (0.9.19)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-shroud!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  nokogiri
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -0,0 +1,23 @@
+# danger-shroud
+
+Danger plugin for reporting jacoco coverage reports to Danger.
+
+## Usage
+
+    Methods and attributes from this plugin are available in
+    your `Dangerfile` under the `shroud` namespace.
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+
+## TODO
+
+- [ ] Write real README
+- [ ] Add paramater for failing project threshold
+- [ ] Add paramater for failing modified file threshold
+- [ ] Add shroud to bridge
+- [ ] Write tests
+- [ ] Make public, released as a regular ol' gem

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-shroud.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shroud/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-shroud'
+  spec.version       = Shroud::VERSION
+  spec.authors       = ['andrewhaisting']
+  spec.email         = ['ahaisting@gmail.com']
+  spec.description   = %q{A short description of danger-shroud.}
+  spec.summary       = %q{A longer description of danger-shroud.}
+  spec.homepage      = 'https://github.com/andrewhaisting/danger-shroud'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yard"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  spec.add_dependency 'nokogiri'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require "shroud/plugin"

data/lib/danger_shroud.rb

@@ -0,0 +1 @@
+require "shroud/gem_version"

data/lib/shroud/gem_version.rb

@@ -0,0 +1,3 @@
+module Shroud
+  VERSION = "0.0.1".freeze
+end

data/lib/shroud/plugin.rb

@@ -0,0 +1,106 @@
+require 'nokogiri'
+
+module Danger
+  # This is your plugin class. Any attributes or methods you expose here will
+  # be available from within your Dangerfile.
+  #
+  # To be published on the Danger plugins site, you will need to have
+  # the public interface documented. Danger uses [YARD](http://yardoc.org/)
+  # for generating documentation from your plugin source, and you can verify
+  # by running `danger plugins lint` or `bundle exec rake spec`.
+  #
+  # You should replace these comments with a public description of your library.
+  #
+  class DangerShroud < Plugin
+
+    # Report coverage on diffed files, as well as overall coverage. 
+    # 
+    # file should reference a jacoco xml coverage report.
+    # totalProjectThreshold defines the threshold at which a warning will be emitted on total project coverage. deafult 0.
+    # modifiedFileThreshold defines the threshold at which a warning will be emitted on each modified file's coverage. default 0.
+    # failIfUnderThreshold when set to true will fail builds that fall under the above thresholds. default is false, which will warn.
+    #
+    # @return   [void]
+    def report(file, totalProjectThreshold = 0, modifiedFileThreshold = 0, failIfUnderThreshold = false)
+      raise "Please specify file name." if file.empty?
+      raise "No jacoco xml report found at #{file}" unless File.exist? file
+      rawXml = File.read(file)
+      parsedXml = Nokogiri::XML.parse(rawXml)
+      totalInstructionCoverage = parsedXml.xpath("/report/counter[@type='INSTRUCTION']")
+      missed = totalInstructionCoverage.attr("missed").value.to_i
+      covered = totalInstructionCoverage.attr("covered").value.to_i
+      total = missed + covered
+      coveragePercent = (covered / total.to_f) * 100
+
+      # get array of files names touched by this PR (modified + added)
+      touchedFileNames = @dangerfile.git.modified_files.map { |file| File.basename(file) }
+      touchedFileNames += @dangerfile.git.added_files.map { |file| File.basename(file) }
+
+      # used to later report files that were modified but not included in the jacoco report
+      fileNamesNotInJacocoReport = []
+
+      # hash for keeping track of coverage per filename: {filename => coverage percent}
+      touchedFilesHash = {}
+
+      touchedFileNames.each do |touchedFileName|
+        xmlForFileName = parsedXml.xpath("//class[@sourcefilename='#{touchedFileName}']/counter[@type='INSTRUCTION']")
+
+        if (xmlForFileName.length > 0)
+          missed = 0
+          covered = 0
+          xmlForFileName.each do |classCountXml|
+            missed += classCountXml.attr("missed").to_i
+            covered += classCountXml.attr("covered").to_i
+          end
+          touchedFilesHash[touchedFileName] = (covered.to_f / (missed + covered)) * 100
+        else
+          fileNamesNotInJacocoReport << touchedFileName
+        end
+      end
+
+      puts "Here are unreported files"
+      puts fileNamesNotInJacocoReport.to_s
+      puts "Here is the touched files coverage hash"
+      puts touchedFilesHash
+
+      output = "## 🧛 Project Code Coverage: **`#{'%.2f' % coveragePercent}%`**\n"
+
+      output << "### Coverage of Modified Files:\n"
+      output << "File | Coverage\n"
+      output << ":-----|:-----:\n"
+
+      # go through each file:
+      touchedFilesHash.sort.each do |fileName, coveragePercent|
+        output << "`#{fileName}` | **`#{'%.2f' % coveragePercent}%`**\n"
+
+        # warn or fail if under specified file threshold:
+        if (coveragePercent < modifiedFileThreshold)
+          warningMessage = "Uh oh! #{fileName} is under #{modifiedFileThreshold}% coverage!"
+          if (failIfUnderThreshold)
+            fail warningMessage
+          else 
+            warn warningMessage
+          end
+        end
+      end
+
+      output << "### Modified Files Not Found In Coverage Report:\n"
+      fileNamesNotInJacocoReport.sort.each do |unreportedFileName| 
+        output << "#{unreportedFileName}\n"
+      end
+
+      output << '> Codebase cunningly covered by count [Shroud 🧛](https://github.com/livefront/livefront-shroud-android/)'
+      markdown output
+
+      # warn or fail if total coverage is under specified threshold
+      if (coveragePercent < totalProjectThreshold)
+        totalCoverageWarning = "Uh oh! Your project is under #{totalProjectThreshold}% coverage!"
+        if (failIfUnderThreshold) 
+          fail totalCoverageWarning
+        else 
+          warn totalCoverageWarning
+        end
+      end
+    end
+  end
+end

data/spec/shroud_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+module Danger
+  describe Danger::DangerShroud do
+    it "should be a plugin" do
+      expect(Danger::DangerShroud.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # TODO test your custom attributes and methods here
+    #
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require "pathname"
+ROOT = Pathname.new(File.expand_path("../../", __FILE__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ''
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: danger-shroud
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- andrewhaisting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A short description of danger-shroud.
+email:
+- ahaisting@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- danger-shroud.gemspec
+- lib/danger_plugin.rb
+- lib/danger_shroud.rb
+- lib/shroud/gem_version.rb
+- lib/shroud/plugin.rb
+- spec/shroud_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/andrewhaisting/danger-shroud
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A longer description of danger-shroud.
+test_files:
+- spec/shroud_spec.rb
+- spec/spec_helper.rb