rspec-tap-formatters 0.1.0

data/lib/rspec/tap/formatters/test_stats.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RSpec
+  module TAP
+    module Formatters
+      # Test stats calculator
+      class TestStats
+        # @!attribute
+        # @return [Hash<Integer, Array<Integer, 4>>] example stats
+        attr_reader :data
+
+        # Constructor
+        def initialize
+          @data = {}
+        end
+
+        # Populates total number of examples and one of
+        # passing, failing, and, pending example.
+        # Traverses bottom up to populate each of the parent example group
+        # stats.
+        #
+        # @param notification [ExampleNotification] example notification
+        # @param index [Integer] the example status index
+        #   (1 - Passing, 2 - Failing, 3 - Pending)
+        def populate(notification, index)
+          metadata = notification.example.metadata[:example_group]
+          increment(metadata[:line_number], index)
+
+          while (parent_metadata = metadata[:parent_example_group])
+            metadata = parent_metadata
+            increment(metadata[:line_number], index)
+          end
+        end
+
+        private
+
+        # Increments the stats for a line number and example status.
+        #
+        # @param line_number [Integer] the example or group line number
+        # @param index [Integer] the example status index
+        #   (1 - Passing, 2 - Failing, 3 - Pending)
+        def increment(line_number, index)
+          @data[line_number] ||= [0, 0, 0, 0]
+          @data[line_number][0] += 1
+          @data[line_number][index] += 1
+        end
+      end
+    end
+  end
+end

data/lib/rspec/tap/formatters/version.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Namespace for the parent module.
+module RSpec
+  # Namespace for the submodule TAP.
+  module TAP
+    # Namespace for all the formatters code.
+    module Formatters
+      # Namespace for the version.
+      module Version
+        # The current version
+        STRING = '0.1.0'
+      end
+    end
+  end
+end

data/spec/rspec/tap/formatters/compact_spec.rb

@@ -0,0 +1,399 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+RSpec.describe RSpec::TAP::Formatters::Compact do
+  subject(:formatter) { described_class.new(report_output) }
+
+  let(:report_output) { StringIO.new }
+  let(:report_printer) { RSpec::TAP::Formatters::Printer.new(report_output) }
+  let(:report_test_stats) { RSpec::TAP::Formatters::TestStats.new }
+
+  before do
+    formatter.instance_variable_set(:@printer, report_printer)
+    formatter.instance_variable_set(:@test_stats, report_test_stats)
+    formatter.instance_variable_set(:@seed, nil)
+    formatter.instance_variable_set(:@level, 0)
+    formatter.instance_variable_set(:@example_number, 0)
+  end
+
+  describe '#seed' do
+    let(:seed) { SecureRandom.random_number(10_000) }
+
+    context 'with seed used' do
+      let(:notification) { OpenStruct.new(seed: seed, seed_used?: true) }
+
+      it 'updates instance variable' do
+        expect { formatter.seed(notification) }
+          .to change { formatter.instance_variable_get(:@seed) }
+          .from(nil)
+          .to(seed)
+      end
+    end
+
+    context 'without seed used' do
+      let(:notification) { OpenStruct.new(seed: seed, seed_used?: false) }
+
+      it 'does not update instance variable' do
+        expect { formatter.seed(notification) }
+          .not_to change { formatter.instance_variable_get(:@seed) }
+      end
+    end
+  end
+
+  describe '#start' do
+    let(:count) { 1 + SecureRandom.random_number(5) }
+    let(:notification) { OpenStruct.new(count: count) }
+
+    it 'delegates to printer' do
+      allow(report_printer).to receive(:start_output)
+
+      formatter.start(notification)
+
+      expect(report_printer).to have_received(:start_output).with(no_args)
+    end
+  end
+
+  describe '#start_dump' do
+    it 'delegates to printer' do
+      allow(report_printer).to receive(:example_progress_dump)
+
+      formatter.start_dump(OpenStruct.new)
+
+      expect(report_printer).to have_received(:example_progress_dump)
+        .with(no_args)
+    end
+  end
+
+  describe '#example_group_started' do
+    let(:level) { 1 + SecureRandom.random_number(5) }
+    let(:example_number) { 1 + SecureRandom.random_number(5) }
+
+    let(:description) { 'test-or-group-foo' }
+    let(:group) { OpenStruct.new(description: description) }
+    let(:notification) { OpenStruct.new(group: group) }
+
+    before do
+      formatter.instance_variable_set(:@level, level)
+      formatter.instance_variable_set(:@example_number, example_number)
+    end
+
+    it 'delegates to printer' do
+      allow(report_printer).to receive(:group_start_output)
+
+      formatter.example_group_started(notification)
+
+      expect(report_printer).to have_received(:group_start_output)
+        .with(notification, level)
+    end
+
+    it 'increments level by one' do
+      expect { formatter.example_group_started(notification) }
+        .to change { formatter.instance_variable_get(:@level) }
+        .by(1)
+    end
+
+    it 'resets example number to zero' do
+      expect { formatter.example_group_started(notification) }
+        .to change { formatter.instance_variable_get(:@example_number) }
+        .from(example_number)
+        .to(0)
+    end
+  end
+
+  describe '#example_group_finished' do
+    let(:passed) { 1 + SecureRandom.random_number(5) }
+    let(:failed) { 1 + SecureRandom.random_number(5) }
+    let(:pending) { 1 + SecureRandom.random_number(5) }
+    let(:tests) { passed + failed + pending }
+    let(:stats_data) { { line_number => [tests, passed, failed, pending] } }
+
+    let(:group) { OpenStruct.new(metadata: { line_number: line_number }) }
+    let(:notification) { OpenStruct.new(group: group) }
+
+    before do
+      formatter.instance_variable_set(:@level, level)
+      formatter.instance_variable_get(:@test_stats)
+        .instance_variable_set(:@data, stats_data)
+    end
+
+    context 'when root level test' do
+      let(:level) { 0 }
+      let(:line_number) { 1 + SecureRandom.random_number(5) }
+
+      it 'delegates to printer' do
+        allow(report_printer).to receive(:group_finished_output)
+
+        formatter.example_group_finished(notification)
+
+        expect(report_printer).to have_received(:group_finished_output)
+          .with(stats_data[line_number], level)
+      end
+
+      it 'does not decrement level' do
+        expect { formatter.example_group_finished(notification) }
+          .not_to change { formatter.instance_variable_get(:@level) }
+      end
+
+      it 'instantiates test stats object' do
+        expect { formatter.example_group_finished(notification) }
+          .to change {
+            formatter.instance_variable_get(:@test_stats).object_id
+          }
+      end
+    end
+
+    context 'when non-root level test' do
+      let(:level) { 2 }
+      let(:line_number) { 1 + SecureRandom.random_number(5) }
+
+      it 'delegates to printer' do
+        allow(report_printer).to receive(:group_finished_output)
+
+        formatter.example_group_finished(notification)
+
+        expect(report_printer).to have_received(:group_finished_output)
+          .with(stats_data[line_number], level)
+      end
+
+      it 'decrements level' do
+        expect { formatter.example_group_finished(notification) }
+          .to change { formatter.instance_variable_get(:@level) }
+          .by(-1)
+      end
+
+      it 'does not instantiate test stats object' do
+        expect { formatter.example_group_finished(notification) }
+          .not_to change {
+            formatter.instance_variable_get(:@test_stats).object_id
+          }
+      end
+    end
+  end
+
+  describe '#example_started' do
+    let(:example_number) { 1 + SecureRandom.random_number(5) }
+
+    it 'increments example number by one' do
+      expect { formatter.example_started(OpenStruct.new) }
+        .to change { formatter.instance_variable_get(:@example_number) }
+        .by(1)
+    end
+  end
+
+  describe '#example_passed' do
+    let(:level) { 1 + SecureRandom.random_number(5) }
+    let(:example_number) { 1 + SecureRandom.random_number(5) }
+    let(:example_status) { :success }
+    let(:example_status_index) { 1 }
+
+    let(:description) { 'example-foo' }
+    let(:example) { OpenStruct.new(description: description) }
+    let(:notification) { OpenStruct.new(example: example) }
+
+    before do
+      formatter.instance_variable_set(:@level, level)
+      formatter.instance_variable_set(:@example_number, example_number)
+
+      allow(report_test_stats).to receive(:populate)
+    end
+
+    it 'populates test stats' do
+      formatter.example_passed(notification)
+
+      expect(report_test_stats).to have_received(:populate)
+        .with(notification, example_status_index)
+    end
+
+    it 'delegates progress report to printer' do
+      allow(report_printer).to receive(:example_progress_output)
+
+      formatter.example_passed(notification)
+
+      expect(report_printer).to have_received(:example_progress_output)
+        .with(example_status)
+    end
+
+    it 'delegates status report to printer' do
+      allow(report_printer).to receive(:success_output)
+
+      formatter.example_passed(notification)
+
+      expect(report_printer).to have_received(:success_output)
+        .with(description, example_number, level)
+    end
+  end
+
+  describe '#example_failed' do
+    let(:level) { 1 + SecureRandom.random_number(5) }
+    let(:example_number) { 1 + SecureRandom.random_number(5) }
+    let(:example_status) { :failure }
+    let(:example_status_index) { 2 }
+
+    let(:description) { 'example-foo' }
+    let(:example) { OpenStruct.new(description: description) }
+    let(:notification) { OpenStruct.new(example: example) }
+
+    before do
+      formatter.instance_variable_set(:@level, level)
+      formatter.instance_variable_set(:@example_number, example_number)
+
+      allow(report_test_stats).to receive(:populate)
+    end
+
+    it 'populates test stats' do
+      formatter.example_failed(notification)
+
+      expect(report_test_stats).to have_received(:populate)
+        .with(notification, example_status_index)
+    end
+
+    it 'delegates progress report to printer' do
+      allow(report_printer).to receive(:example_progress_output)
+
+      formatter.example_failed(notification)
+
+      expect(report_printer).to have_received(:example_progress_output)
+        .with(example_status)
+    end
+
+    it 'delegates status report to printer' do
+      allow(report_printer).to receive(:failure_output)
+
+      formatter.example_failed(notification)
+
+      expect(report_printer).to have_received(:failure_output)
+        .with(description, example_number, level)
+    end
+  end
+
+  describe '#example_pending' do
+    let(:level) { 1 + SecureRandom.random_number(5) }
+    let(:example_number) { 1 + SecureRandom.random_number(5) }
+    let(:example_status) { :pending }
+    let(:example_status_index) { 3 }
+
+    let(:description) { 'example-foo' }
+    let(:example) do
+      OpenStruct.new(
+        description: description,
+        execution_result: execution_result
+      )
+    end
+    let(:notification) { OpenStruct.new(example: example) }
+
+    before do
+      formatter.instance_variable_set(:@level, level)
+      formatter.instance_variable_set(:@example_number, example_number)
+
+      allow(report_test_stats).to receive(:populate)
+    end
+
+    shared_examples_for 'pending example' do
+      it 'populates test stats' do
+        formatter.example_pending(notification)
+
+        expect(report_test_stats).to have_received(:populate)
+          .with(notification, example_status_index)
+      end
+
+      it 'delegates progress report to printer' do
+        allow(report_printer).to receive(:example_progress_output)
+
+        formatter.example_pending(notification)
+
+        expect(report_printer).to have_received(:example_progress_output)
+          .with(example_status)
+      end
+
+      it 'delegates status report to printer' do
+        allow(report_printer).to receive(:pending_output)
+
+        formatter.example_pending(notification)
+
+        expect(report_printer).to have_received(:pending_output)
+          .with(notification, description, example_number, level)
+      end
+    end
+
+    context 'with pending' do
+      let(:pending_message) { "pending-#{SecureRandom.hex}" }
+      let(:directive) { "TODO: #{pending_message}" }
+      let(:execution_result) do
+        OpenStruct.new(
+          pending_message: pending_message,
+          example_skipped?: false
+        )
+      end
+
+      include_examples('pending example')
+    end
+
+    context 'with skipped' do
+      let(:pending_message) { "skip-#{SecureRandom.hex}" }
+      let(:directive) { "SKIP: #{pending_message}" }
+      let(:execution_result) do
+        OpenStruct.new(
+          pending_message: pending_message,
+          example_skipped?: true
+        )
+      end
+
+      include_examples('pending example')
+    end
+  end
+
+  describe '#message' do
+    let(:notification) { OpenStruct.new }
+
+    it 'delegates to printer' do
+      allow(report_printer).to receive(:message_output)
+
+      formatter.message(notification)
+
+      expect(report_printer).to have_received(:message_output)
+        .with(notification)
+    end
+  end
+
+  describe '#dump_failures' do
+    let(:notification) { OpenStruct.new }
+
+    it 'delegates to printer' do
+      allow(report_printer).to receive(:store_failed_examples_summary)
+
+      formatter.dump_failures(notification)
+
+      expect(report_printer).to have_received(:store_failed_examples_summary)
+        .with(notification)
+    end
+  end
+
+  describe '#dump_pending' do
+    let(:notification) { OpenStruct.new }
+
+    it 'delegates to printer' do
+      allow(report_printer).to receive(:store_pending_examples_summary)
+
+      formatter.dump_pending(notification)
+
+      expect(report_printer).to have_received(:store_pending_examples_summary)
+        .with(notification)
+    end
+  end
+
+  describe '#dump_summary' do
+    let(:seed) { 1 + SecureRandom.random_number(10_000) }
+    let(:notification) { OpenStruct.new }
+
+    it 'delegates to printer' do
+      allow(report_printer).to receive(:summary_output)
+
+      formatter.instance_variable_set(:@seed, seed)
+      formatter.dump_summary(notification)
+
+      expect(report_printer).to have_received(:summary_output)
+        .with(notification, seed)
+    end
+  end
+end