如何在 Rails 功能测试中发送原始发布数据？

Question

我希望将原始帖子数据（例如未参数化的 JSON）发送到我的一个控制器进行测试：

class LegacyOrderUpdateControllerTest < ActionController::TestCase
  test "sending json" do
    post :index, '{"foo":"bar", "bool":true}'
  end
end

但这给了我一个NoMethodError: undefined method `symbolize_keys' for #<String:0x00000102cb6080> 错误。

在ActionController::TestCase 中发送原始帖子数据的正确方法是什么？

这是一些控制器代码：

def index
  post_data = request.body.read
  req = JSON.parse(post_data)
end

Answer 1

我今天遇到了同样的问题并找到了解决方案。

在您的test_helper.rb 中，在ActiveSupport::TestCase 中定义以下方法：

def raw_post(action, params, body)
  @request.env['RAW_POST_DATA'] = body
  response = post(action, params)
  @request.env.delete('RAW_POST_DATA')
  response
end

在您的功能测试中，像 post 方法一样使用它，但将原始帖子正文作为第三个参数传递。

class LegacyOrderUpdateControllerTest < ActionController::TestCase
  test "sending json" do
    raw_post :index, {}, {:foo => "bar", :bool => true}.to_json
  end
end

在阅读原始帖子正文时，我在 Rails 2.3.4 上对此进行了测试

request.raw_post

而不是

request.body.read

如果您查看source code，您会发现raw_post 只是将request.body.read 包装起来，并在request env 哈希中检查此RAW_POST_DATA。

Answer 2

我实际上只添加了一行就解决了同样的问题 在模拟 rspec 发布请求之前。你做什么 是填充“RAW_POST_DATA”。我试图删除 帖子上的属性变量：创建，但如果我这样做， 它找不到动作。

这是我的解决方案。

def do_create（属性） request.env['RAW_POST_DATA'] = attributes.to_json 发布：创建，属性 结尾

在控制器中，您需要读取 JSON 的代码是 类似的东西

@property = Property.new(JSON.parse(request.body.read))

Answer 3

Rails 5 版本：

post :create, body: '{"foo": "bar", "bool": true}'

参见here - body 字符串参数被视为原始请求正文。

Answer 4

查看运行测试的堆栈跟踪，您可以获得对请求准备的更多控制： ActionDispatch::Integration::RequestHelpers.post => ActionDispatch::Integration::Session.process => Rack::Test::Session.env_for

您可以将 json 字符串作为 :params 传递并指定内容类型“application/json”。在其他情况下，内容类型将设置为“application/x-www-form-urlencoded”，您的 json 将被正确解析。

所以您只需要指定“CONTENT_TYPE”：

post :index, '{"foo":"bar", "bool":true}', "CONTENT_TYPE" => 'application/json'

Answer 5

对于那些使用 Rails5+ 集成测试的人，（未记录的）方法是在 params 参数中传递一个字符串，所以：

post '/path', params: raw_body, headers: { 'Content-Type' => 'application/json' }

Answer 6

我一直在寻找如何在集成测试 (Rails 5.1) 中发布原始 JSON 内容。我想我的解决方案在这种情况下也有帮助。 我查阅了post 方法的文档和源代码：https://api.rubyonrails.org/v5.1/classes/ActionDispatch/Integration/RequestHelpers.html#method-i-post

这将我引导至process 方法以获取更多详细信息：https://api.rubyonrails.org/v5.1/classes/ActionDispatch/Integration/Session.html#method-i-process

多亏了这个，我终于找到了process和post方法接受了哪些参数。 这是我的最终解决方案：

post my_url, params: nil, headers: nil, env: {'RAW_POST_DATA' => my_body_content}, as: :json

Answer 7

如果您使用 RSpec (>= 2.12.0) 并编写请求规范，则包含的模块是 ActionDispatch::Integration::Runner。如果您查看源代码，您会注意到post 方法调用process，它接受rack_env 参数。

这意味着您可以在规范中简单地执行以下操作：

#spec/requests/articles_spec.rb

post '/articles', {}, {'RAW_POST_DATA' => 'something'}

在控制器中：

#app/controllers/articles_controller.rb

def create
  puts request.body.read
end

Answer 8

使用 Rails 4，我希望这样做以测试对发布到控制器的原始 xml 的处理。我可以通过将字符串提供给帖子来做到这一点：

raw_xml = File.read("my_raw.xml")
post :message, raw_xml, format: :xml

我相信如果提供的参数是一个字符串，它只是作为主体传递给控制器​​。

Answer 9

在 Rails 中，5.1 在执行需要正文中数据的删除请求时为我工作：

delete your_app_url, as: :json, env: {
   "RAW_POST_DATA" =>  {"a_key" => "a_value"}.to_json
}

注意：这仅在进行集成测试时有效。

Answer 10

post 方法需要名称-值对的散列，因此您需要执行以下操作：

post :index, :data => '{"foo":"bar", "bool":true}'

然后，在您的控制器中，像这样获取要解析的数据：

post_data = params[:data]

Answer 11

从 Rails 4.1.5 开始，这是唯一对我有用的东西：

class LegacyOrderUpdateControllerTest < ActionController::TestCase
  def setup
    @request.headers["Content-Type"] = 'application/json'
  end

  test "sending json" do
    post :index, '{"foo":"bar", "bool":true}'.to_json, { account_id: 5, order_id: 10 }
  end
end

获取位于 /accounts/5/orders/10/items 的网址。这将获取传递的 url 参数以及 JSON 正文。当然，如果没有嵌入订单，那么您可以省略 params 哈希。

class LegacyOrderUpdateControllerTest < ActionController::TestCase
  def setup
    @request.headers["Content-Type"] = 'application/json'
  end

  test "sending json" do
    post :index, '{"foo":"bar", "bool":true}'.to_json
  end
end

Answer 12

在 Rails 4 中（至少在 4.2.11.3 中）没有简单的方法来测试使用 json 的控制器（功能测试）。对于在运行的服务器中解析 json，ActionDispatch::ParamsParser middleware 负责。控制器测试虽然依赖于 Rack，但它无法解析 json to this day（不应该如此）。

你可以这样做：

post :create, body_params.to_json

或：

post :update, body_parmas.to_json, url_params

但body_params 将无法通过params 在控制器中访问。你必须做JSON.parse(request.body.read)。所以唯一想到的是：

post :update, url_params.merge(body_params)

也就是说，在测试中通过参数（application/x-www-form-urlencoded）传递所有内容。在生产中，主体将由ActionDispatch::ParamsParser 解析以达到相同的效果。除了你的数字变成字符串（可能更多）：

# test/controllers/post_controller_test.rb
post :update, {id: 1, n: 2}

# app/controller/posts_controller.rb
def update
    p params  # tests:
              # {"id"=>"1", "n" => "2", "controller"=>"posts", "action"=>"update"}
              # production
              # {"id"=>"1", "n" => 2, "controller"=>"posts", "action"=>"update"}
end

如果您愿意自己在控制器中解析 json，尽管您可以这样做：

# test/controllers/post_controller_test.rb
post_json :update, {n: 2}.to_json, {id: 1}

# app/controller/posts_controller.rb
def update
    p JSON.parse(request.body.read)  # {"id"=>"1", "n" => 2, "controller"=>"posts", "action"=>"update"}
end

Answer 13

post :index, {:foo=> 'bar', :bool => 'true'}