activerecord-cockroachdb-adapter 8.0.2 → 8.1.0

data/test/cases/migration/columns_test.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "cases/migration/helper"
+
+module ActiveRecord
+  module CockroachDB
+    class Migration
+      class ColumnsTest < ActiveRecord::TestCase
+        include ActiveRecord::Migration::TestHelper
+
+        self.use_transactional_tests = false
+
+        # This file replaces the same tests that have been excluded from ColumnsTest
+        # (see test/excludes/ActiveRecord/Migration/ColumnsTest.rb). New, unsaved
+        # records won't have string default values if the default has been changed
+        # in the database. This happens because once a column default is changed
+        # in CockroachDB, the type information on the value is missing.
+        # We can still verify the desired behavior by persisting the test records.
+        # When ActiveRecord fetches the records from the database, they'll have
+        # their default values.
+
+        def test_change_column_default
+          add_column "test_models", "first_name", :string
+          connection.change_column_default "test_models", "first_name", "Tester"
+          TestModel.reset_column_information
+
+          # Instead of using an unsaved TestModel record, persist one and fetch
+          # it from the database to get the new default value for type.
+
+          TestModel.create!
+          test_model = TestModel.last
+          assert_equal "Tester", test_model.first_name
+        end
+
+        def test_change_column_default_with_from_and_to
+          add_column "test_models", "first_name", :string
+          connection.change_column_default "test_models", "first_name", from: nil, to: "Tester"
+          TestModel.reset_column_information
+
+          # Instead of using an unsaved TestModel record, persist one and fetch
+          # it from the database to get the new default value for type.
+
+          TestModel.create!
+          test_model = TestModel.last
+          assert_equal "Tester", test_model.first_name
+        end
+      end
+    end
+  end
+end

data/test/cases/migration/create_join_table_test.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "cases/helper"
+
+module ActiveRecord
+  module CockroachDB
+    class Migration
+      class CreateJoinTableTest < ActiveRecord::TestCase
+        attr_reader :connection
+
+        self.use_transactional_tests = false
+
+        def setup
+          super
+          @connection = ActiveRecord::Base.lease_connection
+        end
+
+        teardown do
+          %w(artists_musics musics_videos catalog).each do |table_name|
+            connection.drop_table table_name, if_exists: true
+          end
+        end
+
+        # This test is identical to the one found in Rails, save for the fact
+        # that transactions are turned off for test runs. It is necessary to disable
+        # transactional tests in order to assert on schema changes due to how
+        # CockroachDB handles transactions.
+        def test_create_join_table_with_index
+          connection.create_join_table :artists, :musics do |t|
+            t.index [:artist_id, :music_id]
+          end
+
+          assert_equal [%w(artist_id music_id)], connection.indexes(:artists_musics).map(&:columns)
+        end
+
+        # This test is identical to the one found in Rails, save for the fact
+        # that transactions are turned off for test runs. It is necessary to disable
+        # transactional tests in order to assert on schema changes due to how
+        # CockroachDB handles transactions.
+        def test_create_and_drop_join_table_with_common_prefix
+          with_table_cleanup do
+            connection.create_join_table "audio_artists", "audio_musics"
+            assert connection.table_exists?("audio_artists_musics")
+
+            connection.drop_join_table "audio_artists", "audio_musics"
+            assert !connection.table_exists?("audio_artists_musics"), "Should have dropped join table, but didn't"
+          end
+        end
+
+        private
+
+        def with_table_cleanup
+          tables_before = connection.data_sources
+
+          yield
+        ensure
+          tables_after = connection.data_sources - tables_before
+
+          tables_after.each do |table|
+            connection.drop_table table
+          end
+        end
+      end
+    end
+  end
+end

data/test/cases/migration/foreign_key_test.rb

@@ -0,0 +1,390 @@
+# frozen_string_literal: true
+
+require "cases/helper"
+require "support/schema_dumping_helper"
+
+module ActiveRecord
+  module CockroachDB
+    class Migration
+      class ForeignKeyTest < ActiveRecord::TestCase
+        include SchemaDumpingHelper
+        include ActiveSupport::Testing::Stream
+
+        # All of the following test cases are identical to the ones found in
+        # Rails, the only difference being that we have turned off transactional
+        # tests in the following line in order to properly assert on the various
+        # changes being tested.
+        self.use_transactional_tests = false
+
+        class Rocket < ActiveRecord::Base
+        end
+
+        class Astronaut < ActiveRecord::Base
+        end
+
+        setup do
+          @connection = ActiveRecord::Base.lease_connection
+          @connection.create_table "rockets", force: true do |t|
+            t.string :name
+          end
+
+          @connection.create_table "astronauts", force: true do |t|
+            t.string :name
+            t.references :rocket
+          end
+        end
+
+        teardown do
+          @connection.drop_table "astronauts", if_exists: true
+          @connection.drop_table "rockets", if_exists: true
+        end
+
+        def test_add_foreign_key_inferes_column
+          @connection.add_foreign_key :astronauts, :rockets
+
+          foreign_keys = @connection.foreign_keys("astronauts")
+          assert_equal 1, foreign_keys.size
+
+          fk = foreign_keys.first
+          assert_equal "astronauts", fk.from_table
+          assert_equal "rockets", fk.to_table
+          assert_equal "rocket_id", fk.column
+          assert_equal "id", fk.primary_key
+          assert_equal("fk_rails_78146ddd2e", fk.name)
+        end
+
+        def test_add_foreign_key_with_column
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id"
+
+          foreign_keys = @connection.foreign_keys("astronauts")
+          assert_equal 1, foreign_keys.size
+
+          fk = foreign_keys.first
+          assert_equal "astronauts", fk.from_table
+          assert_equal "rockets", fk.to_table
+          assert_equal "rocket_id", fk.column
+          assert_equal "id", fk.primary_key
+          assert_equal("fk_rails_78146ddd2e", fk.name)
+        end
+
+        def test_add_on_delete_restrict_foreign_key
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", on_delete: :restrict
+
+          foreign_keys = @connection.foreign_keys("astronauts")
+          assert_equal 1, foreign_keys.size
+
+          fk = foreign_keys.first
+          assert_equal :restrict, fk.on_delete
+        end
+
+        def test_add_on_delete_cascade_foreign_key
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", on_delete: :cascade
+
+          foreign_keys = @connection.foreign_keys("astronauts")
+          assert_equal 1, foreign_keys.size
+
+          fk = foreign_keys.first
+          assert_equal :cascade, fk.on_delete
+        end
+
+        def test_add_on_delete_nullify_foreign_key
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", on_delete: :nullify
+
+          foreign_keys = @connection.foreign_keys("astronauts")
+          assert_equal 1, foreign_keys.size
+
+          fk = foreign_keys.first
+          assert_equal :nullify, fk.on_delete
+        end
+
+        def test_add_foreign_key_with_on_update
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", on_update: :nullify
+
+          foreign_keys = @connection.foreign_keys("astronauts")
+          assert_equal 1, foreign_keys.size
+
+          fk = foreign_keys.first
+          assert_equal :nullify, fk.on_update
+        end
+
+        def test_foreign_key_exists
+          @connection.add_foreign_key :astronauts, :rockets
+
+          assert @connection.foreign_key_exists?(:astronauts, :rockets)
+          assert_not @connection.foreign_key_exists?(:astronauts, :stars)
+        end
+
+        def test_foreign_key_exists_by_column
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id"
+
+          assert @connection.foreign_key_exists?(:astronauts, column: "rocket_id")
+          assert_not @connection.foreign_key_exists?(:astronauts, column: "star_id")
+        end
+
+        def test_foreign_key_exists_by_name
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", name: "fancy_named_fk"
+
+          assert @connection.foreign_key_exists?(:astronauts, name: "fancy_named_fk")
+          assert_not @connection.foreign_key_exists?(:astronauts, name: "other_fancy_named_fk")
+        end
+
+        def test_remove_foreign_key_inferes_column
+          @connection.add_foreign_key :astronauts, :rockets
+
+          assert_equal 1, @connection.foreign_keys("astronauts").size
+          @connection.remove_foreign_key :astronauts, :rockets
+          assert_equal [], @connection.foreign_keys("astronauts")
+        end
+
+        def test_remove_foreign_key_by_column
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id"
+
+          assert_equal 1, @connection.foreign_keys("astronauts").size
+          @connection.remove_foreign_key :astronauts, column: "rocket_id"
+          assert_equal [], @connection.foreign_keys("astronauts")
+        end
+
+        def test_remove_foreign_key_by_symbol_column
+          @connection.add_foreign_key :astronauts, :rockets, column: :rocket_id
+
+          assert_equal 1, @connection.foreign_keys("astronauts").size
+          @connection.remove_foreign_key :astronauts, column: :rocket_id
+          assert_equal [], @connection.foreign_keys("astronauts")
+        end
+
+        def test_remove_foreign_key_by_name
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", name: "fancy_named_fk"
+
+          assert_equal 1, @connection.foreign_keys("astronauts").size
+          @connection.remove_foreign_key :astronauts, name: "fancy_named_fk"
+          assert_equal [], @connection.foreign_keys("astronauts")
+        end
+
+        def test_remove_foreign_key_by_the_select_one_on_the_same_table
+          @connection.add_foreign_key :astronauts, :rockets
+          @connection.add_reference :astronauts, :myrocket, foreign_key: { to_table: :rockets }
+
+          assert_equal 2, @connection.foreign_keys("astronauts").size
+
+          @connection.remove_foreign_key :astronauts, :rockets, column: "myrocket_id"
+
+          assert_equal [["astronauts", "rockets", "rocket_id"]],
+            @connection.foreign_keys("astronauts").map { |fk| [fk.from_table, fk.to_table, fk.column] }
+        end
+
+        def test_add_invalid_foreign_key
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", validate: false
+
+          foreign_keys = @connection.foreign_keys("astronauts")
+          assert_equal 1, foreign_keys.size
+
+          fk = foreign_keys.first
+          assert_not_predicate fk, :validated?
+        end
+
+        def test_validate_foreign_key_infers_column
+          @connection.add_foreign_key :astronauts, :rockets, validate: false
+          assert_not_predicate @connection.foreign_keys("astronauts").first, :validated?
+
+          @connection.validate_foreign_key :astronauts, :rockets
+          assert_predicate @connection.foreign_keys("astronauts").first, :validated?
+        end
+
+        def test_validate_foreign_key_by_column
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", validate: false
+          assert_not_predicate @connection.foreign_keys("astronauts").first, :validated?
+
+          @connection.validate_foreign_key :astronauts, column: "rocket_id"
+          assert_predicate @connection.foreign_keys("astronauts").first, :validated?
+        end
+
+        def test_validate_foreign_key_by_symbol_column
+          @connection.add_foreign_key :astronauts, :rockets, column: :rocket_id, validate: false
+          assert_not_predicate @connection.foreign_keys("astronauts").first, :validated?
+
+          @connection.validate_foreign_key :astronauts, column: :rocket_id
+          assert_predicate @connection.foreign_keys("astronauts").first, :validated?
+        end
+
+        def test_validate_foreign_key_by_name
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", name: "fancy_named_fk", validate: false
+          assert_not_predicate @connection.foreign_keys("astronauts").first, :validated?
+
+          @connection.validate_foreign_key :astronauts, name: "fancy_named_fk"
+          assert_predicate @connection.foreign_keys("astronauts").first, :validated?
+        end
+
+        def test_validate_constraint_by_name
+          @connection.add_foreign_key :astronauts, :rockets, column: "rocket_id", name: "fancy_named_fk", validate: false
+
+          @connection.validate_constraint :astronauts, "fancy_named_fk"
+          assert_predicate @connection.foreign_keys("astronauts").first, :validated?
+        end
+
+        def test_schema_dumping
+          @connection.add_foreign_key :astronauts, :rockets
+          output = dump_table_schema "astronauts"
+          assert_match %r{\s+add_foreign_key "astronauts", "rockets"$}, output
+        end
+
+        class CreateCitiesAndHousesMigration < ActiveRecord::Migration::Current
+          def change
+            create_table("cities") { |t| }
+
+            create_table("houses") do |t|
+              t.references :city
+            end
+            add_foreign_key :houses, :cities, column: "city_id"
+
+            # remove and re-add to test that schema is updated and not accidentally cached
+            remove_foreign_key :houses, :cities
+            add_foreign_key :houses, :cities, column: "city_id", on_delete: :cascade
+          end
+        end
+
+        def test_add_foreign_key_is_reversible
+          migration = CreateCitiesAndHousesMigration.new
+          silence_stream($stdout) { migration.migrate(:up) }
+          assert_equal 1, @connection.foreign_keys("houses").size
+        ensure
+          silence_stream($stdout) { migration.migrate(:down) }
+        end
+
+        def test_foreign_key_constraint_is_not_cached_incorrectly
+          migration = CreateCitiesAndHousesMigration.new
+          silence_stream($stdout) { migration.migrate(:up) }
+          output = dump_table_schema "houses"
+          assert_match %r{\s+add_foreign_key "houses",.+on_delete: :cascade$}, output
+        ensure
+          silence_stream($stdout) { migration.migrate(:down) }
+        end
+
+        class CreateSchoolsAndClassesMigration < ActiveRecord::Migration::Current
+          def change
+            create_table(:schools)
+
+            create_table(:classes) do |t|
+              t.references :school
+            end
+            add_foreign_key :classes, :schools
+          end
+        end
+
+        def test_add_foreign_key_with_prefix
+          ActiveRecord::Base.table_name_prefix = "p_"
+          migration = CreateSchoolsAndClassesMigration.new
+          silence_stream($stdout) { migration.migrate(:up) }
+          assert_equal 1, @connection.foreign_keys("p_classes").size
+        ensure
+          silence_stream($stdout) { migration.migrate(:down) }
+          ActiveRecord::Base.table_name_prefix = nil
+        end
+
+        def test_add_foreign_key_with_suffix
+          ActiveRecord::Base.table_name_suffix = "_s"
+          migration = CreateSchoolsAndClassesMigration.new
+          silence_stream($stdout) { migration.migrate(:up) }
+          assert_equal 1, @connection.foreign_keys("classes_s").size
+        ensure
+          silence_stream($stdout) { migration.migrate(:down) }
+          ActiveRecord::Base.table_name_suffix = nil
+        end
+
+        def test_remove_foreign_key_with_if_exists_not_set
+          @connection.add_foreign_key :astronauts, :rockets
+          assert_equal 1, @connection.foreign_keys("astronauts").size
+
+          @connection.remove_foreign_key :astronauts, :rockets
+          assert_equal [], @connection.foreign_keys("astronauts")
+
+          error = assert_raises do
+            @connection.remove_foreign_key :astronauts, :rockets
+          end
+
+          assert_equal("Table 'astronauts' has no foreign key for rockets", error.message)
+        end
+
+        def test_remove_foreign_key_with_if_exists_set
+          @connection.add_foreign_key :astronauts, :rockets
+          assert_equal 1, @connection.foreign_keys("astronauts").size
+
+          @connection.remove_foreign_key :astronauts, :rockets
+          assert_equal [], @connection.foreign_keys("astronauts")
+
+          assert_nothing_raised do
+            @connection.remove_foreign_key :astronauts, :rockets, if_exists: true
+          end
+        end
+
+        def test_add_foreign_key_with_if_not_exists_not_set
+          @connection.add_foreign_key :astronauts, :rockets
+          assert_equal 1, @connection.foreign_keys("astronauts").size
+
+          if current_adapter?(:SQLite3Adapter)
+            assert_nothing_raised do
+              @connection.add_foreign_key :astronauts, :rockets
+            end
+          else
+            error = assert_raises do
+              @connection.add_foreign_key :astronauts, :rockets
+            end
+
+            if current_adapter?(:Mysql2Adapter)
+              if ActiveRecord::Base.lease_connection.mariadb?
+                assert_match(/Duplicate key on write or update/, error.message)
+              elsif ActiveRecord::Base.lease_connection.database_version < "5.6"
+                assert_match(/Can't create table/, error.message)
+              else
+                assert_match(/Duplicate foreign key constraint name/, error.message)
+              end
+            else
+              assert_match(/PG::DuplicateObject: ERROR:  duplicate constraint name:*./, error.message)
+            end
+
+          end
+        end
+
+        def test_add_foreign_key_with_if_not_exists_set
+          @connection.add_foreign_key :astronauts, :rockets
+          assert_equal 1, @connection.foreign_keys("astronauts").size
+
+          assert_nothing_raised do
+            @connection.add_foreign_key :astronauts, :rockets, if_not_exists: true
+          end
+        end
+      end
+
+      class CompositeForeignKeyTest < ActiveRecord::TestCase
+        include SchemaDumpingHelper
+
+        self.use_transactional_tests = false
+
+        setup do
+          @connection = ActiveRecord::Base.lease_connection
+          @connection.create_table :rockets, primary_key: [:tenant_id, :id], force: true do |t|
+            t.integer :tenant_id
+            t.integer :id
+          end
+          @connection.create_table :astronauts, force: true do |t|
+            t.integer :rocket_id
+            t.integer :rocket_tenant_id
+          end
+        end
+
+        teardown do
+          @connection.drop_table :astronauts, if_exists: true
+          @connection.drop_table :rockets, if_exists: true
+        end
+
+        # OVERRIDE: CockroachDB does not quote the table name.
+        def test_add_composite_foreign_key_raises_without_options
+          error = assert_raises(ActiveRecord::StatementInvalid) do
+            @connection.add_foreign_key :astronauts, :rockets
+          end
+
+          assert_match(/there is no unique constraint matching given keys for referenced table rockets/, error.message)
+        end
+      end
+    end
+  end
+end

data/test/cases/migration/hidden_column_test.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "cases/helper"
+require "support/schema_dumping_helper"
+
+module ActiveRecord
+  module CockroachDB
+    class Migration
+      class HiddenColumnTest < ActiveRecord::TestCase
+        include SchemaDumpingHelper
+        include ActiveSupport::Testing::Stream
+
+        self.use_transactional_tests = false
+
+        class Rocket < ActiveRecord::Base
+        end
+
+        class Astronaut < ActiveRecord::Base
+        end
+
+        setup do
+          @connection = ActiveRecord::Base.lease_connection
+          @connection.create_table "rockets", force: true do |t|
+            t.string :name
+          end
+
+          @connection.create_table "astronauts", force: true do |t|
+            t.string :name
+            t.bigint :secret_id, hidden: true
+          end
+        end
+
+        teardown do
+          @connection.drop_table "astronauts", if_exists: true
+          @connection.drop_table "rockets", if_exists: true
+        end
+
+        # rowid is a special hidden column. CRDB implicitly adds it, so it should
+        # not appear in the schema dump.
+        def test_rowid_not_in_dump
+          output = dump_table_schema "rockets"
+          assert_match %r{create_table "rockets", id: false, force: :cascade do |t|"$}, output
+          assert_no_match %r{rowid}, output
+        end
+
+        def test_hidden_column
+          output = dump_table_schema "astronauts"
+          assert_match %r{t.bigint "secret_id", hidden: true$}, output
+        end
+
+        def test_add_hidden_column
+          @connection.add_column :rockets, :new_col, :uuid, hidden: true
+          output = dump_table_schema "rockets"
+          assert_match %r{t.uuid "new_col", hidden: true$}, output
+        end
+
+        # Since 24.2.2, hash sharded indexes add a hidden column to the table.
+        # This tests ensure that the user can still drop the index even if they
+        # call `#remove_index` with the column name rather than the index name.
+        def test_remove_index_with_a_hidden_column
+          @connection.execute <<-SQL
+            CREATE INDEX hash_idx ON rockets (name) USING HASH WITH (bucket_count=8);
+          SQL
+          @connection.remove_index :rockets, :name
+          assert :ok
+        end
+      end
+    end
+  end
+end