[API] Test Runner: Refactors logging

Author: picandocodigo

elasticsearch-api/api-spec-testing/logging.rb

@@ -0,0 +1,28 @@
+# 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 'logger'
+
+module Elasticsearch
+  module RestAPIYAMLTests
+    module Logging
+      def self.logger
+        @logger ||= Logger.new($stdout)
+      end
+    end
+  end
+end

elasticsearch-api/api-spec-testing/test_file.rb

@@ -18,7 +18,7 @@
 require_relative 'test_file/action'
 require_relative 'test_file/test'
 require_relative 'test_file/task_group'
-require 'logger'
+require_relative 'logging'
 
 module Elasticsearch
   module RestAPIYAMLTests
@@ -33,8 +33,6 @@ class SkipTestsException < StandardError
     class TestFile
       attr_reader :features_to_skip, :name, :client
 
-      LOGGER = Logger.new($stdout)
-
       # Initialize a single test file.
       #
       # @example Create a test file object.
@@ -51,8 +49,8 @@ def initialize(file_name, client, features_to_skip = [])
         begin
           documents = YAML.load_stream(File.new(file_name))
         rescue StandardError => e
-          LOGGER.error e
-          LOGGER.error "Filename : #{@name}"
+          Elasticsearch::RestAPIYAMLTests::Logging.logger.error e
+          Elasticsearch::RestAPIYAMLTests::Logging.logger.error "Filename : #{@name}"
         end
         @test_definitions = documents.reject { |doc| doc['setup'] || doc['teardown'] }
         @setup = documents.find { |doc| doc['setup'] }

elasticsearch-api/api-spec-testing/wipe_cluster.rb

@@ -15,6 +15,8 @@
 # specific language governing permissions and limitations
 # under the License.
 
+require_relative 'logging'
+
 module Elasticsearch
   module RestAPIYAMLTests
     module WipeCluster
@@ -87,7 +89,7 @@ def wait_for_pending_tasks(client)
             results.each do |task|
               next if task.empty?
 
-              LOGGER.debug "Pending task: #{task}"
+              Elasticsearch::RestAPIYAMLTests::Logging.logger.debug "Pending task: #{task}"
               count += 1 if task.include?(filter)
             end
             break unless count.positive? && Time.now.to_i < (time + 30)
@@ -103,7 +105,7 @@ def wait_for_cluster_tasks(client)
             results['tasks'].each do |task|
               next if task.empty?
 
-              LOGGER.debug "Pending cluster task: #{task}"
+              Elasticsearch::RestAPIYAMLTests::Logging.logger.debug "Pending cluster task: #{task}"
               count += 1
             end
             break unless count.positive? && Time.now.to_i < (time + 30)
@@ -287,7 +289,7 @@ def wipe_datastreams(client)
           begin
             client.indices.delete_data_stream(name: '*', expand_wildcards: 'all')
           rescue StandardError => e
-            LOGGER.error "Caught exception attempting to delete data streams: #{e}"
+            Elasticsearch::RestAPIYAMLTests::Logging.logger.error "Caught exception attempting to delete data streams: #{e}"
             client.indices.delete_data_stream(name: '*')
           end
         end
@@ -302,7 +304,7 @@ def clear_ml_filters(client)
         def clear_indices(client)
           client.indices.delete(index: '*,-.ds-ilm-history-*', expand_wildcards: 'open,closed,hidden', ignore: 404)
         rescue Elasticsearch::Transport::Transport::Errors::BadRequest => e
-          LOGGER.info "Exception trying to delete index #{e}"
+          Elasticsearch::RestAPIYAMLTests::Logging.logger.info "Exception trying to delete index #{e}"
         end
 
         def wipe_searchable_snapshot_indices(client)