refactor namespace, une PluginMixins for Common and NoopLicenseChecker

Author: colinsurprenant

lib/logstash/outputs/elasticsearch.rb

@@ -86,16 +86,16 @@
 class LogStash::Outputs::ElasticSearch < LogStash::Outputs::Base
   declare_threadsafe!
 
-  require "logstash/outputs/elasticsearch/license_check"
+  require "logstash/outputs/elasticsearch/license_checker"
   require "logstash/outputs/elasticsearch/http_client"
   require "logstash/outputs/elasticsearch/http_client_builder"
   require "logstash/plugin_mixins/elasticsearch/api_configs"
-  require "logstash/outputs/elasticsearch/common"
+  require "logstash/plugin_mixins/elasticsearch/common"
   require "logstash/outputs/elasticsearch/ilm"
   require 'logstash/plugin_mixins/ecs_compatibility_support'
 
   # Protocol agnostic methods
-  include(LogStash::Outputs::ElasticSearch::Common)
+  include(LogStash::PluginMixins::ElasticSearch::Common)
 
   # Methods for ILM support
   include(LogStash::Outputs::ElasticSearch::Ilm)
@@ -265,7 +265,7 @@ def register
     # the license_checking behaviour in the Pool class is externalized in the LogStash::ElasticSearchOutputLicenseChecker
     # class defined in license_check.rb. This license checking is specific to the elasticsearch output here and passed
     # to build_client down to the Pool class.
-    build_client(LogStash::ElasticSearchOutputLicenseChecker.new(@logger))
+    build_client(LicenseChecker.new(@logger))
     setup_after_successful_connection
     check_action_validity
     @bulk_request_metrics = metric.namespace(:bulk_requests)

lib/logstash/outputs/elasticsearch/http_client/pool.rb

@@ -1,4 +1,4 @@
-require "logstash/outputs/elasticsearch/license_check"
+require "logstash/plugin_mixins/elasticsearch/noop_license_checker"
 
 module LogStash; module Outputs; class ElasticSearch; class HttpClient;
   class Pool
@@ -70,7 +70,7 @@ def initialize(logger, adapter, initial_urls=[], options={})
       @url_info = {}
       @stopping = false
 
-      @license_checker = options.fetch(:license_checker) { LogStash::NoopLicenseChecker::INSTANCE }
+      @license_checker = options.fetch(:license_checker) { LogStash::PluginMixins::ElasticSearch::NoopLicenseChecker::INSTANCE }
     end
 
     def start

lib/logstash/outputs/elasticsearch/license_check.rb renamed to lib/logstash/outputs/elasticsearch/license_checker.rb

@@ -1,13 +1,5 @@
-module LogStash
-  class NoopLicenseChecker
-    INSTANCE = self.new
-
-    def appropriate_license?(pool, url)
-      true
-    end
-  end
-
-  class ElasticSearchOutputLicenseChecker
+module LogStash; module Outputs; class ElasticSearch
+  class LicenseChecker
 
     def initialize(logger)
       @logger = logger
@@ -52,4 +44,4 @@ def log_license_deprecation_warn(url)
       @logger.warn("DEPRECATION WARNING: Connecting to an OSS distribution of Elasticsearch using the default distribution of Logstash will stop working in Logstash 8.0.0. Please upgrade to the default distribution of Elasticsearch, or use the OSS distribution of Logstash", :url => url.sanitized.to_s)
     end
   end
-end
+end; end; end

lib/logstash/outputs/elasticsearch/common.rb renamed to lib/logstash/plugin_mixins/elasticsearch/common.rb

@@ -1,6 +1,6 @@
 require "logstash/outputs/elasticsearch/template_manager"
 
-module LogStash; module Outputs; class ElasticSearch;
+module LogStash; module PluginMixins; module ElasticSearch
   module Common
 
     # This module defines common methods that can be reused by alternate elasticsearch output plugins such as the elasticsearch_data_streams output.

lib/logstash/plugin_mixins/elasticsearch/noop_license_checker.rb

@@ -0,0 +1,9 @@
+module LogStash; module PluginMixins; module ElasticSearch
+  class NoopLicenseChecker
+    INSTANCE = self.new
+
+    def appropriate_license?(pool, url)
+      true
+    end
+  end
+end; end; end

spec/unit/outputs/elasticsearch/http_client/pool_spec.rb

@@ -272,7 +272,7 @@
   # TODO: extract to ElasticSearchOutputLicenseChecker unit spec
   describe "license checking with ElasticSearchOutputLicenseChecker" do
     let(:options) do
-      super().merge(:license_checker => LogStash::ElasticSearchOutputLicenseChecker.new(logger))
+      super().merge(:license_checker => LogStash::Outputs::ElasticSearch::LicenseChecker.new(logger))
     end
 
     before(:each) do

spec/unit/outputs/license_check_spec.rb

@@ -1,8 +1,8 @@
 require "logstash/devutils/rspec/spec_helper"
 require "logstash/outputs/elasticsearch/http_client"
-require "logstash/outputs/elasticsearch/license_check"
+require "logstash/outputs/elasticsearch/license_checker"
 
-describe LogStash::ElasticSearchOutputLicenseChecker do
+describe LogStash::Outputs::ElasticSearch::LicenseChecker do
 
   # Note that the actual license checking logic is spec'ed in pool_spec.rb