evil_systems 0.0.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c39ae0b47c7d330afb6daa3ef1c8137d190f861905a4a3cdc45305740927ec1
-  data.tar.gz: e3c40f2764522b1796d11053aecd530267704d87f0ce6732b7d58374a2c030e9
+  metadata.gz: c6d3ebd5d518e616a3322a78a4556837b8b81866832e0b6436098c838142d183
+  data.tar.gz: 64b2e8ecd7f030691ec8e8a81dd088fb42cb79d9933cf0d6fcc1a9bc2ddd99a3
 SHA512:
-  metadata.gz: fed0a5eebfba465c8d2d36228e7b05e6da431a464ee540b34f867c34e64d6263e7cc52d7e9612b679c198514f81ae1fbaff833dc8430600a561e89617ad8a407
-  data.tar.gz: 992f7b9646ecf70c5c07c032f40af6422e52785897ef7cc29c56cc45b08f875e684fec1a5a9b90c81687a1a67b660159fb3bde20490f7f8e9d2226aea59101f5
+  metadata.gz: 45ad267ef6df0f634912e658384d19a5ec4f5422becbd7e9e413d6a8dffe3a130d0bcb2b55faa4f8ebfe598ed56e80b7757b342594de18a63b544a52ba34f31e
+  data.tar.gz: f3e7f6da2b5ccaaebe13cb26d35907dc05d38673492f874d0fc317c39c7899a2e8ad206f417b095db1b84e55c5cb9c91b920af66e89450ed3b7b35ddf68a45ef

data/CHANGELOG.md

@@ -1,3 +1,16 @@
-## 0.0.1
+## 0.1.1
+
+- Fix readme issue
+- Remove mark_all_banners_as_read
+- Remove selenium-webdriver
+
+## 0.1.0
+
+- Allow the Cuprite driver to be configured with ENV variables for headless mode and process_timeouts.
+- Increase process_timeout default to 5
+- Add GH actions testing with a remote chrome instance
+- Minor API cleanup
+
+## 0.0.3
 
 Initial release!

data/README.md

@@ -1,20 +1,44 @@
-# EvilSystemTests
+# Purpose
 
-Why does this exist?
+I write tests using Minitest and routinely reference [EvilMartians System
+of a Test blog post](https://evilmartians.com/chronicles/system-of-a-test-setting-up-end-to-end-rails-testing)
+for best practices for system tests. In this blog post,
+they also have an opinionated way of setting up System Tests.
 
-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.
+`EvilSystems` offers 3 distinct advantages over the setup provided by
+EvilMartians System of a Test:
+
+1.) The blog post was built with RSpec in mind, but we use Minitest
+here!
+
+2.) Constantly copying 5 files over into every new Rails app is annoying. Lets make that easier!
+
+3.) File changes can end up out of sync, a gem makes sure updates can be
+pushed to all users.
+
+`EvilSystems` is a quick, easy, reusable way to apply the SoaT concepts and settings
+to projects for system tests using Minitest.
 
 Full API documentation can be found here:
 
+https://rdoc.info/github/paramagicdev/evil_systems/main
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```ruby
+# Gemfile
+group :test do
+  gem 'evil_systems', '~> 0.1.0'
+end
+```
+
+Make sure the following 3 gems are in your `Gemfile` as well:
 
 ```ruby
-gem 'evil_system_tests'
+# Gemfile
+gem 'capybara'
+gem 'cuprite' # Optional
+gem 'selenium-webdriver' # Not required if using Cuprite and using Rails >= 6.1
 ```
 
 And then execute:
@@ -31,25 +55,23 @@ Navigate to `test/application_system_test_case.rb` in your Rails app.
 
 Setup your file like so:
 
-```rb
+```ruby
 # 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'
+# 'capybara' and 'capybara/cuprite' need to be defined for EvilSystems to work properly.
+require 'capybara'
+require 'capybara/cuprite'
 
-+ require 'evil_systems'
+require 'evil_systems'
 
-+ EvilSystems.initial_setup
+EvilSystems.initial_setup
 
 class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
--  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
-+  driven_by :cuprite
+  driven_by :cuprite
 
-+ include EvilSystems::Helpers
+  include EvilSystems::Helpers
 end
 ```
 
@@ -65,18 +87,28 @@ end
 `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.
+are compiling, and how long the compilation took.
+
 `:task` defaults to `assets:precompile`, System of a test uses
 `webpacker:compile`.
 
+Example:
+
+```rb
+EvilSystems.initial_setup(task: "webpacker:compile", silent: false)
+```
+
 ### Settings
 
-[x] - Automatically registers a `:cuprite` driver if `Capybara::Cuprite`
+- [x] - Automatically registers a `:cuprite` driver if `Capybara::Cuprite`
 is defined.
-[x] - Automatically sets Capybara's default and javascript driver to
+
+- [x] - Automatically sets Capybara's default and javascript driver to
 `:cuprite`
-[x] - Automatically sets `Capybara.app_host`
+
+- [x] - Automatically sets `Capybara.app_host`
 
 <details>
 <summary>How `app_host` is set</summary>
@@ -87,14 +119,17 @@ 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.
+- [x] - `Capybara.server_host = "0.0.0.0"` Make server listening on all hosts
+
+- [x] - `Capybara.default_max_wait_time = 2` Dont spend forever waiting for matchers
+
+- [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
 
@@ -129,12 +164,8 @@ dom_id(*args)
 #### SessionHelpers
 
 ```rb
-# Small wrapper around Capybara.using_session thats easy to call from an
-instance
+# 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
@@ -144,21 +175,22 @@ mark_all_banners_as_read!
 pause
 
 # Opens a Pry or IRB repl. Will use Pry if Pry is defined, fallsback
-to debugging with IRB
-debug
+# to debugging with IRB
+debug binding
 ```
 
 ### Env Variables
 
+ENV variables used by this gem.
+
 ```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["CHROME_URL"] # used for setting a remote chrome instance for Cuprite
+ENV["PROCESS_TIMEOUT"] # How long to wait before killing the process, default is 5 seconds
+ENV["CI"] # Whether or not to run Cuprite in headless mode, defaults to true.
 ```
 
-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

data/lib/evil_systems/register_cuprite.rb

@@ -12,13 +12,22 @@ module EvilSystems
     def self.initial_setup
       return unless defined? Capybara::Cuprite
 
+      begin
+        process_timeout = Integer(ENV.fetch("PROCESS_TIMEOUT", 5))
+      rescue
+        process_timeout = 5
+      end
+
       remote_options = RemoteChrome.options
+
       ::Capybara.register_driver(:cuprite) do |app|
         ::Capybara::Cuprite::Driver.new(
           app,
           **{
             window_size: [1200, 800],
-            browser_options: {"no-sandbox" => nil},
+            browser_options: RemoteChrome.connected? ? {"no-sandbox" => nil} : {},
+            headless: ENV.fetch("CI", "true") == "true",
+            process_timeout: process_timeout,
             inspector: true
           }.merge(remote_options)
         )

data/lib/evil_systems/remote_chrome.rb

@@ -23,12 +23,12 @@ module EvilSystems
     def self.options
       # Check whether the remote chrome is running and configure the Capybara
       # driver for it.
-      remote_chrome ? {url: url} : {}
+      connected? ? {url: url} : {}
     end
 
     # Whether or not the socket could be connected
     # @return [Boolean]
-    def self.remote_chrome
+    def self.connected?
       if url.nil?
         false
       else

data/lib/evil_systems/session_helpers.rb

@@ -5,10 +5,5 @@ module EvilSystems
     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

@@ -29,6 +29,9 @@ module EvilSystems
       # Make server listening on all hosts
       ::Capybara.server_host = "0.0.0.0"
 
+      # Silence puma
+      ::Capybara.server = :puma, {Silent: true}
+
       # Don't wait too long in `have_xyz` matchers
       ::Capybara.default_max_wait_time = 2
 

data/lib/evil_systems/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evil_systems
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ParamagicDev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Fully integrated setup based on EvilMartians system of a test