loggregator_emitter 2.0.0 → 2.0.3

data/lib/loggregator_emitter/emit.rb

@@ -1,7 +1,11 @@
 require 'socket'
+require 'resolv'
 
 module LoggregatorEmitter
   class Emitter
+
+    attr_reader :host
+
     MAX_MESSAGE_BYTE_SIZE = (9 * 1024) - 512
     TRUNCATED_STRING = "TRUNCATED"
 
@@ -16,9 +20,13 @@ module LoggregatorEmitter
 
     def initialize(loggregator_server, source_type_or_name, source_id = nil, secret=nil)
       @host, @port = loggregator_server.split(/:([^:]*$)/)
+
       raise ArgumentError, "Must provide valid loggregator server: #{loggregator_server}" if !valid_hostname || !valid_port
       raise ArgumentError, "Must provide valid source_type_or_name: #{source_type_or_name}" unless source_type_or_name
 
+      @host = ::Resolv.getaddresses(@host).last
+      raise ArgumentError, "Must provide valid loggregator server: #{loggregator_server}" unless @host
+
       case source_type_or_name
         when LogMessage::SourceType::CLOUD_CONTROLLER..LogMessage::SourceType::LOGGREGATOR
           @source_type = source_type_or_name
@@ -50,7 +58,7 @@ module LoggregatorEmitter
     end
 
     def valid_hostname
-      @host && !@host.match(/:\/\//)
+      @host && !@host.empty? && !@host.match(/:\/\//)
     end
 
     def split_message(message)

data/loggregator_emitter.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "loggregator_emitter"
-  spec.version       = '2.0.0'
+  spec.version       = '2.0.3'
   spec.authors       = ["Pivotal"]
   spec.email         = ["cf-eng@pivotallabs.com"]
   spec.description   = "Library to emit data to Loggregator"

data/spec/loggregator_emitter/emit_performance_spec.rb

@@ -16,35 +16,20 @@ class MessageFixture
   end
 end
 
-class FreePort
-  def self.next_free_port
-    @@next_free_port ||= 12345
-    @@next_free_port += 1
-  end
-end
-
 shared_examples "a performance test" do |fixture, using_server|
-  let(:free_port) { FreePort.next_free_port }
   let(:iterations) { using_server ? 100 : 1000 }
-  subject(:emitter) { LoggregatorEmitter::Emitter.new("localhost:#{free_port}", "API", 42, "my-secret") }
 
   before do
-    if using_server
-      @server = FakeLoggregatorServer.new(free_port)
-      @server.start
-    else
-      emitter.should_receive(:send_protobuffer).at_least(iterations).times
+    @emitter = LoggregatorEmitter::Emitter.new("localhost:#{@free_port}", "API", 42, "my-secret")
+    if !using_server
+      @emitter.should_receive(:send_protobuffer).at_least(iterations).times
     end
   end
 
-  after do
-    @server.stop if using_server
-  end
-
   it "emits #{fixture.name} within a time threshold #{using_server ? 'with' : 'without'} server" do
     start_time = Time.now.to_f
 
-    iterations.times { emitter.emit("my_app_id", fixture.message) }
+    iterations.times { @emitter.emit("my_app_id", fixture.message) }
 
     expect(Time.now.to_f - start_time).to be < fixture.expected(using_server)
   end
@@ -57,6 +42,17 @@ describe LoggregatorEmitter do
   @fixtures << MessageFixture.new("message with newlines", 10.times.collect { (6*1024).times.collect { "a" }.join("") + "\n" }.join(""), 3.0, 3.0)
   @fixtures << MessageFixture.new("message worst case", (124*1024).times.collect { "a" }.join("") + "\n", 2.0, 2.0)
 
+  before :all do
+    @free_port = 12346
+    @server = FakeLoggregatorServer.new(@free_port)
+    @server.start
+  end
+
+  after :all do
+    @server.stop
+  end
+
+
   [true, false].each do |using_server|
     @fixtures.each do |fixture|
       it_behaves_like "a performance test", fixture, using_server

data/spec/loggregator_emitter/emit_spec.rb

@@ -2,14 +2,19 @@ require "support/fake_loggregator_server"
 require "loggregator_emitter"
 
 describe LoggregatorEmitter do
-  class FreePort
-    def self.next_free_port
-      @@next_free_port ||= 12345
-      @@next_free_port += 1
-    end
+
+  before :all do
+    @free_port = 12345
+    @server = FakeLoggregatorServer.new(@free_port)
+    @server.start
+  end
+
+  after :all do
+    @server.stop
   end
-  let(:free_port) do
-    FreePort.next_free_port
+
+  before do
+    @server.reset
   end
 
   describe "configuring emitter" do
@@ -22,12 +27,8 @@ describe LoggregatorEmitter do
         expect { LoggregatorEmitter::Emitter.new("localhost:12345", LogMessage::SourceType::DEA) }.not_to raise_error
       end
 
-      it "is valid if a server name is given" do
-        expect { LoggregatorEmitter::Emitter.new("some-unknown-address:12345", LogMessage::SourceType::DEA) }.not_to raise_error
-      end
-
       it "accepts a string as source type/name" do
-        expect { LoggregatorEmitter::Emitter.new("some-unknown-address:12345", "STG") }.not_to raise_error
+        expect { LoggregatorEmitter::Emitter.new("localhost:12345", "STG") }.not_to raise_error
       end
     end
 
@@ -37,21 +38,29 @@ describe LoggregatorEmitter do
           expect { LoggregatorEmitter::Emitter.new("http://0.0.0.0:12345", LogMessage::SourceType::DEA) }.to raise_error(ArgumentError)
         end
 
+        it "raises if host is blank" do
+          expect { LoggregatorEmitter::Emitter.new(":12345", LogMessage::SourceType::DEA) }.to raise_error(ArgumentError)
+        end
+
+        it "raises if host is unresolvable" do
+          expect { LoggregatorEmitter::Emitter.new("i.cant.resolve.foo:12345", LogMessage::SourceType::DEA) }.to raise_error(ArgumentError)
+        end
+
         it "raises if source is an unknown integer" do
-          expect { LoggregatorEmitter::Emitter.new("some-unknown-address:12345", 7) }.to raise_error(ArgumentError)
+          expect { LoggregatorEmitter::Emitter.new("localhost:12345", 7) }.to raise_error(ArgumentError)
         end
 
         it "raises if source is not an integer or string" do
-          expect { LoggregatorEmitter::Emitter.new("some-unknown-address:12345", nil) }.to raise_error(ArgumentError)
-          expect { LoggregatorEmitter::Emitter.new("some-unknown-address:12345", 12.0) }.to raise_error(ArgumentError)
+          expect { LoggregatorEmitter::Emitter.new("localhost:12345", nil) }.to raise_error(ArgumentError)
+          expect { LoggregatorEmitter::Emitter.new("localhost:12345", 12.0) }.to raise_error(ArgumentError)
         end
 
         it "raises if source is too large of a string" do
-          expect { LoggregatorEmitter::Emitter.new("some-unknown-address:12345", "ABCD") }.to raise_error(ArgumentError)
+          expect { LoggregatorEmitter::Emitter.new("localhost:12345", "ABCD") }.to raise_error(ArgumentError)
         end
 
         it "raises if source is too small of a string" do
-          expect { LoggregatorEmitter::Emitter.new("some-unknown-address:12345", "AB") }.to raise_error(ArgumentError)
+          expect { LoggregatorEmitter::Emitter.new("localhost:12345", "AB") }.to raise_error(ArgumentError)
         end
       end
     end
@@ -60,16 +69,7 @@ describe LoggregatorEmitter do
 
   describe "emit_log_envelope" do
     def make_emitter(host)
-      LoggregatorEmitter::Emitter.new("#{host}:#{free_port}", LogMessage::SourceType::CLOUD_CONTROLLER, 42, "secret")
-    end
-
-    before do
-      @server = FakeLoggregatorServer.new(free_port)
-      @server.start
-    end
-
-    after do
-      @server.stop
+      LoggregatorEmitter::Emitter.new("#{host}:#{@free_port}", LogMessage::SourceType::CLOUD_CONTROLLER, 42, "secret")
     end
 
     it "successfully writes envelope protobuffers" do
@@ -114,20 +114,11 @@ describe LoggregatorEmitter do
   {"emit" => LogMessage::MessageType::OUT, "emit_error" => LogMessage::MessageType::ERR}.each do |emit_method, message_type|
     describe "##{emit_method}" do
       def make_emitter(host)
-        LoggregatorEmitter::Emitter.new("#{host}:#{free_port}", LogMessage::SourceType::CLOUD_CONTROLLER, 42)
-      end
-
-      before do
-        @server = FakeLoggregatorServer.new(free_port)
-        @server.start
-      end
-
-      after do
-        @server.stop
+        LoggregatorEmitter::Emitter.new("#{host}:#{@free_port}", LogMessage::SourceType::CLOUD_CONTROLLER, 42)
       end
 
       it "successfully writes protobuffers using ipv4" do
-        emitter = make_emitter("0.0.0.0")
+        emitter = make_emitter("127.0.0.1")
         emitter.send(emit_method, "my_app_id", "Hello there!")
         emitter.send(emit_method, "my_app_id", "Hello again!")
         emitter.send(emit_method, nil, "Hello again!")
@@ -208,14 +199,6 @@ describe LoggregatorEmitter do
   end
 
   describe "source" do
-    before do
-      @server = FakeLoggregatorServer.new(free_port)
-      @server.start
-    end
-
-    after do
-      @server.stop
-    end
 
     let(:emit_message) do
       @emitter.emit_error("my_app_id", "Hello there!")
@@ -226,28 +209,28 @@ describe LoggregatorEmitter do
     end
 
     it "when type is known" do
-      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{free_port}", LogMessage::SourceType::CLOUD_CONTROLLER)
+      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{@free_port}", LogMessage::SourceType::CLOUD_CONTROLLER)
       expect(emit_message.source_name).to eq "CLOUD_CONTROLLER"
     end
 
     it "when type is unknown" do
-      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{free_port}", "STG")
+      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{@free_port}", "STG")
       expect(emit_message.source_name).to eq "STG"
       expect(emit_message.source_type).to eq LogMessage::SourceType::UNKNOWN
     end
 
     it "id can be nil" do
-      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{free_port}", LogMessage::SourceType::CLOUD_CONTROLLER)
+      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{@free_port}", LogMessage::SourceType::CLOUD_CONTROLLER)
       expect(emit_message.source_id).to eq nil
     end
 
     it "id can be passed in as a string" do
-      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{free_port}", LogMessage::SourceType::CLOUD_CONTROLLER, "some_source_id")
+      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{@free_port}", LogMessage::SourceType::CLOUD_CONTROLLER, "some_source_id")
       expect(emit_message.source_id).to eq "some_source_id"
     end
 
     it "id can be passed in as an integer" do
-      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{free_port}", LogMessage::SourceType::CLOUD_CONTROLLER, 13)
+      @emitter = LoggregatorEmitter::Emitter.new("0.0.0.0:#{@free_port}", LogMessage::SourceType::CLOUD_CONTROLLER, 13)
       expect(emit_message.source_id).to eq "13"
     end
   end

data/spec/support/fake_loggregator_server.rb

@@ -6,6 +6,7 @@ class FakeLoggregatorServer
   attr_reader :messages, :port
 
   def initialize(port)
+
     @messages = []
     @port = port
 
@@ -15,7 +16,7 @@ class FakeLoggregatorServer
   end
 
   def start
-    bind_and_record(0, @sockets[0], "localhost")
+    bind_and_record(0, @sockets[0], "127.0.0.1")
     bind_and_record(0, @sockets[1], "::1")
   end
 
@@ -33,10 +34,14 @@ class FakeLoggregatorServer
     @threads.each { |thread| Thread.kill(thread) }
   end
 
+  def reset
+    @messages = []
+  end
+
   private
 
   def bind_and_record(index, socket, server)
-    socket.bind(server, port)
+    socket.bind(server, @port)
 
     @threads[index] = Thread.new do
       while true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggregator_emitter
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beefcake
@@ -119,9 +119,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 584721548114788876
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25