elasticsearch-api 7.5.0 → 7.8.0.pre

data/test/test_helper.rb

@@ -1,6 +1,19 @@
-# 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.
 
 ELASTICSEARCH_HOSTS = if hosts = ENV['TEST_ES_SERVER'] || ENV['ELASTICSEARCH_HOSTS']
                         hosts.split(',').map do |host|

data/utils/Gemfile

@@ -1,6 +1,19 @@
-# 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.
 
 source 'https://rubygems.org'
 

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/thor/generate_source.rb

@@ -1,6 +1,19 @@
-# 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.
 
 # encoding: UTF-8
 
@@ -34,18 +47,28 @@ module Elasticsearch
       __root = Pathname(File.expand_path('../../..', __FILE__))
 
       desc 'generate', 'Generate source code and tests from the REST API JSON specification'
-      method_option :verbose, type: :boolean, default: false, desc: 'Output more information'
-      method_option :tests,   type: :boolean, default: false, desc: 'Generate test files'
-      method_option :xpack,   type: :boolean, default: false, desc: 'Generate X-Pack'
-
+      method_option :verbose, type: :boolean, default: false,  desc: 'Output more information'
+      method_option :tests,   type: :boolean, default: false,  desc: 'Generate test files'
+      method_option :api,     type: :array,   default: %w[oss xpack], desc: 'APIs to generate (oss, x-pack)'
       def generate
         self.class.source_root File.expand_path(__dir__)
-        @xpack = options[:xpack]
+        @xpack = options[:api].include? 'xpack'
+        @oss   = options[:api].include? 'oss'
+
+        __generate_source(:xpack) if @xpack
+        __generate_source(:oss) if @oss
+        # -- Tree output
+        print_tree if options[:verbose]
+      end
+
+      private
 
-        @input = FilesHelper.input_dir(@xpack)
-        @output = FilesHelper.output_dir(@xpack)
+      def __generate_source(api)
+        @current_api = api
+        @input = FilesHelper.input_dir(api)
+        @output = FilesHelper.output_dir(api)
 
-        FilesHelper.files(@xpack).each do |filepath|
+        FilesHelper.files(api).each do |filepath|
           @path = Pathname(@input.join(filepath))
           @json = MultiJson.load(File.read(@path))
           @spec = @json.values.first
@@ -83,17 +106,12 @@ module Elasticsearch
           puts
         end
 
-        run_rubocop
-
-        # -- Tree output
-        print_tree if options[:verbose]
+        run_rubocop(api)
       end
 
-      private
-
       def __full_namespace
         names = @endpoint_name.split('.')
-        if @xpack
+        if @current_api == :xpack
           names = (names.first == 'xpack' ? names : ['xpack', names].flatten)
           # Return an array with 'ml' renamed to 'machine_learning' and 'ilm' to
           # 'index_lifecycle_management'
@@ -149,12 +167,12 @@ module Elasticsearch
         return termvectors_path if @method_name == 'termvectors'
 
         result = ''
-        anchor_string = ''
+        anchor_string = []
         @paths.sort { |a, b| b.length <=> a.length }.each_with_index do |path, i|
           var_string = __extract_path_variables(path).map { |var| "_#{var}" }.join(' && ')
-          next if anchor_string == var_string
+          next if anchor_string.include? var_string
 
-          anchor_string = var_string
+          anchor_string << var_string
           result += if i.zero?
                       "if #{var_string}\n"
                     elsif (i == @paths.size - 1) || var_string.empty?
@@ -238,11 +256,11 @@ module Elasticsearch
       end
 
       def __utils
-        @xpack ? 'Elasticsearch::API::Utils' : 'Utils'
+        (@current_api == :xpack) ? 'Elasticsearch::API::Utils' : 'Utils'
       end
 
-      def run_rubocop
-        system("rubocop --format autogenconf -x #{FilesHelper::output_dir(@xpack)}")
+      def run_rubocop(api)
+        system("rubocop --format autogenconf -x #{FilesHelper::output_dir(api)}")
       end
     end
   end

data/utils/thor/generator/endpoint_specifics.rb

@@ -1,8 +1,19 @@
-# frozen_string_literal: true
-
-# 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.
 
 module Elasticsearch
   module API
@@ -64,6 +75,12 @@ module Elasticsearch
         COMPLEX_IGNORE_404.include? endpoint
       end
 
+      def module_name_helper(name)
+        return name.upcase if %w[sql ssl].include? name
+
+        name.split("_").map(&:capitalize).join
+      end
+
       def termvectors_path
         <<~SRC
           if _index && _type && _id
@@ -81,7 +98,7 @@ module Elasticsearch
       def ping_perform_request
         <<~SRC
           begin
-            perform_request(method, path, params, body).status == 200 ? true : false
+            perform_request(method, path, params, body, headers).status == 200 ? true : false
           rescue Exception => e
             if e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not\s*Found|404|ConnectionFailed/i
               false
@@ -146,7 +163,7 @@ module Elasticsearch
       def bulk_body_helper
         <<~SRC
           if body.is_a? Array
-            payload = Utils.__bulkify(body)
+            payload = Elasticsearch::API::Utils.__bulkify(body)
           else
             payload = body
           end

data/utils/thor/generator/files_helper.rb

@@ -1,4 +1,22 @@
+# 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 'pathname'
+require_relative '../../../lib/elasticsearch/api/version.rb'
 
 module Elasticsearch
   module API
@@ -10,8 +28,8 @@ module Elasticsearch
       XPACK_OUTPUT_DIR = '../../elasticsearch-xpack/lib/elasticsearch/xpack/api/actions'.freeze
 
       # Path to directory with JSON API specs
-      def self.input_dir(xpack = false)
-        input_dir = if xpack
+      def self.input_dir(api)
+        input_dir = if api == :xpack
                       File.expand_path(XPACK_SRC_PATH, __FILE__)
                     else
                       File.expand_path(OSS_SRC_PATH, __FILE__)
@@ -20,18 +38,23 @@ module Elasticsearch
       end
 
       # Path to directory to copy generated files
-      def self.output_dir(xpack = false)
-        xpack ? Pathname(XPACK_OUTPUT_DIR) : Pathname(OSS_OUTPUT_DIR)
+      def self.output_dir(api)
+        api == :xpack ? Pathname(XPACK_OUTPUT_DIR) : Pathname(OSS_OUTPUT_DIR)
       end
 
       # Only get JSON files and remove hidden files
-      def self.files(xpack = false)
-        Dir.entries(input_dir(xpack).to_s).reject do |f|
+      def self.files(api)
+        Dir.entries(input_dir(api).to_s).reject do |f|
           f.start_with?('.') ||
             f.start_with?('_') ||
             File.extname(f) != '.json'
         end
       end
+
+      def self.gem_version
+        regex = /([0-9]{1,2}\.[0-9x]{1,2})/
+        Elasticsearch::API::VERSION.match(regex)[0]
+      end
     end
   end
 end

data/utils/thor/lister.rb

@@ -1,6 +1,19 @@
-# 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.
 
 # encoding: UTF-8
 

data/utils/thor/templates/_documentation_top.erb

@@ -12,7 +12,8 @@
 <%# URL parameters -%>
 <%- @params.each do |name, info| -%>
   <%= docs_helper(name, info) -%>
-<%- end %>
+<%- end -%>
+# @option arguments [Hash] :headers Custom HTTP headers
 <%= '  '*(@namespace_depth+3) + '# @option arguments [Hash] :body ' + (@spec['body']['description'] ? @spec['body']['description'].strip : 'TODO: Description') + (@spec['body']['required'] ? ' (*Required*)' : '') + "\n" if @spec['body'] -%>
 <% if @deprecation_note -%>
   #
@@ -23,5 +24,5 @@
 <% end -%>
 <%= '  '*(@namespace_depth+3) -%>#
 <%# Documentation link -%>
-<%=  '  '*(@namespace_depth+3) %># @see <%= @spec['documentation']['url'] ? @spec['documentation']['url'].gsub!(/\/(current|master)\//, '/7.5/') : "[TODO]" %>
+<%=  '  '*(@namespace_depth+3) %># @see <%= @spec['documentation']['url'] ? @spec['documentation']['url'].gsub(/\/(current|master)\//, "/#{Elasticsearch::API::FilesHelper.gem_version}/") : "[TODO]" %>
 <%= '  '*(@namespace_depth+3) %>#

data/utils/thor/templates/_perform_request.erb

@@ -16,22 +16,23 @@ when 'mtermvectors'
 <%- end -%>
 <%- if ['bulk', 'msearch', 'msearch_template'].include? @method_name -%>
   <%= self.send("#{@method_name}_body_helper".to_s) %>
-  <%= '  '*(@namespace_depth+4) %>perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
+  headers.merge!("Content-Type" => "application/x-ndjson")
+  <%= '  '*(@namespace_depth+4) %>perform_request(method, path, params, payload, headers).body
 <%- elsif @method_name == 'ping' -%>
   <%= ping_perform_request %>
 <%- else -%>
   <%- if needs_ignore_404?(@endpoint_name) %>
     <%= __utils %>.__rescue_from_not_found do
-      perform_request(method, path, params, body).status == 200 ? true : false
+      perform_request(method, path, params, body, headers).status == 200 ? true : false
     end
   <%- elsif needs_complex_ignore_404?(@endpoint_name) -%>
     if Array(arguments[:ignore]).include?(404)
-      <%= __utils %>.__rescue_from_not_found { perform_request(method, path, params, body).body }
+      <%= __utils %>.__rescue_from_not_found { perform_request(method, path, params, body, headers).body }
     else
-      perform_request(method, path, params, body).body
+      perform_request(method, path, params, body, headers).body
     end
   <%- else -%>
-      perform_request(method, path, params, body).body
+      perform_request(method, path, params, body, headers).body
   <%- end -%>
 <%- end -%>
 <%= '  '*(@namespace_depth+3) %>end

data/utils/thor/templates/method.erb

@@ -1,19 +1,32 @@
-# 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.
 
 module Elasticsearch
-<%- if @xpack -%>
+<%- if @current_api == :xpack -%>
   <%= '  '*(@namespace_depth) %>module XPack
 <%- end %>
 <%= '  '*(@namespace_depth) %>module API
 <%- @module_namespace.each_with_index do |name, i| -%>
-  <%= '  '*i %>module <%= name.split("_").map(&:capitalize).join %>
+  <%= '  '*i %>module <%= module_name_helper(name) %>
 <%- end -%>
 <%= '  '*(@namespace_depth+2) %>module Actions
 <%= ERB.new(File.new("./thor/templates/_documentation_top.erb").read, trim_mode: '-').result(binding) -%>
 <%# Method definition -%>
-<%= '  '*(@namespace_depth+3) -%>def <%= @method_name %>(arguments={})
+<%= '  '*(@namespace_depth+3) -%>def <%= @method_name %>(arguments = {})
 <%- if @endpoint_name == 'create' -%>
   <%= '  '*(@namespace_depth+3) %>if arguments[:id]
   <%= '  '*(@namespace_depth+3) %>  index arguments.update op_type: 'create'
@@ -30,6 +43,7 @@ module Elasticsearch
       <%= '  '*(@namespace_depth+3) + "raise ArgumentError, \"Required argument '#{required}' missing\" unless arguments[:#{required}]" + "\n" -%>
     <%- end -%>
     <%- end -%>
+    headers = arguments.delete(:headers) || {}
     <%- # Method setup -%>
     <%= ERB.new(File.new("./thor/templates/_method_setup.erb").read, trim_mode: '-').result(binding) %>
     <%- # Perform request -%>

data/utils/thor/templates/test_helper.rb

@@ -1,6 +1,19 @@
-# 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.
 
 RUBY_1_8 = defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'