specwrk 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 331e0982599a516c3c862c4a5c33a825c71256f5f95e6d1656c0ad410541df06
-  data.tar.gz: c7d93bf3add6e6de08cad22f8036ef89b01752b0e6dfe42615035d9e301ecff5
+  metadata.gz: dac5590f1e1c0603205328a69256a082c3ba1ff7ccf3ecd3937103d006706cb8
+  data.tar.gz: d53d623560f4c52a56e57d4d166597e40079bea76ea231d087930db588b7c401
 SHA512:
-  metadata.gz: 9daa901f8a7b7f453079f766d09e47fb621cf85e1cdb6111303e1f8b17cc3091312b2128ca141328f1c8a28216151b991f431cbb4550445ce137349dcb30f3c5
-  data.tar.gz: f0ae841735759d62e9ad6607065ca7bc8747a9d85e8906dea19019af7c63183df26b82cce51bc2a8c453cf4e1bb7d3d0b0c900c917cf689730cdac6028efaae5
+  metadata.gz: 7ecd6b6c0c37e6d17603f63b83e9f4cbfab076db34e67fc3fa433ef06ca66899b273d1858a7667b5946cc4b97ec58ac3e3c7eeea316687cde6fa3a824632e295
+  data.tar.gz: b963354e642948b1939009b8a0c54b126fc5d819b3cd07b14eb8822b0282317ce82dd432c7dcd5e28e5ed212aaf8e18a1a9bf048bb30ed9bd187a60da0d9d04d

data/docker/Dockerfile.server

@@ -1,11 +1,6 @@
 FROM ruby:3.4-alpine
 
-RUN apk add --no-cache \
-      build-base \
-      ruby-dev \
-      linux-headers \
-      zlib-dev \
-      libffi-dev
+RUN apk add --no-cache build-base 
 
 WORKDIR /app
 
@@ -13,14 +8,15 @@ RUN mkdir .specwrk/
 
 ARG SPECWRK_SRV_PORT=5138
 ARG SPECWRK_VERSION=latest
-ARG GEMFILE=specwrk-$SPECWRK_VERSION.gem
+ARG GEM_FILE=specwrk-$SPECWRK_VERSION.gem
 
-COPY $GEMFILE ./
-RUN gem install ./$GEMFILE --no-document
-RUN rm ./$GEMFILE
+COPY $GEM_FILE ./
+RUN gem install ./$GEM_FILE --no-document
+RUN rm ./$GEM_FILE
 
-RUN gem install puma thruster
+RUN gem install pitchfork thruster
 COPY config.ru ./
+COPY docker/pitchfork.conf ./
 
 COPY docker/entrypoint.server.sh /usr/local/bin/entrypoint
 RUN chmod +x /usr/local/bin/entrypoint

data/docker/entrypoint.server.sh

@@ -2,6 +2,6 @@
 
 export THRUSTER_HTTP_PORT=${PORT:-5138}
 export THRUSTER_TARGET_PORT=3000
-export THRUSTER_HTTP_IDLE_TIMEOUT=${IDLE_TIMEOUT:-305}
+export THRUSTER_HTTP_IDLE_TIMEOUT=${IDLE_TIMEOUT:-300}
 
-exec thrust puma --workers 0 --bind tcp://127.0.0.1:3000 --threads ${PUMA_THREADS:-1}
+exec thrust pitchfork -c pitchfork.conf

data/docker/pitchfork.conf

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+worker_processes 1
+listen "localhost:3000", backlog: 2048
+timeout 301

data/lib/specwrk/cli_reporter.rb

@@ -11,7 +11,10 @@ require "rspec/core/formatters/console_codes"
 module Specwrk
   class CLIReporter
     def report
-      return 1 unless Client.connect?
+      unless Client.connect?
+        puts colorizer.wrap("\nCannot connect to server to generate report. Assuming failure.", :red)
+        return 1
+      end
 
       puts "\nFinished in #{total_duration} " \
                           "(total execution time of #{total_run_time})\n"
@@ -28,8 +31,11 @@ module Specwrk
         puts colorizer.wrap(totals_line, :green)
         0
       end
-    rescue Specwrk::UnhandledResponseError
-      puts colorizer.wrap("No examples run.", :red)
+    rescue Specwrk::UnhandledResponseError => e
+      puts colorizer.wrap("\nCannot report, #{e.message}.", :red)
+
+      client.shutdown
+
       1
     end
 
@@ -43,28 +49,28 @@ module Specwrk
       summary
     end
 
-    def stats
-      @stats ||= client.stats
+    def report_data
+      @report_data ||= client.report
     end
 
     def total_duration
-      Time.parse(stats.dig(:completed, :meta, :last_finished_at)) - Time.parse(stats.dig(:completed, :meta, :first_started_at))
+      Time.parse(report_data.dig(:meta, :last_finished_at)) - Time.parse(report_data.dig(:meta, :first_started_at))
     end
 
     def total_run_time
-      stats.dig(:completed, :meta, :total_run_time)
+      report_data.dig(:meta, :total_run_time)
     end
 
     def failure_count
-      stats.dig(:completed, :meta, :failures)
+      report_data.dig(:meta, :failures)
     end
 
     def pending_count
-      stats.dig(:completed, :meta, :pending)
+      report_data.dig(:meta, :pending)
     end
 
     def example_count
-      stats.dig(:completed, :examples).length
+      report_data.dig(:examples).length
     end
 
     def client

data/lib/specwrk/client.rb

@@ -62,8 +62,8 @@ module Specwrk
       response.code == "200"
     end
 
-    def stats
-      response = get "/stats"
+    def report
+      response = get "/report"
 
       if response.code == "200"
         JSON.parse(response.body, symbolize_names: true)

data/lib/specwrk/queue.rb

@@ -6,7 +6,11 @@ require "json"
 module Specwrk
   # Thread-safe Hash access
   class Queue
+    attr_reader :created_at
+
     def initialize(hash = {})
+      @created_at = Time.now
+
       if block_given?
         @mutex = Monitor.new # Reentrant locking is required here
         # It's possible to enter the proc from two threads, so we need to ||= in case
@@ -40,8 +44,6 @@ module Specwrk
   end
 
   class PendingQueue < Queue
-    attr_reader :previous_run_times
-
     def shift_bucket
       return bucket_by_file unless previous_run_times
 
@@ -59,17 +61,22 @@ module Specwrk
       previous_run_times.dig(:meta, :average_run_time)
     end
 
-    # TODO: move reading the file to the getter method
-    def previous_run_times_file=(path)
-      return unless path
-      return unless File.exist? path
+    def previous_run_times
+      return unless ENV["SPECWRK_OUT"]
 
-      File.open(path, "r") do |file|
-        file.flock(File::LOCK_EX)
+      @previous_run_times ||= begin
+        return unless previous_run_times_file_path
+        return unless File.exist? previous_run_times_file_path
 
-        @previous_run_times = JSON.parse(file.read, symbolize_names: true)
+        raw_data = File.open(previous_run_times_file_path, "r") do |file|
+          file.flock(File::LOCK_SH)
+          file.read
+        end
 
-        file.flock(File::LOCK_UN)
+        @previous_run_times = JSON.parse(raw_data, symbolize_names: true)
+      rescue JSON::ParserError => e
+        warn "#{e.inspect} in file #{previous_run_times_file_path}"
+        nil
       end
     end
 
@@ -84,6 +91,15 @@ module Specwrk
 
     private
 
+    # We want the most recently modified run time file
+    # report files are prefixed with a timestamp, and Dir.glob should order
+    # alphanumericly
+    def previous_run_times_file_path
+      return unless ENV["SPECWRK_OUT"]
+
+      @previous_run_times_file_path ||= Dir.glob(File.join(ENV["SPECWRK_OUT"], "*-report-*.json")).last
+    end
+
     # Take elements from the hash where the file_path is the same
     def bucket_by_file
       bucket = []
@@ -163,7 +179,7 @@ module Specwrk
         @hash.values.each { |example| calculate(example) }
 
         @output[:meta][:total_run_time] = @run_times.sum
-        @output[:meta][:average_run_time] = @output[:meta][:total_run_time] / @run_times.length.to_f
+        @output[:meta][:average_run_time] = @output[:meta][:total_run_time] / [@run_times.length, 1].max.to_f
         @output[:meta][:first_started_at] = @first_started_at.iso8601(6)
         @output[:meta][:last_finished_at] = @last_finished_at.iso8601(6)
 

data/lib/specwrk/version.rb

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

data/lib/specwrk/web/app.rb

@@ -52,10 +52,8 @@ module Specwrk
 
         def setup!
           if ENV["SPECWRK_OUT"]
-
             FileUtils.mkdir_p(ENV["SPECWRK_OUT"])
             ENV["SPECWRK_SRV_LOG"] ||= Pathname.new(File.join(ENV["SPECWRK_OUT"], "server.log")).to_s unless ENV["SPECWRK_SRV_VERBOSE"]
-            ENV["SPECWRK_SRV_OUTPUT"] ||= Pathname.new(File.join(ENV["SPECWRK_OUT"], "report.json")).expand_path(Dir.pwd).to_s
           end
 
           if ENV["SPECWRK_SRV_LOG"]
@@ -100,8 +98,8 @@ module Specwrk
           Endpoints::Complete
         when ["POST", "/seed"]
           Endpoints::Seed
-        when ["GET", "/stats"]
-          Endpoints::Stats
+        when ["GET", "/report"]
+          Endpoints::Report
         when ["DELETE", "/shutdown"]
           Endpoints::Shutdown
         else

data/lib/specwrk/web/auth.rb

@@ -28,7 +28,7 @@ module Specwrk
       private
 
       def unauthorized
-        [401, {"Content-Type" => "application/json"}, ["Unauthorized"]]
+        [401, {"content-type" => "application/json"}, ["Unauthorized"]]
       end
     end
   end

data/lib/specwrk/web/endpoints.rb

@@ -22,11 +22,11 @@ module Specwrk
         attr_reader :request
 
         def not_found
-          [404, {"Content-Type" => "text/plain"}, ["This is not the path you're looking for, 'ol chap..."]]
+          [404, {"content-type" => "text/plain"}, ["This is not the path you're looking for, 'ol chap..."]]
         end
 
         def ok
-          [200, {"Content-Type" => "text/plain"}, ["OK, 'ol chap"]]
+          [200, {"content-type" => "text/plain"}, ["OK, 'ol chap"]]
         end
 
         def payload
@@ -38,7 +38,7 @@ module Specwrk
         end
 
         def pending_queue
-          Web::PENDING_QUEUES[request.get_header("HTTP_X_SPECWRK_RUN")]
+          Web::PENDING_QUEUES[run_id]
         end
 
         def processing_queue
@@ -56,6 +56,14 @@ module Specwrk
         def worker
           workers[request.get_header("HTTP_X_SPECWRK_ID")]
         end
+
+        def run_id
+          request.get_header("HTTP_X_SPECWRK_RUN")
+        end
+
+        def run_report_file_path
+          @run_report_file_path ||= File.join(ENV["SPECWRK_OUT"], "#{completed_queue.created_at.strftime("%Y%m%dT%H%M%S")}-report-#{run_id}.json").to_s
+        end
       end
 
       # Base default response is 404
@@ -98,8 +106,8 @@ module Specwrk
             end
           end
 
-          if pending_queue.length.zero? && processing_queue.length.zero? && completed_queue.length.positive? && ENV["SPECWRK_SRV_OUTPUT"]
-            completed_queue.dump_and_write(ENV["SPECWRK_SRV_OUTPUT"])
+          if pending_queue.length.zero? && processing_queue.length.zero? && completed_queue.length.positive? && ENV["SPECWRK_OUT"]
+            completed_queue.dump_and_write(run_report_file_path)
           end
 
           ok
@@ -117,38 +125,50 @@ module Specwrk
           end
 
           if @examples.length.positive?
-            [200, {"Content-Type" => "application/json"}, [JSON.generate(@examples)]]
+            [200, {"content-type" => "application/json"}, [JSON.generate(@examples)]]
           elsif pending_queue.length.zero? && processing_queue.length.zero? && completed_queue.length.zero?
-            [204, {"Content-Type" => "text/plain"}, ["Waiting for sample to be seeded."]]
+            [204, {"content-type" => "text/plain"}, ["Waiting for sample to be seeded."]]
           elsif completed_queue.length.positive? && processing_queue.length.zero?
-            [410, {"Content-Type" => "text/plain"}, ["That's a good lad. Run along now and go home."]]
+            [410, {"content-type" => "text/plain"}, ["That's a good lad. Run along now and go home."]]
           else
             not_found
           end
         end
       end
 
-      class Stats < Base
+      class Report < Base
         def response
-          data = {
-            pending: {count: pending_queue.length},
-            processing: {count: processing_queue.length},
-            completed: completed_queue.dump
-          }
-
-          if data.dig(:completed, :examples).length.positive?
-            [200, {"Content-Type" => "application/json"}, [JSON.generate(data)]]
+          if data
+            [200, {"content-type" => "application/json"}, [data]]
           else
-            not_found
+            [404, {"content-type" => "text/plain"}, ["Unable to report on run #{run_id}; no file matching #{"*-report-#{run_id}.json"}"]]
+          end
+        end
+
+        private
+
+        def data
+          return @data if defined? @data
+
+          return unless most_recent_run_report_file
+          return unless File.exist?(most_recent_run_report_file)
+
+          @data = File.open(most_recent_run_report_file, "r") do |file|
+            file.flock(File::LOCK_SH)
+            file.read
           end
         end
+
+        def most_recent_run_report_file
+          @most_recent_run_report_file ||= Dir.glob(File.join(ENV["SPECWRK_OUT"], "*-report-#{run_id}.json")).last
+        end
       end
 
       class Shutdown < Base
         def response
           interupt! if ENV["SPECWRK_SRV_SINGLE_RUN"]
 
-          [200, {"Content-Type" => "text/plain"}, ["✌️"]]
+          [200, {"content-type" => "text/plain"}, ["✌️"]]
         end
 
         def interupt!

data/lib/specwrk/web.rb

@@ -4,7 +4,7 @@ require "specwrk/queue"
 
 module Specwrk
   class Web
-    PENDING_QUEUES = Queue.new { |h, key| h[key] = PendingQueue.new.tap { |q| q.previous_run_times_file = ENV["SPECWRK_SRV_OUTPUT"] } }
+    PENDING_QUEUES = Queue.new { |h, key| h[key] = PendingQueue.new }
     PROCESSING_QUEUES = Queue.new { |h, key| h[key] = Queue.new }
     COMPLETED_QUEUES = Queue.new { |h, key| h[key] = CompletedQueue.new }
     WORKERS = Hash.new { |h, key| h[key] = Hash.new { |h, key| h[key] = {} } }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specwrk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Daniel Westendorf
@@ -152,6 +152,7 @@ files:
 - config.ru
 - docker/Dockerfile.server
 - docker/entrypoint.server.sh
+- docker/pitchfork.conf
 - exe/specwrk
 - lib/specwrk.rb
 - lib/specwrk/cli.rb