logstash-output-google_cloud_storage 4.0.0-java

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

data/spec/outputs/gcs/worker_pool_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'logstash/outputs/gcs/worker_pool'
+
+describe LogStash::Outputs::Gcs::WorkerPool do
+  describe '#post' do
+    it 'runs the task in the same thread if synchronous' do
+      pool = LogStash::Outputs::Gcs::WorkerPool.new(5, true)
+      expect(pool.workers).to_not receive(:post)
+
+      pool.post { 1 + 2 }
+      pool.stop!
+    end
+
+    it 'runs the task in a different thread if asynchronous' do
+      pool = LogStash::Outputs::Gcs::WorkerPool.new(5, false)
+      expect(pool.workers).to receive(:post)
+
+      pool.post { 1 + 2 }
+      pool.stop!
+    end
+
+    it 'raises an error if the pool is already stopped' do
+      pool = LogStash::Outputs::Gcs::WorkerPool.new(5, true)
+      pool.stop!
+
+      expect{ pool.post{} }.to raise_error(RuntimeError)
+    end
+  end
+end

data/spec/outputs/google_cloud_storage_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require_relative "../spec_helper"
+require "tempfile"
+
+describe LogStash::Outputs::GoogleCloudStorage do
+
+  let(:javaclient) { double("google-java-client") }
+  let(:javastorage) { double("google-java-client-storage") }
+
+  subject { described_class.new(config) }
+  let(:config) { {"bucket" => "", "uploader_interval_secs" => 0.1, "upload_synchronous" => true} }
+
+  before(:each) do
+    allow(LogStash::Outputs::Gcs::Client).to receive(:new).and_return(:javaclient)
+    allow(javaclient).to receive(:initialize_storage).and_return(:javastorage)
+  end
+
+  it "should register without errors" do
+    expect { subject.register }.to_not raise_error
+
+    subject.close
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/google_cloud_storage"