Adding tests for HTTP_COMPRESSION => true

We are using a simple rack handling defined in the Sinatra chains that
will automatically uncompressed any request with `CONTENT_ENCODING` set
to gzip.

Fixes logstash-plugins#72

Author: ph

spec/outputs/http_spec.rb

@@ -3,6 +3,7 @@
 require "logstash/codecs/plain"
 require "thread"
 require "sinatra"
+require_relative "../supports/compressed_requests"
 
 PORT = rand(65535-1024) + 1025
 
@@ -16,8 +17,10 @@ class LogStash::Outputs::Http
 #
 # == Sinatra (v1.4.6) has taken the stage on 51572 for development with backup from WEBrick
 # == Sinatra has ended his set (crowd applauds)
-
+#
 class TestApp < Sinatra::Base
+  # on the fly uncompress gzip content
+  use CompressedRequests
 
   # disable WEBrick logging
   def self.server_settings
@@ -38,11 +41,11 @@ def self.last_request=(request)
   def self.last_request
     @last_request
   end
-  
+
   def self.retry_fail_count=(count)
     @retry_fail_count = count
   end
-  
+
   def self.retry_fail_count()
     @retry_fail_count
   end
@@ -56,10 +59,10 @@ def self.retry_fail_count()
     self.class.last_request = request
     [400, "YUP"]
   end
-  
+
   multiroute(%w(get post put patch delete), "/retry") do
     self.class.last_request = request
-    
+
     if self.class.retry_fail_count > 0
       self.class.retry_fail_count -= 1
       [429, "Will succeed in #{self.class.retry_fail_count}"]
@@ -80,7 +83,7 @@ def sinatra_run_wait(app, opts)
           app.run!(opts) do |server|
             queue.push("started")
           end
-        rescue => e 
+        rescue => e
           puts "Error in webserver thread #{e}"
           # ignore
         end
@@ -158,7 +161,7 @@ def sinatra_run_wait(app, opts)
           expect(subject).to have_received(:log_failure).with(any_args)
         end
       end
-      
+
       context "with ignorable failing requests" do
         let(:url) { "http://localhost:#{port}/bad"}
         let(:verb_behavior_config) { super.merge("ignorable_codes" => [400]) }
@@ -171,7 +174,7 @@ def sinatra_run_wait(app, opts)
           expect(subject).not_to have_received(:log_failure).with(any_args)
         end
       end
-      
+
       context "with retryable failing requests" do
         let(:url) { "http://localhost:#{port}/retry"}
 
@@ -184,12 +187,12 @@ def sinatra_run_wait(app, opts)
         it "should log a failure 2 times" do
           expect(subject).to have_received(:log_failure).with(any_args).twice
         end
-        
+
         it "should make three total requests" do
           expect(subject).to have_received(:send_event).exactly(3).times
         end
-      end  
-      
+      end
+
     end
   end
 
@@ -225,7 +228,8 @@ def sinatra_run_wait(app, opts)
     end
   end
 
-  describe "integration tests" do
+  shared_examples "integration tests" do
+    let(:base_config) { {} }
     let(:url) { "http://localhost:#{port}/good" }
     let(:event) {
       LogStash::Event.new("foo" => "bar", "baz" => "bot", "user" => "McBest")
@@ -239,7 +243,7 @@ def sinatra_run_wait(app, opts)
 
     describe "sending with the default (JSON) config" do
       let(:config) {
-        {"url" => url, "http_method" => "post", "pool_max" => 1}
+        base_config.merge({"url" => url, "http_method" => "post", "pool_max" => 1})
       }
       let(:expected_body) { LogStash::Json.dump(event) }
       let(:expected_content_type) { "application/json" }
@@ -249,7 +253,7 @@ def sinatra_run_wait(app, opts)
 
     describe "sending the event as a form" do
       let(:config) {
-        {"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "form"}
+        base_config.merge({"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "form"})
       }
       let(:expected_body) { subject.send(:encode, event.to_hash) }
       let(:expected_content_type) { "application/x-www-form-urlencoded" }
@@ -259,7 +263,7 @@ def sinatra_run_wait(app, opts)
 
     describe "sending the event as a message" do
       let(:config) {
-        {"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "message", "message" => "%{foo} AND %{baz}"}
+        base_config.merge({"url" => url, "http_method" => "post", "pool_max" => 1, "format" => "message", "message" => "%{foo} AND %{baz}"})
       }
       let(:expected_body) { "#{event.get("foo")} AND #{event.get("baz")}" }
       let(:expected_content_type) { "text/plain" }
@@ -269,7 +273,7 @@ def sinatra_run_wait(app, opts)
 
     describe "sending a mapped event" do
       let(:config) {
-        {"url" => url, "http_method" => "post", "pool_max" => 1, "mapping" => {"blah" => "X %{foo}"} }
+        base_config.merge({"url" => url, "http_method" => "post", "pool_max" => 1, "mapping" => {"blah" => "X %{foo}"} })
       }
       let(:expected_body) { LogStash::Json.dump("blah" => "X #{event.get("foo")}") }
       let(:expected_content_type) { "application/json" }
@@ -279,7 +283,7 @@ def sinatra_run_wait(app, opts)
 
     describe "sending a mapped, nested event" do
       let(:config) {
-        {
+        base_config.merge({
           "url" => url,
           "http_method" => "post",
           "pool_max" => 1,
@@ -292,7 +296,7 @@ def sinatra_run_wait(app, opts)
               "user" => "Z %{user}"
             }]
           }
-        }
+        })
       }
       let(:expected_body) {
         LogStash::Json.dump({
@@ -310,4 +314,14 @@ def sinatra_run_wait(app, opts)
       include_examples("a received event")
     end
   end
+
+  describe "integration test without gzip compression" do
+    include_examples("integration tests")
+  end
+
+  describe "integration test with gzip compression" do
+    include_examples("integration tests") do
+      let(:base_config) { { "http_compression" => true } }
+    end
+  end
 end

spec/supports/compressed_requests.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+#
+# based on relistan's rack handler
+# out of the box rack only gives use the rack deflater handler to return compressed
+# response, this gist offer the inverse and should work on all rack based app like sinatra or rails.
+#
+# original source: https://gist.github.com/relistan/2109707
+require "zlib"
+
+class CompressedRequests
+  def initialize(app)
+    @app = app
+  end
+
+  def encoding_handled?(env)
+    ['gzip', 'deflate'].include? env['HTTP_CONTENT_ENCODING']
+  end
+
+  def call(env)
+    if encoding_handled?(env)
+      extracted = decode(env['rack.input'], env['HTTP_CONTENT_ENCODING'])
+
+      env.delete('HTTP_CONTENT_ENCODING')
+      env['CONTENT_LENGTH'] = extracted.bytesize
+      env['rack.input'] = StringIO.new(extracted)
+    end
+
+    status, headers, response = @app.call(env)
+    return [status, headers, response]
+  end
+
+  def decode(input, content_encoding)
+    case content_encoding
+      when 'gzip' then Zlib::GzipReader.new(input).read
+      when 'deflate' then Zlib::Inflate.inflate(input.read)
+    end
+  end
+end