1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/activerecord/test/cases/schema_dumper_test.rb
Alex Ghiculescu 867d27dd64 Active Record + PostgreSQL: native support for timestamp with time zone
In https://github.com/rails/rails/issues/21126 it was suggested to make "timestamp with time zone" the default type for datetime columns in PostgreSQL. This is in line with PostgreSQL [best practices](https://wiki.postgresql.org/wiki/Don't_Do_This#Don.27t_use_timestamp_.28without_time_zone.29). This PR lays some groundwork for that.

This PR adds a configuration option, `ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type`. The default is `:timestamp` which preserves current Rails behavior of using "timestamp without time zone" when you do `t.datetime` in a migration. If you change it to `:timestamptz`, you'll get "timestamp with time zone" columns instead.

If you change this setting in an existing app, you should immediately call `bin/rails db:migrate` to ensure your `schema.rb` file remains correct. If you do so, then existing columns will not be impacted, so for example if you have an app with a mixture of both types of columns, and you change the config, schema dumps will continue to output the correct types.

This PR also adds two new types that can be used in migrations: `t.timestamp` and `t.timestamptz`.

```ruby
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type = :timestamp # default value is :timestamp

create_table("foo1") do |t|
  t.datetime :default_format # "timestamp without time zone"
  t.timestamp :without_time_zone # "timestamp without time zone"
  t.timestamptz :with_time_zone # "timestamp with time zone"
end

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type = :timestamptz

create_table("foo2") do |t|
  t.datetime :default_format # "timestamp with time zone" <-- note how this has changed!
  t.timestamp :without_time_zone # "timestamp without time zone"
  t.timestamptz :with_time_zone # "timestamp with time zone"
end

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:my_custom_type] = { name: "custom_datetime_format_i_invented" }
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type = :my_custom_type

create_table("foo3") do |t|
  t.datetime :default_format # "custom_datetime_format_i_invented"
  t.timestamp :without_time_zone # "timestamp without time zone"
  t.timestamptz :with_time_zone # "timestamp with time zone"
end
```

**Notes**

- This PR doesn't change the default `datetime` format. The default is still "timestamp without time zone". A future PR could do that, but there was enough code here just getting the config option right.
- See also https://github.com/rails/rails/pull/41395 which set some groundwork (and added some tests) for this.
- This reverts some of https://github.com/rails/rails/pull/15184. https://github.com/rails/rails/pull/15184 alluded to issues in XML serialization, but I couldn't find any related tests that this broke.
2021-05-06 17:41:55 -05:00

855 lines
33 KiB
Ruby

# frozen_string_literal: true
require "cases/helper"
require "support/schema_dumping_helper"
class SchemaDumperTest < ActiveRecord::TestCase
include SchemaDumpingHelper
self.use_transactional_tests = false
setup do
ActiveRecord::SchemaMigration.create_table
end
def standard_dump
@@standard_dump ||= perform_schema_dump
end
def perform_schema_dump
dump_all_table_schema []
end
def test_dump_schema_information_with_empty_versions
ActiveRecord::SchemaMigration.delete_all
schema_info = ActiveRecord::Base.connection.dump_schema_information
assert_no_match(/INSERT INTO/, schema_info)
end
def test_dump_schema_information_outputs_lexically_ordered_versions
versions = %w{ 20100101010101 20100201010101 20100301010101 }
versions.reverse_each do |v|
ActiveRecord::SchemaMigration.create!(version: v)
end
schema_info = ActiveRecord::Base.connection.dump_schema_information
assert_match(/20100201010101.*20100301010101/m, schema_info)
assert_includes schema_info, "20100101010101"
ensure
ActiveRecord::SchemaMigration.delete_all
end
def test_schema_dump
output = standard_dump
assert_match %r{create_table "accounts"}, output
assert_match %r{create_table "authors"}, output
assert_no_match %r{(?<=, ) do \|t\|}, output
assert_no_match %r{create_table "schema_migrations"}, output
assert_no_match %r{create_table "ar_internal_metadata"}, output
end
def test_schema_dump_uses_force_cascade_on_create_table
output = dump_table_schema "authors"
assert_match %r{create_table "authors",.* force: :cascade}, output
end
def test_schema_dump_excludes_sqlite_sequence
output = standard_dump
assert_no_match %r{create_table "sqlite_sequence"}, output
end
def test_schema_dump_includes_camelcase_table_name
output = standard_dump
assert_match %r{create_table "CamelCase"}, output
end
def assert_no_line_up(lines, pattern)
return assert(true) if lines.empty?
matches = lines.map { |line| line.match(pattern) }
matches.compact!
return assert(true) if matches.empty?
line_matches = lines.map { |line| [line, line.match(pattern)] }.select { |line, match| match }
assert line_matches.all? { |line, match|
start = match.offset(0).first
line[start - 2..start - 1] == ", "
}
end
def column_definition_lines(output = standard_dump)
output.scan(/^( *)create_table.*?\n(.*?)^\1end/m).map { |m| m.last.split(/\n/) }
end
def test_types_no_line_up
column_definition_lines.each do |column_set|
next if column_set.empty?
assert column_set.all? { |column| !column.match(/\bt\.\w+\s{2,}/) }
end
end
def test_arguments_no_line_up
column_definition_lines.each do |column_set|
assert_no_line_up(column_set, /default: /)
assert_no_line_up(column_set, /limit: /)
assert_no_line_up(column_set, /null: /)
end
end
def test_no_dump_errors
output = standard_dump
assert_no_match %r{\# Could not dump table}, output
end
def test_schema_dump_includes_not_null_columns
output = dump_all_table_schema([/^[^r]/])
assert_match %r{null: false}, output
end
def test_schema_dump_includes_limit_constraint_for_integer_columns
output = dump_all_table_schema([/^(?!integer_limits)/])
assert_match %r{"c_int_without_limit"(?!.*limit)}, output
if current_adapter?(:PostgreSQLAdapter)
assert_match %r{c_int_1.*limit: 2}, output
assert_match %r{c_int_2.*limit: 2}, output
# int 3 is 4 bytes in postgresql
assert_match %r{"c_int_3"(?!.*limit)}, output
assert_match %r{"c_int_4"(?!.*limit)}, output
elsif current_adapter?(:Mysql2Adapter)
assert_match %r{c_int_1.*limit: 1}, output
assert_match %r{c_int_2.*limit: 2}, output
assert_match %r{c_int_3.*limit: 3}, output
assert_match %r{"c_int_4"(?!.*limit)}, output
elsif current_adapter?(:SQLite3Adapter)
assert_match %r{c_int_1.*limit: 1}, output
assert_match %r{c_int_2.*limit: 2}, output
assert_match %r{c_int_3.*limit: 3}, output
assert_match %r{c_int_4.*limit: 4}, output
end
if current_adapter?(:SQLite3Adapter, :OracleAdapter)
assert_match %r{c_int_5.*limit: 5}, output
assert_match %r{c_int_6.*limit: 6}, output
assert_match %r{c_int_7.*limit: 7}, output
assert_match %r{c_int_8.*limit: 8}, output
else
assert_match %r{t\.bigint\s+"c_int_5"$}, output
assert_match %r{t\.bigint\s+"c_int_6"$}, output
assert_match %r{t\.bigint\s+"c_int_7"$}, output
assert_match %r{t\.bigint\s+"c_int_8"$}, output
end
end
def test_schema_dump_with_string_ignored_table
output = dump_all_table_schema(["accounts"])
assert_no_match %r{create_table "accounts"}, output
assert_match %r{create_table "authors"}, output
assert_no_match %r{create_table "schema_migrations"}, output
assert_no_match %r{create_table "ar_internal_metadata"}, output
end
def test_schema_dump_with_regexp_ignored_table
output = dump_all_table_schema([/^account/])
assert_no_match %r{create_table "accounts"}, output
assert_match %r{create_table "authors"}, output
assert_no_match %r{create_table "schema_migrations"}, output
assert_no_match %r{create_table "ar_internal_metadata"}, output
end
def test_schema_dumps_index_columns_in_right_order
index_definition = dump_table_schema("companies").split(/\n/).grep(/t\.index.*company_index/).first.strip
if current_adapter?(:Mysql2Adapter)
if ActiveRecord::Base.connection.supports_index_sort_order?
assert_equal 't.index ["firm_id", "type", "rating"], name: "company_index", length: { type: 10 }, order: { rating: :desc }', index_definition
else
assert_equal 't.index ["firm_id", "type", "rating"], name: "company_index", length: { type: 10 }', index_definition
end
elsif ActiveRecord::Base.connection.supports_index_sort_order?
assert_equal 't.index ["firm_id", "type", "rating"], name: "company_index", order: { rating: :desc }', index_definition
else
assert_equal 't.index ["firm_id", "type", "rating"], name: "company_index"', index_definition
end
end
def test_schema_dumps_partial_indices
index_definition = dump_table_schema("companies").split(/\n/).grep(/t\.index.*company_partial_index/).first.strip
if ActiveRecord::Base.connection.supports_partial_index?
assert_equal 't.index ["firm_id", "type"], name: "company_partial_index", where: "(rating > 10)"', index_definition
else
assert_equal 't.index ["firm_id", "type"], name: "company_partial_index"', index_definition
end
end
def test_schema_dumps_index_sort_order
index_definition = dump_table_schema("companies").split(/\n/).grep(/t\.index.*_name_and_rating/).first.strip
if ActiveRecord::Base.connection.supports_index_sort_order?
assert_equal 't.index ["name", "rating"], name: "index_companies_on_name_and_rating", order: :desc', index_definition
else
assert_equal 't.index ["name", "rating"], name: "index_companies_on_name_and_rating"', index_definition
end
end
def test_schema_dumps_index_length
index_definition = dump_table_schema("companies").split(/\n/).grep(/t\.index.*_name_and_description/).first.strip
if current_adapter?(:Mysql2Adapter)
assert_equal 't.index ["name", "description"], name: "index_companies_on_name_and_description", length: 10', index_definition
else
assert_equal 't.index ["name", "description"], name: "index_companies_on_name_and_description"', index_definition
end
end
if ActiveRecord::Base.connection.supports_check_constraints?
def test_schema_dumps_check_constraints
constraint_definition = dump_table_schema("products").split(/\n/).grep(/t.check_constraint.*products_price_check/).first.strip
if current_adapter?(:Mysql2Adapter)
assert_equal 't.check_constraint "`price` > `discounted_price`", name: "products_price_check"', constraint_definition
else
assert_equal 't.check_constraint "price > discounted_price", name: "products_price_check"', constraint_definition
end
end
end
def test_schema_dump_should_honor_nonstandard_primary_keys
output = standard_dump
match = output.match(%r{create_table "movies"(.*)do})
assert_not_nil(match, "nonstandardpk table not found")
assert_match %r(primary_key: "movieid"), match[1], "non-standard primary key not preserved"
end
def test_schema_dump_should_use_false_as_default
output = dump_table_schema "booleans"
assert_match %r{t\.boolean\s+"has_fun",.+default: false}, output
end
def test_schema_dump_does_not_include_limit_for_text_field
output = dump_table_schema "admin_users"
assert_match %r{t\.text\s+"params"$}, output
end
def test_schema_dump_does_not_include_limit_for_binary_field
output = dump_table_schema "binaries"
assert_match %r{t\.binary\s+"data"$}, output
end
def test_schema_dump_does_not_include_limit_for_float_field
output = dump_table_schema "numeric_data"
assert_match %r{t\.float\s+"temperature"$}, output
end
def test_schema_dump_aliased_types
output = standard_dump
assert_match %r{t\.binary\s+"blob_data"$}, output
assert_match %r{t\.decimal\s+"numeric_number"}, output
end
if ActiveRecord::Base.connection.supports_expression_index?
def test_schema_dump_expression_indices
index_definition = dump_table_schema("companies").split(/\n/).grep(/t\.index.*company_expression_index/).first.strip
index_definition.sub!(/, name: "company_expression_index"\z/, "")
if current_adapter?(:PostgreSQLAdapter)
assert_match %r{CASE.+lower\(\(name\)::text\).+END\) DESC"\z}i, index_definition
elsif current_adapter?(:Mysql2Adapter)
assert_match %r{CASE.+lower\(`name`\).+END\) DESC"\z}i, index_definition
elsif current_adapter?(:SQLite3Adapter)
assert_match %r{CASE.+lower\(name\).+END\) DESC"\z}i, index_definition
else
assert false
end
end
end
if current_adapter?(:Mysql2Adapter)
def test_schema_dump_includes_length_for_mysql_binary_fields
output = dump_table_schema "binary_fields"
assert_match %r{t\.binary\s+"var_binary",\s+limit: 255$}, output
assert_match %r{t\.binary\s+"var_binary_large",\s+limit: 4095$}, output
end
def test_schema_dump_includes_length_for_mysql_blob_and_text_fields
output = dump_table_schema "binary_fields"
assert_match %r{t\.binary\s+"tiny_blob",\s+size: :tiny$}, output
assert_match %r{t\.binary\s+"normal_blob"$}, output
assert_match %r{t\.binary\s+"medium_blob",\s+size: :medium$}, output
assert_match %r{t\.binary\s+"long_blob",\s+size: :long$}, output
assert_match %r{t\.text\s+"tiny_text",\s+size: :tiny$}, output
assert_match %r{t\.text\s+"normal_text"$}, output
assert_match %r{t\.text\s+"medium_text",\s+size: :medium$}, output
assert_match %r{t\.text\s+"long_text",\s+size: :long$}, output
assert_match %r{t\.binary\s+"tiny_blob_2",\s+size: :tiny$}, output
assert_match %r{t\.binary\s+"medium_blob_2",\s+size: :medium$}, output
assert_match %r{t\.binary\s+"long_blob_2",\s+size: :long$}, output
assert_match %r{t\.text\s+"tiny_text_2",\s+size: :tiny$}, output
assert_match %r{t\.text\s+"medium_text_2",\s+size: :medium$}, output
assert_match %r{t\.text\s+"long_text_2",\s+size: :long$}, output
end
def test_schema_does_not_include_limit_for_emulated_mysql_boolean_fields
output = dump_table_schema "booleans"
assert_no_match %r{t\.boolean\s+"has_fun",.+limit: 1}, output
end
def test_schema_dumps_index_type
output = dump_table_schema "key_tests"
assert_match %r{t\.index \["awesome"\], name: "index_key_tests_on_awesome", type: :fulltext$}, output
assert_match %r{t\.index \["pizza"\], name: "index_key_tests_on_pizza"$}, output
end
end
def test_schema_dump_includes_decimal_options
output = dump_all_table_schema([/^[^n]/])
assert_match %r{precision: 3,[[:space:]]+scale: 2,[[:space:]]+default: "2\.78"}, output
end
if current_adapter?(:PostgreSQLAdapter)
def test_schema_dump_includes_bigint_default
output = dump_table_schema "defaults"
assert_match %r{t\.bigint\s+"bigint_default",\s+default: 0}, output
end
def test_schema_dump_includes_limit_on_array_type
output = dump_table_schema "bigint_array"
assert_match %r{t\.bigint\s+"big_int_data_points",\s+array: true}, output
end
def test_schema_dump_allows_array_of_decimal_defaults
output = dump_table_schema "bigint_array"
assert_match %r{t\.decimal\s+"decimal_array_default",\s+default: \["1.23", "3.45"\],\s+array: true}, output
end
def test_schema_dump_interval_type
output = dump_table_schema "postgresql_times"
assert_match %r{t\.interval\s+"time_interval"$}, output
assert_match %r{t\.interval\s+"scaled_time_interval",\s+precision: 6$}, output
end
def test_schema_dump_oid_type
output = dump_table_schema "postgresql_oids"
assert_match %r{t\.oid\s+"obj_id"$}, output
end
def test_schema_dump_includes_extensions
connection = ActiveRecord::Base.connection
connection.stub(:extensions, ["hstore"]) do
output = perform_schema_dump
assert_match "# These are extensions that must be enabled", output
assert_match %r{enable_extension "hstore"}, output
end
connection.stub(:extensions, []) do
output = perform_schema_dump
assert_no_match "# These are extensions that must be enabled", output
assert_no_match %r{enable_extension}, output
end
end
def test_schema_dump_includes_extensions_in_alphabetic_order
connection = ActiveRecord::Base.connection
connection.stub(:extensions, ["hstore", "uuid-ossp", "xml2"]) do
output = perform_schema_dump
enabled_extensions = output.scan(%r{enable_extension "(.+)"}).flatten
assert_equal ["hstore", "uuid-ossp", "xml2"], enabled_extensions
end
connection.stub(:extensions, ["uuid-ossp", "xml2", "hstore"]) do
output = perform_schema_dump
enabled_extensions = output.scan(%r{enable_extension "(.+)"}).flatten
assert_equal ["hstore", "uuid-ossp", "xml2"], enabled_extensions
end
end
end
def test_schema_dump_keeps_large_precision_integer_columns_as_decimal
output = standard_dump
# Oracle supports precision up to 38 and it identifies decimals with scale 0 as integers
if current_adapter?(:OracleAdapter)
assert_match %r{t\.integer\s+"atoms_in_universe",\s+precision: 38}, output
else
assert_match %r{t\.decimal\s+"atoms_in_universe",\s+precision: 55}, output
end
end
def test_schema_dump_keeps_id_column_when_id_is_false_and_id_column_added
output = standard_dump
match = output.match(%r{create_table "goofy_string_id"(.*)do.*\n(.*)\n})
assert_not_nil(match, "goofy_string_id table not found")
assert_match %r(id: false), match[1], "no table id not preserved"
assert_match %r{t\.string\s+"id",.*?null: false$}, match[2], "non-primary key id column not preserved"
end
def test_schema_dump_keeps_id_false_when_id_is_false_and_unique_not_null_column_added
output = standard_dump
assert_match %r{create_table "string_key_objects", id: false}, output
end
if ActiveRecord::Base.connection.supports_foreign_keys?
def test_foreign_keys_are_dumped_at_the_bottom_to_circumvent_dependency_issues
output = standard_dump
assert_match(/^\s+add_foreign_key "fk_test_has_fk"[^\n]+\n\s+add_foreign_key "lessons_students"/, output)
end
def test_do_not_dump_foreign_keys_for_ignored_tables
output = dump_table_schema "authors"
assert_equal ["authors"], output.scan(/^\s*add_foreign_key "([^"]+)".+$/).flatten
end
end
class CreateDogMigration < ActiveRecord::Migration::Current
def up
create_table("dog_owners") do |t|
end
create_table("dogs") do |t|
t.column :name, :string
t.references :owner
t.index [:name]
t.foreign_key :dog_owners, column: "owner_id"
end
end
def down
drop_table("dogs")
drop_table("dog_owners")
end
end
def test_schema_dump_with_table_name_prefix_and_suffix
original, $stdout = $stdout, StringIO.new
ActiveRecord::Base.table_name_prefix = "foo_"
ActiveRecord::Base.table_name_suffix = "_bar"
migration = CreateDogMigration.new
migration.migrate(:up)
output = perform_schema_dump
assert_no_match %r{create_table "foo_.+_bar"}, output
assert_no_match %r{add_index "foo_.+_bar"}, output
assert_no_match %r{create_table "schema_migrations"}, output
assert_no_match %r{create_table "ar_internal_metadata"}, output
if ActiveRecord::Base.connection.supports_foreign_keys?
assert_no_match %r{add_foreign_key "foo_.+_bar"}, output
assert_no_match %r{add_foreign_key "[^"]+", "foo_.+_bar"}, output
end
ensure
migration.migrate(:down)
ActiveRecord::Base.table_name_suffix = ActiveRecord::Base.table_name_prefix = ""
$stdout = original
end
def test_schema_dump_with_table_name_prefix_and_suffix_regexp_escape
original, $stdout = $stdout, StringIO.new
ActiveRecord::Base.table_name_prefix = "foo$"
ActiveRecord::Base.table_name_suffix = "$bar"
migration = CreateDogMigration.new
migration.migrate(:up)
output = perform_schema_dump
assert_no_match %r{create_table "foo\$.+\$bar"}, output
assert_no_match %r{add_index "foo\$.+\$bar"}, output
assert_no_match %r{create_table "schema_migrations"}, output
assert_no_match %r{create_table "ar_internal_metadata"}, output
if ActiveRecord::Base.connection.supports_foreign_keys?
assert_no_match %r{add_foreign_key "foo\$.+\$bar"}, output
assert_no_match %r{add_foreign_key "[^"]+", "foo\$.+\$bar"}, output
end
ensure
migration.migrate(:down)
ActiveRecord::Base.table_name_suffix = ActiveRecord::Base.table_name_prefix = ""
$stdout = original
end
def test_schema_dump_with_table_name_prefix_and_ignoring_tables
original, $stdout = $stdout, StringIO.new
create_cat_migration = Class.new(ActiveRecord::Migration::Current) do
def change
create_table("cats") do |t|
end
create_table("omg_cats") do |t|
end
end
end
original_table_name_prefix = ActiveRecord::Base.table_name_prefix
original_schema_dumper_ignore_tables = ActiveRecord::SchemaDumper.ignore_tables
ActiveRecord::Base.table_name_prefix = "omg_"
ActiveRecord::SchemaDumper.ignore_tables = ["cats"]
migration = create_cat_migration.new
migration.migrate(:up)
stream = StringIO.new
output = ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream).string
assert_match %r{create_table "omg_cats"}, output
assert_no_match %r{create_table "cats"}, output
ensure
migration.migrate(:down)
ActiveRecord::Base.table_name_prefix = original_table_name_prefix
ActiveRecord::SchemaDumper.ignore_tables = original_schema_dumper_ignore_tables
$stdout = original
end
if current_adapter?(:PostgreSQLAdapter)
def test_schema_dump_with_correct_timestamp_types_via_create_table_and_t_column
original, $stdout = $stdout, StringIO.new
migration = Class.new(ActiveRecord::Migration::Current) do
def up
create_table("timestamps") do |t|
t.datetime :this_should_remain_datetime
t.timestamp :this_is_an_alias_of_datetime
t.column :without_time_zone, :timestamp
t.column :with_time_zone, :timestamptz
end
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
assert output.include?('t.datetime "this_should_remain_datetime"')
assert output.include?('t.datetime "this_is_an_alias_of_datetime"')
assert output.include?('t.datetime "without_time_zone"')
assert output.include?('t.timestamptz "with_time_zone"')
ensure
migration.migrate(:down)
$stdout = original
end
def test_schema_dump_with_timestamptz_datetime_format
migration, original, $stdout = nil, $stdout, StringIO.new
with_postgresql_datetime_type(:timestamptz) do
migration = Class.new(ActiveRecord::Migration::Current) do
def up
create_table("timestamps") do |t|
t.datetime :this_should_remain_datetime
t.timestamptz :this_is_an_alias_of_datetime
t.column :without_time_zone, :timestamp
t.column :with_time_zone, :timestamptz
end
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
assert output.include?('t.datetime "this_should_remain_datetime"')
assert output.include?('t.datetime "this_is_an_alias_of_datetime"')
assert output.include?('t.timestamp "without_time_zone"')
assert output.include?('t.datetime "with_time_zone"')
end
ensure
migration.migrate(:down)
$stdout = original
end
def test_timestamps_schema_dump_before_rails_7
migration, original, $stdout = nil, $stdout, StringIO.new
migration = Class.new(ActiveRecord::Migration[6.1]) do
def up
create_table("timestamps") do |t|
t.datetime :this_should_remain_datetime
t.timestamp :this_is_an_alias_of_datetime
t.column :this_is_also_an_alias_of_datetime, :timestamp
end
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
assert output.include?('t.datetime "this_should_remain_datetime"')
assert output.include?('t.datetime "this_is_an_alias_of_datetime"')
assert output.include?('t.datetime "this_is_also_an_alias_of_datetime"')
ensure
migration.migrate(:down)
$stdout = original
end
def test_timestamps_schema_dump_before_rails_7_with_timestamptz_setting
migration, original, $stdout = nil, $stdout, StringIO.new
with_postgresql_datetime_type(:timestamptz) do
migration = Class.new(ActiveRecord::Migration[6.1]) do
def up
create_table("timestamps") do |t|
t.datetime :this_should_change_to_timestamp
t.timestamp :this_should_stay_as_timestamp
t.column :this_should_also_stay_as_timestamp, :timestamp
end
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
# Normally we'd write `t.datetime` here. But because you've changed the `datetime_type`
# to something else, `t.datetime` now means `:timestamptz`. To ensure that old columns
# are still created as a `:timestamp` we need to change what is written to the schema dump.
#
# Typically in Rails we handle this through Migration versioning (`ActiveRecord::Migration::Compatibility`)
# but that doesn't work here because the schema dumper is not aware of which migration
# a column was added in.
assert output.include?('t.timestamp "this_should_change_to_timestamp"')
assert output.include?('t.timestamp "this_should_stay_as_timestamp"')
assert output.include?('t.timestamp "this_should_also_stay_as_timestamp"')
end
ensure
migration.migrate(:down)
$stdout = original
end
def test_schema_dump_when_changing_datetime_type_for_an_existing_app
original, $stdout = $stdout, StringIO.new
migration = Class.new(ActiveRecord::Migration::Current) do
def up
create_table("timestamps") do |t|
t.datetime :default_format
t.column :without_time_zone, :timestamp
t.column :with_time_zone, :timestamptz
end
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
assert output.include?('t.datetime "default_format"')
assert output.include?('t.datetime "without_time_zone"')
assert output.include?('t.timestamptz "with_time_zone"')
datetime_type_was = ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type = :timestamptz
output = perform_schema_dump
assert output.include?('t.timestamp "default_format"')
assert output.include?('t.timestamp "without_time_zone"')
assert output.include?('t.datetime "with_time_zone"')
ensure
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.datetime_type = datetime_type_was
migration.migrate(:down)
$stdout = original
end
def test_schema_dump_with_correct_timestamp_types_via_create_table_and_t_timestamptz
original, $stdout = $stdout, StringIO.new
migration = Class.new(ActiveRecord::Migration::Current) do
def up
create_table("timestamps") do |t|
t.datetime :default_format
t.datetime :without_time_zone
t.timestamp :also_without_time_zone
t.timestamptz :with_time_zone
end
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
assert output.include?('t.datetime "default_format"')
assert output.include?('t.datetime "without_time_zone"')
assert output.include?('t.datetime "also_without_time_zone"')
assert output.include?('t.timestamptz "with_time_zone"')
ensure
migration.migrate(:down)
$stdout = original
end
def test_schema_dump_with_correct_timestamp_types_via_add_column
original, $stdout = $stdout, StringIO.new
migration = Class.new(ActiveRecord::Migration::Current) do
def up
create_table("timestamps")
add_column :timestamps, :default_format, :datetime
add_column :timestamps, :without_time_zone, :datetime
add_column :timestamps, :also_without_time_zone, :timestamp
add_column :timestamps, :with_time_zone, :timestamptz
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
assert output.include?('t.datetime "default_format"')
assert output.include?('t.datetime "without_time_zone"')
assert output.include?('t.datetime "also_without_time_zone"')
assert output.include?('t.timestamptz "with_time_zone"')
ensure
migration.migrate(:down)
$stdout = original
end
def test_schema_dump_with_correct_timestamp_types_via_add_column_before_rails_7
original, $stdout = $stdout, StringIO.new
migration = Class.new(ActiveRecord::Migration[6.1]) do
def up
create_table("timestamps")
add_column :timestamps, :default_format, :datetime
add_column :timestamps, :without_time_zone, :datetime
add_column :timestamps, :also_without_time_zone, :timestamp
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
assert output.include?('t.datetime "default_format"')
assert output.include?('t.datetime "without_time_zone"')
assert output.include?('t.datetime "also_without_time_zone"')
ensure
migration.migrate(:down)
$stdout = original
end
def test_schema_dump_with_correct_timestamp_types_via_add_column_before_rails_7_with_timestamptz_setting
migration, original, $stdout = nil, $stdout, StringIO.new
with_postgresql_datetime_type(:timestamptz) do
migration = Class.new(ActiveRecord::Migration[6.1]) do
def up
create_table("timestamps")
add_column :timestamps, :this_should_change_to_timestamp, :datetime
add_column :timestamps, :this_should_stay_as_timestamp, :timestamp
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
# Normally we'd write `t.datetime` here. But because you've changed the `datetime_type`
# to something else, `t.datetime` now means `:timestamptz`. To ensure that old columns
# are still created as a `:timestamp` we need to change what is written to the schema dump.
#
# Typically in Rails we handle this through Migration versioning (`ActiveRecord::Migration::Compatibility`)
# but that doesn't work here because the schema dumper is not aware of which migration
# a column was added in.
assert output.include?('t.timestamp "this_should_change_to_timestamp"')
assert output.include?('t.timestamp "this_should_stay_as_timestamp"')
end
ensure
migration.migrate(:down)
$stdout = original
end
def test_schema_dump_with_correct_timestamp_types_via_add_column_with_type_as_string
migration, original, $stdout = nil, $stdout, StringIO.new
with_postgresql_datetime_type(:timestamptz) do
migration = Class.new(ActiveRecord::Migration[6.1]) do
def up
create_table("timestamps")
add_column :timestamps, :this_should_change_to_timestamp, "datetime"
add_column :timestamps, :this_should_stay_as_timestamp, "timestamp"
end
def down
drop_table("timestamps")
end
end
migration.migrate(:up)
output = perform_schema_dump
# Normally we'd write `t.datetime` here. But because you've changed the `datetime_type`
# to something else, `t.datetime` now means `:timestamptz`. To ensure that old columns
# are still created as a `:timestamp` we need to change what is written to the schema dump.
#
# Typically in Rails we handle this through Migration versioning (`ActiveRecord::Migration::Compatibility`)
# but that doesn't work here because the schema dumper is not aware of which migration
# a column was added in.
assert output.include?('t.timestamp "this_should_change_to_timestamp"')
assert output.include?('t.timestamp "this_should_stay_as_timestamp"')
end
ensure
migration.migrate(:down)
$stdout = original
end
end
end
class SchemaDumperDefaultsTest < ActiveRecord::TestCase
include SchemaDumpingHelper
setup do
@connection = ActiveRecord::Base.connection
@connection.create_table :dump_defaults, force: true do |t|
t.string :string_with_default, default: "Hello!"
t.date :date_with_default, default: "2014-06-05"
t.datetime :datetime_with_default, default: "2014-06-05 07:17:04"
t.time :time_with_default, default: "07:17:04"
t.decimal :decimal_with_default, default: "1234567890.0123456789", precision: 20, scale: 10
end
if current_adapter?(:PostgreSQLAdapter)
@connection.create_table :infinity_defaults, force: true do |t|
t.float :float_with_inf_default, default: Float::INFINITY
t.float :float_with_nan_default, default: Float::NAN
t.datetime :beginning_of_time, default: "-infinity"
t.datetime :end_of_time, default: "infinity"
t.date :date_with_neg_inf_default, default: -::Float::INFINITY
t.date :date_with_pos_inf_default, default: ::Float::INFINITY
end
end
end
teardown do
@connection.drop_table "dump_defaults", if_exists: true
end
def test_schema_dump_defaults_with_universally_supported_types
output = dump_table_schema("dump_defaults")
assert_match %r{t\.string\s+"string_with_default",.*?default: "Hello!"}, output
assert_match %r{t\.date\s+"date_with_default",\s+default: "2014-06-05"}, output
assert_match %r{t\.datetime\s+"datetime_with_default",\s+default: "2014-06-05 07:17:04"}, output
assert_match %r{t\.time\s+"time_with_default",\s+default: "2000-01-01 07:17:04"}, output
assert_match %r{t\.decimal\s+"decimal_with_default",\s+precision: 20,\s+scale: 10,\s+default: "1234567890.0123456789"}, output
end
def test_schema_dump_with_column_infinity_default
skip unless current_adapter?(:PostgreSQLAdapter)
output = dump_table_schema("infinity_defaults")
assert_match %r{t\.float\s+"float_with_inf_default",\s+default: ::Float::INFINITY}, output
assert_match %r{t\.float\s+"float_with_nan_default",\s+default: ::Float::NAN}, output
assert_match %r{t\.datetime\s+"beginning_of_time",\s+default: -::Float::INFINITY}, output
assert_match %r{t\.datetime\s+"end_of_time",\s+default: ::Float::INFINITY}, output
assert_match %r{t\.date\s+"date_with_neg_inf_default",\s+default: -::Float::INFINITY}, output
assert_match %r{t\.date\s+"date_with_pos_inf_default",\s+default: ::Float::INFINITY}, output
end
end