RubyGems - rspec-flaky - Versions diffs - 0.0.1 - Mend

rspec-flaky 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

checksums.yaml +7 -0
data/README.md +39 -0
data/assets/layout.html.erb +149 -0
data/bin/rspec-flaky +4 -0
data/lib/rspec/flaky.rb +32 -0
data/lib/rspec/flaky/cli.rb +64 -0
data/lib/rspec/flaky/differ.rb +61 -0
data/lib/rspec/flaky/drawer.rb +21 -0
data/lib/rspec/flaky/dumper/db.rb +25 -0
data/lib/rspec/flaky/dumper/json.rb +23 -0
data/lib/rspec/flaky/pathes.rb +27 -0
data/lib/rspec/flaky/tables.rb +22 -0
data/lib/rspec/flaky/version.rb +5 -0
metadata +71 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d80b7e5a54c2a9d25326907dc0ff92304f410041c55e24d030bc99451370273
+  data.tar.gz: 6bf0165957822e3af4e57f477c18fac6f37cd756f275f78126265b085d365696
+SHA512:
+  metadata.gz: 43df5f4540f9cde2c791cd194068dcc4b912dd63f1429d4121166469bac2a216426ab896cc97e946903c098cf3100355bc2592f82f23abce2691112c60b35fa0
+  data.tar.gz: ccddd3c02724b590f8c2798ad99c0488670719676afa6dc6aaae4f87e274f9058b925b9c8ecc48417139ba988c27b2ef0a0152f8e64b68442c199bec0a619f6c

data/README.md ADDED

@@ -0,0 +1,39 @@
+# RSpecFlaky
+TODO: Write a gem description
+## Installation
+Add this line to test group of your application's Gemfile:
+    gem 'rspec-flaky'
+Install the gem:
+    $ bundle
+And then add this line to your spec/spec_helper.rb:
+    require 'rspec/flaky'
+Select the model whose attributes will be dumped:
+    it 'is flaky test', tables: [User, Post] do
+        expect([true, false]).to be true
+    end
+## Usage
+Run the command to iteratively run flaky example:
+    rspec-flaky path/to/flaky_spec.rb:12 -i 10
+If at least one example is failed you can compare pointed model's attributes dumped to tmp/flaky_test folder.
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/assets/layout.html.erb ADDED

@@ -0,0 +1,149 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <link href="application.css" rel='stylesheet' type='text/css' />
+  <title>Flaky Result</title>
+  <style>
+    html {
+      line-height: 1.15;
+    }
+    body {
+      margin: auto;
+      width: 80%;
+    }
+    h1 {
+      font-size: 2em;
+      margin: .67em 0
+    }
+    pre {
+      font-family: monospace, monospace;
+      font-size: 1em
+    }
+    html {
+      font-family: sans-serif
+    }
+    .pure-table {
+      border-collapse: collapse;
+      border-spacing: 0;
+      empty-cells: show;
+      border: 1px solid #cbcbcb
+    }
+    table {
+      table-layout: fixed;
+      width: 100%
+    }
+    .pure-table caption {
+      color: #000;
+      font: italic 85%/1 arial, sans-serif;
+      padding: 1em 0;
+      text-align: center
+    }
+    .pure-table td,
+    .pure-table th {
+      border-left: 1px solid #cbcbcb;
+      border-width: 0 0 0 1px;
+      font-size: inherit;
+      margin: 0;
+      overflow: visible;
+      padding: .5em 1em
+    }
+    .pure-table thead {
+      background-color: #e0e0e0;
+      color: #000;
+      text-align: left;
+      vertical-align: bottom
+    }
+    .pure-table td {
+      background-color: transparent;
+      max-width: 600px;
+      overflow: hidden;
+    }
+    .pure-table-odd td {
+      background-color: #f2f2f2
+    }
+    .pure-table-striped tr:nth-child(2n-1) td {
+      background-color: #f2f2f2
+    }
+    .pure-table-bordered td {
+      border-bottom: 1px solid #cbcbcb
+    }
+    .pure-table-bordered tbody>tr:last-child>td {
+      border-bottom-width: 0
+    }
+    .pure-table-horizontal td,
+    .pure-table-horizontal th {
+      border-width: 0 0 1px 0;
+      border-bottom: 1px solid #cbcbcb
+    }
+    .pure-table-horizontal tbody>tr:last-child>td {
+      border-bottom-width: 0
+    }
+  </style>
+</head>
+<body>
+  <% @diffs.each do |diffs| -%>
+    <div class="example">
+      <h2>Location: <%= diffs[:location] -%></h2>
+      <h2>Table: <%= diffs[:table] %></h2>
+      <% if diffs[:result] == "no_content" -%>
+        There were no failed and passed tests during the testing process. Try to increase the number of iterations
+      <% elsif diffs[:result] == "empty_table" -%>
+        Table is empty
+      <% else -%>
+        <p>Diffs:</p>
+        <% diffs[:result].each do |diff| -%>
+          <div>
+            <table class="pure-table">
+              <thead>
+                <th>
+                  <%=diffs[:table]%>'s Attribute
+                </th>
+                <th>
+                  Passed value
+                </th>
+                <th>
+                  Failed value
+                </th>
+              </thead>
+              <tbody>
+                <% diff.each do |attribute| -%>
+                  <tr>
+                    <td>
+                      <span><%= attribute[1] || "Record"%></span>
+                    </td>
+                    <td style="background-color: lightgreen">
+                      <span><pre><%= prettify attribute[2]%></pre></span>
+                    </td>
+                    <td style="background-color: rosybrown">
+                      <span><pre><%= prettify attribute[3]%></pre></span>
+                    </td>
+                  </tr>
+                <% end -%>
+              </tbody>
+            </table>
+          </div>
+        <% end -%>
+      <% end -%>
+    </div>
+  <%end -%>
+</body>
+</html>

data/bin/rspec-flaky ADDED

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'rspec/flaky/cli'
+Flaky::CLI.new.run(ARGV)

data/lib/rspec/flaky.rb ADDED

@@ -0,0 +1,32 @@
+require 'rspec/flaky/version'
+require 'rspec/flaky/differ'
+require 'rspec/flaky/tables'
+require 'rspec/flaky/pathes'
+require 'rspec/flaky/drawer'
+require 'rspec'
+require 'fileutils'
+require 'open3'
+module RSpec::Flaky
+  def self.run_spec locations, options
+    FileUtils.rm_rf(Pathes.summary_path)
+    rspec_options = options.delete(:rspec_options) || ""
+    options[:iterations].times do
+      if options[:silent]
+        Open3.capture2e("FLAKY_SPEC=1 rspec #{locations} #{rspec_options}")
+      else
+        system("FLAKY_SPEC=1 rspec #{locations} #{rspec_options}")
+      end
+    end
+    Differ.get_result
+    Pathes.summary_path.children.each do |child|
+      if child.basename.to_s.start_with?(".:")
+        FileUtils.rm_rf(child) unless options[:save_jsons]
+      elsif child.basename.to_s == 'database_dumps'
+        FileUtils.rm_rf(child) unless options[:dump_db]
+      end
+    end
+  end
+end

data/lib/rspec/flaky/cli.rb ADDED

@@ -0,0 +1,64 @@
+require 'rspec/flaky'
+require 'optparse'
+module Flaky
+  class CLI
+    DEFAULT_OPTIONS = {
+      iterations: 1,
+      silent: false,
+      save_jsons: false,
+      dump_db: false
+    }
+    def run argv
+      locations = get_location(argv) unless argv.any?{|arg| arg == '-h' || arg == '--help'}
+      options = parse_options(argv).reverse_merge(DEFAULT_OPTIONS)
+      options[:rspec_options] = extract_rspec_options argv
+      RSpec::Flaky.run_spec(locations, options)
+    end
+    private
+    def get_location(argv)
+      first_arg = argv.shift
+      raise 'You need to specify location first' unless Pathname.new(first_arg).exist?
+      return first_arg
+    end
+    def parse_options argv
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: rspec-flaky path/to/flaky_spec.rb:12 [options] -- [rspec options]"
+        opts.on("-i", "--iterations [NUMBER]", Integer, "Execute spec a given number of times")  do |v|
+          options[:iterations] = v
+        end
+        opts.on("--silent", "Silent mode (no output)") do |v|
+          options[:silent] = v
+        end
+        opts.on("-j", "--jsons", "Save pointed models attributes")  do |v|
+          options[:save_jsons] = v
+        end
+        opts.on("-d", "--dump", "Dump database to sql-file after each example")  do |v|
+          options[:dump_db] = v
+        end
+        opts.on('-h', '--help', 'Displays Help') do
+          puts opts
+          exit
+        end
+      end.parse!(argv)
+      options
+    end
+    def extract_rspec_options argv
+      idx = argv.index('--') || -1
+      rspec_options = argv[idx+1..-1]
+      return if rspec_options.empty?
+      rspec_options.compact.join(' ')
+    end
+  end
+end

data/lib/rspec/flaky/differ.rb ADDED

@@ -0,0 +1,61 @@
+require 'hashdiff'
+require 'fileutils'
+module Differ
+  EXPECTED_CONTENT = %w(failed.json passed.json)
+  class << self
+    def get_result
+      create_summary_folder
+      @diffs = []
+      Pathes.summary_path.children.each do |example_dir|
+        next unless example_dir.directory?
+        next unless example_dir.basename.to_s.start_with?(".:")
+        example_dir.children.select do |tables_dir|
+          next unless tables_dir.directory?
+          @diffs << {
+            location: Pathes.relative_path(example_dir),
+            table: tables_dir.basename.to_s,
+            result: get_diffs(tables_dir)
+          }
+        end
+      end
+      Drawer.draw @diffs
+    end
+    def create_summary_folder
+      FileUtils.mkdir_p(Pathes.summary_path)
+    end
+    def get_diffs tables_dir
+      return 'no_content' unless contains_passed_and_failed_jsons? tables_dir
+      result = []
+      jsons = tables_dir.children.select { |child| EXPECTED_CONTENT.include? child.basename.to_s }
+      jsons = read_jsons(jsons)
+      return 'empty_table' if jsons.values.all? &:empty?
+      jsons.values.map(&:length).max.times do |idx|
+        passed_record = jsons["passed"].try(:[], idx) || {}
+        failed_record = jsons["failed"].try(:[], idx) || {}
+        result << Hashdiff.diff(passed_record, failed_record)
+      end
+      result
+    end
+    def read_jsons pathes
+      {}.tap do |hash|
+        pathes.each do |path|
+          hash[path.basename.to_s.split('.')[0]] = JSON.parse(File.read(Pathes.base_path.join(path)))
+        end
+      end
+    end
+    def contains_passed_and_failed_jsons? tables_dir
+      actual_content = tables_dir.children.map(&:basename).map(&:to_s)
+      EXPECTED_CONTENT & actual_content == EXPECTED_CONTENT
+    end
+  end
+end

data/lib/rspec/flaky/drawer.rb ADDED

@@ -0,0 +1,21 @@
+module Drawer
+  class << self
+    def draw diffs
+      @diffs = diffs
+      erb_str  = File.read(Pathes.template_path)
+      result = ERB.new(erb_str, nil, '-').result(binding)
+      File.open(Pathes.summary_path.join('result.html'), 'w') do |f|
+        f.write(result)
+      end
+    end
+    def prettify(data)
+      return '-' if data.nil?
+      return JSON.pretty_generate(data) if data.is_a? Hash
+      data
+    end
+  end
+end

data/lib/rspec/flaky/dumper/db.rb ADDED

@@ -0,0 +1,25 @@
+require 'rails'
+module Dumper
+  class Db
+    def dump!(location, status)
+      path = dump_path(location)
+      FileUtils.mkdir_p(path) unless File.exists?(path)
+      #TODO adapter for mysql and sqlite3
+      #TODO username from config
+      system "pg_dump -U postgres -d #{db_name} > #{path}/#{status}.sql"
+    end
+    private
+    def db_name
+      Rails.configuration.database_configuration["test"]["database"]
+    end
+    def dump_path location
+      "tmp/flaky_tests/database_dumps/#{location}"
+    end
+  end
+end

data/lib/rspec/flaky/dumper/json.rb ADDED

@@ -0,0 +1,23 @@
+require 'json'
+require 'fileutils'
+module Dumper
+  class Json
+    def dump!(location, status, tables)
+      tables.each do |table|
+        json = JSON.pretty_generate(table.all.map(&:attributes))
+        FileUtils.mkdir_p(dump_path(location, table)) unless File.exists?(dump_path(location, table))
+        File.open("#{dump_path(location, table)}/#{status}.json", 'w') do |f|
+          f.write(json)
+        end
+      end
+    end
+    private
+    def dump_path location, table
+      "tmp/flaky_tests/#{location}/#{table}"
+    end
+  end
+end

data/lib/rspec/flaky/pathes.rb ADDED

@@ -0,0 +1,27 @@
+module Pathes
+  class << self
+    def template_path
+      assets_path.join("layout.html.erb")
+    end
+    def summary_path
+      base_path.join('tmp/flaky_tests')
+    end
+    def base_path
+      Pathname.new(FileUtils.pwd)
+    end
+    def relative_path path
+      path.relative_path_from(summary_path).to_s
+    end
+    def assets_path
+      Pathname.new(__dir__).join("../../../assets/")
+    end
+  end
+end

data/lib/rspec/flaky/tables.rb ADDED

@@ -0,0 +1,22 @@
+require 'rspec'
+require 'rspec/flaky/dumper/json'
+require 'rspec/flaky/dumper/db'
+RSpec.configure do |config|
+  if ENV["FLAKY_SPEC"] == "1"
+    config.before(:suite, table: true) do
+      config.after(:each, tables: true) do |example|
+        location = example.metadata[:location].gsub('/', ':')
+        status = example.exception.nil? ? 'passed' : 'failed'
+        tables = Array.wrap(example.metadata[:tables].select{|t| t < ApplicationRecord})
+        Dumper::Json.new.dump!(location, status, tables)
+        Dumper::Db.new.dump!(location, status)
+      end
+      config.before(:each, tables: true) do
+        DatabaseCleaner.strategy = :truncation
+      end
+    end
+  end
+end

data/lib/rspec/flaky/version.rb ADDED

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module RSpecFlaky
+  VERSION = '0.0.1'
+end

metadata ADDED

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rspec-flaky
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- maratz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: Gem wraps every runned example to dump pointed database tables to json
+  files
+email:
+- mzasorinwd@gmail.com
+executables:
+- rspec-flaky
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- assets/layout.html.erb
+- bin/rspec-flaky
+- lib/rspec/flaky.rb
+- lib/rspec/flaky/cli.rb
+- lib/rspec/flaky/differ.rb
+- lib/rspec/flaky/drawer.rb
+- lib/rspec/flaky/dumper/db.rb
+- lib/rspec/flaky/dumper/json.rb
+- lib/rspec/flaky/pathes.rb
+- lib/rspec/flaky/tables.rb
+- lib/rspec/flaky/version.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Gem for catching flaky specs
+test_files: []