logstash-devutils 2.2.0-java → 2.4.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbd9bcbe08648ad69e9cbf9781acbebfa5168e0c9c8be8a253620b1ec20bb6f4
-  data.tar.gz: a91b1a94368455897c54bc705f4a647c89919e7964ed568cf909d9c477b2e35b
+  metadata.gz: f6acb50f9d6e040af22acda0163ef38f8bce77506f023dd8a58a4ee925d9df3c
+  data.tar.gz: 51c47c93c93335ed8cba0e0349dc712808051e77ca69ca8f79617eaa9442731a
 SHA512:
-  metadata.gz: e5d3faadbce4f82285d54231a742cc3ebae7f8da46cc575ddd55a3f9ac51488ff5b79af8b52956c7de9672c61080c80a6a5206dfe618f7f76f2b9844cb476ac4
-  data.tar.gz: 4c7b243ebed7a5747b35315f2c88059aa32f498af5d34f6096ad5df9a6b6f1122b0c5e87649b3e7b97351bd757dffd811302335deaa200a60471d06829368696
+  metadata.gz: 8fa7d3f493f223e497c7877bfc9c6a9440a269367a02d7c6f468580f0ac6d4e6156600ba30fc2fcc831a27cef74a6e65cbfa7daebd29623042557b524a3423ff
+  data.tar.gz: a6530c6d9bd097ea6f081224a7ff6254e38f3d6abc400f3b4bbaca5cea7b354e4e37b60071755eef6d05bac2afce89601b53b72b4339ba15b97696dceb541cb1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2.4.0
+ - Feat: shared test (spec) task for all! [#96](https://github.com/elastic/logstash-devutils/pull/96)
+
+## 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
 
@@ -22,15 +31,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/lib/logstash/devutils/rake/publish.rake

@@ -10,7 +10,7 @@ if RUBY_PLATFORM == "java"
         cmd = Shellwords.join(arguments)
         Open3.popen3(cmd) do |_i, stdout, stderr, thr|
           output = [stderr.read, stdout.read].join.strip
-          raise Error, "`#{cmd}` -> #{output}" if thr.value.exitstatus > 0
+          raise Error, output if thr.value.exitstatus > 0
           return output
         end
       end

data/lib/logstash/devutils/rake/test.rake

@@ -0,0 +1,17 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) # default glob: 'spec/**{,/*/**}/*_spec.rb'
+rescue LoadError
+end
+
+desc "Run tests including Java tests (if any)"
+task :test => [ 'test:java', 'test:ruby' ]
+namespace :test do
+  task :java do
+    gradlew = File.join(Dir.pwd, 'gradlew')
+    sh "#{gradlew} --no-daemon test" if File.exist?(gradlew)
+  end
+  task :ruby => :vendor do
+    Rake::Task[:spec].invoke
+  end
+end

data/lib/logstash/devutils/rake.rb

@@ -1,3 +1,4 @@
 raise "Only JRuby is supported at this time." unless RUBY_PLATFORM == "java"
 load "logstash/devutils/rake/publish.rake"
 load "logstash/devutils/rake/vendor.rake"
+load "logstash/devutils/rake/test.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/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/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.2.0"
+  spec.version = "2.4.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.2.0
+  version: 2.4.0
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +163,7 @@ files:
 - Rakefile
 - lib/logstash/devutils/rake.rb
 - lib/logstash/devutils/rake/publish.rake
+- lib/logstash/devutils/rake/test.rake
 - lib/logstash/devutils/rake/vendor.rake
 - lib/logstash/devutils/rspec/log4j2.properties
 - lib/logstash/devutils/rspec/logstash_helpers.rb
@@ -191,8 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.10
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: An assortment of tooling/libraries to make Logstash plugin development and