opensearch-api 1.0.0

data/spec/opensearch/api/actions/nodes/hot_threads_spec.rb

@@ -0,0 +1,70 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.nodes#hot_threads' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_cluster/nodes/hot_threads'
+  end
+
+  it 'performs the request' do
+    expect(client_double.nodes.hot_threads).to eq({})
+  end
+
+  context 'when the node id is specified' do
+
+    let(:url) do
+      '_cluster/nodes/foo/hot_threads'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.hot_threads(node_id: 'foo')).to eq({})
+    end
+  end
+
+  context 'when the path must be URL-escaped' do
+
+    let(:url) do
+      '_cluster/nodes/foo%5Ebar/hot_threads'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.hot_threads(node_id: 'foo^bar')).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/nodes/info_spec.rb

@@ -0,0 +1,111 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.nodes#info' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_nodes'
+  end
+
+  it 'performs the request' do
+    expect(client_double.nodes.info).to eq({})
+  end
+
+  let(:params) do
+    {}
+  end
+
+  context 'when the node id is specified' do
+
+    let(:url) do
+      '_nodes/foo'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.info(node_id: 'foo')).to eq({})
+    end
+  end
+
+  context 'when multiple node ids are specified as a list' do
+
+    let(:url) do
+      '_nodes/A,B,C'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.info(node_id: ['A', 'B', 'C'])).to eq({})
+    end
+  end
+
+  context 'when multiple node ids are specified as a String' do
+
+    let(:url) do
+      '_nodes/A,B,C'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.info(node_id: 'A,B,C')).to eq({})
+    end
+  end
+
+  context 'when URL params are specified' do
+
+    let(:url) do
+      '_nodes'
+    end
+
+    let(:params) do
+      { format: 'yaml' }
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.info(format: 'yaml')).to eq({})
+    end
+  end
+
+  context 'when metrics are specified' do
+
+    let(:url) do
+      '_nodes/http,network'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.info(metric: ['http', 'network'])).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/nodes/reload_secure_settings_spec.rb

@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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#reload_secure_settings' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:params) { {} }
+  let(:url) { '_nodes/reload_secure_settings' }
+  let(:body) { nil }
+
+  it 'performs the request' do
+    expect(client_double.nodes.reload_secure_settings()).to eq({})
+  end
+
+  context 'when a node id is specified' do
+
+    let(:url) do
+      '_nodes/foo/reload_secure_settings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.reload_secure_settings(node_id: 'foo')).to eq({})
+    end
+  end
+
+  context 'when more than one node id is specified as a string' do
+    let(:body){ { foo: 'bar' } }
+
+    let(:url) do
+      '_nodes/foo,bar/reload_secure_settings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.reload_secure_settings(node_id: 'foo,bar', body: { foo: 'bar' })).to eq({})
+    end
+  end
+
+  context 'when more than one node id is specified as a list' do
+    let(:body){ { foo: 'bar' } }
+    let(:url) do
+      '_nodes/foo,bar/reload_secure_settings'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.reload_secure_settings(node_id: ['foo', 'bar'], body: { foo: 'bar' })).to eq({})
+    end
+  end
+
+  context 'when a timeout param is specified' do
+
+    let(:params) do
+      { timeout: '30s'}
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.reload_secure_settings(timeout: '30s')).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/nodes/shutdown_spec.rb

@@ -0,0 +1,85 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.nodes#shutdown' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        nil,
+        nil
+    ]
+  end
+
+  let(:url) do
+    '_cluster/nodes/_shutdown'
+  end
+
+  it 'performs the request' do
+    expect(client_double.nodes.shutdown).to eq({})
+  end
+
+  let(:params) do
+    {}
+  end
+
+  context 'when the node id is specified' do
+
+    let(:url) do
+      '_cluster/nodes/foo/_shutdown'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.shutdown(node_id: 'foo')).to eq({})
+    end
+  end
+
+  context 'when multiple node ids are specified as a list' do
+
+    let(:url) do
+      '_cluster/nodes/A,B,C/_shutdown'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.shutdown(node_id: ['A', 'B', 'C'])).to eq({})
+    end
+  end
+
+  context 'when multiple node ids are specified as a String' do
+
+    let(:url) do
+      '_cluster/nodes/A,B,C/_shutdown'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.shutdown(node_id: 'A,B,C')).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/nodes/stats_spec.rb

@@ -0,0 +1,85 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.nodes#stats' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        params,
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_nodes/stats'
+  end
+
+  it 'performs the request' do
+    expect(client_double.nodes.stats).to eq({})
+  end
+
+  let(:params) do
+    {}
+  end
+
+  context 'when the node id is specified' do
+
+    let(:url) do
+      '_nodes/foo/stats'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.stats(node_id: 'foo')).to eq({})
+    end
+  end
+
+  context 'when metrics are specified' do
+
+    let(:url) do
+      '_nodes/stats/http,fs'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.stats(metric: [:http, :fs])).to eq({})
+    end
+  end
+
+  context 'when index metric is specified' do
+
+    let(:url) do
+      '_nodes/stats/indices/filter_cache'
+    end
+
+    it 'performs the request' do
+      expect(client_double.nodes.stats(metric: :indices, index_metric: :filter_cache)).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/open_point_in_time_spec.rb

@@ -0,0 +1,53 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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#open_point_in_time' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let (:url) { '_pit'}
+
+  it 'performs the request' do
+    expect(client_double.open_point_in_time).to eq({})
+  end
+
+  context 'with index' do
+    let (:url) { 'foo/_pit'}
+
+    it 'performs the request' do
+      expect(client_double.open_point_in_time(index: 'foo')).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/ping_spec.rb

@@ -0,0 +1,85 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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#ping' do
+
+  let(:expected_args) do
+    [
+        'HEAD',
+        '',
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.ping).to eq(true)
+  end
+
+  context 'when the response is a 404' do
+
+    let(:response_double) do
+      double('response', status: 404, body: {}, headers: {})
+    end
+
+    it 'returns false' do
+      expect(client_double.ping).to eq(false)
+    end
+  end
+
+  context 'when a 404 \'not found\' exception is raised' do
+
+    before do
+      allow(client).to receive(:perform_request).and_raise(StandardError.new('404 NotFound'))
+    end
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'returns false' do
+      expect(client.ping).to eq(false)
+    end
+  end
+
+  context 'when \'connection failed\' exception is raised' do
+
+    before do
+      allow(client).to receive(:perform_request).and_raise(StandardError.new('ConnectionFailed'))
+    end
+
+    let(:client) do
+      Class.new { include OpenSearch::API }.new
+    end
+
+    it 'returns false' do
+      expect(client.ping).to eq(false)
+    end
+  end
+end

data/spec/opensearch/api/actions/put_script_spec.rb

@@ -0,0 +1,65 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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#put_script' do
+  let(:url) do
+    '_scripts/foo'
+  end
+
+  context 'when the lang parameter is provided' do
+    let(:expected_args) do
+      [
+        'PUT',
+        url,
+        {},
+        { script: 'bar', lang: 'groovy' },
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.put_script(id: 'foo', body: { script: 'bar', lang: 'groovy' })).to eq({})
+    end
+  end
+
+  context 'when the lang parameter is not provided' do
+    let(:expected_args) do
+      [
+        'PUT',
+        url,
+        {},
+        { script: 'bar' },
+        {}
+      ]
+    end
+
+    it 'performs the request' do
+      expect(client_double.put_script(id: 'foo', body: { script: 'bar' })).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/reindex_spec.rb

@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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#reindex' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        '_reindex',
+        {},
+        {},
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.reindex(body: {})).to eq({})
+  end
+end