logstash-codec-rfc6587 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35642c5e5db8b142c4afb325b96fb4cd24cf9b5f711c61476d601c382dcf4e57
-  data.tar.gz: 294de35a68a24b131e6fec7035d784161698c8ba82fee4fb676de7f763031aa7
+  metadata.gz: d4b77071d659535df03e355c6608120d7d198b08eaccd52da29e5bc320933fb3
+  data.tar.gz: 7d00398f882083289ea13f6c75bdbd728d2b3a11ad6499e3c6b230c26082ca7a
 SHA512:
-  metadata.gz: 48e8171e101c400fb9c42050a1b8303d0c920f567872e02bf76f003fdad211137fd42e8688b755148744dd2fef834a0e47b3169336a3e4273978c7509e168677
-  data.tar.gz: 51c30b54a8546cb2297c6d3ce8baccd297a16fa975c950ff6464cd801a8a6467485c5c6e6687410ccb3f9aa59c5c65c507bce8f55bedfb7bd73c2d1cf09868c6
+  metadata.gz: 73a1b782ef74480634c426b4b900a418672f7afe10a4b252588d9a0d3d79496f7b5396cf32f5411f653b3416ab13db9b8138e89304967f0f3b1664136c054166
+  data.tar.gz: c4a2988537b9aebc49f961dbb186389310acc507da1d69057bbe8b27bac3c9bd15fd3c14bc2c50117345466d0be82c723c3493b94224476c13470fddc0f3591a

data/lib/logstash/codecs/rfc6587.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require "logstash/codecs/base"
 require "logstash/util/charset"
 
@@ -11,14 +12,13 @@ require 'logstash/plugin_mixins/event_support/event_factory_adapter'
 #
 # Encoding behavior: TBD
 class LogStash::Codecs::Rfc6587 < LogStash::Codecs::Base
-
   include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled, :v1, :v8 => :v1)
   include LogStash::PluginMixins::EventSupport::EventFactoryAdapter
 
   config_name "rfc6587"
 
   ## Set the desired text format for encoding.
-  #config :format, :validate => :string
+  # config :format, :validate => :string
 
   # The character encoding used in this input. Examples include `UTF-8`
   # and `cp1252`
@@ -35,6 +35,8 @@ class LogStash::Codecs::Rfc6587 < LogStash::Codecs::Base
   def initialize(*params)
     super
 
+    raise "Delimitter must be 1 character long, but got '#{@delimiter}'" if @delimiter.length != 1
+
     @original_field = ecs_select[disabled: nil, v1: '[event][original]']
   end
 
@@ -48,13 +50,15 @@ class LogStash::Codecs::Rfc6587 < LogStash::Codecs::Base
 
   def read(data)
     header = ""
-    while c = data.read(1)
-      next if ["\0", "\x00"].include?(c)  # ignore null characters
+    while (c = data.getc)
+      next if ["\0", "\x00"].include?(c) # ignore null characters
       raise "Unknown header character '#{c}'" if not [@delimiter, nil, c.to_i.to_s].include?(c)
+
       header += c if c
       break if c == @delimiter or data.eof or c == nil
     end
     raise "Unknown header '#{header}'" if header != "" and header.to_i == 0
+
     if data.eof
       @leftover = header
       return
@@ -64,6 +68,7 @@ class LogStash::Codecs::Rfc6587 < LogStash::Codecs::Base
     line = ""
     to_read.times do
       break if (c = data.getc) == nil
+
       line += c
     end
 
@@ -82,22 +87,22 @@ class LogStash::Codecs::Rfc6587 < LogStash::Codecs::Base
 
   def decode(data)
     data = StringIO.new @leftover + data
-    while line = read(data)
+    while (line = read(data))
       yield new_event_from_line(line)
     end
   end
 
   def flush(&block)
-    #remainder = @buffer.flush
-    #if !remainder.empty?
+    # remainder = @buffer.flush
+    # if !remainder.empty?
     #  block.call new_event_from_line(remainder)
-    #end
+    # end
   end
 
   def encode(event)
     raise "Not implemented"
-    #encoded = @format ? event.sprintf(@format) : event.to_s
-    #@on_event.call(event, encoded + @delimiter)
+    # encoded = @format ? event.sprintf(@format) : event.to_s
+    # @on_event.call(event, encoded + @delimiter)
   end
 
   private
@@ -108,5 +113,4 @@ class LogStash::Codecs::Rfc6587 < LogStash::Codecs::Base
     event.set @original_field, message.dup.freeze if @original_field
     event
   end
-
 end

data/logstash-codec-rfc6587.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-codec-rfc6587'
-  s.version         = '0.1.4'
+  s.version         = '0.1.5'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads lines as described in rfc6587"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/codecs/rfc6587_spec.rb

@@ -7,12 +7,11 @@ require "logstash/event"
 require 'logstash/plugin_mixins/ecs_compatibility_support/spec_helper'
 
 describe LogStash::Codecs::Rfc6587, :ecs_compatibility_support do
-
   subject do
     next LogStash::Codecs::Rfc6587.new
   end
 
-  #context "#encode" do
+  # context "#encode" do
   #  let (:event) {LogStash::Event.new({"message" => "hello world", "host" => "test"})}
 
   #  it "should return a default date formatted line" do
@@ -46,111 +45,65 @@ describe LogStash::Codecs::Rfc6587, :ecs_compatibility_support do
   #      subject.encode(event)
   #    end
   #  end
-  #end
+  # end  # context #encode
 
   context "#decode" do
-
-    it "should return an event from an ascii string" do
-      decoded = false
-      subject.decode("11 hello world") do |e|
-        decoded = true
-        insist { e.is_a?(LogStash::Event) }
-        insist { e.get("message") } == "hello world"
-      end
-      insist { decoded } == true
-    end
-
-    it "should return nothing if input data is empty" do
-      decoded = false
-      subject.decode("") do |e|
-        decoded = true
-      end
-      insist { decoded } == false
-    end
-
-    it "should return nothing if input data is only '\\0' or '\\x00'" do
-      decoded = false
-      subject.decode("\0\x00") do |e|
-        decoded = true
-      end
-      insist { decoded } == false
-    end
-
-    it "should return an event from an ascii string prefixed with \\0" do
-      decoded = false
-      subject.decode("\x004 test") do |e|
-        decoded = true
-        insist { e.is_a?(LogStash::Event) }
-        insist { e.get("message") } == "test"
-      end
-      insist { decoded } == true
-    end
-
-    it "should contain correct results when input contains newline" do
-      result = []
-      subject.decode("5 line17 line2\n!5 line3") { |e| result << e }
-      subject.flush { |e| result << e }
-      expect(result.size).to eq(3)
-      expect(result[0].get("message")).to eq("line1")
-      expect(result[1].get("message")).to eq("line2\n!")
-      expect(result[2].get("message")).to eq("line3")
-    end
-
-    it "should parse partial batches" do
-      result = []
-      subject.decode("5 line15 line")  { |e| result << e }
-      subject.decode("25 line3") { |e| result << e }
-      subject.flush { |e| result << e }
-      expect(result.size).to eq(3)
-      expect(result[0].get("message")).to eq("line1")
-      expect(result[1].get("message")).to eq("line2")
-      expect(result[2].get("message")).to eq("line3")
-    end
-
     ecs_compatibility_matrix(:disabled, :v1, :v8 => :v1) do |ecs_select|
-
       before(:each) do
         allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
       end
 
-      let(:line) { "7 München" }
-      let(:message) { "München" }
-
-      it "should return an event from a valid utf-8 string" do
-        subject.decode(line) do |e|
-          expect( e ).to be_a LogStash::Event
-          expect( e.get("message") ).to eql message
-          expect( e.get("message").encoding ).to eql Encoding.find('UTF-8')
-          expect( e.get("message").valid_encoding? ).to be true
+      it "should return an event from an ascii string" do
+        decoded = false
+        subject.decode("11 hello world") do |e|
+          decoded = true
+          insist { e.is_a?(LogStash::Event) }
+          insist { e.get("message") } == "hello world"
         end
+        insist { decoded } == true
       end
 
-      it "sets event.original in ECS mode" do
-        subject.decode(line) do |event|
-          expect( event.get("[event][original]") ).to eql message
+      it "should return nothing if input data is empty" do
+        decoded = false
+        subject.decode("") do
+          decoded = true
         end
-      end if ecs_select.active_mode != :disabled
+        insist { decoded } == false
+      end
 
-    end
+      it "should return nothing if input data is only '\\0' or '\\x00'" do
+        decoded = false
+        subject.decode("\0\x00") do
+          decoded = true
+        end
+        insist { decoded } == false
+      end
 
-    context "when using custom :delimiter" do
-      subject do
-        next LogStash::Codecs::Rfc6587.new("delimiter" => "|")
+      it "should return an event from an ascii string prefixed with \\0" do
+        decoded = false
+        subject.decode("\x004 test") do |e|
+          decoded = true
+          insist { e.is_a?(LogStash::Event) }
+          insist { e.get("message") } == "test"
+        end
+        insist { decoded } == true
       end
 
-      it "should not break lines by '<number><space><line>'" do
-        line = "4 item4 item"
-        raw = "12|#{line}"
+      it "should contain correct results when input contains newline" do
         result = []
-        subject.decode(raw) { |e| result << e }
+        subject.decode("5 line17 line2\n!5 line3") { |e| result << e }
         subject.flush { |e| result << e }
-        expect(result.size).to eq(1)
-        expect(result[0].get("message")).to eq(line)
+        expect(result.size).to eq(3)
+        expect(result[0].get("message")).to eq("line1")
+        expect(result[1].get("message")).to eq("line2\n!")
+        expect(result[2].get("message")).to eq("line3")
       end
 
-      it "should break lines by that delimiter" do
+      it "should parse partial batches" do
         result = []
-        subject.decode("5|line15|line25|line3") { |e| result << e }
+        subject.decode("5 line15")  { |e| result << e }
+        subject.decode(" line25 ") { |e| result << e }
+        subject.decode("line3") { |e| result << e }
         subject.flush { |e| result << e }
         expect(result.size).to eq(3)
         expect(result[0].get("message")).to eq("line1")
@@ -158,21 +111,73 @@ describe LogStash::Codecs::Rfc6587, :ecs_compatibility_support do
         expect(result[2].get("message")).to eq("line3")
       end
 
-    end
-  end
+      it "should return an event from a valid utf-8 string" do
+        subject.decode("7 München") do |e|
+          expect(e).to be_a LogStash::Event
+          expect(e.get("message")).to eql "München"
+          expect(e.get("message").encoding).to eql Encoding.find('UTF-8')
+          expect(e.get("message").valid_encoding?).to be true
+        end
+      end
 
-  #context "#flush" do
-  #  it "should convert charsets" do
-  #    garbage = [0xD0].pack("C")
-  #    subject.decode(garbage) do |e|
-  #      fail "Should not get here."
-  #    end
-  #    count = 0
-  #    subject.flush do |event|
-  #      count += 1
-  #      insist { event.get("message").encoding } == Encoding::UTF_8
-  #    end
-  #    insist { count } == 1
-  #  end
-  #end
-end
+      it "sets event.original in ECS mode" do
+        subject.decode("7 München") do |event|
+          expect(event.get("[event][original]")).to eql "München"
+        end
+      end if ecs_select.active_mode != :disabled
+
+      context "when using custom :delimiter" do
+        subject do
+          next LogStash::Codecs::Rfc6587.new("delimiter" => "|")
+        end
+
+        it "should fail if delimitter has an invalid length" do
+          expect {
+            LogStash::Codecs::Rfc6587.new("delimiter" => "")
+          }.to raise_error(RuntimeError,
+                           "Delimitter must be 1 character long, but got ''")
+          expect {
+            LogStash::Codecs::Rfc6587.new("delimiter" => "xx")
+          }.to raise_error(RuntimeError,
+                           "Delimitter must be 1 character long, but got 'xx'")
+        end
+
+        it "should not break lines by '<number><space><line>'" do
+          line = "4 item4 item"
+          raw = "12|#{line}"
+          result = []
+          subject.decode(raw) { |e| result << e }
+          subject.flush { |e| result << e }
+          expect(result.size).to eq(1)
+          expect(result[0].get("message")).to eq(line)
+        end
+
+        it "should break lines by that delimiter" do
+          result = []
+          subject.decode("5|line15|line25|line3") { |e| result << e }
+          subject.flush { |e| result << e }
+          expect(result.size).to eq(3)
+          expect(result[0].get("message")).to eq("line1")
+          expect(result[1].get("message")).to eq("line2")
+          expect(result[2].get("message")).to eq("line3")
+        end
+
+        context "and it being unicode" do
+          subject do
+            next LogStash::Codecs::Rfc6587.new("delimiter" => "÷")
+          end
+
+          it "should produce correct events" do
+            line = "4÷item4÷item"
+            result = []
+            subject.decode(line) { |e| result << e }
+            subject.flush { |e| result << e }
+            expect(result.size).to eq(2)
+            expect(result[0].get("message")).to eq('item')
+            expect(result[1].get("message")).to eq('item')
+          end
+        end # context unicode delimiter
+      end # context custom delimiter
+    end # ecs compat
+  end # context #decode
+end  # describe

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-codec-rfc6587
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Elastic
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -21,8 +21,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.99'
   name: logstash-core-plugin-api
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,8 +38,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
   name: logstash-mixin-event_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -52,8 +52,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
   name: logstash-mixin-ecs_compatibility_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -66,8 +66,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,8 +80,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: insist
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="