logstash-devutils 2.0.4-java → 2.3.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d34e698203e399da96e7498c7582dd598768b295943c23ee4030affcf1ca4f6
-  data.tar.gz: 2f92614519c0663e305f5c346cce5a6438eed765b4e429f814fc3317b91031a0
+  metadata.gz: 5ef657a14adf95e2a926763dc1fee0ad934eb0b94671cb91c25fa64401de14ad
+  data.tar.gz: 23c0a0173b7ca9f8e6e2dde1c388a426c28630ea50f56848b660c5f59a8fbfb9
 SHA512:
-  metadata.gz: 7fb5f164892910850f3240d31461de6b357820871f90845c2815f6320ef4599b9be2e9c8bb902aa0229de29b07a5c745599283d675f94d9048ad22eb355063bb
-  data.tar.gz: 71db99f7105959af5e641b75cfb55306dbb2afe677f352a4f85ccb6fabb0e0c074d64137b0fd2d001b2c2165346c63d7242b3f5894d31acc5487052de976fcab
+  metadata.gz: 51f2121d23bdd714670035b0eb92cb134cb4a1ee424408974303b2ea272bc804654df8045a2a77a0529db8da209cedee2f4632c7be3ab645ad7d84044010fd60
+  data.tar.gz: 8b8341622d83cf83a93bbc0d9cfd6674d7d9e39da0bcba4690873dc1047ef33d0587985fae3b4c380b100a5aef2abc3b19a34e9b6f0ac79b933df70a44204696

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 2.3.0
+ - Introduce `be_a_logstash_timestamp_equivalent_to` RSpec matcher to compare LogStash::Timestamp [#99](https://github.com/elastic/logstash-devutils/pull/99)
+
+## 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
 
@@ -16,15 +28,15 @@
  - [BREAKING] changes:
    * `plugin_input` helper no longer works - simply fails with a not implemented error
    * `type` and `tags` helpers have no effect - they will print a deprecation warning
-   * using gem **insist** is discouraged and has to be pulled in manually 
+   * using gem **insist** is discouraged and has to be pulled in manually
      (in *plugin.gemspec* `add_development_dependency 'insist'` and `require "insist"`)
    * shared examples need to be explicitly required, as they are not re-used that much
      (in spec_helper.rb `require "logstash/devutils/rspec/shared_examples"'`)
    * `input` helper now yields a Queue-like collection (with `Queue#pop` blocking semantics)
-     with a default timeout polling mechanism to guard against potential dead-locks 
+     with a default timeout polling mechanism to guard against potential dead-locks
 
 ## 1.3.6
- - Revert the removal (e.g. add back) of the log4j spec helper. It is still needed for 5.x builds. 
+ - Revert the removal (e.g. add back) of the log4j spec helper. It is still needed for 5.x builds.
 
 ## 1.3.5
  - Fix spec helper method `input` generating an invalid `output_func` that returned `nil` instead of an array

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)
@@ -73,7 +93,11 @@ module LogStashHelper
         # 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
@@ -83,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

@@ -38,6 +38,16 @@ else
   LogStash::Logging::Logger::configure_logging('ERROR')
 end
 
+RSpec::Matchers.define :be_a_logstash_timestamp_equivalent_to do |expected|
+  # use the Timestamp compare to avoid suffering of precision loss of time format
+  expected = LogStash::Timestamp.new(expected) unless expected.kind_of?(LogStash::Timestamp)
+  description { "be a LogStash::Timestamp equivalent to #{expected}" }
+
+  match do |actual|
+    actual.kind_of?(LogStash::Timestamp) && actual == expected
+  end
+end
+
 RSpec.configure do |config|
   # for now both include and extend are required because the newly refactored "input" helper method need to be visible in a "it" block
   # and this is only possible by calling include on LogStashHelper
@@ -57,4 +67,3 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = :random
 end
-

data/lib/logstash/test_pipeline.rb

@@ -1,4 +1,3 @@
-require "logstash/pipeline"
 require "logstash/java_pipeline"
 
 module LogStash

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.4"
+  spec.version = "2.3.0"
   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.4
+  version: 2.3.0
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-07 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -191,8 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: An assortment of tooling/libraries to make Logstash plugin development and