elasticsearch-api 6.8.0 → 7.10.0

data/spec/elasticsearch/api/actions/update_by_query_spec.rb

@@ -1,3 +1,20 @@
+# 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#update_by_query' do
@@ -6,8 +23,9 @@ describe 'client#update_by_query' do
     [
         'POST',
         'foo/_update_by_query',
-        { },
-        nil
+        {},
+        nil,
+        {}
     ]
   end
 

data/spec/elasticsearch/api/actions/update_document_spec.rb

@@ -1,3 +1,20 @@
+# 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#update' do
@@ -7,7 +24,8 @@ describe 'client#update' do
         'POST',
         url,
         params,
-        body
+        body,
+        {}
     ]
   end
 
@@ -33,12 +51,6 @@ describe 'client#update' do
     }.to raise_exception(ArgumentError)
   end
 
-  it 'requires the :type argument' do
-    expect {
-      client.update(index: 'foo', id: '1')
-    }.to raise_exception(ArgumentError)
-  end
-
   it 'requires the :id argument' do
     expect {
       client.update(index: 'foo', type: 'bar')
@@ -55,16 +67,12 @@ describe 'client#update' do
       'foo/bar/1/_update'
     end
 
-    let(:params) do
-      { version: 100 }
-    end
-
     let(:body) do
       {}
     end
 
     it 'performs the request' do
-      expect(client_double.update(index: 'foo', type: 'bar', id: '1', version: 100, body: {}))
+      expect(client_double.update(index: 'foo', type: 'bar', id: '1', body: {}))
     end
   end
 
@@ -100,14 +108,14 @@ describe 'client#update' do
 
     it 'raises it to the user' do
       expect {
-        client.update(index: 'foo', type: 'bar', id: 'XXX')
+        client.update(index: 'foo', type: 'bar', id: 'XXX', body: {})
       }.to raise_exception(NotFound)
     end
 
     context 'when the :ignore parameter is specified' do
 
       it 'does not raise the error to the user' do
-        expect(client.update(index: 'foo', type: 'bar', id: 'XXX', ignore: 404)).to eq(false)
+        expect(client.update(index: 'foo', type: 'bar', id: 'XXX', body: {}, ignore: 404)).to eq(false)
       end
     end
   end

data/spec/elasticsearch/api/api_spec.rb

@@ -1,3 +1,20 @@
+# 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::API do

data/spec/elasticsearch/api/client_spec.rb

@@ -1,3 +1,20 @@
+# 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 'API Client' do

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -0,0 +1,138 @@
+# 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
+#
+require 'spec_helper'
+require 'rest_yaml_tests_helper'
+
+describe 'Rest API YAML tests' do
+  # Traverse YAML files and create TestFile object:
+  REST_API_YAML_FILES.each do |file|
+    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.
+      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'
+          else
+            let(:client) do
+              DEFAULT_CLIENT
+            end
+
+            # Runs once before each test in a test file
+            before(:all) do
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
+              test_file.setup
+            end
+
+            after(:all) do
+              test_file.teardown
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
+            end
+
+            test.task_groups.each do |task_group|
+              before do
+                task_group.run(client)
+              end
+
+              # 'catch' is in the task group definition
+              if task_group.catch_exception?
+                it 'sends the request and throws the expected error' do
+                  expect(task_group.exception).to match_error(task_group.expected_exception_message)
+                end
+
+                # 'match' on error description is in the task group definition
+                if task_group.has_match_clauses?
+                  task_group.match_clauses.each do |match|
+                    it 'contains the expected error in the request response' do
+                      expect(task_group.exception.message).to match(Regexp.new(Regexp.escape(match['match'].values.first.to_s)))
+                    end
+                  end
+                end
+              else
+                # 'match' is in the task group definition
+                if task_group.has_match_clauses?
+                  task_group.match_clauses.each do |match|
+                    it "has the expected value (#{match['match'].values.join(',')}) in the response field (#{match['match'].keys.join(',')})" do
+                      expect(task_group.response).to match_response(match['match'], test)
+                    end
+                  end
+                end
+
+                # 'length' is in the task group definition
+                if task_group.has_length_match_clauses?
+                  task_group.length_match_clauses.each do |match|
+                    it "the '#{match['length'].keys.join(',')}' field have the expected length" do
+                      expect(task_group.response).to match_response_field_length(match['length'], test)
+                    end
+                  end
+                end
+
+                # 'is_true' is in the task group definition
+                if task_group.has_true_clauses?
+                  task_group.true_clauses.each do |match|
+                    it "sends the request and the '#{match['is_true']}' field is set to true" do
+                      expect(task_group.response).to match_true_field(match['is_true'], test)
+                    end
+                  end
+                end
+
+                # 'is_false' is in the task group definition
+                if task_group.has_false_clauses?
+                  task_group.false_clauses.each do |match|
+                    it "sends the request and the '#{match['is_false']}' field is set to true" do
+                      expect(task_group.response).to match_false_field(match['is_false'], test)
+                    end
+                  end
+                end
+
+                # 'gte' is in the task group definition
+                if task_group.has_gte_clauses?
+                  task_group.gte_clauses.each do |match|
+                    it "sends the request and the '#{match['gte']}' field is greater than or equal to the expected value" do
+                      expect(task_group.response).to match_gte_field(match['gte'], test)
+                    end
+                  end
+                end
+
+                # 'gt' is in the task group definition
+                if task_group.has_gt_clauses?
+                  task_group.gt_clauses.each do |match|
+                    it "sends the request and the '#{match['gt']}' field is greater than the expected value" do
+                      expect(task_group.response).to match_gt_field(match['gt'], test)
+                    end
+                  end
+                end
+
+                # 'lte' is in the task group definition
+                if task_group.has_lte_clauses?
+                  task_group.lte_clauses.each do |match|
+                    it "sends the request and the '#{match['lte']}' field is less than or equal to the expected value" do
+                      expect(task_group.response).to match_lte_field(match['lte'], test)
+                    end
+                  end
+                end
+
+                # 'lt' is in the task group definition
+                if task_group.has_lt_clauses?
+                  task_group.lt_clauses.each do |match|
+                    it "sends the request and the '#{match['lt']}' field is less than the expected value" do
+                      expect(task_group.response).to match_lt_field(match['lt'], test)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/elasticsearch/api/utils_spec.rb

@@ -1,3 +1,20 @@
+# 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::API::Utils do
@@ -27,7 +44,7 @@ describe Elasticsearch::API::Utils do
       expect(utils.__escape('foo bar')).to eq('foo+bar')
     end
 
-    it 'uses the escape_utils gem when available', unless: JRUBY do
+    it 'uses the escape_utils gem when available', unless: defined?(JRUBY_VERSION) do
       require 'escape_utils'
       expect(CGI).not_to receive(:escape)
       expect(EscapeUtils).to receive(:escape_url).and_call_original

data/spec/rest_yaml_tests_helper.rb

@@ -0,0 +1,107 @@
+# 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 "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/test_file"
+require "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/rspec_matchers"
+include Elasticsearch::RestAPIYAMLTests
+
+TRANSPORT_OPTIONS = {}
+PROJECT_PATH = File.join(File.dirname(__FILE__), '..', '..')
+
+if hosts = ELASTICSEARCH_URL
+  split_hosts = hosts.split(',').map do |host|
+    /(http\:\/\/)?\S+/.match(host)
+  end
+  uri = URI.parse(split_hosts.first[0])
+  TEST_HOST = uri.host
+  TEST_PORT = uri.port
+else
+  TEST_HOST, TEST_PORT = 'localhost', '9200'
+end
+
+if defined?(TEST_HOST) && defined?(TEST_PORT)
+  URL = "http://#{TEST_HOST}:#{TEST_PORT}"
+
+  ADMIN_CLIENT = Elasticsearch::Client.new(host: URL, transport_options: TRANSPORT_OPTIONS)
+
+  if ENV['QUIET'] == 'true'
+    DEFAULT_CLIENT = Elasticsearch::Client.new(host: URL, transport_options: TRANSPORT_OPTIONS)
+  else
+    DEFAULT_CLIENT = Elasticsearch::Client.new(host: URL,
+                                               transport_options: TRANSPORT_OPTIONS,
+                                               tracer: Logger.new($stdout))
+  end
+end
+
+
+YAML_FILES_DIRECTORY = "#{File.expand_path(File.dirname('..'), '..')}" +
+    "/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test"
+
+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']}"]
+              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
+
+# The directory of rest api YAML files.
+REST_API_YAML_FILES = SINGLE_TEST || Dir.glob("#{YAML_FILES_DIRECTORY}/**/*.yml")
+
+# The features to skip
+REST_API_YAML_SKIP_FEATURES = ['warnings'].freeze

data/spec/spec_helper.rb

@@ -1,23 +1,44 @@
-require 'pry-nav'
-require 'elasticsearch-transport'
+# 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.
+
+if defined?(JRUBY_VERSION)
+  require 'pry-nav'
+else
+  require 'pry-byebug'
+end
+require 'ansi'
+require 'elasticsearch'
 require 'elasticsearch-api'
-
-require 'jbuilder' if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+require 'elasticsearch-transport'
+require 'jbuilder'
 require 'jsonify'
+require 'yaml'
 
-require 'ansi'
 tracer = ::Logger.new(STDERR)
 tracer.formatter = lambda { |s, d, p, m| "#{m.gsub(/^.*$/) { |n| '   ' + n }.ansi(:faint)}\n" }
 
-RUBY_1_8 = defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
-JRUBY    = defined?(JRUBY_VERSION)
-
 unless defined?(ELASTICSEARCH_URL)
-  ELASTICSEARCH_URL = ENV['ELASTICSEARCH_URL'] || ENV['TEST_ES_SERVER'] || "localhost:#{(ENV['TEST_CLUSTER_PORT'] || 9200)}"
+  ELASTICSEARCH_URL = ENV['ELASTICSEARCH_URL'] ||
+                        ENV['TEST_ES_SERVER'] ||
+                        "localhost:#{(ENV['TEST_CLUSTER_PORT'] || 9200)}"
 end
 
-DEFAULT_CLIENT = Elasticsearch::Client.new host: ELASTICSEARCH_URL,
-                                           tracer: (ENV['QUIET'] ? nil : tracer)
+DEFAULT_CLIENT = Elasticsearch::Client.new(host: ELASTICSEARCH_URL,
+                                           tracer: (tracer unless ENV['QUIET']))
 
 module HelperModule
   def self.included(context)
@@ -44,29 +65,7 @@ RSpec.configure do |config|
   config.include(HelperModule)
   config.formatter = 'documentation'
   config.color = true
-end
-
-if ENV['COVERAGE'] && ENV['CI'].nil? && !RUBY_1_8
-  require 'simplecov'
-  SimpleCov.start { add_filter "/test|test_/" }
-end
-
-if ENV['CI'] && !RUBY_1_8
-  require 'simplecov'
-  require 'simplecov-rcov'
-  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
-  SimpleCov.start { add_filter "/test|test_" }
-end
-
-
-unless ENV["NOTURN"] || RUBY_1_8
-  require 'turn'
-
-  if ENV['QUIET']
-    Turn.config.format = :outline
-    Turn.config.trace = 1
-  end
+  config.add_formatter('RspecJunitFormatter', 'tmp/elasticsearch-api-junit.xml')
 end
 
 class NotFound < StandardError; end
-

data/utils/Gemfile

@@ -1,3 +1,20 @@
+# 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.
+
 source 'https://rubygems.org'
 
 gem 'activesupport'
@@ -7,3 +24,4 @@ gem 'multi_json'
 gem 'thor'
 gem 'json'
 gem 'pry'
+gem 'rubocop'

data/utils/README.md

@@ -0,0 +1,41 @@
+# Utils
+
+## The Generator
+
+This directory hosts The Generator, a tool that generates the classes for each API endpoint from the [Elasticsearch REST API JSON Specification](https://github.com/elastic/elasticsearch/tree/master/rest-api-spec).
+
+### Generate
+
+To generate the code, you need to run (from this folder):
+```bash
+$ thor api:code:generate
+```
+
+- The oss Ruby code will be generated in `elasticsearch-api/lib/elasticsearch/api/actions`.  
+- The xpack Ruby code will be generated in `elasticsearch-xpack/lib/elasticsearch/xpack/api/actions`.
+- The generator runs Rubocop to autolint and clean up the generated files.
+
+Alternatively, you can pass in `oss` or `xpack` as parameters to generate only one of the 2 sets of endpoints:
+
+```bash
+$ thor api:code:generate --api=xpack
+$ thor api:code:generate --api=oss
+```
+
+### Development
+
+The main entry point is `generate_source.rb`, which contains a class that implements a Thor task: `generate`:
+
+```
+$ thor api:code:generate
+```
+
+It uses [Thor::Actions](https://github.com/erikhuda/thor/wiki/Actions)' `template` method and `templates/method.erb` to generate the final code. The `generator` directory contains some helpers used to generate the code. The ERB template is split into partials and you can find all ERB files in the `templates` directory.
+
+There's also a lister task:
+
+```
+$ thor api:list
+```
+
+It's implemented in `lister.rb` and it lists all the REST API endpoints from the JSON specification.

data/utils/Thorfile

@@ -1,3 +1,6 @@
-require File.expand_path('./thor/generate_api')
+# 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
+
 require File.expand_path('./thor/generate_source')
 require File.expand_path('./thor/lister')

data/utils/thor/.rubocop.yml

@@ -0,0 +1,2 @@
+Layout/EndAlignment:
+  AutoCorrect: true