specwrk 0.15.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63eedb1506644bd71c457579fb2de19779c66c565b2c614284272152506648ca
-  data.tar.gz: eb5c83efcd7a9d76623867ec42d48a335e2f349c6608326abba643252a31e486
+  metadata.gz: 3de4bb5f29a1c817db2c766d49fcd20d2153e6bf9708fc7b5ece2e1101fbb839
+  data.tar.gz: 3fb0dc079f9d85461ec245e2b1019d03e94ba7f3403813f2c7558504140b2c37
 SHA512:
-  metadata.gz: 8235b7ddcd7bbee6acc73ec3c53bf8bd9987d769babc42159248b514f326b381ad49a4247e12c649d21d700d158c7f1b83b1b5c93ff6200eb38f8e41b46f4df1
-  data.tar.gz: f98b5df6bb5a72bd515c5324c17c8c76daf1a08c876fc6d4ab8b7a9f9f6a6477248b34dc9a82c73f289f417a8026bd7b2cc6eb367c25948d17c5f0c5d918844d
+  metadata.gz: 3bfbec41f429426bcd85e81c2d879c1e3171ce2f0dba908a420890b5fa37373e803540ef92d4bfada74f4e465e4babc558c3e18cf8fa941376eb6e2d0d08cea2
+  data.tar.gz: 9096f33b527c0ae8233ae22a01d7e6b53e446b6684b63417120ba9181f7780e2590a4ff59ee5777a06d750341c5f3781f2f3f705c65874b69ae422db812a1ed2

data/README.md

@@ -142,6 +142,26 @@ Options:
   --help, -h                        # Print this help
 ```
 
+### `specwrk watch -c 8` 
+Starts `8` worker processes in watch mode for the current directory. Watched spec files will be distributed across the processes. By default, only looks at `_spec.rb` files. Configure a [watchfile](#create-a-watchfile-for-the-watch-command) to map file changes to spec files (i.e. modification of `app/models/user.rb` should run `spec/models/user_spec.rb` and `spec/system/users_spec.rb`).
+
+```sh
+$ specwrk watch --help
+Command:
+  specwrk watch
+
+Usage:
+  specwrk watch
+
+Description:
+  Start a server and workers, watch for file changes in the current directory, and execute specs
+
+Options:
+  --watchfile=VALUE                 # Path to watchfile configuration, default: "Specwrk.watchfile.rb"
+  --count=VALUE, -c VALUE           # The number of worker processes you want to start, default: 1
+  --help, -h                        # Print this help
+```
+
 ## Configuring your test environment
 If you test suite tracks state, starts servers, etc. and you plan on running many processes on the same node, you'll need to make
 adjustments to avoid conflicting port usage or database/state mutations.
@@ -204,6 +224,43 @@ Start a persistent Queue Server given one of the following methods
 
 See [specwrk serve --help](#specwrk-serve) for all possible configuration options.
 
+### Create a watchfile for the `watch` command
+Watch file (default path is `Specwrk.watchfile.rb` in the current directory) is a ruby file that will be instance eval'd to configure the watcher. There are two commands available:
+
+1. `ignore(Regexp)` to define files that should never trigger a run
+2. `map(Regexp, &blk)` to map a file change to the spec files that should be run to that file change
+
+By default, files without a `.rb` extension will be ignored and files ending with `_spec.rb` will be run. Presence of a watchfile will override these defaults.
+
+```ruby
+# Specwrk.watchfile.rb
+# Ignore all files which don't have an .rb extension
+ignore(/^(?!.*\.rb$).+/)
+
+# When a _spec.rb file changes, it should be run
+map(/_spec\.rb$/) do |spec_path|
+  spec_path
+end
+
+# If a file in lib changes, map it to the spec folder for it's spec file
+map(/lib\/.*\.rb$/) do |path|
+  path.gsub(/lib\/(.+)\.rb/, "spec/\\1_spec.rb")
+end
+
+# If a model file changes (assuming rails app structure), run the model's spec file
+# map(/app\/models\/.*.rb$/) do |path|
+#   path.gsub(/app\/models\/(.+)\.rb/, "spec/models/\\1_spec.rb")
+# end
+#
+# If a controlelr file changes (assuming rails app structure), run the controller and system specs file
+# map(/app\/controllers\/.*.rb$/) do |path|
+#   [
+#     path.gsub(/app\/controllers\/(.+)\.rb/, "spec/controllers/\\1_spec.rb"),
+#     path.gsub(/app\/controllers\/(.+)\.rb/, "spec/system/\\1_spec.rb")
+#   ]
+# end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/dwestendorf/specwrk.

data/Specwrk.watchfile.rb

@@ -0,0 +1,25 @@
+# Ignore all files which don't have an .rb extension
+ignore(/^(?!.*\.rb$).+/)
+
+# When a _spec.rb file changes, it should be run
+map(/_spec\.rb$/) do |spec_path|
+  spec_path
+end
+
+# If a file in lib changes, map it to the spec folder for it's spec file
+map(/lib\/.*\.rb$/) do |path|
+  path.gsub(/lib\/(.+)\.rb/, "spec/\\1_spec.rb")
+end
+
+# If a model file changes (assuming rails app structure), run the model's spec file
+# map(/app\/models\/.*.rb$/) do |path|
+#   path.gsub(/app\/models\/(.+)\.rb/, "spec/models/\\1_spec.rb")
+# end
+#
+# If a controlelr file changes (assuming rails app structure), run the controller and system specs file
+# map(/app\/controllers\/.*.rb$/) do |path|
+#   [
+#     path.gsub(/app\/controllers\/(.+)\.rb/, "spec/controllers/\\1_spec.rb"),
+#     path.gsub(/app\/controllers\/(.+)\.rb/, "spec/system/\\1_spec.rb")
+#   ]
+# end

data/lib/specwrk/cli.rb

@@ -74,6 +74,7 @@ module Specwrk
       def drain_outputs
         @final_outputs.each do |reader|
           reader.each_line { |line| $stdout.print line }
+          reader.close
         end
       end
 
@@ -252,7 +253,7 @@ module Specwrk
         require "specwrk/cli_reporter"
         status = Specwrk::CLIReporter.new.report
 
-        Specwrk.wait_for_pids_exit([web_pid, seed_pid] + @worker_pids)
+        Specwrk.wait_for_pids_exit([web_pid, seed_pid])
         exit(status)
       end
 
@@ -262,10 +263,161 @@ module Specwrk
       end
     end
 
+    class Watch < Dry::CLI::Command
+      desc "Start a server and workers, watch for file changes in the current directory, and execute specs"
+      option :watchfile, type: :string, default: "Specwrk.watchfile.rb", desc: "Path to watchfile configuration"
+      option :count, type: :integer, default: 1, aliases: ["-c"], desc: "The number of worker processes you want to start"
+
+      def call(count:, watchfile:, **args)
+        $stdout.sync = true
+
+        # nil this env var if it exists to prevent never-ending workers
+        ENV["SPECWRK_SRV_URI"] = nil
+        ENV["SPECWRK_SEED_WAITS"] = "0"
+        ENV["SPECWRK_MAX_BUCKET_SIZE"] = "1"
+        ENV["SPECWRK_COUNT"] = count.to_s
+        ENV["SPECWRK_RUN"] = "watch"
+
+        web_pid
+
+        return if Specwrk.force_quit
+
+        seed_pid
+
+        start_watcher(watchfile)
+
+        require "specwrk/cli_reporter"
+
+        loop do
+          status "👀 Watching for file changes..."
+
+          @worker_pids = nil
+          Thread.pass until file_queue.length.positive? || Specwrk.force_quit
+
+          break if Specwrk.force_quit
+
+          files = []
+          files.push(file_queue.pop) until file_queue.length.zero?
+          status "Running specs for #{files.join(" ")}..."
+          ipc.write(files.join(" "))
+
+          example_count = ipc.read.to_i
+          if example_count.positive?
+            puts "\n🌱 Seeded #{example_count} examples for execution\n"
+          else
+            puts "\n🙅 No examples to seed for execution\n"
+          end
+
+          next if example_count.zero?
+
+          return if Specwrk.force_quit
+          start_workers
+
+          Specwrk.wait_for_pids_exit(@worker_pids)
+
+          drain_outputs
+          return if Specwrk.force_quit
+
+          Specwrk::CLIReporter.new.report
+          puts
+          $stdout.flush
+        end
+
+        ipc.write "INT" # wakes the socket
+        Specwrk.wait_for_pids_exit([web_pid, seed_pid])
+      end
+
+      private
+
+      def web_pid
+        @web_pid ||= Process.fork do
+          require "specwrk/web"
+          require "specwrk/web/app"
+
+          ENV["SPECWRK_FORKED"] = "1"
+          status "Starting queue server..."
+          Specwrk::Web::App.run!
+        end
+      end
+
+      def seed_pid
+        @seed_pid ||= begin
+          ipc # must be initialized in the parent process
+
+          @seed_pid = Process.fork do
+            require "specwrk/seed_loop"
+
+            ENV["SPECWRK_FORKED"] = "1"
+            ENV["SPECWRK_SEED"] = "1"
+
+            Specwrk::SeedLoop.loop!(ipc)
+          end
+        end
+      end
+
+      def ipc
+        @ipc ||= begin
+          require "specwrk/ipc"
+
+          Specwrk::IPC.new
+        end
+      end
+
+      def start_watcher(watchfile)
+        require "specwrk/watcher"
+
+        Specwrk::Watcher.watch(Dir.pwd, file_queue, watchfile)
+      end
+
+      def file_queue
+        @file_queue ||= Queue.new
+      end
+
+      def status(msg)
+        print "\e[2K\r#{msg}"
+        $stdout.flush
+      end
+
+      def start_workers
+        @final_outputs = []
+        @worker_pids = worker_count.times.map do |i|
+          reader, writer = IO.pipe
+          @final_outputs << reader
+
+          Process.fork do
+            ENV["TEST_ENV_NUMBER"] = ENV["SPECWRK_FORKED"] = (i + 1).to_s
+            ENV["SPECWRK_ID"] = "specwrk-worker-#{i + 1}"
+
+            $final_output = writer # standard:disable Style/GlobalVars
+            $final_output.sync = true # standard:disable Style/GlobalVars
+            reader.close
+
+            require "specwrk/worker"
+
+            status = Specwrk::Worker.run!
+            $final_output.close # standard:disable Style/GlobalVars
+            exit(status)
+          end.tap { writer.close }
+        end
+      end
+
+      def drain_outputs
+        @final_outputs.each do |reader|
+          reader.each_line { |line| $stdout.print line }
+          reader.close
+        end
+      end
+
+      def worker_count
+        @worker_count ||= [1, ENV["SPECWRK_COUNT"].to_i].max
+      end
+    end
+
     register "version", Version, aliases: ["v", "-v", "--version"]
     register "work", Work, aliases: ["wrk", "twerk", "w"]
     register "serve", Serve, aliases: ["srv", "s"]
     register "seed", Seed
     register "start", Start
+    register "watch", Watch, aliases: ["w", "👀"]
   end
 end

data/lib/specwrk/ipc.rb

@@ -0,0 +1,36 @@
+require "socket"
+
+module Specwrk
+  class IPC
+    def initialize
+      @parent_pid = Process.pid
+
+      @parent_socket, @child_socket = UNIXSocket.pair
+    end
+
+    def write(msg)
+      socket.puts msg.to_s
+    end
+
+    def read
+      IO.select([socket])
+
+      data = socket.gets&.chomp
+      return if data.nil? || data.length.zero? || data == "INT"
+
+      data
+    end
+
+    private
+
+    attr_reader :parent_pid, :parent_socket, :child_socket
+
+    def socket
+      child? ? child_socket : parent_socket
+    end
+
+    def child?
+      Process.pid != parent_pid
+    end
+  end
+end

data/lib/specwrk/list_examples.rb

@@ -11,6 +11,7 @@ module Specwrk
     end
 
     def examples
+      reset!
       return @examples if defined?(@examples)
 
       @examples = []
@@ -38,6 +39,30 @@ module Specwrk
 
     private
 
+    def reset!
+      return unless ENV["SPECWRK_SEED"]
+      RSpec.clear_examples
+
+      # see https://github.com/rspec/rspec-core/pull/2723
+      if Gem::Version.new(RSpec::Core::Version::STRING) <= Gem::Version.new("3.9.1")
+        RSpec.world.instance_variable_set(
+          :@example_group_counts_by_spec_file, Hash.new(0)
+        )
+      end
+
+      # RSpec.clear_examples does not reset those, which causes issues when
+      # a non-example error occurs (subsequent jobs are not executed)
+      RSpec.world.non_example_failure = false
+
+      # we don't want an error that occured outside of the examples (which
+      # would set this to `true`) to stop the worker
+      RSpec.world.wants_to_quit = Specwrk.force_quit
+
+      RSpec.configuration.silence_filter_announcements = true
+
+      true
+    end
+
     def out
       @out ||= Tempfile.new.tap do |f|
         f.define_singleton_method(:tty?) { true }

data/lib/specwrk/seed_loop.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "specwrk/list_examples"
+require "specwrk/client"
+
+module Specwrk
+  class SeedLoop
+    def self.loop!(ipc)
+      Client.wait_for_server!
+
+      loop do
+        break if Specwrk.force_quit
+
+        files = ipc.read
+
+        next unless files
+        examples = ListExamples.new(files.split(" ")).examples
+
+        client = Client.new
+        client.seed(examples, 0)
+        client.close
+
+        ipc.write examples.length
+      end
+    end
+  end
+end

data/lib/specwrk/version.rb

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

data/lib/specwrk/watcher.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "listen"
+
+module Specwrk
+  class Watcher
+    class Config
+      def self.load(file)
+        if file && File.exist?(file)
+          new(false).tap { |instance| instance.instance_eval(File.read(file), file, 1) }
+        else
+          new
+        end
+      end
+
+      def initialize(default_config = true)
+        if default_config
+          @mappings = [
+            [/_spec\.rb$/, proc { |changed_file_path| changed_file_path }]
+          ]
+
+          @ignore_patterns = [/^(?!.*\.rb$).+/]
+        else
+          @mappings = []
+          @ignore_patterns = []
+        end
+      end
+
+      def map(pattern, &block)
+        @mappings << [pattern, block]
+      end
+
+      def ignore(*patterns)
+        @ignore_patterns.concat(patterns)
+      end
+
+      def spec_files_for(path)
+        return [] if @ignore_patterns.any? { |pattern| pattern.match? path }
+
+        @mappings.map do |pattern, block|
+          next unless pattern.match? path
+
+          block.call(path)
+        end.flatten.compact.uniq
+      end
+    end
+
+    def self.watch(dir, queue, watchfile)
+      instance = new(dir, queue, watchfile)
+
+      instance.start
+    end
+
+    def initialize(dir, queue, watchfile = "Specwrk.watchfile.rb")
+      @dir = dir
+      @queue = queue
+      @config = Config.load(watchfile)
+    end
+
+    def start
+      listener.start
+    end
+
+    def push(paths)
+      paths.each do |path|
+        relative_path = Pathname.new(path).relative_path_from(Pathname.new(dir)).to_s
+
+        spec_files = config.spec_files_for(relative_path)
+
+        spec_files.each do |spec_file_path|
+          queue.push(spec_file_path) if File.exist?(spec_file_path)
+        end
+      end
+    end
+
+    private
+
+    attr_reader :dir, :queue, :config
+
+    def listener
+      @listener ||= Listen.to(dir) do |modified, added|
+        push(modified)
+        push(added)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specwrk
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Daniel Westendorf
@@ -79,6 +79,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rackup
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +205,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Specwrk.watchfile.rb
 - config.ru
 - docker/Dockerfile.server
 - docker/entrypoint.server.sh
@@ -190,12 +219,15 @@ files:
 - lib/specwrk/cli_reporter.rb
 - lib/specwrk/client.rb
 - lib/specwrk/hookable.rb
+- lib/specwrk/ipc.rb
 - lib/specwrk/list_examples.rb
+- lib/specwrk/seed_loop.rb
 - lib/specwrk/store.rb
 - lib/specwrk/store/base_adapter.rb
 - lib/specwrk/store/file_adapter.rb
 - lib/specwrk/store/memory_adapter.rb
 - lib/specwrk/version.rb
+- lib/specwrk/watcher.rb
 - lib/specwrk/web.rb
 - lib/specwrk/web/app.rb
 - lib/specwrk/web/auth.rb