logstash-output-googlecloudstorage 0.1.0-java

data/logstash-output-googlecloudstorage.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-output-googlecloudstorage'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache-2.0']
+  s.summary         = "plugin to upload log events to Google Cloud Storage (GCS)"
+  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"
+  s.authors         = ["Shailesh"]
+  s.email           = 'shailesh17mar@gmail.com'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+  s.platform = Gem::Platform::JAVA if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+
+  # Files
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_development_dependency 'logstash-devutils'
+
+  s.add_runtime_dependency 'stud'
+  s.add_runtime_dependency 'google-api-client', '~> 0.8.7' # version 0.9.x works only with ruby 2.x
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'mime-types', '~> 2' # last version compatible with ruby 2.x
+  s.add_runtime_dependency 'concurrent-ruby', '1.0.5'
+end
+

data/spec/outputs/gcs/log_rotate_spec.rb

@@ -0,0 +1,129 @@
+# encoding: utf-8
+require 'logstash/outputs/gcs/log_rotate'
+require 'logstash/outputs/gcs/path_factory'
+require 'logstash/outputs/gcs/temp_log_file'
+
+describe LogStash::Outputs::Gcs::LogRotate do
+  let(:tempdir){ Stud::Temporary.directory }
+  let(:path_factory) do
+    LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+      builder.set_directory tempdir
+      builder.set_prefix 'prefix'
+      builder.set_include_host true
+      builder.set_date_pattern ''
+      builder.set_include_part true
+      builder.set_include_uuid true
+      builder.set_is_gzipped true
+    end
+  end
+  let(:open_file_1) { double('open-temp-1', :size => 5, :path => 'one', :close! => true, :time_since_sync => 10, :fsync => true)}
+  let(:open_file_2) { double('open-temp-2', :size => 5, :path => 'two', :close! => true, :time_since_sync => 60, :fsync => true)}
+
+  describe '#initialize' do
+    it 'opens the first file' do
+      expect(LogStash::Outputs::Gcs::LogFileFactory).to receive(:create).and_return(open_file_1)
+
+      LogStash::Outputs::Gcs::LogRotate.new(path_factory, 10, false, 30)
+    end
+  end
+
+  describe '#writeln' do
+    subject { LogStash::Outputs::Gcs::LogRotate.new(path_factory, 10, false, 30) }
+
+    it 'does not rotate if size is small and path is the same' do
+      expect(path_factory).to receive(:should_rotate?).and_return(false)
+      # once for init
+      expect(path_factory).to receive(:rotate_path!).once
+
+      subject.writeln('foo')
+    end
+
+    it 'rotates the file if the size is too big' do
+      # once for init, once for writeln
+      expect(path_factory).to receive(:rotate_path!).twice
+
+      subject.writeln('this line is longer than ten characters' * 1000)
+      subject.writeln('flush')
+    end
+
+    it 'rotates the file if the path changed' do
+      expect(path_factory).to receive(:should_rotate?).and_return(true)
+      # once for init, once for writeln
+      expect(path_factory).to receive(:rotate_path!).twice
+
+      subject.writeln('foo')
+    end
+
+    it 'writes the message' do
+      expect(LogStash::Outputs::Gcs::LogFileFactory).to receive(:create).and_return(open_file_1)
+      expect(open_file_1).to receive(:write).with('foo', "\n")
+
+      subject.writeln('foo')
+    end
+
+    it 'does not write nil messages' do
+      expect(LogStash::Outputs::Gcs::LogFileFactory).to receive(:create).and_return(open_file_1)
+      expect(open_file_1).not_to receive(:write)
+
+      subject.writeln(nil)
+    end
+
+    it 'does not fsync if delta less than limit' do
+      expect(LogStash::Outputs::Gcs::LogFileFactory).to receive(:create).and_return(open_file_1)
+      expect(open_file_1).not_to receive(:fsync)
+
+      subject.writeln(nil)
+    end
+
+    it 'fsyncs if delta greater than limit' do
+      expect(LogStash::Outputs::Gcs::LogFileFactory).to receive(:create).and_return(open_file_2)
+      expect(open_file_2).to receive(:fsync)
+
+      subject.writeln(nil)
+    end
+  end
+
+  describe '#rotate_log!' do
+    subject { LogStash::Outputs::Gcs::LogRotate.new(path_factory, 10, false, 30) }
+
+    before :each do
+      allow(LogStash::Outputs::Gcs::LogFileFactory).to receive(:create).and_return(open_file_1, open_file_2)
+    end
+
+    it 'closes the old file' do
+      expect(open_file_1).to receive(:close!)
+
+      subject.rotate_log!
+    end
+
+    it 'calls the callback with the old file name' do
+      value = nil
+      subject.on_rotate { |old_path| value = old_path }
+
+      subject.rotate_log!
+      expect(value).to eq(open_file_1.path)
+    end
+
+    it 'opens a new file based on the new path' do
+      expect(LogStash::Outputs::Gcs::LogFileFactory).to receive(:create).and_return(open_file_1, open_file_2)
+      expect(open_file_2).to receive(:write).with('foo', "\n")
+
+      subject.rotate_log!
+      subject.writeln('foo')
+    end
+  end
+
+  describe '#on_rotate' do
+    subject { LogStash::Outputs::Gcs::LogRotate.new(path_factory, 10, false, 30) }
+
+    it 'replaces an existing callback' do
+      value = :none
+
+      subject.on_rotate { value = :first }
+      subject.on_rotate { value = :second }
+
+      subject.rotate_log!
+      expect(value).to eq(:second)
+    end
+  end
+end

data/spec/outputs/gcs/path_factory_spec.rb

@@ -0,0 +1,189 @@
+# encoding: utf-8
+require 'logstash/outputs/gcs/path_factory'
+
+describe LogStash::Outputs::Gcs::PathFactory do
+  describe '#initialize' do
+    it 'includes optional fields if requested' do
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory 'path/to/directory'
+        builder.set_prefix 'prefix'
+        builder.set_include_host true
+        builder.set_date_pattern ''
+        builder.set_include_part true
+        builder.set_include_uuid true
+        builder.set_is_gzipped true
+      end
+
+      vars = {
+          prefix: 'prefix',
+          host: 'hostname',
+          date: '2018-01-01',
+          uuid: '00000000-0000-0000-0000-000000000000',
+          partf: '333'
+      }
+
+      expected = 'prefix_hostname_2018-01-01.part333.00000000-0000-0000-0000-000000000000.log.gz'
+      expected = File.join('path/to/directory', expected)
+
+      actual = pf.current_path(vars)
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'excludes optional fields if not requested' do
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory 'path/to/directory'
+        builder.set_prefix 'prefix'
+        builder.set_include_host false
+        builder.set_date_pattern ''
+        builder.set_include_part false
+        builder.set_include_uuid false
+        builder.set_is_gzipped false
+      end
+
+      vars = {
+          prefix: 'prefix',
+          host: 'hostname',
+          date: '2018-01-01',
+          uuid: '00000000-0000-0000-0000-000000000000',
+          partf: '333'
+      }
+
+      expected = 'prefix_2018-01-01.log'
+      expected = File.join('path/to/directory', expected)
+
+      actual = pf.current_path(vars)
+
+      expect(actual).to eq(expected)
+    end
+
+    it 'loads a path immediately' do
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory ''
+        builder.set_prefix ''
+        builder.set_include_host false
+        builder.set_date_pattern ''
+        builder.set_include_part false
+        builder.set_include_uuid false
+        builder.set_is_gzipped false
+      end
+
+      expect(pf.current_path).to_not eq(nil)
+    end
+
+    it 'recovers the starting part number' do
+      contents = ['pre_date.part009.log.gz', 'pre_date.part091.log.gz', 'pre_date.part000.log.gz']
+
+      allow(::File).to receive(:directory?).with('dir').and_return(true)
+      allow(Dir).to receive(:glob).and_return(contents)
+
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory 'dir'
+        builder.set_prefix 'pre'
+        builder.set_include_host false
+        builder.set_date_pattern 'date'
+        builder.set_include_part true
+        builder.set_include_uuid false
+        builder.set_is_gzipped false
+      end
+
+      expect(pf.current_path).to include('part092')
+    end
+  end
+
+  describe 'rotate_path!' do
+    it 'increments the part number if the base has not changed' do
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory 'dir'
+        builder.set_prefix 'pre'
+        builder.set_include_host false
+        builder.set_date_pattern 'date'
+        builder.set_include_part true
+        builder.set_include_uuid false
+        builder.set_is_gzipped false
+      end
+
+      expect(pf.current_path).to eq(File.join('dir', 'pre_date.part000.log'))
+
+      pf.rotate_path!
+      expect(pf.current_path).to eq(File.join('dir', 'pre_date.part001.log'))
+    end
+
+    it 'resets the part number if the base has changed' do
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory 'dir'
+        builder.set_prefix 'pre'
+        builder.set_include_host false
+        builder.set_date_pattern '%N'
+        builder.set_include_part true
+        builder.set_include_uuid false
+        builder.set_is_gzipped false
+      end
+      expect(pf.current_path).to include('part000')
+
+      pf.rotate_path!
+      expect(pf.current_path).to include('part000')
+    end
+
+    it 'returns the path being rotated out' do
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory 'dir'
+        builder.set_prefix 'pre'
+        builder.set_include_host false
+        builder.set_date_pattern 'date'
+        builder.set_include_part true
+        builder.set_include_uuid false
+        builder.set_is_gzipped false
+      end
+      last = pf.current_path
+      after = pf.rotate_path!
+      expect(after).to eq(last)
+    end
+  end
+
+  describe 'should_rotate?' do
+    it 'returns false when the times in the bases are the same' do
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory ''
+        builder.set_prefix ''
+        builder.set_include_host false
+        builder.set_date_pattern ''
+        builder.set_include_part false
+        builder.set_include_uuid false
+        builder.set_is_gzipped false
+      end
+      sleep 1.0
+      expect(pf.should_rotate?).to eq(false)
+    end
+
+    it 'returns true when the times in the bases are different' do
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory ''
+        builder.set_prefix ''
+        builder.set_include_host false
+        builder.set_date_pattern '%N'
+        builder.set_include_part false
+        builder.set_include_uuid false
+        builder.set_is_gzipped false
+      end
+      sleep 1.0
+      expect(pf.should_rotate?).to eq(true)
+    end
+  end
+
+  describe 'current_path' do
+    it 'joins the directory and filename' do
+      pf = LogStash::Outputs::Gcs::PathFactoryBuilder.build do |builder|
+        builder.set_directory 'dir'
+        builder.set_prefix 'pre'
+        builder.set_include_host false
+        builder.set_date_pattern 'date'
+        builder.set_include_part false
+        builder.set_include_uuid false
+        builder.set_is_gzipped false
+      end
+
+      expect(pf.current_path).to eq(File.join('dir', 'pre_date.log'))
+    end
+  end
+end

data/spec/outputs/gcs/temp_log_file_spec.rb

@@ -0,0 +1,155 @@
+# encoding: utf-8
+require 'logstash/outputs/gcs/temp_log_file'
+require 'stud/temporary'
+require 'zlib'
+
+shared_examples 'a log file' do
+  describe '#initialize' do
+    it 'opens a file' do
+      expect{subject.fd}.to_not raise_error
+      expect(subject.fd).to_not be_nil
+    end
+
+    it 'sets the path' do
+      expect{subject.path}.to_not raise_error
+      expect(subject.path).to_not be_nil
+    end
+
+    it 'sets last sync' do
+      expect{subject.time_since_sync}.to_not raise_error
+    end
+  end
+
+  describe '#write' do
+    it 'writes the content' do
+      expect(subject.fd).to receive(:write).with('foo')
+      expect(subject.fd).to receive(:write).with("\n")
+
+      subject.write('foo', "\n")
+    end
+
+    it 'fails if the file is closed' do
+      subject.close!
+
+      expect{ subject.write('foo') }.to raise_error(IOError)
+    end
+  end
+
+  describe '#fsync' do
+    it 'fails if the file is closed' do
+      subject.close!
+
+      expect{ subject.fsync }.to raise_error(IOError)
+    end
+  end
+
+  describe '#close!' do
+    it 'fails if the file is closed' do
+      subject.close!
+
+      expect{ subject.close! }.to raise_error(IOError)
+    end
+  end
+
+  describe '#size' do
+    it 'gets the size of the file on disk' do
+      subject.write('hello, world!')
+      subject.fsync
+
+      expect(subject.size).to eq(File.stat(subject.path).size)
+    end
+
+    it 'does not fail if the file is closed' do
+      subject.close!
+
+      expect{ subject.size }.to_not raise_error
+    end
+  end
+
+  describe '#time_since_sync' do
+    it 'returns a delta' do
+      expect(Time).to receive(:now).and_return(Time.at(30), Time.at(40), Time.at(50))
+
+      subject.fsync
+
+      expect(subject.time_since_sync).to eq(10)
+    end
+  end
+end
+
+describe LogStash::Outputs::Gcs::PlainLogFile do
+  let(:tempdir) { Stud::Temporary.directory }
+  let(:path) { ::File.join(tempdir, 'logfile.log') }
+  subject { LogStash::Outputs::Gcs::LogFileFactory.create(path, false, false) }
+
+  it_behaves_like 'a log file'
+
+  it 'creates a valid plain text file' do
+    subject.write('Hello, world!')
+    subject.close!
+    data = File.read(path)
+
+    expect(data).to eq('Hello, world!')
+  end
+end
+
+describe LogStash::Outputs::Gcs::GzipLogFile do
+  let(:tempdir) { Stud::Temporary.directory }
+  let(:path) { ::File.join(tempdir, 'logfile.log') }
+  subject { LogStash::Outputs::Gcs::LogFileFactory.create(path, true, false) }
+
+  it_behaves_like 'a log file'
+
+  it 'creates a valid gzip' do
+    subject.write('Hello, world!')
+    subject.close!
+
+    Zlib::GzipReader.open(path) do |gz|
+      expect(gz.read).to eq('Hello, world!')
+    end
+  end
+end
+
+describe LogStash::Outputs::Gcs::SynchronizedLogFile do
+  let(:tempdir) { Stud::Temporary.directory }
+  let(:path) { ::File.join(tempdir, 'logfile.log') }
+  subject { LogStash::Outputs::Gcs::LogFileFactory.create(path, false, true) }
+
+  it_behaves_like 'a log file'
+end
+
+describe 'gzip encoded file' do
+  let(:tempdir) { Stud::Temporary.directory }
+  let(:path) { ::File.join(tempdir, 'logfile.log') }
+  subject { LogStash::Outputs::Gcs::LogFileFactory.create(path, false, false, true) }
+
+  it_behaves_like 'a log file'
+
+  it 'creates a valid gzip' do
+    subject.write('Hello, world!')
+    subject.close!
+
+    Zlib::GzipReader.open(path) do |gz|
+      expect(gz.read).to eq('Hello, world!')
+    end
+  end
+end
+
+describe 'double gzip encoded file' do
+  let(:tempdir) { Stud::Temporary.directory }
+  let(:path) { ::File.join(tempdir, 'logfile.log') }
+  subject { LogStash::Outputs::Gcs::LogFileFactory.create(path, true, false, true) }
+
+  it_behaves_like 'a log file'
+
+  it 'creates a valid double gzip' do
+    subject.write('Hello, world!')
+    subject.close!
+
+    Zlib::GzipReader.open(path) do |outer|
+      Zlib::GzipReader.new(outer) do |inner|
+        expect(inner.read).to eq('Hello, world!')
+      end
+    end
+  end
+end