coverband 4.0.1.alpha → 4.0.1.beta

data/test/unit/utils/result_test.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../test_helper', File.dirname(__FILE__))
+
+####
+# Thanks for all the help SimpleCov https://github.com/colszowka/simplecov-html
+# initial version of test pulled into Coverband from Simplecov 12/19/2018
+####
+describe 'result' do
+  describe 'with a (mocked) Coverage.result' do
+    let(:original_result) do
+      {
+        source_fixture('sample.rb') => [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil],
+        source_fixture('app/models/user.rb') => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil],
+        source_fixture('app/controllers/sample_controller.rb') => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil]
+      }
+    end
+
+    describe 'a simple cov result initialized from that' do
+      subject { Coverband::Utils::Result.new(original_result) }
+
+      it 'has 3 filenames' do
+        assert_equal 3, subject.filenames.count
+      end
+
+      it 'has 3 source files' do
+        assert_equal 3, subject.source_files.count
+        subject.source_files.each do |source_file|
+          assert source_file.is_a?(Coverband::Utils::SourceFile)
+        end
+      end
+
+      it 'returns an instance of Coverband::Utils::FileList for source_files and files' do
+        assert subject.files.is_a?(Coverband::Utils::FileList)
+        assert subject.source_files.is_a?(Coverband::Utils::FileList)
+      end
+
+      it 'has files equal to source_files' do
+        assert_equal subject.source_files, subject.files
+      end
+
+      it 'has accurate covered percent' do
+        # in our fixture, there are 13 covered line (result in 1) in all 15 relevant line (result in non-nil)
+        assert_equal 86.66666666666667, subject.covered_percent
+      end
+
+      it 'has accurate covered percentages' do
+        assert_equal [80.0, 80.0, 100.0], subject.covered_percentages
+      end
+
+      it 'has accurate least covered file' do
+        assert subject.least_covered_file.match(/sample_controller.rb/)
+      end
+
+      [:covered_percent,
+       :covered_percentages,
+       :least_covered_file,
+       :covered_strength,
+       :covered_lines,
+       :missed_lines,
+       :total_lines].each do |msg|
+        it "responds to #{msg}" do
+          assert(subject.respond_to?(msg))
+        end
+      end
+
+      describe 'dumped with to_hash' do
+        it 'is a hash' do
+          assert subject.to_hash.is_a?(Hash)
+        end
+
+        describe 'loaded back with from_hash' do
+          let(:dumped_result) do
+            Coverband::Utils::Result.from_hash(subject.to_hash)
+          end
+
+          it 'has 3 source files' do
+            assert_equal subject.source_files.count, dumped_result.source_files.count
+          end
+
+          it 'has the same covered_percent' do
+            assert_equal subject.covered_percent, dumped_result.covered_percent
+          end
+
+          it 'has the same covered_percentages' do
+            assert_equal subject.covered_percentages, dumped_result.covered_percentages
+          end
+
+          it 'has the same timestamp' do
+            assert_equal subject.created_at.to_i, dumped_result.created_at.to_i
+          end
+
+          it 'has the same command_name' do
+            assert_equal subject.command_name, dumped_result.command_name
+          end
+
+          it 'has the same original_result' do
+            assert_equal subject.original_result, dumped_result.original_result
+          end
+        end
+      end
+    end
+  end
+end

data/test/unit/{utils_s3_report_test.rb → utils/s3_report_test.rb}

@@ -1,8 +1,7 @@
-require File.expand_path('../test_helper', File.dirname(__FILE__))
-require 'aws-sdk'
+require File.expand_path('../../test_helper', File.dirname(__FILE__))
 
 module Coverband
-  class S3ReportTest < Test::Unit::TestCase
+  class S3ReportTest < Minitest::Test
     def html_version
       Coverband::VERSION
     end
@@ -15,8 +14,9 @@ module Coverband
         object = mock('object')
         s3.expects(:bucket).with('coverage-bucket').returns(bucket)
         bucket.expects(:object).with('coverband/index.html').returns(object)
-        File.expects(:read).at_least(0).returns("content ./assets/#{html_version}/")
+        File.expects(:read).with("#{Coverband.configuration.root}/coverage/index.html").returns("content ./assets/#{html_version}/")
         object.expects(:put).with(body: 'content ')
+        Aws::S3::Client.expects(:new).returns(nil)
         Aws::S3::Resource.expects(:new).returns(s3)
       else
         # AWS v1

data/test/unit/utils/source_file_line_test.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../test_helper', File.dirname(__FILE__))
+
+####
+# Thanks for all the help SimpleCov https://github.com/colszowka/simplecov-html
+# initial version of test pulled into Coverband from Simplecov 12/19/2018
+####
+describe Coverband::Utils::SourceFile::Line do
+  describe 'a source line' do
+    subject do
+      Coverband::Utils::SourceFile::Line.new('# the ruby source', 5, 3)
+    end
+
+    it 'returns "# the ruby source" as src' do
+      assert_equal '# the ruby source', subject.src
+    end
+
+    it 'returns the same for source as for src' do
+      assert_equal subject.src, subject.source
+    end
+
+    it 'has line number 5' do
+      assert_equal 5, subject.line_number
+    end
+
+    it 'has equal line_number, line and number' do
+      assert_equal subject.line, subject.line_number
+      assert_equal subject.number, subject.line_number
+    end
+
+    describe 'flagged as skipped!' do
+      before do
+        subject.skipped!
+      end
+      it 'is not covered' do
+        refute subject.covered?
+      end
+
+      it 'is skipped' do
+        assert subject.skipped?
+      end
+
+      it 'is not missed' do
+        refute subject.missed?
+      end
+
+      it 'is not never' do
+        refute subject.never?
+      end
+
+      it 'status is skipped' do
+        assert_equal 'skipped', subject.status
+      end
+    end
+  end
+
+  describe 'A source line with coverage' do
+    subject do
+      Coverband::Utils::SourceFile::Line.new('# the ruby source', 5, 3)
+    end
+
+    it 'has coverage of 3' do
+      assert_equal 3, subject.coverage
+    end
+
+    it 'is covered' do
+      assert subject.covered?
+    end
+
+    it 'is not skipped' do
+      refute subject.skipped?
+    end
+
+    it 'is not missed' do
+      refute subject.missed?
+    end
+
+    it 'is not never' do
+      refute subject.never?
+    end
+
+    it 'status is covered' do
+      assert_equal 'covered', subject.status
+    end
+  end
+
+  describe 'A source line without coverage' do
+    subject do
+      Coverband::Utils::SourceFile::Line.new('# the ruby source', 5, 0)
+    end
+
+    it 'has coverage of 0' do
+      assert_equal 0, subject.coverage
+    end
+
+    it 'is not covered' do
+      refute subject.covered?
+    end
+
+    it 'is not skipped' do
+      refute subject.skipped?
+    end
+
+    it 'is missed' do
+      assert subject.missed?
+    end
+
+    it 'is not never' do
+      refute subject.never?
+    end
+
+    it 'status is missed' do
+      assert_equal 'missed', subject.status
+    end
+  end
+
+  describe 'A source line with no code' do
+    subject do
+      Coverband::Utils::SourceFile::Line.new('# the ruby source', 5, nil)
+    end
+
+    it 'has nil coverage' do
+      assert_nil subject.coverage
+    end
+
+    it 'is not covered' do
+      refute subject.covered?
+    end
+
+    it 'is not skipped' do
+      refute subject.skipped?
+    end
+
+    it 'is not missed' do
+      refute subject.missed?
+    end
+
+    it 'is never' do
+      assert subject.never?
+    end
+
+    it 'status is never' do
+      assert_equal 'never', subject.status
+    end
+  end
+
+  it 'raises ArgumentError when initialized with invalid src' do
+    assert_raises ArgumentError do
+      Coverband::Utils::SourceFile::Line.new(:symbol, 5, 3)
+    end
+  end
+
+  it 'raises ArgumentError when initialized with invalid line_number' do
+    assert_raises ArgumentError do
+      Coverband::Utils::SourceFile::Line.new('some source', 'five', 3)
+    end
+  end
+
+  it 'raises ArgumentError when initialized with invalid coverage' do
+    assert_raises ArgumentError do
+      Coverband::Utils::SourceFile::Line.new('some source', 5, 'three')
+    end
+  end
+end

data/test/unit/utils/source_file_test.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../test_helper', File.dirname(__FILE__))
+
+####
+# Thanks for all the help SimpleCov https://github.com/colszowka/simplecov-html
+# initial version of test pulled into Coverband from Simplecov 12/19/2018
+####
+describe Coverband::Utils::SourceFile do
+  COVERAGE_FOR_SAMPLE_RB = [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil, nil, nil, nil, nil, nil, nil].freeze
+  describe 'a source file initialized with some coverage data' do
+    subject do
+      Coverband::Utils::SourceFile.new(source_fixture('sample.rb'), COVERAGE_FOR_SAMPLE_RB)
+    end
+
+    it 'has a filename' do
+      assert subject.filename
+    end
+
+    it 'has source equal to src' do
+      assert_equal subject.source, subject.src
+    end
+
+    it 'has a project filename which removes the project directory' do
+      assert_equal '/test/fixtures/sample.rb', subject.project_filename
+    end
+
+    it 'has source_lines equal to lines' do
+      assert_equal subject.source_lines, subject.lines
+    end
+
+    it 'has 16 source lines' do
+      assert_equal 16, subject.lines.count
+    end
+
+    it 'has all source lines of type Coverband::Utils::SourceFile::Line' do
+      subject.lines.each do |line|
+        assert line.is_a?(Coverband::Utils::SourceFile::Line)
+      end
+    end
+
+    it "has 'class Foo' as line(2).source" do
+      assert_equal "class Foo\n", subject.line(2).source
+    end
+
+    it 'returns lines number 2, 3, 4, 7 for covered_lines' do
+      assert_equal [2, 3, 4, 7], subject.covered_lines.map(&:line)
+    end
+
+    it 'returns lines number 8 for missed_lines' do
+      assert_equal [8], subject.missed_lines.map(&:line)
+    end
+
+    it 'returns lines number 1, 5, 6, 9, 10, 16 for never_lines' do
+      assert_equal [1, 5, 6, 9, 10, 16], subject.never_lines.map(&:line)
+    end
+
+    it 'returns line numbers 11, 12, 13, 14, 15 for skipped_lines' do
+      assert_equal [11, 12, 13, 14, 15], subject.skipped_lines.map(&:line)
+    end
+
+    it 'has 80% covered_percent' do
+      assert_equal 80.0, subject.covered_percent
+    end
+  end
+
+  describe 'simulating potential Ruby 1.9 defect -- see Issue #56' do
+    subject do
+      Coverband::Utils::SourceFile.new(source_fixture('sample.rb'), COVERAGE_FOR_SAMPLE_RB + [nil])
+    end
+
+    it 'has 16 source lines regardless of extra data in coverage array' do
+      # Do not litter test output with known warning
+      capture_stderr { assert_equal 16, subject.lines.count }
+    end
+
+    it 'prints a warning to stderr if coverage array contains more data than lines in the file' do
+      captured_output = capture_stderr do
+        subject.lines
+      end
+
+      assert(captured_output.match(/^Warning: coverage data provided/))
+    end
+  end
+
+  describe 'a file that is never relevant' do
+    COVERAGE_FOR_NEVER_RB = [nil, nil].freeze
+
+    subject do
+      Coverband::Utils::SourceFile.new(source_fixture('never.rb'), COVERAGE_FOR_NEVER_RB)
+    end
+
+    it 'has 0.0 covered_strength' do
+      assert_equal 0.0, subject.covered_strength
+    end
+
+    it 'has 0.0 covered_percent' do
+      assert_equal 100.0, subject.covered_percent
+    end
+  end
+
+  describe 'a file where nothing is ever executed mixed with skipping #563' do
+    COVERAGE_FOR_SKIPPED_RB = [nil, nil, nil, nil].freeze
+
+    subject do
+      Coverband::Utils::SourceFile.new(source_fixture('skipped.rb'), COVERAGE_FOR_SKIPPED_RB)
+    end
+
+    it 'has 0.0 covered_strength' do
+      assert_equal 0.0, subject.covered_strength
+    end
+
+    it 'has 0.0 covered_percent' do
+      assert_equal 0.0, subject.covered_percent
+    end
+  end
+
+  describe 'a file where everything is skipped and missed #563' do
+    COVERAGE_FOR_SKIPPED_RB_2 = [nil, nil, 0, nil].freeze
+
+    subject do
+      Coverband::Utils::SourceFile.new(source_fixture('skipped.rb'), COVERAGE_FOR_SKIPPED_RB_2)
+    end
+
+    it 'has 0.0 covered_strength' do
+      assert_equal 0.0, subject.covered_strength
+    end
+
+    it 'has 0.0 covered_percent' do
+      assert_equal 0.0, subject.covered_percent
+    end
+  end
+
+  describe 'a file where everything is skipped/irrelevamt but executed #563' do
+    COVERAGE_FOR_SKIPPED_AND_EXECUTED_RB = [nil, nil, 1, 1, 0, nil, nil, nil].freeze
+
+    subject do
+      Coverband::Utils::SourceFile.new(source_fixture('skipped_and_executed.rb'), COVERAGE_FOR_SKIPPED_AND_EXECUTED_RB)
+    end
+
+    it 'has 0.0 covered_strength' do
+      assert_equal 0.0, subject.covered_strength
+    end
+
+    it 'has 0.0 covered_percent' do
+      assert_equal 0.0, subject.covered_percent
+    end
+  end
+end

data/views/layout.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html xmlns='http://www.w3.org/1999/xhtml'>
   <head>
-    <title>Code coverage for <%= Coverband::VERSION %></title>
+    <title>Coverband: <%= 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'>
@@ -14,6 +14,15 @@
       <img src="<%= assets_path('loading.gif') %>" alt="loading"/>
     </div>
     <div id="wrapper" style="display:none;">
+      <div id="header">
+        <a href='<%= base_path %>'>Coverband Admin</a> &nbsp;
+        <%= button("#{base_path}collect_coverage", 'force coverage collection') %> &nbsp;
+        <%= button("#{base_path}reload_files", 'reload Coverband files') %> &nbsp;
+        <%= button("#{base_path}clear", 'clear coverage report', delete: true) %>
+      </div>
+      <% if notice.to_s.length > 0 %>
+      <div class="notice"><%= notice %></div>
+      <% end %>
       <div class="timestamp">Generated <%= timeago(Time.now) %></div>
       <ul class="group_tabs"></ul>