simplecov_s3_codeclimate 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06e1440f057237a77b87ebacb357b63bba47152c
+  data.tar.gz: 1596f444e315d5a4e373a773128057d9a1e3f00a
+SHA512:
+  metadata.gz: c15eed43527e1e4e9e178d133a720ab1dec77212d8dffcae9165c61f0f3851b855a4696b6041fa9f80646c3f0787debe2b6caf36e09fb1374669dbb309caba9d
+  data.tar.gz: 600c42e6f2ea57ee9b8a857acd2c44a998ba0552f5337428bbf9e44e329d441d305bde9f6e59e4602fec6d52c685684a49b429db2b0ff7b661eba618b019a3fe

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--format documentation --colour

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'pry'
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Engine Yard
+
+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,69 @@
+# simplecov_s3_codeclimate
+
+Sample Usage:
+
+`Gemfile`
+
+```ruby
+group :test do
+  gem 'simplecov_s3_codeclimate'
+end
+```
+
+`config/environment.rb`
+
+```ruby
+require File.expand_path('../application', __FILE__)
+
+if Rails.env.test?
+  require File.expand_path("../../spec/coverage_helper", __FILE__)
+end
+```
+
+`spec/coverage_helper.rb`
+
+```ruby
+unless ENV["SKIP_COVERAGE"]
+  require 'simplecov'
+  SimpleCov.start(:rails)
+  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+  end
+  # Yes this is a hack, the most reliable way to ensure that simplecov doesn't de-dupe your coverage results for having the same command_name: "rspec"
+  command_name "Test #{ARGV[0]}"
+  SimpleCov.merge_timeout 3600
+end
+```
+
+`lib/tasks/codeclimate_coverage.rake`
+
+```ruby
+task :coverage do
+  require File.expand_path("../spec/coverage_helper", __FILE__)
+  cov = SimpleCov::S3::Codeclimate.new(
+    :fog => {
+      provider: 'AWS',
+      aws_access_key_id: "AWS_ACCESS_KEY_ID",
+      aws_secret_access_key: "AWS_SECRET_ACCESS_KEY",
+      region: "us-east-1",
+    },
+    project_name: "PROJECT_NAME",
+    build_id: "BUILD_ID", # Unique identifier for a CI build
+    build_unit: "BUILD_UNIT", # Unique identifier for a test run within a CI build
+    build_units: 1, # Total number of build_units within a CI build
+    bucket_name: "S3_BUCKET_NAME",
+    shared_secret: "XXXXXXXXXXXX", # Used so build units can find each other,
+    subfolder: 'OPTIONAL_SUBFOLDER' # Subfolder in S3 Bucket to store temp data
+  )
+  cov.push_partial
+  cov.pull_merge_and_push_full
+end
+```
+
+.gitinore:
+
+    #ignore generated coverage results
+    coverage
+
+You must also have `CODECLIMATE_REPO_TOKEN` in your environment. See [their documentation](https://github.com/codeclimate/ruby-test-reporter) for more info.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end

data/lib/simplecov_s3_codeclimate/version.rb

@@ -0,0 +1,7 @@
+module SimpleCov
+  module S3
+    class Codeclimate
+      VERSION = '0.2'
+    end
+  end
+end

data/lib/simplecov_s3_codeclimate.rb

@@ -0,0 +1,108 @@
+require 'digest'
+require 'securerandom'
+require 'excon'
+require 'fog'
+require 'simplecov'
+require 'json'
+require 'codeclimate-test-reporter'
+
+module SimpleCov
+  module S3
+    class Codeclimate
+      def self.ensured(task_to_invoke, &_block)
+        Rake::Task[task_to_invoke].invoke
+      ensure
+        begin
+          yield
+        rescue => exception
+          puts exception.inspect
+          puts exception.backtrace
+        end
+      end
+
+      def initialize(opts)
+        @connection = Fog::Storage.new(opts[:fog])
+        @shared_secret = opts[:shared_secret]
+        @bucket_name = opts[:bucket_name]
+        @subfolder = opts[:subfolder] || ''
+        @build_units = opts[:build_units].to_i
+        @build_unit = opts[:build_unit]
+        @build_id = opts[:build_id]
+        @project_name = opts[:project_name] || 'unknown'
+        @project_name = 'unknown' if @project_name.empty?
+        @history_limit = opts[:history_limit] || 15
+      end
+
+      def push_partial
+        result = SimpleCov::ResultMerger.merged_result
+        data_to_push = result.original_result.merge('BUILD_UNIT' => @build_unit).to_json
+        put_file("#{@project_name}-#{commit_time}-coverageJSON/#{hashed_build_id}/#{@build_unit}", data_to_push)
+      rescue => exception
+        puts exception.inspect
+        puts exception.backtrace
+        puts 'SOMEHTING WENT WRONG, PUSHING EMPTY COVERAGE FILE'
+        put_file("#{@project_name}-#{commit_time}-coverageJSON/#{hashed_build_id}/#{@build_unit}", {}.to_json)
+      end
+
+      def pull_merge_and_push_full
+        json_files_size = json_files.size
+        if json_files_size < @build_units
+          puts "Expected to see #{@build_units} files"
+          puts "currently only #{json_files_size}"
+          require 'pp'
+          pp json_files.map(&:key)
+          puts 'Assuming some other build unit will be the last to exit, and merge/post full coverage'
+          return false
+        end
+        puts "Coverage combined from #{json_files_size} units"
+        results = []
+        included_units = []
+        json_files.each do |file|
+          parsed = JSON.parse(file.body)
+          included_units << parsed.delete('BUILD_UNIT')
+          results << SimpleCov::Result.new(parsed)
+        end
+        puts "Included units: #{included_units.sort_by(&:to_s).inspect}"
+        merged = {}
+        results.each do |result|
+          merged = result.original_result.merge_resultset(merged)
+        end
+        result = SimpleCov::Result.new(merged)
+        CodeClimate::TestReporter::Formatter.new.format(result)
+        cleanup_files
+      end
+
+      private
+
+      def cleanup_files
+        json_files.each(&:destroy)
+        all_files = @connection.directories.get(@bucket_name, prefix: @project_name).files
+        return unless all_files.size > @history_limit
+        all_files.sort_by(&:last_modified)[0, all_files.size - @history_limit].each do |file|
+          puts "Cleaning up #{file.key}"
+          file.destroy
+        end
+      end
+
+      def put_file(path, data)
+        puts "Putting to #{path} data size #{data.size}"
+        @connection.directories.get(@bucket_name).files.create(key: "#{@subfolder}/#{path}", body: data, content_type: 'text/html')
+      end
+
+      def json_files
+        expected_dir = "#{@subfolder}/#{@project_name}-#{commit_time}-coverageJSON/#{hashed_build_id}/"
+        @connection.directories.get(@bucket_name, prefix: expected_dir).files
+      end
+
+      def commit_time
+        @commit_time ||= DateTime.parse(`git show | grep Date`.gsub('Date:', '').strip).strftime('%s')
+      end
+
+      def hashed_build_id
+        @hashed_build_id ||= begin
+          Digest::SHA1.hexdigest(@build_id + @shared_secret)
+        end
+      end
+    end
+  end
+end

data/simplecov-s3-codeclimate.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'simplecov_s3_codeclimate/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'simplecov_s3_codeclimate'
+  s.version     = SimpleCov::S3::Codeclimate::VERSION
+  s.authors     = ['Jacob', 'Jonah Hirsch']
+  s.email       = %w(jacob@engineyard.com jonah@giftcardzen.com)
+  s.homepage    = 'https://github.com/giftcardzen/simplecov-s3'
+  s.summary     = 'Merge simplecov output using S3 as shared storage (and publish the results to Codeclimate)'
+  s.description = 'Merges simplecov output using S3 as shared storage. Once all coverage is compiled, pushes this data to Codeclimate.'
+  s.license     = 'MIT'
+
+  s.files         = (`git ls-files`.split("\n") - `git ls-files -- fake`.split("\n"))
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec', '~> 0'
+  s.add_development_dependency 'reek', '~> 0'
+  s.add_development_dependency 'rubocop', '~> 0'
+  s.add_runtime_dependency 'fog', '~> 0'
+  s.add_runtime_dependency 'simplecov', '~> 0'
+  s.add_runtime_dependency 'codeclimate-test-reporter', '~> 0'
+end

data/spec/a_spec.rb

@@ -0,0 +1,43 @@
+require 'simplecov-s3-codeclimate'
+require 'rspec'
+require 'pry'
+
+describe SimpleCov::S3 do
+
+  it "is just barely tested" do
+    Fog.mock!
+    def Excon.post(*args)
+      puts "Mocked!"
+    end
+    #TODO: generate some coverage data via SimpleCov.start ?
+    fog_opts = {
+        :provider => 'AWS',
+        :aws_access_key_id => "XXXXXX",
+        :aws_secret_access_key => "XXXXXXXXXXXXX",
+        :region => "us-east-1",
+      }
+    s3conn = Fog::Storage.new(fog_opts)
+    s3conn.directories.create(:key => "somebucket")
+    cov_opts = {
+      :fog => fog_opts,
+      :project_name => "ey/simplecov-s3", #ENV["TRAVIS_REPO_SLUG"],
+      :build_id => "123", #ENV["TRAVIS_BUILD_ID"],
+      :job_id => "456", #ENV["TRAVIS_JOB_ID"],
+      :build_unit => "5", #ENV["BUILD_UNIT"],
+      :build_units => 2,
+      :bucket_name => "somebucket",
+      :public_url_base => "http://somebucket.s3-website-us-east-1.amazonaws.com/",
+      :assets_url => "http://somebucket.s3-website-us-east-1.amazonaws.com/assets",
+      :shared_secret => "XXXXXXXXXXXX", #used so build units can find each other, and for covereage postback
+      :postback_url => "https://bot.example.org/coverage",
+    }
+    cov = SimpleCov::S3.new(cov_opts)
+    cov.push_partial
+    cov.pull_merge_and_push_full
+    cov2 = SimpleCov::S3.new(cov_opts.merge(:job_id => "457", :build_unit => "6"))
+    cov2.push_partial
+    cov2.pull_merge_and_push_full
+    #TODO: assert on the resulting contents of S3?
+  end
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: simplecov_s3_codeclimate
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Jacob
+- Jonah Hirsch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: reek
+  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: 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: fog
+  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: simplecov
+  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: codeclimate-test-reporter
+  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'
+description: Merges simplecov output using S3 as shared storage. Once all coverage
+  is compiled, pushes this data to Codeclimate.
+email:
+- jacob@engineyard.com
+- jonah@giftcardzen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simplecov_s3_codeclimate.rb
+- lib/simplecov_s3_codeclimate/version.rb
+- simplecov-s3-codeclimate.gemspec
+- spec/a_spec.rb
+homepage: https://github.com/giftcardzen/simplecov-s3
+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.3
+signing_key: 
+specification_version: 4
+summary: Merge simplecov output using S3 as shared storage (and publish the results
+  to Codeclimate)
+test_files:
+- spec/a_spec.rb
+has_rdoc: