derail_specs 0.2.0

data/lib/derail_specs/server/puma.rb

@@ -0,0 +1,32 @@
+module DerailSpecs
+  class Server
+    module Puma
+      def self.create(app, port, host)
+        require "rack/handler/puma"
+
+        # If we just run the Puma Rack handler it installs signal handlers which prevent us from being able to interrupt tests.
+        # Therefore construct and run the Server instance ourselves.
+        # Rack::Handler::Puma.run(app, { Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false }.merge(options))
+        default_options = { Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false }
+        options = default_options # .merge(options)
+
+        conf = Rack::Handler::Puma.config(app, options)
+        conf.clamp
+        events = ::Puma::Events.stdio
+
+        puma_ver = Gem::Version.new(::Puma::Const::PUMA_VERSION)
+        require_relative "patches/puma_ssl" if (Gem::Version.new("4.0.0")...Gem::Version.new("4.1.0")).cover? puma_ver
+
+        events.log "Starting Puma..."
+        events.log "* Version #{::Puma::Const::PUMA_VERSION} , codename: #{::Puma::Const::CODE_NAME}"
+        events.log "* Min threads: #{conf.options[:min_threads]}, max threads: #{conf.options[:max_threads]}"
+
+        ::Puma::Server.new(conf.app, events, conf.options).tap do |s|
+          s.binder.parse conf.options[:binds], s.events
+          s.min_threads = conf.options[:min_threads]
+          s.max_threads = conf.options[:max_threads]
+        end.run.join
+      end
+    end
+  end
+end

data/lib/derail_specs/server/timer.rb

@@ -0,0 +1,20 @@
+module DerailSpecs
+  class Server
+    class Timer
+      def initialize(expire_in)
+        @start = current
+        @expire_in = expire_in
+      end
+
+      def expired?
+        current - @start >= @expire_in
+      end
+
+      private
+
+      def current
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/derail_specs/server.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "rack"
+require_relative "server/middleware"
+require_relative "server/checker"
+require_relative "server/timer"
+require_relative "server/puma"
+require_relative "server/app"
+
+# Tons of this server configuration stuff is copied from:
+# https://github.com/testdouble/cypress-rails
+module DerailSpecs
+  class Server
+    class << self
+      def ports
+        @ports ||= {}
+      end
+    end
+
+    attr_reader :app, :host, :port
+
+    def initialize(reportable_errors: [Exception], extra_middleware: [])
+      @app = Server::App
+      @extra_middleware = extra_middleware
+      @server_thread = nil # suppress warnings
+      @host = DerailSpecs.configuration.host
+      @reportable_errors = reportable_errors
+      @port = DerailSpecs.configuration.port
+      @port ||= Server.ports[port_key]
+      @port ||= find_available_port(host)
+      @checker = Checker.new(@host, @port)
+    end
+
+    def reset_error!
+      middleware.clear_error
+    end
+
+    def error
+      middleware.error
+    end
+
+    def using_ssl?
+      @checker.ssl?
+    end
+
+    def responsive?
+      return false if @server_thread&.join(0)
+
+      res = @checker.request { |http| http.get("/__identify__") }
+
+      return res.body == app.object_id.to_s if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
+    rescue SystemCallError, Net::ReadTimeout, OpenSSL::SSL::SSLError
+      false
+    end
+
+    def wait_for_pending_requests
+      timer = Timer.new(60)
+      while pending_requests?
+        raise "Requests did not finish in 60 seconds: #{middleware.pending_requests}" if timer.expired?
+
+        sleep 0.01
+      end
+    end
+
+    def boot
+      unless responsive?
+        Server.ports[port_key] = port
+
+        @server_thread = Thread.new do
+          Puma.create(middleware, port, host)
+        end
+
+        timer = Timer.new(60)
+        until responsive?
+          raise "Rack application timed out during boot" if timer.expired?
+
+          @server_thread.join(0.1)
+        end
+      end
+
+      self
+    end
+
+    private
+
+    def middleware
+      @middleware ||= Middleware.new(app, @reportable_errors, @extra_middleware)
+    end
+
+    def port_key
+      app.object_id # as opposed to middleware.object_id if multiple instances
+    end
+
+    def pending_requests?
+      middleware.pending_requests?
+    end
+
+    def find_available_port(host)
+      server = TCPServer.new(host, 0)
+      port = server.addr[1]
+      server.close
+
+      # Workaround issue where some platforms (mac, ???) when passed a host
+      # of '0.0.0.0' will return a port that is only available on one of the
+      # ip addresses that resolves to, but the next binding to that port requires
+      # that port to be available on all ips
+      server = TCPServer.new(host, port)
+      port
+    rescue Errno::EADDRINUSE
+      retry
+    ensure
+      server&.close
+    end
+  end
+end

data/lib/derail_specs/transaction.rb

@@ -0,0 +1,84 @@
+module DerailSpecs
+  class Transaction
+    def self.instance
+      @instance ||= new
+    end
+
+    def self.begin
+      instance.begin
+    end
+
+    def begin
+      @connections = gather_connections
+      @connections.each do |connection|
+        connection.begin_transaction joinable: false, _lazy: false
+        connection.pool.lock_thread = true
+      end
+
+      # When connections are established in the future, begin a transaction too
+      @connection_subscriber = ActiveSupport::Notifications.subscribe("!connection.active_record") do |_, _, _, _, payload|
+        if payload.key?(:spec_name) && (spec_name = payload[:spec_name])
+          setup_shared_connection_pool
+
+          begin
+            ActiveRecord::Base.connection_handler.retrieve_connection(spec_name)
+          rescue ActiveRecord::ConnectionNotEstablished
+            connection = nil
+          end
+
+          if connection && !@connections.include?(connection)
+            connection.begin_transaction joinable: false, _lazy: false
+            connection.pool.lock_thread = true
+            @connections << connection
+          end
+        end
+      end
+    end
+
+    def self.rollback
+      instance.rollback
+    end
+
+    def rollback
+      return unless @connections.present?
+
+      ActiveSupport::Notifications.unsubscribe(@connection_subscriber) if @connection_subscriber
+
+      @connections.each do |connection|
+        connection.rollback_transaction if connection.transaction_open?
+        connection.pool.lock_thread = false
+      end
+      @connections.clear
+
+      ActiveRecord::Base.clear_active_connections!
+    end
+
+    def self.reset
+      instance.reset
+    end
+
+    def reset
+      rollback
+      self.begin
+    end
+
+    def gather_connections
+      setup_shared_connection_pool
+
+      ActiveRecord::Base.connection_handler.connection_pool_list.map(&:connection)
+    end
+
+    # Shares the writing connection pool with connections on
+    # other handlers.
+    #
+    # In an application with a primary and replica the test fixtures
+    # need to share a connection pool so that the reading connection
+    # can see data in the open transaction on the writing connection.
+    def setup_shared_connection_pool
+      @legacy_saved_pool_configs ||= Hash.new { |hash, key| hash[key] = {} }
+      @saved_pool_configs ||= Hash.new { |hash, key| hash[key] = {} }
+
+      ActiveRecord::TestFixtures.instance_method(:setup_shared_connection_pool).bind_call(self)
+    end
+  end
+end

data/lib/derail_specs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DerailSpecs
+  VERSION = "0.2.0"
+end

data/lib/derail_specs.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "derail_specs/version"
+
+module DerailSpecs
+  class Error < StandardError; end
+
+  def self.configuration
+    @configuration ||= Struct
+                       .new(:command, :host, :port, keyword_init: true)
+                       .new(
+                         host: '127.0.0.1',
+                         port: 3001,
+                       )
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+
+require 'derail_specs/boot'
+require 'derail_specs/transaction'
+require 'derail_specs/railtie'

data/lib/generators/derail_specs/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module DerailSpecs
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __dir__)
+
+      def copy_config
+        copy_file(
+          "config/initializers/derail_specs.rb",
+          "config/initializers/derail_specs.rb",
+        )
+      end
+    end
+  end
+end

data/lib/generators/templates/config/initializers/derail_specs.rb

@@ -0,0 +1,5 @@
+DerailSpecs.configure do |config|
+  config.command = './tests.sh'
+  config.host = '127.0.0.1'
+  config.port = 3001
+end

data/lib/tasks/derail_specs.rake

@@ -0,0 +1,5 @@
+namespace :derail_specs do
+  task run: :environment do
+    DerailSpecs::Boot.new.run
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: derail_specs
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alex Piechowski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description:
+email:
+- alex@piechowski.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- derail_specs.gemspec
+- example/.gitignore
+- example/.ruby-version
+- example/Gemfile
+- example/Gemfile.lock
+- example/README.md
+- example/Rakefile
+- example/app/controllers/application_controller.rb
+- example/app/models/application_record.rb
+- example/app/views/layouts/application.html.erb
+- example/bin/bundle
+- example/bin/rails
+- example/bin/rake
+- example/bin/setup
+- example/config.ru
+- example/config/application.rb
+- example/config/boot.rb
+- example/config/credentials.yml.enc
+- example/config/database.yml
+- example/config/environment.rb
+- example/config/environments/development.rb
+- example/config/environments/production.rb
+- example/config/environments/test.rb
+- example/config/initializers/application_controller_renderer.rb
+- example/config/initializers/backtrace_silencers.rb
+- example/config/initializers/content_security_policy.rb
+- example/config/initializers/cookies_serializer.rb
+- example/config/initializers/derail_specs.rb
+- example/config/initializers/filter_parameter_logging.rb
+- example/config/initializers/inflections.rb
+- example/config/initializers/mime_types.rb
+- example/config/initializers/permissions_policy.rb
+- example/config/initializers/wrap_parameters.rb
+- example/config/locales/en.yml
+- example/config/puma.rb
+- example/config/routes.rb
+- example/public/404.html
+- example/public/422.html
+- example/public/500.html
+- example/public/apple-touch-icon-precomposed.png
+- example/public/apple-touch-icon.png
+- example/public/favicon.ico
+- example/public/robots.txt
+- example/tests.sh
+- lib/derail_specs.rb
+- lib/derail_specs/boot.rb
+- lib/derail_specs/railtie.rb
+- lib/derail_specs/server.rb
+- lib/derail_specs/server/app.rb
+- lib/derail_specs/server/checker.rb
+- lib/derail_specs/server/middleware.rb
+- lib/derail_specs/server/puma.rb
+- lib/derail_specs/server/timer.rb
+- lib/derail_specs/transaction.rb
+- lib/derail_specs/version.rb
+- lib/generators/derail_specs/install_generator.rb
+- lib/generators/templates/config/initializers/derail_specs.rb
+- lib/tasks/derail_specs.rake
+homepage: https://github.com/roshreview/derail_specs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/roshreview/derail_specs
+  source_code_uri: https://github.com/roshreview/derail_specs
+  changelog_uri: https://github.com/roshreview/derail_specs/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Rails test server for external tests.
+test_files: []