elasticsearch-api 8.12.2 → 8.13.0

data/spec/elasticsearch/api/actions/esql/async_query_get._spec.rb

@@ -0,0 +1,35 @@
+# 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.esql#async_query_get' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_query/async/foo',
+      {},
+      nil,
+      {},
+      { defined_params: {id: 'foo' }, endpoint: 'esql.async_query_get' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.esql.async_query_get(id: 'foo')).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/esql/async_query_spec.rb

@@ -0,0 +1,35 @@
+# 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.esql#async_query' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_query/async',
+      {},
+      {},
+      {},
+      { endpoint: 'esql.async_query' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.esql.async_query(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/indices/resolve_cluster_spec.rb

@@ -0,0 +1,51 @@
+# 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.indices#delete_alias' do
+
+  let(:expected_args) do
+    [
+      'GET',
+      '_resolve/cluster/foo',
+      {},
+      nil,
+      {},
+      { defined_params: { name: 'foo'}, endpoint: 'indices.resolve_cluster' }
+    ]
+  end
+
+  context 'when there is no name specified' do
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.resolve_cluster
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+
+  context 'when name is specified' do
+    it 'performs the request' do
+      expect(client_double.indices.resolve_cluster(name: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/inference/delete_model_spec.rb

@@ -25,12 +25,12 @@ describe 'client#inference.delete_model' do
       {},
       nil,
       {},
-      { defined_params: { model_id: 'bar', task_type: 'foo' },
+      { defined_params: { inference_id: 'bar', task_type: 'foo' },
         endpoint: 'inference.delete_model' }
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.inference.delete_model(task_type: 'foo', model_id: 'bar')).to be_a Elasticsearch::API::Response
+    expect(client_double.inference.delete_model(task_type: 'foo', inference_id: 'bar')).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/inference/get_model_spec.rb

@@ -25,12 +25,12 @@ describe 'client#inference.get_model' do
       {},
       nil,
       {},
-      { defined_params: { model_id: 'bar', task_type: 'foo' },
+      { defined_params: { inference_id: 'bar', task_type: 'foo' },
         endpoint: 'inference.get_model' }
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.inference.get_model(task_type: 'foo', model_id: 'bar')).to be_a Elasticsearch::API::Response
+    expect(client_double.inference.get_model(task_type: 'foo', inference_id: 'bar')).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/inference/inference_spec.rb

@@ -25,12 +25,12 @@ describe 'client#inference.inference' do
       {},
       nil,
       {},
-      { defined_params: { model_id: 'bar', task_type: 'foo' },
+      { defined_params: { inference_id: 'bar', task_type: 'foo' },
         endpoint: 'inference.inference' }
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.inference.inference(task_type: 'foo', model_id: 'bar')).to be_a Elasticsearch::API::Response
+    expect(client_double.inference.inference(task_type: 'foo', inference_id: 'bar')).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/inference/put_model_spec.rb

@@ -25,12 +25,12 @@ describe 'client#inference.put_model' do
       {},
       nil,
       {},
-      { defined_params: { model_id: 'bar', task_type: 'foo' },
+      { defined_params: { inference_id: 'bar', task_type: 'foo' },
         endpoint: 'inference.put_model' }
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.inference.put_model(task_type: 'foo', model_id: 'bar')).to be_a Elasticsearch::API::Response
+    expect(client_double.inference.put_model(task_type: 'foo', inference_id: 'bar')).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/profiling/flamegraph_spec.rb

@@ -0,0 +1,35 @@
+# 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.profiling#flamegraph' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_profiling/flamegraph',
+      {},
+      {},
+      {},
+      { endpoint: 'profiling.flamegraph' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.profiling.flamegraph(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/profiling/stacktraces_spec.rb

@@ -0,0 +1,35 @@
+# 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.profiling#stacktraces' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_profiling/stacktraces',
+      {},
+      {},
+      {},
+      { endpoint: 'profiling.stacktraces' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.profiling.stacktraces(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/security/query_user_spec.rb

@@ -0,0 +1,49 @@
+# 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#security#query_user' do
+  let(:expected_args) do
+    [
+      method,
+      '_security/_query/user',
+      {},
+      body,
+      {},
+      { endpoint: 'security.query_user' }
+    ]
+  end
+
+  let(:body) { nil }
+  let(:method) { 'GET' }
+
+  it 'performs the request' do
+    expect(client_double.security.query_user).to be_a Elasticsearch::API::Response
+  end
+
+  context 'when body is specified' do
+    let(:body) do
+      { size: 1, query: 'test' }
+    end
+    let(:method) { 'POST' }
+
+    it 'performs the request' do
+      expect(client_double.security.query_user(body: body)).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/text_structure/find_structure_spec.rb

@@ -0,0 +1,35 @@
+# 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.text_structure#test_grok_pattern' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_text_structure/find_structure',
+      {},
+      {},
+      {"Content-Type"=>"application/x-ndjson"},
+      { endpoint: 'text_structure.find_structure' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.text_structure.find_structure(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/actions/text_structure/test_grok_pattern_spec.rb

@@ -0,0 +1,35 @@
+# 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.text_structure#test_grok_pattern' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_text_structure/test_grok_pattern',
+      {},
+      {},
+      {},
+      { endpoint: 'text_structure.test_grok_pattern' }
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.text_structure.test_grok_pattern(body: {})).to be_a Elasticsearch::API::Response
+  end
+end

data/spec/elasticsearch/api/perform_request_spec.rb

@@ -17,7 +17,7 @@
 
 require 'spec_helper'
 require 'elastic-transport'
-require_relative '../../../utils/endpoint_spec'
+require_relative '../../../utils/thor/endpoint_spec'
 require_relative '../../../utils/thor/generator/files_helper'
 
 describe 'Perform request args' do

data/spec/free/integration/health_spec.rb

@@ -0,0 +1,28 @@
+# 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.
+# TODO: These tests won't be necessary once we migrate to the new YAML tests
+require_relative './spec_helper'
+
+describe "Health basic test" do
+  it 'performs the request' do
+    response = CLIENT.health_report
+    expect(response.status).to eq 200
+    expect(response['cluster_name']).not_to be_nil
+    expect(response.dig('indicators', 'master_is_stable', 'symptom')).to eq 'The cluster has a stable master node'
+    expect(response.dig('indicators', 'master_is_stable', 'status')).to eq 'green'
+  end
+end

data/spec/free/integration/spec_helper.rb

@@ -0,0 +1,28 @@
+# 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 'elasticsearch'
+
+host = ENV['TEST_ES_SERVER'] || 'http://localhost:9200'
+raise URI::InvalidURIError unless host =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
+
+test_suite = ENV['TEST_SUITE'] || 'free'
+password = ENV['ELASTIC_PASSWORD'] || 'changeme'
+uri = URI.parse(host)
+transport_options = {}
+host = "http://elastic:#{password}@#{uri.host}:#{uri.port}".freeze
+
+CLIENT = Elasticsearch::Client.new(host: host, transport_options: transport_options)

data/spec/platinum/integration/api_key/api_key_query_with_aggs_spec.rb

@@ -0,0 +1,120 @@
+# 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_relative '../platinum_helper'
+
+describe 'API keys' do
+  before do
+    ADMIN_CLIENT.security.put_role(
+      name: 'admin_role',
+      body: { cluster: ['manage_api_key'] }
+    )
+    ADMIN_CLIENT.security.put_role(
+      name: 'user_role',
+      body: {
+        cluster: ['manage_own_api_key'],
+      }
+    )
+    ADMIN_CLIENT.security.put_user(
+      username: 'api_key_manager',
+      body: {
+        password: 'x-pack-test-password',
+        roles: [ 'admin_role' ],
+        full_name: 'API key manager'
+      }
+    )
+
+    ADMIN_CLIENT.security.put_user(
+      username: 'api_key_user',
+      body: {
+        password: 'x-pack-test-password',
+        roles: [ 'user_role' ],
+        full_name: 'API key user'
+      }
+    )
+  end
+  after do
+    ADMIN_CLIENT.security.delete_role(name: "admin_role", ignore: 404)
+    ADMIN_CLIENT.security.delete_role(name: "user_role", ignore: 404)
+    ADMIN_CLIENT.security.delete_user(username: "api_key_user", ignore: 404)
+    ADMIN_CLIENT.security.delete_user(username: "api_key_manager", ignore: 404)
+  end
+
+  def client(headers)
+    Elasticsearch::Client.new(
+      host: "https://#{HOST_URI.host}:#{HOST_URI.port}",
+      transport_options: TRANSPORT_OPTIONS.merge(headers: headers)
+    )
+  end
+
+  let(:manager_auth) do
+    { Authorization: "Basic YXBpX2tleV9tYW5hZ2VyOngtcGFjay10ZXN0LXBhc3N3b3Jk" }
+  end
+  let(:user_auth) do
+    { Authorization: "Basic YXBpX2tleV9tYW5hZ2VyOngtcGFjay10ZXN0LXBhc3N3b3Jk" }
+  end
+
+  it 'queries api key with args' do
+    # api_key_manager authorization:
+    client = client(manager_auth)
+    response = client.security.create_api_key(
+      body: {
+        name: 'manager-api-key',
+        expiration: '10d',
+        metadata: {
+          letter: 'a',
+          number: 42
+        }
+      }
+    )
+    expect(response.status).to eq 200
+    id = response['id']
+    api_key = response['api_key']
+    expect(response['encoded']).to eq Base64.strict_encode64("#{id}:#{api_key}")
+
+    client = client(user_auth)
+    response = client.security.create_api_key(
+      body: {
+        name: 'user-api-key',
+        expiration: '1d',
+        metadata: {
+          letter: 'a',
+          number: 1
+        }
+      }
+    )
+    expect(response.status).to eq 200
+    id = response['id']
+    api_key = response['api_key']
+    expect(response['encoded']).to eq Base64.strict_encode64("#{id}:#{api_key}")
+
+    response = client.security.query_api_keys(
+      body: {
+        size: 0,
+        aggs: {
+          my_buckets: {
+            composite: {
+              sources: [{ key_name: { terms: { field: "name" } } } ]
+            }
+          }
+        }
+      }
+    )
+    expect(response.dig('aggregations', 'my_buckets', 'buckets').find { |a| a.dig('key', 'key_name') == 'manager-api-key'})
+    expect(response.dig('aggregations', 'my_buckets', 'buckets').find { |a| a.dig('key', 'key_name') == 'user-api-key'})
+  end
+end

data/spec/platinum/integration/platinum_helper.rb

@@ -37,6 +37,6 @@ ADMIN_CLIENT = Elasticsearch::Client.new(host: HOST, transport_options: TRANSPOR
 
 RSpec.configure do |config|
   config.add_formatter('documentation')
-  config.add_formatter('RSpec::Core::Formatters::HtmlFormatter', "tmp/platinum-integration.html")
+  config.add_formatter('RSpec::Core::Formatters::HtmlFormatter', "tmp/platinum-#{ENV['RUBY_VERSION']}-manual-integration.html")
   config.color_mode = :on
 end

data/spec/platinum/integration/security/users_query_spec.rb

@@ -0,0 +1,49 @@
+# 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_relative '../platinum_helper'
+
+describe 'security/Query User' do
+  before do
+    ADMIN_CLIENT.security.put_user(
+      username: "query_users_test",
+      body: {
+        password: "x-pack-test-password",
+        roles: [ "manage_users_role" ],
+        full_name: "Read User"
+      }
+    )
+  end
+
+  it 'queries users' do
+    response = ADMIN_CLIENT.security.query_user(body: {})
+    expect(response.status).to eq 200
+    expect(response['count']).to be > 0
+    expect(response['total']).to be > 0
+  end
+
+  it 'queries user and finds created one' do
+    body = {
+      query: { wildcard: { username: 'query_users_*' } }
+    }
+    response = ADMIN_CLIENT.security.query_user(body: body)
+    expect(response.status).to eq 200
+    expect(response['count']).to be 1
+    expect(response['total']).to be 1
+    expect(response['users'].first['username']).to eq 'query_users_test'
+  end
+end

data/spec/rest_api/skipped_tests_free.yml

@@ -31,9 +31,24 @@
 -
   :file: 'cluster.desired_nodes/10_basic.yml'
   :description: 'Test update desired nodes is idempotent with different order'
+-
+  :file: 'cluster.desired_nodes/10_basic.yml'
+  :description: 'Test node version must be at least the current master version'
+-
+  :file: 'cluster.desired_nodes/10_basic.yml'
+  :description: 'Test node version must have content'
 -
   :file: 'search.vectors/40_knn_search.yml'
   :description: 'Direct kNN queries are disallowed'
 -
   :file: 'search.vectors/45_knn_search_byte.yml'
   :description: 'Direct kNN queries are disallowed'
+-
+  :file: 'tsdb/25_id_generation.yml'
+  :description: 'generates a consistent id'
+-
+  :file: 'indices.resolve_cluster/10_basic_resolve_cluster.yml'
+  :description: 'Resolve cluster using alias and index that does not exist'
+-
+  :file: 'health/10_basic.yml' # Migrated to written manually
+  :description: 'cluster health basic test'

data/spec/rest_api/skipped_tests_platinum.yml

@@ -112,3 +112,9 @@
 -
   :file: 'esql/60_usage.yml'
   :description: 'Basic ESQL usage output (telemetry)'
+-
+  :file: 'users/40_query.yml'
+  :description: 'Test query user'
+-
+  :file: 'api_key/21_query_with_aggs.yml'
+  :description: 'Test composite aggs api key'