active_record_doctor 1.5.0 → 1.8.0

data/test/active_record_doctor/detectors/missing_foreign_keys_test.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::MissingForeignKeysTest < Minitest::Test
+  def test_missing_foreign_key_is_reported
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: false
+    end
+
+    assert_problems(<<OUTPUT)
+The following columns lack a foreign key constraint:
+  users company_id
+OUTPUT
+  end
+
+  def test_present_foreign_key_is_not_reported
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company, foreign_key: true
+    end
+
+    refute_problems
+  end
+end

data/test/active_record_doctor/detectors/missing_non_null_constraint_test.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::MissingNonNullConstraintTest < Minitest::Test
+  def test_presence_true_and_null_true
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      validates :name, presence: true
+    end
+
+    assert_problems(<<OUTPUT)
+The following columns should be marked as `null: false`:
+  users: name
+OUTPUT
+  end
+
+  def test_association_presence_true_and_null_true
+    create_table(:companies)
+    create_table(:users) do |t|
+      t.references :company
+    end.create_model do
+      belongs_to :company, required: true
+    end
+
+    assert_problems(<<OUTPUT)
+The following columns should be marked as `null: false`:
+  users: company_id
+OUTPUT
+  end
+
+  def test_presence_true_and_null_false
+    create_table(:users) do |t|
+      t.string :name, null: false
+    end.create_model do
+      validates :name, presence: true
+    end
+
+    refute_problems
+  end
+
+  def test_presence_false_and_null_true
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      # The age validator is a form of regression test against a bug that
+      # caused false positives. In this test case, name is NOT validated
+      # for presence so it does NOT need be marked non-NULL. However, the
+      # bug would match the age presence validator with the NULL-able name
+      # column which would result in a false positive error report.
+      validates :age, presence: true
+      validates :name, presence: false
+    end
+
+    refute_problems
+  end
+
+  def test_presence_false_and_null_false
+    create_table(:users) do |t|
+      t.string :name, null: false
+    end.create_model do
+      validates :name, presence: false
+    end
+
+    refute_problems
+  end
+
+  def test_presence_true_with_if
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      validates :name, presence: true, if: -> { false }
+    end
+
+    refute_problems
+  end
+
+  def test_presence_true_with_unless
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      validates :name, presence: true, unless: -> { false }
+    end
+
+    refute_problems
+  end
+
+  def test_presence_true_with_allow_nil
+    create_table(:users) do |t|
+      t.string :name, null: true
+    end.create_model do
+      validates :name, presence: true, allow_nil: true
+    end
+
+    refute_problems
+  end
+
+  def test_models_with_non_existent_tables_are_skipped
+    create_model(:users)
+
+    refute_problems
+  end
+end

data/test/active_record_doctor/detectors/missing_presence_validation_test.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::MissingPresenceValidationTest < Minitest::Test
+  def test_null_column_is_not_reported_if_validation_absent
+    create_table(:users) do |t|
+      t.string :name
+    end.create_model do
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_column_is_reported_if_validation_absent
+    create_table(:users) do |t|
+      t.string :name, null: false
+    end.create_model do
+    end
+
+    assert_problems(<<OUTPUT)
+The following models and columns should have presence validations:
+  ModelFactory::Models::User: name
+OUTPUT
+  end
+
+  def test_non_null_column_is_not_reported_if_validation_present
+    create_table(:users) do |t|
+      t.string :name, null: false
+    end.create_model do
+      validates :name, presence: true
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_column_is_not_reported_if_association_validation_present
+    create_table(:companies).create_model
+    create_table(:users) do |t|
+      t.references :company, null: false
+    end.create_model do
+      belongs_to :company, required: true
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_boolean_is_reported_if_nil_included
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.create_model do
+      validates :active, inclusion: { in: [nil, true, false] }
+    end
+
+    assert_problems(<<OUTPUT)
+The following models and columns should have presence validations:
+  ModelFactory::Models::User: active
+OUTPUT
+  end
+
+  def test_non_null_boolean_is_not_reported_if_nil_not_included
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.create_model do
+      validates :active, inclusion: { in: [true, false] }
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_boolean_is_not_reported_if_nil_excluded
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.create_model do
+      validates :active, exclusion: { in: [nil] }
+    end
+
+    refute_problems
+  end
+
+  def test_non_null_boolean_is_reported_if_nil_not_excluded
+    create_table(:users) do |t|
+      t.boolean :active, null: false
+    end.create_model do
+      validates :active, exclusion: { in: [false] }
+    end
+
+    assert_problems(<<OUTPUT)
+The following models and columns should have presence validations:
+  ModelFactory::Models::User: active
+OUTPUT
+  end
+
+  def test_timestamps_are_not_reported
+    create_table(:users) do |t|
+      t.timestamps null: false
+    end.create_model do
+      validates :name, presence: true
+    end
+
+    refute_problems
+  end
+
+  def test_models_with_non_existent_tables_are_skipped
+    create_model(:users)
+
+    refute_problems
+  end
+end

data/test/active_record_doctor/detectors/missing_unique_indexes_test.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::MissingUniqueIndexesTest < Minitest::Test
+  def test_missing_unique_index
+    create_table(:users) do |t|
+      t.string :email
+      t.index :email
+    end.create_model do
+      validates :email, uniqueness: true
+    end
+
+    assert_problems(<<OUTPUT)
+The following indexes should be created to back model-level uniqueness validations:
+  users: email
+OUTPUT
+  end
+
+  def test_present_unique_index
+    create_table(:users) do |t|
+      t.string :email
+      t.index :email, unique: true
+    end.create_model do
+      validates :email, uniqueness: true
+    end
+
+    refute_problems
+  end
+
+  def test_missing_unique_index_with_scope
+    create_table(:users) do |t|
+      t.string :email
+      t.integer :company_id
+      t.integer :department_id
+      t.index [:company_id, :department_id, :email]
+    end.create_model do
+      validates :email, uniqueness: { scope: [:company_id, :department_id] }
+    end
+
+    assert_problems(<<OUTPUT)
+The following indexes should be created to back model-level uniqueness validations:
+  users: company_id, department_id, email
+OUTPUT
+  end
+
+  def test_present_unique_index_with_scope
+    create_table(:users) do |t|
+      t.string :email
+      t.integer :company_id
+      t.integer :department_id
+      t.index [:company_id, :department_id, :email], unique: true
+    end.create_model do
+      validates :email, uniqueness: { scope: [:company_id, :department_id] }
+    end
+
+    refute_problems
+  end
+
+  def test_column_order_is_ignored
+    create_table(:users) do |t|
+      t.string :email
+      t.integer :organization_id
+
+      t.index [:email, :organization_id], unique: true
+    end.create_model do
+      validates :email, uniqueness: { scope: :organization_id }
+    end
+
+    refute_problems
+  end
+
+  def test_conditions_is_skipped
+    assert_skipped(conditions: -> { where.not(email: nil) })
+  end
+
+  def test_case_insensitive_is_skipped
+    assert_skipped(case_sensitive: false)
+  end
+
+  def test_if_is_skipped
+    assert_skipped(if: ->(_model) { true })
+  end
+
+  def test_unless_is_skipped
+    assert_skipped(unless: ->(_model) { true })
+  end
+
+  def test_skips_validator_without_attributes
+    create_table(:users) do |t|
+      t.string :email
+      t.index :email
+    end.create_model do
+      validates_with DummyValidator
+    end
+
+    refute_problems
+  end
+
+  class DummyValidator < ActiveModel::Validator
+    def validate(record)
+    end
+  end
+
+  private
+
+  def assert_skipped(options)
+    create_table(:users) do |t|
+      t.string :email
+    end.create_model do
+      validates :email, uniqueness: options
+    end
+
+    refute_problems
+  end
+end

data/test/active_record_doctor/detectors/undefined_table_references_test.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::UndefinedTableReferencesTest < Minitest::Test
+  def test_table_exists
+    create_table(:users) do
+    end.create_model do
+    end
+
+    refute_problems
+  end
+
+  def test_table_does_not_exist_when_views_supported
+    create_model(:users)
+
+    if mysql? && ActiveRecord::VERSION::STRING < "5.0"
+      assert_problems(<<OUTPUT)
+WARNING: Models backed by database views are supported only in Rails 5+ OR
+Rails 4.2 + PostgreSQL. It seems this is NOT your setup. Therefore, such models
+will be erroneously reported below as not having their underlying tables/views.
+Consider upgrading Rails or disabling this task temporarily.
+The following models reference undefined tables:
+  ModelFactory::Models::User (the table users is undefined)
+OUTPUT
+    else
+      assert_problems(<<OUTPUT)
+The following models reference undefined tables:
+  ModelFactory::Models::User (the table users is undefined)
+OUTPUT
+    end
+  end
+
+  def test_view_instead_of_table
+    # We replace the underlying table with a view. The view doesn't have to be
+    # backed by an actual table - it can simply return a predefined tuple.
+    ActiveRecord::Base.connection.execute("CREATE VIEW users AS SELECT 1")
+    create_model(:users)
+
+    begin
+      refute_problems
+    ensure
+      ActiveRecord::Base.connection.execute("DROP VIEW users")
+    end
+  end
+end

data/test/active_record_doctor/detectors/unindexed_deleted_at_test.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class ActiveRecordDoctor::Detectors::UnindexedDeletedAtTest < Minitest::Test
+  def test_indexed_deleted_at_is_not_reported
+    skip("MySQL doesn't support partial indexes") if mysql?
+
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.datetime :deleted_at
+      t.index [:first_name, :last_name],
+        name: "index_profiles_on_first_name_and_last_name",
+        where: "deleted_at IS NULL"
+    end
+
+    refute_problems
+  end
+
+  def test_unindexed_deleted_at_is_reported
+    skip("MySQL doesn't support partial indexes") if mysql?
+
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.datetime :deleted_at
+      t.index [:first_name, :last_name],
+        name: "index_profiles_on_first_name_and_last_name"
+    end
+
+    assert_problems(<<OUTPUT)
+The following indexes should include `deleted_at IS NULL`:
+  index_profiles_on_first_name_and_last_name
+OUTPUT
+  end
+
+  def test_indexed_discarded_at_is_not_reported
+    skip("MySQL doesn't support partial indexes") if mysql?
+
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.datetime :discarded_at
+      t.index [:first_name, :last_name],
+        name: "index_profiles_on_first_name_and_last_name",
+        where: "discarded_at IS NULL"
+    end
+
+    refute_problems
+  end
+
+  def test_unindexed_discarded_at_is_reported
+    skip("MySQL doesn't support partial indexes") if mysql?
+
+    create_table(:users) do |t|
+      t.string :first_name
+      t.string :last_name
+      t.datetime :discarded_at
+      t.index [:first_name, :last_name],
+        name: "index_profiles_on_first_name_and_last_name"
+    end
+
+    assert_problems(<<OUTPUT)
+The following indexes should include `deleted_at IS NULL`:
+  index_profiles_on_first_name_and_last_name
+OUTPUT
+  end
+end