pullreview-coverage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43dbef35aeec4ac67f0b747299bc1bc04efba654
+  data.tar.gz: 22bbb19335f218f594a243262e3b5be15f538926
+SHA512:
+  metadata.gz: aab646b40c2f4e49689f9e092f7c17748daf23cb25580a204b3bf8c0811dc366d076b4b77c3dfbe71836f3b189fcc4d3cf7a55c7437c9dc794a8a93d54d3cdbb
+  data.tar.gz: 03fb513a645b250673185a6b14182c7b2eaf9a8bfcdae47a965e7a597d19e939b1bb57d89cbd8bb2d72386648b6288d82a61afc666a7ad6f4f3f8c847288678f

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pullreview-coverage.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+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,56 @@
+# Pullreview::Coverage
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test, :development do
+  # .... your other test gem like simplecov
+  gem 'pullreview-coverage', require: false
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Adapt your SimpleCov Formatter listing to add the PullReview formatter.
+This formatter will post over https the coverage report and a few additional informations.
+
+```ruby
+require 'simplecov'
+require 'simplecov-rcov'
+require 'pullreview/coverage'
+
+formatters = [SimpleCov::Formatter::HTMLFormatter]
+formatters << SimpleCov::Formatter::RcovFormatter if ENV['BUILD_ID'] # sample jenkins-ci formatter
+formatters << PullReview::Coverage::Formatter
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+
+```
+
+## How can I check the content submitted to pullreview
+
+In your project directory, launch
+
+```
+PULLREVIEW_REPO_TOKEN=4564654 PULLREVIEW_COVERAGE_TO_FILE=true rake test
+....
+PullReview::Coverage : info : Generated /tmp/coverage-8c2c37dd-8412-4137-9b38-7147c1662140.json
+```
+
+A json file will be generated in /tmp/ the content might change a little bit depending on your environment (dev, ci)
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/pullreview-coverage/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/pullreview/coverage/client_api.rb

@@ -0,0 +1,109 @@
+require 'securerandom'
+require 'tmpdir'
+
+module PullReview
+  module Coverage
+    # Local file based implementation
+    # ease testing/debugging coverage report content generation
+    class LocalFileApi
+      attr_reader :config
+
+      def initialize(config)
+        @config = config || Config.new
+      end
+
+      # generate a random file in tmp dir with the same json payload (except pretty formatted)
+      def publish(payload)
+        file_path = File.join(Dir.tmpdir, "coverage-#{SecureRandom.uuid}.json")
+        File.open(file_path, 'w') { |file| file.write(JSON.pretty_generate(payload)) }
+        PullReview::Coverage.log(:info, "Generated #{file_path}")
+        file_path
+      end
+    end
+
+    # Remote api based implementation for production intent
+    class ClientApi
+      attr_reader :config
+
+      def initialize(config)
+        @config = config || Config.new
+      end
+
+      # post json payload to pullreview host.
+      def publish(payload)
+        allow_pullreview_webmock
+        allow_pullreview_vcr
+        response = post(payload)
+        "#{response.code} : #{response.body}"
+      end
+
+      private
+
+      # post the payload and return exception if error occured.
+      def post(payload)
+        response = http(config.api_uri).request(zipped_post(config.api_uri, payload))
+        if response.code.to_i >= 200 && response.code.to_i < 300
+          response
+        else
+          raise "HTTP Error: #{response.code} #{config.api_uri}"
+        end
+      end
+
+      # return Net::HTTP::Post with gzipped json payload
+      def zipped_post(uri, payload)
+        request = Net::HTTP::Post.new(uri.path)
+        request['User-Agent'] = config.user_agent
+        request['X-Repo-Token'] = config.repo_token
+        request['Content-Type'] = 'application/json'
+        request['Content-Encoding'] = 'gzip'
+        request.body = compress(payload.to_json)
+
+        request
+      end
+
+      # return gzipped str
+      def compress(str)
+        sio = StringIO.new('w')
+        # don't use the block notation for StringIO
+        # https://bugs.ruby-lang.org/issues/8935
+        gz = Zlib::GzipWriter.new(sio)
+        gz.write(str)
+        gz.close
+        sio.string
+      end
+
+      # Return an Net::HTTP configured with timeout and https certificate verification if necessary
+      def http(uri)
+        Net::HTTP.new(uri.host, uri.port).tap do |http|
+          if uri.scheme == 'https'
+            http.use_ssl = true
+            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+            http.verify_depth = 5
+          end
+          http.open_timeout = config.api_open_timeout_in_seconds
+          http.read_timeout = config.api_read_timeout_in_seconds
+        end
+      end
+
+      # white list the pullreview host for webmock
+      def allow_pullreview_webmock
+        if defined?(WebMock) && allow = WebMock::Config.instance.allow || []
+          WebMock::Config.instance.allow = [*allow].push(config.api_host)
+        end
+      end
+
+      # white list the pullreview host for vcr
+      def allow_pullreview_vcr
+        if defined?(VCR)
+          VCR.send(VCR.version.major < 2 ? :config : :configure) do |c|
+            c.ignore_hosts(config.api_host)
+          end
+        end
+      end
+
+      def to_s
+        "ClientApi : #{config.api_uri}"
+      end
+    end
+  end
+end

data/lib/pullreview/coverage/config.rb

@@ -0,0 +1,51 @@
+require 'uri'
+module PullReview
+  module Coverage
+    # PullReview api coverage settings, allow overwriting via ENV for dev/testing
+    class Config
+      def api_host
+        ENV['PULLREVIEW_HOST'] || 'www.pullreview.com'
+      end
+
+      def api_protocol
+        ENV['PULLREVIEW_PROTOCOL'] || 'https'
+      end
+
+      def api_port
+        ENV['PULLREVIEW_PORT'] || '443'
+      end
+
+      def api_to_file?
+        !!ENV['PULLREVIEW_COVERAGE_TO_FILE']
+      end
+
+      def api_read_timeout_in_seconds
+        ENV['PULLREVIEW_READ_TIMEOUT_S'] || 5
+      end
+
+      def api_open_timeout_in_seconds
+        ENV['PULLREVIEW_OPEN_TIMEOUT_S'] || 5
+      end
+
+      def api_https_cacert
+        File.expand_path('../../../../config/cacert.pem', __FILE__)
+      end
+
+      def user_agent
+        "PullReview::Coverage.#{VERSION}"
+      end
+
+      def repo_token
+        ENV['PULLREVIEW_REPO_TOKEN']
+      end
+
+      def should_run?
+        !!repo_token
+      end
+
+      def api_uri
+        URI("#{api_protocol}://#{api_host}:#{api_port}/api/coverage")
+      end
+    end
+  end
+end

data/lib/pullreview/coverage/continuous_build.rb

@@ -0,0 +1,122 @@
+module PullReview
+  module Coverage
+    # Various continuous build providers
+    module ContinousBuild
+      # https://travis-ci.org/
+      class TravisCi
+        def enabled?
+          !!ENV['TRAVIS']
+        end
+        #:nodoc
+        def infos
+          {
+            name: 'travis-ci',
+            branch: ENV['TRAVIS_BRANCH'],
+            build_id: ENV['TRAVIS_JOB_ID'],
+            pull_request: ENV['TRAVIS_PULL_REQUEST']
+          }
+        end
+      end
+
+      # https://circleci.com/
+      class CircleCi
+        def enabled?
+          !!ENV['CIRCLECI']
+        end
+
+        #:nodoc
+        def infos
+          {
+            name: 'circleci',
+            build_id: ENV['CIRCLE_BUILD_NUM'],
+            branch: ENV['CIRCLE_BRANCH'],
+            commit_sha: ENV['CIRCLE_SHA1']
+          }
+        end
+      end
+
+      # https://semaphoreapp.com/
+      class Semaphore
+        def enabled?
+          !!ENV['SEMAPHORE']
+        end
+
+        #:nodoc
+        def infos
+          {
+            name: 'semaphore',
+            branch: ENV['BRANCH_NAME'],
+            build_id: ENV['SEMAPHORE_BUILD_NUMBER']
+          }
+        end
+      end
+
+      # http://jenkins-ci.org/
+      class Jenkins
+        def enabled?
+          !!ENV['JENKINS_URL']
+        end
+
+        #:nodoc
+        def infos
+          {
+            name: 'jenkins',
+            build_id: ENV['BUILD_NUMBER'],
+            build_url: ENV['BUILD_URL'],
+            branch: ENV['GIT_BRANCH'],
+            commit_sha: ENV['GIT_COMMIT']
+          }
+        end
+      end
+
+      # https://www.codeship.io/
+      class Codeship
+        def enabled?
+          ENV['CI_NAME'] =~ /codeship/i
+        end
+
+        #:nodoc
+        def infos
+          {
+            name: 'codeship',
+            build_id: ENV['CI_BUILD_NUMBER'],
+            build_url: ENV['CI_BUILD_URL'],
+            branch: ENV['CI_BRANCH'],
+            commit_sha: ENV['CI_COMMIT_ID']
+          }
+        end
+      end
+
+      # Damned you should really get one !
+      class None
+        def enabled?
+          true
+        end
+
+        #:nodoc
+        def infos
+          {}
+        end
+      end
+
+      # return hash with ci build info like
+      # name, build_id, build_url, branch, commit_sha if provided via ENV
+      def self.infos
+        provider.infos
+      end
+
+      private
+
+      def self.provider
+        [
+          TravisCi.new,
+          CircleCi.new,
+          Semaphore.new,
+          Jenkins.new,
+          Codeship.new,
+          None.new
+        ].find { |ci| ci.enabled? }
+      end
+    end
+  end
+end

data/lib/pullreview/coverage/formatter.rb

@@ -0,0 +1,82 @@
+module PullReview
+  module Coverage
+    # A simplecov Formatter implementation
+    # see README.md for usage.
+    class Formatter
+      # Simplecov callback to format report
+      def format(result)
+        return unless config.should_run?
+        response = api.publish(to_payload(result))
+        PullReview::Coverage.log(:info, "Coverage report ok #{api} : #{response}")
+      rescue => e
+        PullReview::Coverage.log(:error, "Coverage report submission failed #{api}", e)
+      end
+
+      def config
+        @config ||= PullReview::Coverage::Config.new
+      end
+
+      # return based on config a remote api client or a local file implementation.
+      def api
+        config.api_to_file? ? PullReview::Coverage::LocalFileApi.new(config) : PullReview::Coverage::ClientApi.new(config)
+      end
+
+      # Transform simplecov result to huge hash.
+      def to_payload(result)
+        totals = Hash.new(0)
+        sources = sources_coverage(result, totals)
+        {
+          repo_token: config.repo_token,
+          files_coverage: sources,
+          run_at: result.created_at.to_i,
+          covered_percent: round(result.covered_percent, 2),
+          covered_strength: round(result.covered_strength, 2),
+          line_counts: totals,
+          git_info: Git.new.infos,
+          environment: {
+            test_framework: result.command_name.downcase,
+            pwd: Dir.pwd,
+            rails_root: (Rails.root.to_s rescue nil),
+            simplecov_root: ::SimpleCov.root,
+            gem_version: VERSION
+          },
+          ci_info: ContinousBuild.infos
+        }
+      end
+
+      # return array of hash with coverage details for each files
+      # a side effect is calculating the coverage's totals
+      def sources_coverage(result, totals)
+        sources = result.files.map do |file|
+          file_name = short_filename(file.filename)
+          next if file_name.start_with?('vendor')
+          totals[:total] += file.lines.count
+          totals[:covered] += file.covered_lines.count
+          totals[:missed] += file.missed_lines.count
+          {
+            name: file_name,
+            coverage_details: file.coverage.to_json,
+            covered_percent: round(file.covered_percent, 2),
+            covered_strength: round(file.covered_strength, 2),
+            line_counts: {
+              total: file.lines.count,
+              covered: file.covered_lines.count,
+              missed: file.missed_lines.count
+            }
+          }
+        end
+        sources
+      end
+
+      def short_filename(filename)
+        return filename unless ::SimpleCov.root
+        filename = filename.gsub(::SimpleCov.root, '.').gsub(/^\.\//, '')
+        filename
+      end
+
+      def round(numeric, precision)
+        Float(numeric).round(precision)
+      end
+    end
+  end
+end

data/lib/pullreview/coverage/git.rb

@@ -0,0 +1,83 @@
+module PullReview
+  module Coverage
+    # Fetch git infos
+    class Git
+      # return hash with head,
+      #   head: all commit information
+      #      sha, author, committer, message, committed_at
+      #   remotes: list of git urls (name url)
+      #   committed_at: commit time(as UNIX timestamp)
+      #   branch: name of the branch.
+      def infos
+        {
+          head: last_commit,
+          remotes: remotes,
+          branch: branch_from_git_or_continuous_build
+        }
+      end
+
+      private
+
+      def last_commit
+        {
+          sha: `git log -1 --pretty=format:'%H'`.strip,
+          author_name: `git log -1 --pretty=format:'%aN'`.strip,
+          author_email: `git log -1 --pretty=format:'%ae'`.strip,
+          committer_name: `git log -1 --pretty=format:'%cN'`.strip,
+          committer_email:  `git log -1 --pretty=format:'%ce'`.strip,
+          message:  `git log -1 --pretty=format:'%s'`.strip,
+          committed_at: committed_at
+        }
+      end
+
+      def remotes
+        remotes = nil
+        begin
+          remotes = `git remote -v`.split(/\n/).map do |remote|
+            splits = remote.split(' ').compact
+            { name: splits[0], url: splits[1] }
+          end.uniq
+        rescue => e
+          PullReview::Coverage.log(:warn, 'failed to fetch remotes urls', e)
+        end
+        remotes
+      end
+
+      # Cover case when fetching the branch name isn't obvious
+      #   git clone --depth=50 git://github.com/rails/rails.git rails/rails
+      #   cd rails/rails
+      #   git fetch origin +refs/pull/14423/merge:
+      #   git checkout -qf FETCH_HEAD
+      #   git branch
+      #   /tmp/rails/rails [:cb7ba03] > git branch
+      #   * (no branch)
+      #   master
+      def branch_from_git_or_continuous_build
+        git_branch = branch_from_git
+        ci_branch = ContinousBuild.infos[:branch]
+        branch = 'master'
+        if ci_branch.to_s.strip.size > 0
+          branch = ci_branch
+        elsif git_branch.to_s.strip.size > 0 && !git_branch.to_s.strip.start_with?('(')
+          branch = git_branch
+        end
+        cleanup_branch(branch)
+      end
+
+      def cleanup_branch(branch)
+        branch.sub(/^origin\//, '')
+      end
+
+      def committed_at
+        committed_at = `git log -1 --pretty=format:'%ct'`
+        committed_at.to_i.zero? ? nil : committed_at.to_i
+      end
+
+      def branch_from_git
+        branch = `git branch`.split("\n").delete_if { |i| i[0] != '*' }
+        branch = [branch].flatten.first
+        branch ? branch.gsub('* ', '') : nil
+      end
+    end
+  end
+end

data/lib/pullreview/coverage/version.rb

@@ -0,0 +1,6 @@
+module PullReview
+  module Coverage
+    # gem version
+    VERSION = '0.0.1'
+  end
+end

data/lib/pullreview/coverage.rb

@@ -0,0 +1,22 @@
+# https://www.pullreview.com
+module PullReview
+  # Collect coverage report to generate action points for the review.
+  module Coverage
+    # log to stdout message and optional exception at a given level
+    def self.log(level, message, exception = nil)
+      full_message = ["PullReview::Coverage : #{level} : #{message}"]
+      if exception
+        full_message << "#{exception.message} #{exception.class}"
+        full_message << exception.backtrace.join("\n")
+      end
+      puts full_message.join("\n")
+    end
+  end
+end
+
+require_relative 'coverage/version'
+require_relative 'coverage/config'
+require_relative 'coverage/continuous_build'
+require_relative 'coverage/git'
+require_relative 'coverage/client_api'
+require_relative 'coverage/formatter'

data/pullreview-coverage.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pullreview/coverage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pullreview-coverage'
+  spec.version       = PullReview::Coverage::VERSION
+  spec.authors       = ['Stephan Mestach']
+  spec.email         = ['stephan.mestach@8thcolor.com']
+  spec.summary       = %q{Collect coverage information and send them to PullReview.com}
+  spec.description   = %q{Collect coverage information generated by simplecov and send them to PullReview.com}
+  spec.homepage      = 'https://www.pullreview.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'simplecov', '>= 0.7.1', '< 1.0.0'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: pullreview-coverage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephan Mestach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Collect coverage information generated by simplecov and send them to
+  PullReview.com
+email:
+- stephan.mestach@8thcolor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pullreview/coverage.rb
+- lib/pullreview/coverage/client_api.rb
+- lib/pullreview/coverage/config.rb
+- lib/pullreview/coverage/continuous_build.rb
+- lib/pullreview/coverage/formatter.rb
+- lib/pullreview/coverage/git.rb
+- lib/pullreview/coverage/version.rb
+- pullreview-coverage.gemspec
+homepage: https://www.pullreview.com
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Collect coverage information and send them to PullReview.com
+test_files: []