elasticsearch-api 7.9.0 → 7.14.1

data/spec/elasticsearch/api/actions/shutdown/put_node_spec.rb

@@ -0,0 +1,50 @@
+# 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.shutdown#put_node' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_nodes/id/shutdown',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.shutdown.put_node(body: {}, node_id: 'id')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'raises an error if no node_id is provided' do
+    expect {
+      client.shutdown.put_node(body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'raises an error if no body is provided' do
+    expect {
+      client.shutdown.put_node(node_id: 'id')
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/snapshot/clone_spec.rb

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

data/spec/elasticsearch/api/actions/snapshot/get_features_spec.rb

@@ -0,0 +1,38 @@
+# 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.snapshot#get' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_snapshottable_features',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'performs the request' do
+    expect(client_double.snapshot.get_features).to eq({})
+  end
+end

data/spec/elasticsearch/api/actions/snapshot/repository_analize_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'
+
+describe 'client.snapshot#repository_analyze' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url) do
+    '_snapshot/foo/_analyze'
+  end
+
+  it 'performs the request' do
+    expect(client_double.snapshot.repository_analyze(repository: 'foo')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :repository argument' do
+    expect {
+      client.snapshot.repository_analyze
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -1,18 +1,45 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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 'rest_yaml_tests_helper'
 
 describe 'Rest API YAML tests' do
+  if REST_API_YAML_FILES.empty?
+    logger = Logger.new($stdout)
+    logger.error 'No test files found!'
+    logger.info 'Use rake rake elasticsearch:download_artifacts in the root directory of the project to download the test artifacts.'
+    exit 1
+  end
+
   # Traverse YAML files and create TestFile object:
   REST_API_YAML_FILES.each do |file|
-    test_file = Elasticsearch::RestAPIYAMLTests::TestFile.new(file, REST_API_YAML_SKIP_FEATURES)
+    begin
+      test_file = Elasticsearch::RestAPIYAMLTests::TestFile.new(file, ADMIN_CLIENT, REST_API_YAML_SKIP_FEATURES)
+    rescue SkipTestsException => _e
+      # If the test file has a `skip` at the top level that applies to this
+      # version of Elasticsearch, continue with the next text.
+      logger = Logger.new($stdout)
+      logger.info "Skipping #{file} due to 'skip all'."
+      next
+    end
 
     context "#{file.gsub("#{YAML_FILES_DIRECTORY}/", '')}" do
       test_file.tests.each do |test|
-
         context "#{test.description}" do
           if test.skip_test?(ADMIN_CLIENT)
             skip 'Test contains feature(s) not yet supported or version is not satisfied'
@@ -23,13 +50,13 @@ describe 'Rest API YAML tests' do
 
             # Runs once before each test in a test file
             before(:all) do
-              Elasticsearch::RestAPIYAMLTests::TestFile.clear_data(ADMIN_CLIENT)
-              test_file.setup(ADMIN_CLIENT)
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
+              test_file.setup
             end
 
             after(:all) do
-              test_file.teardown(ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.clear_data(ADMIN_CLIENT)
+              test_file.teardown
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
             end
 
             test.task_groups.each do |task_group|

data/spec/rest_yaml_tests_helper.rb

@@ -20,9 +20,9 @@ require "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/rspec_ma
 include Elasticsearch::RestAPIYAMLTests
 
 TRANSPORT_OPTIONS = {}
-PROJECT_PATH = File.join(File.dirname(__FILE__), '..', '..')
+PROJECT_PATH = File.join(File.dirname(__FILE__), '..')
 
-if hosts = ELASTICSEARCH_URL
+if (hosts = ELASTICSEARCH_URL)
   split_hosts = hosts.split(',').map do |host|
     /(http\:\/\/)?\S+/.match(host)
   end
@@ -47,61 +47,34 @@ if defined?(TEST_HOST) && defined?(TEST_PORT)
   end
 end
 
-
-YAML_FILES_DIRECTORY = "#{File.expand_path(File.dirname('..'), '..')}" +
-    "/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test"
+YAML_FILES_DIRECTORY = "#{PROJECT_PATH}/../tmp/rest-api-spec/test/free"
 
 SINGLE_TEST = if ENV['SINGLE_TEST'] && !ENV['SINGLE_TEST'].empty?
-                ["#{File.expand_path(File.dirname('..'), '..')}" +
-                     "/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test/#{ENV['SINGLE_TEST']}"]
+                test_target = ENV['SINGLE_TEST']
+
+                if test_target.match?(/\.yml$/)
+                  ["#{PROJECT_PATH}/../tmp/rest-api-spec/test/free/#{test_target}"]
+                else
+                  Dir.glob(
+                    ["#{PROJECT_PATH}/../tmp/rest-api-spec/test/free/#{test_target}/*.yml"]
+                  )
+                end
               end
 
-skipped_tests = []
-
-# Response from Elasticsearch is just a String, so it's not possible to compare using headers.
-skipped_tests << { file:        'cat.aliases/20_headers.yml',
-                   description: 'Simple alias with yaml body through Accept header' }
-
-# Check version skip logic
-skipped_tests << { file:        'create/15_without_id.yml',
-                   description: 'Create without ID' }
-
-# No error is raised
-skipped_tests << { file:        'create/15_without_id_with_types.yml',
-                   description: 'Create without ID' }
-
-# Error message doesn't match
-skipped_tests << { file:        'tasks.get/10_basic.yml',
-                   description: 'get task test' }
-
-# No error is raised
-skipped_tests << { file:        'cat.allocation/10_basic.yml',
-                   description: '*' }
-
-# Figure out how to match response when there is an error
-skipped_tests << { file:        'delete/70_mix_typeless_typeful.yml',
-                   description: '*' }
-
-# Figure out how to match response when there is an error
-skipped_tests << { file:        'cat.templates/10_basic.yml',
-                   description: '*' }
-
-# node_selector is not supported yet
-skipped_tests << { file: 'cat.aliases/10_basic.yml',
-                   description: '*' }
-
-# Responses are there but not equal (eg.: yellow status)
-skipped_tests << { file: 'cluster.health/10_basic.yml',
-                   description: 'cluster health with closed index (pre 7.2.0)' }
-
-# Regular expression not catching exact match:
-skipped_tests << { file: 'cat.indices/10_basic.yml',
-                   description: 'Test cat indices output for closed index (pre 7.2.0)' }
-
-SKIPPED_TESTS = skipped_tests
+# Skipped tests
+file = File.expand_path("#{__dir__}/skipped_tests.yml")
+skipped_tests = YAML.load_file(file)
 
 # The directory of rest api YAML files.
-REST_API_YAML_FILES = SINGLE_TEST || Dir.glob("#{YAML_FILES_DIRECTORY}/**/*.yml")
+REST_API_YAML_FILES = if ENV['RUN_SKIPPED_TESTS'] # only run the skipped tests if true
+                        SKIPPED_TESTS = []
+                        skipped_tests.map { |test| "#{YAML_FILES_DIRECTORY}/#{test[:file]}" }
+                      else
+                        # If not, define the skipped tests constant and try the single test or all
+                        # the tests
+                        SKIPPED_TESTS = skipped_tests
+                        SINGLE_TEST || Dir.glob("#{YAML_FILES_DIRECTORY}/**/*.yml")
+                      end
 
 # The features to skip
-REST_API_YAML_SKIP_FEATURES = ['warnings'].freeze
+REST_API_YAML_SKIP_FEATURES = ['warnings', 'node_selector'].freeze

data/spec/skipped_tests.yml

@@ -0,0 +1,29 @@
+# Response from Elasticsearch is just a String, so it's not possible to compare using headers.
+-
+  :file:        'cat.aliases/20_headers.yml'
+  :description: 'Simple alias with yaml body through Accept header'
+
+# Check version skip logic
+-
+  :file:        'create/15_without_id.yml'
+  :description: 'Create without ID'
+
+# No error is raised
+-
+  :file:        'create/15_without_id_with_types.yml'
+  :description: 'Create without ID'
+
+# Error message doesn't match
+-
+  :file:        'tasks.get/10_basic.yml'
+  :description: 'get task test'
+
+# Figure out how to match response when there is an error
+-
+  :file:        'delete/70_mix_typeless_typeful.yml'
+  :description: '*'
+
+# Figure out how to match response when there is an error
+-
+  :file:        'cat.templates/10_basic.yml'
+  :description: '*'

data/spec/spec_helper.rb

@@ -14,6 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+if ENV['COVERAGE'] && ENV['CI'].nil?
+  require 'simplecov'
+  SimpleCov.start { add_filter %r{^/test|spec/} }
+end
 
 if defined?(JRUBY_VERSION)
   require 'pry-nav'
@@ -42,7 +46,6 @@ DEFAULT_CLIENT = Elasticsearch::Client.new(host: ELASTICSEARCH_URL,
 
 module HelperModule
   def self.included(context)
-
     context.let(:client_double) do
       Class.new { include Elasticsearch::API }.new.tap do |client|
         expect(client).to receive(:perform_request).with(*expected_args).and_return(response_double)

data/utils/Gemfile

@@ -18,10 +18,11 @@
 source 'https://rubygems.org'
 
 gem 'activesupport'
-gem 'rest-client'
+gem 'byebug'
 gem 'coderay'
-gem 'multi_json'
-gem 'thor'
 gem 'json'
+gem 'multi_json'
 gem 'pry'
+gem 'rest-client'
 gem 'rubocop'
+gem 'thor'

data/utils/README.md

@@ -6,7 +6,12 @@ This directory hosts The Generator, a tool that generates the classes for each A
 
 ### Generate
 
-To generate the code, you need to run (from this folder):
+To generate the code, you need to have the Elasticsearch REST API spec files in `tmp/rest-api-spec` in the root of the project. You can run a rake task from the root of the project to download the specs corresponding to the current running cluster:
+```bash
+$ rake elasticsearch:download_artifacts
+```
+
+Once the JSON files have been downloaded, you need to run (from this folder):
 ```bash
 $ thor api:code:generate
 ```