rfc 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2bd98f4ee027dedf465a06422cd238ddce586defb49eb2ca864c79975c88d5b
-  data.tar.gz: d8f3f0d13c12fb1f75778e9f4612b9cce2c07ea5c4481131658909f42586e619
+  metadata.gz: f978de1d87822212ecd4f4164491cd25c05e19fa7858c6e29d072d521bee1e76
+  data.tar.gz: b357da050dbabf49d475ac54b9fdc0ed8d8ad0aa96c2a17a279886e4ab63b011
 SHA512:
-  metadata.gz: 023c98057230d614c70be9ec22765afc4d04a2fc49908ebb7b0e53541a98db9d3e521a1cd58863b482bdaa0f4190cc286e695d7672ff632914338d8d39aae5ac
-  data.tar.gz: 1c862442efc54a7b507044824b0d8519e48c9c4a989b2fe8d056f66cbd0c8c93ce120128feeb7f88c29810ad8de74f1905527e2ca9d2f0dd02289d3e0a1ef039
+  metadata.gz: 614d52a87cb62de11bf3ba1188d59ac251816dba957bd4f285c01ac657c2460d513236310b701fd336dc3e0dd982f05d8926e39bc0e8d548ef368e6128c884ec
+  data.tar.gz: 8d9efb9c30bf2bb17d2c71fd61e4f6fe04b39e2e3cc2a20940c16c1d45fa72b1e05eacc98a93b58d5f2c753e450dde35bd3c56b49cca7740b84e47ea4cd2db74

data/README.md

@@ -2,9 +2,10 @@
 
 A collection of RSpec formatters.
 
-## RSpec Insta-Failing Formatter (Rif, Riff)
 
-RIFF was originally developed for running large test suites in a
+## RSpec Insta-Failing Formatter (`Rif`, `Riff`)
+
+This formatter was originally developed for running large test suites in a
 continuous integration environment, where the runs are non-interactive
 and the output is saved to a file/stream of some kind.
 It has the following features;
@@ -12,6 +13,23 @@ It has the following features;
 - Immediate error/failure reporting
 - Timestamped percentage progress output
 - No output overwrites or terminal manipulation
+- Optionally reports system statistics
+
+To assist in diagnosing test failures caused by resource exhaustion,
+`Rif` can output the following additional statistics:
+
+- Ruby object space stats: number of objects total and free
+- System memory stats: memory and swap used, free and total
+- CPU stats: average CPU load during test suite execution
+
+To enable object space stastistics reporting, add to your `spec_helper.rb`:
+
+    Rfc::Rif.output_object_space_stats = true
+
+To enable memory and CPU statistics reporting, add to your `spec_helper.rb`:
+
+    Rfc::Rif.output_system_load = true
+
 
 ## Announce Formatter (Announce)
 
@@ -23,11 +41,13 @@ by global test setup code as well as a specific test, or by multiple tests.
 This formatter reports failures at the end of the test run, like
 RSpec's documentation formatter does.
 
+
 ## Announce Insta-Failing Formatter (Aif, AIF)
 
 This is the announce formatter with insta-fail feature. It reports
 failures as soon as they happen, after each example is executed.
 
+
 ## License
 
 MIT

data/lib/rfc/cpu_time_averager.rb

@@ -0,0 +1,50 @@
+module Rfc
+  class CpuTimeAverager
+    Sample = Struct.new(
+      :user, :nice, :system, :idle, :iowait, :irq, :softirq, :steal,
+      :guest, :guest_nice,
+    )
+
+    def initialize
+      @samples = []
+    end
+
+    def sample
+      # https://www.linuxhowtos.org/manpages/5/proc.htm
+      IO.readlines('/proc/stat').each do |line|
+        if line =~ /^cpu/
+          _, user, nice, system, idle, iowait, irq, softirq, steal,
+            guest, guest_nice = line.split.map(&:to_i)
+          @samples << [Time.now, Sample.new(
+            user, nice, system, idle, iowait, irq, softirq, steal,
+            guest, guest_nice,
+          )]
+          break
+        end
+      end
+
+      threshold = Time.now - 10
+      while @samples.length > 2 && @samples.first.first < threshold
+        @samples.shift
+      end
+    end
+
+    def enough?
+      @samples.last.first - @samples.first.first >= 2
+    end
+
+    def first
+      @samples.first
+    end
+
+    def last
+      @samples.last
+    end
+
+    %i(user nice system idle iowait irq softirq steal guest guest_nice).each do |attr|
+      define_method("#{attr}_delta") do
+        last.last.send(attr) - first.last.send(attr)
+      end
+    end
+  end
+end

data/lib/rfc/rif.rb

@@ -1,4 +1,5 @@
 require 'rspec/core'
+require 'rfc/cpu_time_averager'
 RSpec::Support.require_rspec_core "formatters/base_text_formatter"
 
 module Rfc
@@ -15,6 +16,8 @@ class Rif < RSpec::Core::Formatters::BaseTextFormatter
     # ObjectSpace statistics are generally not available on JRuby:
     # RuntimeError (ObjectSpace is disabled; each_object will only work with Class, pass -X+O to enable)
     attr_accessor :output_object_space_stats
+
+    attr_accessor :output_system_load
   end
   self.heartbeat_interval = 10
 
@@ -53,6 +56,12 @@ class Rif < RSpec::Core::Formatters::BaseTextFormatter
   end
 
   def report_progress
+    if total_count == 0
+      # When a test suite has no examples or they are all filtered out,
+      # there is no meaningful progress to report.
+      return
+    end
+
     this_percent = @completed_count * 100 / total_count
     if @reported_percent != this_percent || @reported_at.nil? ||
       Time.now-@reported_at > self.class.heartbeat_interval
@@ -69,6 +78,9 @@ class Rif < RSpec::Core::Formatters::BaseTextFormatter
       if self.class.output_object_space_stats
         progress_msg += "; objects: #{ObjectSpace.count_objects[:TOTAL]} total, #{ObjectSpace.count_objects[:FREE]} free"
       end
+      if self.class.output_system_load
+        progress_msg += "\n#{system_load_msg}"
+      end
       output.puts progress_msg
       @reported_percent = this_percent
       @reported_at = Time.now
@@ -77,5 +89,57 @@ class Rif < RSpec::Core::Formatters::BaseTextFormatter
 
   def dump_failures(notification)
   end
+
+  private
+
+  def system_load_msg
+    stats = {}
+    IO.readlines('/proc/meminfo').each do |line|
+      measure, value, unit = line.split
+      value = value.to_i
+      if value != 0
+        if unit != 'kB'
+          return "Unexpected unit: #{unit} for #{line}"
+        end
+        value = value * 1024
+        measure.sub!(/:$/, '')
+        stats[measure] = value
+      end
+    end
+
+    mem_used = stats['MemTotal'] - stats['MemFree'] - stats['Buffers'] - stats['Cached']
+    swap_used = stats['SwapTotal'] - stats['SwapFree']
+    buf_used = stats['Buffers'] + stats['Cached']
+    total = stats['MemTotal']
+    swap = stats['SwapTotal']
+    avail = stats['MemFree'] + stats['Buffers'] + stats['Cached']
+
+    msg = "Memory: #{m(mem_used)} RAM + #{m(swap_used)} swap used, #{m(buf_used)} buf, #{m(total)} RAM + #{m(swap)} swap total, #{m(avail)} avail"
+
+    @cpu_time_averager ||= CpuTimeAverager.new
+    @cpu_time_averager.sample
+    if @cpu_time_averager.enough?
+      all = @cpu_time_averager.user_delta +
+        @cpu_time_averager.nice_delta +
+        @cpu_time_averager.system_delta +
+        @cpu_time_averager.irq_delta +
+        @cpu_time_averager.iowait_delta +
+        @cpu_time_averager.idle_delta
+      used = ((@cpu_time_averager.user_delta +
+        @cpu_time_averager.nice_delta +
+        @cpu_time_averager.system_delta +
+        @cpu_time_averager.irq_delta) * 100.0 / all).round
+      idle = (@cpu_time_averager.idle_delta * 100 / all).round
+      iowait = (@cpu_time_averager.iowait_delta * 100 / all).round
+
+      msg += "\nCPU: %2d%% used, %2d%% iowait, %2d%% idle" % [used, iowait, idle]
+    end
+
+    msg
+  end
+
+  def m(value)
+    "#{(value / 1024.0 / 1024).round}M"
+  end
 end
 end

data/lib/rfc/version.rb

@@ -1,3 +1,3 @@
 module Rfc
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfc
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Oleg Pudeyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2020-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -35,6 +35,7 @@ files:
 - lib/rfc.rb
 - lib/rfc/aif.rb
 - lib/rfc/announce.rb
+- lib/rfc/cpu_time_averager.rb
 - lib/rfc/rif.rb
 - lib/rfc/riff.rb
 - lib/rfc/version.rb
@@ -61,5 +62,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: rfc-0.0.7
+summary: rfc-0.1.0
 test_files: []