rspec-tracer 1.2.3 → 2.0.0.pre.2

data/lib/rspec_tracer/html_reporter/reporter.rb

@@ -1,242 +0,0 @@
-# frozen_string_literal: true
-
-require 'erb'
-require 'time'
-
-module RSpecTracer
-  module HTMLReporter
-    class Reporter
-      attr_reader :last_run, :examples, :flaky_examples, :examples_dependency, :files_dependency
-
-      def initialize(report_dir, reporter)
-        @report_dir = report_dir
-        @reporter = reporter
-      end
-
-      def generate_report
-        starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-
-        prepare
-
-        file_name = File.join(@report_dir, 'index.html')
-
-        File.open(file_name, 'wb') do |file|
-          file.puts(template('layout').result(binding))
-        end
-
-        ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        elapsed = RSpecTracer::TimeFormatter.format_time(ending - starting)
-
-        RSpecTracer.logger.debug "RSpecTracer generated HTML report to #{file_name} (took #{elapsed})"
-      end
-
-      private
-
-      def prepare
-        format_last_run
-        format_examples
-        format_duplicate_examples
-        format_flaky_examples
-        format_examples_dependency
-        format_files_dependency
-        copy_assets
-      end
-
-      def copy_assets
-        Dir[File.join(File.dirname(__FILE__), 'public/*')].each do |path|
-          FileUtils.cp_r(path, asset_output_path)
-        end
-      end
-
-      def format_last_run
-        @last_run = @reporter.last_run.slice(
-          :actual_count,
-          :duplicate_examples,
-          :failed_examples,
-          :pending_examples,
-          :skipped_examples
-        )
-      end
-
-      def format_examples
-        @examples = {}
-
-        @reporter.all_examples.each_pair do |example_id, example|
-          @examples[example_id] = {
-            id: example_id,
-            description: example[:full_description],
-            location: example_location(example[:rerun_file_name], example[:rerun_line_number]),
-            status: example[:run_reason] || 'Skipped'
-          }.merge(example_result(example_id, example))
-        end
-      end
-
-      def example_result(example_id, example)
-        if example[:execution_result].nil?
-          {
-            result: @reporter.example_interrupted?(example_id) ? 'Interrupted' : '_',
-            last_run: '_'
-          }
-        else
-          {
-            result: example[:execution_result][:status].capitalize,
-            last_run: example_run_local_time(example[:execution_result][:finished_at])
-          }
-        end
-      end
-
-      def format_duplicate_examples
-        @duplicate_examples = []
-
-        @reporter.duplicate_examples.each_pair do |example_id, examples|
-          examples.each do |example|
-            @duplicate_examples << {
-              id: example_id,
-              description: example[:full_description],
-              location: example_location(example[:rerun_file_name], example[:rerun_line_number])
-            }
-          end
-        end
-      end
-
-      def format_flaky_examples
-        @flaky_examples = @examples.slice(*@reporter.flaky_examples).values
-      end
-
-      def example_run_local_time(utc_time)
-        case utc_time
-        when Time
-          utc_time.localtime.strftime('%Y-%m-%d %H:%M:%S')
-        when String
-          Time.parse(utc_time).localtime.strftime('%Y-%m-%d %H:%M:%S')
-        else
-          utc_time.inspect
-        end
-      end
-
-      def format_examples_dependency
-        @examples_dependency = []
-
-        @reporter.dependency.each_pair do |example_id, files|
-          @examples_dependency << {
-            example_id: example_id,
-            example: @examples[example_id][:description],
-            files_count: files.count,
-            files: files.map { |file_name| shortened_file_name(file_name) }.sort.join(', ')
-          }
-        end
-      end
-
-      def format_files_dependency
-        @files_dependency = []
-
-        @reporter.reverse_dependency.each_pair do |main_file_name, data|
-          short_file_name = shortened_file_name(main_file_name)
-
-          @files_dependency << {
-            name: short_file_name,
-            example_count: data[:example_count],
-            file_count: data[:examples].count,
-            files: data[:examples]
-              .map { |file_name, count| "#{shortened_file_name(file_name)}: #{count}" }
-              .join(', ')
-          }
-        end
-      end
-
-      def example_location(file_name, line_number)
-        "#{shortened_file_name(file_name)}:#{line_number}"
-      end
-
-      def shortened_file_name(file_name)
-        file_name.sub(%r{^/}, '')
-      end
-
-      def asset_output_path
-        @asset_output_path ||= begin
-          asset_output_path = File.join(@report_dir, 'assets', RSpecTracer::VERSION)
-
-          FileUtils.mkdir_p(asset_output_path)
-
-          asset_output_path
-        end
-      end
-
-      def assets_path(name)
-        File.join('./assets', RSpecTracer::VERSION, name)
-      end
-
-      def formatted_examples(title, examples)
-        title_id = report_container_id(title)
-        current_binding = binding
-
-        current_binding.local_variable_set(:title_id, title_id)
-        template(title_id).result(current_binding)
-      end
-
-      def formatted_duplicate_examples(title, duplicate_examples)
-        title_id = report_container_id(title)
-        current_binding = binding
-
-        current_binding.local_variable_set(:title_id, title_id)
-        template(title_id).result(current_binding)
-      end
-
-      def formatted_flaky_examples(title, flaky_examples)
-        title_id = report_container_id(title)
-        current_binding = binding
-
-        current_binding.local_variable_set(:title_id, title_id)
-        template(title_id).result(current_binding)
-      end
-
-      def formatted_examples_dependency(title, examples_dependency)
-        title_id = report_container_id(title)
-        current_binding = binding
-
-        current_binding.local_variable_set(:title_id, title_id)
-        template(title_id).result(current_binding)
-      end
-
-      def formatted_files_dependency(title, files_dependency)
-        title_id = report_container_id(title)
-        current_binding = binding
-
-        current_binding.local_variable_set(:title_id, title_id)
-        template(title_id).result(current_binding)
-      end
-
-      def report_container_id(title)
-        title.gsub(/\s+/, ' ').downcase.tr(' ', '_')
-      end
-
-      def template(name)
-        ERB.new(File.read(File.join(File.dirname(__FILE__), 'views/', "#{name}.erb"), encoding: 'UTF-8'))
-      end
-
-      def example_status_css_class(example_status)
-        case example_status.split.first
-        when 'Failed', 'Flaky', 'Interrupted'
-          'red'
-        when 'Pending'
-          'yellow'
-        else
-          'blue'
-        end
-      end
-
-      def example_result_css_class(example_result)
-        case example_result
-        when 'Passed'
-          'green'
-        when 'Failed', 'Interrupted'
-          'red'
-        when 'Pending'
-          'yellow'
-        else
-          'blue'
-        end
-      end
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-<div class="report_container" id="<%= title_id %>">
-  <h2>
-    <span class="group_name"><%= title %></span>
-    (
-      <span class="blue">
-        <strong><%= duplicate_examples.count %></strong>
-      </span> examples
-    )
-  </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>
-        </tr>
-      </thead>
-
-      <tbody>
-        <% duplicate_examples.each do |example| %>
-          <tr>
-            <td><%= example[:id] %></td>
-            <td><%= example[:description] %></td>
-            <td><%= example[:location] %></td>
-          </tr>
-        <% end %>
-      </tbody>
-    </table>
-  </div>
-</div>

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

@@ -1,58 +0,0 @@
-<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[:duplicate_examples].positive? %>
-        <span class="blue">
-          <strong><%= last_run[:duplicate_examples] %></strong>
-        </span> duplicates,
-      <% end %>
-      <% 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

@@ -1,36 +0,0 @@
-<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

@@ -1,36 +0,0 @@
-<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/flaky_examples.erb

@@ -1,38 +0,0 @@
-<div class="report_container" id="<%= title_id %>">
-  <h2>
-    <span class="group_name"><%= title %></span>
-    (
-      <span class="blue">
-        <strong><%= flaky_examples.count %></strong>
-      </span> examples
-    )
-  </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>Result</th>
-          <th>Run At</th>
-        </tr>
-      </thead>
-
-      <tbody>
-        <% flaky_examples.each do |example| %>
-          <tr>
-            <td><%= example[:id] %></td>
-            <td><%= example[:description] %></td>
-            <td><%= example[:location] %></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/layout.erb

@@ -1,38 +0,0 @@
-<!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) %>
-        <% unless @duplicate_examples.empty? %>
-          <%= formatted_duplicate_examples('Duplicate Examples', @duplicate_examples) %>
-        <% end %>
-        <% unless @flaky_examples.empty? %>
-          <%= formatted_flaky_examples('Flaky Examples', @flaky_examples) %>
-        <% end %>
-        <%= 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/remote_cache/aws.rb

@@ -1,176 +0,0 @@
-# frozen_string_literal: true
-
-module RSpecTracer
-  module RemoteCache
-    class Aws
-      class AwsError < StandardError; end
-
-      def initialize
-        @s3_bucket, @s3_path = setup_s3
-        @aws_cli = RSpecTracer.use_local_aws ? 'awslocal' : 'aws'
-        @use_test_suite_id_cache = ENV.fetch('USE_TEST_SUITE_ID_CACHE', nil) == 'true'
-        @test_suite_id = ENV.fetch('TEST_SUITE_ID', nil) if @use_test_suite_id_cache
-      end
-
-      def branch_refs?(branch_name)
-        key = "#{@s3_path}/branch-refs/#{branch_name}/branch_refs.json"
-
-        system(
-          @aws_cli,
-          's3api',
-          'head-object',
-          '--bucket',
-          @s3_bucket,
-          '--key',
-          key,
-          out: File::NULL,
-          err: File::NULL
-        )
-      end
-
-      def download_branch_refs(branch_name, file_name)
-        key = "#{@s3_path}/branch-refs/#{branch_name}/branch_refs.json"
-
-        system(
-          @aws_cli,
-          's3api',
-          'get-object',
-          '--bucket',
-          @s3_bucket,
-          '--key',
-          key,
-          file_name,
-          out: File::NULL,
-          err: File::NULL
-        )
-      end
-
-      def upload_branch_refs(branch_name, file_name)
-        remote_path = "s3://#{@s3_bucket}/#{@s3_path}/branch-refs/#{branch_name}/branch_refs.json"
-
-        raise AwsError, "Failed to upload branch refs for #{branch_name} branch" unless system(
-          @aws_cli,
-          's3',
-          'cp',
-          file_name,
-          remote_path,
-          out: File::NULL,
-          err: File::NULL
-        )
-
-        RSpecTracer.logger.debug "Uploaded branch refs for #{branch_name} branch to #{remote_path}"
-      end
-
-      def cache_files_list(ref)
-        prefix = if @use_test_suite_id_cache && !@test_suite_id.nil?
-                   "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/#{@test_suite_id}/"
-                 else
-                   "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/"
-                 end
-
-        `#{@aws_cli} s3 ls #{prefix} --recursive`.chomp.split("\n")
-      end
-
-      def download_file(ref, file_name)
-        remote_path = File.join(s3_dir(ref), file_name)
-        local_path = File.join(RSpecTracer.cache_path, file_name)
-
-        raise AwsError, "Failed to download file #{remote_path}" unless system(
-          @aws_cli,
-          's3',
-          'cp',
-          remote_path,
-          local_path,
-          out: File::NULL,
-          err: File::NULL
-        )
-
-        RSpecTracer.logger.debug "Downloaded file #{remote_path} to #{local_path}"
-      end
-
-      def download_dir(ref, run_id)
-        remote_dir = s3_dir(ref, run_id)
-        local_dir = File.join(RSpecTracer.cache_path, run_id)
-
-        raise AwsError, "Failed to download files from #{remote_dir}" unless system(
-          @aws_cli,
-          's3',
-          'cp',
-          remote_dir,
-          local_dir,
-          '--recursive',
-          out: File::NULL,
-          err: File::NULL
-        )
-
-        RSpecTracer.logger.debug "Downloaded cache files from #{remote_dir} to #{local_dir}"
-      rescue AwsError => e
-        FileUtils.rm_rf(local_dir)
-
-        raise e
-      end
-
-      def upload_file(ref, file_name)
-        remote_path = File.join(s3_dir(ref), file_name)
-        local_path = File.join(RSpecTracer.cache_path, file_name)
-
-        raise AwsError, "Failed to upload file #{local_path}" unless system(
-          @aws_cli,
-          's3',
-          'cp',
-          local_path,
-          remote_path,
-          out: File::NULL,
-          err: File::NULL
-        )
-
-        RSpecTracer.logger.debug "Uploaded file #{local_path} to #{remote_path}"
-      end
-
-      def upload_dir(ref, run_id)
-        remote_dir = s3_dir(ref, run_id)
-        local_dir = File.join(RSpecTracer.cache_path, run_id)
-
-        raise AwsError, "Failed to upload files from #{local_dir}" unless system(
-          @aws_cli,
-          's3',
-          'cp',
-          local_dir,
-          remote_dir,
-          '--recursive',
-          out: File::NULL,
-          err: File::NULL
-        )
-
-        RSpecTracer.logger.debug "Uploaded files from #{local_dir} to #{remote_dir}"
-      end
-
-      private
-
-      def setup_s3
-        s3_uri = RSpecTracer.reports_s3_path
-
-        raise AwsError, 'Invalid reports S3 path' if s3_uri.nil?
-
-        uri_parts = s3_uri[4..].split('/')
-
-        raise AwsError, "Invalid S3 URI #{s3_uri}" unless uri_parts.length >= 3 && uri_parts.first.empty?
-
-        [
-          uri_parts[1],
-          uri_parts[2..].join('/')
-        ]
-      end
-
-      def s3_dir(ref, run_id = nil)
-        test_suite_id = ENV.fetch('TEST_SUITE_ID', nil)
-
-        if test_suite_id.nil?
-          "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/#{run_id}/".sub(%r{/+$}, '/')
-        else
-          "s3://#{@s3_bucket}/#{@s3_path}/#{ref}/#{test_suite_id}/#{run_id}/".sub(%r{/+$}, '/')
-        end
-      end
-    end
-  end
-end