logstash-devutils 2.0.2-java → 2.2.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bea3aed46049f9e213c68ff3f0271bdb6f32253f59368a5dbec6c94988c99693
-  data.tar.gz: af4b9f342648b1dc8c346f450eeb311a64a9985847e069b1978cbe7ea1175c87
+  metadata.gz: 5b3032f571207f629539ec5d700a503822fcdc926f99cf85b3a591ec1917a80d
+  data.tar.gz: 5f8ba35dd80a02f8a329f74b28c18ec3d8100eab6fd50c71ac01061e8ff7df20
 SHA512:
-  metadata.gz: deba0abca9bae4f1650874649e4be4e58e1ed7e1f2e32e98dca578f01aafb3b217a552644786b7d687767c393e23b489eb0ae1e795f3774a4b8de8f28a39c49d
-  data.tar.gz: 3e35bb4b9e1c4c11d83d5d1ce65751339c10374706e19442241fd2b4ae957c6ce0bf3a61f85a29778affc1efb94dfdf52538d6b80c7996eccb0f2d18424e30e7
+  metadata.gz: ae858d1af44e21974fab7c43b8b90b8311e9e765493e67ecbfd4e6f0cbb3e39be8b647a16e083edfce109352115204f5ed92403c5b58edf3d5b6fcda92aa11f2
+  data.tar.gz: 0c70d08d421648b23f7004a2aa2eb7e6c1d3790a580ee0827eed44cad3b3417e4f56b232a496029e79bd9e6ea6684be60545121ad14f7c9b4b55e69d2d2ae52f

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 2.2.1
+ - Fixed `LogStashHelpers#sample` to work with pipelines whose filters add, clone, and cancel events.
+
+## 2.2.0
+ - Add `allowed_lag` config for shared input interruptiblity spec
+
+## 2.1.0
+ - Remove ruby pipeline dependency
+
+## 2.0.4
+ - Fix: avoid double registering filters on `sample` spec helper
+
+## 2.0.3
+ - Fix: add missing `events` method to QueuedBatchDelegator, which was causing test failures
+ after https://github.com/elastic/logstash/pull/11737 was committed.
+
 ## 2.0.2
  - Fix: add plain codec as runtime dependency for TestPipeline helper
 

data/Gemfile

@@ -3,4 +3,5 @@ gemspec
 
 if Dir.exist?(logstash_path = ENV["LOGSTASH_PATH"])
   gem 'logstash-core', path: "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', path: "#{logstash_path}/logstash-core-plugin-api"
 end

data/Rakefile

@@ -1,2 +1,3 @@
 raise "only JRuby is supported" unless defined? JRUBY_VERSION
 require 'bundler/gem_tasks'
+require 'logstash/devutils/rake'

data/lib/logstash/devutils/rspec/logstash_helpers.rb

@@ -1,6 +1,7 @@
 require "logstash/agent"
 require "logstash/event"
 require "logstash/test_pipeline"
+require "logstash/outputs/test_sink"
 
 require "stud/try"
 require "rspec/expectations"
@@ -52,11 +53,30 @@ module LogStashHelper
     deprecated "tags(#{tags.inspect}) - let(:default_tags) are not used"
   end
 
-  def sample(sample_event, &block)
+  ##
+  # Creates a single-example example group in the current rspec context to validate the results of filter operations.
+  # The current group is expected to use `LogStashHelpers#config` to provide a pipeline configuration.
+  #
+  # The provided block has access to an [Array] `results`, and also sets an unnamed `subject` that is either a
+  # single `LogStash::Event` or an `[Array[LogStash::Event]]` containing at least two entries.
+  #
+  # @param sample_event [String, #to_json]
+  # @param validation_source [:output, :queue]
+  # @yield creates an example with expectations provided by the block
+  # @return [void]
+  def sample(sample_event, validation_source: :output, &block)
+    validation_sources = [:output, :queue].freeze
+    fail(ArgumentError, "Unexpected source `#{validation_source.inspect}`, expected one of #{validation_sources.inspect}") unless validation_sources.include?(validation_source)
+
     name = sample_event.is_a?(String) ? sample_event : LogStash::Json.dump(sample_event)
     name = name[0..50] + "..." if name.length > 50
 
-    describe "\"#{name}\"" do
+    describe name.inspect do
+      if validation_source == :output
+        let(:test_sink) { LogStash::Outputs::TestSink.new("release_on_close" => false, "store_events" => true) }
+        before { expect(LogStash::Outputs::TestSink).to receive(:new).and_return(test_sink) }
+      end
+
       let(:pipeline) { new_pipeline_from_string(config) }
       let(:event) do
         sample_event = [sample_event] unless sample_event.is_a?(Array)
@@ -67,14 +87,17 @@ module LogStashHelper
       end
 
       let(:results) do
-        pipeline.filters.each(&:register)
-
+        # Java pipeline (since 6.1) registers filters from start_workers
         pipeline.run_with(event)
 
         # flush makes sure to empty any buffered events in the filter
         pipeline.flush_filters(:final => true) { |flushed_event| results << flushed_event }
 
-        pipeline.filter_queue_client.processed_events
+        case validation_source
+        when :queue  then pipeline.filter_queue_client.processed_events # legacy?
+        when :output then test_sink.event_store.to_a
+        else              fail NotImplementedError("validation source `#{validation_source}` not implemented.")
+        end
       end
 
       # starting at logstash-core 5.3 an initialized pipeline need to be closed
@@ -84,7 +107,7 @@ module LogStashHelper
 
       subject { results.length > 1 ? results : results.first }
 
-      it("when processed", &block)
+      it("processes events as specified", &block)
     end
   end # def sample
 

data/lib/logstash/devutils/rspec/shared_examples.rb

@@ -1,6 +1,10 @@
 require 'rspec/wait'
 
 RSpec.shared_examples "an interruptible input plugin" do
+  # why 3? 2 is not enough, 4 is too much..
+  # a plugin that is known to be slower can override
+  let(:allowed_lag) { 3 }
+
   describe "#stop" do
     let(:queue) { SizedQueue.new(20) }
     subject { described_class.new(config) }
@@ -14,8 +18,7 @@ RSpec.shared_examples "an interruptible input plugin" do
       expect(plugin_thread).to be_alive
       # now let's actually stop the plugin
       subject.do_stop
-      # why 3? 2 is not enough, 4 is too much..
-      wait(3).for { plugin_thread }.to_not be_alive
+      wait(allowed_lag).for { plugin_thread }.to_not be_alive
     end
   end
 end

data/lib/logstash/devutils/rspec/spec_helper.rb

@@ -29,7 +29,7 @@ if RUBY_VERSION < "2.3"
   raise LoadError.new("Ruby >= 2.3.0 or later is required. (You are running: " + RUBY_VERSION + ")")
 end
 
-if level = (ENV["TEST_DEBUG"] || ENV['LOGGER_LEVEL'])
+if level = (ENV['LOG_LEVEL'] || ENV['LOGGER_LEVEL'] || ENV["TEST_DEBUG"])
   logger, level = level.split('=') # 'logstash.filters.grok=DEBUG'
   level, logger = logger, nil if level.nil? # only level given e.g. 'DEBUG'
   level = org.apache.logging.log4j.Level.toLevel(level, org.apache.logging.log4j.Level::WARN)

data/lib/logstash/test_pipeline.rb

@@ -1,4 +1,3 @@
-require "logstash/pipeline"
 require "logstash/java_pipeline"
 
 module LogStash
@@ -151,6 +150,13 @@ module LogStash
         @delegate.to_java.filtered_size
       end
 
+      def events
+        @delegate.events.tap do |events|
+          # filters out rogue (cancelled) events
+          @event_tracker.filtered_events events
+        end
+      end
+
       # @override void merge(IRubyObject event);
       def merge(event)
         @delegate.merge(event)

data/logstash-devutils.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   files = %x{git ls-files}.split("\n")
 
   spec.name = "logstash-devutils"
-  spec.version = "2.0.2"
+  spec.version = "2.2.1"
   spec.license = "Apache-2.0"
   spec.authors = ["Elastic"]
   spec.email = "info@elastic.co"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-devutils
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.1
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.7.10
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: An assortment of tooling/libraries to make Logstash plugin development and