Merge pull request #12 from hoppergee/rails_miniest_integration

hoppergee · web-flow · commit 4f5d3ac99a6a · 2021-10-10T02:11:18.000+08:00
Rails Miniest/Rspec integration
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
@@ -71,4 +71,5 @@ jobs:
       -
         name: Run minitest
         run: |
+          bundle exec rspec test
           bundle exec rake
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [1.3.0] - 2021-10-10
+
+- Integrate with Rails default testing toolchain (Minitest + Capybara)
+- Integrate with RSpec + Capybara
 
 ## [1.2.0] - 2021-10-08
 
diff --git a/Gemfile b/Gemfile
@@ -10,6 +10,14 @@ group :development do
 end
 
 # To use a debugger
-gem 'byebug', group: [:development, :test]
-gem 'minitest-focus', group: [:test]
-gem 'sidekiq', group: [:test]
+group :development, :test do
+  gem 'byebug'
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'sidekiq'
+end
+
+group :test do
+  gem 'minitest-focus'
+end
diff --git a/README.md b/README.md
@@ -237,6 +237,12 @@ MultiTenantSupport.under_tenant amazon do
 end
 ```
 
+### Set current tenant global
+
+```ruby
+MultiTenantSupport::Current.tenant_account = account
+```
+
 ### Disallow read across tenant by default
 
 This gem disallow read across tenant by default. You can check current state through:
@@ -329,6 +335,44 @@ Console does not allow read across tenant by default. But you have several ways
     $ irb(main):001:0> MultiTenantSupport.allow_read_across_tenant
     ```
 
+## Testing
+### Minitest (Rails default)
+
+```ruby
+# test/test_helper.rb
+require 'multi_tenant_support/minitet'
+```
+### RSpec (with Capybara)
+
+```ruby
+# spec/rails_helper.rb or spec/spec_helper.rb
+require 'multi_tenant_support/rspec'
+```
+
+Above code will make sure the `MultiTenantSupport.current_tenant` won't accidentally be reset during integration and system tests. For example:
+
+With above testing requre code
+
+```ruby
+# Integration test
+test "a integration test" do
+  host! "apple.example.com"
+
+  assert_no_changes "MultiTenantSupport.current_tenant" do
+    get users_path
+  end
+end
+
+# System test
+test "a system test" do
+  Capybara.app_host = "http://apple.example.com"
+
+  assert_no_changes "MultiTenantSupport.current_tenant" do
+    visit users_path
+  end
+end
+```
+
 ## Code Example
 
 ### Database Schema
diff --git a/gemfiles/docker-compose/rails-6-0-Gemfile b/gemfiles/docker-compose/rails-6-0-Gemfile
@@ -11,6 +11,13 @@ group :development do
 end
 
 # To use a debugger
-gem 'byebug', group: [:development, :test]
-gem 'minitest-focus', group: [:test]
-gem 'sidekiq', group: [:test]
+group :development, :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'sidekiq'
+end
+
+group :test do
+  gem 'minitest-focus'
+end
diff --git a/gemfiles/docker-compose/rails-6-1-Gemfile b/gemfiles/docker-compose/rails-6-1-Gemfile
@@ -11,6 +11,13 @@ group :development do
 end
 
 # To use a debugger
-gem 'byebug', group: [:development, :test]
-gem 'minitest-focus', group: [:test]
-gem 'sidekiq', group: [:test]
+group :development, :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'sidekiq'
+end
+
+group :test do
+  gem 'minitest-focus'
+end
diff --git a/gemfiles/docker-compose/rails-master-Gemfile b/gemfiles/docker-compose/rails-master-Gemfile
@@ -11,6 +11,13 @@ group :development do
 end
 
 # To use a debugger
-gem 'byebug', group: [:development, :test]
-gem 'minitest-focus', group: [:test]
-gem 'sidekiq', group: [:test]
+group :development, :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'sidekiq'
+end
+
+group :test do
+  gem 'minitest-focus'
+end
diff --git a/gemfiles/github-action/rails-6.0-Gemfile b/gemfiles/github-action/rails-6.0-Gemfile
@@ -11,6 +11,13 @@ group :development do
 end
 
 # To use a debugger
-gem 'byebug', group: [:development, :test]
-gem 'minitest-focus', group: [:test]
-gem 'sidekiq', group: [:test]
+group :development, :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'sidekiq'
+end
+
+group :test do
+  gem 'minitest-focus'
+end
diff --git a/gemfiles/github-action/rails-6.1-Gemfile b/gemfiles/github-action/rails-6.1-Gemfile
@@ -11,6 +11,13 @@ group :development do
 end
 
 # To use a debugger
-gem 'byebug', group: [:development, :test]
-gem 'minitest-focus', group: [:test]
-gem 'sidekiq', group: [:test]
+group :development, :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'sidekiq'
+end
+
+group :test do
+  gem 'minitest-focus'
+end
diff --git a/gemfiles/github-action/rails-master-Gemfile b/gemfiles/github-action/rails-master-Gemfile
@@ -11,6 +11,13 @@ group :development do
 end
 
 # To use a debugger
-gem 'byebug', group: [:development, :test]
-gem 'minitest-focus', group: [:test]
-gem 'sidekiq', group: [:test]
+group :development, :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'sidekiq'
+end
+
+group :test do
+  gem 'minitest-focus'
+end
diff --git a/lib/multi_tenant_support/minitest.rb b/lib/multi_tenant_support/minitest.rb
@@ -0,0 +1,7 @@
+require_relative "./test/integration"
+require_relative "./test/system"
+require_relative "./test/capybara"
+
+ActionDispatch::IntegrationTest.prepend(MultiTenantSupport::Test::Integration)
+ActionDispatch::SystemTestCase.prepend(MultiTenantSupport::Test::System)
+Capybara::Node::Element.prepend(MultiTenantSupport::Test::Capybara)
diff --git a/lib/multi_tenant_support/rspec.rb b/lib/multi_tenant_support/rspec.rb
@@ -0,0 +1,13 @@
+require_relative "./test/integration"
+require_relative "./test/system"
+require_relative "./test/capybara"
+
+RSpec.configure do |config|
+  config.include MultiTenantSupport::Test::Integration, type: :request
+  config.include MultiTenantSupport::Test::Integration, type: :controller
+
+  config.include MultiTenantSupport::Test::System, type: :system
+  config.include MultiTenantSupport::Test::System, type: :feature
+end
+
+Capybara::Node::Element.prepend(MultiTenantSupport::Test::Capybara)
diff --git a/lib/multi_tenant_support/test/capybara.rb b/lib/multi_tenant_support/test/capybara.rb
@@ -0,0 +1,57 @@
+module MultiTenantSupport
+  module Test
+    module Capybara
+
+      def set(value, **options)
+        keep_context_tenant_unchange do
+          super(value, **options)
+        end
+      end
+
+      def select_option(wait: nil)
+        keep_context_tenant_unchange do
+          super(wait: wait)
+        end
+      end
+
+      def unselect_option(wait: nil)
+        keep_context_tenant_unchange do
+          super(wait: wait)
+        end
+      end
+
+      def perform_click_action(keys, wait: nil, **options)
+        keep_context_tenant_unchange do
+          super
+        end
+      end
+
+      def trigger(event)
+        keep_context_tenant_unchange do
+          super
+        end
+      end
+
+      def evaluate_script(script, *args)
+        keep_context_tenant_unchange do
+          super
+        end
+      end
+
+      def evaluate_async_script(script, *args)
+        keep_context_tenant_unchange do
+          super
+        end
+      end
+
+      def keep_context_tenant_unchange
+        _current_tenant = MultiTenantSupport::Current.tenant_account
+        MultiTenantSupport::Current.tenant_account = nil # Simulate real circumstance
+        yield
+      ensure
+        MultiTenantSupport::Current.tenant_account = _current_tenant
+      end
+
+    end
+  end
+end
diff --git a/lib/multi_tenant_support/test/integration.rb b/lib/multi_tenant_support/test/integration.rb
@@ -0,0 +1,29 @@
+module MultiTenantSupport
+  module Test
+    module Integration
+
+      %i[get post patch put delete head options].each do |method|
+        define_method method do |path, **args|
+          keep_context_tenant_unchange do
+            super(path, **args)
+          end
+        end
+      end
+    
+      def follow_redirect(**args)
+        keep_context_tenant_unchange do
+          super(**args)
+        end
+      end
+
+      def keep_context_tenant_unchange
+        _current_tenant = MultiTenantSupport::Current.tenant_account
+        MultiTenantSupport::Current.tenant_account = nil # Simulate real circumstance
+        yield
+      ensure
+        MultiTenantSupport::Current.tenant_account = _current_tenant
+      end
+
+    end
+  end
+end
diff --git a/lib/multi_tenant_support/test/system.rb b/lib/multi_tenant_support/test/system.rb
@@ -0,0 +1,38 @@
+module MultiTenantSupport
+  module Test
+    module System
+
+      %i[
+        visit refresh click_on go_back go_forward
+        check choose click_button click_link
+        fill_in uncheck check unselect select
+        execute_script evaluate_script
+      ].each do |method|
+        if RUBY_VERSION >= '2.7'
+          class_eval <<~METHOD, __FILE__, __LINE__ + 1
+            def #{method}(...)
+              keep_context_tenant_unchange do
+                super(...)
+              end
+            end
+          METHOD
+        else
+          define_method method do |*args, &block|
+            keep_context_tenant_unchange do
+              super(*args, &block)
+            end
+          end
+        end
+      end
+
+      def keep_context_tenant_unchange
+        _current_tenant = MultiTenantSupport::Current.tenant_account
+        MultiTenantSupport::Current.tenant_account = nil # Simulate real circumstance
+        yield
+      ensure
+        MultiTenantSupport::Current.tenant_account = _current_tenant
+      end
+
+    end
+  end
+end
diff --git a/lib/multi_tenant_support/version.rb b/lib/multi_tenant_support/version.rb
@@ -1,3 +1,3 @@
 module MultiTenantSupport
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end
diff --git a/test/dummy/app/controllers/users_controller.rb b/test/dummy/app/controllers/users_controller.rb
@@ -1,4 +1,22 @@
 class UsersController < ApplicationController
   def index
   end
+
+  def new
+  end
+
+  def edit
+  end
+
+  def create
+    redirect_to users_path
+  end
+
+  def update
+    redirect_to users_path
+  end
+
+  def destroy
+    redirect_to users_path
+  end
 end
diff --git a/test/dummy/app/views/users/edit.html.erb b/test/dummy/app/views/users/edit.html.erb
@@ -0,0 +1 @@
+<h1>User - Edit</h1>
diff --git a/test/dummy/app/views/users/index.html.erb b/test/dummy/app/views/users/index.html.erb
@@ -2,4 +2,6 @@
 <div id="id"><%= current_tenant_account.id %></div>
 <div id="name"><%= current_tenant_account.name %></div>
 <div id="domain"><%= current_tenant_account.domain %></div>
-<div id="subdomain"><%= current_tenant_account.subdomain %></div>
+<div id="subdomain"><%= current_tenant_account.subdomain %></div>
+
+<%= link_to "Show", user_path(id: 1) %>
diff --git a/test/dummy/app/views/users/new.html.erb b/test/dummy/app/views/users/new.html.erb
@@ -0,0 +1 @@
+<h1>User - New</h1>
diff --git a/test/dummy/app/views/users/show.html.erb b/test/dummy/app/views/users/show.html.erb
@@ -0,0 +1 @@
+<h1>User - Show</h1>
diff --git a/test/dummy/config/environments/development.rb b/test/dummy/config/environments/development.rb
diff --git a/test/dummy/config/initializers/assets.rb b/test/dummy/config/initializers/assets.rb
diff --git a/test/integration/current_tenant_protect_during_integration_test.rb b/test/integration/current_tenant_protect_during_integration_test.rb
diff --git a/test/integration/current_tenant_protect_during_integration_test_spec.rb b/test/integration/current_tenant_protect_during_integration_test_spec.rb
diff --git a/test/spec_helper.rb b/test/spec_helper.rb
diff --git a/test/system/current_tenant_protect_during_system_test.rb b/test/system/current_tenant_protect_during_system_test.rb
diff --git a/test/system/current_tenant_protect_during_system_test_spec.rb b/test/system/current_tenant_protect_during_system_test_spec.rb
diff --git a/test/test_helper.rb b/test/test_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -71,4 +71,5 @@ jobs:`
`71`	`71`	`-`
`72`	`72`	`name: Run minitest`
`73`	`73`	`run: \|`
	`74`	`+ bundle exec rspec test`
`74`	`75`	`bundle exec rake`