rspec_log_formatter 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGJmODJlZTJkMzNjOGY5OWRjNDRjNmIxYzUyMTM0ZWEyY2MxN2U0Ng==
+    NDA1NzQxMjZmZjU0ZWU3ZjkzZTRmMzIzNTYzM2Q1NTRiZTJiYTVkOA==
   data.tar.gz: !binary |-
-    YzQ3MDllYzM1MmQ5NmJjNzJkYmVlMjE0ZjkxY2U1ZmFiZjg1ZDYxMw==
+    NjhiY2JiNzgyMGEyZGFlOTIyZjk4NTZjZmU5NzFkODA3NjBlNGIwOQ==
 SHA512:
   metadata.gz: !binary |-
-    MzBjMWQ3NGZjMzZmODM1M2VhY2ZmYjA3MGE0NjQzYTg5Zjg1YjEwNTA3YjIy
-    ZDhmMDZlNDBmYTc5Y2ZjZjc1Njg3MjMwYzQ1ZjRlNmJhOTFmZTI5NzQwZDlj
-    MDA0OGQ5ODJjNmQxZWU1NDZlOTJkM2Q4NTU2YzFlNGJiMmQ0ZGQ=
+    NDE3M2RlZGExODYyNjc2ZGZmOGE4YjgxYzMxZDYzYTRlZWQwMGNjOGNiZGY5
+    MTlmOGIzYjE5ZDUyMWU0MjFjMjBhNjlkZjc0M2IzNzk3MWQ1MWVlYWQ0NTM0
+    ZmI3YzRlNjlhODcwZmZjYTQ2NGQxODU5ZTZhOWY2YWNiNjIwYjU=
   data.tar.gz: !binary |-
-    Mzc5NWQ5MzEyZmFiMDE0ODZjODEyZTkxYWQ4MWQ3ZDRjYmUzNDI5ODY3YjVm
-    NTY2ZTg1ZjJkZWY1YjczMGQyMWE3OTE4M2Q4YjJjMDA4YTdjNTM0Nzg3YjRk
-    MjdhMjgzZjM4Y2JkY2MwNjE2OWFiYzQwNWIwM2M2YzAyNjE4MTQ=
+    YTEwMTFlYzFjMTllODQ0NmQxZDU4Mjc1MDI4NzBhOTc2NGU4OWM1NDBhZmNk
+    YTNiYmY0MmYzZjdlMjMyYjc5YTgxNGE1YTk0YWZjOThiOTBmZDJlNmRkYjk1
+    ZTQ0NDEwNjNiZmU2OGRlZjY4MDNhMGYxMjAxNzU2ZmVhZjliNTY=

data/lib/rspec_log_formatter/analysis/analyzer.rb

@@ -6,14 +6,7 @@ module RspecLogFormatter
       def analyze(filepath, options = {})
         window = options[:last_builds]
 
-        build_numbers = []
-        results = File.open(filepath).each_line.map do |line|
-          result = Result.new(*CSV.parse_line(line, col_sep: "\t").first(7))
-          build_numbers << result.build_number
-          result
-        end
-        build_numbers.uniq!.sort!
-
+        build_numbers, results = result_numbers(filepath, options = {})
 
         scores = []
         results.group_by(&:description).each do |description, results|
@@ -33,6 +26,48 @@ module RspecLogFormatter
 
         scores.sort.map(&:as_hash)
       end
+
+      def truncate(filepath, opts = {})
+        builds = opts.fetch(:keep_builds)
+        build_numbers, results = result_numbers(filepath, options = {})
+        sio = StringIO.new
+
+        File.open(filepath, 'r').each_line do |line|
+          result = parse_line(line)
+          next unless build_numbers.last(builds).include? result.build_number
+          sio.puts line
+        end
+
+        sio.rewind
+        File.open(filepath, 'w') do |f|
+          f.write sio.read
+        end
+      end
+
+      private
+
+      def parse_line(line)
+        Result.new(*CSV.parse_line(line, col_sep: "\t").first(7))
+      end
+
+      def each_result(filepath, &block)
+        File.open(filepath, 'r').each_line do |line|
+          result = parse_line(line)
+          block.call(result)
+        end
+      end
+
+      def result_numbers(filepath, options = {})
+        build_numbers = []
+        results = []
+        each_result(filepath) do |result|
+          build_numbers << result.build_number
+          results << result
+        end
+        [build_numbers.uniq.sort, results]
+      end
+
     end
+
   end
 end

data/lib/rspec_log_formatter/analysis/pretty_printer.rb

@@ -6,8 +6,15 @@ module RspecLogFormatter
       end
 
       def to_s
-        results = @results.first(10)
-        header = "Top #{results.count} flakiest examples\n"
+        results = @results.reject do |result|
+          result[:percent] == 0.0
+        end.first(10)
+
+        header = if results.empty?
+           "None of the specs were flaky"
+         else
+           "Top #{results.size} flakiest examples\n"
+         end
         header + results.each_with_index.map do |result, i|
           title = "  #{i+1}) #{result[:description]} -- #{result[:percent]}%"
           failure_messages = result[:failure_messages].map { |fm| "    * #{fm}" }.join("\n")

data/lib/rspec_log_formatter/analyzer_formatter.rb

@@ -0,0 +1,20 @@
+require "csv"
+require "rspec/core/formatters/base_formatter"
+
+module RspecLogFormatter
+  class AnalyzerFormatter < RSpec::Core::Formatters::BaseFormatter
+    FILENAME = "rspec.history"
+
+    def initialize(*args)
+      super
+    end
+
+
+    def dump_summary(_,_,_,_)
+      output.puts RspecLogFormatter::Analysis::PrettyPrinter.new(
+        RspecLogFormatter::Analysis::Analyzer.new.analyze(FILENAME)
+      )
+    end
+
+  end
+end

data/lib/rspec_log_formatter/formatter.rb

@@ -5,23 +5,17 @@ module RspecLogFormatter
   class Formatter < RSpec::Core::Formatters::BaseFormatter
     FILENAME = "rspec.history"
 
-    class Config
-      def clock=(clock)
-        @clock = clock
+    class Maker
+      def new(_output)
+        RspecLogFormatter::Formatter.new(clock, opts)
       end
-      def clock
-        @clock ||= Time
-        @clock
-      end
-    end
-    CONFIG = Config.new
-
-    def initialize(*args)
-      super
     end
+    Factory = Maker.new
 
-    def self.analyze(filepath)
-      Analysis::Analyzer.new.analyze(filepath)
+    def initialize(clock=nil, opts={})
+      @clock = clock || Time
+      @build_number = opts[:build_number] || ENV["BUILD_NUMBER"]
+      @keep_builds = opts[:keep_builds]
     end
 
     def example_started(example)
@@ -36,11 +30,14 @@ module RspecLogFormatter
       record("failed", example, clock.now, clock.now - @clock_start, example.exception)
     end
 
+    def dump_summary(_,_,_,_)
+      return unless @keep_builds
+      RspecLogFormatter::Analysis::Analyzer.new.truncate(FILENAME, keep_builds: @keep_builds)
+    end
+
     private
 
-    def clock
-      CONFIG.clock
-    end
+    attr_reader :clock
 
     def record(outcome, example, time, duration, exception=nil)
       if exception
@@ -53,7 +50,7 @@ module RspecLogFormatter
       end
 
       example_data = [
-        ENV["BUILD_NUMBER"],
+        @build_number,
         time,
         outcome,
         example.full_description.to_s.gsub(/\r|\n|\t/, " "),

data/lib/rspec_log_formatter/version.rb

@@ -1,3 +1,3 @@
 module RspecLogFormatter
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/lib/rspec_log_analyzer/analysis/analyzer_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require 'tempfile'
 
 describe RspecLogFormatter::Analysis::Analyzer do
   it "sorts the parsed results by failure percentage" do
@@ -24,6 +25,19 @@ describe RspecLogFormatter::Analysis::Analyzer do
     }
   end
 
+
+  it "can truncate the log file" do
+    filepath = File.expand_path("../../../../fixtures/test_was_flaky_then_fixed.history", __FILE__)
+    temp = Tempfile.new('fixture')
+    FileUtils.copy(filepath, temp.path)
+    described_class.new.truncate(temp.path, keep_builds: 3)
+    File.open(temp.path, 'r').read.should == <<HEREDOC
+5	2014-01-21 16:08:25 -0800	passed	desc	./spec/m1k1_spec.rb
+6	2014-01-21 16:08:25 -0800	passed	desc	./spec/m1k1_spec.rb
+7	2014-01-21 16:08:25 -0800	passed	desc	./spec/m1k1_spec.rb
+HEREDOC
+  end
+
   it "can analyze only a window of builds" do
     filepath = File.expand_path("../../../../fixtures/test_was_flaky_then_fixed.history", __FILE__)
     subject.analyze(filepath, last_builds: 7).first.should == {

data/spec/lib/rspec_log_analyzer/analysis/pretty_printer_spec.rb

@@ -24,7 +24,7 @@ Top 2 flakiest examples
 
   context "when there are more than 10 results" do
     it "only prints the top 10" do
-      results = (1..20).map do |i|
+      results = (1..11).map do |i|
         {description: "hi#{i}", percent: 1, failure_messages: ["bye#{i}"]}
       end
 
@@ -53,4 +53,39 @@ Top 10 flakiest examples
       TEXT
     end
   end
+
+  it "only prints flaky specs" do
+    results = (1..7).map do |i|
+      {description: "hi#{i}", percent: 1, failure_messages: ["bye#{i}"]}
+    end + (8..10).map do |i|
+      {description: "hi#{i}", percent: 0.0, failure_messages: ["bye#{i}"]}
+
+    end
+
+    described_class.new(results).to_s.should == <<-TEXT.strip
+  Top 7 flakiest examples
+  1) hi1 -- 1%
+    * bye1
+  2) hi2 -- 1%
+    * bye2
+  3) hi3 -- 1%
+    * bye3
+  4) hi4 -- 1%
+    * bye4
+  5) hi5 -- 1%
+    * bye5
+  6) hi6 -- 1%
+    * bye6
+  7) hi7 -- 1%
+    * bye7
+    TEXT
+  end
+
+  it "only prints flaky specs" do
+    results = (1..11).map do |i|
+      {description: "hi#{i}", percent: 0, failure_messages: ["bye#{i}"]}
+    end
+
+    described_class.new(results).to_s.should == "None of the specs were flaky"
+  end
 end

data/spec/lib/rspec_log_analyzer/analyzer_formatter_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe RspecLogFormatter::Formatter do
+
+
+  it "works" do
+    filepath = File.expand_path("../../../fixtures/varying_flakiness.history", __FILE__)
+    FileUtils.cp(filepath, 'rspec.history')
+    out = StringIO.new
+    formatter = RspecLogFormatter::AnalyzerFormatter.new(out)
+    formatter.dump_summary(1,2,3,4)
+    out.rewind
+    out.read.should == <<HEREDOC
+Top 3 flakiest examples
+  1) desc3 -- 75.0%
+    * ec10
+      msg10
+    * ec10
+      msg10
+    * ec10
+      msg10
+  2) desc2 -- 66.66666666666667%
+    * ec10
+      msg10
+    * ec10
+      msg10
+  3) desc1 -- 50.0%
+    * ec10
+      msg10
+HEREDOC
+  end
+end

data/spec/lib/rspec_log_analyzer/formatter_spec.rb

@@ -10,25 +10,65 @@ describe RspecLogFormatter::Formatter do
     }.merge(opts))
   end
 
+  def formatter_for_build(build)
+    RspecLogFormatter::Formatter.new(double(now: Time.at(0)), keep_builds: 2, build_number: build)
+  end
+
+  it "can truncate the log file" do
+    the_example = make_example
+    formatter = formatter_for_build(1)
+    formatter.example_started(the_example)
+    formatter.example_passed(the_example)
+    formatter.dump_summary(1,2,3,4)
+
+    formatter = formatter_for_build(2)
+    formatter.example_started(the_example)
+    formatter.example_passed(the_example)
+    formatter.dump_summary(1,2,3,4)
+
+    File.open(RspecLogFormatter::Formatter::FILENAME, 'r').read.should == <<HEREDOC
+1	1969-12-31 16:00:00 -0800	passed	description_1	path_1			0.0
+2	1969-12-31 16:00:00 -0800	passed	description_1	path_1			0.0
+HEREDOC
+
+    formatter = formatter_for_build(3)
+    formatter.example_started(the_example)
+    formatter.example_passed(the_example)
+    formatter.dump_summary(1,2,3,4)
+
+    formatter = formatter_for_build(4)
+    formatter.example_started(the_example)
+    formatter.example_passed(the_example)
+    formatter.dump_summary(1,2,3,4)
+
+    File.open(RspecLogFormatter::Formatter::FILENAME, 'r').read.should == <<HEREDOC
+3	1969-12-31 16:00:00 -0800	passed	description_1	path_1			0.0
+4	1969-12-31 16:00:00 -0800	passed	description_1	path_1			0.0
+HEREDOC
+  end
+
+  class FakeClock
+    def initialize(now)
+      self.now = now
+    end
+    attr_accessor :now
+  end
+
   it "works" do
     failed_example = make_example(exception: Exception.new("Error"))
     passed_example = make_example(exception: nil)
     time = Time.parse("2014-02-06 16:01:10")
-    clock = double(now: time)
-    RspecLogFormatter::Formatter::CONFIG.clock = clock
-
-    formatter = RspecLogFormatter::Formatter.new(StringIO.new)
+    clock = FakeClock.new(time)
+    formatter = RspecLogFormatter::Formatter.new(clock)
     formatter.example_started(failed_example)
-    #clock.stub(now: time + 5)
-    RspecLogFormatter::Formatter::CONFIG.clock = double(now: time + 5)
+    clock.now = time + 5
     formatter.example_failed(failed_example)
 
     formatter.example_started(passed_example)
-    #clock.stub(:now, time + 8)
-    RspecLogFormatter::Formatter::CONFIG.clock = double(now: time + 8)
+    clock.now = time + 8
     formatter.example_passed(passed_example)
     formatter.dump_summary(1,2,3,4)
-    File.open('rspec.history').readlines.should == [
+    File.open('rspec.history'). readlines.should == [
       "\t2014-02-06 16:01:15 -0800\tfailed\tdescription_1\tpath_1\tError\tException\t5.0\n",
       "\t2014-02-06 16:01:18 -0800\tpassed\tdescription_2\tpath_2\t\t\t3.0\n",
     ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_log_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Serguei Filimonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - lib/rspec_log_formatter/analysis/pretty_printer.rb
 - lib/rspec_log_formatter/analysis/result.rb
 - lib/rspec_log_formatter/analysis/score.rb
+- lib/rspec_log_formatter/analyzer_formatter.rb
 - lib/rspec_log_formatter/formatter.rb
 - lib/rspec_log_formatter/version.rb
 - rspec_log_formatter.gemspec
@@ -93,6 +94,7 @@ files:
 - spec/fixtures/varying_flakiness.history
 - spec/lib/rspec_log_analyzer/analysis/analyzer_spec.rb
 - spec/lib/rspec_log_analyzer/analysis/pretty_printer_spec.rb
+- spec/lib/rspec_log_analyzer/analyzer_formatter_spec.rb
 - spec/lib/rspec_log_analyzer/formatter_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -125,5 +127,6 @@ test_files:
 - spec/fixtures/varying_flakiness.history
 - spec/lib/rspec_log_analyzer/analysis/analyzer_spec.rb
 - spec/lib/rspec_log_analyzer/analysis/pretty_printer_spec.rb
+- spec/lib/rspec_log_analyzer/analyzer_formatter_spec.rb
 - spec/lib/rspec_log_analyzer/formatter_spec.rb
 - spec/spec_helper.rb