1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/railties/test/application/rake/dbs_test.rb

776 lines
29 KiB
Ruby

# frozen_string_literal: true
require "isolation/abstract_unit"
require "chdir_helpers"
require "env_helpers"
module ApplicationTests
module RakeTests
class RakeDbsTest < ActiveSupport::TestCase
include ActiveSupport::Testing::Isolation, ChdirHelpers, EnvHelpers
def setup
build_app
FileUtils.rm_rf("#{app_path}/config/environments")
end
def teardown
teardown_app
end
def database_url_db_name
"db/database_url_db.sqlite3"
end
def set_database_url
ENV["DATABASE_URL"] = "sqlite3:#{database_url_db_name}"
# ensure it's using the DATABASE_URL
FileUtils.rm_rf("#{app_path}/config/database.yml")
end
def db_create_and_drop(expected_database, environment_loaded: true)
chdir(app_path) do
output = rails("db:create")
assert_match(/Created database/, output)
assert File.exist?(expected_database)
yield if block_given?
assert_equal expected_database, ActiveRecord::Base.connection_db_config.database if environment_loaded
output = rails("db:drop")
assert_match(/Dropped database/, output)
assert_not File.exist?(expected_database)
end
end
def db_create_with_warning(expected_database)
chdir(app_path) do
output = rails("db:create")
assert_match(/Rails couldn't infer whether you are using multiple databases/, output)
assert_match(/Created database/, output)
assert File.exist?(expected_database)
end
end
test "db:create and db:drop without database URL" do
require "#{app_path}/config/environment"
db_config = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: "primary")
db_create_and_drop db_config.database
end
test "db:create and db:drop with database URL" do
require "#{app_path}/config/environment"
set_database_url
db_create_and_drop database_url_db_name
end
test "db:create and db:drop with database URL don't use YAML DBs" do
require "#{app_path}/config/environment"
set_database_url
File.write("#{app_path}/config/database.yml", <<~YAML)
test:
adapter: sqlite3
database: db/test.sqlite3
development:
adapter: sqlite3
database: db/development.sqlite3
YAML
with_rails_env "development" do
db_create_and_drop database_url_db_name do
assert_not File.exist?("#{app_path}/db/test.sqlite3")
assert_not File.exist?("#{app_path}/db/development.sqlite3")
end
end
end
test "db:create and db:drop respect environment setting" do
app_file "config/database.yml", <<-YAML
<% 1 %>
development:
database: <%= Rails.application.config.database %>
adapter: sqlite3
YAML
app_file "config/environments/development.rb", <<-RUBY
Rails.application.configure do
config.database = "db/development.sqlite3"
end
RUBY
db_create_and_drop("db/development.sqlite3", environment_loaded: false)
end
test "db:create and db:drop don't raise errors when loading YAML with multiline ERB" do
app_file "config/database.yml", <<-YAML
development:
database: <%=
Rails.application.config.database
%>
adapter: sqlite3
YAML
app_file "config/environments/development.rb", <<-RUBY
Rails.application.configure do
config.database = "db/development.sqlite3"
end
RUBY
db_create_and_drop("db/development.sqlite3", environment_loaded: false)
end
test "db:create and db:drop show warning but doesn't raise errors when loading YAML with alias ERB" do
app_file "config/database.yml", <<-YAML
sqlite: &sqlite
adapter: sqlite3
database: db/development.sqlite3
development:
<<: *<%= ENV["DB"] || "sqlite" %>
YAML
app_file "config/environments/development.rb", <<-RUBY
Rails.application.configure do
config.database = "db/development.sqlite3"
end
RUBY
db_create_with_warning("db/development.sqlite3")
end
test "db:create and db:drop don't raise errors when loading YAML containing conditional statements in ERB" do
app_file "config/database.yml", <<-YAML
development:
<% if Rails.application.config.database %>
database: <%= Rails.application.config.database %>
<% else %>
database: db/default.sqlite3
<% end %>
adapter: sqlite3
YAML
app_file "config/environments/development.rb", <<-RUBY
Rails.application.configure do
config.database = "db/development.sqlite3"
end
RUBY
db_create_and_drop("db/development.sqlite3", environment_loaded: false)
end
test "db:create and db:drop don't raise errors when loading YAML containing multiple ERB statements on the same line" do
app_file "config/database.yml", <<-YAML
development:
database: <% if Rails.application.config.database %><%= Rails.application.config.database %><% else %>db/default.sqlite3<% end %>
adapter: sqlite3
YAML
app_file "config/environments/development.rb", <<-RUBY
Rails.application.configure do
config.database = "db/development.sqlite3"
end
RUBY
db_create_and_drop("db/development.sqlite3", environment_loaded: false)
end
test "db:create and db:drop dont raise errors when loading YAML with single-line ERB" do
app_file "config/database.yml", <<-YAML
development:
<%= Rails.application.config.database ? 'database: db/development.sqlite3' : 'database: db/development.sqlite3' %>
adapter: sqlite3
YAML
app_file "config/environments/development.rb", <<-RUBY
Rails.application.configure do
config.database = "db/development.sqlite3"
end
RUBY
db_create_and_drop("db/development.sqlite3", environment_loaded: false)
end
test "db:create and db:drop don't raise errors when loading YAML which contains a key's value as an ERB statement" do
app_file "config/database.yml", <<-YAML
development:
database: <%= Rails.application.config.database ? 'db/development.sqlite3' : 'db/development.sqlite3' %>
custom_option: <%= ENV['CUSTOM_OPTION'] %>
adapter: sqlite3
YAML
app_file "config/environments/development.rb", <<-RUBY
Rails.application.configure do
config.database = "db/development.sqlite3"
end
RUBY
db_create_and_drop("db/development.sqlite3", environment_loaded: false)
end
def with_database_existing
chdir(app_path) do
set_database_url
rails "db:create"
yield
rails "db:drop"
end
end
test "db:create failure because database exists" do
with_database_existing do
output = rails("db:create")
assert_match(/already exists/, output)
end
end
def with_bad_permissions
chdir(app_path) do
skip "Can't avoid permissions as root" if Process.uid.zero?
set_database_url
FileUtils.chmod("-w", "db")
yield
FileUtils.chmod("+w", "db")
end
end
test "db:create failure because bad permissions" do
with_bad_permissions do
output = rails("db:create", allow_failure: true)
assert_match("Couldn't create '#{database_url_db_name}' database. Please check your configuration.", output)
assert_equal 1, $?.exitstatus
end
end
test "db:create works when schema cache exists and database does not exist" do
use_postgresql
begin
rails %w(db:create db:migrate db:schema:cache:dump)
rails "db:drop"
rails "db:create"
assert_equal 0, $?.exitstatus
ensure
rails "db:drop" rescue nil
end
end
test "db:drop failure because database does not exist" do
output = rails("db:drop:_unsafe", "--trace")
assert_match(/does not exist/, output)
end
test "db:drop failure because bad permissions" do
with_database_existing do
with_bad_permissions do
output = rails("db:drop", allow_failure: true)
assert_match(/Couldn't drop/, output)
assert_equal 1, $?.exitstatus
end
end
end
test "db:truncate_all truncates all non-internal tables" do
chdir(app_path) do
rails "generate", "model", "book", "title:string"
rails "db:migrate"
require "#{app_path}/config/environment"
Book.create!(title: "Remote")
assert_equal 1, Book.count
schema_migrations = ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.schema_migrations_table_name}\"")
internal_metadata = ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.internal_metadata_table_name}\"")
rails "db:truncate_all"
assert_equal(
schema_migrations,
ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.schema_migrations_table_name}\"")
)
assert_equal(
internal_metadata,
ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.internal_metadata_table_name}\"")
)
assert_equal 0, Book.count
end
end
test "db:truncate_all does not truncate any tables when environment is protected" do
with_rails_env "production" do
chdir(app_path) do
rails "generate", "model", "book", "title:string"
rails "db:migrate"
require "#{app_path}/config/environment"
Book.create!(title: "Remote")
assert_equal 1, Book.count
schema_migrations = ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.schema_migrations_table_name}\"")
internal_metadata = ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.internal_metadata_table_name}\"")
books = ActiveRecord::Base.connection.execute("SELECT * from \"books\"")
output = rails("db:truncate_all", allow_failure: true)
assert_match(/ActiveRecord::ProtectedEnvironmentError/, output)
assert_equal(
schema_migrations,
ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.schema_migrations_table_name}\"")
)
assert_equal(
internal_metadata,
ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.internal_metadata_table_name}\"")
)
assert_equal 1, Book.count
assert_equal(books, ActiveRecord::Base.connection.execute("SELECT * from \"books\""))
end
end
end
def db_migrate_and_status(expected_database)
rails "generate", "model", "book", "title:string"
rails "db:migrate"
output = rails("db:migrate:status")
assert_match(%r{database:\s+\S*#{Regexp.escape(expected_database)}}, output)
assert_match(/up\s+\d{14}\s+Create books/, output)
end
test "db:migrate and db:migrate:status without database_url" do
require "#{app_path}/config/environment"
db_config = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: "primary")
db_migrate_and_status db_config.database
end
test "db:migrate and db:migrate:status with database_url" do
require "#{app_path}/config/environment"
set_database_url
db_migrate_and_status database_url_db_name
end
def db_schema_dump
chdir(app_path) do
args = ["generate", "model", "book", "title:string"]
rails args
rails "db:migrate", "db:schema:dump"
assert_match(/create_table \"books\"/, File.read("db/schema.rb"))
end
end
test "db:schema:dump without database_url" do
db_schema_dump
end
test "db:schema:dump with database_url" do
set_database_url
db_schema_dump
end
def db_schema_cache_dump(filename = "db/schema_cache.yml")
chdir(app_path) do
rails "db:schema:cache:dump"
cache_size = lambda { rails("runner", "p ActiveRecord::Base.connection.schema_cache.size").strip }
cache_tables = lambda { rails("runner", "p ActiveRecord::Base.connection.schema_cache.columns('books')").strip }
assert_equal "12", cache_size[]
assert_includes cache_tables[], "id", "expected cache_tables to include an id entry"
assert_includes cache_tables[], "title", "expected cache_tables to include a title entry"
end
end
test "db:schema:cache:dump" do
db_schema_dump
db_schema_cache_dump
end
test "db:schema:cache:dump with custom filename" do
chdir(app_path) do
File.open("#{app_path}/config/database.yml", "w") do |f|
f.puts <<-YAML
default: &default
adapter: sqlite3
pool: 5
timeout: 5000
variables:
statement_timeout: 1000
development:
<<: *default
database: db/development.sqlite3
schema_cache_path: db/special_schema_cache.yml
YAML
end
end
db_schema_dump
db_schema_cache_dump("db/special_schema_cache.yml")
end
test "db:schema:cache:dump custom env" do
@old_schema_cache_env = ENV["SCHEMA_CACHE"]
filename = "db/special_schema_cache.yml"
ENV["SCHEMA_CACHE"] = filename
db_schema_dump
db_schema_cache_dump(filename)
ensure
ENV["SCHEMA_CACHE"] = @old_schema_cache_env
end
test "db:schema:cache:dump first config wins" do
chdir(app_path) do
File.open("#{app_path}/config/database.yml", "w") do |f|
f.puts <<-YAML
default: &default
adapter: sqlite3
pool: 5
timeout: 5000
variables:
statement_timeout: 1000
development:
some_entry:
<<: *default
database: db/development.sqlite3
another_entry:
<<: *default
database: db/another_entry_development.sqlite3
migrations_paths: db/another_entry_migrate
YAML
end
end
db_schema_dump
db_schema_cache_dump
end
def db_fixtures_load(expected_database)
chdir(app_path) do
rails "generate", "model", "book", "title:string"
reload
rails "db:migrate", "db:fixtures:load"
assert_match expected_database, ActiveRecord::Base.connection_db_config.database
assert_equal 2, Book.count
end
end
test "db:fixtures:load without database_url" do
require "#{app_path}/config/environment"
db_config = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: "primary")
db_fixtures_load db_config.database
end
test "db:fixtures:load with database_url" do
require "#{app_path}/config/environment"
set_database_url
db_fixtures_load database_url_db_name
end
test "db:fixtures:load with namespaced fixture" do
require "#{app_path}/config/environment"
rails "generate", "model", "admin::book", "title:string"
reload
rails "db:migrate", "db:fixtures:load"
assert_equal 2, Admin::Book.count
end
def db_structure_dump_and_load(expected_database)
chdir(app_path) do
rails "generate", "model", "book", "title:string"
rails "db:migrate", "db:structure:dump"
structure_dump = File.read("db/structure.sql")
assert_match(/CREATE TABLE (?:IF NOT EXISTS )?\"books\"/, structure_dump)
rails "environment", "db:drop", "db:structure:load"
assert_match expected_database, ActiveRecord::Base.connection_db_config.database
require "#{app_path}/app/models/book"
# if structure is not loaded correctly, exception would be raised
assert_equal 0, Book.count
end
end
["dump", "load"].each do |command|
test "db:structure:#{command} is deprecated" do
add_to_config("config.active_support.deprecation = :stderr")
stderr_output = capture(:stderr) { rails("db:structure:#{command}", stderr: true, allow_failure: true) }
assert_match(/DEPRECATION WARNING: Using `bin\/rails db:structure:#{command}` is deprecated and will be removed in Rails 6.2/, stderr_output)
end
end
test "db:structure:dump and db:structure:load without database_url" do
add_to_config "config.active_record.schema_format = :sql"
require "#{app_path}/config/environment"
db_config = ActiveRecord::Base.connection_db_config
db_structure_dump_and_load db_config.database
end
test "db:structure:dump and db:structure:load with database_url" do
add_to_config "config.active_record.schema_format = :sql"
require "#{app_path}/config/environment"
set_database_url
db_structure_dump_and_load database_url_db_name
end
test "db:structure:dump and db:structure:load set ar_internal_metadata" do
add_to_config "config.active_record.schema_format = :sql"
require "#{app_path}/config/environment"
db_config = ActiveRecord::Base.connection_db_config
db_structure_dump_and_load db_config.database
assert_equal "test", rails("runner", "-e", "test", "puts ActiveRecord::InternalMetadata[:environment]").strip
assert_equal "development", rails("runner", "puts ActiveRecord::InternalMetadata[:environment]").strip
end
test "db:structure:dump does not dump schema information when no migrations are used" do
add_to_config "config.active_record.schema_format = :sql"
# create table without migrations
rails "runner", "ActiveRecord::Base.connection.create_table(:posts) {|t| t.string :title }"
stderr_output = capture(:stderr) { rails("db:structure:dump", stderr: true, allow_failure: true) }
assert_empty stderr_output
structure_dump = File.read("#{app_path}/db/structure.sql")
assert_match(/CREATE TABLE (?:IF NOT EXISTS )?\"posts\"/, structure_dump)
end
test "db:schema:load and db:structure:load do not purge the existing database" do
rails "runner", "ActiveRecord::Base.connection.create_table(:posts) {|t| t.string :title }"
app_file "db/schema.rb", <<-RUBY
ActiveRecord::Schema.define(version: 20140423102712) do
create_table(:comments) {}
end
RUBY
list_tables = lambda { rails("runner", "p ActiveRecord::Base.connection.tables").strip }
assert_equal '["posts"]', list_tables[]
rails "db:schema:load"
assert_equal '["posts", "comments", "schema_migrations", "ar_internal_metadata"]', list_tables[]
add_to_config "config.active_record.schema_format = :sql"
app_file "db/structure.sql", <<-SQL
CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255));
SQL
rails "db:structure:load"
assert_equal '["posts", "comments", "schema_migrations", "ar_internal_metadata", "users"]', list_tables[]
end
test "db:schema:load with inflections" do
app_file "config/initializers/inflection.rb", <<-RUBY
ActiveSupport::Inflector.inflections do |inflect|
inflect.irregular 'goose', 'geese'
end
RUBY
app_file "config/initializers/primary_key_table_name.rb", <<-RUBY
ActiveRecord::Base.primary_key_prefix_type = :table_name
RUBY
app_file "db/schema.rb", <<-RUBY
ActiveRecord::Schema.define(version: 20140423102712) do
create_table("goose".pluralize) do |t|
t.string :name
end
end
RUBY
rails "db:schema:load"
tables = rails("runner", "p ActiveRecord::Base.connection.tables").strip
assert_match(/"geese"/, tables)
columns = rails("runner", "p ActiveRecord::Base.connection.columns('geese').map(&:name)").strip
assert_equal columns, '["gooseid", "name"]'
end
test "db:schema:load fails if schema.rb doesn't exist yet" do
stderr_output = capture(:stderr) { rails("db:schema:load", stderr: true, allow_failure: true) }
assert_match(/Run `bin\/rails db:migrate` to create it/, stderr_output)
end
def db_test_load_structure
chdir(app_path) do
rails "generate", "model", "book", "title:string"
rails "db:migrate", "db:structure:dump", "db:test:load_structure"
ActiveRecord::Base.configurations = Rails.application.config.database_configuration
ActiveRecord::Base.establish_connection :test
require "#{app_path}/app/models/book"
# if structure is not loaded correctly, exception would be raised
assert_equal 0, Book.count
db_config = ActiveRecord::Base.configurations.configs_for(env_name: "test", name: "primary")
assert_match db_config.database, ActiveRecord::Base.connection_db_config.database
end
end
test "db:test:load_structure without database_url" do
add_to_config "config.active_record.schema_format = :sql"
require "#{app_path}/config/environment"
db_test_load_structure
end
test "db:test:load_structure is deprecated" do
add_to_config("config.active_support.deprecation = :stderr")
stderr_output = capture(:stderr) { rails("db:test:load_structure", stderr: true, allow_failure: true) }
assert_match(/DEPRECATION WARNING: Using `bin\/rails db:test:load_structure` is deprecated and will be removed in Rails 6.2/, stderr_output)
end
test "db:setup loads schema and seeds database" do
@old_rails_env = ENV["RAILS_ENV"]
@old_rack_env = ENV["RACK_ENV"]
ENV.delete "RAILS_ENV"
ENV.delete "RACK_ENV"
app_file "db/schema.rb", <<-RUBY
ActiveRecord::Schema.define(version: "1") do
create_table :users do |t|
t.string :name
end
end
RUBY
app_file "db/seeds.rb", <<-RUBY
puts ActiveRecord::Base.connection_db_config.database
RUBY
database_path = rails("db:setup")
assert_equal "development.sqlite3", File.basename(database_path.strip)
ensure
ENV["RAILS_ENV"] = @old_rails_env
ENV["RACK_ENV"] = @old_rack_env
end
test "db:setup sets ar_internal_metadata" do
app_file "db/schema.rb", ""
rails "db:setup"
test_environment = lambda { rails("runner", "-e", "test", "puts ActiveRecord::InternalMetadata[:environment]").strip }
development_environment = lambda { rails("runner", "puts ActiveRecord::InternalMetadata[:environment]").strip }
assert_equal "test", test_environment.call
assert_equal "development", development_environment.call
app_file "db/structure.sql", ""
app_file "config/initializers/enable_sql_schema_format.rb", <<-RUBY
Rails.application.config.active_record.schema_format = :sql
RUBY
rails "db:setup"
assert_equal "test", test_environment.call
assert_equal "development", development_environment.call
end
test "db:test:prepare sets test ar_internal_metadata" do
app_file "db/schema.rb", ""
rails "db:test:prepare"
test_environment = lambda { rails("runner", "-e", "test", "puts ActiveRecord::InternalMetadata[:environment]").strip }
assert_equal "test", test_environment.call
app_file "db/structure.sql", ""
app_file "config/initializers/enable_sql_schema_format.rb", <<-RUBY
Rails.application.config.active_record.schema_format = :sql
RUBY
rails "db:test:prepare"
assert_equal "test", test_environment.call
end
test "db:seed:replant truncates all non-internal tables and loads the seeds" do
chdir(app_path) do
rails "generate", "model", "book", "title:string"
rails "db:migrate"
require "#{app_path}/config/environment"
Book.create!(title: "Remote")
assert_equal 1, Book.count
schema_migrations = ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.schema_migrations_table_name}\"")
internal_metadata = ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.internal_metadata_table_name}\"")
app_file "db/seeds.rb", <<-RUBY
Book.create!(title: "Rework")
Book.create!(title: "Ruby Under a Microscope")
RUBY
rails "db:seed:replant"
assert_equal(
schema_migrations,
ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.schema_migrations_table_name}\"")
)
assert_equal(
internal_metadata,
ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.internal_metadata_table_name}\"")
)
assert_equal 2, Book.count
assert_not_predicate Book.where(title: "Remote"), :exists?
assert_predicate Book.where(title: "Rework"), :exists?
assert_predicate Book.where(title: "Ruby Under a Microscope"), :exists?
end
end
test "db:seed:replant does not truncate any tables and does not load the seeds when environment is protected" do
with_rails_env "production" do
chdir(app_path) do
rails "generate", "model", "book", "title:string"
rails "db:migrate"
require "#{app_path}/config/environment"
Book.create!(title: "Remote")
assert_equal 1, Book.count
schema_migrations = ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.schema_migrations_table_name}\"")
internal_metadata = ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.internal_metadata_table_name}\"")
books = ActiveRecord::Base.connection.execute("SELECT * from \"books\"")
app_file "db/seeds.rb", <<-RUBY
Book.create!(title: "Rework")
RUBY
output = rails("db:seed:replant", allow_failure: true)
assert_match(/ActiveRecord::ProtectedEnvironmentError/, output)
assert_equal(
schema_migrations,
ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.schema_migrations_table_name}\"")
)
assert_equal(
internal_metadata,
ActiveRecord::Base.connection.execute("SELECT * from \"#{ActiveRecord::Base.internal_metadata_table_name}\"")
)
assert_equal 1, Book.count
assert_equal(books, ActiveRecord::Base.connection.execute("SELECT * from \"books\""))
assert_not_predicate Book.where(title: "Rework"), :exists?
end
end
end
test "db:prepare setup the database" do
chdir(app_path) do
rails "generate", "model", "book", "title:string"
output = rails("db:prepare")
assert_match(/CreateBooks: migrated/, output)
output = rails("db:drop")
assert_match(/Dropped database/, output)
rails "generate", "model", "recipe", "title:string"
output = rails("db:prepare")
assert_match(/CreateBooks: migrated/, output)
assert_match(/CreateRecipes: migrated/, output)
end
end
test "db:prepare does not touch schema when dumping is disabled" do
chdir(app_path) do
rails "generate", "model", "book", "title:string"
rails "db:create", "db:migrate"
app_file "db/schema.rb", "Not touched"
app_file "config/initializers/disable_dumping_schema.rb", <<-RUBY
Rails.application.config.active_record.dump_schema_after_migration = false
RUBY
rails "db:prepare"
assert_equal("Not touched", File.read("db/schema.rb").strip)
end
end
end
end
end