Ruby on Rails单元测试：如何加载lib目录下的Datetools模块？

问题场景 #

在lib/utils/datetools.rb定义了如下模块：

module Datetools
  def hello
    'world'
  end
end

编写测试文件test/utils/datetools_test.rb时触发uninitialized constant Datetools (NameError)错误，测试代码如下：

import Datetools

class DatetoolsTest < TestCase
  test 'hello world' do
    assert Datetools.hello() == 'world'
  end
end

执行测试命令：

rails t test/utils/datetools_test.rb

环境：Ruby 3.3.5，Rails 7.1.4

问题原因 #

1. Rails默认不会将lib目录纳入测试环境的自动加载路径，导致测试进程无法找到模块文件
2. 测试代码误用Ruby不推荐的import语法（Ruby标准引入方式为require），且未加载测试环境配置
3. 模块中的hello是实例方法，无法直接通过Datetools.hello的方式调用

解决步骤 #

1. 配置Rails自动加载lib目录 #

修改config/application.rb，添加以下配置，让所有环境（含测试）加载lib目录：

module YourAppName
  class Application < Rails::Application
    # ...其他已有配置
    config.autoload_paths << Rails.root.join('lib')
    config.eager_load_paths << Rails.root.join('lib')
  end
end

若仅需在测试环境加载，可修改config/environments/test.rb：

Rails.application.configure do
  # ...其他已有配置
  config.autoload_paths << Rails.root.join('lib')
end

2. 修正模块方法定义 #

将实例方法改为类方法，允许直接通过模块名调用：

# lib/utils/datetools.rb
module Datetools
  def self.hello
    'world'
  end
end

若需保留实例方法，测试时需先将模块混入测试类再调用：

# 测试文件中的替代写法
class DatetoolsTest < ActiveSupport::TestCase
  include Datetools
  test 'hello returns world' do
    assert_equal 'world', hello
  end
end

3. 修正测试文件代码 #

测试文件开头必须加载test_helper.rb（Rails测试标准配置），同时移除错误的import语句：

# test/utils/datetools_test.rb
require 'test_helper'

class DatetoolsTest < ActiveSupport::TestCase
  test 'hello returns world' do
    assert_equal 'world', Datetools.hello
  end
end

验证 #

重新执行测试命令：

rails t test/utils/datetools_test.rb

测试应正常通过。

内容的提问来源于stack exchange，提问作者Patrick Bucher