26、Rails 应用程序测试全攻略

Rails 应用程序测试全攻略

在开发 Rails 应用程序时，测试是确保代码质量和功能正确性的重要环节。本文将详细介绍 Rails 应用程序的测试方法，包括功能测试和集成测试，并提供具体的代码示例和操作步骤。

功能测试

功能测试主要用于测试控制器的各个动作，确保它们能按预期工作。以下是一些常见动作的测试方法：

1. 验证实例变量的赋值

在测试控制器时，需要验证正确的实例变量是否被赋值。可以使用 assigns 方法来测试实例变量的赋值是否成功。例如，要验证 @articles 实例变量是否被赋值，可以使用以下代码：

assert_not_nil assigns(:articles)

这个断言表示 @articles 实际上已经被赋值（因为它不应该为 nil ）。可以使用这种技术来测试控制器中设置的任何实例变量的存在性。

2. 测试 show 动作

show 动作的测试用例与 index 动作的测试用例类似，但需要传递要显示的记录的 id 参数。以下是 show 动作的测试代码示例：

require 'test_helper'

class ArticlesControllerTest < ActionController::TestCase
  setup do
    @article = articles(:welcome_to_rails)
  end

  test "should show article" do
    get :show, :id => @article.to_param
    assert_response :success
    assert_template 'show'
    assert_not_nil assigns(:article)
    assert assigns(:article).valid?
  end
end

在这个测试中，使用 get 请求 show 动作，并传递 id 参数。然后验证响应状态、模板和实例变量是否符合预期。

3. 测试 new 动作

new 动作的测试相对简单，首先使用 login_as 辅助方法登录用户，然后发起 new 动作的请求，并验证响应是否成功。以下是 new 动作的测试代码示例：

require 'test_helper'

class ArticlesControllerTest < ActionController::TestCase
  setup do
    @article = articles(:welcome_to_rails)
  end

  test "should get new" do
    login_as(:eugene)
    get :new
    assert_response :success
  end
end

4. 测试 create 动作

create 动作需要提交表单参数来创建一个有效的文章。使用 POST 请求，并在 assert_difference 方法块中执行创建操作，以验证文章数量是否增加。以下是 create 动作的测试代码示例：

require 'test_helper'

class ArticlesControllerTest < ActionController::TestCase
  setup do
    @article = articles(:welcome_to_rails)
  end

  test "should create article" do
    login_as(:eugene)
    assert_difference('Article.count') do
      post :create, :article => { :title => 'Post title', :body  => 'Lorem ipsum..' }
    end
    assert_response :redirect
    assert_redirected_to article_path(assigns(:article))
  end
end

5. 测试 destroy 动作

destroy 动作的测试需要先验证要删除的文章是否存在，然后发起 DELETE 请求删除文章，并验证文章是否被成功删除。以下是 destroy 动作的测试代码示例：

require 'test_helper'

class ArticlesControllerTest < ActionController::TestCase
  setup do
    @article = articles(:welcome_to_rails)
  end

  test "should destroy article" do
    login_as(:eugene)
    assert_nothing_raised { Article.find(@article.to_param) }
    assert_difference('Article.count', -1) do
      delete :destroy, :id => @article.to_param
    end
    assert_response :redirect
    assert_redirected_to articles_path
    assert_raise(ActiveRecord::RecordNotFound) { Article.find(@article.to_param) }
  end
end

运行功能测试

完成控制器测试套件的编写后，可以使用以下命令来执行所有测试方法并验证是否修复了所有问题：

$ ruby -Itest test/controllers/articles_controller_test.rb

运行结果示例：

Loaded suite test/controllers/articles_controller_test
Started
.......
Finished in 0.432005 seconds.

7 tests, 20 assertions, 0 failures, 0 errors, 0 skips

修复缺失的测试

在运行完整的功能测试套件之前，还需要修复一个测试。当生成 Notifier 邮件发送器时，Rails 在 test/mailers 目录中添加了一个邮件测试文件，由于对该类进行了更改，这些测试现在失败了。以下是更新后的测试代码：

require 'test_helper'

class NotifierTest < ActionMailer::TestCase
  test "email_friend" do
    article = articles(:welcome_to_rails)
    message = Notifier.email_friend(article, 'John Smith', 'dude@example.com')
    assert_equal "Interesting Article", message.subject
    assert_equal ["dude@example.com"], message.to
    assert_equal ["from@example.com"], message.from
  end
end

运行完整的测试套件

完成所有功能测试后，可以使用以下命令运行整个功能测试套件：

$ rake test:functionals

运行结果示例：

Loaded suite
Started
...........
Finished in 0.665524 seconds.

8 tests, 23 assertions, 0 failures, 0 errors, 0 skips

还可以使用 rake test 命令运行整个测试套件，包括单元测试和功能测试：

$ rake test

运行结果示例：

Loaded suite
Started
.............
Finished in 0.230277 seconds.

13 tests, 32 assertions, 0 failures, 0 errors, 0 skips

集成测试

集成测试是 Rails 中最高级别的测试类型，它可以跨越多个控制器和动作，并支持完整的会话。集成测试更接近模拟与 Web 应用程序的实际交互，用于测试应用程序的各个部分是否能很好地集成在一起。

1. 生成集成测试文件

可以使用以下命令生成集成测试文件：

$ rails generate test_unit:integration UserStories

这将在 test/integration 目录下创建一个 user_stories_test.rb 文件。

2. 编写集成测试用例

以下是几个集成测试用例的示例：

• 登录测试 ：

require 'test_helper'

class UserStoriesTest < ActionDispatch::IntegrationTest
  test "should login user and redirect" do
    get login_path
    assert_response :success
    assert_template 'new'
    post session_path, :email => 'eugene@example.com', :password => 'secret'
    assert_response :redirect
    assert_redirected_to root_path
    follow_redirect!
    assert_response :success
    assert_template 'index'
    assert session[:user_id]
  end
end

• 登出测试 ：

require 'test_helper'

class UserStoriesTest < ActionDispatch::IntegrationTest
  test "should logout user and redirect" do
    get logout_path
    assert_response :redirect
    assert_redirected_to root_path
    assert_nil session[:user]
    follow_redirect!
    assert_template 'index'
  end
end

• 登录、创建文章和登出测试 ：

require 'test_helper'

class UserStoriesTest < ActionDispatch::IntegrationTest
  test "should login create article and logout" do
    # Login
    get login_path
    assert_response :success
    assert_template 'new'
    post session_path, :email => 'eugene@example.com', :password => 'secret'
    assert_response :redirect
    assert_redirected_to root_path
    follow_redirect!
    assert_response :success
    assert_template 'index'
    assert session[:user_id]

    # Create New Article
    get new_article_path
    assert_response :success
    assert_template 'new'
    post articles_path, :article => {:title => 'Integration Tests', :body => 'Lorem Ipsum..'}
    assert assigns(:article).valid?
    assert_response :redirect
    assert_redirected_to article_path(assigns(:article))
    follow_redirect!
    assert_response :success
    assert_template 'show'

    # Logout
    get logout_path
    assert_response :redirect
    assert_redirected_to root_path
    assert_nil session[:user]
    follow_redirect!
    assert_template 'index'
  end
end

总结

通过功能测试和集成测试，可以确保 Rails 应用程序的各个部分都能按预期工作。功能测试主要针对控制器的单个动作进行测试，而集成测试则可以模拟用户与应用程序的实际交互，测试多个控制器和动作的集成情况。在开发过程中，定期运行测试套件可以帮助及时发现和修复问题，提高代码的质量和稳定性。

以下是一个简单的测试流程 mermaid 流程图：

graph LR
    A[编写功能测试用例] --> B[运行功能测试]
    B --> C{是否有失败的测试}
    C -- 是 --> D[修复测试问题]
    D --> B
    C -- 否 --> E[编写集成测试用例]
    E --> F[运行集成测试]
    F --> G{是否有失败的测试}
    G -- 是 --> H[修复测试问题]
    H --> F
    G -- 否 --> I[完成测试]

以下是一个测试类型和作用的表格：
| 测试类型 | 作用 |
| ---- | ---- |
| 功能测试 | 测试控制器的各个动作，验证实例变量赋值、响应状态、模板等 |
| 集成测试 | 模拟用户与应用程序的实际交互，测试多个控制器和动作的集成情况 |

通过以上步骤和示例，你可以全面地对 Rails 应用程序进行测试，确保应用程序的质量和稳定性。

Rails 应用程序测试全攻略（续）

深入理解测试细节

在前面的内容中，我们已经介绍了 Rails 应用程序的功能测试和集成测试的基本方法和示例。接下来，我们将进一步深入探讨这些测试的细节，以及如何更好地利用测试来保证应用程序的质量。

功能测试的细节分析

• assigns 方法的使用 ：在功能测试中， assigns 方法是一个非常有用的工具。它允许我们访问控制器中设置的实例变量，从而验证这些变量是否被正确赋值。例如，在测试 show 动作时，我们使用 assert_not_nil assigns(:article) 来验证 @article 实例变量是否被赋值，并且使用 assert assigns(:article).valid? 来验证该实例变量所代表的文章对象是否有效。
• 请求方法的选择 ：不同的控制器动作需要使用不同的请求方法。例如， index 、 show 和 new 动作通常使用 GET 请求，而 create 动作使用 POST 请求， update 动作使用 PUT 请求， destroy 动作使用 DELETE 请求。在编写测试用例时，必须根据具体的动作选择正确的请求方法。
• assert_difference 方法的应用 ： assert_difference 方法用于验证某个表达式的值在执行一段代码前后是否发生了预期的变化。在测试 create 动作时，我们使用 assert_difference('Article.count') 来验证文章的数量在创建文章后是否增加了 1；在测试 destroy 动作时，使用 assert_difference('Article.count', -1) 来验证文章的数量在删除文章后是否减少了 1。

集成测试的优势和挑战

• 优势 ：集成测试可以模拟用户与应用程序的实际交互，跨越多个控制器和动作，并且支持完整的会话。这使得我们能够更全面地测试应用程序的功能，发现一些在功能测试中难以发现的问题。例如，在集成测试中，我们可以测试用户登录、创建文章和登出的整个流程，确保这些操作之间的交互正常。
• 挑战 ：由于集成测试涉及多个控制器和动作，测试用例的编写和维护相对复杂。此外，集成测试的执行时间通常比功能测试长，因为它需要模拟更多的操作和交互。因此，在编写集成测试时，需要仔细设计测试用例，确保测试的覆盖率和效率。

测试用例的优化和扩展

为了提高测试的效率和覆盖率，我们可以对测试用例进行优化和扩展。

优化测试用例

• 减少重复代码 ：在测试用例中，可能会存在一些重复的代码，例如登录操作。可以将这些重复的代码提取到辅助方法中，以减少代码的冗余。例如，创建一个 login_user 辅助方法：

def login_user
  get login_path
  assert_response :success
  assert_template 'new'
  post session_path, :email => 'eugene@example.com', :password => 'secret'
  assert_response :redirect
  assert_redirected_to root_path
  follow_redirect!
  assert_response :success
  assert_template 'index'
  assert session[:user_id]
end

然后在需要登录的测试用例中调用该方法：

require 'test_helper'

class UserStoriesTest < ActionDispatch::IntegrationTest
  test "should create article after login" do
    login_user
    get new_article_path
    assert_response :success
    assert_template 'new'
    post articles_path, :article => {:title => 'New Article', :body => 'Content...'}
    assert assigns(:article).valid?
    assert_response :redirect
    assert_redirected_to article_path(assigns(:article))
    follow_redirect!
    assert_response :success
    assert_template 'show'
  end
end

• 使用数据驱动测试 ：如果测试用例需要测试多种不同的数据情况，可以使用数据驱动测试的方法。例如，在测试 create 动作时，可以使用不同的文章属性来创建文章：

require 'test_helper'

class ArticlesControllerTest < ActionController::TestCase
  setup do
    @article = articles(:welcome_to_rails)
  end

  test "should create article with different attributes" do
    login_as(:eugene)
    article_attributes = [
      { :title => 'Article 1', :body => 'Content 1' },
      { :title => 'Article 2', :body => 'Content 2' },
      { :title => 'Article 3', :body => 'Content 3' }
    ]

    article_attributes.each do |attributes|
      assert_difference('Article.count') do
        post :create, :article => attributes
      end
      assert_response :redirect
      assert_redirected_to article_path(assigns(:article))
    end
  end
end

扩展测试用例

• 边界条件测试 ：除了正常情况的测试，还需要对边界条件进行测试。例如，在测试文章标题的长度限制时，可以测试标题长度为最小值和最大值的情况，以及超出长度限制的情况。
• 异常处理测试 ：测试应用程序在遇到异常情况时的处理能力。例如，在测试 destroy 动作时，除了测试正常删除文章的情况，还可以测试删除不存在的文章时应用程序的响应。

持续集成和测试自动化

在实际的开发过程中，为了确保应用程序的质量，需要将测试纳入到持续集成（CI）流程中，实现测试的自动化。

持续集成工具

常见的持续集成工具有 Jenkins、GitLab CI/CD 和 Travis CI 等。这些工具可以在代码提交到版本控制系统后自动触发测试任务，并及时反馈测试结果。

配置持续集成环境

以 GitLab CI/CD 为例，以下是一个简单的 .gitlab-ci.yml 配置文件示例：

stages:
  - test

test:
  stage: test
  script:
    - bundle install
    - rake test

这个配置文件定义了一个 test 阶段，在该阶段中执行 bundle install 安装依赖项，然后运行 rake test 命令执行所有测试。

总结和展望

通过本文的介绍，我们了解了 Rails 应用程序的功能测试和集成测试的方法、细节和优化技巧，以及如何将测试纳入到持续集成流程中。测试是保证应用程序质量的重要手段，在开发过程中，应该养成编写测试用例的习惯，定期运行测试套件，及时发现和修复问题。

未来，随着 Rails 框架的不断发展和应用程序的复杂性增加，测试的方法和工具也会不断更新和完善。例如，可能会出现更强大的测试框架和工具，能够更高效地进行测试。同时，人工智能和机器学习技术也可能会应用到测试领域，帮助我们自动生成测试用例和发现潜在的问题。

以下是一个持续集成流程的 mermaid 流程图：

graph LR
    A[代码提交到版本控制系统] --> B[触发持续集成任务]
    B --> C[安装依赖项]
    C --> D[运行功能测试]
    D --> E{功能测试是否通过}
    E -- 是 --> F[运行集成测试]
    E -- 否 --> G[通知开发人员修复问题]
    G --> A
    F --> H{集成测试是否通过}
    H -- 是 --> I[部署应用程序]
    H -- 否 --> G

以下是一个测试优化和扩展的总结表格：
| 优化/扩展方向 | 具体方法 |
| ---- | ---- |
| 优化测试用例 | 减少重复代码、使用数据驱动测试 |
| 扩展测试用例 | 边界条件测试、异常处理测试 |

通过以上的方法和实践，我们可以更全面、高效地对 Rails 应用程序进行测试，确保应用程序的质量和稳定性，为用户提供更好的使用体验。