coverband 4.1.1 → 4.2.0.alpha

data/lib/coverband/utils/file_path_helper.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-####
-# Helper functions for shared logic related to file path manipulation
-####
-module Coverband
-  module Utils
-    module FilePathHelper
-      ###
-      # Takes a full path and converts to a relative path
-      ###
-      def full_path_to_relative(full_path)
-        relative_filename = full_path
-        Coverband.configuration.all_root_paths.each do |root|
-          relative_filename = relative_filename.gsub(/^#{root}/, './')
-          # once we have a relative path break out of the loop
-          break if relative_filename.start_with? './'
-        end
-        relative_filename
-      end
-
-      ###
-      # relative_path_to_full code takes:
-      # relative_path: which is a full path the same as reported by Coverage
-      # roots: if a collection of all possible full app paths
-      #    EX: [Coverband.configuration.root_paths, "#{current_root}/"]
-      # The LAST item should be the current file system root
-      # it expands that expands and adds a '/' as that isn't there from Dir.pwd
-      #
-      # NOTEs on configuration.root_paths usage
-      # strings: matching is pretty simple for full string paths
-      # regex: to get regex to work for changing deploy directories
-      #        the regex must be double escaped in double quotes
-      #          (if using \d for example)
-      #        or use single qoutes
-      #        example: '/box/apps/app_name/releases/\d+/'
-      #        example: '/var/local/company/company.d/[0-9]*/'
-      ###
-      def relative_path_to_full(relative_path, roots)
-        relative_filename = relative_path
-        local_filename = relative_filename
-        roots.each do |root|
-          relative_filename = relative_filename.gsub(/^#{root}/, './')
-        end
-        # the filename for our reports is expected to be a full path.
-        # roots.last should be roots << current_root}/
-        # a fully expanded path of config.root
-        # filename = filename.gsub('./', roots.last)
-        # above only works for app files
-        # we need to rethink some of this logic
-        # gems aren't at project root and can have multiple locations
-        local_root = roots.find { |root| File.exist?(relative_filename.gsub('./', root)) }
-        local_root ? relative_filename.gsub('./', local_root) : local_filename
-      end
-    end
-  end
-end

data/test/benchmarks/coverage_fork.sh

@@ -1,37 +0,0 @@
-#!/usr/bin/env ruby
-
-# This is a small script to illustrate how previous results get wiped out by forking
-# this has implications of forking processes like Resque...
-# this in the end would cause coverage.array_diff
-# with previous results to add NEGATIVE code hits to the stored Coverage
-# which in turn causes all sorts of crazy issues.
-#
-# ruby test/benchmarks/coverage_fork.rb
-# in parent before fork
-# {"/Users/danmayer/projects/coverband/test/dog.rb"=>[nil, nil, 1, 1, 2, nil, nil]}
-# in child after fork
-# {"/Users/danmayer/projects/coverband/test/dog.rb"=>[nil, nil, 0, 0, 0, nil, nil]}
-# now triggering hits
-# {"/Users/danmayer/projects/coverband/test/dog.rb"=>[nil, nil, 0, 0, 3, nil, nil]}
-#
-# I believe this might be related to CoW and GC... not sure
-# http://patshaughnessy.net/2012/3/23/why-you-should-be-excited-about-garbage-collection-in-ruby-2-0
-#
-# NOTE: That the child now has 0 hits where previously method definitions had 1
-# this causes all sorts of bad things to happen.
-require 'coverage'
-Coverage.start
-load './test/dog.rb'
-Dog.new.bark
-Dog.new.bark
-puts 'in parent before fork'
-puts Coverage.peek_result
-fork do
-  puts 'in child after fork'
-  puts Coverage.peek_result
-  puts 'now triggering hits'
-  Dog.new.bark
-  Dog.new.bark
-  Dog.new.bark
-  puts Coverage.peek_result
-end

data/test/coverband/collectors/coverage_test.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../test_helper', File.dirname(__FILE__))
-
-class CollectorsCoverageTest < Minitest::Test
-  attr_accessor :coverband
-
-  def setup
-    super
-    Coverband.configure do |config|
-      config.store = Coverband::Adapters::RedisStore.new(Redis.new)
-    end
-    @coverband = Coverband::Collectors::Coverage.instance.reset_instance
-  end
-
-  def teardown
-    Thread.current[:coverband_instance] = nil
-    Coverband.configure do |config|
-    end
-    @coverband = Coverband::Collectors::Coverage.instance.reset_instance
-  end
-
-  test 'Dog class coverage' do
-    file = require_unique_file
-    coverband.report_coverage(true)
-    coverage = Coverband.configuration.store.coverage
-    assert_equal(coverage[file]["data"], [nil, nil, 1, 1, 0, nil, nil])
-  end
-
-  test 'Dog method and class coverage' do
-    load File.expand_path('../../dog.rb', File.dirname(__FILE__))
-    Dog.new.bark
-    coverband.report_coverage(true)
-    coverage = Coverband.configuration.store.coverage
-    assert_equal(coverage["./test/dog.rb"]["data"], [nil, nil, 1, 1, 1, nil, nil])
-  end
-
-  test 'gets coverage instance' do
-    assert_equal Coverband::Collectors::Coverage, coverband.class
-  end
-
-  test 'defaults to a redis store' do
-    assert_equal Coverband::Adapters::RedisStore, coverband.instance_variable_get('@store').class
-  end
-
-  test 'report_coverage raises errors in tests' do
-    @coverband.reset_instance
-    @coverband.expects(:ready_to_report?).raises('Oh no')
-    assert_raises RuntimeError do
-      @coverband.report_coverage
-    end
-  end
-
-  test 'default tmp ignores' do
-    heroku_build_file = '/tmp/build_81feca8c72366e4edf020dc6f1937485/config/initializers/assets.rb'
-    assert_equal false, @coverband.send(:track_file?, heroku_build_file)
-  end
-
-  test '#array_diff never returns negative hits' do
-    # this can occur if a process forks after initializing the previous results
-    # see test/benchmarks/coverage_fork.rb
-    latest = [0, nil]
-    original = [1, nil]
-    expected = [0, nil]
-    assert_equal expected, @coverband.send(:array_diff, latest, original)
-  end
-end

data/test/coverband/reporters/base_test.rb

@@ -1,168 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../test_helper', File.dirname(__FILE__))
-
-class ReportsBaseTest < Minitest::Test
-  test 'relative_path_to_full fix filename from a key with a swappable path' do
-    Coverband.configure do |config|
-      config.reporter          = 'std_out'
-      config.root              = '/full/remote_app/path'
-    end
-
-    key = '/app/is/a/path.rb'
-    # the code takes config.root expands and adds a '/' for the final path in roots
-    roots = ['/app/', '/full/remote_app/path/']
-
-    expected_path = '/full/remote_app/path/is/a/path.rb'
-    File.expects(:exist?).with(key).returns(false)
-    File.expects(:exist?).with(expected_path).returns(true)
-    assert_equal expected_path, Coverband::Reporters::Base.send(:relative_path_to_full, key, roots)
-  end
-
-  test 'relative_path_to_full fix filename a changing deploy path with quotes' do
-    Coverband.configure do |config|
-      config.reporter          = 'std_out'
-      config.root              = '/full/remote_app/path'
-    end
-
-    expected_path = '/full/remote_app/path/app/models/user.rb'
-    key = '/box/apps/app_name/releases/20140725203539/app/models/user.rb'
-    roots = ["/box/apps/app_name/releases/\\d+/", '/full/remote_app/path/']
-    File.expects(:exist?).with('/box/apps/app_name/releases/\\d+/app/models/user.rb').returns(false)
-    File.expects(:exist?).with(expected_path).returns(true)
-    assert_equal expected_path, Coverband::Reporters::Base.send(:relative_path_to_full, key, roots)
-    File.expects(:exist?).with('/box/apps/app_name/releases/\\d+/app/models/user.rb').returns(false)
-    File.expects(:exist?).with(expected_path).returns(true)
-    roots = ['/box/apps/app_name/releases/\d+/', '/full/remote_app/path/']
-    assert_equal expected_path, Coverband::Reporters::Base.send(:relative_path_to_full, key, roots)
-  end
-
-  test 'relative_path_to_full fix filename a changing deploy path real world examples' do
-    current_app_root = '/var/local/company/company.d/79'
-    Coverband.configure do |config|
-      config.reporter          = 'std_out'
-      config.root              = current_app_root
-    end
-
-    expected_path = '/var/local/company/company.d/79/app/controllers/dashboard_controller.rb'
-    key = '/var/local/company/company.d/78/app/controllers/dashboard_controller.rb'
-
-    File.expects(:exist?).with('/var/local/company/company.d/[0-9]*/app/controllers/dashboard_controller.rb').returns(false)
-    File.expects(:exist?).with(expected_path).returns(true)
-    roots = ['/var/local/company/company.d/[0-9]*/', "#{current_app_root}/"]
-    assert_equal expected_path, Coverband::Reporters::Base.send(:relative_path_to_full, key, roots)
-    File.expects(:exist?).with('/var/local/company/company.d/[0-9]*/app/controllers/dashboard_controller.rb').returns(false)
-    File.expects(:exist?).with(expected_path).returns(true)
-    roots = ["/var/local/company/company.d/[0-9]*/", "#{current_app_root}/"]
-    assert_equal expected_path, Coverband::Reporters::Base.send(:relative_path_to_full, key, roots)
-  end
-
-  test 'relative_path_to_full leave filename from a key with a local path' do
-    Coverband.configure do |config|
-      config.reporter          = 'std_out'
-      config.root              = '/full/remote_app/path'
-    end
-
-    key = '/full/remote_app/path/is/a/path.rb'
-    # the code takes config.root expands and adds a '/' for the final path in roots
-    roots = ['/app/', '/full/remote_app/path/']
-
-    expected_path = '/full/remote_app/path/is/a/path.rb'
-    assert_equal expected_path, Coverband::Reporters::Base.send(:relative_path_to_full, key, roots)
-  end
-
-  test '#merge_arrays basic merge preserves order and counts' do
-    first = [0, 0, 1, 0, 1]
-    second = [nil, 0, 1, 0, 0]
-    expects = [0, 0, 2, 0, 1]
-
-    assert_equal expects, Coverband::Reporters::Base.send(:merge_arrays, first, second)
-  end
-
-  test '#merge_arrays basic merge preserves order and counts different lengths' do
-    first = [0, 0, 1, 0, 1]
-    second = [nil, 0, 1, 0, 0, 0, 0, 1]
-    expects = [0, 0, 2, 0, 1, 0, 0, 1]
-
-    assert_equal expects, Coverband::Reporters::Base.send(:merge_arrays, first, second)
-  end
-
-  test '#merge_arrays basic merge preserves nils' do
-    first = [0, 1, 2, nil, nil, nil]
-    second = [0, 1, 2, nil, 0, 1, 2]
-    expects = [0, 2, 4, nil, 0, 1, 2]
-
-    assert_equal expects, Coverband::Reporters::Base.send(:merge_arrays, first, second)
-  end
-
-  test "#get_current_scov_data_imp doesn't ignore folders with default ignore keys" do
-    @redis = Redis.new
-    store = Coverband::Adapters::RedisStore.new(@redis)
-    store.clear!
-
-    Coverband.configure do |config|
-      config.reporter          = 'std_out'
-      config.root              = '/full/remote_app/path'
-      config.store             = store
-    end
-
-    key = '/a_path/that_has_erb_in/thepath.rb'
-    roots = ['/app/', '/full/remote_app/path/']
-
-    lines_hit = [1, 3, 6]
-    store.stubs(:coverage).returns(key => lines_hit)
-    expected = { key => [1, 3, 6] }
-
-    assert_equal expected, Coverband::Reporters::Base.send(:get_current_scov_data_imp, store, roots)
-  end
-
-  ###
-  # This test uses real world example data which helped uncover a bug
-  # The copied data doesn't format easily and isn't worth the effort to meet
-  # string style
-  # rubocop:disable all
-  ###
-  test '#get_current_scov_data_imp merges multiples of file data' do
-    coverage = {'/base/66/app/controllers/dashboard_controller.rb' =>
-       {"first_updated_at"=>1549610119,
-        "last_updated_at"=>1549610200,
-        "file_hash"=>"14dc84e940e26cbfb9ac79b43862e762",
-        "data"=>[1, 1, 1, nil, 1, 1, nil, nil, 1, nil, 1, 26, 26, nil, 26, 26, 26, 26, 26, 26, 26, nil, nil, 1, nil, 1, 26, 19, 0, 0, 0, 0, nil, nil, nil, nil, 0, 0, nil, nil, 1, 26, 26, 26, nil, nil, nil, nil, nil, 1, 26, nil, nil, 1, 26, nil, nil]},
-     '/base/78/app/controllers/dashboard_controller.rb' =>
-       {"first_updated_at"=>1549658574,
-        "last_updated_at"=>1549729830,
-        "file_hash"=>"14dc84e940e26cbfb9ac79b43862e762",
-        "data"=>[21, 21, 21, nil, 21, 21, nil, nil, 21, nil, 21, 22, 22, nil, 22, 22, 22, 22, 22, 22, 22, nil, nil, 21, nil, 21, 22, 13, 0, 0, 0, 0, nil, nil, nil, nil, 0, 0, nil, nil, 21, 22, 22, 22, nil, nil, nil, nil, nil, 21, 22, nil, nil, 21, 22, nil, nil]},
-    '/base/70/app/controllers/dashboard_controller.rb' =>
-       {"first_updated_at"=>1549617873,
-        "last_updated_at"=>1549618094,
-        "file_hash"=>"14dc84e940e26cbfb9ac79b43862e762",
-        "data"=>[16, 16, 16, nil, 16, 16, nil, nil, 16, nil, 16, 32, 32, nil, 32, 32, 32, 32, 32, 32, 32, nil, nil, 16, nil, 16, 32, 23, 0, 0, 0, 0, nil, nil, nil, nil, 0, 0, nil, nil, 16, 32, 32, 32, nil, nil, nil, nil, nil, 16, 32, nil, nil, 16, 32, nil, nil]}
-      }
-    @redis = Redis.new
-    store = Coverband::Adapters::RedisStore.new(@redis)
-    store.clear!
-
-    Coverband.configure do |config|
-      config.reporter          = 'std_out'
-      config.root              = '/base/78/app/'
-      config.store             = store
-    end
-
-    key = '/base/78/app/app/controllers/dashboard_controller.rb'
-    roots = ['/base/[0-9]*/', '/base/78/app/']
-
-    lines_hit = [1, 3, 6]
-    store.stubs(:coverage).returns(coverage)
-    File.expects(:exist?).at_least_once
-      .with('/base/[0-9]*/app/controllers/dashboard_controller.rb')
-      .returns(false)
-    File.expects(:exist?).at_least_once.with(key).returns(true)
-
-    expected = {"first_updated_at"=>1549617873,
-                "last_updated_at"=>1549618094,
-                "file_hash"=>"14dc84e940e26cbfb9ac79b43862e762",
-                "data"=>[38, 38, 38, nil, 38, 38, nil, nil, 38, nil, 38, 80, 80, nil, 80, 80, 80, 80, 80, 80, 80, nil, nil, 38, nil, 38, 80, 55, 0, 0, 0, 0, nil, nil, nil, nil, 0, 0, nil, nil, 38, 80, 80, 80, nil, nil, nil, nil, nil, 38, 80, nil, nil, 38, 80, nil, nil]}
-    assert_equal expected, Coverband::Reporters::Base.send(:get_current_scov_data_imp, store, roots)[key]
-  end
-end

data/test/coverband/utils/file_groups_test.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('../../test_helper', File.dirname(__FILE__))
-
-describe Coverband::Utils::FileGroups do
-  FAKE_GEM_PATH = 'fake/gem/path'
-  subject do
-    controller_lines = [nil, 2, 2, 0, nil, nil, 0, nil, nil, nil]
-    files = [
-      Coverband::Utils::SourceFile.new(source_fixture('sample.rb'), [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil]),
-      Coverband::Utils::SourceFile.new(source_fixture('app/models/user.rb'), [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil]),
-      Coverband::Utils::SourceFile.new(source_fixture('app/controllers/sample_controller.rb'), controller_lines),
-      Coverband::Utils::SourceFile.new("#{FAKE_GEM_PATH}/gem_name.rb", controller_lines)
-    ]
-    Coverband.configuration.expects(:gem_paths).at_least_once.returns([FAKE_GEM_PATH])
-    Coverband.configuration.track_gems = true
-    Coverband::Utils::FileGroups.new(files)
-  end
-
-  it 'has app files' do
-    assert_equal 'test/fixtures/sample.rb', subject.grouped_results['App'].first.short_name
-  end
-
-  it 'has gem files' do
-    assert_equal "#{FAKE_GEM_PATH}/gem_name.rb", subject.grouped_results['Gems'].first.first.short_name
-  end
-end
-
-describe Coverband::Utils::FileGroups, :vendored_gems do
-  FAKE_VENDOR_GEM_PATH = "#{test_root}/app/vendor/bundle/ruby/2.5.0/gems"
-  subject do
-    controller_lines = [nil, 2, 2, 0, nil, nil, 0, nil, nil, nil]
-    files = [
-      Coverband::Utils::SourceFile.new(source_fixture('sample.rb'), [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil]),
-      Coverband::Utils::SourceFile.new(source_fixture('app/models/user.rb'), [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil]),
-      Coverband::Utils::SourceFile.new(source_fixture('app/controllers/sample_controller.rb'), controller_lines),
-      Coverband::Utils::SourceFile.new("#{FAKE_VENDOR_GEM_PATH}/gem_name.rb", controller_lines)
-    ]
-    Coverband.configuration.expects(:gem_paths).at_least_once.returns([FAKE_VENDOR_GEM_PATH])
-    Coverband.configuration.track_gems = true
-    Coverband::Utils::FileGroups.new(files)
-  end
-
-  it 'has app files' do
-    assert_equal 'test/fixtures/sample.rb', subject.grouped_results['App'].first.short_name
-  end
-
-  it "doesn't include vendor gems in app files app files" do
-    assert_nil subject.grouped_results['App'].select { |files| files.short_name.match(/gem_name/) }.first
-  end
-
-  it 'does has gem files' do
-    assert_equal 'gem_name.rb', subject.grouped_results['Gems'].first.first.short_name
-  end
-end

data/test/unique_files.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'securerandom'
-require 'fileutils'
-
-UNIQUE_FILES_DIR = "./test/unique_files"
-
-def require_unique_file(file = 'dog.rb')
-  dir = "#{UNIQUE_FILES_DIR}/#{SecureRandom.uuid}"
-  FileUtils.mkdir_p(dir)
-  temp_file = "#{dir}/#{file}"
-  File.open(temp_file, 'w'){ |w| w.write(File.read("./test/#{file}")) }
-  require temp_file
-  temp_file
-end
-
-def remove_unique_files
-  FileUtils.rm_r(UNIQUE_FILES_DIR) if File.exist?(UNIQUE_FILES_DIR)
-end
-
-Minitest.after_run do
-  remove_unique_files
-end

data/views/settings.erb

@@ -1,35 +0,0 @@
-<!DOCTYPE html>
-<html xmlns='http://www.w3.org/1999/xhtml'>
-  <head>
-    <title>Coverband Info: <%= Coverband::VERSION %></title>
-    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
-    <script src='<%= assets_path('application.js') %>' type='text/javascript'></script>
-    <link href='<%= assets_path('application.css') %>' media='screen, projection, print' rel='stylesheet' type='text/css'>
-    <link rel="icon" type="image/png" href="<%= assets_path('favicon.png') %>" />
-  </head>
-
-  <body>
-    <div id="wrapper" style="">
-      <div id="header">
-        <a href='<%= base_path %>'>Coverband Admin</a> &nbsp;
-        <a href='<%= base_path %>settings'>Info</a> &nbsp;
-      </div>
-      <div id="content">
-        <dl>
-        <% Coverband.configuration.to_h.each_pair do |key,value| %>
-          <dt><%= key %></dt>
-          <dd><%= value %></dd>
-        <% end %>
-
-        <dt>Size (in bytes)</dt>
-        <dd><%= Coverband.configuration.store.size %></dd>
-        <dt>Size (in MiB)</dt>
-        <dd><%= Coverband.configuration.store.size_in_mib %></dd>
-        </dl>
-      </div>
-      <div id="footer">
-        Generated by <a href="http://github.com/danmayer/coverband">Coverband</a> v<%= Coverband::VERSION %>
-      </div>
-    </div>
-  </body>
-</html>