specwrk 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29f7cb9c448edda0afc2ec56876818525e89a4a27fcacf14999124b299e43522
-  data.tar.gz: b47405dbb97ede3bd1d97766b21fd8ce4e35638664a779ea4723eca75b55b685
+  metadata.gz: 63eedb1506644bd71c457579fb2de19779c66c565b2c614284272152506648ca
+  data.tar.gz: eb5c83efcd7a9d76623867ec42d48a335e2f349c6608326abba643252a31e486
 SHA512:
-  metadata.gz: 68e6b8e27da121cfd0b74142528ce9cb238c721a75e55dabca9a58fe35b63364c2315a9a0a1a239f2906c386682ca7ef5e6d9b78535ac3cfb9ffc9b8ec141f73
-  data.tar.gz: 8b26d7d1def9ead69b0583786d54c03251edfe7944631a7f53cb882c655e798b8038bffdb97328ca1318d243079073824a5be5dbcb693f6d60bd0ceb25aa7164
+  metadata.gz: 8235b7ddcd7bbee6acc73ec3c53bf8bd9987d769babc42159248b514f326b381ad49a4247e12c649d21d700d158c7f1b83b1b5c93ff6200eb38f8e41b46f4df1
+  data.tar.gz: f98b5df6bb5a72bd515c5324c17c8c76daf1a08c876fc6d4ab8b7a9f9f6a6477248b34dc9a82c73f289f417a8026bd7b2cc6eb367c25948d17c5f0c5d918844d

data/.circleci/config.yml

@@ -83,6 +83,17 @@ jobs:
             - .specwrk/report.json
           key: specwrk-{{ .Branch }}
       ## /SPECWRK STEP ##
+  
+      - run: 
+          name: Echo the workers output for giggles
+          command: |
+            shopt -s nullglob
+            for file in /tmp/specwrk/main/*.ndjson; do
+              echo "===== $file ====="
+              cat "$file"
+              echo
+            done
+
         
   specwrk-multi-node-prepare:
     docker:
@@ -116,7 +127,6 @@ jobs:
               --key "$SPECWRK_KEY" \
               --run "$CIRCLE_WORKFLOW_ID" \
               spec/
-
       ## /SPECWRK STEP ##
 
   specwrk-multi-node:
@@ -154,3 +164,14 @@ jobs:
               --run "$CIRCLE_WORKFLOW_ID" \
               --count 2
       ## /SPECWRK STEP ##
+      
+      - run: 
+          name: Echo the workers output for giggles
+          command: |
+            shopt -s nullglob
+            for file in /tmp/specwrk/main/*.ndjson; do
+              echo "===== $file ====="
+              cat "$file"
+              echo
+            done
+

data/lib/specwrk/cli_reporter.rb

@@ -19,10 +19,25 @@ module Specwrk
       puts "\nFinished in #{Specwrk.human_readable_duration total_duration} " \
                           "(total execution time of #{Specwrk.human_readable_duration total_run_time})\n"
 
+      if flake_count.positive?
+        puts "\nFlaked examples:\n\n"
+        flake_reruns_lines.each { |(command, description)| print "#{colorizer.wrap(command, :magenta)} #{colorizer.wrap(description, :cyan)}\n" }
+        puts ""
+      end
+
       client.shutdown
 
       if failure_count.positive?
         puts colorizer.wrap(totals_line, :red)
+
+        puts "\nFailed examples:\n\n"
+        failure_reruns_lines.each { |(command, description)| print "#{colorizer.wrap(command, :red)} #{colorizer.wrap(description, :cyan)}\n" }
+        puts ""
+
+        1
+      elsif unexecuted_count.positive?
+        puts colorizer.wrap(totals_line, :red)
+
         1
       elsif pending_count.positive?
         puts colorizer.wrap(totals_line, :yellow)
@@ -44,11 +59,29 @@ module Specwrk
     def totals_line
       summary = RSpec::Core::Formatters::Helpers.pluralize(example_count, "example") +
         ", " + RSpec::Core::Formatters::Helpers.pluralize(failure_count, "failure")
-      summary += ", #{pending_count} pending" if pending_count > 0
+      summary += ", #{pending_count} pending" if pending_count.positive?
+      summary += ", #{RSpec::Core::Formatters::Helpers.pluralize(flake_count, "example")} flaked #{RSpec::Core::Formatters::Helpers.pluralize(total_flakes, "time")}" if flake_count.positive?
+      summary += ". #{RSpec::Core::Formatters::Helpers.pluralize(unexecuted_count, "example")} not executed" if unexecuted_count.positive?
 
       summary
     end
 
+    def failure_reruns_lines
+      @failure_reruns_lines ||= report_data.dig(:examples).values.map do |example|
+        next unless example[:status] == "failed"
+
+        ["rspec #{example[:file_path]}:#{example[:line_number]}", "# #{example[:full_description]}"]
+      end.compact
+    end
+
+    def flake_reruns_lines
+      @flake_reruns_lines ||= report_data.dig(:flakes).map do |example_id, count|
+        example = report_data.dig(:examples, example_id)
+
+        ["rspec #{example[:file_path]}:#{example[:line_number]}", "# #{example[:full_description]}. Failed #{RSpec::Core::Formatters::Helpers.pluralize(count, "time")} before passing."]
+      end.compact
+    end
+
     def report_data
       @report_data ||= client.report
     end
@@ -69,10 +102,22 @@ module Specwrk
       report_data.dig(:meta, :pending)
     end
 
+    def unexecuted_count
+      report_data.dig(:meta, :unexecuted)
+    end
+
     def example_count
       report_data.dig(:examples).length
     end
 
+    def flake_count
+      report_data.dig(:flakes).length
+    end
+
+    def total_flakes
+      @total_flakes ||= report_data.dig(:flakes).values.sum
+    end
+
     def client
       @client ||= Client.new
     end

data/lib/specwrk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Specwrk
-  VERSION = "0.14.1"
+  VERSION = "0.15.0"
 end

data/lib/specwrk/web/endpoints.rb

@@ -145,6 +145,7 @@ module Specwrk
 
         def with_response
           pending.clear
+          processing.clear
           failure_counts.clear
 
           pending.max_retries = payload.fetch(:max_retries, "0").to_i
@@ -331,15 +332,16 @@ module Specwrk
 
       class Report < Base
         def with_response
-          [200, {"content-type" => "application/json"}, [JSON.generate(completed.dump)]]
+          completed_dump = completed.dump
+          completed_dump[:meta][:unexecuted] = pending.length + processing.length
+          completed_dump[:flakes] = failure_counts.to_h.reject { |id, _count| completed_dump.dig(:examples, id, :status) == "failed" }
+
+          [200, {"content-type" => "application/json"}, [JSON.generate(completed_dump)]]
         end
       end
 
       class Shutdown < Base
         def with_response
-          pending.clear
-          processing.clear
-
           interupt! if ENV["SPECWRK_SRV_SINGLE_RUN"]
 
           [200, {"content-type" => "text/plain"}, ["✌️"]]

data/lib/specwrk/worker/completion_formatter.rb

@@ -13,7 +13,7 @@ module Specwrk
 
       def stop(group_notification)
         group_notification.notifications.map do |notification|
-          examples << {
+          hash = {
             id: notification.example.id,
             full_description: notification.example.full_description,
             status: notification.example.execution_result.status,
@@ -23,6 +23,16 @@ module Specwrk
             finished_at: notification.example.execution_result.finished_at.iso8601(6),
             run_time: notification.example.execution_result.run_time
           }
+
+          if (e = notification.example.exception)
+            hash[:exception] = {
+              class: e.class.name,
+              message: e.message,
+              backtrace: notification.formatted_backtrace
+            }
+          end
+
+          examples << hash
         end
       end
     end

data/lib/specwrk/worker/executor.rb

@@ -24,12 +24,13 @@ module Specwrk
 
         example_ids = examples.map { |example| example[:id] }
 
-        options = RSpec::Core::ConfigurationOptions.new rspec_options + example_ids
+        options = RSpec::Core::ConfigurationOptions.new ["--format", "Specwrk::Worker::NullFormatter"] + example_ids
         RSpec::Core::Runner.new(options).run($stderr, $stdout)
       end
 
       # https://github.com/skroutz/rspecq/blob/341383ce3ca25f42fad5483cbb6a00ba1c405570/lib/rspecq/worker.rb#L208-L224
       def reset!
+        flush_log
         completion_formatter.examples.clear
 
         RSpec.clear_examples
@@ -71,13 +72,25 @@ module Specwrk
         @completion_formatter ||= CompletionFormatter.new
       end
 
-      def rspec_options
-        @rspec_options ||= if ENV["SPECWRK_OUT"]
-          ["--format", "json", "--out", File.join(ENV["SPECWRK_OUT"], "#{ENV.fetch("SPECWRK_ID", "specwrk-worker")}.json")]
+      def flush_log
+        completion_formatter.examples.each { |example| json_log_file.puts example }
+      end
+
+      def json_log_file
+        @json_log_file ||= if json_log_file_path
+          FileUtils.mkdir_p(File.dirname(json_log_file_path))
+          File.truncate(json_log_file_path, 0) if File.exist?(json_log_file_path)
+          File.open(json_log_file_path, "a", sync: true)
         else
-          ["--format", "Specwrk::Worker::NullFormatter"]
+          File.open(File::NULL, "a")
         end
       end
+
+      def json_log_file_path
+        return unless ENV["SPECWRK_OUT"]
+
+        @json_log_file_path ||= File.join(ENV["SPECWRK_OUT"], ENV["SPECWRK_RUN"], "#{ENV["SPECWRK_FORKED"]}.ndjson")
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specwrk
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Daniel Westendorf