evil_systems 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c39ae0b47c7d330afb6daa3ef1c8137d190f861905a4a3cdc45305740927ec1
+  data.tar.gz: e3c40f2764522b1796d11053aecd530267704d87f0ce6732b7d58374a2c030e9
+SHA512:
+  metadata.gz: fed0a5eebfba465c8d2d36228e7b05e6da431a464ee540b34f867c34e64d6263e7cc52d7e9612b679c198514f81ae1fbaff833dc8430600a561e89617ad8a407
+  data.tar.gz: 992f7b9646ecf70c5c07c032f40af6422e52785897ef7cc29c56cc45b08f875e684fec1a5a9b90c81687a1a67b660159fb3bde20490f7f8e9d2226aea59101f5

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+Initial release!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 ParamagicDev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,179 @@
+# EvilSystemTests
+
+Why does this exist?
+
+I wanted a quick, easy, reusable way to use the settings put forth in
+[EvilMartians System of a Test blog post] (https://evilmartians.com/chronicles/system-of-a-test-setting-up-end-to-end-rails-testing)
+for Minitest. System of a test is currently written for RSpec.
+
+Full API documentation can be found here:
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'evil_system_tests'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+## Setup
+
+### Minitest
+
+Navigate to `test/application_system_test_case.rb` in your Rails app.
+
+Setup your file like so:
+
+```rb
+# test/application_system_test_case.rb
+
+require 'test_helper'
+
++ # 'capybara' and 'capybara/cuprite' need to be defined for EvilSystems to
+work properly.
++ require 'capybara'
++ require 'capybara/cuprite'
+
++ require 'evil_systems'
+
++ EvilSystems.initial_setup
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+-  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
++  driven_by :cuprite
+
++ include EvilSystems::Helpers
+end
+```
+
+### RSpec
+
+*Maybe in the future?*
+
+## Whats included?
+
+## Usage
+
+`EvilSystems.initial_setup` takes two keyword arguments, `:task`, and
+`silent`.
+
+Both arguments have to do with precompiling assets.
+`:silent` by default is set to `true` and will only tell you when assets
+are compiling, and how long it took.
+`:task` defaults to `assets:precompile`, System of a test uses
+`webpacker:compile`.
+
+### Settings
+
+[x] - Automatically registers a `:cuprite` driver if `Capybara::Cuprite`
+is defined.
+[x] - Automatically sets Capybara's default and javascript driver to
+`:cuprite`
+[x] - Automatically sets `Capybara.app_host`
+
+<details>
+<summary>How `app_host` is set</summary>
+
+`app_host` will first use `ENV["APP_HOST"]` then falls back to the systems
+`hostname` if the `APP_HOST` ENV var is not defined.
+If neither are defined, it will then default to `"0.0.0.0"`
+
+</details>
+
+[x] - `Capybara.server_host = "0.0.0.0"`
+[x] - `Capybara.default_max_wait_time = 2`
+[x] - `Capybara.default_normalize_ws = true` normalizes whitespace in
+`has_text?` and similar matchers.
+[x] - Sets the `Capybara.save_path` Uses `ENV["CAPYBARA_ARTIFACTS"]` and
+falls back to `"./tmp/capybara"`
+[x] - Sets a `REMOTE_CHROME` instance if a `ENV["CHROME_URL"]` is found
+[x] - Prepends a `last_used_session` attribute accessor to Capybara.
+
+### Helpers
+
+`EvilSystems::Helpers`
+
+Automatically includes `ActionView::RecordIdentifier` if Rails is
+defined.
+
+Also includes:
+
+```rb
+EvilSystems::CupriteHelpers
+EvilSystems::SessionHelpers
+```
+
+#### Regular Helpers
+
+```rb
+# The full path to be prepended to a screen shot
+absolute_image_path
+
+# The relative path to be prepended to a screenshot message to make it clickable
+image_path
+
+# Make failure screenshots compatible with multi-session setup
+take_screenshot
+
+# Prepends a '#' to the +dom_id+ method provided by Rails
+dom_id(*args)
+```
+
+#### SessionHelpers
+
+```rb
+# Small wrapper around Capybara.using_session thats easy to call from an
+instance
+within_session(name_or_session, &block)
+
+# Remove all cookie banners
+mark_all_banners_as_read!
+```
+
+#### Cuprite Helpers
+
+```rb
+# pauses the page
+pause
+
+# Opens a Pry or IRB repl. Will use Pry if Pry is defined, fallsback
+to debugging with IRB
+debug
+```
+
+### Env Variables
+
+```rb
+ENV["APP_HOST"] # used for Capybara.app_host
+ENV["CAPYBARA_ARTIFACTS"] # used for Capybara.save_path
+ENV["CHROME_URL"] # used for setting a remote chrome instance for
+Cuprite
+```
+
+ENV variables used by this gem.
+
+## I don't want to use Cuprite.
+
+Thats fine! I totally get it. Selenium is battle tested. Simply remove
+the `require "capybara/cuprite"` line and `EvilSystems` will detect that
+Cuprite is not defined and not setup a driver for you and not include
+Cuprite helpers.
+
+## Omissions and differences
+
+- Will use `assets:precompile` instead of `webpacker:compile` before
+  systems tests (configurable)
+
+- Does not set the `Rails.application.default_url_options[:host]` due to
+  parallelization issues found while testing the dummy app.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/evil_systems.rb

@@ -0,0 +1,21 @@
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+# EvilMartians like setup for Minitest
+module EvilSystems
+  # To be called before module +ApplicationSystemTest+
+  # @param task [String, nil] ("assets:precompile") - the precompile task to run
+  # @param silent [Boolean] (true) - silence build output and only show asset compilation and time spent compiling.
+  # @return void
+  # @see Settings#initial_setup
+  # @see RegisterCuprite#initial_setup
+  # @see PrecompileAssets#initial_setup
+  def self.initial_setup(task: "assets:precompile", silent: true)
+    Settings.initial_setup
+    RegisterCuprite.initial_setup
+    PrecompileAssets.initial_setup(task: task, silent: silent)
+  end
+end
+
+require "evil_systems/engine" if defined?(Rails)

data/lib/evil_systems/cuprite_helpers.rb

@@ -0,0 +1,22 @@
+# Add shortcuts for cuprite-specific debugging helpers
+module EvilSystems
+  module CupriteHelpers
+    # Pauses the current driver
+    # @return [nil]
+    def pause
+      page.driver.pause
+    end
+
+    # Opens a debug session via Pry if defined, else uses Irb.
+    def debug(binding = nil)
+      $stdout.puts "🔎 Open Chrome inspector at http://localhost:3333"
+      if binding
+        return binding.pry if defined?(Pry)
+
+        return binding.irb
+      end
+
+      page.driver.pause
+    end
+  end
+end

data/lib/evil_systems/engine.rb

@@ -0,0 +1,8 @@
+# require "rails/railtie"
+# Dont think this is needed, perhaps for older rails?
+# Leaving this here in case an issue is reported.
+
+module EvilSystems
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/evil_systems/helpers.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module EvilSystems
+  # Helpers to make life easier
+  module Helpers
+    include ActionView::RecordIdentifier if defined? ::Rails
+    include CupriteHelpers if defined? ::Capybara::Cuprite
+    include SessionHelpers
+
+    # Use our `Capybara.save_path` to store screenshots with other capybara artifacts
+    # (Rails screenshots path is not configurable https://github.com/rails/rails/blob/49baf092439fc74fc3377b12e3334c3dd9d0752f/actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb#L79)
+    # @return [String]
+    def absolute_image_path
+      return ::Rails.root.join("#{::Capybara.save_path}/screenshots/#{image_name}.png") if defined? ::Rails
+
+      File.join("#{::Capybara.save_path}/screenshots/#{image_name}.png")
+    end
+
+    # Use relative path in screenshot message to make it clickable in VS Code when running in Docker
+    # @return [String]
+    def image_path
+      return absolute_image_path.relative_path_from(::Rails.root).to_s if defined? ::Rails
+
+      absolute_image_path.relative_path_from(Dir.pwd)
+    end
+
+    # Make failure screenshots compatible with multi-session setup
+    # @return void
+    def take_screenshot
+      return super unless ::Capybara.last_used_session
+
+      ::Capybara.using_session(::Capybara.last_used_session) { super }
+    end
+
+    # Convert dom_id to a selector.
+    # @example
+    #   dom_id(Facility.first)
+    #   # => "#facility-1"
+    # @return [String]
+    def dom_id(*args)
+      "##{super}"
+    end
+  end
+end

data/lib/evil_systems/precompile_assets.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module EvilSystems
+  module PrecompileAssets
+    # Precompile assets before running tests to avoid timeouts.
+    # Do not precompile if webpack-dev-server is running (NOTE: MUST be launched with RAILS_ENV=test)
+    # @param task [String, nil] ("assets:precompile") - the precompile task to run
+    # @param silent [Boolean] (true) - silence build output and only show asset compilation and time spent compiling.
+    def self.initial_setup(task: "assets:precompile", silent: true)
+      $stdout.puts "\n🐢  Precompiling assets.\n"
+      original_stdout = $stdout.clone
+      start = Time.current
+      begin
+        # Silence output
+        $stdout.reopen(File.new("/dev/null", "w")) if silent == true
+        # next 3 lines to compile assets before running our test suite
+        require "rake"
+        Rails.application.load_tasks
+        Rake::Task[task].invoke if task
+      ensure
+        $stdout.reopen(original_stdout) if silent == true
+        $stdout.puts "Finished in #{(Time.current - start).round(2)} seconds"
+      end
+    end
+  end
+end

data/lib/evil_systems/register_cuprite.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module EvilSystems
+  # Cuprite is a modern Capybara driver which uses Chrome CDP API
+  # instead of Selenium & co.
+  # See https://github.com/rubycdp/cuprite
+  module RegisterCuprite
+    # Registers the Cuprite driver. Can be used via:
+    # driven_by :cuprite, using: :chrome, screen_size: [1400, 1400]
+    # The initial setup prior to the class ApplicationSystemTestCase, runs before the entire test suite.
+    # @return [void]
+    def self.initial_setup
+      return unless defined? Capybara::Cuprite
+
+      remote_options = RemoteChrome.options
+      ::Capybara.register_driver(:cuprite) do |app|
+        ::Capybara::Cuprite::Driver.new(
+          app,
+          **{
+            window_size: [1200, 800],
+            browser_options: {"no-sandbox" => nil},
+            inspector: true
+          }.merge(remote_options)
+        )
+      end
+    end
+  end
+end
+
+Capybara.default_driver = Capybara.javascript_driver = :cuprite

data/lib/evil_systems/remote_chrome.rb

@@ -0,0 +1,42 @@
+module EvilSystems
+  module RemoteChrome
+    # @return [String, nil]
+    def self.url
+      ENV["CHROME_URL"]
+    end
+
+    # Current port
+    # @return Integer
+    def self.port
+      URI.parse(url).yield_self { |uri| uri.port }
+    end
+
+    # Current host
+    # @return [String, nil]
+    def self.host
+      URI.parse(url).yield_self { |uri| uri.host } if url
+    end
+
+    # Returns a hash with a :url key / value if a remote chrome url is found.
+    # @return [Hash{:url => String, nil}]
+    #
+    def self.options
+      # Check whether the remote chrome is running and configure the Capybara
+      # driver for it.
+      remote_chrome ? {url: url} : {}
+    end
+
+    # Whether or not the socket could be connected
+    # @return [Boolean]
+    def self.remote_chrome
+      if url.nil?
+        false
+      else
+        Socket.tcp(host, port, connect_timeout: 1).close
+        true
+      end
+    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError
+      false
+    end
+  end
+end

data/lib/evil_systems/session_helpers.rb

@@ -0,0 +1,14 @@
+module EvilSystems
+  # Capybara Sessions are limited, lets add some extra helpers.
+  module SessionHelpers
+    # Convencience method for session names.
+    def within_session(name_or_session, &block)
+      ::Capybara.using_session(name_or_session, &block)
+    end
+
+    # Remove all banners
+    def mark_all_banners_as_read!
+      page.driver.set_cookie "show_banners", "N"
+    end
+  end
+end

data/lib/evil_systems/settings.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module EvilSystems
+  # Capybara settings (not covered by Rails system tests)
+  module Settings
+    # Finds the current app host via ENV["APP_HOST"], `hostname`, or defaults to "0.0.0.0"
+    # @return [String]
+    def self.app_host
+      "http://#{ENV.fetch("APP_HOST", `hostname`&.strip&.downcase || "0.0.0.0")}"
+    end
+
+    # Finds the current cookie domain
+    # @return [String]
+    def self.cookie_domain
+      URI.parse(app_host).host.then do |host|
+        # If host is a top-level domain
+        next host unless host.include?(".")
+
+        ".#{host}"
+      end
+    end
+
+    # The setup to be run prior to the test suite
+    def self.initial_setup
+      prepend_session_to_capybara
+
+      ::Capybara.app_host = app_host
+
+      # Make server listening on all hosts
+      ::Capybara.server_host = "0.0.0.0"
+
+      # Don't wait too long in `have_xyz` matchers
+      ::Capybara.default_max_wait_time = 2
+
+      # Normalizes whitespaces when using `has_text?` and similar matchers
+      ::Capybara.default_normalize_ws = true
+
+      # Where to store artifacts (e.g. screenshots, downloaded files, etc.)
+      ::Capybara.save_path = ENV.fetch("CAPYBARA_ARTIFACTS", "./tmp/capybara")
+    end
+
+    private_class_method def self.prepend_session_to_capybara
+      ::Capybara.singleton_class.prepend(Module.new do
+        attr_accessor :last_used_session
+
+        def using_session(name, &block)
+          self.last_used_session = name
+          super
+        ensure
+          self.last_used_session = nil
+        end
+      end)
+    end
+  end
+end

data/lib/evil_systems/version.rb

@@ -0,0 +1,3 @@
+module EvilSystems
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: evil_systems
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ParamagicDev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: 
+email:
+- konnor5456@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/evil_systems.rb
+- lib/evil_systems/cuprite_helpers.rb
+- lib/evil_systems/engine.rb
+- lib/evil_systems/helpers.rb
+- lib/evil_systems/precompile_assets.rb
+- lib/evil_systems/register_cuprite.rb
+- lib/evil_systems/remote_chrome.rb
+- lib/evil_systems/session_helpers.rb
+- lib/evil_systems/settings.rb
+- lib/evil_systems/version.rb
+homepage: https://github.com/paramagicdev/evil_systems
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/paramagicdev/evil_systems
+  source_code_uri: https://github.com/paramagicdev/evil_systems
+  changelog_uri: https://github.com/paramagicdev/evil_systems/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Fully integrated setup based on EvilMartians system of a test
+test_files: []