elasticsearch 7.17.10 → 8.0.0.pre1

data/spec/unit/cloud_credentials_spec.rb

@@ -0,0 +1,167 @@
+# 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 Elasticsearch::Client do
+  context 'when cloud credentials are provided' do
+    let(:client) do
+      described_class.new(
+        cloud_id: 'name:bG9jYWxob3N0JGFiY2QkZWZnaA==',
+        user: 'elastic',
+        password: 'changeme'
+      )
+    end
+
+    let(:hosts) do
+      client.transport.hosts
+    end
+
+    it 'extracts the cloud credentials' do
+      expect(hosts[0][:host]).to eq('abcd.localhost')
+      expect(hosts[0][:protocol]).to eq('https')
+      expect(hosts[0][:user]).to eq('elastic')
+      expect(hosts[0][:password]).to eq('changeme')
+      expect(hosts[0][:port]).to eq(443)
+    end
+
+    it 'creates the correct full url' do
+      expect(
+        client.transport.__full_url(client.transport.hosts[0])
+      ).to eq('https://elastic:changeme@abcd.localhost:443')
+    end
+
+    context 'when a port is specified' do
+      let(:client) do
+        described_class.new(cloud_id: 'name:bG9jYWxob3N0JGFiY2QkZWZnaA==', user: 'elastic', password: 'changeme', port: 9250)
+      end
+
+      it 'sets the specified port along with the cloud credentials' do
+        expect(hosts[0][:host]).to eq('abcd.localhost')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elastic')
+        expect(hosts[0][:password]).to eq('changeme')
+        expect(hosts[0][:port]).to eq(9250)
+      end
+
+      it 'creates the correct full url' do
+        expect(client.transport.__full_url(client.transport.hosts[0])).to eq('https://elastic:changeme@abcd.localhost:9250')
+      end
+    end
+
+    context 'when the cluster has alternate names' do
+      let(:client) do
+        described_class.new(
+          cloud_id: 'myCluster:bG9jYWxob3N0JGFiY2QkZWZnaA==',
+          user: 'elasticfantastic',
+          password: 'tobechanged'
+        )
+      end
+
+      let(:hosts) do
+        client.transport.hosts
+      end
+
+      it 'extracts the cloud credentials' do
+        expect(hosts[0][:host]).to eq('abcd.localhost')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elasticfantastic')
+        expect(hosts[0][:password]).to eq('tobechanged')
+        expect(hosts[0][:port]).to eq(443)
+      end
+
+      it 'creates the correct full url' do
+        expect(
+          client.transport.__full_url(client.transport.hosts[0])
+        ).to eq('https://elasticfantastic:tobechanged@abcd.localhost:443')
+      end
+    end
+
+    context 'when decoded cloud id has a trailing dollar sign' do
+      let(:client) do
+        described_class.new(
+          cloud_id: 'a_cluster:bG9jYWxob3N0JGFiY2Qk',
+          user: 'elasticfantastic',
+          password: 'changeme'
+        )
+      end
+
+      let(:hosts) do
+        client.transport.hosts
+      end
+
+      it 'extracts the cloud credentials' do
+        expect(hosts[0][:host]).to eq('abcd.localhost')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elasticfantastic')
+        expect(hosts[0][:password]).to eq('changeme')
+        expect(hosts[0][:port]).to eq(443)
+      end
+
+      it 'creates the correct full url' do
+        expect(
+          client.transport.__full_url(client.transport.hosts[0])
+        ).to eq('https://elasticfantastic:changeme@abcd.localhost:443')
+      end
+    end
+
+    context 'when the cloud host provides a port' do
+      let(:client) do
+        described_class.new(
+          cloud_id: 'name:ZWxhc3RpY19zZXJ2ZXI6OTI0MyRlbGFzdGljX2lk',
+          user: 'elastic',
+          password: 'changeme'
+        )
+      end
+
+      let(:hosts) do
+        client.transport.hosts
+      end
+
+      it 'creates the correct full url' do
+        expect(hosts[0][:host]).to eq('elastic_id.elastic_server')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elastic')
+        expect(hosts[0][:password]).to eq('changeme')
+        expect(hosts[0][:port]).to eq(9243)
+      end
+    end
+
+    context 'when the cloud host provides a port and the port is also specified' do
+      let(:client) do
+        described_class.new(
+          cloud_id: 'name:ZWxhc3RpY19zZXJ2ZXI6OTI0MyRlbGFzdGljX2lk',
+          user: 'elastic',
+          password: 'changeme',
+          port: 9200
+        )
+      end
+
+      let(:hosts) do
+        client.transport.hosts
+      end
+
+      it 'creates the correct full url' do
+        expect(hosts[0][:host]).to eq('elastic_id.elastic_server')
+        expect(hosts[0][:protocol]).to eq('https')
+        expect(hosts[0][:user]).to eq('elastic')
+        expect(hosts[0][:password]).to eq('changeme')
+        expect(hosts[0][:port]).to eq(9243)
+      end
+    end
+  end
+end

data/spec/unit/custom_transport_implementation_spec.rb

@@ -0,0 +1,43 @@
+# 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 Elasticsearch::Client do
+  context 'when using custom transport implementation' do
+    class MyTransport
+      include Elastic::Transport::Transport::Base
+      def initialize(args); end
+    end
+    let(:client) { Elasticsearch::Client.new(transport_class: MyTransport) }
+    let(:arguments) { client.instance_variable_get('@transport').instance_variable_get('@arguments') }
+    let(:subject) do
+      arguments[:transport_options][:headers]
+    end
+
+    let(:meta_header) do
+      if jruby?
+        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION}"
+      else
+        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION}"
+      end
+    end
+
+    it 'doesnae set any info about the implementation in the metaheader' do
+      expect(subject).to include('x-elastic-client-meta' => meta_header)
+    end
+  end
+end

data/spec/unit/elasticsearch_product_validation_spec.rb

@@ -25,20 +25,20 @@ describe 'Elasticsearch: Validation' do
       .to_return(status: status, body: body, headers: headers)
   end
   let(:count_request_stub) do
-    stub_request(:get, "#{host}/_count")
+    stub_request(:post, "#{host}/_count")
       .to_return(status: 200, body: nil, headers: {})
   end
   let(:status) { 200 }
   let(:body) { {}.to_json }
   let(:client) { Elasticsearch::Client.new }
   let(:headers) do
-    { 'content-type' => 'json' }
+    { 'content-type' => 'application/json' }
   end
 
   def error_requests_and_expectations(message = Elasticsearch::NOT_ELASTICSEARCH_WARNING)
     expect { client.count }.to raise_error Elasticsearch::UnsupportedProductError, message
     assert_requested :get, host
-    assert_not_requested :get, "#{host}/_count"
+    assert_not_requested :post, "#{host}/_count"
     expect { client.cluster.health }.to raise_error Elasticsearch::UnsupportedProductError, message
     expect(client.instance_variable_get('@verified')).to be false
     expect { client.cluster.health }.to raise_error Elasticsearch::UnsupportedProductError, message
@@ -51,7 +51,7 @@ describe 'Elasticsearch: Validation' do
     client.count
     expect(client.instance_variable_get('@verified'))
     assert_requested :get, host
-    assert_requested :get, "#{host}/_count"
+    assert_requested :post, "#{host}/_count"
   end
 
   context 'When Elasticsearch replies with status 401' do
@@ -96,30 +96,9 @@ describe 'Elasticsearch: Validation' do
     end
   end
 
-  context 'When Elasticsearch replies with status 403' do
-    let(:status) { 413 }
-    let(:body) { {}.to_json }
-
-    it 'Verifies the request but shows a warning' do
-      stderr      = $stderr
-      fake_stderr = StringIO.new
-      $stderr     = fake_stderr
-
-      verify_request_stub
-      count_request_stub
-
-      valid_requests_and_expectations
-
-      fake_stderr.rewind
-      expect(fake_stderr.string).to eq("#{Elasticsearch::SECURITY_PRIVILEGES_VALIDATION_WARNING}\n")
-    ensure
-      $stderr = stderr
-    end
-  end
-
-  context 'When the Elasticsearch version is >= 7.14' do
+  context 'When the Elasticsearch version is >= 8.0.0' do
     context 'With a valid Elasticsearch response' do
-      let(:body) { { 'version' => { 'number' => '7.14.0' } }.to_json }
+      let(:body) { { 'version' => { 'number' => '8.0.0' } }.to_json }
       let(:headers) do
         {
           'X-Elastic-Product' => 'Elasticsearch',
@@ -147,9 +126,9 @@ describe 'Elasticsearch: Validation' do
     end
   end
 
-  context 'When the Elasticsearch version is >= 7.14-SNAPSHOT' do
+  context 'When the Elasticsearch version is >= 8.1.0' do
     context 'With a valid Elasticsearch response' do
-      let(:body) { { 'version' => { 'number' => '7.14-SNAPSHOT' } }.to_json }
+      let(:body) { { 'version' => { 'number' => '8.1.0' } }.to_json }
       let(:headers) do
         {
           'X-Elastic-Product' => 'Elasticsearch',
@@ -177,15 +156,17 @@ describe 'Elasticsearch: Validation' do
     end
   end
 
-  context 'When the Elasticsearch version is >= 7.15-SNAPSHOT' do
+
+  context 'When the Elasticsearch version is 8.0.0.pre' do
     context 'With a valid Elasticsearch response' do
-      let(:body) { { 'version' => { 'number' => '7.15-SNAPSHOT' } }.to_json }
+      let(:body) { { 'version' => { 'number' => '8.0.0.pre' } }.to_json }
       let(:headers) do
         {
           'X-Elastic-Product' => 'Elasticsearch',
           'content-type' => 'json'
         }
       end
+
       it 'Makes requests and passes validation' do
         verify_request_stub
         count_request_stub
@@ -206,8 +187,8 @@ describe 'Elasticsearch: Validation' do
     end
   end
 
-  context 'When the version is 7.x-SNAPSHOT' do
-    let(:body) { { 'version' => { 'number' => '7.x-SNAPSHOT' } }.to_json }
+  context 'When the version is 8.0.0-SNAPSHOT' do
+    let(:body) { { 'version' => { 'number' => '8.0.0-SNAPSHOT' } }.to_json }
 
     context 'When the header is not present' do
       it 'Fails validation' do
@@ -235,77 +216,8 @@ describe 'Elasticsearch: Validation' do
     end
   end
 
-  context 'When Elasticsearch version is 7.4.0' do
-    context 'When tagline is not present' do
-      let(:body) { { 'version' => { 'number' => '7.4.0', 'build_flavor' => 'default' } }.to_json }
-
-      it 'Fails validation' do
-        verify_request_stub
-        count_request_stub
-
-        error_requests_and_expectations
-      end
-    end
-
-    context 'When build flavor is not present' do
-      let(:body) do
-        {
-          'version' => {
-            'number' => '7.4.0'
-          },
-          'tagline' => Elasticsearch::YOU_KNOW_FOR_SEARCH
-        }.to_json
-      end
-
-      it 'Fails validation' do
-        verify_request_stub
-        count_request_stub
-
-        error_requests_and_expectations(Elasticsearch::NOT_SUPPORTED_ELASTICSEARCH_WARNING)
-      end
-    end
-
-    context 'When the tagline is different' do
-      let(:body) do
-        {
-          'version' => {
-            'number' => '7.4.0',
-            'build_flavor' => 'default'
-          },
-          'tagline' => 'You Know, for other stuff'
-        }.to_json
-      end
-
-      it 'Fails validation' do
-        verify_request_stub
-        count_request_stub
-
-        error_requests_and_expectations
-      end
-    end
-
-    context 'With a valid Elasticsearch response' do
-      let(:body) do
-        {
-          'version' => {
-            'number' => '7.4.0',
-            'build_flavor' => 'default'
-          },
-          'tagline' => 'You Know, for Search'
-        }.to_json
-      end
-
-      it 'Makes requests and passes validation' do
-        verify_request_stub
-        count_request_stub
-
-        valid_requests_and_expectations
-      end
-    end
-  end
-
-  context 'When Elasticsearch version is < 6.0.0' do
-    let(:body) { { 'version' => { 'number' => '5.0.0' } }.to_json }
+  context 'When Elasticsearch version is < 8.0.0' do
+    let(:body) { { 'version' => { 'number' => '7.16.0' } }.to_json }
 
     it 'Raises an exception and client doesnae work' do
       verify_request_stub
@@ -321,141 +233,13 @@ describe 'Elasticsearch: Validation' do
     end
   end
 
-  context 'When Elasticsearch version is between 6.0.0 and 7.0.0' do
-    context 'With an Elasticsearch valid response' do
-      let(:body) do
-        {
-          'version' => {
-            'number' => '6.8.10'
-          },
-          'tagline' => 'You Know, for Search'
-        }.to_json
-      end
-
-      it 'Makes requests and passes validation' do
-        verify_request_stub
-        count_request_stub
-
-        valid_requests_and_expectations
-      end
-    end
-
-    context 'With no tagline' do
-      let(:body) do
-        { 'version' => { 'number' => '6.8.10' } }.to_json
-      end
-
-      it 'Fails validation' do
-        verify_request_stub
-        count_request_stub
-
-        error_requests_and_expectations
-      end
-    end
-
-    context 'When the tagline is different' do
-      let(:body) do
-        {
-          'version' => {
-            'number' => '6.8.10',
-            'build_flavor' => 'default'
-          },
-          'tagline' => 'You Know, for Stuff'
-        }.to_json
-      end
-
-      it 'Fails validation' do
-        verify_request_stub
-        count_request_stub
-
-        error_requests_and_expectations
-      end
-    end
-  end
-
-  context 'When Elasticsearch version is between 7.0.0 and 7.14.0' do
-    context 'With a valid Elasticsearch response' do
-      let(:body) do
-        {
-          'version' => {
-            'number' => '7.10.0',
-            'build_flavor' => 'default'
-          },
-          'tagline' => 'You Know, for Search'
-        }.to_json
-      end
-
-      it 'Makes requests and passes validation' do
-        verify_request_stub
-        count_request_stub
-
-        valid_requests_and_expectations
-      end
-    end
-
-    context 'When the tagline is not present' do
-      let(:body) do
-        {
-          'version' => {
-            'number' => '7.10.0',
-            'build_flavor' => 'default'
-          }
-        }.to_json
-      end
-
-      it 'Fails validation' do
-        verify_request_stub
-        count_request_stub
-
-        error_requests_and_expectations
-      end
-    end
-
-    context 'When the tagline is different' do
-      let(:body) do
-        {
-          'version' => {
-            'number' => '7.10.0',
-            'build_flavor' => 'default'
-          },
-          'tagline' => 'You Know, for other stuff'
-        }.to_json
-      end
-
-      it 'Fails validation' do
-        verify_request_stub
-        count_request_stub
-
-        error_requests_and_expectations
-      end
-    end
-
-    context 'When the build_flavor is not present' do
-      let(:body) do
-        {
-          'version' => {
-            'number' => '7.10.0'
-          },
-          'tagline' => 'You Know, for Search'
-        }.to_json
-      end
-
-      it 'Fails validation' do
-        verify_request_stub
-        count_request_stub
-
-        error_requests_and_expectations(Elasticsearch::NOT_SUPPORTED_ELASTICSEARCH_WARNING)
-      end
-    end
-  end
-
   context 'When doing a yaml content-type request' do
     let(:client) do
       Elasticsearch::Client.new(transport_options: {headers: { accept: 'application/yaml', content_type: 'application/yaml' }})
     end
 
     let(:headers) { { 'content-type' => 'application/yaml', 'X-Elastic-Product' => 'Elasticsearch' } }
-    let(:body) { "---\nversion:\n  number: \"7.14.0-SNAPSHOT\"\n" }
+    let(:body) { "---\nversion:\n  number: \"8.0.0-SNAPSHOT\"\n" }
 
     it 'validates' do
       verify_request_stub

data/spec/unit/headers_spec.rb

@@ -0,0 +1,55 @@
+# 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'
+require 'ostruct'
+
+describe Elasticsearch::Client do
+  context 'when a header is set on an endpoint request' do
+    let(:client) { described_class.new }
+    let(:headers) { { 'user-agent' => 'my ruby app' } }
+
+    it 'performs the request with the header' do
+      allow(client).to receive(:perform_request) { OpenStruct.new(body: '') }
+      expect { client.search(headers: headers) }.not_to raise_error
+      expect(client).to have_received(:perform_request)
+        .with('GET', '_search', {}, nil, headers)
+    end
+  end
+
+  context 'when a header is set on an endpoint request and on initialization' do
+    let!(:client) do
+      described_class.new(
+        host: 'http://localhost:9200',
+        transport_options: { headers: instance_headers }
+      ).tap do |client|
+        client.instance_variable_set('@verified', true)
+      end
+    end
+    let(:instance_headers) { { set_in_instantiation: 'header value' } }
+    let(:param_headers) { { 'user-agent' => 'My Ruby Tests', 'set-on-method-call' => 'header value' } }
+
+    it 'performs the request with the header' do
+      expected_headers = client.transport.connections.connections.first.connection.headers.merge(param_headers)
+
+      expect_any_instance_of(Faraday::Connection)
+        .to receive(:run_request)
+          .with(:get, 'http://localhost:9200/_search', nil, expected_headers) { OpenStruct.new(body: '') }
+
+      client.search(headers: param_headers)
+    end
+  end
+end

data/spec/unit/opaque_id_spec.rb

@@ -0,0 +1,48 @@
+# 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'
+require 'ostruct'
+
+describe Elasticsearch::Client do
+  let(:transport) { client.instance_variable_get('@transport') }
+  let(:client) { described_class.new.tap { |cl| cl.instance_variable_set('@verified', true) } }
+
+  before do
+    allow(transport).to receive(:perform_request) { OpenStruct.new(body: '') }
+  end
+
+  context 'when x-opaque-id is set' do
+    it 'uses x-opaque-id on a request' do
+      client.search(opaque_id: '12345')
+      expect(transport).to have_received(:perform_request)
+        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => '12345' })
+    end
+  end
+
+  context 'when an x-opaque-id prefix is set on initialization' do
+    let(:prefix) { 'elastic_cloud' }
+    let(:client) do
+      described_class.new(opaque_id_prefix: prefix).tap { |cl| cl.instance_variable_set('@verified', true) }
+    end
+
+    it 'uses x-opaque-id on a request' do
+      expect { client.search(opaque_id: '12345') }.not_to raise_error
+      expect(transport).to have_received(:perform_request)
+        .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => 'elastic_cloud12345' })
+    end
+  end
+end

data/spec/unit/wrapper_gem_spec.rb

@@ -14,13 +14,13 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-require 'elasticsearch'
-require 'webmock/rspec'
+
+require 'spec_helper'
 
 describe 'Elasticsearch: wrapper gem' do
   it 'requires all neccessary subgems' do
-    expect(defined?(Elasticsearch::Client))
-    expect(defined?(Elasticsearch::API))
+    expect(defined? Elasticsearch::Client)
+    expect(defined? Elasticsearch::API)
   end
 
   it 'mixes the API into the client' do
@@ -30,10 +30,4 @@ describe 'Elasticsearch: wrapper gem' do
     expect(client).to respond_to(:cluster)
     expect(client).to respond_to(:indices)
   end
-
-  it 'can access the client transport' do
-    client = Elasticsearch::Client.new
-    expect(client.transport).to be_a(Elasticsearch::Transport::Client)
-    expect(client.transport.transport).to be_a(Elasticsearch::Transport::Transport::HTTP::Faraday)
-  end
 end