如何在 Capybara 中 POST 到 URL？

Question

刚刚从 Cucumber+Webrat 切换到 Cucumber+Capybara，我想知道如何将内容 POST 到 Capybara 中的 URL。

在 Cucumber+Webrat 中，我能够执行以下步骤：

When /^I send "([^\"]*)" to "([^\"]*)"$/ do |file, project|
  proj = Project.find(:first, :conditions => "name='#{project}'")
  f = File.new(File.join(::Rails.root.to_s, file))
  visit "project/" + proj.id.to_s + "/upload",
        :post, {:upload_path => File.join(::Rails.root.to_s, file)}
end

但是，Capybara 文档提到：

访问方法只需要一个 参数，请求方法为 始终获取。始终获取。

如何修改我的步骤，以便 Cucumber+Capybara 对 URL 执行 POST？

Answer 1

正如其他人所说，没有直接的方法可以用 Capybara 进行 POST，因为它完全与浏览器交互有关。对于 API 测试，我非常强烈推荐 rspec_api_documentation gem。

Answer 2

对于使用 RSpec 3+ 的应用程序，您不会希望使用 Capybara 发出 HTTP POST 请求。 Capybara 用于模拟用户行为，并接受由此产生的 JS 行为和页面内容。最终用户不会对应用程序中的资源形成 HTTP POST 请求，用户会单击按钮、单击 ajax 链接、拖放元素、提交 Web 表单等。

请查看 这篇关于 Capybara 和其他 HTTP 方法的博客文章。作者提出以下主张：

您是否看到任何提及 get、post 或 response 等方法的内容？不？那是因为水豚中不存在这些。让我们非常清楚这一点......Capybara 不是一个适合测试 API 的库。就这样，你就有了。不要使用 Capybara 测试 API。它不是为此而设计的。

因此，无论是否开发 API，如果您必须发出显式 HTTP POST 请求，并且它不涉及 HTML 元素和某种事件（单击、拖动、选择、聚焦等），那么就不应该这样做用水豚进行测试。如果您可以通过单击某个按钮来测试相同的功能，那么请使用 Capybara。

您可能想要的是 RSpec 请求规范 。您可以在此处进行 post 调用以及任何其他 HTTP 方法，并断言对响应的期望。您还可以模拟 n 个存根对象和方法，以断言对请求和响应之间发生的副作用和其他行为的期望。

# spec located in spec/requests/project_file_upload_spec.rb
require "rails_helper"

RSpec.describe "Project File Upload", type: :request do

  let(:project) { create(:project) }
  let(:file)    { File.new(File.join(::Rails.root.to_s, 'path/to/file.ext')) } # can probably extract this to a helper...

  it "accepts a file uploaded to a Project resource" do

    post "project/#{project.id}/upload", upload_path: file

    expect(response).to be_success
    expect(project.file?).to eq(true)
    # expect(project.file).not_to eq(nil)
    expect(response).to render_template(:show)
  end

end

Answer 3

虽然这不是问题的确切答案，但对我来说最好的解决方案是使用 Capybara 来模拟用户交互的规范（使用 visit），并使用 Rack Test 来测试 API（如请求）。它们可以在同一测试套件中一起使用。

将以下内容添加到规范帮助程序中可以访问 get、post 和其他机架测试方法：

RSpec.configure do |config|
  config.include Rack::Test::Methods

您可能需要将机架测试规范放入 spec/requests 中 文件夹。

Answer 4

我知道答案已被接受，但我想提供更新的答案。这是 Anthony Eden 和 Corey Haines 将 Rack::Test 传递给 Cucumber 的 World 对象：

使用 Cucumber 和 Rack::Test 测试 REST API

通过这种技术，我能够在步骤定义内直接发送 post 请求。在编写步骤定义时，从 Rack::Test API 自己的 规格。

# feature
  Scenario: create resource from one time request
    Given I am an admin
    When I make an authenticated request for a new resource
    Then I am redirected  
    And I see the message "Resource successfully created" 

# step definitions using Rack::Test
When /^I make an authenticated request for a new resource$/ do
  post resources_path, :auth_token => @admin.authentication_token
  follow_redirect!
end

Then /^I am redirected$/ do
  last_response.should_not be_redirect
  last_request.env["HTTP_REFERER"].should include(resources_path)
end

Then /^I see the message "([^"]*)"$/ do |msg|
  last_response.body.should include(msg)
end

Answer 5

更新答案 2022-10-05

如果您的驱动程序没有 post （例如，Poltergeist 没有），您可以执行以下操作：

response = nil
open_session do |session|
  session.post("/mypath", params: { foo: "bar" })
  response = session.response
end

我们现在可以在 response.body< 上断言/代码>。

您还可以直接使用 integration_session.post(…)，但我认为如果不将 POST 会话与测试的普通会话分开，可能会导致一些混乱。

正如其他地方所述，在水豚测试中，您通常希望像用户一样通过提交表单来执行 POST。我使用上面的内容来测试如果 POST 在另一个会话中发生（通过 WebSockets），用户会发生什么，所以表单不会削减它。

文档：

• https://api.rubyonrails.org/ classes/ActionDispatch/Integration/Runner.html#method-i-open_session

---

2014-06-22 的旧答案

如果您的驱动程序没有 post （例如，Poltergeist 没有），您可以这样做：

session = ActionDispatch::Integration::Session.new(Rails.application)
response = session.post("/mypath", my_params: "go_here")

但请注意，此请求发生在新会话中，因此您必须通过 response 对象对其进行断言。

文档：

• http://api.rubyonrails.org/classes/ActionDispatch/Integration/ Session.html
• http://api.rubyonrails.org/classes /ActionDispatch/Integration/RequestHelpers.html

Answer 6

Capybara 的 visit 仅执行 GET 请求。这是设计使然。

用户要执行POST，他必须单击按钮或提交表单。没有其他方法可以使用浏览器来执行此操作。

测试此行为的正确方法是：

visit "project/:id/edit" # This will only GET
attach_file "photo", File.open('cute_photo.jpg')
click_button 'Upload' # This will POST

如果您想测试 API，我建议使用 spec/request 而不是 cucumber，但这只是我的想法。

Answer 7

最近，我发现了这篇很棒的博客文章。这对于像托尼这样的情况非常有用，并且您确实想在您的杯子中发布一些内容：

对于我的情况，这变成了：

def send_log(file, project)
  proj = Project.find(:first, :conditions => "name='#{project}'")
  f = File.new(File.join(::Rails.root.to_s, file))
  page.driver.post("projects/" + proj.id.to_s + "/log?upload_path=" + f.to_path)
  page.driver.status_code.should eql 200
end

Answer 8

您可以这样做：

rack_test_session_wrapper = Capybara.current_session.driver
rack_test_session_wrapper.submit :post, your_path, nil

• 您可以将 :post 替换为您关心的任何方法，例如 :put 或 :delete。
• 将 your_path 替换为您想要的 Rails 路径，例如 rack_test_session_wrapper.submit :delete, document_path(Document.last), nil 会删除我的应用程序中的最后一个文档。