elasticsearch 7.17.1 → 8.1.0

data/spec/unit/api_key_spec.rb

@@ -0,0 +1,101 @@
+# 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 API Key' do
+    let(:authorization_header) do
+      client.transport.connections.first.connection.headers['Authorization']
+    end
+
+    context 'when an encoded api_key is provided' do
+      let(:client) do
+        described_class.new(api_key: 'an_api_key')
+      end
+
+      it 'Adds the ApiKey header to the connection' do
+        expect(authorization_header).to eq('ApiKey an_api_key')
+      end
+    end
+
+    context 'when an un-encoded api_key is provided' do
+      let(:client) do
+        described_class.new(api_key: { id: 'my_id', api_key: 'my_api_key' })
+      end
+
+      it 'Adds the ApiKey header to the connection' do
+        expect(authorization_header).to eq("ApiKey #{Base64.strict_encode64('my_id:my_api_key')}")
+      end
+    end
+
+    context 'when basic auth and api_key are provided' do
+      let(:client) do
+        described_class.new(
+          api_key: { id: 'my_id', api_key: 'my_api_key' },
+          host: 'http://elastic:password@localhost:9200'
+        )
+      end
+
+      it 'removes basic auth credentials' do
+        expect(authorization_header).not_to match(/^Basic/)
+        expect(authorization_header).to match(/^ApiKey/)
+      end
+    end
+
+    context 'when other headers where specified' do
+      let(:client) do
+        described_class.new(
+          api_key: 'elasticsearch_api_key',
+          transport_options: { headers: { 'x-test-header' => 'test' } }
+        )
+      end
+
+      it 'Adds the ApiKey header to the connection and keeps the header' do
+        header = client.transport.connections.first.connection.headers
+        expect(header['Authorization']).to eq('ApiKey elasticsearch_api_key')
+        expect(header['X-Test-Header']).to eq('test')
+      end
+    end
+
+    context 'Metaheader' do
+      let(:adapter_code) { "nh=#{defined?(Net::HTTP::VERSION) ? Net::HTTP::VERSION : Net::HTTP::HTTPVersion}" }
+      let(:meta_header) do
+        if jruby?
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+        else
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elastic::Transport::VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+        end
+      end
+
+      context 'when using API Key' do
+        let(:client) do
+          described_class.new(api_key: 'an_api_key')
+        end
+
+        let(:headers) do
+          client.transport.connections.first.connection.headers
+        end
+
+        it 'adds the ApiKey header to the connection' do
+          expect(authorization_header).to eq('ApiKey an_api_key')
+          expect(headers).to include('x-elastic-client-meta' => meta_header)
+        end
+      end
+    end
+  end
+end

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

@@ -32,13 +32,13 @@ describe 'Elasticsearch: Validation' do
   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
@@ -65,7 +65,6 @@ describe 'Elasticsearch: Validation' do
 
       verify_request_stub
       count_request_stub
-
       valid_requests_and_expectations
 
       fake_stderr.rewind
@@ -86,7 +85,6 @@ describe 'Elasticsearch: Validation' do
 
       verify_request_stub
       count_request_stub
-
       valid_requests_and_expectations
 
       fake_stderr.rewind
@@ -96,30 +94,63 @@ describe 'Elasticsearch: Validation' do
     end
   end
 
-  context 'When Elasticsearch replies with status 403' do
+  context 'When Elasticsearch replies with status 413' do
     let(:status) { 413 }
     let(:body) { {}.to_json }
 
-    it 'Verifies the request but shows a warning' do
+    it 'Verifies the request and shows a warning' do
       stderr      = $stderr
       fake_stderr = StringIO.new
       $stderr     = fake_stderr
 
+      expect(client.instance_variable_get('@verified')).to be false
+      assert_not_requested :get, host
       verify_request_stub
-      count_request_stub
+      expect { client.info }.to raise_error Elastic::Transport::Transport::Errors::RequestEntityTooLarge
+      expect(client.instance_variable_get('@verified')).to be true
 
-      valid_requests_and_expectations
+      fake_stderr.rewind
+      expect(fake_stderr.string.delete("\n"))
+        .to eq(Elasticsearch::SECURITY_PRIVILEGES_VALIDATION_WARNING)
+    ensure
+      $stderr = stderr
+    end
+  end
+
+  context 'When Elasticsearch replies with status 503' do
+    let(:status) { 503 }
+    let(:body) { {}.to_json }
+
+    it 'Does not verify the request and shows a warning' do
+      stderr      = $stderr
+      fake_stderr = StringIO.new
+      $stderr     = fake_stderr
+
+      expect(client.instance_variable_get('@verified')).to be false
+      assert_not_requested :get, host
+      verify_request_stub
+      expect { client.info }.to raise_error Elastic::Transport::Transport::Errors::ServiceUnavailable
+      assert_not_requested :post, "#{host}/_count"
+      expect(client.instance_variable_get('@verified')).to be false
 
       fake_stderr.rewind
-      expect(fake_stderr.string).to eq("#{Elasticsearch::SECURITY_PRIVILEGES_VALIDATION_WARNING}\n")
+      expect(fake_stderr.string)
+        .to eq(
+              <<~MSG
+            The client is unable to verify that the server is \
+            Elasticsearch. Some functionality may not be compatible \
+            if the server is running an unsupported product.
+          MSG
+            )
     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 +178,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 +208,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 +239,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 +268,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 +285,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