logstash-output-csv 3.0.9 → 3.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7a05140cdafe0cf40199b965734aec4da79a70513ee9f3d9085af089ce126dc
-  data.tar.gz: 047b1370413123253334129b37f504ba85f71a29e99e769dc333525e79471a0f
+  metadata.gz: ecdec45db80595cc81698a806071c64593c61f4750dd5ce3bca94dce10a55b3f
+  data.tar.gz: ac29398e62fe6942440fd847be257f8ff6c737f812ae003743688a189fba29fd
 SHA512:
-  metadata.gz: a7c0372851b2b7ca7d6989f17846a6658636e439b6328d72182fb6da1ac9ea5875686c6d74aa8be928bc327a9f01408151944a98ade2d51e9fdf68dcc2ef1690
-  data.tar.gz: 9e7a658e67f5207c8d58ed8234ef61bcdd9c65171ad918df536753b59a91573f26e8fad18949c4bbce785a085a635d516e8eda9f4dfe4268b2b730e7028af3c3
+  metadata.gz: 7f3902673a817ae7c836d5bc600bee0d93f5bf6735bd32eb72373f065c0ff5ebde69461d306c10cb16eadc96c37e6568038652471743ee13d093efd1e83cc408
+  data.tar.gz: cd130b35764cc66b0ac070d49ed0d24ff701524dafcead9b45179a97c80a8a35e6fcac3ae48dba05bed6a51c0a16ec4fd2a355e90b9261d3f55aa0f8bec9278f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 3.0.11
+  - Docs: Correct code snippet [#28](https://github.com/logstash-plugins/logstash-output-csv/pull/28)
+
+## 3.0.10
+  - Extend `spreadsheet_safe` prefix guard to '-', '+', and '@' [#27](https://github.com/logstash-plugins/logstash-output-csv/pull/27)
+
 ## 3.0.9
  - Fix: updates syntax to JRuby 9.4 [#25](https://github.com/logstash-plugins/logstash-output-csv/pull/25)
 

data/docs/index.asciidoc

@@ -147,7 +147,7 @@ You can customise the line format using the `line` codec like:
 [source,ruby]
 -----
 output {
- file {
+ csv {
    path => ...
    codec => line { format => "custom format: %{message}"}
  }
@@ -180,4 +180,4 @@ may not make the values safe in your spreadsheet application
 include::{include_path}/{type}.asciidoc[]
 
 
-:default_codec!:
+:default_codec!:

data/lib/logstash/outputs/csv.rb

@@ -66,6 +66,6 @@ class LogStash::Outputs::CSV < LogStash::Outputs::File
 
   private
   def escape_csv(val)
-    (spreadsheet_safe && val.is_a?(String) && val.start_with?("=")) ? "'#{val}" : val
+    (spreadsheet_safe && val.is_a?(String) && val.start_with?(/[=+\-@]/)) ? "'#{val}" : val
   end
 end # class LogStash::Outputs::CSV

data/logstash-output-csv.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-csv'
-  s.version         = '3.0.9'
+  s.version         = '3.0.11'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Writes events to disk in a delimited format"
   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"
@@ -22,9 +22,6 @@ Gem::Specification.new do |s|
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
 
-  s.add_runtime_dependency 'logstash-input-generator'
   s.add_runtime_dependency 'logstash-output-file'
-  s.add_runtime_dependency 'logstash-filter-json'
   s.add_development_dependency 'logstash-devutils'
-  s.add_development_dependency 'insist'
 end

data/spec/outputs/csv_spec.rb

@@ -1,319 +1,171 @@
 require "csv"
 require "tempfile"
 require "logstash/devutils/rspec/spec_helper"
-require "insist"
 require "logstash/outputs/csv"
 
 describe LogStash::Outputs::CSV do
 
+  subject { described_class.new(options) }
 
-  describe "Write a single field to a csv file" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          add_field => ["foo","bar"]
-          count => 1
-        }
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => "foo"
-        }
-      }
-    CONFIG
+  let(:tmpfile) { Tempfile.new('logstash-spec-output-csv').path }
+  let(:output) { File.readlines(tmpfile) }
+  let(:csv_output) { CSV.read(tmpfile) }
 
-    agent do
-      lines = File.readlines(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0]} == "bar\n"
-    end
+  before(:each) do
+    subject.register
+    subject.multi_receive(events)
   end
 
-  describe "write multiple fields and lines to a csv file" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          add_field => ["foo", "bar", "baz", "quux"]
-          count => 2
-        }
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["foo", "baz"]
-        }
-      }
-    CONFIG
-
-    agent do
-      lines = File.readlines(tmpfile.path)
-      insist {lines.count} == 2
-      insist {lines[0]} == "bar,quux\n"
-      insist {lines[1]} == "bar,quux\n"
+  context "when configured with a single field" do
+    let(:events) { [ LogStash::Event.new("foo" => "bar") ] }
+    let(:options) { { "path" => tmpfile, "fields" => "foo" } }
+    it "writes a single field to a csv file" do
+      expect(output.count).to eq(1)
+      expect(output.first).to eq("bar\n")
     end
   end
 
-  describe "missing event fields are empty in csv" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          add_field => ["foo","bar", "baz", "quux"]
-          count => 1
-        }
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["foo", "not_there", "baz"]
-        }
-      }
-    CONFIG
-
-    agent do
-      lines = File.readlines(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0]} == "bar,,quux\n"
+  context "when receiving multiple events with multiple fields" do
+    let(:events) do
+      [ LogStash::Event.new("foo" => "bar", "baz" => "quux"),
+        LogStash::Event.new("foo" => "bar", "baz" => "quux") ]
+    end
+    let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"] } }
+    it "writes a line per event " do
+      expect(output.count).to eq(2)
+    end
+    it "writes configured fields for each line" do
+      expect(output[0]).to eq("bar,quux\n")
+      expect(output[1]).to eq("bar,quux\n")
     end
   end
 
-  describe "commas are quoted properly" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          add_field => ["foo","one,two", "baz", "quux"]
-          count => 1
-        }
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["foo", "baz"]
-        }
-      }
-    CONFIG
+  context "with missing event fields" do
+    let(:events) do
+      [ LogStash::Event.new("foo" => "bar", "baz" => "quux") ]
+    end
+    let(:options) { { "path" => tmpfile, "fields" => ["foo", "not_there", "baz"] } }
 
-    agent do
-      lines = File.readlines(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0]} == "\"one,two\",quux\n"
+    it "skips on the resulting line" do
+      expect(output.size).to eq(1)
+      expect(output[0]).to eq("bar,,quux\n")
     end
   end
 
-  describe "new lines are quoted properly" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          add_field => ["foo","one\ntwo", "baz", "quux"]
-          count => 1
-        }
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["foo", "baz"]
-        }
-      }
-    CONFIG
-
-    agent do
-      lines = CSV.read(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0][0]} == "one\ntwo"
+  context "when field values have commas" do
+    let(:events) do
+      [ LogStash::Event.new("foo" => "one,two", "baz" => "quux") ]
+    end
+    let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"] } }
+    it "correctly escapes them" do
+      expect(output.size).to eq(1)
+      expect(output[0]).to eq("\"one,two\",quux\n")
     end
   end
 
-  describe "fields that are are objects are written as JSON" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          message => '{"foo":{"one":"two"},"baz": "quux"}'
-          count => 1
-        }
-      }
-      filter {
-        json { source => "message"}
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["foo", "baz"]
-        }
-      }
-    CONFIG
-
-    agent do
-      lines = CSV.read(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0][0]} == '{"one":"two"}'
+  context "when fields contain special characters" do
+    let(:events) do
+      [ LogStash::Event.new("foo" => 'one\ntwo', "baz" => "quux") ]
+    end
+    let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"] } }
+    it "correctly escapes them" do
+      expect(csv_output.size).to eq(1)
+      expect(csv_output[0]).to eq(['one\ntwo', 'quux'])
     end
   end
 
-  describe "can address nested field using field reference syntax" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          message => '{"foo":{"one":"two"},"baz": "quux"}'
-          count => 1
-        }
-      }
-      filter {
-        json { source => "message"}
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["[foo][one]", "baz"]
-        }
-      }
-    CONFIG
+  context "fields that contain objects" do
+    let(:events) do
+      [ LogStash::Event.new("foo" => {"one" => "two"}, "baz" => "quux") ]
+    end
+    let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"] } }
 
-    agent do
-      lines = CSV.read(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0][0]} == "two"
-      insist {lines[0][1]} == "quux"
+    it "are written as json" do
+      expect(csv_output.size).to eq(1)
+      expect(csv_output[0][0]).to eq('{"one":"two"}')
     end
   end
+  context "with address nested field" do
+    let(:events) do
+      [ LogStash::Event.new("foo" => {"one" => "two"}, "baz" => "quux") ]
+    end
+    let(:options) { { "path" => tmpfile, "fields" => ["[foo][one]", "baz"] } }
 
-  describe "missing nested field is blank" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          message => '{"foo":{"one":"two"},"baz": "quux"}'
-          count => 1
-        }
-      }
-      filter {
-        json { source => "message"}
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["[foo][missing]", "baz"]
-        }
-      }
-    CONFIG
-
-    agent do
-      lines = File.readlines(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0]} == ",quux\n"
+    it "are referenced using field references" do
+      expect(csv_output.size).to eq(1)
+      expect(csv_output[0][0]).to eq('two')
+      expect(csv_output[0][1]).to eq('quux')
     end
   end
 
-  describe "can choose field seperator" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          message => '{"foo":"one","bar": "two"}'
-          count => 1
-        }
-      }
-      filter {
-        json { source => "message"}
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["foo", "bar"]
-          csv_options => {"col_sep" => "|"}
-        }
-      }
-    CONFIG
+  context "missing nested field" do
+    let(:events) do
+      [ LogStash::Event.new("foo" => {"one" => "two"}, "baz" => "quux") ]
+    end
+    let(:options) { { "path" => tmpfile, "fields" => ["[foo][missing]", "baz"] } }
 
-    agent do
-      lines = File.readlines(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0]} == "one|two\n"
+    it "are blank" do
+      expect(output.size).to eq(1)
+      expect(output[0]).to eq(",quux\n")
     end
   end
-  describe "can choose line seperator" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          message => '{"foo":"one","bar": "two"}'
-          count => 2
-        }
-      }
-      filter {
-        json { source => "message"}
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["foo", "bar"]
-          csv_options => {"col_sep" => "|" "row_sep" => "\t"}
-        }
-      }
-    CONFIG
 
-    agent do
-      lines = File.readlines(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0]} == "one|two\tone|two\t"
+  describe "field separator" do
+    let(:events) do
+      [ LogStash::Event.new("foo" => "one", "baz" => "two") ]
+    end
+    let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"], "csv_options" => {"col_sep" => "|" } } }
+
+    it "uses separator in output" do
+      expect(output.size).to eq(1)
+      expect(output[0]).to eq("one|two\n")
     end
   end
 
-  describe "can escape rogue values" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          add_field => ["foo","1+1", "baz", "=1+1"]
-          count => 1
-        }
-      }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          fields => ["foo", "baz"]
-        }
-      }
-    CONFIG
+  describe "line seperator" do
+    let(:events) do
+      [ LogStash::Event.new("foo" => "one", "baz" => "two"),
+        LogStash::Event.new("foo" => "one", "baz" => "two") ]
+    end
+    let(:options) { { "path" => tmpfile, "fields" => ["foo", "baz"], "csv_options" => {"col_sep" => "|", "row_sep" => "\t" } } }
 
-    agent do
-      lines = CSV.read(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0][0]} == "1+1"
-      insist {lines[0][1]} == "'=1+1"
+    it "uses separator in output" do
+      expect(output.size).to eq(1)
+      expect(output[0]).to eq("one|two\tone|two\t")
     end
   end
 
-  describe "can turn off escaping rogue values" do
-    tmpfile = Tempfile.new('logstash-spec-output-csv')
-    config <<-CONFIG
-      input {
-        generator {
-          add_field => ["foo","1+1", "baz", "=1+1"]
-          count => 1
-        }
+  context "with rogue values" do
+    let(:event_data) do
+      {
+        "f1" => "1+1",
+        "f2" => "=1+1",
+        "f3" => "+1+1",
+        "f4" => "-1+1",
+        "f5" => "@1+1"
       }
-      output {
-        csv {
-          path => "#{tmpfile.path}"
-          spreadsheet_safe => false
-          fields => ["foo", "baz"]
-        }
-      }
-    CONFIG
+    end
+    let(:events) do
+      [ LogStash::Event.new(event_data) ]
+    end
 
-    agent do
-      lines = CSV.read(tmpfile.path)
-      insist {lines.count} == 1
-      insist {lines[0][0]} == "1+1"
-      insist {lines[0][1]} == "=1+1"
+    let(:options) { { "path" => tmpfile, "fields" => ["f1", "f2", "f3", "f4", "f5"] } }
+    it "escapes them correctly" do
+      expect(csv_output.size).to eq(1)
+      expect(csv_output[0][0]).to eq("1+1")
+      expect(csv_output[0][1]).to eq("'=1+1")
+      expect(csv_output[0][2]).to eq("'+1+1")
+      expect(csv_output[0][3]).to eq("'-1+1")
+      expect(csv_output[0][4]).to eq("'@1+1")
     end
-  end
 
+    context "when escaping is turned off" do
+      let(:options) { super().merge("spreadsheet_safe" => false) }
+      it "doesn't escapes values" do
+        expect(csv_output.size).to eq(1)
+        expect(csv_output[0][0]).to eq("1+1")
+        expect(csv_output[0][1]).to eq("=1+1")
+      end
+    end
+  end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-csv
 version: !ruby/object:Gem::Version
-  version: 3.0.9
+  version: 3.0.11
 platform: ruby
 authors:
 - Elastic
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2025-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -19,9 +19,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:
     - - ">="
@@ -31,70 +30,28 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.99'
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  name: logstash-input-generator
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
   name: logstash-output-file
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-filter-json
-  prerelease: false
   type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  name: logstash-devutils
   prerelease: false
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: logstash-devutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: insist
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +81,6 @@ licenses:
 metadata:
   logstash_plugin: 'true'
   logstash_group: output
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Writes events to disk in a delimited format
 test_files: