Refactor tests to use seed data.

Author: gregschmit

bin/reloader

@@ -18,12 +18,12 @@ LISTEN_DIRS = %w[
   test/test
 ].map { |dir| File.join(PROJECT_ROOT, dir) }
 
-def reload
+def reload(skip_seed: false)
   # Reload Puma.
   system("kill -USR1 $(cat #{PUMA_PID_PATH})")
 
   # Run the test suite (generates coverage report).
-  system("bin/rails test")
+  system("#{"SKIP_SEED=1" if skip_seed} bin/rails test".strip)
 
   # Generate brakeman report.
   system("bin/brakeman")
@@ -34,7 +34,7 @@ reload
 
 listener = Listen.to(*LISTEN_DIRS) do |modified, added, removed|
   puts(modified: modified, added: added, removed: removed)
-  reload
+  reload(skip_seed: true)
 end
 
 listener.start

test/app/models/email.rb

@@ -1,4 +1,4 @@
 class Email < ApplicationRecord
-  belongs_to :user
+  belongs_to :user, optional: true
   has_one :billing_user, class_name: "User", inverse_of: :billing_email
 end

test/app/models/user.rb

@@ -9,12 +9,7 @@ class User < ApplicationRecord
 
   # This association is purposefully named differently than the column to test how this affects the
   # framework.
-  belongs_to(
-    :billing_email,
-    optional: true,
-    class_name: "Email",
-    foreign_key: "email_id",
-  )
+  belongs_to(:billing_email, optional: true, class_name: "Email", foreign_key: "finance_email_id")
 
   belongs_to :manager, class_name: "User", optional: true
   has_and_belongs_to_many :movies

test/db/migrate/20240906180000_test_app_tables.rb

@@ -28,7 +28,12 @@ def change
       t.references(:user, null: true, foreign_key: {on_delete: :nullify})
     end
 
-    add_reference(:users, :email, foreign_key: {on_delete: :nullify}, index: {unique: true})
+    add_reference(
+      :users,
+      :finance_email,
+      foreign_key: {to_table: :emails, on_delete: :nullify},
+      index: {unique: true},
+    )
 
     create_table(:phone_numbers) do |t|
       t.string(:number, null: false, default: "", index: {unique: true})

test/db/schema.rb

@@ -115,8 +115,8 @@
     t.integer "manager_id"
     t.datetime "created_at"
     t.datetime "updated_at"
-    t.integer "email_id"
-    t.index ["email_id"], name: "index_users_on_email_id", unique: true
+    t.integer "finance_email_id"
+    t.index ["finance_email_id"], name: "index_users_on_finance_email_id", unique: true
     t.index ["login"], name: "index_users_on_login", unique: true
     t.index ["manager_id"], name: "index_users_on_manager_id"
   end
@@ -130,6 +130,6 @@
   add_foreign_key "movies_users", "movies", on_delete: :cascade
   add_foreign_key "movies_users", "users", on_delete: :cascade
   add_foreign_key "phone_numbers", "users", on_delete: :cascade
-  add_foreign_key "users", "emails", on_delete: :nullify
+  add_foreign_key "users", "emails", column: "finance_email_id", on_delete: :nullify
   add_foreign_key "users", "users", column: "manager_id", on_delete: :nullify
 end

test/db/seeds.rb

@@ -1,6 +1,17 @@
-# Seed data is used for the Demo API.
+# Seed data is used for the Demo API as well as initial test data in lieu of fixtures.
+
+# Always clear the database before seeding.
+puts "Clearing database..."
+Email.delete_all
+Genre.delete_all
+Movie.delete_all
+PhoneNumber.delete_all
+User.delete_all
 
 Faker::Config.random = Random.new(42)
+srand(42)
+
+puts "Seed data loading..."
 
 example = User.create!(
   login: "example",
@@ -18,25 +29,37 @@
 example.update!(manager: admin)
 
 1000.times do |_|
-  # Create with faker data:
   legal_name = Faker::Name.name_with_middle
-  short_name = legal_name.split(" ").first
-  begin
-    User.create!(
-      login: Faker::Internet.username,
-      legal_name: legal_name,
-      short_name: short_name,
-      age: rand(18..65),
-      is_admin: rand < 0.2,
-      balance: rand(0.0..10000.0),
-      state: [0, 0, 0, 0, User.states.keys.sample].sample,
-      status: User::STATUS_OPTS.keys.sample,
-      day_start: ["7:30", "8:00", "8:30", "9:00", "9:30"].sample,
-      last_reviewed_on: Time.zone.today - rand(0..365).days,
-      manager: [nil, example, admin, User.first(10).sample].sample,
-    )
-  rescue ActiveRecord::RecordInvalid
+  short_name = legal_name.gsub(/^[a-zA-Z]*\./, "").split(" ").first
+  login = Faker::Internet.username(specifier: legal_name) + rand(1..100).to_s
+
+  # Generate either 0, 1, or 2 emails:
+  erand = rand
+  emails = (erand < 0.1 ? 0 : erand > 0.9 ? 2 : 1).times.map do |i|
+    Email.create!(email: Faker::Internet.email(name: legal_name), is_primary: i == 0)
   end
+
+  u = User.create!(
+    login: login,
+    legal_name: legal_name,
+    short_name: short_name,
+    age: rand(18..65),
+    is_admin: rand < 0.2,
+    balance: rand(0.0..10000.0),
+    state: [0, 0, 0, 0, User.states.keys.sample].sample,
+    status: User::STATUS_OPTS.keys.sample,
+    day_start: ["7:30", "8:00", "8:30", "9:00", "9:30"].sample,
+    last_reviewed_on: Time.zone.today - rand(0..365).days,
+    manager: [nil, nil, nil, example, admin, User.first(10).sample].sample,
+    billing_email: rand < 0.5 ? emails.first : nil,
+    emails: emails,
+  )
+
+  # Triggers stack error on users controller somehow.
+  if rand < 0.7
+    PhoneNumber.create!(number: Faker::PhoneNumber.cell_phone, user: u)
+  end
+rescue ActiveRecord::RecordInvalid
 end
 
 # Created by copilot:
@@ -76,3 +99,5 @@
 
 example.movies += Movie.all.sample(5)
 admin.movies += Movie.all.sample(20)
+
+puts "Seed data loaded."

test/test/controllers/api/demo/movies_controller_test.rb

@@ -8,9 +8,9 @@ class Api::Demo::MoviesControllerTest < ActionController::TestCase
 
   if defined?(Ransack)
     def test_ransack_simple
-      get(:index, as: :json, params: {q: {price_gt: 9}})
+      get(:index, as: :json, params: {q: {price_gt: 9}, page_size: 0})
       assert_response(:success)
-      assert_equal(2, @response.parsed_body["results"].length)
+      assert_equal(Movie.where("price > 9").count, @response.parsed_body.length)
     end
   end
 

test/test/fixtures/genres.yml

@@ -21,6 +21,6 @@ def test_rescue_unknown_format
     assert_response(:success)
     resp2 = @response.body
 
-    assert_equal(resp1, resp2)
+    assert_equal(resp1, resp2.gsub(".jsom", ".json"))
   end
 end

test/test/fixtures/movies.yml

@@ -26,3 +26,5 @@
 
 class ActiveSupport::TestCase
 end
+
+Rails.application.load_seed unless ENV["SKIP_SEED"]