flaky_stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f46e85bcc221c806457d3f481f5ffa56c893cd2
+  data.tar.gz: 823883da6f051e786ec1f894a37fb3a9e91641d9
+SHA512:
+  metadata.gz: 31002d561575e96e7d9d024f10855b04b50ff0003219883976969d04a2de48b4e6a6430fdde2327f8ea53434cf931c44aeed5279e5806dcedb032369b96da826
+  data.tar.gz: 05c5ee0c41c6c4a070b07e4258d4fdb6d7cdcf0ddc1b7823c60295407689de0804745e08b64309de0b4d47d6ee54634f2a0d0d4cad2b10cf3a0c6ded0c1ec1d5

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flaky_stats.gemspec
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+# FlakyStats
+
+Collects broken tests from a parallel failing test log, uses them to rerun the flaky tests and if they pass whilst running them on their own add them to the flaky_stats.log file.
+
+At the end of the tests we can display a flaky stats summary which should display the top flaky tests in order of the most flakiest.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flaky_stats'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flaky_stats
+
+## Usage
+
+    $ rake parallel:rerun
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/map7/flaky_stats.
+
+## Ref
+
+http://blog.nathanhumbert.com/2010/02/rails-3-loading-rake-tasks-from-gem.html
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flaky_stats"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flaky_stats.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flaky_stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flaky_stats"
+  spec.version       = FlakyStats::VERSION
+  spec.authors       = ["Michael Pope"]
+  spec.email         = ["michael@dtcorp.com.au"]
+
+  spec.summary       = %q{Records flaky tests}
+  spec.description   = %q{Flaky stats will rerun broken tests from your parallel tests and if they pass then they must be flaky so it records them.}
+  spec.homepage      = "http://github.com/map7/flaky_stats"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", "= 0.8.1"
+end

data/lib/flaky_stats/flaky_tests.rb

@@ -0,0 +1,37 @@
+module FlakyStats
+  class FlakyTests
+
+    def initialize(options = {})
+      @logfile = options[:logfile]
+    end
+
+    def form_data(failed_file = {})
+      return [Time.now,failed_file[:filename],failed_file[:lineno],1].join ","
+    end
+
+    # Run each failing test singularly and return a list of flaky tests.
+    def run(failed_files)
+      real_flaky_tests = []
+
+      puts "\n\n"
+      puts "-------------------------------------------------------------------"
+      puts "Rerunning failing tests in single thread"
+      puts "-------------------------------------------------------------------"
+      
+      # sleep 10                   # Settle everything down.
+
+      # Run all failing tests separately with '--format doc' on the end.
+      failed_files.each do |failed_file|
+        # sleep 2                   # Settle everything down.
+        status = system("rspec --format doc #{failed_file[:filename]}")
+
+        # This is a flaky test only, so record it
+        if status == true
+          real_flaky_tests << form_data(failed_file)
+        end
+      end
+
+      return real_flaky_tests
+    end
+  end  
+end

data/lib/flaky_stats/logfile.rb

@@ -0,0 +1,46 @@
+# Logfile
+#
+# Deals with reading failing logs, remove old log files and
+# logging the flaky stats
+
+module FlakyStats
+  class LogFile
+    def initialize(options = {})
+      @failing_log = options[:failing_log]
+      @logfile = options[:logfile]
+    end
+
+    def get_error_info(line)
+      information= line.partition(/\.\/.*.rb/)
+      filename = information[1]
+      lineno = information[2].partition(/:/)[2].to_i
+      return {filename: filename, lineno: lineno}
+    end
+    
+    # Read the failing log from our test stack
+    def read_failing_log()
+      failed_files = []
+
+      # Read in the file
+      file = File.readlines(@failing_log)
+
+      # Get lines which begin with rspec
+      file.each do |line|
+        if line =~ /rspec \.\//
+          # Get the file name only
+          failed_files << get_error_info(line)
+        end
+      end
+
+      return failed_files
+    end
+
+    # Log flaky stats
+    def write_flaky_stats(real_flaky_tests)
+      File.open(@logfile, "a") do |log|
+        real_flaky_tests.each {|data| log.puts data}
+      end
+    end
+    
+  end
+end

data/lib/flaky_stats/railtie.rb

@@ -0,0 +1,11 @@
+require 'flaky_stats'
+require 'rails'
+module FlakyStats
+  class Railtie < Rails::Railtie
+    railtie_name :flaky_stats
+
+    rake_tasks do
+      load "tasks/flaky_stats.rake"
+    end
+  end
+end

data/lib/flaky_stats/summary.rb

@@ -0,0 +1,41 @@
+# Summary
+#
+# Calculate and display summary information for errors and flaky stats
+
+module FlakyStats
+  class Summary
+    def initialize(options)
+      @failing_log = options[:failing_log]
+      @logfile = options[:logfile]
+    end
+
+    def display_error_summary()
+      puts "\n\n"
+      puts "-------------------------------------------------------------------"
+      puts "Errors summary"
+      puts "-------------------------------------------------------------------"
+
+      system("cat #{@failing_log}")
+    end
+
+    def calc_flaky_summary
+      sum=Hash.new(0)
+      CSV.foreach(@logfile) do |row|
+        sum[row[1]]+=row[3].to_i
+      end
+      return sum
+    end
+
+    def display_flaky_summary
+      puts "\n\n"
+      puts "-------------------------------------------------------------------"
+      puts "Flaky summary"
+      puts "-------------------------------------------------------------------"
+
+      calc_flaky_summary.each do |k,v|
+        puts "#{k} = #{v}" if v > 1
+      end
+      puts "\n"
+    end
+  end
+end

data/lib/flaky_stats/version.rb

@@ -0,0 +1,3 @@
+module FlakyStats
+  VERSION = "0.1.0"
+end

data/lib/flaky_stats.rb

@@ -0,0 +1,8 @@
+require "flaky_stats/version"
+require "flaky_stats/summary"
+require "flaky_stats/logfile"
+require "flaky_stats/flaky_tests"
+
+module FlakyStats
+  require 'flaky_stats/railtie' if defined?(Rails)
+end

data/lib/tasks/flaky_stats.rake

@@ -0,0 +1,26 @@
+require 'csv'
+
+LOGFILE=Rails.root + "log/flaky_tests.log"
+FAILING_LOG=Rails.root + "tmp/failing_specs.log"
+
+desc "Rerun failing parallel tests in a single thread"
+task :flaky_stats => :environment do  |t|
+  if File.exist?(FAILING_LOG)
+
+    # Read failing log
+    logfile = FlakyStats::LogFile.new(failing_log: FAILING_LOG, logfile: LOGFILE)
+    failed_files = logfile.read_failing_log()
+
+    # Run tests singularly
+    flaky_tests = FlakyStats::FlakyTests.new(logfile: LOGFILE)
+    real_flaky_tests = flaky_tests.run(failed_files)
+
+    # Write out the log file of real flaky tests
+    logfile.write_flaky_stats(real_flaky_tests)
+    
+    # Display summaries
+    summary = FlakyStats::Summary.new(failing_log: FAILING_LOG, logfile: LOGFILE)
+    summary.display_error_summary()
+    summary.display_flaky_summary()
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: flaky_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Pope
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: Flaky stats will rerun broken tests from your parallel tests and if they
+  pass then they must be flaky so it records them.
+email:
+- michael@dtcorp.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flaky_stats.gemspec
+- lib/flaky_stats.rb
+- lib/flaky_stats/flaky_tests.rb
+- lib/flaky_stats/logfile.rb
+- lib/flaky_stats/railtie.rb
+- lib/flaky_stats/summary.rb
+- lib/flaky_stats/version.rb
+- lib/tasks/flaky_stats.rake
+homepage: http://github.com/map7/flaky_stats
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Records flaky tests
+test_files: []