|
| 1 | +require 'spec_helper' |
| 2 | + |
| 3 | +module VCAP::CloudController |
| 4 | + RSpec.describe 'VCAP Request ID Middleware - User Agent' do |
| 5 | + let(:captured_values) { {} } |
| 6 | + |
| 7 | + before do |
| 8 | + allow_any_instance_of(CloudFoundry::Middleware::VcapRequestContextSetter).to receive(:call).and_wrap_original do |original_method, *args| |
| 9 | + env = args[0] |
| 10 | + result = original_method.call(*args) |
| 11 | + captured_values[:user_agent_during_request] = env['HTTP_USER_AGENT'] |
| 12 | + captured_values[:request_id_during_request] = env['cf.request_id'] |
| 13 | + |
| 14 | + result |
| 15 | + end |
| 16 | + end |
| 17 | + |
| 18 | + describe 'user agent and request id handling' do |
| 19 | + let(:space) { VCAP::CloudController::Space.make } |
| 20 | + let(:user) { make_developer_for_space(space) } |
| 21 | + let(:request_id) { 'test-request-123' } |
| 22 | + let(:user_agent) { 'cf/8.7.0 (go1.21.4; amd64 linux)' } |
| 23 | + let(:user_headers) do |
| 24 | + headers_for(user, user_name: 'roto').merge('HTTP_USER_AGENT' => user_agent) |
| 25 | + end |
| 26 | + |
| 27 | + context 'when User-Agent header is provided' do |
| 28 | + it 'sets VCAP::Request.user_agent during the request' do |
| 29 | + get '/v3/spaces', nil, user_headers |
| 30 | + expect(last_response.status).to eq(200) |
| 31 | + expect(captured_values[:user_agent_during_request]).to eq(user_agent) |
| 32 | + expect(captured_values[:request_id_during_request]).to be_present |
| 33 | + # After the request completes, user_agent should be nil |
| 34 | + expect(::VCAP::Request.user_agent).to be_nil |
| 35 | + end |
| 36 | + end |
| 37 | + |
| 38 | + context 'when User-Agent header and HTTP_X_VCAP_REQUEST_ID are provided' do |
| 39 | + it 'sets VCAP::Request.user_agent and HTTP_X_VCAP_REQUEST_ID during the request' do |
| 40 | + get '/v3/spaces', nil, user_headers.merge('HTTP_X_VCAP_REQUEST_ID' => request_id) |
| 41 | + expect(last_response.status).to eq(200) |
| 42 | + expect(captured_values[:user_agent_during_request]).to eq(user_agent) |
| 43 | + expect(captured_values[:request_id_during_request]).to include(request_id) |
| 44 | + expect(last_response.headers['X-VCAP-Request-ID']).to include(request_id) |
| 45 | + # After the request completes, user_agent and current_id should be nil |
| 46 | + expect(::VCAP::Request.user_agent).to be_nil |
| 47 | + expect(::VCAP::Request.current_id).to be_nil |
| 48 | + end |
| 49 | + end |
| 50 | + end |
| 51 | + |
| 52 | + context 'telemetry' do |
| 53 | + let(:space) { VCAP::CloudController::Space.make } |
| 54 | + let(:org) { space.organization } |
| 55 | + let(:user) { make_developer_for_space(space) } |
| 56 | + let(:user_agent) { 'cf/8.7.0 (go1.21.4; amd64 linux)' } |
| 57 | + let(:user_header) { headers_for(user, user_name: 'roto').merge('HTTP_USER_AGENT' => user_agent) } |
| 58 | + let(:logger_spy) { spy('logger') } |
| 59 | + let(:stack) { VCAP::CloudController::Stack.make } |
| 60 | + let(:buildpack) { VCAP::CloudController::Buildpack.make(stack: stack.name) } |
| 61 | + let(:create_request) do |
| 62 | + { |
| 63 | + name: 'my_app', |
| 64 | + lifecycle: { |
| 65 | + type: 'buildpack', |
| 66 | + data: { |
| 67 | + stack: buildpack.stack, |
| 68 | + buildpacks: [buildpack.name] |
| 69 | + } |
| 70 | + }, |
| 71 | + relationships: { |
| 72 | + space: { |
| 73 | + data: { |
| 74 | + guid: space.guid |
| 75 | + } |
| 76 | + } |
| 77 | + } |
| 78 | + } |
| 79 | + end |
| 80 | + |
| 81 | + before do |
| 82 | + org.add_user(user) |
| 83 | + space.add_developer(user) |
| 84 | + allow(VCAP::CloudController::TelemetryLogger).to receive(:logger).and_return(logger_spy) |
| 85 | + end |
| 86 | + |
| 87 | + it 'includes user-agent in telemetry logs when making a request' do |
| 88 | + Timecop.freeze do |
| 89 | + post '/v3/apps', create_request.to_json, user_header |
| 90 | + |
| 91 | + parsed_response = Oj.load(last_response.body) |
| 92 | + app_guid = parsed_response['guid'] |
| 93 | + |
| 94 | + expected_json = { |
| 95 | + 'telemetry-source' => 'cloud_controller_ng', |
| 96 | + 'telemetry-time' => Time.now.to_datetime.rfc3339, |
| 97 | + 'create-app' => { |
| 98 | + 'api-version' => 'v3', |
| 99 | + 'app-id' => OpenSSL::Digest::SHA256.hexdigest(app_guid), |
| 100 | + 'user-id' => OpenSSL::Digest::SHA256.hexdigest(user.guid), |
| 101 | + 'user-agent' => user_agent |
| 102 | + } |
| 103 | + } |
| 104 | + expect(logger_spy).to have_received(:info) do |actual_json| |
| 105 | + actual = Oj.load(actual_json) |
| 106 | + expect(actual).to eq(expected_json) |
| 107 | + end |
| 108 | + expect(last_response.status).to eq(201), last_response.body |
| 109 | + end |
| 110 | + end |
| 111 | + end |
| 112 | + end |
| 113 | +end |
0 commit comments