test: introduce assert_same_elements where order doesn't matter

instead of explicitly sorting arrays in the test for comparison

Author: flavorjones

test/test_helper.rb

@@ -17,21 +17,20 @@ module Tenanted
     class TestCase < ActiveSupport::TestCase
       extend Minitest::Spec::DSL
 
-      # When used with Minitest::Spec's `describe`, ActiveSupport::Testing's `test` creates methods
-      # that may be inherited by subsequent describe blocks and run multiple times. Warn us if this
-      # happens. (Note that Minitest::Spec's `it` doesn't do this.)
-      def self.test(name, &block)
-        if self.children.any?
-          c = caller_locations[0]
-          path = Pathname.new(c.path).relative_path_from(Pathname.new(Dir.pwd))
-          puts "WARNING: #{path}:#{__LINE__}: test #{name.inspect} is being inherited"
-        end
-
-        super
-      end
+      class << self
+        # When used with Minitest::Spec's `describe`, ActiveSupport::Testing's `test` creates methods
+        # that may be inherited by subsequent describe blocks and run multiple times. Warn us if this
+        # happens. (Note that Minitest::Spec's `it` doesn't do this.)
+        def test(name, &block)
+          if self.children.any?
+            c = caller_locations[0]
+            path = Pathname.new(c.path).relative_path_from(Pathname.new(Dir.pwd))
+            puts "WARNING: #{path}:#{__LINE__}: test #{name.inspect} is being inherited"
+          end
 
+          super
+        end
 
-      class << self
         def for_each_scenario(s = all_scenarios, &block)
           s.each do |db_scenario, model_scenarios|
             with_db_scenario(db_scenario) do
@@ -143,6 +142,10 @@ def with_new_migration_file
                      File.join(db_path, "tenanted_migrations")
       end
 
+      def assert_same_elements(expected, actual)
+        assert_equal(expected.sort, actual.sort, "Elements don't match")
+      end
+
       def capture_log
         StringIO.new.tap do |log|
           logger_was, ActiveRecord::Base.logger = ActiveRecord::Base.logger, ActiveSupport::Logger.new(log)

test/unit/base_test.rb

@@ -91,10 +91,10 @@
         test "models can be created" do
           user = User.new
 
-          assert_equal([ "id", "email", "created_at", "updated_at" ].sort,
-                       user.attributes.keys.sort)
-          assert_equal([ "id", "email", "created_at", "updated_at" ].sort,
-                       User.column_names.sort)
+          assert_same_elements([ "id", "email", "created_at", "updated_at" ],
+                               user.attributes.keys)
+          assert_same_elements([ "id", "email", "created_at", "updated_at" ],
+                               User.column_names)
         end
 
         test "schema cache can be loaded" do

test/unit/database_configurations_test.rb

@@ -54,7 +54,7 @@
 
           TenantedApplicationRecord.while_tenanted("bar") { User.count }
 
-          assert_equal([ "foo", "bar" ].sort, tenanted_config.tenants.sort)
+          assert_same_elements([ "foo", "bar" ], tenanted_config.tenants)
 
           TenantedApplicationRecord.destroy_tenant("foo")
 

test/unit/tenant_test.rb

@@ -208,7 +208,7 @@
 
         TenantedApplicationRecord.while_tenanted("bar") { User.count }
 
-        assert_equal([ "foo", "bar" ].sort, TenantedApplicationRecord.tenants.sort)
+        assert_same_elements([ "foo", "bar" ], TenantedApplicationRecord.tenants)
 
         TenantedApplicationRecord.destroy_tenant("foo")
 
@@ -292,8 +292,8 @@
                 User.count
               end
               assert_equal(20250213005959, User.connection_pool.migration_context.current_version)
-              assert_equal([ "id", "email", "created_at", "updated_at", "age" ].sort,
-                           User.new.attributes.keys.sort)
+              assert_same_elements([ "id", "email", "created_at", "updated_at", "age" ],
+                                   User.new.attributes.keys)
             end
           end
         end
@@ -305,8 +305,8 @@
 
         describe "before a connection is made" do
           test "models can be created but migration is not applied" do
-            assert_equal([ "id", "email", "created_at", "updated_at" ].sort,
-                         User.new.attributes.keys.sort)
+            assert_same_elements([ "id", "email", "created_at", "updated_at" ],
+                                 User.new.attributes.keys)
           end
         end
 
@@ -319,8 +319,8 @@
                 User.count
               end
               assert_equal(20250213005959, User.connection_pool.migration_context.current_version)
-              assert_equal([ "id", "email", "created_at", "updated_at", "age" ].sort,
-                           User.new.attributes.keys.sort)
+              assert_same_elements([ "id", "email", "created_at", "updated_at", "age" ],
+                                   User.new.attributes.keys)
             end
           end
         end