elasticsearch-api/spec/unit/actions/msearch_spec.rb

# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

require 'spec_helper'

describe 'client#msearch' do
  let(:expected_args) do
    [
      'POST',
      url,
      params,
      body,
      headers,
      { endpoint: 'msearch' }
    ]
  end

  let(:body) do
    nil
  end

  let(:url) do
    '_msearch'
  end

  let(:params) do
    {}
  end

  let(:headers) {
    {
      'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
    }
  }

  let(:client) do
    Class.new { include Elasticsearch::API }.new
  end

  it 'requires the :body argument' do
    expect {
      client.msearch
    }.to raise_exception(ArgumentError)
  end

  context 'when the body is an object' do

    let(:body) do
      <<-PAYLOAD.gsub(/^\s+/, '')
            {"index":"foo"}
            {"query":{"match_all":{}}}
            {"index":"bar"}
            {"query":{"match":{"foo":"bar"}}}
            {"search_type":"count"}
            {"facets":{"tags":{}}}
      PAYLOAD
    end

    it 'performs the request' do
      expect(client_double.msearch body: [
          { index: 'foo', search: { query: { match_all: {}  } } },
          { index: 'bar', search: { query: { match: { foo: 'bar' } } } },
          { search_type: 'count', search: { facets: { tags: {} } } }
      ])
    end
  end

  context 'when the body is a string' do

    let(:body) do
      %Q|{"foo":"bar"}\n{"moo":"lam"}|
    end

    it 'performs the request' do
      expect(client_double.msearch(body: %Q|{"foo":"bar"}\n{"moo":"lam"}|)).to be_a Elasticsearch::API::Response
    end
  end

  context 'when an index is specified' do
    let(:url) do
      'foo/_msearch'
    end

    let(:body) do
      ''
    end

    let(:expected_args) do
      [
        'POST',
        url,
        params,
        body,
        headers,
        { defined_params: { index: 'foo' }, endpoint: 'msearch' }
      ]
    end

    it 'performs the request' do
      expect(client_double.msearch(index: 'foo', body: []))
    end
  end

  context 'when multiple indices are specified' do
    let(:url) do
      'foo,bar/_msearch'
    end

    let(:body) do
      ''
    end

    let(:expected_args) do
      [
        'POST',
        url,
        params,
        body,
        headers,
        { defined_params: { index: ['foo', 'bar'] }, endpoint: 'msearch' }
      ]
    end

    it 'performs the request' do
      expect(client_double.msearch(index: ['foo', 'bar'], body: []))
    end
  end

  context 'when the request needs to be URL-escaped' do

    let(:url) do
      'foo%5Ebar/_msearch'
    end

    let(:body) do
      ''
    end

    let(:expected_args) do
      [
        'POST',
        url,
        params,
        body,
        headers,
        { defined_params: { index: 'foo^bar' }, endpoint: 'msearch' }
      ]
    end

    it 'performs the request' do
      expect(client_double.msearch(index: 'foo^bar', body: [])).to be_a Elasticsearch::API::Response
    end
  end

  context 'when the URL params need to be URL-encoded' do

    let(:url) do
      '_msearch'
    end

    let(:body) do
      ''
    end

    let(:params) do
      { search_type: 'scroll' }
    end

    it 'performs the request' do
      expect(client_double.msearch(body: [], search_type: 'scroll')).to be_a Elasticsearch::API::Response
    end
  end
end