[XPACK] Adds searchable_snapshots/cache_stats endpoint, specs for searchable_snapshots

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/searchable_snapshots/cache_stats.rb

@@ -0,0 +1,56 @@
+# 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.
+
+module Elasticsearch
+  module XPack
+    module API
+      module SearchableSnapshots
+        module Actions
+          # Retrieve node-level cache statistics about searchable snapshots.
+          # This functionality is Experimental and may be changed or removed
+          # completely in a future release. Elastic will take a best effort approach
+          # to fix any issues, but experimental features are not subject to the
+          # support SLA of official GA features.
+          #
+          # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-apis.html
+          #
+          def cache_stats(arguments = {})
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _node_id = arguments.delete(:node_id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = if _node_id
+                       "_searchable_snapshots/#{Elasticsearch::API::Utils.__listify(_node_id)}/cache/stats"
+                     else
+                       "_searchable_snapshots/cache/stats"
+                     end
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/searchable_snapshots/cache_stats_spec.rb

@@ -0,0 +1,44 @@
+# 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#searchable_snapshots.cache_stats' do
+  let(:expected_args) do
+    [
+      'GET',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url){ '_searchable_snapshots/cache/stats' }
+
+  it 'performs the request' do
+    expect(client_double.searchable_snapshots.cache_stats).to eq({})
+  end
+
+  context 'when using index' do
+    let(:url){ '_searchable_snapshots/foo/cache/stats' }
+
+    it 'performs the request' do
+      expect(client_double.searchable_snapshots.cache_stats(node_id: 'foo')).to eq({})
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/searchable_snapshots/clear_cache_spec.rb

@@ -0,0 +1,44 @@
+# 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#searchable_snapshots.clear_cache' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url){ '_searchable_snapshots/cache/clear' }
+
+  it 'performs the request' do
+    expect(client_double.searchable_snapshots.clear_cache).to eq({})
+  end
+
+  context 'when using index' do
+    let(:url){ 'foo/_searchable_snapshots/cache/clear' }
+
+    it 'performs the request' do
+      expect(client_double.searchable_snapshots.clear_cache(index: 'foo')).to eq({})
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/searchable_snapshots/mount_spec.rb

@@ -0,0 +1,56 @@
+# 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#searchable_snapshots.mount' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_snapshot/foo/bar/_mount',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.searchable_snapshots.mount(body: {}, repository: 'foo', snapshot: 'bar')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::XPack::API }.new
+  end
+
+  it 'requires the :body argument' do
+    expect {
+      client.searchable_snapshots.mount(repository: 'foo', snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :repository argument' do
+    expect {
+      client.searchable_snapshots.mount(body: {}, snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :snapshot argument' do
+    expect {
+      client.searchable_snapshots.mount(body: {}, repository: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+end

elasticsearch-xpack/spec/xpack/searchable_snapshots/repository_stats_spec.rb

@@ -0,0 +1,44 @@
+# 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#searchable_snapshots.repository_stats' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_snapshot/foo/_stats',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.searchable_snapshots.repository_stats(repository: 'foo')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::XPack::API }.new
+  end
+
+  it 'requires the :repository argument' do
+    expect {
+      client.searchable_snapshots.repository_stats
+    }.to raise_exception(ArgumentError)
+  end
+end

elasticsearch-xpack/spec/xpack/searchable_snapshots/stats_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 'client#searchable_snapshots.stats' do
+  let(:expected_args) do
+    [
+      'GET',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+  let(:url) { '_searchable_snapshots/stats' }
+
+  it 'performs the request' do
+    expect(client_double.searchable_snapshots.stats).to eq({})
+  end
+
+  context 'using index' do
+    let(:url) { 'foo/_searchable_snapshots/stats' }
+
+    it 'performs the request' do
+      expect(client_double.searchable_snapshots.stats(index: 'foo')).to eq({})
+    end
+  end
+end