7263da542b
Replaced by `#lease_connection` to better reflect what it does. `ActiveRecord::Base#connection` is deprecated in the same way but without a removal timeline nor a deprecation warning. Inside the Active Record test suite, we do remove `Base.connection` to ensure it's not used internally. Some callsites have been converted to use `with_connection`, some other have been more simply migrated to `lease_connection` and will serve as a list of callsites to convert for https://github.com/rails/rails/pull/50793
272 lines
6.6 KiB
Ruby
272 lines
6.6 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "tempfile"
|
|
|
|
require "isolation/abstract_unit"
|
|
require "console_helpers"
|
|
|
|
class ConsoleTest < ActiveSupport::TestCase
|
|
include ActiveSupport::Testing::Isolation
|
|
|
|
def setup
|
|
build_app
|
|
end
|
|
|
|
def teardown
|
|
teardown_app
|
|
end
|
|
|
|
def load_environment(sandbox = false)
|
|
require "#{rails_root}/config/environment"
|
|
Rails.application.sandbox = sandbox
|
|
Rails.application.load_console
|
|
end
|
|
|
|
def irb_context
|
|
Object.new.extend(Rails::ConsoleMethods)
|
|
end
|
|
|
|
def test_app_method_should_return_integration_session
|
|
TestHelpers::Rack.remove_method :app
|
|
load_environment
|
|
console_session = irb_context.app
|
|
assert_instance_of ActionDispatch::Integration::Session, console_session
|
|
end
|
|
|
|
def test_app_can_access_path_helper_method
|
|
app_file "config/routes.rb", <<-RUBY
|
|
Rails.application.routes.draw do
|
|
get 'foo', to: 'foo#index'
|
|
end
|
|
RUBY
|
|
|
|
load_environment
|
|
console_session = irb_context.app
|
|
assert_equal "/foo", console_session.foo_path
|
|
end
|
|
|
|
def test_new_session_should_return_integration_session
|
|
load_environment
|
|
session = irb_context.new_session
|
|
assert_instance_of ActionDispatch::Integration::Session, session
|
|
end
|
|
|
|
def test_reload_should_fire_preparation_and_cleanup_callbacks
|
|
load_environment
|
|
a = b = c = nil
|
|
|
|
# TODO: These should be defined on the initializer
|
|
ActiveSupport::Reloader.to_complete { a = b = c = 1 }
|
|
ActiveSupport::Reloader.to_complete { b = c = 2 }
|
|
ActiveSupport::Reloader.to_prepare { c = 3 }
|
|
|
|
irb_context.reload!(false)
|
|
|
|
assert_equal 1, a
|
|
assert_equal 2, b
|
|
assert_equal 3, c
|
|
end
|
|
|
|
def test_reload_should_reload_constants
|
|
app_file "app/models/user.rb", <<-MODEL
|
|
class User
|
|
attr_accessor :name
|
|
end
|
|
MODEL
|
|
|
|
load_environment
|
|
assert_respond_to User.new, :name
|
|
|
|
app_file "app/models/user.rb", <<-MODEL
|
|
class User
|
|
attr_accessor :name, :age
|
|
end
|
|
MODEL
|
|
|
|
assert_not_respond_to User.new, :age
|
|
irb_context.reload!(false)
|
|
assert_respond_to User.new, :age
|
|
end
|
|
|
|
def test_access_to_helpers
|
|
load_environment
|
|
helper = irb_context.helper
|
|
assert_not_nil helper
|
|
assert_instance_of ActionView::Base, helper
|
|
assert_equal "Once upon a time in a world...",
|
|
helper.truncate("Once upon a time in a world far far away")
|
|
end
|
|
end
|
|
|
|
class FullStackConsoleTest < ActiveSupport::TestCase
|
|
include ConsoleHelpers
|
|
|
|
def setup
|
|
skip "PTY unavailable" unless available_pty?
|
|
|
|
build_app
|
|
app_file "app/models/post.rb", <<-CODE
|
|
class Post < ActiveRecord::Base
|
|
end
|
|
CODE
|
|
system "#{app_path}/bin/rails runner 'Post.lease_connection.create_table :posts'"
|
|
|
|
@primary, @replica = PTY.open
|
|
end
|
|
|
|
def teardown
|
|
teardown_app
|
|
end
|
|
|
|
def write_prompt(command, expected_output = nil)
|
|
@primary.puts command
|
|
assert_output command, @primary
|
|
assert_output expected_output, @primary, 100 if expected_output
|
|
assert_output "> ", @primary
|
|
end
|
|
|
|
def spawn_console(options, wait_for_prompt: true, env: {})
|
|
pid = Process.spawn(
|
|
{ "TERM" => "dumb" }.merge(env),
|
|
"#{app_path}/bin/rails console #{options}",
|
|
in: @replica, out: @replica, err: @replica
|
|
)
|
|
|
|
if wait_for_prompt
|
|
assert_output "> ", @primary, 30
|
|
end
|
|
|
|
pid
|
|
end
|
|
|
|
def test_sandbox
|
|
options = "--sandbox"
|
|
spawn_console(options)
|
|
|
|
write_prompt "Post.count", "=> 0"
|
|
write_prompt "Post.create"
|
|
write_prompt "Post.count", "=> 1"
|
|
@primary.puts "quit"
|
|
|
|
spawn_console(options)
|
|
|
|
write_prompt "Post.count", "=> 0"
|
|
write_prompt "Post.transaction { Post.create; raise }"
|
|
write_prompt "Post.count", "=> 0"
|
|
@primary.puts "quit"
|
|
end
|
|
|
|
def test_sandbox_when_sandbox_is_disabled
|
|
add_to_config <<-RUBY
|
|
config.disable_sandbox = true
|
|
RUBY
|
|
|
|
output = `#{app_path}/bin/rails console --sandbox`
|
|
|
|
assert_includes output, "sandbox mode is disabled"
|
|
assert_equal 1, $?.exitstatus
|
|
end
|
|
|
|
def test_sandbox_by_default
|
|
add_to_config <<-RUBY
|
|
config.sandbox_by_default = true
|
|
RUBY
|
|
|
|
options = "-e production -- --verbose"
|
|
spawn_console(options)
|
|
|
|
write_prompt "puts Rails.application.sandbox", "puts Rails.application.sandbox\r\ntrue"
|
|
@primary.puts "quit"
|
|
end
|
|
|
|
def test_sandbox_by_default_with_no_sandbox
|
|
add_to_config <<-RUBY
|
|
config.sandbox_by_default = true
|
|
RUBY
|
|
|
|
options = "-e production --no-sandbox -- --verbose"
|
|
spawn_console(options)
|
|
|
|
write_prompt "puts Rails.application.sandbox", "puts Rails.application.sandbox\r\nfalse"
|
|
@primary.puts "quit"
|
|
end
|
|
|
|
def test_sandbox_by_default_with_development_environment
|
|
add_to_config <<-RUBY
|
|
config.sandbox_by_default = true
|
|
RUBY
|
|
|
|
options = "-- --verbose"
|
|
spawn_console(options)
|
|
|
|
write_prompt "puts Rails.application.sandbox", "puts Rails.application.sandbox\r\nfalse"
|
|
@primary.puts "quit"
|
|
end
|
|
|
|
def test_environment_option_and_irb_option
|
|
options = "-e test -- --verbose"
|
|
spawn_console(options)
|
|
|
|
write_prompt "a = 1", "a = 1"
|
|
write_prompt "puts Rails.env", "puts Rails.env\r\ntest"
|
|
@primary.puts "quit"
|
|
end
|
|
|
|
def test_production_console_prompt
|
|
options = "-e production"
|
|
spawn_console(options)
|
|
|
|
write_prompt "123", "app-template(prod)> 123"
|
|
end
|
|
|
|
def test_development_console_prompt
|
|
options = "-e development"
|
|
spawn_console(options)
|
|
|
|
write_prompt "123", "app-template(dev)> 123"
|
|
end
|
|
|
|
def test_test_console_prompt
|
|
options = "-e test"
|
|
spawn_console(options)
|
|
|
|
write_prompt "123", "app-template(test)> 123"
|
|
end
|
|
|
|
def test_console_respects_user_defined_prompt_mode
|
|
irbrc = Tempfile.new("irbrc")
|
|
irbrc.write <<-RUBY
|
|
IRB.conf[:PROMPT_MODE] = :SIMPLE
|
|
RUBY
|
|
irbrc.close
|
|
|
|
options = "-e test"
|
|
spawn_console(options, env: { "IRBRC" => irbrc.path })
|
|
|
|
write_prompt "123", ">> 123"
|
|
ensure
|
|
File.unlink(irbrc)
|
|
end
|
|
|
|
def test_console_disables_IRB_auto_completion_in_non_local
|
|
options = "-e production -- --verbose"
|
|
spawn_console(options)
|
|
|
|
write_prompt "IRB.conf[:USE_AUTOCOMPLETE]", "IRB.conf[:USE_AUTOCOMPLETE]\r\n=> false"
|
|
end
|
|
|
|
def test_console_accepts_override_on_IRB_auto_completion_flag
|
|
options = "-e production -- --verbose"
|
|
spawn_console(options, env: { "IRB_USE_AUTOCOMPLETE" => "true" })
|
|
|
|
write_prompt "IRB.conf[:USE_AUTOCOMPLETE]", "IRB.conf[:USE_AUTOCOMPLETE]\r\n=> true"
|
|
end
|
|
|
|
def test_console_doesnt_disable_IRB_auto_completion_in_local
|
|
options = "-e development -- --verbose"
|
|
spawn_console(options)
|
|
|
|
write_prompt "IRB.conf[:USE_AUTOCOMPLETE]", "IRB.conf[:USE_AUTOCOMPLETE]\r\n=> true"
|
|
end
|
|
end
|