pullreview-coverage 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef06d79e9efa5c30cfcfa6dd5299e6b5dfec7fea
-  data.tar.gz: 1ab33b44a0ccddbc33d48c74c83fef2273f580ed
+  metadata.gz: d438d852e093bfb8bb27ca1e06a4c4f870b814a9
+  data.tar.gz: 43ebb1a326a15c79111fcae39f19bff8d07c559f
 SHA512:
-  metadata.gz: 3ab989b12023f0e613003906a911b627076005710cbc3aadf09796f39124c160ab5fc307016d72ad4bae5d5d0624dc6b89fbc266db6407c8497b31aa5a036247
-  data.tar.gz: 061c8ab4aaf6313f9d018d382abb826ad9e41e7b8ecb3698a3d557ab30759248ca74a4cf936ab62d93f89751f8409a0925a25dbeccea06ba305fa1c48a0b2510
+  metadata.gz: f4ed289d452e6fd2eef6fd362ec266ae32543dca9f26f53465398146b8db7b21be99c11a3f77e36f667dce546becce50260688c65d625cba55c448d0819ae650
+  data.tar.gz: b1da38b690252fc1bf0d64e142e5ffdb5e5c94f44209871020ef878b880a97c271e037a84eee17674657a30ded55b41bbaa5ed206b83e8495834224458714413

data/.pullreview.yml

@@ -0,0 +1,5 @@
+---
+notifications:
+  pullrequest:
+    comment: verbose
+

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.0.3] - 2015-03-11
+### Added
+- include into payload the URI of the build for Semaphore
+
+### Fixed
+- fix spec helper ENV allowing to update ENV for a test

data/README.md

@@ -2,59 +2,92 @@
 
 [![PullReview stats](https://www.pullreview.com/github/8thcolor/pullreview-coverage/badges/master.svg?type=full)](https://www.pullreview.com/github/8thcolor/pullreview-coverage/reviews/master)
 
-TODO: Write a gem description
+With the Gem PullReview-Coverage, you can retrieve your **Ruby test coverage** into PullReview.
 
-## Installation
+## How it works?
 
-Add this line to your application's Gemfile:
+Maintaining an environment to run your tests is hard and out of the scope of PullReview, and you probably already launch your tests via a self hosted continuous integration (CI) server ([Jenkins](http://jenkins-ci.org/), [GitLab CI](https://about.gitlab.com/gitlab-ci/)) or hosted CI service. The idea is to add a Gem and configure it to collect the coverage reports, and then to submit them to PullReview just after the tests are completed. PullReview will process them and map them to the current review, and add actions for the uncovered methods/classes.
 
-```ruby
-group :test, :development do
-  # .... your other test gem like simplecov
+Depending on race condition between PullReview and your CI-Server, you will have reviews with or without coverage related actions. If you have multiple test-suites, running on multiple nodes, PullReview will merge the coverage reports. If [PullReview](https://pullreview.com) isn't available at the report submission time, note that the build won't fail. 
+
+## Setup your project
+
+Update Gemfile for `:test`
+
+Add the following in `:test` group.
+
+```Ruby
+group :test do
   gem 'pullreview-coverage', require: false
 end
 ```
 
-And then execute:
+Once done, run a `bundle install` and commit your modified `Gemfile` and `Gemfile.lock`.
 
-    $ bundle
+Note: this Gem is [open-source](https://github.com/8thcolor/pullreview-coverage) and available via [RubyGems](https://rubygems.org/gems/pullreview-coverage).
 
 ## 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.
+### If you don't already use simplecov
+
+You can simply enable the coverage report by adding the following lines in your `{spec,test}_helper.rb`:
+
+```Ruby
+require 'pullreview/coverage_reporter'
+PullReview::CoverageReporter.start
+```
 
-```ruby
+### If you use already simplecov
+
+Add our formatter in your `{spec,test}_helper.rb`:
+
+```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 = []
+... # your other formatters (html ?)
 formatters << PullReview::Coverage::Formatter
-
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
-
 ```
+## Setup in your CI build
 
-Or if you do not use SimpleCov yet,
+Add an environment variable with your repository token
 
-```ruby
-require 'pullreview/coverage_reporter'
-PullReview::CoverageReporter.start
+```Bash
+PULLREVIEW_REPO_TOKEN=<your repo token> rake test 
 ```
 
-## How can I check the content submitted to pullreview
+Depending on the CI you use, you can pass that token via the environment variable `PULLREVIEW_REPO_TOKEN`, prefer the encrypted option if available:
+
+* [Circle-CI](https://circleci.com/docs/environment-variables#setting-environment-variables-for-all-commands-without-adding-them-to-git)
+* [Codeship](https://www.codeship.io/documentation/continuous-integration/set-environment-variables/)
+* [Semaphore](https://semaphoreapp.com/docs/exporting-environment-variables.html)
+* [Travis-CI ](http://docs.travis-ci.com/user/build-configuration/#Secure-environment-variables)
+
+## Finally trigger a build
 
-In your project directory, launch
+If the Gemfile modification is merged in your integration branch, new actions about test coverage could be now reported in the corresponding review.
+
+## FAQ
+
+### 1. I don't see any test coverage information in the reviews?
+
+Checkout the logs of your CI-build, and looks for stacktraces/messages related to PullReview coverage.
 
 ```
-PULLREVIEW_REPO_TOKEN=4564654 PULLREVIEW_COVERAGE_TO_FILE=true rake test
-....
+PullReview::Coverage : info : Coverage report ok ClientApi : https://www.pullreview.com/api/coverage : 200 : {"message":"Invalid repository token"}
+```
+
+### 2. How can I check the content submitted to PullReview?
+
+You could check the content submitted to PullReview by running in your project directory the following:
+```Bash
+PULLREVIEW_REPO_TOKEN=<token> 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)
+A JSON file will be generated in `/tmp/`. The content might change a little bit depending on your environment (dev, CI).
 
 ## Contributing
 

data/lib/pullreview/coverage/client_api.rb

@@ -1,5 +1,6 @@
 require 'securerandom'
 require 'tmpdir'
+require 'net/http'
 
 module PullReview
   module Coverage

data/lib/pullreview/coverage/continuous_build.rb

@@ -46,9 +46,20 @@ module PullReview
           {
             name: 'semaphore',
             branch: ENV['BRANCH_NAME'],
-            build_id: ENV['SEMAPHORE_BUILD_NUMBER']
+            build_id: ENV['SEMAPHORE_BUILD_NUMBER'],
+            build_url: build_url(
+                        ENV['SEMAPHORE_REPO_SLUG'],
+                        ENV['BRANCH_NAME'],
+                        ENV['SEMAPHORE_BUILD_NUMBER']
+                      )
           }
         end
+
+        private
+
+        def build_url(repo_slug, branch_name, build_number)
+          "https://semaphoreci.com/#{repo_slug}/branches/#{branch_name}/builds/#{build_number}"
+        end
       end
 
       # http://jenkins-ci.org/

data/lib/pullreview/coverage/version.rb

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

data/pullreview-coverage.gemspec

@@ -6,8 +6,8 @@ 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.authors       = ['Stephan Mestach', 'Christophe Philemotte']
+  spec.email         = ['support@pullreview.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'

data/spec/coverage/continous_build_spec.rb

@@ -21,4 +21,20 @@ describe PullReview::Coverage::ContinousBuild do
       )
     end
   end
+
+  it 'should support semaphore' do
+    with_env(
+      'SEMAPHORE' => 'true',
+      'BRANCH_NAME' => 'feature/super',
+      'SEMAPHORE_BUILD_NUMBER' => '123',
+      'SEMAPHORE_REPO_SLUG' => 'account/project'
+    ) do
+      PullReview::Coverage::ContinousBuild.infos.must_equal(
+        name: 'semaphore',
+        branch: 'feature/super',
+        build_id: '123',
+        build_url: 'https://semaphoreci.com/account/project/branches/feature/super/builds/123'
+      )
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -8,8 +8,10 @@ require_relative '../lib/pullreview/coverage.rb'
 
 def with_env(options, &block)
   backup = ENV.to_h
+  ENV.clear
   ENV.update(options)
   yield
 ensure
+  ENV.clear
   ENV.update(backup)
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pullreview-coverage
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Stephan Mestach
+- Christophe Philemotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -89,12 +90,14 @@ dependencies:
 description: Collect coverage information generated by simplecov and send them to
   PullReview.com
 email:
-- stephan.mestach@8thcolor.com
+- support@pullreview.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".pullreview.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -132,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Collect coverage information and send them to PullReview.com