elasticsearch-api 7.17.1 → 8.1.0

data/spec/unit_tests_platinum/unit/watcher/activate_watch_test.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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherActivateWatchTest < Minitest::Test
+
+      context "XPack Watcher: Activate watch" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'PUT', method
+            assert_equal '_watcher/watch/foo/_activate', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.activate_watch watch_id: 'foo'
+        end
+
+      end
+
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/watcher/deactivate_watch_test.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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherDeactivateWatchTest < Minitest::Test
+
+      context "XPack Watcher: Deactivate watch" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'PUT', method
+            assert_equal '_watcher/watch/foo/_deactivate', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.deactivate_watch watch_id: 'foo'
+        end
+
+      end
+
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/watcher/delete_watch_test.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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherDeleteWatchTest < Minitest::Test
+
+      context "XPack Watcher: Delete watch" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'DELETE', method
+            assert_equal '_watcher/watch/foo', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.delete_watch id: 'foo'
+        end
+
+      end
+
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/watcher/execute_watch_test.rb

@@ -0,0 +1,55 @@
+# 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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherExecuteWatchTest < Minitest::Test
+
+      context "XPack Watcher: Execute watch" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'PUT', method
+            assert_equal '_watcher/watch/foo/_execute', url
+            assert_equal Hash.new, params
+            assert_nil body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.execute_watch id: 'foo'
+        end
+
+        should "perform correct request with no id specified" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'PUT', method
+            assert_equal '_watcher/watch/_execute', url
+            assert_equal Hash.new, params
+            assert_nil body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.execute_watch
+        end
+
+      end
+
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/watcher/get_watch_test.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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherGetWatchTest < Minitest::Test
+
+      context "XPack Watcher: Get watch" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'GET', method
+            assert_equal '_watcher/watch/foo', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.get_watch id: 'foo'
+        end
+
+      end
+
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/watcher/put_watch_test.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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherPutWatchTest < Minitest::Test
+
+      context "XPack Watcher: Put watch" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'PUT', method
+            assert_equal '_watcher/watch/foo', url
+            assert_equal Hash.new, params
+            assert_equal Hash.new, body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.put_watch id: 'foo', body: {}
+        end
+
+      end
+
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/watcher/query_watches_test.rb

@@ -0,0 +1,52 @@
+# 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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherQueryWatchesTest < Minitest::Test
+      context "XPack Watcher: Query watches" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('GET', method)
+            assert_equal('_watcher/_query/watches', url)
+            assert_equal(params, {})
+            assert_nil(body)
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.query_watches
+        end
+
+        should "perform correct request when sending body" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal('POST', method)
+            assert_equal('_watcher/_query/watches', url)
+            assert_equal(params, {})
+            assert_equal(body, {})
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.query_watches(body: {})
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/watcher/start_test.rb

@@ -0,0 +1,41 @@
+# 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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherStartTest < Minitest::Test
+
+      context "XPack Watcher: Start" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'POST', method
+            assert_equal '_watcher/_start', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.start
+        end
+      end
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/watcher/stats_test.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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherStatsTest < Minitest::Test
+
+      context "XPack Watcher: Stats" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'GET', method
+            assert_equal '_watcher/stats', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.stats
+        end
+
+      end
+
+    end
+  end
+end

data/spec/unit_tests_platinum/unit/watcher/stop_test.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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackWatcherStopTest < Minitest::Test
+
+      context "XPack Watcher: Stop" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'POST', method
+            assert_equal '_watcher/_stop', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.watcher.stop
+        end
+
+      end
+
+    end
+  end
+end

data/utils/README.md

@@ -13,18 +13,15 @@ $ rake elasticsearch:download_artifacts
 
 Once the JSON files have been downloaded, you need to run (from this folder):
 ```bash
-$ thor api:code:generate
+$ thor 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 Ruby code will be generated in `elasticsearch-api/lib/elasticsearch/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:
+- You can use the environment variable `IGNORE_VERSION` to ignore the current version of the client when generating the source code documentation urls. This is currently used when generating code from `main`:
 
 ```bash
-$ thor api:code:generate --api=xpack
-$ thor api:code:generate --api=oss
+$ IGNORE_VERSION=true thor code:generate
 ```
 
 ### Development

data/utils/thor/.rubocop.yml

@@ -1,4 +1,2 @@
 Layout/EndAlignment:
   AutoCorrect: true
-Metrics/LineLength:
-  Max: 160

data/utils/thor/generate_source.rb

@@ -40,7 +40,7 @@ module Elasticsearch
     # here.
     #
     class SourceGenerator < Thor
-      namespace 'api:code'
+      namespace 'code'
       include Thor::Actions
       include EndpointSpecifics
 
@@ -49,26 +49,20 @@ module Elasticsearch
       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 :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[:api].include? 'xpack'
-        @oss   = options[:api].include? 'oss'
-
-        __generate_source(:xpack) if @xpack
-        __generate_source(:oss) if @oss
+        generate_source
         # -- Tree output
         print_tree if options[:verbose]
       end
 
       private
 
-      def __generate_source(api)
-        @current_api = api
-        @output = FilesHelper.output_dir(api)
+      def generate_source
+        @output = FilesHelper.output_dir
 
-        FilesHelper.files(api).each do |filepath|
+        FilesHelper.files.each do |filepath|
           @path = Pathname(filepath)
           @json = MultiJson.load(File.read(@path))
           @spec = @json.values.first
@@ -80,6 +74,10 @@ module Elasticsearch
           @full_namespace   = __full_namespace
           @namespace_depth  = @full_namespace.size > 0 ? @full_namespace.size - 1 : 0
           @module_namespace = @full_namespace[0, @namespace_depth]
+
+          # Don't generate code for internal APIs:
+          next if @module_namespace.flatten.first == '_internal'
+
           @method_name      = @full_namespace.last
           @parts            = __endpoint_parts
           @params           = @spec['params'] || {}
@@ -91,7 +89,6 @@ module Elasticsearch
           @http_path        = __http_path
           @required_parts   = __required_parts
 
-          @module_namespace.shift if @module_namespace.first == 'xpack'
           @path_to_file = @output.join(@module_namespace.join('/')).join("#{@method_name}.rb")
           dir = @output.join(@module_namespace.join('/'))
           empty_directory(dir, verbose: false)
@@ -106,23 +103,18 @@ module Elasticsearch
           puts
         end
 
-        run_rubocop(api)
+        run_rubocop
       end
 
       def __full_namespace
         names = @endpoint_name.split('.')
-        if @current_api == :xpack
-          names = (names.first == 'xpack' ? names : ['xpack', names].flatten)
-          # Return an array to expand 'ccr', 'ilm', 'ml' and 'slm'
-          names.map do |name|
-            name
-              .gsub(/^ml$/, 'machine_learning')
-              .gsub(/^ilm$/, 'index_lifecycle_management')
-              .gsub(/^ccr/, 'cross_cluster_replication')
-              .gsub(/^slm/, 'snapshot_lifecycle_management')
-          end
-        else
-          names
+        # Return an array to expand 'ccr', 'ilm', 'ml' and 'slm'
+        names.map do |name|
+          name
+            .gsub(/^ml$/, 'machine_learning')
+            .gsub(/^ilm$/, 'index_lifecycle_management')
+            .gsub(/^ccr/, 'cross_cluster_replication')
+            .gsub(/^slm/, 'snapshot_lifecycle_management')
         end
       end
 
@@ -164,8 +156,9 @@ module Elasticsearch
       end
 
       def post_and_get
+        # the METHOD is defined after doing arguments.delete(:body), so we need to check for `body`
         <<~SRC
-          if arguments[:body]
+          if body
             Elasticsearch::API::HTTP_POST
           else
             Elasticsearch::API::HTTP_GET
@@ -175,7 +168,6 @@ module Elasticsearch
 
       def __http_path
         return "\"#{__parse_path(@paths.first)}\"" if @paths.size == 1
-        return termvectors_path if @method_name == 'termvectors'
 
         result = ''
         anchor_string = []
@@ -200,7 +192,7 @@ module Elasticsearch
       def __parse_path(path)
         path.gsub(/^\//, '')
           .gsub(/\/$/, '')
-          .gsub('{', "\#{#{__utils}.__listify(_")
+          .gsub('{', "\#{Utils.__listify(_")
           .gsub('}', ')}')
       end
 
@@ -295,12 +287,8 @@ module Elasticsearch
         say_status('tree', lines.first + "\n" + lines[1, lines.size].map { |l| ' ' * 14 + l }.join("\n"))
       end
 
-      def __utils
-        @current_api == :xpack ? 'Elasticsearch::API::Utils' : 'Utils'
-      end
-
-      def run_rubocop(api)
-        system("rubocop -c ./thor/.rubocop.yml --format autogenconf -x #{FilesHelper::output_dir(api)}")
+      def run_rubocop
+        system("rubocop -c ./thor/.rubocop.yml --format autogenconf -x #{FilesHelper::output_dir}")
       end
     end
   end

data/utils/thor/generator/endpoint_specifics.rb

@@ -27,7 +27,6 @@ module Elasticsearch
         exists
         indices.exists
         indices.exists_alias
-        indices.exists_index_template
         indices.exists_template
         indices.exists_type
       ].freeze
@@ -38,9 +37,8 @@ module Elasticsearch
         delete
         get
         indices.flush_synced
-        indices.delete
-        indices.delete_index_template
         indices.delete_template
+        indices.delete
         security.get_role
         security.get_user
         snapshot.status
@@ -80,21 +78,7 @@ module Elasticsearch
       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
-            "\#{Utils.__listify(_index)}/\#{Utils.__listify(_type)}/\#{Utils.__listify(_id)}/\#{endpoint}"
-          elsif _index && _type
-            "\#{Utils.__listify(_index)}/\#{Utils.__listify(_type)}/\#{endpoint}"
-          elsif _index && _id
-            "\#{Utils.__listify(_index)}/\#{endpoint}/\#{Utils.__listify(_id)}"
-          else
-            "\#{Utils.__listify(_index)}/\#{endpoint}"
-          end
-        SRC
+        name.split('_').map(&:capitalize).map{ |n| n == 'Xpack' ? 'XPack' : n }.join
       end
 
       def ping_perform_request
@@ -111,18 +95,6 @@ module Elasticsearch
         SRC
       end
 
-      def indices_stats_params_registry
-        <<~SRC
-          ParamsRegistry.register(:stats_params, [
-            #{@spec['params'].keys.map { |k| ":#{k}" }.join(",\n")}
-          ].freeze)
-
-          ParamsRegistry.register(:stats_parts, [
-            #{@parts['metric']['options'].push('metric').map { |k| ":#{k}" }.join(",\n")}
-          ].freeze)
-        SRC
-      end
-
       def msearch_body_helper
         <<~SRC
           case