keycloak_ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b7102d00536558b7b36e60884ddf78f31c675c2a16e02662fc907b234ee1913
-  data.tar.gz: 5d354bc56a1639a26b63bb5c3699580effded5bc0601a8679c8036fa192b4e7d
+  metadata.gz: dab863bc25bb5a8c853b4792d3b190c473718e4435e3123150ea04cf3e7d135b
+  data.tar.gz: fa732b217abe15b324be2b173b740dc2e54743ee9a7a430258b603c8dfa68fc5
 SHA512:
-  metadata.gz: 36dae08b9022816c03ba59fb3fb2c9578641743c183162a70d6f1f009c0399d9dd66fcb56174c648d4a454b26986957bce9e76cb2614f9871d1d17282ec00db1
-  data.tar.gz: 801fa2a2d87504cda27a7cdbc39054f821734bf75ab656244e414e4982bc59ef3b2ff5117f6de4de77f9fbe8d0b8e8502436f1ca1811bc2eeadb32d8cabab7db
+  metadata.gz: fabda0c8e26181776ca2846b75985b84dd320aef47437f4ee6d617f3f5d58cf95454079163cbca733dab44fd392853e44f0c5c84a0a32f25763cd4373d2c78cd
+  data.tar.gz: 660fc8396f0456432b6722b66517a58a48768517b5f559d9741e93081eba8aa4817650a1da26c9d44ffe317071217c167ecd7b764da12547ee9a0caf957e9719

data/README.md

@@ -181,3 +181,36 @@ For test purpose there mock helper sign_in(user)
 
 - add `require "keycloak_ruby/testing/keycloak_helpers"` to keycloak_helper.rb
 - add sign_in in tests `config.include KeycloakRuby::Testing::KeycloakHelpers`
+
+### Fast test login
+
+По умолчанию `sign_in` в браузерных тестах (`:feature` / `:system`) проходит полный цикл через OmniAuth.
+Чтобы ускорить тесты, можно включить быстрый логин через Rack-middleware — он записывает фейковые токены
+прямо в сессию, минуя OmniAuth и Keycloak.
+
+Добавьте в `config/keycloak.yml`:
+
+```yaml
+test:
+  fast_test_login: true
+  # ... остальные параметры
+```
+
+После этого `sign_in(user)` в feature/system тестах будет использовать middleware вместо полного входа.
+
+Если в отдельном тесте нужно проверить сам логин (flash-сообщения, редиректы и т.д.),
+используйте `full_sign_in(user)` — он всегда проходит полный цикл через OmniAuth.
+
+```ruby
+# Большинство тестов — быстрый вход (при fast_test_login: true)
+sign_in(user)
+
+# Тесты, проверяющие логин
+full_sign_in(user)
+```
+
+| Тип теста | `sign_in` (fast_test_login: true) | `sign_in` (fast_test_login: false) | `full_sign_in` |
+|---|---|---|---|
+| `:feature` / `:system` | Middleware — сессия напрямую | OmniAuth mock → visit /login → клик | OmniAuth mock → visit /login → клик |
+| `:request` | `mock_token_service` | `mock_token_service` | `mock_token_service` |
+| `:controller` и др. | `mock_token_service` | `mock_token_service` | `mock_keycloak_login` без Capybara |

data/lib/keycloak_ruby/config.rb

@@ -50,7 +50,8 @@ module KeycloakRuby
                   :admin_client_id,
                   :admin_client_secret,
                   :oauth_client_id,
-                  :oauth_client_secret
+                  :oauth_client_secret,
+                  :fast_test_login
 
     attr_reader :config_path
 

data/lib/keycloak_ruby/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module KeycloakRuby
+  # Подключает middleware для быстрого логина в тестах.
+  # Включается только если в конфиге стоит fast_test_login: true
+  class Railtie < ::Rails::Railtie
+    initializer "keycloak_ruby.test_login_middleware" do |app|
+      if Rails.env.test? && KeycloakRuby.config.fast_test_login
+        require "keycloak_ruby/testing/login_middleware"
+        app.middleware.insert_before ActionDispatch::Flash, KeycloakRuby::Testing::LoginMiddleware
+      end
+    end
+  end
+end

data/lib/keycloak_ruby/request_params.rb

@@ -10,7 +10,6 @@ module KeycloakRuby
     :body,
     :success_codes,
     :error_class,
-    :error_message,
-    keyword_init: true
+    :error_message
   )
 end

data/lib/keycloak_ruby/testing/keycloak_helpers.rb

@@ -4,16 +4,30 @@
 # :reek:UtilityFunction :reek:ControlParameter :reek:ManualDispatch :reek:BooleanParameter :reek:LongParameterList
 module KeycloakRuby
   module Testing
-    # Helper module for tests with Keycloak
+    # Хелперы для тестов с Keycloak
     module KeycloakHelpers
-      # Combines both sign-in approaches with automatic detection of test type
+      # Быстрый вход: если включён fast_test_login, для браузерных тестов
+      # устанавливает сессию через middleware без OmniAuth.
+      # Если флаг выключен — идёт через полный логин.
+      # Для остальных типов тестов — мокирует TokenService.
       def sign_in(user, test_type: auto_detect_test_type)
+        case test_type
+        when :feature, :system
+          fast_login_enabled? ? visit("/__test_login__/#{user.id}") : full_sign_in(user, test_type:)
+        else
+          mock_token_service(user)
+        end
+      end
+
+      # Полная процедура входа через OmniAuth для тестов, которые проверяют сам логин.
+      # Проходит /login → OmniAuth callback → SessionsController#create.
+      def full_sign_in(user, test_type: auto_detect_test_type)
         case test_type
         when :request
           mock_token_service(user)
         when :feature, :system
           mock_keycloak_login(user, use_capybara: true)
-        else # :controller, :view, etc.
+        else
           mock_keycloak_login(user, use_capybara: false)
         end
       end
@@ -31,9 +45,9 @@ module KeycloakRuby
         user_data
       end
 
-      # Delete all users from Keycloak
+      # Удаление всех пользователей из Keycloak
       def self.delete_all_keycloak_users
-        users = KeycloakRuby::User.find("") # Empty search string to find all users
+        users = KeycloakRuby::User.find("") # Пустая строка — ищем всех
         users.each do |user|
           KeycloakRuby::User.delete_by_id(user["id"])
         end
@@ -107,17 +121,21 @@ module KeycloakRuby
           :feature
         end
       end
+
+      def fast_login_enabled?
+        KeycloakRuby.config.fast_test_login
+      end
     end
   end
 end
-# Automatically include in common test frameworks
+# Автоматическое подключение хелперов в тестовые фреймворки
 if defined?(RSpec)
   RSpec.configure do |config|
     config.include KeycloakRuby::Testing::KeycloakHelpers
   end
 elsif defined?(Minitest)
   module Minitest
-    # Include helpers in minitest module
+    # Подключение хелперов в Minitest
     class Test
       include KeycloakRuby::Testing::KeycloakHelpers
     end

data/lib/keycloak_ruby/testing/login_middleware.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module KeycloakRuby
+  module Testing
+    # Rack-middleware для быстрой аутентификации в тестах.
+    # Записывает токены в сессию напрямую, минуя OmniAuth и Keycloak.
+    #
+    # Подключается автоматически в test-окружении через KeycloakRuby::Railtie.
+    # Используется хелпером sign_in для браузерных тестов (:feature/:system).
+    #
+    # Было:  visit /login → рендер HTML → клик → OmniAuth → SessionsController → редирект
+    # Стало: visit /__test_login__/123 → запись сессии → 200 OK
+    class LoginMiddleware
+      TEST_LOGIN_PATH = %r{\A/__test_login__/(\d+)\z}
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if (match = env["PATH_INFO"].match(TEST_LOGIN_PATH))
+          handle_test_login(env, match[1].to_i)
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def handle_test_login(env, user_id)
+        user = ::User.find(user_id)
+        fill_session(env, user)
+        [200, { "Content-Type" => "text/plain" }, ["Logged in"]]
+      rescue ActiveRecord::RecordNotFound
+        [404, { "Content-Type" => "text/plain" }, ["Test login failed: User #{user_id} not found"]]
+      end
+
+      # :reek:UtilityFunction
+      def fill_session(env, user)
+        email = user.email
+        expired_time = 2.hours.from_now.to_i
+        token_payload = { "email" => email, "exp" => expired_time }
+
+        session = env["rack.session"]
+        session[:access_token] = JWT.encode(token_payload, nil, "none")
+        session[:refresh_token] = "fake-refresh-#{email}"
+        session[:id_token] = "fake-id-#{email}"
+      end
+    end
+  end
+end

data/lib/keycloak_ruby/version.rb

@@ -6,7 +6,7 @@ module KeycloakRuby
   # Follows Semantic Versioning 2.0 (https://semver.org)
   # @example
   #   KeycloakRuby::VERSION # => "0.1.3"
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 
   # Provides version information and comparison methods for the KeycloakRuby gem.
   # This module follows Semantic Versioning 2.0 guidelines.

data/lib/keycloak_ruby.rb

@@ -11,11 +11,13 @@ require "omniauth/rails_csrf_protection/railtie" if defined?(Rails)
 loader = Zeitwerk::Loader.for_gem
 loader.ignore(
   "#{__dir__}/generators",
-  "#{__dir__}/templates"
+  "#{__dir__}/templates",
+  "#{__dir__}/keycloak_ruby/railtie.rb"
 )
 loader.setup
 
 require "generators/keycloak_ruby/install_generator" if defined?(Rails)
+require "keycloak_ruby/railtie" if defined?(Rails::Railtie)
 
 # Module for interacting with Keycloak
 module KeycloakRuby

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keycloak_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sergey Arkhipov
@@ -133,11 +133,13 @@ files:
 - lib/keycloak_ruby/client.rb
 - lib/keycloak_ruby/config.rb
 - lib/keycloak_ruby/errors.rb
+- lib/keycloak_ruby/railtie.rb
 - lib/keycloak_ruby/request_params.rb
 - lib/keycloak_ruby/request_performer.rb
 - lib/keycloak_ruby/response_validator.rb
 - lib/keycloak_ruby/testing.rb
 - lib/keycloak_ruby/testing/keycloak_helpers.rb
+- lib/keycloak_ruby/testing/login_middleware.rb
 - lib/keycloak_ruby/token_refresher.rb
 - lib/keycloak_ruby/token_service.rb
 - lib/keycloak_ruby/user.rb