[CI] Test Runner: Reimplement clearing X-PACK data, based on PHP's wipe cluster

Author: picandocodigo

api-spec-testing/test_file.rb

@@ -141,33 +141,130 @@ def teardown(client)
       end
 
       class << self
-        # Prepare Elasticsearch for a single test file.
-        # This method deletes indices, roles, datafeeds, etc.
-        #
-        # @since 6.2.0
-        def clear_data(client)
-          clear_indices(client)
-          clear_index_templates(client)
+        PRESERVE_ILM_POLICY_IDS = [
+          'ilm-history-ilm-policy', 'slm-history-ilm-policy',
+          'watch-history-ilm-policy', 'ml-size-based-ilm-policy', 'logs',
+          'metrics'
+        ].freeze
+
+        XPACK_TEMPLATES = [
+          '.watches', 'logstash-index-template', '.logstash-management',
+          'security_audit_log', '.slm-history', '.async-search',
+          'saml-service-provider', 'ilm-history', 'logs', 'logs-settings',
+          'logs-mappings', 'metrics', 'metrics-settings', 'metrics-mappings',
+          'synthetics', 'synthetics-settings', 'synthetics-mappings',
+          '.snapshot-blob-cache', '.deprecation-indexing-mappings', '.deprecation-indexing-settings'
+        ].freeze
+
+        # Wipe Cluster, based on PHP's implementation of ESRestTestCase.java:wipeCluster()
+        # https://github.com/elastic/elasticsearch-php/blob/7.10/tests/Elasticsearch/Tests/Utility.php#L97
+        def wipe_cluster(client)
+          if xpack?
+            clear_rollup_jobs(client)
+            wait_for_pending_tasks(client)
+            clear_sml_policies(client)
+          end
+
           clear_snapshots_and_repositories(client)
-        end
+          clear_datastreams(client) if xpack?
+          clear_indices(client)
+
+          if xpack?
+            clear_templates_xpack(client)
+          else
+            client.indices.delete_template(name: '*')
+            client.indices.delete_index_template(name: '*')
+            client.cluster.delete_component_template(name: '*')
+          end
+
+          clear_cluster_settings(client)
+
+          return unless xpack?
 
-        # Prepare Elasticsearch for a single test file.
-        # This method deletes indices, roles, datafeeds, etc.
-        #
-        # @since 6.2.0
-        def clear_data_xpack(client)
-          clear_roles(client)
-          clear_users(client)
-          clear_privileges(client)
-          clear_datafeeds(client)
-          clear_ml_jobs(client)
-          clear_rollup_jobs(client)
+          clear_ilm_policies(client)
+          clear_auto_follow_patterns(client)
           clear_tasks(client)
-          clear_machine_learning_indices(client)
-          clear_indices_xpack(client)
-          clear_index_templates(client)
-          clear_snapshots_and_repositories(client)
-          clear_transforms(client)
+        end
+
+        def xpack?
+          ENV['TEST_SUITE'] == 'xpack'
+        end
+
+        def wait_for_pending_tasks(client)
+          filter = 'xpack/rollup/job'
+          loop do
+            results = client.cat.tasks(detailed: true).split("\n")
+            count = 0
+
+            time = Time.now.to_i
+            results.each do |task|
+              next if task.empty?
+
+              count += 1 if task.include?(filter)
+            end
+            break unless count.positive? && Time.now.to_i < (time + 30)
+          end
+        end
+
+        def clear_sml_policies(client)
+          policies = client.xpack.snapshot_lifecycle_management.get_lifecycle
+
+          policies.each do |name, _|
+            client.xpack.snapshot_lifecycle_management.delete_lifecycle(policy_id: name)
+          end
+        end
+
+        def clear_ilm_policies(client)
+          policies = client.xpack.ilm.get_lifecycle
+          policies.each do |policy|
+            client.xpack.ilm.delete_lifecycle(policy: policy[0]) unless PRESERVE_ILM_POLICY_IDS.include? policy[0]
+          end
+        end
+
+        def clear_cluster_settings(client)
+          # TODO
+          # settings = client.cluster.get_settings
+          # settings.each do |setting|
+          # end
+        end
+
+        def clear_templates_xpack(client)
+          templates = client.cat.templates(h: 'name').split("\n")
+
+          templates.each do |template|
+            next if xpack_template? template
+
+            begin
+              client.indices.delete_template(name: template)
+            rescue Elasticsearch::Transport::Transport::Errors::NotFound => e
+              if e.message.include?("index_template [#{template}] missing")
+                client.indices.delete_index_template(name: template)
+              end
+            end
+          end
+          # Delete component template
+          result = client.cluster.get_component_template
+
+          result['component_templates'].each do |template|
+            next if xpack_template? template['name']
+
+            client.cluster.delete_component_template(name: template['name'])
+          end
+        end
+
+        def xpack_template?(template)
+          xpack_prefixes = ['.monitoring', '.watch', '.triggered-watches', '.data-frame', '.ml-', '.transform'].freeze
+          xpack_prefixes.map { |a| return true if a.include? template }
+
+          XPACK_TEMPLATES.include? template
+        end
+
+        def clear_auto_follow_patterns(client)
+          patterns = client.cross_cluster_replication.get_auto_follow_pattern
+
+          patterns['patterns'].each do |pattern|
+            client.cross_cluster_replication.delete_auto_follow_pattern(name: pattern)
+          end
         end
 
         private
@@ -202,6 +299,10 @@ def clear_datafeeds(client)
           end
         end
 
+        def clear_datastreams(client)
+          client.xpack.indices.delete_data_stream(name: '*', expand_wildcards: 'all')
+        end
+
         def clear_ml_jobs(client)
           client.xpack.ml.close_job(job_id: '_all', force: true)
           client.xpack.ml.get_jobs['jobs'].each do |d|
@@ -253,7 +354,7 @@ def clear_transforms(client)
         end
 
         def clear_indices(client)
-          client.indices.delete(index: '*', expand_wildcards: 'all')
+          client.indices.delete(index: '*', expand_wildcards: 'all', ignore: 404)
         end
 
         def clear_indices_xpack(client)

elasticsearch-api/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -18,7 +18,6 @@
 
     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'
@@ -29,13 +28,13 @@
 
             # Runs once before each test in a test file
             before(:all) do
-              Elasticsearch::RestAPIYAMLTests::TestFile.clear_data(ADMIN_CLIENT)
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
               test_file.setup(ADMIN_CLIENT)
             end
 
             after(:all) do
               test_file.teardown(ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.clear_data(ADMIN_CLIENT)
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
             end
 
             test.task_groups.each do |task_group|

elasticsearch-xpack/spec/xpack/rest_api_yaml_spec.rb

@@ -31,7 +31,7 @@
     context "#{file.gsub("#{YAML_FILES_DIRECTORY}/", '')}" do
       before(:all) do
         # Runs once before all tests in a test file
-        Elasticsearch::RestAPIYAMLTests::TestFile.clear_data_xpack(ADMIN_CLIENT)
+        Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
       end
 
       test_file.tests.each do |test|
@@ -51,18 +51,10 @@
                 ADMIN_CLIENT.xpack.watcher.delete_watch(id: "my_watch")
               rescue Elasticsearch::Transport::Transport::Errors::NotFound
               end
-
               # todo: remove these two lines when Dimitris' PR is merged
               ADMIN_CLIENT.cluster.put_settings(body: { transient: { "xpack.ml.max_model_memory_limit" => nil } })
               ADMIN_CLIENT.cluster.put_settings(body: { persistent: { "xpack.ml.max_model_memory_limit" => nil } })
-              Elasticsearch::RestAPIYAMLTests::TestFile.send(:clear_datafeeds, ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.send(:clear_ml_jobs, ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.send(:clear_tasks, ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.send(:clear_rollup_jobs, ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.send(:clear_machine_learning_indices, ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.send(:clear_indices, ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.send(:clear_transforms, ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.send(:clear_index_templates, ADMIN_CLIENT)
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
               test_file.setup(ADMIN_CLIENT)
             end