puffing-billy 2.4.1 → 3.0.1

data/spec/lib/proxy_spec.rb

@@ -1,431 +0,0 @@
-require 'spec_helper'
-require 'resolv'
-
-shared_examples_for 'a proxy server' do
-  it 'should proxy GET requests' do
-    expect(http.get('/echo').body).to eql 'GET /echo'
-  end
-
-  it 'should proxy POST requests' do
-    expect(http.post('/echo', foo: 'bar').body).to eql "POST /echo\nfoo=bar"
-  end
-
-  it 'should proxy PUT requests' do
-    expect(http.post('/echo', foo: 'bar').body).to eql "POST /echo\nfoo=bar"
-  end
-
-  it 'should proxy HEAD requests' do
-    expect(http.head('/echo').headers['HTTP-X-EchoServer']).to eql 'HEAD /echo'
-  end
-
-  it 'should proxy DELETE requests' do
-    expect(http.delete('/echo').body).to eql 'DELETE /echo'
-  end
-
-  it 'should proxy OPTIONS requests' do
-    expect(http.run_request(:options, '/echo', nil, nil).body).to eql 'OPTIONS /echo'
-  end
-end
-
-shared_examples_for 'a request stub' do
-  it 'should stub GET requests' do
-    proxy.stub("#{url}/foo")
-      .and_return(text: 'hello, GET!')
-    expect(http.get('/foo').body).to eql 'hello, GET!'
-  end
-
-  it 'should stub GET response statuses' do
-    proxy.stub("#{url}/foo")
-      .and_return(code: 200)
-    expect(http.get('/foo').status).to eql 200
-  end
-
-  it 'should stub POST requests' do
-    proxy.stub("#{url}/bar", method: :post)
-      .and_return(text: 'hello, POST!')
-    expect(http.post('/bar', foo: :bar).body).to eql 'hello, POST!'
-  end
-
-  it 'should stub PUT requests' do
-    proxy.stub("#{url}/baz", method: :put)
-      .and_return(text: 'hello, PUT!')
-    expect(http.put('/baz', foo: :bar).body).to eql 'hello, PUT!'
-  end
-
-  it 'should stub HEAD requests' do
-    proxy.stub("#{url}/bap", method: :head)
-      .and_return(headers: { 'HTTP-X-Hello' => 'hello, HEAD!' })
-    expect(http.head('/bap').headers['http-x-hello']).to eql 'hello, HEAD!'
-  end
-
-  it 'should stub DELETE requests' do
-    proxy.stub("#{url}/bam", method: :delete)
-      .and_return(text: 'hello, DELETE!')
-    expect(http.delete('/bam').body).to eql 'hello, DELETE!'
-  end
-
-  it 'should stub OPTIONS requests' do
-    proxy.stub("#{url}/bim", method: :options)
-      .and_return(text: 'hello, OPTIONS!')
-    expect(http.run_request(:options, '/bim', nil, nil).body).to eql 'hello, OPTIONS!'
-  end
-
-  it 'should expose the currently registered stubs' do
-    stub1 = proxy.stub("#{url}/foo", method: :options)
-      .and_return(text: 'hello, OPTIONS!')
-    stub2 = proxy.stub("#{url}/bar", method: :options)
-              .and_return(text: 'hello, OPTIONS!')
-    expect(proxy.stubs).to eql([stub2, stub1])
-  end
-end
-
-shared_examples_for 'a cache' do
-  context 'whitelisted GET requests' do
-    it 'should not be cached' do
-      assert_noncached_url
-    end
-
-    context 'with ports' do
-      before do
-        rack_app_url = URI(http.url_prefix)
-        Billy.config.whitelist = ["#{rack_app_url.host}:#{rack_app_url.port}"]
-      end
-
-      it 'should not be cached ' do
-        assert_noncached_url
-      end
-    end
-  end
-
-  context 'non-whitelisted GET requests' do
-    before do
-      Billy.config.whitelist = []
-    end
-
-    it 'should be cached' do
-      assert_cached_url
-    end
-
-    context 'with ports' do
-      before do
-        rack_app_url = URI(http.url_prefix)
-        Billy.config.whitelist = ["#{rack_app_url.host}:#{rack_app_url.port + 1}"]
-      end
-
-      it 'should be cached' do
-        assert_cached_url
-      end
-    end
-  end
-
-  context 'cache_whitelist GET requests' do
-    before do
-      Billy.config.whitelist = [http.host]
-      Billy.config.cache_whitelist = [http.host]
-    end
-
-    it 'should be cached' do
-      assert_cached_url
-    end
-
-    context 'with ports' do
-      before do
-        rack_app_url = URI(http.url_prefix)
-        Billy.config.whitelist = ["#{rack_app_url.host}:#{rack_app_url.port + 1}"]
-        Billy.config.cache_whitelist = Billy.config.whitelist
-      end
-
-      it 'should be cached' do
-        assert_cached_url
-      end
-    end
-  end
-
-  context 'ignore_params GET requests' do
-    before do
-      Billy.config.ignore_params = ['/analytics']
-    end
-
-    it 'should be cached' do
-      r = http.get('/analytics?some_param=5')
-      expect(r.body).to eql 'GET /analytics'
-      expect do
-        expect do
-          r = http.get('/analytics?some_param=20')
-        end.to change { r.headers['HTTP-X-EchoCount'].to_i }.by(1)
-      end.to_not change { r.body }
-    end
-  end
-
-  context 'path_blacklist GET requests' do
-    before do
-      Billy.config.path_blacklist = ['/api']
-    end
-
-    it 'should be cached' do
-      assert_cached_url('/api')
-    end
-
-    context 'path_blacklist includes regex' do
-      before do
-        Billy.config.path_blacklist = [/widgets$/]
-      end
-
-      it 'should not cache a non-match' do
-        assert_noncached_url('/widgets/5/edit')
-      end
-
-      it 'should cache a match' do
-        assert_cached_url('/widgets')
-      end
-    end
-  end
-
-  context 'cache persistence' do
-    let(:cache_path) { Billy.config.cache_path }
-    let(:cached_key) { proxy.cache.key('get', "#{url}/foo", '') }
-    let(:cached_file) do
-      f = cached_key + '.yml'
-      File.join(cache_path, f)
-    end
-
-    before do
-      Billy.config.whitelist = []
-      Dir.mkdir(cache_path) unless Dir.exist?(cache_path)
-    end
-
-    after do
-      File.delete(cached_file) if File.exist?(cached_file)
-    end
-
-    context 'enabled' do
-      before { Billy.config.persist_cache = true }
-
-      it 'should persist' do
-        http.get('/foo')
-        expect(File.exist?(cached_file)).to be true
-      end
-
-      it 'should be read initially from persistent cache' do
-        File.open(cached_file, 'w') do |f|
-          cached = {
-            headers: {},
-            content: 'GET /foo cached'
-          }
-          f.write(cached.to_yaml(Encoding: :Utf8))
-        end
-
-        r = http.get('/foo')
-        expect(r.body).to eql 'GET /foo cached'
-      end
-
-      context 'cache_request_headers requests' do
-        it 'should not be cached by default' do
-          http.get('/foo')
-          saved_cache = Billy.proxy.cache.fetch_from_persistence(cached_key)
-          expect(saved_cache.keys).not_to include :request_headers
-        end
-
-        context 'when enabled' do
-          before do
-            Billy.config.cache_request_headers = true
-          end
-
-          it 'should be cached' do
-            http.get('/foo')
-            saved_cache = Billy.proxy.cache.fetch_from_persistence(cached_key)
-            expect(saved_cache.keys).to include :request_headers
-          end
-        end
-      end
-
-      context 'ignore_cache_port requests' do
-        it 'should be cached without port' do
-          r   = http.get('/foo')
-          url = URI(r.env[:url])
-          saved_cache = Billy.proxy.cache.fetch_from_persistence(cached_key)
-
-          expect(saved_cache[:url]).to_not eql(url.to_s)
-          expect(saved_cache[:url]).to eql(url.to_s.gsub(":#{url.port}", ''))
-        end
-      end
-
-      context 'non_whitelisted_requests_disabled requests' do
-        before { Billy.config.non_whitelisted_requests_disabled = true }
-
-        it 'should raise error when disabled' do
-          # TODO: Suppress stderr output: https://gist.github.com/adamstegman/926858
-          expect { http.get('/foo') }.to raise_error(Faraday::ConnectionFailed, 'end of file reached')
-        end
-      end
-
-      context 'non_successful_cache_disabled requests' do
-        before do
-          rack_app_url = URI(http_error.url_prefix)
-          Billy.config.whitelist = ["#{rack_app_url.host}:#{rack_app_url.port}"]
-          Billy.config.non_successful_cache_disabled = true
-        end
-
-        it 'should not cache non-successful response when enabled' do
-          http_error.get('/foo')
-          expect(File.exist?(cached_file)).to be false
-        end
-
-        it 'should cache successful response when enabled' do
-          assert_cached_url
-        end
-      end
-
-      context 'non_successful_error_level requests' do
-        before do
-          rack_app_url = URI(http_error.url_prefix)
-          Billy.config.whitelist = ["#{rack_app_url.host}:#{rack_app_url.port}"]
-          Billy.config.non_successful_error_level = :error
-        end
-
-        it 'should raise error for non-successful responses when :error' do
-          expect { http_error.get('/foo') }.to raise_error(Faraday::ConnectionFailed)
-        end
-      end
-    end
-
-    context 'disabled' do
-      before { Billy.config.persist_cache = false }
-
-      it 'shouldnt persist' do
-        http.get('/foo')
-        expect(File.exist?(cached_file)).to be false
-      end
-    end
-  end
-
-  def assert_noncached_url(url = '/foo')
-    r = http.get(url)
-    expect(r.body).to eql "GET #{url}"
-    expect do
-      expect do
-        r = http.get(url)
-      end.to change { r.headers['HTTP-X-EchoCount'].to_i }.by(1)
-    end.to_not change { r.body }
-  end
-
-  def assert_cached_url(url = '/foo')
-    r = http.get(url)
-    expect(r.body).to eql "GET #{url}"
-    expect do
-      expect do
-        r = http.get(url)
-      end.to_not change { r.headers['HTTP-X-EchoCount'] }
-    end.to_not change { r.body }
-  end
-end
-
-describe Billy::Proxy do
-  before do
-    # Adding non-valid Faraday options throw an error: https://github.com/arsduo/koala/pull/311
-    # Valid options: :request, :proxy, :ssl, :builder, :url, :parallel_manager, :params, :headers, :builder_class
-    faraday_options = {
-      proxy: { uri: proxy.url },
-      request: { timeout: 1.0 }
-    }
-    faraday_ssl_options = faraday_options.merge(ssl: {
-      verify: true,
-      ca_file: Billy.certificate_authority.cert_file
-    })
-
-    @http       = Faraday.new @http_url,  faraday_options
-    @https      = Faraday.new @https_url, faraday_ssl_options
-    @http_error = Faraday.new @error_url, faraday_options
-  end
-
-  context 'proxying' do
-    context 'HTTP' do
-      let!(:http) { @http }
-      it_should_behave_like 'a proxy server'
-    end
-
-    context 'HTTPS' do
-      let!(:http) { @https }
-      it_should_behave_like 'a proxy server'
-    end
-  end
-
-  context 'stubbing' do
-    context 'HTTP' do
-      let!(:url)  { @http_url }
-      let!(:http) { @http }
-      it_should_behave_like 'a request stub'
-    end
-
-    context 'HTTPS' do
-      let!(:url)  { @https_url }
-      let!(:http) { @https }
-      it_should_behave_like 'a request stub'
-    end
-  end
-
-  context 'caching' do
-    it 'defaults to nil scope' do
-      expect(proxy.cache.scope).to be nil
-    end
-
-    context 'HTTP' do
-      let!(:url)        { @http_url }
-      let!(:http)       { @http }
-      let!(:http_error) { @http_error }
-      it_should_behave_like 'a cache'
-    end
-
-    context 'HTTPS' do
-      let!(:url)        { @https_url }
-      let!(:http)       { @https }
-      let!(:http_error) { @http_error }
-      it_should_behave_like 'a cache'
-    end
-
-    context 'with a cache scope' do
-      let!(:url)        { @http_url }
-      let!(:http)       { @http }
-      let!(:http_error) { @http_error }
-
-      before do
-        proxy.cache.scope_to 'my_cache'
-      end
-
-      after do
-        proxy.cache.use_default_scope
-      end
-
-      it_should_behave_like 'a cache'
-
-      it 'uses the cache scope' do
-        expect(proxy.cache.scope).to eq('my_cache')
-      end
-
-      it 'can be reset to the default scope' do
-        proxy.cache.use_default_scope
-        expect(proxy.cache.scope).to be nil
-      end
-
-      it 'can execute a block against a cache scope' do
-        expect(proxy.cache.scope).to eq 'my_cache'
-        proxy.cache.with_scope 'another_cache' do
-          expect(proxy.cache.scope).to eq 'another_cache'
-        end
-        expect(proxy.cache.scope).to eq 'my_cache'
-      end
-
-      it 'requires a block to be passed to with_scope' do
-        expect { proxy.cache.with_scope 'some_scope' }.to raise_error ArgumentError
-      end
-
-      it 'should have different keys for the same request under a different scope' do
-        args = ['get', "#{url}/foo", '']
-        key = proxy.cache.key(*args)
-        proxy.cache.with_scope 'another_cache' do
-          expect(proxy.cache.key(*args)).to_not eq key
-        end
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,52 +0,0 @@
-Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
-
-require 'pry'
-require 'billy/capybara/rspec'
-require 'billy/watir/rspec'
-require 'rack'
-require 'logger'
-require 'fileutils'
-require 'webdrivers'
-
-$stdout.puts `#{::Selenium::WebDriver::Chrome::Service.driver_path.call} --version` if ENV['CI']
-
-browser = Billy::Browsers::Watir.new :chrome
-
-Capybara.configure do |config|
-  config.app = Rack::Directory.new(File.expand_path('../../examples', __FILE__))
-  config.server = :webrick
-  config.javascript_driver = :selenium_chrome_headless_billy
-end
-
-Billy.configure do |config|
-  config.logger = Logger.new(File.expand_path('../../log/test.log', __FILE__))
-end
-
-RSpec.configure do |config|
-  include Billy::TestServer
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-  config.order = 'random'
-
-  config.before :suite do
-    FileUtils.rm_rf(Billy.config.certs_path)
-    FileUtils.rm_rf(Billy.config.cache_path)
-  end
-
-  config.before :all do
-    start_test_servers
-    @browser = browser
-  end
-
-  config.before :each do
-    proxy.reset_cache
-  end
-
-  config.after :each do
-    Billy.config.reset
-  end
-
-  config.after :suite do
-    browser.close
-  end
-end

data/spec/support/test_server.rb

@@ -1,79 +0,0 @@
-require 'eventmachine'
-require 'thin'
-require 'faraday'
-
-module Thin::Backends
-  class TcpServer
-    def get_port
-      # seriously, eventmachine, how hard does getting a port have to be?
-      Socket.unpack_sockaddr_in(EM.get_sockname(@signature)).first
-    end
-  end
-end
-
-module Billy
-  module TestServer
-    def initialize
-      Thin::Logging.silent = true
-    end
-
-    def start_test_servers
-      q = Queue.new
-      Thread.new do
-        EM.run do
-          echo = echo_app_setup
-
-          http_server = start_server(echo)
-          q.push http_server.backend.get_port
-
-          https_server = start_server(echo, true)
-          q.push https_server.backend.get_port
-
-          echo_error = echo_app_setup(500)
-          error_server = start_server(echo_error)
-          q.push error_server.backend.get_port
-        end
-      end
-
-      @http_url  = "http://127.0.0.1:#{q.pop}"
-      @https_url = "https://127.0.0.1:#{q.pop}"
-      @error_url = "http://127.0.0.1:#{q.pop}"
-    end
-
-    def echo_app_setup(response_code = 200)
-      counter = 0
-      Proc.new do |env|
-        req_body = env['rack.input'].read
-        request_info = "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}"
-        res_body = request_info
-        res_body += "\n#{req_body}" unless req_body.empty?
-        counter += 1
-        [
-          response_code,
-          { 'HTTP-X-EchoServer' => request_info,
-            'HTTP-X-EchoCount' => "#{counter}" },
-          [res_body]
-        ]
-      end
-    end
-
-    def certificate_chain(domain)
-      ca = Billy.certificate_authority.cert
-      cert = Billy::Certificate.new(domain)
-      chain = Billy::CertificateChain.new(domain, cert.cert, ca)
-      { private_key_file: cert.key_file,
-        cert_chain_file: chain.file }
-
-    end
-
-    def start_server(echo, ssl = false)
-      http_server = Thin::Server.new '127.0.0.1', 0, echo
-      if ssl
-        http_server.ssl = true
-        http_server.ssl_options = certificate_chain('localhost')
-      end
-      http_server.start
-      http_server
-    end
-  end
-end