simplecov-s3 0.1.1

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+*.gem
+.bundle
+Gemfile.lock
+EYIntegratedGemfile.lock
+pkg/*
+.rvmrc
+coverage

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,24 @@
+---
+git:
+  depth: 1
+
+notifications:
+  email: false
+  webhooks:
+    urls:
+    - https://ensemble.engineyard.com/travis
+    on_success: always
+    on_failure: always
+    on_start: true
+
+before_script:
+  - echo "--profile --color" > '.rspec' # Report slowest ten tests, make it pretty
+
+script: bundle exec rake
+
+env:
+  global:
+  - RUBY_GC_MALLOC_LIMIT=1000000000
+  - RUBY_HEAP_SLOTS_GROWTH_FACTOR=1.25
+  - RUBY_HEAP_MIN_SLOTS=800000
+  - RUBY_FREE_MIN=600000

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,87 @@
+# Simplecov-S3
+
+Sample Usage:
+
+config/environment.rb
+
+    require File.expand_path('../application', __FILE__)
+
+    if Rails.env.test?
+      require File.expand_path("../../spec/coverage_helper", __FILE__)
+    end
+
+coverage_helper.rb
+
+    unless ENV["SKIP_COVERAGE"]
+      require 'simplecov'
+      SimpleCov.start(:rails)
+      SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+      SimpleCov.at_exit do
+        SimpleCov.result.format!
+      end
+      SimpleCov.command_name("HAX#{Time.now.to_i}")
+      SimpleCov.merge_timeout 86400
+    end
+
+Rakefile
+
+    task :coverage do
+      build_units = YAML.load_file(File.expand_path("../build_units.yml",__FILE__)).size
+      require File.expand_path("../spec/coverage_helper", __FILE__)
+      cov = SimpleCov::S3.new(
+        :fog => {
+          :provider => 'AWS',
+          :aws_access_key_id => "XXXXXX",
+          :aws_secret_access_key => "XXXXXXXXXXXXX",
+          :region => "us-east-1",
+        },
+        :project_name => ENV["TRAVIS_REPO_SLUG"],
+        :build_id => ENV["TRAVIS_BUILD_ID"],
+        :job_id => ENV["TRAVIS_JOB_ID"],
+        :build_unit => ENV["BUILD_UNIT"],
+        :build_units => build_units,
+        :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.push_partial(:debug => true)
+      cov.pull_merge_and_push_full
+    end
+
+Sample S3 Bucket policy to allow the "<user>" user of from the Amazon Account ID "<awsaccount>" access to read/write from the "<bucket>" bucket, while the public is allowed read-only:
+
+    {
+      "Version": "2008-10-17",
+      "Id": "Policy123456",
+      "Statement": [
+        {
+          "Sid": "Stmt11111",
+          "Effect": "Allow",
+          "Principal": {
+            "AWS": "arn:aws:iam::<awsaccount>:user/<user>"
+          },
+          "Action": "s3:*",
+          "Resource": "arn:aws:s3:::<bucket>"
+        },
+        {
+          "Sid": "Stmt222222",
+          "Effect": "Allow",
+          "Principal": {
+            "AWS": "arn:aws:iam::<awsaccount>:user/<user>"
+          },
+          "Action": "s3:*",
+          "Resource": "arn:aws:s3:::<bucket>/*"
+        },
+        {
+          "Sid": "Stmt33333",
+          "Effect": "Allow",
+          "Principal": {
+            "AWS": "*"
+          },
+          "Action": "s3:GetObject",
+          "Resource": "arn:aws:s3:::<bucket>/*"
+        }
+      ]
+    }

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.rb

@@ -0,0 +1,141 @@
+require 'digest'
+require 'securerandom'
+require 'excon'
+require 'fog'
+require 'simplecov'
+require 'json'
+
+module SimpleCov
+  class S3
+
+    def self.ensured(task_to_invoke, &block)
+      Rake::Task[task_to_invoke].invoke
+    ensure
+      begin
+        yield
+      rescue => e
+        puts e.inspect
+        puts e.backtrace
+      end
+    end
+
+    class Formatter < SimpleCov::Formatter::HTMLFormatter
+      #an ugly partial-copy from: https://github.com/colszowka/simplecov-html/blob/master/lib/simplecov-html.rb
+      def format(result)
+        template('layout').result(binding)
+      end
+    end
+
+    def initialize(opts)
+      @connection = Fog::Storage.new(opts[:fog])
+      @public_url_base = opts[:public_url_base]
+      @shared_secret = opts[:shared_secret]
+      @assets_url = opts[:assets_url]
+      @bucket_name = opts[:bucket_name]
+      @build_units = opts[:build_units]
+      @postback_url = opts[:postback_url]
+      @build_unit = opts[:build_unit]
+      @build_id = opts[:build_id]
+      @job_id = opts[:job_id]
+      @project_name = opts[:project_name]
+    end
+
+    def push_partial(opts = {})
+      begin
+        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}/#{@job_id}", data_to_push)
+      rescue => e
+        puts e.inspect
+        puts e.backtrace
+        puts "SOMEHTING WENT WRONG, PUSHING EMPTY COVERAGE FILE"
+        put_file("#{@project_name}-#{commit_time}-coverageJSON/#{hashed_build_id}/#{@job_id}", {}.to_json)
+      end
+      if opts[:debug]
+        debug_folder = "#{@project_name}-#{Time.now.to_i}-coverageDEBUG/#{hashed_build_id}-#{@job_id}"
+        push_coverage_to(debug_folder, gen_body(result))
+      end
+    end
+
+    def pull_merge_and_push_full
+      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 |f|
+        parsed = JSON.parse(f.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)
+      push_coverage_to("#{@project_name}-#{Time.now.to_i}-coverageRESULT/#{SecureRandom.urlsafe_base64(33)}", gen_body(result), result.covered_percent, @postback_url)
+    end
+
+    def push_full
+      result = SimpleCov::ResultMerger.merged_result
+      push_coverage_to("#{@project_name}-#{Time.now.to_i}-coverageRESULT/#{SecureRandom.urlsafe_base64(33)}", gen_body(result), result.covered_percent, @postback_url)
+    end
+
+    private
+
+    def put_file(path, data)
+      puts "Putting to #{path} data size #{data.size}"
+      @connection.directories.get(@bucket_name).files.create(:key => path, :body => data, :content_type => "text/html")
+    end
+
+    def json_files
+      expected_dir = "#{@project_name}-#{commit_time}-coverageJSON/#{hashed_build_id}/"
+      @connection.directories.get(@bucket_name, :prefix => expected_dir).files
+    end
+
+    def gen_body(result)
+      Formatter.new.format(result).gsub("./assets",@assets_url)
+    end
+
+    def push_coverage_to(folder, data, covered_percent = nil, postback_url = false)
+      coverage_url = "#{@public_url_base}#{folder}"
+      puts "Pushing full coverage to #{coverage_url}"
+      put_file("#{folder}/index.html", data)
+      if postback_url
+        puts "Postback coverage_url to #{postback_url}"
+        coverage_percentage = "#{covered_percent.round(2)}"
+        travis_id = @build_id
+        signature = Digest::SHA1.hexdigest([coverage_url, coverage_percentage, travis_id, @shared_secret].join("."))
+        post_params = {
+            'coverage_url' => coverage_url,
+            'coverage_percentage' => coverage_percentage,
+            'travis_id' => travis_id,
+            'signature' => signature,
+        }
+        puts "post params: " + post_params.inspect
+        result = Excon.post(postback_url,
+          :body => URI.encode_www_form(post_params),
+          :headers => { "Content-Type" => "application/x-www-form-urlencoded" })
+        puts result.inspect
+      end
+    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

data/lib/simplecov-s3/version.rb

@@ -0,0 +1,5 @@
+module SimpleCov
+  class S3
+    VERSION = "0.1.1"
+  end
+end

data/simplecov-s3.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simplecov-s3/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simplecov-s3"
+  s.version     = SimpleCov::S3::VERSION
+  s.authors     = ["Jacob"]
+  s.email       = ["jacob@engineyard.com"]
+  s.homepage    = "https://github.com/engineyard/simplecov-s3"
+  s.summary     = %q{Merge simplecov outputs using S3 as shared storage (and publish the results as html to S3)}
+  s.description = %q{Merge simplecov outputs using S3 as shared storage (and publish the results as html to S3) (works best with travis)}
+
+  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'
+  s.add_dependency "fog"
+  s.add_dependency 'simplecov'
+end

data/spec/a_spec.rb

@@ -0,0 +1,44 @@
+require 'simplecov-s3'
+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(:debug => true)
+    cov.pull_merge_and_push_full
+    cov2 = SimpleCov::S3.new(cov_opts.merge(:job_id => "457", :build_unit => "6"))
+    cov2.push_partial(:debug => true)
+    cov2.pull_merge_and_push_full
+    cov2.push_full
+    #TODO: assert on the resulting contents of S3?
+  end
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-s3
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Jacob
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Merge simplecov outputs using S3 as shared storage (and publish the results
+  as html to S3) (works best with travis)
+email:
+- jacob@engineyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simplecov-s3.rb
+- lib/simplecov-s3/version.rb
+- simplecov-s3.gemspec
+- spec/a_spec.rb
+homepage: https://github.com/engineyard/simplecov-s3
+licenses: []
+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.25
+signing_key: 
+specification_version: 3
+summary: Merge simplecov outputs using S3 as shared storage (and publish the results
+  as html to S3)
+test_files:
+- spec/a_spec.rb
+has_rdoc: