rspec-tracer 0.1.0

data/lib/rspec_tracer/html_reporter/views/examples.erb

@@ -0,0 +1,53 @@
+<div class="report_container" id="<%= title_id %>">
+  <h2>
+    <span class="group_name"><%= title %></span>
+    (
+      <span class="blue">
+        <strong><%= last_run[:actual_count] %></strong>
+      </span> examples,
+      <% if last_run[:failed_examples].positive? %>
+        <span class="red">
+          <strong><%= last_run[:failed_examples] %></strong>
+        </span> failures,
+      <% end %>
+      <% if last_run[:pending_examples].positive? %>
+        <span class="yellow">
+          <strong><%= last_run[:pending_examples] %></strong>
+        </span> pending,
+      <% end %>
+      <span class="blue">
+        <strong><%= last_run[:skipped_examples] %></strong>
+      </span> skipped by rspec-tracer
+    )
+  </h2>
+
+  <a name="<%= title_id %>"></a>
+
+  <div class="report-table--responsive">
+    <table class="report-table">
+      <thead>
+        <tr>
+          <th>ID</th>
+          <th>Description</th>
+          <th>Location</th>
+          <th>Run Reason</th>
+          <th>Result</th>
+          <th>Run At</th>
+        </tr>
+      </thead>
+
+      <tbody>
+        <% examples.each do |example| %>
+          <tr>
+            <td><%= example[:id] %></td>
+            <td><%= example[:description] %></td>
+            <td><%= example[:location] %></td>
+            <td><strong class="<%= example_status_css_class(example[:status]) %>"><%= example[:status] %></strong></td>
+            <td><strong class="<%= example_result_css_class(example[:result]) %>"><%= example[:result] %></strong></td>
+            <td width="8%"><%= example[:last_run] %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>

data/lib/rspec_tracer/html_reporter/views/examples_dependency.erb

@@ -0,0 +1,36 @@
+<div class="report_container" id="<%= title_id %>">
+  <h2>
+    <span class="group_name"><%= title %></span>
+    (
+      <span class="blue">
+        <strong><%= examples_dependency.count %></strong>
+      </span> examples
+    )
+  </h2>
+
+  <a name="<%= title_id %>"></a>
+
+  <div class="report-table--responsive">
+    <table class="report-table">
+      <thead>
+        <tr>
+          <th>Example ID</th>
+          <th>Example</th>
+          <th>Files Count</th>
+          <th data-orderable="false">Files Name</th>
+        </tr>
+      </thead>
+
+      <tbody>
+        <% examples_dependency.each do |example_dependency| %>
+          <tr>
+            <td><%= example_dependency[:example_id] %></td>
+            <td><%= example_dependency[:example] %></td>
+            <td class="number" width="8%"><strong><%= example_dependency[:files_count] %></strong></td>
+            <td><%= example_dependency[:files] %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>

data/lib/rspec_tracer/html_reporter/views/files_dependency.erb

@@ -0,0 +1,36 @@
+<div class="report_container" id="<%= title_id %>">
+  <h2>
+    <span class="group_name"><%= title %></span>
+    (
+      <span class="blue">
+        <strong><%= files_dependency.count %></strong>
+      </span> files
+    )
+  </h2>
+
+  <a name="<%= title_id %>"></a>
+
+  <div class="report-table--responsive">
+    <table class="report-table">
+      <thead>
+        <tr>
+          <th searchable="true">File</th>
+          <th>Examples Count</th>
+          <th>Files Count</th>
+          <th data-orderable="false">Dependent Files</th>
+        </tr>
+      </thead>
+
+      <tbody>
+        <% files_dependency.each do |file_dependency| %>
+          <tr class="t-example">
+            <td><%= file_dependency[:name] %></td>
+            <td class="number" width="8%"><strong><%= file_dependency[:example_count] %></strong></td>
+            <td class="number" width="8%"><strong><%= file_dependency[:file_count] %></strong></td>
+            <td><%= file_dependency[:files] %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>

data/lib/rspec_tracer/html_reporter/views/layout.erb

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+
+<html xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <title>RSpec Tracer Report for <%= RSpecTracer.project_name %></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="loading">
+      <img src="<%= assets_path('loading.gif') %>" width="60" height="60" alt="loading" />
+    </div>
+
+    <div id="wrapper" class="hide">
+      <ul class="group_tabs"></ul>
+
+      <div id="content">
+        <%= formatted_examples('Examples', examples.values) %>
+        <%= formatted_examples_dependency('Examples Dependency', examples_dependency) %>
+        <%= formatted_files_dependency("Files Dependency", files_dependency) %>
+      </div>
+
+      <div id="footer">
+        Generated by <a href="https://github.com/avmnu-sng/rspec-tracer">rspec-tracer</a>
+        v<%= RSpecTracer::VERSION %>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/rspec_tracer/reporter.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+module RSpecTracer
+  class Reporter
+    attr_reader :all_examples, :pending_examples, :all_files, :dependency,
+                :reverse_dependency, :examples_coverage, :last_run
+
+    def initialize
+      initialize_examples
+      initialize_files
+      initialize_dependency
+      initialize_coverage
+    end
+
+    def register_example(example)
+      @all_examples[example[:example_id]] = example
+    end
+
+    def on_example_skipped(example_id)
+      @skipped_examples << example_id
+    end
+
+    def on_example_passed(example_id, result)
+      @all_examples[example_id][:execution_result] = formatted_execution_result(result)
+    end
+
+    def on_example_failed(example_id, result)
+      @failed_examples << example_id
+      @all_examples[example_id][:execution_result] = formatted_execution_result(result)
+    end
+
+    def on_example_pending(example_id, result)
+      @pending_examples << example_id
+      @all_examples[example_id][:execution_result] = formatted_execution_result(result)
+    end
+
+    def register_deleted_examples(seen_examples)
+      @deleted_examples = seen_examples.keys.to_set - (@skipped_examples | @all_examples.keys)
+
+      @deleted_examples.select! do |example_id|
+        example = seen_examples[example_id]
+
+        file_changed?(example[:file_name]) || file_changed?(example[:rerun_file_name])
+      end
+    end
+
+    def register_failed_example(example_id)
+      @failed_examples << example_id
+    end
+
+    def register_pending_example(example_id)
+      @pending_examples << example_id
+    end
+
+    def example_skipped?(example_id)
+      @skipped_examples.include?(example_id)
+    end
+
+    def example_failed?(example_id)
+      @failed_examples.include?(example_id)
+    end
+
+    def example_pending?(example_id)
+      @pending_examples.include?(example_id)
+    end
+
+    def example_deleted?(example_id)
+      @deleted_examples.include?(example_id)
+    end
+
+    def register_source_file(source_file)
+      @all_files[source_file[:file_name]] = source_file
+    end
+
+    def on_file_deleted(file_name)
+      @deleted_files << file_name
+    end
+
+    def on_file_modified(file_name)
+      @modified_files << file_name
+    end
+
+    def file_deleted?(file_name)
+      @deleted_files.include?(file_name)
+    end
+
+    def file_modified?(file_name)
+      @modified_files.include?(file_name)
+    end
+
+    def file_changed?(file_name)
+      file_deleted?(file_name) || file_modified?(file_name)
+    end
+
+    def register_dependency(example_id, file_name)
+      @dependency[example_id] << file_name
+    end
+
+    def register_examples_coverage(examples_coverage)
+      @examples_coverage = examples_coverage
+    end
+
+    def generate_reverse_dependency_report
+      @dependency.each_pair do |example_id, files|
+        example_file = @all_examples[example_id][:rerun_file_name]
+
+        files.each do |file_name|
+          @reverse_dependency[file_name][:example_count] += 1
+          @reverse_dependency[file_name][:examples][example_file] += 1
+        end
+      end
+
+      format_reverse_dependency_report
+    end
+
+    def generate_last_run_report
+      @last_run = {
+        run_id: @run_id,
+        pid: RSpecTracer.pid,
+        actual_count: RSpec.world.example_count + @skipped_examples.count,
+        example_count: RSpec.world.example_count,
+        failed_examples: @failed_examples.count,
+        skipped_examples: @skipped_examples.count,
+        pending_examples: @pending_examples.count
+      }
+    end
+
+    def write_reports
+      @run_id = Digest::MD5.hexdigest(@all_examples.keys.sort.to_json)
+      @cache_dir = File.join(RSpecTracer.cache_path, @run_id)
+
+      FileUtils.mkdir_p(@cache_dir)
+
+      %i[
+        all_examples
+        failed_examples
+        pending_examples
+        all_files
+        dependency
+        reverse_dependency
+        examples_coverage
+        last_run
+      ].each { |report_type| send("write_#{report_type}_report") }
+
+      puts "RSpec tracer reports generated to #{@cache_dir}"
+    end
+
+    private
+
+    def initialize_examples
+      @all_examples = {}
+      @failed_examples = Set.new
+      @skipped_examples = Set.new
+      @pending_examples = Set.new
+      @deleted_examples = Set.new
+    end
+
+    def initialize_files
+      @all_files = {}
+      @modified_files = Set.new
+      @deleted_files = Set.new
+    end
+
+    def initialize_dependency
+      @dependency = Hash.new { |hash, key| hash[key] = Set.new }
+      @reverse_dependency = Hash.new do |examples, file_name|
+        examples[file_name] = {
+          example_count: 0,
+          examples: Hash.new(0)
+        }
+      end
+    end
+
+    def initialize_coverage
+      @examples_coverage = Hash.new do |examples, example_id|
+        examples[example_id] = Hash.new do |files, file_name|
+          files[file_name] = {}
+        end
+      end
+    end
+
+    def formatted_execution_result(result)
+      {
+        started_at: result.started_at.utc,
+        finished_at: result.finished_at.utc,
+        run_time: result.run_time,
+        status: result.status.to_s
+      }
+    end
+
+    def format_reverse_dependency_report
+      @reverse_dependency.transform_values! do |data|
+        {
+          example_count: data[:example_count],
+          examples: data[:examples].sort_by { |file_name, count| [-count, file_name] }.to_h
+        }
+      end
+
+      report = @reverse_dependency.sort_by do |file_name, data|
+        [-data[:example_count], file_name]
+      end
+
+      @reverse_dependency = report.to_h
+    end
+
+    def write_all_examples_report
+      file_name = File.join(@cache_dir, 'all_examples.json')
+
+      File.write(file_name, JSON.pretty_generate(@all_examples))
+    end
+
+    def write_failed_examples_report
+      file_name = File.join(@cache_dir, 'failed_examples.json')
+
+      File.write(file_name, JSON.pretty_generate(@failed_examples.to_a))
+    end
+
+    def write_pending_examples_report
+      file_name = File.join(@cache_dir, 'pending_examples.json')
+
+      File.write(file_name, JSON.pretty_generate(@pending_examples.to_a))
+    end
+
+    def write_all_files_report
+      file_name = File.join(@cache_dir, 'all_files.json')
+
+      File.write(file_name, JSON.pretty_generate(@all_files))
+    end
+
+    def write_dependency_report
+      file_name = File.join(@cache_dir, 'dependency.json')
+
+      File.write(file_name, JSON.pretty_generate(@dependency))
+    end
+
+    def write_reverse_dependency_report
+      file_name = File.join(@cache_dir, 'reverse_dependency.json')
+
+      File.write(file_name, JSON.pretty_generate(@reverse_dependency))
+    end
+
+    def write_examples_coverage_report
+      file_name = File.join(@cache_dir, 'examples_coverage.json')
+
+      File.write(file_name, JSON.pretty_generate(@examples_coverage))
+    end
+
+    def write_last_run_report
+      file_name = File.join(RSpecTracer.cache_path, 'last_run.json')
+      last_run_data = @last_run.merge(run_id: @run_id, timestamp: Time.now.utc)
+
+      File.write(file_name, JSON.pretty_generate(last_run_data))
+    end
+  end
+end

data/lib/rspec_tracer/rspec_reporter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RSpecTracer
+  module RSpecReporter
+    def example_started(example)
+      RSpecTracer.coverage_reporter.record_coverage
+      RSpecTracer.start_example_trace if RSpecTracer.trace_example?
+
+      super(example)
+    end
+
+    def example_finished(example)
+      passed = example.execution_result.status == :passed
+      RSpecTracer.stop_example_trace(passed) if RSpecTracer.trace_example?
+
+      example_id = example.metadata[:rspec_tracer_example_id]
+      RSpecTracer.coverage_reporter.compute_diff(example_id)
+
+      super(example)
+    end
+
+    def example_passed(example)
+      example_id = example.metadata[:rspec_tracer_example_id]
+      RSpecTracer.runner.on_example_passed(example_id, example.execution_result)
+
+      super(example)
+    end
+
+    def example_failed(example)
+      example_id = example.metadata[:rspec_tracer_example_id]
+      RSpecTracer.runner.on_example_failed(example_id, example.execution_result)
+
+      super(example)
+    end
+
+    def example_pending(example)
+      example_id = example.metadata[:rspec_tracer_example_id]
+      RSpecTracer.runner.on_example_pending(example_id, example.execution_result)
+
+      super(example)
+    end
+  end
+end