steno-capi 1.3.4

data/spec/unit/sink/fluentd_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Steno::Sink::IO do
+  let(:level) do
+    Steno::Logger.lookup_level(:info)
+  end
+
+  let(:record) do
+    Steno::Record.new("source", level.name, "message")
+  end
+
+  describe "#initialize" do
+    it "should initialize FluentLogger with the default option" do
+      expect(Fluent::Logger::FluentLogger).to receive(:new).with("steno", {
+        :host => "127.0.0.1",
+        :port => 24224,
+        :buffer_limit => Fluent::Logger::FluentLogger::BUFFER_LIMIT,
+        }).and_return(nil)
+      sink = Steno::Sink::Fluentd.new()
+    end
+
+    it "should initialize FliuentLogger with override options" do
+      expect(Fluent::Logger::FluentLogger).to receive(:new).with("vcap", {
+        :host => "localhost",
+        :port => 8080,
+        :buffer_limit => 1024,
+        }).and_return(nil)
+      sink = Steno::Sink::Fluentd.new({
+        :tag_prefix => "vcap",
+        :host => "localhost",
+        :port => 8080,
+        :buffer_limit => 1024
+        })
+    end
+  end
+
+  describe "#add_record" do
+    it "should post an record with the correct tag" do
+      fluentd = double("fluentd")
+      expect(Fluent::Logger::FluentLogger).to receive(:new).and_return(fluentd)
+      expect(fluentd).to receive(:post).with("source", record)
+      sink = Steno::Sink::Fluentd.new()
+      sink.add_record(record)
+    end
+  end
+end

data/spec/unit/sink/io_spec.rb

@@ -0,0 +1,111 @@
+require "spec_helper"
+
+describe Steno::Sink::IO do
+  let(:level) do
+    Steno::Logger.lookup_level(:info)
+  end
+
+  let(:record) do
+    Steno::Record.new("source", level.name, "message")
+  end
+
+  describe ".for_file" do
+    it "should return a new sink configured to append to the file at path with autosync set to true by default" do
+      mock_handle = double("file handle")
+
+      expect(File).to receive(:open).with("path", "a+").and_return(mock_handle)
+      expect(mock_handle).to receive(:sync=).with(true)
+
+      mock_sink = double("sink")
+      expect(Steno::Sink::IO).to receive(:new).with(mock_handle,
+                                                :max_retries => 10).
+        and_return(mock_sink)
+
+      returned = Steno::Sink::IO.for_file("path",
+                                          :max_retries => 10)
+      expect(returned).to eq(mock_sink)
+    end
+
+    it "should return a new sink configured to append to the file at path with specified options" do
+      mock_handle = double("file handle")
+
+      expect(File).to receive(:open).with("path", "a+").and_return(mock_handle)
+      expect(mock_handle).to receive(:sync=).with(false)
+
+      mock_sink = double("sink")
+      expect(Steno::Sink::IO).to receive(:new).with(mock_handle,
+                                                :max_retries => 10).
+        and_return(mock_sink)
+
+      returned = Steno::Sink::IO.for_file("path",
+                                          :autoflush => false,
+                                          :max_retries => 10)
+      expect(returned).to eq(mock_sink)
+    end
+  end
+
+  describe "#add_record" do
+    it "should encode the record and write it to the underlying io object" do
+      codec = double("codec")
+      expect(codec).to receive(:encode_record).with(record).and_return(record.message)
+
+      io = double("io")
+      expect(io).to receive(:write).with(record.message)
+
+      Steno::Sink::IO.new(io, :codec => codec).add_record(record)
+    end
+
+    it "should by default not retry on IOError" do
+      codec = double("codec")
+      expect(codec).to receive(:encode_record).with(record).and_return(record.message)
+
+      io = double("io")
+
+      expect(io).to receive(:write).with(record.message).ordered.and_raise(IOError)
+
+      expect do
+        Steno::Sink::IO.new(io, :codec => codec).add_record(record)
+      end.to raise_error(IOError)
+    end
+
+    it "should retry not more than specified number of times on IOError" do
+      codec = double("codec")
+      expect(codec).to receive(:encode_record).with(record).and_return(record.message)
+
+      io = double("io")
+
+      expect(io).to receive(:write).exactly(3).times.with(record.message).
+        and_raise(IOError)
+
+      expect do
+        Steno::Sink::IO.new(io, :codec => codec, :max_retries => 2).
+          add_record(record)
+      end.to raise_error(IOError)
+    end
+
+    it "should retry on IOError and succeed" do
+      codec = double("codec")
+      expect(codec).to receive(:encode_record).with(record).and_return(record.message)
+
+      io = double("io")
+      expect(io).to receive(:write).with(record.message).once.
+        and_raise(IOError)
+      expect(io).to receive(:write).with(record.message).once.ordered.
+        and_return(record.message)
+
+      expect do
+        Steno::Sink::IO.new(io, :codec => codec, :max_retries => 1).
+          add_record(record)
+      end.to_not raise_error
+    end
+  end
+
+  describe "#flush" do
+    it "should call flush on the underlying io object" do
+      io = double("io")
+      expect(io).to receive(:flush)
+
+      Steno::Sink::IO.new(io).flush
+    end
+  end
+end

data/spec/unit/sink/syslog_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+unless Steno::Sink::WINDOWS
+  describe Steno::Sink::Syslog do
+    let(:level) do
+      Steno::Logger.lookup_level(:info)
+    end
+
+    let(:record) do
+      Steno::Record.new("source", level.name, "message")
+    end
+
+    let(:record_with_big_message) do
+      Steno::Record.new("source", level.name,
+        "a" * (Steno::Sink::Syslog::MAX_MESSAGE_SIZE + 1))
+    end
+
+    describe "#add_record" do
+      after do
+        Syslog::Logger.syslog = nil
+      end
+
+      it "should append an encoded record with the correct priority" do
+        identity = "test"
+
+        syslog = double("syslog", facility: nil)
+        expect(Syslog).to receive(:open).and_return(syslog)
+
+        sink = Steno::Sink::Syslog.instance
+        sink.open(identity)
+
+        codec = double("codec")
+        expect(codec).to receive(:encode_record).with(record).and_return(record.message)
+        sink.codec = codec
+
+        expect(syslog).to receive(:log).with(Syslog::LOG_INFO, "%s", record.message)
+
+        sink.add_record(record)
+      end
+
+      it "should truncate the record message if its greater than than allowed size" do
+        identity = "test"
+
+        syslog = double("syslog", facility: nil)
+        expect(Syslog).to receive(:open).and_return(syslog)
+
+        sink = Steno::Sink::Syslog.instance
+        sink.open(identity)
+
+        truncated = record_with_big_message.message.
+            slice(0..(Steno::Sink::Syslog::MAX_MESSAGE_SIZE) - 4)
+        truncated << Steno::Sink::Syslog::TRUNCATE_POSTFIX
+        codec = double("codec")
+        expect(codec).to receive(:encode_record) do |*args|
+          expect(args.size).to eq(1)
+          expect(args[0].message).to eq(truncated)
+          expect(args[0].message.size).to be <= Steno::Sink::Syslog::MAX_MESSAGE_SIZE
+
+          next args[0].message
+        end
+
+        sink.codec = codec
+
+        expect(syslog).to receive(:log).with(Syslog::LOG_INFO, "%s", truncated)
+
+        sink.add_record(record_with_big_message)
+      end
+    end
+
+    describe "#flush" do
+      it "should do nothing" do
+        Steno::Sink::Syslog.instance.flush
+      end
+    end
+  end
+end

data/spec/unit/steno_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+describe Steno do
+  let(:config) { Steno::Config.new }
+
+  before :each do
+    Steno.init(config)
+  end
+
+  describe "#logger" do
+    it "should return a new Steno::Logger instance" do
+      logger = Steno.logger("test")
+      expect(logger).to_not be_nil
+      expect(logger.name).to eq("test")
+    end
+
+    it "should memoize loggers by name" do
+      logger1 = Steno.logger("test")
+      logger2 = Steno.logger("test")
+
+      expect(logger1.object_id).to eq(logger2.object_id)
+    end
+  end
+
+  describe "#set_logger_regexp" do
+    it "should modify the levels of existing loggers that match the regex" do
+      logger = Steno.logger("test")
+
+      expect(logger.level).to eq(:info)
+
+      Steno.set_logger_regexp(/te/, :debug)
+
+      expect(logger.level).to eq(:debug)
+    end
+
+    it "should modify the levels of new loggers after a regexp has been set" do
+      Steno.set_logger_regexp(/te/, :debug)
+
+      expect(Steno.logger("te").level).to eq(:debug)
+    end
+
+    it "should reset the levels of previously matching loggers when changed" do
+      Steno.set_logger_regexp(/foo/, :debug)
+
+      logger = Steno.logger("foo")
+      expect(logger.level).to eq(:debug)
+
+      Steno.set_logger_regexp(/bar/, :debug)
+
+      expect(logger.level).to eq(:info)
+    end
+  end
+
+  describe "#clear_logger_regexp" do
+    it "should reset any loggers matching the existing regexp" do
+      Steno.set_logger_regexp(/te/, :debug)
+
+      logger = Steno.logger("test")
+      expect(logger.level).to eq(:debug)
+
+      Steno.clear_logger_regexp
+
+      expect(logger.level).to eq(:info)
+      expect(Steno.logger_regexp).to be_nil
+    end
+  end
+
+  describe "#logger_level_snapshot" do
+    it "should return a hash mapping logger name to level" do
+      loggers = []
+
+      expected = {
+        "foo" => :debug,
+        "bar" => :warn,
+      }
+
+      expected.each do |name, level|
+        # Prevent GC
+        loggers << Steno.logger(name)
+        loggers.last.level = level
+      end
+
+      expect(Steno.logger_level_snapshot).to eq(expected)
+    end
+  end
+end

data/spec/unit/tagged_logger_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Steno::TaggedLogger do
+  let(:sink) { NullSink.new }
+  let(:logger) { Steno::Logger.new("test", [sink]) }
+  let(:user_data) { { "foo" => "bar" } }
+  let(:tagged_logger) { Steno::TaggedLogger.new(logger, user_data) }
+
+  it "should add any user data to each log record" do
+    tagged_logger.info("testing", "test" => "data")
+    expect(sink.records.size).to eq(1)
+    expect(sink.records[0].data).to eq(user_data.merge("test" => "data"))
+
+    tagged_logger.log_exception(RuntimeError.new("hi"))
+    expect(sink.records.size).to eq(2)
+    expect(sink.records[1].data).to eq(user_data.merge(:backtrace => nil))
+  end
+
+  it "should forward missing methods to the proxied logger" do
+    expect(tagged_logger.level).to eq(:info)
+    tagged_logger.level = :warn
+
+    expect(logger.level).to eq(:warn)
+
+    expect(tagged_logger.level_active?(:info)).to be_falsey
+  end
+
+  describe "#tag" do
+    it "should return a new tagged logger with merged user-data" do
+      tl = tagged_logger.tag("bar" => "baz")
+      expect(tl.proxied_logger).to eq(logger)
+      expect(tl.user_data).to eq(user_data.merge("bar" => "baz"))
+    end
+  end
+end

data/steno-capi.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/steno/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["mpage, capi-pivot"]
+  gem.email         = ["mpage@rbcon.com, zrobinson@pivotal.io"]
+  gem.description   = "A thread-safe logging library designed to support" \
+    + " multiple log destinations. With changes to allow using syslog directly."
+  gem.summary       = "A logging library."
+  gem.homepage      = "http://www.cloudfoundry.org"
+
+  gitignore = File.readlines(".gitignore").grep(/^[^#]/).map { |s| s.chomp }
+
+  # Ignore Gemfile, this is a library
+  gitignore << "Gemfile*"
+
+  glob = Dir["**/*"].
+    reject { |f| File.directory?(f) }.
+    reject { |f| gitignore.any? { |i| File.fnmatch(i, f) } }
+
+  gem.files         = glob
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "steno-capi"
+  gem.require_paths = ["lib"]
+  gem.version       = Steno::VERSION
+
+  gem.add_dependency("yajl-ruby", "~> 1.0")
+  gem.add_dependency("fluent-logger")
+  
+  gem.add_development_dependency("rack-test")
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec", "~>3.4.0")
+  
+  if RUBY_PLATFORM=~ /mswin|mingw|cygwin/
+    gem.platform      = Gem::Platform::CURRENT
+    gem.add_dependency("win32-eventlog", "~> 0.6.0")
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: steno-capi
+version: !ruby/object:Gem::Version
+  version: 1.3.4
+platform: ruby
+authors:
+- mpage, capi-pivot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: A thread-safe logging library designed to support multiple log destinations.
+  With changes to allow using syslog directly.
+email:
+- mpage@rbcon.com, zrobinson@pivotal.io
+executables:
+- steno-prettify
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- bin/steno-prettify
+- lib/steno.rb
+- lib/steno/codec.rb
+- lib/steno/codec/base.rb
+- lib/steno/codec/json.rb
+- lib/steno/config.rb
+- lib/steno/context.rb
+- lib/steno/core_ext.rb
+- lib/steno/errors.rb
+- lib/steno/json_prettifier.rb
+- lib/steno/log_level.rb
+- lib/steno/logger.rb
+- lib/steno/record.rb
+- lib/steno/sink.rb
+- lib/steno/sink/base.rb
+- lib/steno/sink/counter.rb
+- lib/steno/sink/eventlog.rb
+- lib/steno/sink/fluentd.rb
+- lib/steno/sink/io.rb
+- lib/steno/sink/syslog.rb
+- lib/steno/tagged_logger.rb
+- lib/steno/version.rb
+- spec/spec_helper.rb
+- spec/support/barrier.rb
+- spec/support/null_sink.rb
+- spec/support/shared_context_specs.rb
+- spec/unit/config_spec.rb
+- spec/unit/context_spec.rb
+- spec/unit/core_ext_spec.rb
+- spec/unit/json_codec_spec.rb
+- spec/unit/json_prettifier_spec.rb
+- spec/unit/log_level_spec.rb
+- spec/unit/logger_spec.rb
+- spec/unit/record_spec.rb
+- spec/unit/sink/counter_spec.rb
+- spec/unit/sink/eventlog_spec.rb
+- spec/unit/sink/fluentd_spec.rb
+- spec/unit/sink/io_spec.rb
+- spec/unit/sink/syslog_spec.rb
+- spec/unit/steno_spec.rb
+- spec/unit/tagged_logger_spec.rb
+- steno-capi.gemspec
+homepage: http://www.cloudfoundry.org
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A logging library.
+test_files:
+- spec/spec_helper.rb
+- spec/support/barrier.rb
+- spec/support/null_sink.rb
+- spec/support/shared_context_specs.rb
+- spec/unit/config_spec.rb
+- spec/unit/context_spec.rb
+- spec/unit/core_ext_spec.rb
+- spec/unit/json_codec_spec.rb
+- spec/unit/json_prettifier_spec.rb
+- spec/unit/log_level_spec.rb
+- spec/unit/logger_spec.rb
+- spec/unit/record_spec.rb
+- spec/unit/sink/counter_spec.rb
+- spec/unit/sink/eventlog_spec.rb
+- spec/unit/sink/fluentd_spec.rb
+- spec/unit/sink/io_spec.rb
+- spec/unit/sink/syslog_spec.rb
+- spec/unit/steno_spec.rb
+- spec/unit/tagged_logger_spec.rb