codeclimate-test-reporter 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGE4Y2ZjZDBmYzMyMzdhNzhkN2M1NGNhZWI5N2JkNWVmY2FjNzAxNA==
+  data.tar.gz: !binary |-
+    YTc5MjYzNTJmMGViZDdkNTQ5MzhkNjQ4MTE3ODYwMzM4OTk4NGIyMA==
+SHA512:
+  metadata.gz: !binary |-
+    MTM2ZTY3YWU4MjlmZTdlM2U2NjgyNDVlYTQ1NWI5Y2EwMmRkYTU0MjM3YTM3
+    N2I4YzJjZWZmNmM3NGNlNTkwMDQzNTFjNmZhY2M2YWUwMzQ3YTA4MTc0ZTVi
+    NGI2NjI5NmM3Yzg5MzEyNjJlNWZiYzE0NGIxZGFkNTczMDk3Mjg=
+  data.tar.gz: !binary |-
+    NDc4NzgxNWY5ZWQzMzA2NDBkYmYyMzY2MGJiNjVlYzhlZjZkNjdlMDYzZGY3
+    MzNlNDI0NWJiZWM0YTA0M2U1ZmIzYTg2NDQ1OTIzODEwYjdlMDJkZTVlMTRm
+    ZjM3YWFiNmVkZTY0ZWNjNTIyODIzNjZmNmEyNTA4YWI5Y2VlZTE=

data/README.md

@@ -14,9 +14,9 @@ first step is to create an account at: [https://codeclimate.com](https://codecli
 
 1. Add this to your Gemfile:
 
-        gem install "codeclimate-test-reporter", group: :test
+        gem "codeclimate-test-reporter", group: :test
 
-1. Start the test reporter **at the very beginning** of your `test_helper.rb` or
+1. Start the test reporter **on the very first line** of your `test_helper.rb` or
   `spec_helper.rb` file:
 
         require "codeclimate-test-reporter"
@@ -26,7 +26,7 @@ Then set the `CODECLIMATE_REPO_TOKEN` environment variable when you run your bui
 on your CI server, and the results will show up in your Code Climate account.
 
 The `CODECLIMATE_REPO_TOKEN` value is provided after you add your repo to your
-Code Climate account if you are in the test coverage private beta.
+Code Climate account by clicking on "Setup Test Coverage" on the right hand side of your feed.
 
 Please contact hello@codeclimate.com if you need any assistance setting this up.
 

data/lib/code_climate/test_reporter/configuration.rb

@@ -19,7 +19,7 @@ module CodeClimate
     end
 
     class Configuration
-      attr_accessor :branch, :logger, :profile
+      attr_accessor :branch, :logger, :profile, :path_prefix
 
       def logger
         @logger ||= default_logger

data/lib/code_climate/test_reporter/formatter.rb

@@ -5,6 +5,7 @@ require "digest/sha1"
 require "simplecov"
 
 require "code_climate/test_reporter/exception_message"
+require "code_climate/test_reporter/payload_validator"
 
 module CodeClimate
   module TestReporter
@@ -13,6 +14,7 @@ module CodeClimate
         print "Coverage = #{round(result.covered_percent, 2)}%. "
 
         payload = to_payload(result)
+        PayloadValidator.validate(payload)
         if tddium? || ENV["TO_FILE"]
           file_path = File.join(Dir.tmpdir, "codeclimate-test-coverage-#{SecureRandom.uuid}.json")
           print "Coverage results saved to #{file_path}... "
@@ -84,7 +86,8 @@ module CodeClimate
 
       def short_filename(filename)
         return filename unless ::SimpleCov.root
-        filename.gsub(::SimpleCov.root, '.').gsub(/^\.\//, '')
+        filename = filename.gsub(::SimpleCov.root, '.').gsub(/^\.\//, '')
+        apply_prefix filename
       end
 
       def tddium?
@@ -99,6 +102,12 @@ module CodeClimate
 
       private
 
+      def apply_prefix filename
+        prefix = CodeClimate::TestReporter.configuration.path_prefix
+        return filename if prefix.nil?
+        "#{prefix}/#{filename}"
+      end
+
       def ci_service_data
         @ci_service_data ||= Ci.service_data
       end

data/lib/code_climate/test_reporter/payload_validator.rb

@@ -0,0 +1,59 @@
+module CodeClimate
+  module TestReporter
+    InvalidPayload = Class.new(StandardError)
+
+    class PayloadValidator
+      def initialize(payload)
+        @payload = payload
+      end
+
+      def self.validate(payload)
+        new(payload).validate
+      end
+
+      def validate
+        raise InvalidPayload, "A git commit sha was not found in the test report payload" unless commit_sha
+        raise InvalidPayload, "A git commit timestamp was not found in the test report payload" unless committed_at
+        raise InvalidPayload, "A run at timestamp was not found in the test report payload" unless run_at
+        raise InvalidPayload, "No source files were found in the test report payload" unless source_files?
+        raise InvalidPayload, "Invalid source files were found in the test report payload" unless valid_source_files?
+        true
+      end
+
+    private
+
+      def commit_sha
+        commit_sha_from_git || commit_sha_from_ci_service
+      end
+
+      def committed_at
+        @payload[:git] && @payload[:git][:committed_at]
+      end
+
+      def run_at
+        @payload[:run_at]
+      end
+
+      def source_files?
+        @payload[:source_files] && @payload[:source_files].any?
+      end
+
+      def valid_source_files?
+        @payload[:source_files].all? { |s| valid_source_file?(s) }
+      end
+
+      def valid_source_file?(file)
+        file.is_a?(Hash) && file[:coverage] && file[:name]
+      end
+
+      def commit_sha_from_git
+        @payload[:git] && @payload[:git][:head]
+      end
+
+      def commit_sha_from_ci_service
+        @payload[:ci_service] && @payload[:ci_service][:commit_sha]
+      end
+    end
+
+  end
+end

data/lib/code_climate/test_reporter/version.rb

@@ -1,5 +1,5 @@
 module CodeClimate
   module TestReporter
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/spec/lib/configuration_spec.rb

@@ -13,6 +13,7 @@ module CodeClimate::TestReporter
         expect(CodeClimate::TestReporter.configuration.logger).to be_instance_of Logger
         expect(CodeClimate::TestReporter.configuration.logger.level).to eq Logger::INFO
         expect(CodeClimate::TestReporter.configuration.profile).to eq('test_frameworks')
+        expect(CodeClimate::TestReporter.configuration.path_prefix).to be_nil
       end
     end
 
@@ -47,6 +48,19 @@ module CodeClimate::TestReporter
 
         expect(CodeClimate::TestReporter.configuration.profile).to eq('custom')
       end
+
+      it 'stores path prefix' do
+        CodeClimate::TestReporter.configure do |config|
+          config.path_prefix = 'custom'
+        end
+
+        expect(CodeClimate::TestReporter.configuration.path_prefix).to eq('custom')
+
+        CodeClimate::TestReporter.configure do |config|
+          config.path_prefix = nil
+        end
+
+      end
     end
   end
 end

data/spec/lib/formatter_spec.rb

@@ -8,10 +8,10 @@ module CodeClimate::TestReporter
     let(:formatter) { Formatter.new }
     let(:files) {
       [
-        mock(
-          :lines            => [mock, mock, mock],
-          :covered_lines    => [mock, mock],
-          :missed_lines     => [mock],
+        double(
+          :lines            => [double, double, double],
+          :covered_lines    => [double, double],
+          :missed_lines     => [double],
           :filename         => project_file,
           :coverage         => [0,3,2,nil],
           :covered_percent  => 33.2,
@@ -21,7 +21,7 @@ module CodeClimate::TestReporter
     }
 
     let(:simplecov_result) {
-      mock(
+      double(
         :covered_percent  => 24.3,
         :covered_strength => 33.2,
         :files            => files,
@@ -98,4 +98,22 @@ module CodeClimate::TestReporter
       app.http_user_agent.should include("v#{CodeClimate::TestReporter::VERSION}")
     end
   end
+
+  describe '#short_filename' do
+    it 'should return the filename of the file relative to the SimpleCov root' do
+      CodeClimate::TestReporter::Formatter.new.short_filename('file1').should == 'file1'
+      CodeClimate::TestReporter::Formatter.new.short_filename("#{::SimpleCov.root}/file1").should == 'file1'
+    end
+
+    it 'should include the path prefix if set' do
+      CodeClimate::TestReporter.configure do |config|
+        config.path_prefix = 'custom'
+      end
+      CodeClimate::TestReporter::Formatter.new.short_filename('file1').should == 'custom/file1'
+      CodeClimate::TestReporter::Formatter.new.short_filename("#{::SimpleCov.root}/file1").should == 'custom/file1'
+      CodeClimate::TestReporter.configure do |config|
+        config.path_prefix = nil
+      end
+    end
+  end
 end

data/spec/lib/payload_validator_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+module CodeClimate::TestReporter
+  describe PayloadValidator do
+    let(:payload) {
+      {
+        git: {
+          committed_at: 1389603672,
+          head:         "4b968f076d169c3d98089fba27988f0d52ba803d"
+        },
+        run_at: 1379704336,
+        source_files: [
+          { coverage: "[0,3,4]", name: "user.rb" }
+        ]
+      }
+    }
+
+    it "does not raise if there's a minimally valid test report payload" do
+      expect {
+        PayloadValidator.validate(payload)
+      }.to_not raise_error
+    end
+
+    it "raises when there's no commit sha" do
+      payload[:git][:head] = nil
+      expect {
+        PayloadValidator.validate(payload)
+      }.to raise_error(InvalidPayload, /A git commit sha was not found/)
+    end
+
+    it "does not raise if there's a commit sha in ci_service data" do
+      payload[:git][:head] = nil
+      payload[:ci_service] = {}
+      payload[:ci_service][:commit_sha] = "4b968f076d169c3d98089fba27988f0d52ba803d"
+      expect {
+        PayloadValidator.validate(payload)
+      }.to_not raise_error
+    end
+
+    it "raises when there is no committed_at" do
+      payload[:git][:committed_at] = nil
+      expect {
+        PayloadValidator.validate(payload)
+      }.to raise_error(InvalidPayload, /A git commit timestamp was not found/)
+    end
+
+    it "raises when there's no run_at" do
+      payload[:run_at] = nil
+      expect {
+        PayloadValidator.validate(payload)
+      }.to raise_error(InvalidPayload, /A run at timestamp was not found/)
+    end
+
+    it "raises when no source_files parameter is passed" do
+      payload[:source_files] = nil
+      expect {
+        PayloadValidator.validate(payload)
+      }.to raise_error(InvalidPayload, /No source files were found/)
+    end
+
+    it "raises when there's no source files" do
+      payload[:source_files] = []
+      expect {
+        PayloadValidator.validate(payload)
+      }.to raise_error(InvalidPayload, /No source files were found/)
+    end
+
+    it "raises if source files aren't hashes" do
+      payload[:source_files] = [1,2,3]
+      expect {
+        PayloadValidator.validate(payload)
+      }.to raise_error(InvalidPayload, /Invalid source files/)
+    end
+
+    it "raises if source files don't have names" do
+      payload[:source_files] = [{ coverage: "[1,1]" }]
+      expect {
+        PayloadValidator.validate(payload)
+      }.to raise_error(InvalidPayload, /Invalid source files/)
+    end
+
+    it "raises if source files don't have coverage" do
+      payload[:source_files] = [{ name: "foo.rb" }]
+      expect {
+        PayloadValidator.validate(payload)
+      }.to raise_error(InvalidPayload, /Invalid source files/)
+    end
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate-test-reporter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Bryan Helmkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -25,7 +23,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -36,7 +33,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -44,7 +40,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -52,7 +47,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -60,7 +54,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -68,7 +61,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -76,7 +68,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -84,7 +75,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: artifice
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -92,7 +82,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -100,7 +89,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -108,7 +96,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -116,7 +103,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-debugger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -124,7 +110,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -154,43 +139,45 @@ files:
 - lib/code_climate/test_reporter/exception_message.rb
 - lib/code_climate/test_reporter/formatter.rb
 - lib/code_climate/test_reporter/git.rb
+- lib/code_climate/test_reporter/payload_validator.rb
 - lib/code_climate/test_reporter/version.rb
 - lib/codeclimate-test-reporter.rb
 - spec/lib/ci_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/formatter_spec.rb
 - spec/lib/git_spec.rb
+- spec/lib/payload_validator_spec.rb
 - spec/lib/test_reporter_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Uploads Ruby test coverage data to Code Climate.
 test_files:
 - spec/lib/ci_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/formatter_spec.rb
 - spec/lib/git_spec.rb
+- spec/lib/payload_validator_spec.rb
 - spec/lib/test_reporter_spec.rb
 - spec/spec_helper.rb