stomp_parser 1.0.0

data/spec/benchmarks/message_bench.rb

@@ -0,0 +1,50 @@
+require_relative "../bench_helper"
+
+describe "Frame#to_str minimal" do |bench|
+  bench.setup do
+    @frame = StompParser::Frame.new("CONNECT", nil)
+  end
+
+  bench.code { @frame.to_str }
+
+  bench.assert do |frame_str|
+    frame_str == "CONNECT\ncontent-length:0\n\n\x00"
+  end
+end
+
+describe "Frame#to_str with header" do |bench|
+  bench.setup do
+    @frame = StompParser::Frame.new("CONNECT", { "heart-beat" => "0,0" }, nil)
+  end
+
+  bench.code { @frame.to_str }
+
+  bench.assert do |frame_str|
+    frame_str == "CONNECT\nheart-beat:0,0\ncontent-length:0\n\n\x00"
+  end
+end
+
+describe "Frame#to_str with headers and small body" do |bench|
+  bench.setup do
+    @frame = StompParser::Frame.new("CONNECT", { "some" => "header" }, "body")
+  end
+
+  bench.code { @frame.to_str }
+
+  bench.assert do |frame_str|
+    frame_str == "CONNECT\nsome:header\ncontent-length:4\n\nbody\x00"
+  end
+end
+
+describe "Frame#to_str with headers and large body" do |bench|
+  bench.setup do
+    large_binary = "b\x00" * 2 # make room for headers
+    @frame = StompParser::Frame.new("CONNECT", { "some" => "header" }, large_binary)
+  end
+
+  bench.code { @frame.to_str }
+
+  bench.assert do |frame_str|
+    frame_str == "CONNECT\nsome:header\ncontent-length:#{@frame.body.bytesize}\n\n#{@frame.body}\x00"
+  end
+end

data/spec/benchmarks/parser_bench.rb

@@ -0,0 +1,43 @@
+require_relative "../bench_helper"
+
+def parse_one(parser, data)
+  frame = nil
+  parser.parse(data) { |m| frame = m }
+  frame
+end
+
+%w[CParser JavaParser RubyParser].each do |parser|
+  parser = begin
+    StompParser.const_get(parser)
+  rescue NameError
+    next
+  end
+
+  describe "#{parser}: minimal" do |bench|
+    bench.setup do
+      @parser = parser.new
+      @frame = "CONNECT\n\n\x00"
+    end
+
+    bench.code { parse_one(@parser, @frame) }
+  end
+
+  describe "#{parser}: headers and small body" do |bench|
+    bench.setup do
+      @parser = parser.new
+      @frame = "CONNECT\ncontent-length:4\n\nbody\x00"
+    end
+
+    bench.code { parse_one(@parser, @frame) }
+  end
+
+  describe "#{parser}: headers and large body" do |bench|
+    bench.setup do
+      @parser = parser.new
+      large_body = ("b" * (StompParser.max_frame_size - 50)) # make room for headers
+      @frame = "CONNECT\ncontent-length:#{large_body.bytesize}\n\n#{large_body}\x00"
+    end
+
+    bench.code { parse_one(@parser, @frame) }
+  end
+end

data/spec/profile.rb

@@ -0,0 +1,27 @@
+require "bundler/setup"
+require "stomp_parser"
+require "perftools"
+
+parser = StompParser::Parser.new
+body_size = (1024 * 99) / 2
+large_binary = "b\x00" * body_size # make room for headers
+data = <<-MESSAGE
+CONNECT
+content-length:#{large_binary.bytesize}
+
+#{large_binary}\x00
+MESSAGE
+stream = data + data + data + data
+
+profile_output = File.expand_path("./profile/parser.profile", File.dirname(__FILE__))
+PerfTools::CpuProfiler.start(profile_output) do
+  i = 100
+  loop do
+    parser.parse(data) do |frame|
+      # no op
+    end
+
+    i -= 1
+    break if i <= 0
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "bundler/setup"
+require "stomp_parser"
+require "pry"
+require "timeout"
+
+require "support/shared_parser_examples"

data/spec/stomp_parser/c_parser_spec.rb

@@ -0,0 +1,5 @@
+if defined?(StompParser::CParser)
+  describe StompParser::CParser do
+    it_behaves_like "a stomp_parser parser"
+  end
+end

data/spec/stomp_parser/java_parser_spec.rb

@@ -0,0 +1,5 @@
+if defined?(StompParser::JavaParser)
+  describe StompParser::JavaParser do
+    it_behaves_like "a stomp_parser parser"
+  end
+end

data/spec/stomp_parser/message_spec.rb

@@ -0,0 +1,50 @@
+describe StompParser::Frame do
+  describe "#content_length" do
+    it "returns content length if available" do
+      frame = StompParser::Frame.new("CONNECT", { "content-length" => "1337" }, nil)
+      frame.content_length.should eq 1337
+    end
+
+    it "returns nil if no content length defined" do
+      frame = StompParser::Frame.new("CONNECT", nil)
+      frame.content_length.should be_nil
+    end
+
+    it "raises an error if invalid content length defined" do
+      frame = StompParser::Frame.new("CONNECT", { "content-length" => "LAWL" }, nil)
+      expect { frame.content_length }.to raise_error(StompParser::Error, /invalid content length "LAWL"/)
+    end
+  end
+
+  describe "#to_str" do
+    specify "frame with command only" do
+      frame = StompParser::Frame.new("CONNECT", nil)
+      frame.to_str.should eq "CONNECT\ncontent-length:0\n\n\x00"
+    end
+
+    specify "frame with with headers" do
+      frame = StompParser::Frame.new("CONNECT", { "moo" => "cow", "boo" => "hoo" }, nil)
+      frame.to_str.should eq "CONNECT\nmoo:cow\nboo:hoo\ncontent-length:0\n\n\x00"
+    end
+
+    specify "frame with with body" do
+      frame = StompParser::Frame.new("CONNECT", "this is a body")
+      frame.to_str.should eq "CONNECT\ncontent-length:14\n\nthis is a body\x00"
+    end
+
+    specify "frame with escapeable characters in headers" do
+      frame = StompParser::Frame.new("CONNECT", { "k\\\n\r:" => "v\\\n\r:" }, nil)
+      frame.to_str.should eq "CONNECT\nk\\\\\\n\\r\\c:v\\\\\\n\\r\\c\ncontent-length:0\n\n\x00"
+    end
+
+    specify "frame with binary body" do
+      frame = StompParser::Frame.new("CONNECT", "\x00ab\x00")
+      frame.to_str.should eq "CONNECT\ncontent-length:4\n\n\x00ab\x00\x00"
+    end
+
+    specify "overrides user-specified content-length" do
+      frame = StompParser::Frame.new("CONNECT", { "content-length" => "10" }, "\x00ab\x00")
+      frame.to_str.should eq "CONNECT\ncontent-length:4\n\n\x00ab\x00\x00"
+    end
+  end
+end

data/spec/stomp_parser/ruby_parser_spec.rb

@@ -0,0 +1,3 @@
+describe StompParser::RubyParser do
+  it_behaves_like "a stomp_parser parser"
+end

data/spec/stomp_parser_spec.rb

@@ -0,0 +1,9 @@
+describe StompParser do
+  specify { defined?(StompParser::VERSION).should be_true }
+
+  describe ".max_frame_size" do
+    it "has a sane default value" do
+      StompParser.max_frame_size.should be_a(Fixnum)
+    end
+  end
+end

data/spec/support/shared_parser_examples.rb

@@ -0,0 +1,268 @@
+# encoding: UTF-8
+RSpec.shared_examples_for "a stomp_parser parser" do
+  let(:parser) { described_class.new }
+
+  context "#parse" do
+    def parse_all(data)
+      frames = []
+      parser.parse(data) { |m| frames << m }
+      frames
+    end
+
+    it "parses frame as binary" do
+      frames = parse_all("CONNECT\n\n\x00")
+      frames.length.should eq(1)
+      frames[0].command.encoding.should eq Encoding::BINARY
+    end
+
+    context "command" do
+      it "can parse commands" do
+        frames = parse_all("CONNECT\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].command.should eq("CONNECT")
+      end
+    end
+
+    context "headers" do
+      it "can parse simple headers" do
+        frames = parse_all("CONNECT\nmoo:cow\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].headers.should eq("moo" => "cow")
+      end
+
+      it "can parse multiple headers" do
+        frames = parse_all("CONNECT\nmoo:cow\nbaah:sheep\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].headers.should eq("moo" => "cow", "baah" => "sheep")
+      end
+
+      it "can parse headers with NULLs in them" do
+        frames = parse_all("CONNECT\nnull\x00:null\x00\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].headers.should eq("null\x00" => "null\x00")
+      end
+
+      it "can parse headers with escape characters" do
+        frames = parse_all("CONNECT\nnull\\c:\\r\\n\\c\\\\\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].headers.should eq("null:" => "\r\n:\\")
+      end
+
+      it "can parse headers with no value" do
+        frames = parse_all("CONNECT\nmoo:\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].headers.should eq("moo" => nil)
+      end
+
+      it "nullifies previous headers" do
+        frames = parse_all("CONNECT\nmoo:\nmoo:hello\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].headers.should eq("moo" => nil)
+      end
+
+      it "prioritises first header when given multiple of same key" do
+        frames = parse_all("CONNECT\nkey:first\nkey:second\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].headers.should eq("key" => "first")
+      end
+
+      it "parses multibyte headers as UTF-8 even if content type specifies something else" do
+        frames = parse_all("MESSAGE\ncontent-type:text/plain;charset=ISO-8859-1\nwhät:üp\n\n\x00")
+        frames.length.should eq(1)
+
+        key, value = frames[0].headers.to_a[1]
+
+        key.should eq "wh\xC3\xA4t".force_encoding("UTF-8")
+        key.encoding.should eq Encoding::UTF_8
+
+        value.should eq "\xC3\xBCp".force_encoding("UTF-8")
+        value.encoding.should eq Encoding::UTF_8
+      end
+    end
+
+    context "body" do
+      it "can parse body" do
+        frames = parse_all("CONNECT\n\nbody\x00")
+        frames.length.should eq(1)
+        frames[0].body.should eq "body"
+      end
+
+      it "can parse binary body" do
+        frames = parse_all("CONNECT\ncontent-length:5\n\nbo\x00dy\x00")
+        frames.length.should eq(1)
+        frames[0].body.should eq "bo\x00dy"
+      end
+
+      it "parses body as binary string when no content-type given" do
+        frames = parse_all("MESSAGE\n\nWhat üp\x00")
+        frames.length.should eq(1)
+        frames[0].body.should eq "What \xC3\xBCp".force_encoding("BINARY")
+        frames[0].body.encoding.should eq Encoding::BINARY
+      end
+
+      it "parses body as encoded string when content-type is a text type and charset is given" do
+        frames = parse_all("MESSAGE\ncontent-type:text/plain;charset=ISO-8859-1\n\nWhat \xFCp\x00")
+        frames.length.should eq(1)
+        frames[0].body.should eq "What \xFCp".force_encoding("iso-8859-1")
+        frames[0].body.encoding.should eq Encoding::ISO_8859_1
+      end
+
+      it "parses body as encoded string when content-type is not a text type and charset is given" do
+        frames = parse_all("MESSAGE\ncontent-type:application/octet-stream;charset=ISO-8859-1\n\nWhat \xFCp\x00")
+        frames.length.should eq(1)
+        frames[0].body.should eq "What \xFCp".force_encoding("iso-8859-1")
+        frames[0].body.encoding.should eq Encoding::ISO_8859_1
+      end
+
+      it "parses body as utf-8 encoded string when content-type is a text type and charset is not given" do
+        frames = parse_all("MESSAGE\ncontent-type:text/plain\n\nWhat üp\x00")
+        frames.length.should eq(1)
+        frames[0].body.should eq "What \xC3\xBCp".force_encoding("UTF-8")
+        frames[0].body.encoding.should eq Encoding::UTF_8
+      end
+
+      it "parses body as binary string when content-type is not a text type and charset is not given" do
+        frames = parse_all("MESSAGE\ncontent-type:application/octet-stream\n\nWhat \xFCp\x00")
+        frames.length.should eq(1)
+        frames[0].body.should eq "What \xFCp".force_encoding("BINARY")
+        frames[0].body.encoding.should eq Encoding::BINARY
+      end
+    end
+
+    context "multiple frames" do
+      it "yields multiple frames in a single invocation" do
+        frames = parse_all("CONNECT\n\n\x00CONNECT\n\n\x00CONNECT\n\n\x00")
+        frames.length.should eq(3)
+        frames.map(&:command).should eq %w[CONNECT CONNECT CONNECT]
+        frames.uniq.length.should eq(3)
+      end
+
+      it "allows newlines between frames" do
+        frames = parse_all("\n\r\n\nCONNECT\n\n\x00\n\n\r\nCONNECT\n\n\x00\n\n")
+        frames.length.should eq(2)
+        frames.map(&:command).should eq %w[CONNECT CONNECT]
+        frames.uniq.length.should eq(2)
+      end
+    end
+
+    context "multiple invocations" do
+      it "parses simple split up frames" do
+        frames = parse_all("CONNECT\n")
+        frames.should be_empty
+
+        frames = parse_all("\n\x00")
+        frames.length.should eq(1)
+        frames[0].command.should eq "CONNECT"
+      end
+
+      it "parses frames split across buffer markings" do
+        frames = parse_all("\n\nCONN")
+        frames.should be_empty
+
+        frames = parse_all("ECT\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].command.should eq "CONNECT"
+      end
+
+      it "parses frames split across header keys" do
+        frames = parse_all("CONNECT\nheader:")
+        frames.should be_empty
+
+        frames = parse_all("value\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].command.should eq "CONNECT"
+        frames[0].headers.should eq("header" => "value")
+      end
+
+      it "parses binary frame split across body" do
+        frames = parse_all("CONNECT\ncontent-length:4\n\n\x00a")
+        frames.should be_empty
+
+        frames = parse_all("b\x00\x00")
+        frames.length.should eq(1)
+        frames[0].command.should eq "CONNECT"
+        frames[0].body.should eq("\x00ab\x00")
+      end
+
+      it "parses frames split across frames" do
+        frames = parse_all("CONNECT\n")
+        frames.should be_empty
+
+        frames = parse_all("\n\x00CONNEC")
+        frames.length.should eq(1)
+        frames[0].command.should eq "CONNECT"
+
+        frames = parse_all("T\n\n\x00")
+        frames.length.should eq(1)
+        frames[0].command.should eq "CONNECT"
+      end
+    end
+
+    context "fails on invalid frames" do
+      specify "no block given" do
+        expect { parser.parse("CONNECT\n\n\x00") }.to raise_error(LocalJumpError)
+      end
+
+      specify "invalid command" do
+        expect { parser.parse("CONNET\n\n\x00") }.to raise_error(StompParser::ParseError)
+      end
+
+      specify "unfinished command" do
+        expect { parser.parse("CONNECT\x00") }.to raise_error(StompParser::ParseError)
+      end
+
+      specify "header with colon" do
+        expect { parser.parse("CONNECT\nfoo: :bar\n\n\x00") }.to raise_error(StompParser::ParseError)
+      end
+
+      specify "header with invalid escape" do
+        expect { parser.parse("CONNECT\nfoo:\\t\n\n\x00") }.to raise_error(StompParser::ParseError)
+      end
+
+      specify "body longer than content length" do
+        expect { parser.parse("CONNECT\ncontent-length:0\n\nx\x00") }.to raise_error(StompParser::ParseError)
+      end
+
+      specify "invalid content length" do
+        expect { parser.parse("CONNECT\ncontent-length:LAWL\n\nx\x00") }.to raise_error(StompParser::Error, /invalid content length "LAWL"/)
+      end
+
+      specify "re-trying invocation after an error" do
+        first_error = begin
+          parser.parse("CONNET")
+        rescue StompParser::ParseError => ex
+          ex
+        end
+
+        first_error.should be_a(StompParser::ParseError)
+
+        second_error = begin
+          parser.parse("")
+        rescue StompParser::ParseError => ex
+          ex
+        end
+
+        second_error.should eql(first_error)
+      end
+
+      specify "total size bigger than global max frame size setting" do
+        StompParser.stub(:max_frame_size => 30)
+        parser = described_class.new
+        parser.parse("CONNECT\n") # 8
+        parser.parse("header:value\n") # 21
+        expect {
+          parser.parse("other:val\n") # 31
+        }.to raise_error(StompParser::FrameSizeExceeded)
+      end
+
+      specify "total size bigger than local max frame size setting" do
+        parser = described_class.new(max_frame_size = 30)
+        parser.parse("CONNECT\n") # 8
+        parser.parse("header:value\n") # 21
+        expect {
+          parser.parse("other:val\n") # 31
+        }.to raise_error(StompParser::FrameSizeExceeded)
+      end
+    end
+  end
+end