From df0de681dc1873534ecd2fc8371e1f2562984b68 Mon Sep 17 00:00:00 2001
From: John Crepezzi <john.crepezzi@gmail.com>
Date: Thu, 16 Jun 2022 08:34:05 -0400
Subject: [PATCH] Remove the multi-call form of assert_called_with
The `assert_called_with` helper allows passing a multi-dimensional array to
mock multiple calls to the same method for a given block. This works
fine now, but when adding support for real kwargs arguments to line up with
recent upgrades in Minitest, this approach is no longer workable because
we can't pass multiple sets of differing kwargs.
Rather than complicated this method further, this commit removes the
multi-call form of `assert_called_with` and modifies the tests that
currently make use of that functionality to just use the underlying
`Minitest::Mock` calls.
Co-authored-by: Eileen M. Uchitelle <eileencodes@gmail.com>
---
.../test/cases/tasks/database_tasks_test.rb | 71 ++++++++---------
.../test/cases/tasks/mysql_rake_test.rb | 15 ++--
.../test/cases/tasks/postgresql_rake_test.rb | 76 +++++++------------
3 files changed, 72 insertions(+), 90 deletions(-)
diff --git a/activerecord/test/cases/tasks/database_tasks_test.rb b/activerecord/test/cases/tasks/database_tasks_test.rb
index 70c378c6680a9..9aa4da54d889a 100644
--- a/activerecord/test/cases/tasks/database_tasks_test.rb
+++ b/activerecord/test/cases/tasks/database_tasks_test.rb
@@ -39,6 +39,16 @@ def with_stubbed_new(&block)
end
end
+ module DatabaseTasksHelper
+ def assert_called_for_configs(method_name, configs, &block)
+ mock = Minitest::Mock.new
+ configs.each { |config| mock.expect(:call, nil, config) }
+
+ ActiveRecord::Tasks::DatabaseTasks.stub(method_name, mock, &block)
+ assert_mock(mock)
+ end
+ end
+
ADAPTERS_TASKS = {
mysql2: :mysql_tasks,
postgresql: :postgresql_tasks,
@@ -368,6 +378,8 @@ def with_stubbed_configurations_establish_connection(&block)
end
class DatabaseTasksCreateCurrentTest < ActiveRecord::TestCase
+ include DatabaseTasksHelper
+
def setup
@configurations = {
"development" => { "database" => "dev-db" },
@@ -406,8 +418,7 @@ def test_creates_current_environment_database_with_url
def test_creates_test_and_development_databases_when_env_was_not_specified
with_stubbed_configurations_establish_connection do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:create,
[
[config_for("development", "primary")],
@@ -426,8 +437,7 @@ def test_creates_test_and_development_databases_when_rails_env_is_development
ENV["RAILS_ENV"] = "development"
with_stubbed_configurations_establish_connection do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:create,
[
[config_for("development", "primary")],
@@ -449,8 +459,7 @@ def test_creates_development_database_without_test_database_when_skip_test_datab
ENV["SKIP_TEST_DATABASE"] = "true"
with_stubbed_configurations_establish_connection do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:create,
[
[config_for("development", "primary")]
@@ -492,6 +501,8 @@ def with_stubbed_configurations_establish_connection(&block)
end
class DatabaseTasksCreateCurrentThreeTierTest < ActiveRecord::TestCase
+ include DatabaseTasksHelper
+
def setup
@configurations = {
"development" => { "primary" => { "database" => "dev-db" }, "secondary" => { "database" => "secondary-dev-db" } },
@@ -502,8 +513,7 @@ def setup
def test_creates_current_environment_database
with_stubbed_configurations_establish_connection do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:create,
[
[config_for("test", "primary")],
@@ -519,8 +529,7 @@ def test_creates_current_environment_database
def test_creates_current_environment_database_with_url
with_stubbed_configurations_establish_connection do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:create,
[
[config_for("production", "primary")],
@@ -536,8 +545,7 @@ def test_creates_current_environment_database_with_url
def test_creates_test_and_development_databases_when_env_was_not_specified
with_stubbed_configurations_establish_connection do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:create,
[
[config_for("development", "primary")],
@@ -558,8 +566,7 @@ def test_creates_test_and_development_databases_when_rails_env_is_development
ENV["RAILS_ENV"] = "development"
with_stubbed_configurations_establish_connection do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:create,
[
[config_for("development", "primary")],
@@ -705,6 +712,8 @@ def with_stubbed_configurations
end
class DatabaseTasksDropCurrentTest < ActiveRecord::TestCase
+ include DatabaseTasksHelper
+
def setup
@configurations = {
"development" => { "database" => "dev-db" },
@@ -743,8 +752,7 @@ def test_drops_current_environment_database_with_url
def test_drops_test_and_development_databases_when_env_was_not_specified
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:drop,
[
[config_for("development", "primary")],
@@ -763,8 +771,7 @@ def test_drops_testand_development_databases_when_rails_env_is_development
ENV["RAILS_ENV"] = "development"
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:drop,
[
[config_for("development", "primary")],
@@ -796,6 +803,8 @@ def with_stubbed_configurations
end
class DatabaseTasksDropCurrentThreeTierTest < ActiveRecord::TestCase
+ include DatabaseTasksHelper
+
def setup
@configurations = {
"development" => { "primary" => { "database" => "dev-db" }, "secondary" => { "database" => "secondary-dev-db" } },
@@ -806,8 +815,7 @@ def setup
def test_drops_current_environment_database
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:drop,
[
[config_for("test", "primary")],
@@ -823,8 +831,7 @@ def test_drops_current_environment_database
def test_drops_current_environment_database_with_url
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:drop,
[
[config_for("production", "primary")],
@@ -840,8 +847,7 @@ def test_drops_current_environment_database_with_url
def test_drops_test_and_development_databases_when_env_was_not_specified
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:drop,
[
[config_for("development", "primary")],
@@ -862,8 +868,7 @@ def test_drops_testand_development_databases_when_rails_env_is_development
ENV["RAILS_ENV"] = "development"
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:drop,
[
[config_for("development", "primary")],
@@ -1232,6 +1237,8 @@ class DatabaseTasksTruncateAllWithSuffixTest < DatabaseTasksTruncateAllTest
end
class DatabaseTasksTruncateAllWithMultipleDatabasesTest < ActiveRecord::TestCase
+ include DatabaseTasksHelper
+
def setup
@configurations = {
"development" => { "primary" => { "database" => "dev-db" }, "secondary" => { "database" => "secondary-dev-db" } },
@@ -1242,8 +1249,7 @@ def setup
def test_truncate_all_databases_for_environment
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:truncate_tables,
[
[config_for("test", "primary")],
@@ -1259,8 +1265,7 @@ def test_truncate_all_databases_for_environment
def test_truncate_all_databases_with_url_for_environment
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:truncate_tables,
[
[config_for("production", "primary")],
@@ -1276,8 +1281,7 @@ def test_truncate_all_databases_with_url_for_environment
def test_truncate_all_development_databases_when_env_is_not_specified
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:truncate_tables,
[
[config_for("development", "primary")],
@@ -1296,8 +1300,7 @@ def test_truncate_all_development_databases_when_env_is_development
ENV["RAILS_ENV"] = "development"
with_stubbed_configurations do
- assert_called_with(
- ActiveRecord::Tasks::DatabaseTasks,
+ assert_called_for_configs(
:truncate_tables,
[
[config_for("development", "primary")],
diff --git a/activerecord/test/cases/tasks/mysql_rake_test.rb b/activerecord/test/cases/tasks/mysql_rake_test.rb
index 75f557444c535..5fa3c500cfc36 100644
--- a/activerecord/test/cases/tasks/mysql_rake_test.rb
+++ b/activerecord/test/cases/tasks/mysql_rake_test.rb
@@ -26,18 +26,17 @@ def teardown
def test_establishes_connection_without_database
db_config = ActiveRecord::DatabaseConfigurations::HashConfig.new("default_env", "primary", @configuration)
+ mock = Minitest::Mock.new
+ mock.expect(:call, nil, [adapter: "mysql2", database: nil])
+ mock.expect(:call, nil, [db_config])
+
ActiveRecord::Base.stub(:connection, @connection) do
- assert_called_with(
- ActiveRecord::Base,
- :establish_connection,
- [
- [adapter: "mysql2", database: nil],
- [db_config]
- ]
- ) do
+ ActiveRecord::Base.stub(:establish_connection, mock) do
ActiveRecord::Tasks::DatabaseTasks.create(db_config)
end
end
+
+ assert_mock(mock)
end
def test_creates_database_with_no_default_options
diff --git a/activerecord/test/cases/tasks/postgresql_rake_test.rb b/activerecord/test/cases/tasks/postgresql_rake_test.rb
index 5c5df88e96afb..3b328cb5d5603 100644
--- a/activerecord/test/cases/tasks/postgresql_rake_test.rb
+++ b/activerecord/test/cases/tasks/postgresql_rake_test.rb
@@ -23,22 +23,17 @@ def teardown
def test_establishes_connection_to_postgresql_database
db_config = ActiveRecord::DatabaseConfigurations::HashConfig.new("default_env", "primary", @configuration)
+ mock = Minitest::Mock.new
+ mock.expect(:call, nil, [{ adapter: "postgresql", database: "postgres", schema_search_path: "public" }])
+ mock.expect(:call, nil, [db_config])
+
ActiveRecord::Base.stub(:connection, @connection) do
- assert_called_with(
- ActiveRecord::Base,
- :establish_connection,
- [
- [
- adapter: "postgresql",
- database: "postgres",
- schema_search_path: "public"
- ],
- [db_config]
- ]
- ) do
+ ActiveRecord::Base.stub(:establish_connection, mock) do
ActiveRecord::Tasks::DatabaseTasks.create(db_config)
end
end
+
+ assert_mock(mock)
end
def test_creates_database_with_default_encoding
@@ -89,22 +84,17 @@ def test_creates_database_with_given_collation_and_ctype
def test_establishes_connection_to_new_database
db_config = ActiveRecord::DatabaseConfigurations::HashConfig.new("default_env", "primary", @configuration)
+ mock = Minitest::Mock.new
+ mock.expect(:call, nil, [{ adapter: "postgresql", database: "postgres", schema_search_path: "public" }])
+ mock.expect(:call, nil, [db_config])
+
ActiveRecord::Base.stub(:connection, @connection) do
- assert_called_with(
- ActiveRecord::Base,
- :establish_connection,
- [
- [
- adapter: "postgresql",
- database: "postgres",
- schema_search_path: "public"
- ],
- [db_config]
- ]
- ) do
+ ActiveRecord::Base.stub(:establish_connection, mock) do
ActiveRecord::Tasks::DatabaseTasks.create(db_config)
end
end
+
+ assert_mock(mock)
end
def test_db_create_with_error_prints_message
@@ -229,22 +219,17 @@ def test_clears_active_connections
def test_establishes_connection_to_postgresql_database
db_config = ActiveRecord::DatabaseConfigurations::HashConfig.new("default_env", "primary", @configuration)
+ mock = Minitest::Mock.new
+ mock.expect(:call, nil, [{ adapter: "postgresql", database: "postgres", schema_search_path: "public" }])
+ mock.expect(:call, nil, [db_config])
+
with_stubbed_connection do
- assert_called_with(
- ActiveRecord::Base,
- :establish_connection,
- [
- [
- adapter: "postgresql",
- database: "postgres",
- schema_search_path: "public"
- ],
- [db_config]
- ]
- ) do
+ ActiveRecord::Base.stub(:establish_connection, mock) do
ActiveRecord::Tasks::DatabaseTasks.purge(db_config)
end
end
+
+ assert_mock(mock)
end
def test_drops_database
@@ -274,22 +259,17 @@ def test_creates_database
def test_establishes_connection
db_config = ActiveRecord::DatabaseConfigurations::HashConfig.new("default_env", "primary", @configuration)
+ mock = Minitest::Mock.new
+ mock.expect(:call, nil, [{ adapter: "postgresql", database: "postgres", schema_search_path: "public" }])
+ mock.expect(:call, nil, [db_config])
+
with_stubbed_connection do
- assert_called_with(
- ActiveRecord::Base,
- :establish_connection,
- [
- [
- adapter: "postgresql",
- database: "postgres",
- schema_search_path: "public"
- ],
- [db_config]
- ]
- ) do
+ ActiveRecord::Base.stub(:establish_connection, mock) do
ActiveRecord::Tasks::DatabaseTasks.purge(db_config)
end
end
+
+ assert_mock(mock)
end
private