spec/integration/sinatra_spec.rb

# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

# frozen_string_literal: true

require 'integration_helper'

if defined?(Sinatra)
  enabled = true
else
  puts '[INFO] Skipping Sinatra spec'
end

if enabled
  RSpec.describe 'Sinatra integration', :mock_intake, :allow_running_agent do
    include Rack::Test::Methods

    def app
      SinatraTestApp
    end

    before(:all) do
      class FancyError < StandardError; end

      class BackwardsCompatibleLogger < Logger
        def write(*args)
          self.<<(*args)
        end
      end

      class SinatraTestApp < ::Sinatra::Base
        enable :logging
        disable :protection
        disable :show_exceptions

        use ElasticAPM::Middleware
        use Rack::CommonLogger, BackwardsCompatibleLogger.new(nil)
        # use Rack::CommonLogger, BackwardsCompatibleLogger.new(STDOUT)

        get '/' do
          'Yes!'
        end

        get '/inline' do
          erb 'Inline <%= "t" * 3 %>emplate'
        end

        template :index do
          '<%= (1..3).to_a.join(" ") %> hello <%= @name %>'
        end

        get '/tmpl' do
          @name = 'you'
          erb :index
        end

        get '/users/:id' do
          @name = params[:id].to_s
          erb :index
        end

        get '/error' do
          raise FancyError, 'Halp!'
        end
      end

      MockIntake.stub!
      ElasticAPM.start(app: SinatraTestApp, api_request_time: '200ms')
    end

    after(:all) do
      ElasticAPM.stop
    end

    it 'knows Sinatra' do
      response = get '/'

      wait_for transactions: 1

      expect(response.body).to eq 'Yes!'

      service = @mock_intake.metadatas.first['service']
      expect(service['name']).to eq 'SinatraTestApp'
      expect(service['framework']['name']).to eq 'Sinatra'
      expect(service['framework']['version'])
        .to match(/\d+\.\d+\.\d+(\.\d+)?/)
    end

    describe 'transactions' do
      it 'sets transaction outcome to `success`' do
        get '/'

        wait_for transactions: 1

        transaction = @mock_intake.transactions.first
        expect(transaction['outcome']).to eq 'success'
      end

      it 'wraps requests in a transaction named after route' do
        get '/'

        wait_for transactions: 1

        expect(@mock_intake.requests.length).to be 1
        transaction = @mock_intake.transactions.first
        expect(transaction['name']).to eq 'GET /'
      end

      it 'knows variables in routes' do
        get '/users/666'

        wait_for transactions: 1, spans: 1

        transaction, = @mock_intake.transactions
        expect(transaction['name']).to eq 'GET /users/:id'
        span, = @mock_intake.spans
        expect(span['name']).to eq 'index'
      end

      it 'spans inline templates' do
        get '/inline'

        wait_for transactions: 1, spans: 1

        span = @mock_intake.spans.last
        expect(span['name']).to eq 'Inline erb'
        expect(span['type']).to eq 'template.tilt'
      end

      it 'spans templates' do
        response = get '/tmpl'

        wait_for transactions: 1, spans: 1

        expect(response.body).to eq '1 2 3 hello you'

        span = @mock_intake.spans.last
        expect(span['name']).to eq 'index'
        expect(span['type']).to eq 'template.tilt'
        expect(span['outcome']).to eq 'success'
      end
    end

    describe 'errors' do
      it 'adds an exception handler and posts transaction' do
        begin
          get '/error'
        rescue FancyError
        end

        wait_for errors: 1, transactions: 1

        error_request =
          @mock_intake.errors.first
        exception = error_request['exception']
        expect(exception['type']).to eq 'FancyError'
      end

      it 'sets the transaction outcome to `failure`' do
        begin
          get '/error'
        rescue FancyError
        end

        wait_for errors: 1, transactions: 1

        transaction = @mock_intake.transactions.first
        expect(transaction['outcome']).to eq 'failure'
      end
    end
  end
end