squash: add url.template tests

Author: arielvalentin

instrumentation/excon/test/opentelemetry/instrumentation/excon/dup/instrumentation_test.rb

@@ -24,6 +24,7 @@
     stub_request(:get, 'http://example.com/success?hello=there').to_return(status: 200)
     stub_request(:get, 'http://example.com/failure').to_return(status: 500)
     stub_request(:get, 'http://example.com/timeout').to_timeout
+    stub_request(:get, 'http://example.com/users/123').to_return(status: 200)
 
     # this is currently a noop but this will future proof the test
     @orig_propagation = OpenTelemetry.propagation
@@ -404,6 +405,24 @@
         _(exporter.finished_spans.size).must_equal(0)
       end
     end
+
+    it 'uses url.template in span name when present in client context' do
+      client_context_attrs = { 'url.template' => '/users/{id}' }
+      OpenTelemetry::Common::HTTP::ClientContext.with_attributes(client_context_attrs) do
+        Excon.get('http://example.com/users/123')
+      end
+
+      _(exporter.finished_spans.size).must_equal 1
+      _(span.name).must_equal 'GET /users/{id}'
+      _(span.attributes['http.method']).must_equal 'GET'
+      _(span.attributes['http.request.method']).must_equal 'GET'
+      _(span.attributes['url.template']).must_equal '/users/{id}'
+      assert_requested(
+        :get,
+        'http://example.com/users/123',
+        headers: { 'Traceparent' => "00-#{span.hex_trace_id}-#{span.hex_span_id}-01" }
+      )
+    end
   end
 
   def assert_http_spans(scheme: 'http', host: 'localhost', port: nil, target: '/', exception: nil)

instrumentation/excon/test/opentelemetry/instrumentation/excon/stable/instrumentation_test.rb

@@ -24,6 +24,7 @@
     stub_request(:get, 'http://example.com/success?hello=there').to_return(status: 200)
     stub_request(:get, 'http://example.com/failure').to_return(status: 500)
     stub_request(:get, 'http://example.com/timeout').to_timeout
+    stub_request(:get, 'http://example.com/users/123').to_return(status: 200)
 
     # this is currently a noop but this will future proof the test
     @orig_propagation = OpenTelemetry.propagation
@@ -368,4 +369,23 @@ def assert_http_spans(scheme: 'http', host: 'localhost', port: nil, target: '/',
       end
     end
   end
+
+  describe 'url.template' do
+    it 'uses url.template in span name when present in client context' do
+      client_context_attrs = { 'url.template' => '/users/{id}' }
+      OpenTelemetry::Common::HTTP::ClientContext.with_attributes(client_context_attrs) do
+        Excon.get('http://example.com/users/123')
+      end
+
+      _(exporter.finished_spans.size).must_equal 1
+      _(span.name).must_equal 'GET /users/{id}'
+      _(span.attributes['http.request.method']).must_equal 'GET'
+      _(span.attributes['url.template']).must_equal '/users/{id}'
+      assert_requested(
+        :get,
+        'http://example.com/users/123',
+        headers: { 'Traceparent' => "00-#{span.hex_trace_id}-#{span.hex_span_id}-01" }
+      )
+    end
+  end
 end

instrumentation/faraday/test/opentelemetry/instrumentation/faraday/middlewares/dup/tracer_middleware_test.rb

@@ -279,5 +279,30 @@
         _(tracers).must_equal 1
       end
     end
+
+    describe 'url.template in span name' do
+      let(:client) do
+        Faraday.new('http://example.com') do |builder|
+          builder.adapter(:test) do |stub|
+            stub.get('/users/123') { |_| [200, {}, 'OK'] }
+          end
+        end
+      end
+
+      it 'uses url.template in span name when present in client context' do
+        client_context_attrs = { 'url.template' => '/users/{id}' }
+        response = OpenTelemetry::Common::HTTP::ClientContext.with_attributes(client_context_attrs) do
+          client.get('/users/123')
+        end
+
+        _(span.name).must_equal 'GET /users/{id}'
+        _(span.attributes['http.method']).must_equal 'GET'
+        _(span.attributes['http.request.method']).must_equal 'GET'
+        _(span.attributes['url.template']).must_equal '/users/{id}'
+        _(response.env.request_headers['Traceparent']).must_equal(
+          "00-#{span.hex_trace_id}-#{span.hex_span_id}-01"
+        )
+      end
+    end
   end
 end

instrumentation/faraday/test/opentelemetry/instrumentation/faraday/middlewares/stable/tracer_middleware_test.rb

@@ -250,5 +250,29 @@
         _(tracers).must_equal 1
       end
     end
+
+    describe 'url.template in span name' do
+      let(:client) do
+        Faraday.new('http://example.com') do |builder|
+          builder.adapter(:test) do |stub|
+            stub.get('/users/123') { |_| [200, {}, 'OK'] }
+          end
+        end
+      end
+
+      it 'uses url.template in span name when present in client context' do
+        client_context_attrs = { 'url.template' => '/users/{id}' }
+        response = OpenTelemetry::Common::HTTP::ClientContext.with_attributes(client_context_attrs) do
+          client.get('/users/123')
+        end
+
+        _(span.name).must_equal 'GET /users/{id}'
+        _(span.attributes['http.request.method']).must_equal 'GET'
+        _(span.attributes['url.template']).must_equal '/users/{id}'
+        _(response.env.request_headers['Traceparent']).must_equal(
+          "00-#{span.hex_trace_id}-#{span.hex_span_id}-01"
+        )
+      end
+    end
   end
 end

instrumentation/http/test/instrumentation/http/patches/dup/client_test.rb

@@ -35,6 +35,7 @@
     stub_request(:get, 'http://example.com/success?hello=there').to_return(status: 200)
     stub_request(:post, 'http://example.com/failure').to_return(status: 500)
     stub_request(:get, 'https://example.com/timeout').to_timeout
+    stub_request(:get, 'http://example.com/users/123').to_return(status: 200)
   end
 
   after do
@@ -272,5 +273,23 @@
         headers: { 'Traceparent' => "00-#{span.hex_trace_id}-#{span.hex_span_id}-01" }
       )
     end
+
+    it 'uses url.template in span name when present in client context' do
+      client_context_attrs = { 'url.template' => '/users/{id}' }
+      OpenTelemetry::Common::HTTP::ClientContext.with_attributes(client_context_attrs) do
+        HTTP.get('http://example.com/users/123')
+      end
+
+      _(exporter.finished_spans.size).must_equal 1
+      _(span.name).must_equal 'GET /users/{id}'
+      _(span.attributes['http.method']).must_equal 'GET'
+      _(span.attributes['http.request.method']).must_equal 'GET'
+      _(span.attributes['url.template']).must_equal '/users/{id}'
+      assert_requested(
+        :get,
+        'http://example.com/users/123',
+        headers: { 'Traceparent' => "00-#{span.hex_trace_id}-#{span.hex_span_id}-01" }
+      )
+    end
   end
 end

instrumentation/http/test/instrumentation/http/patches/stable/client_test.rb

@@ -35,6 +35,7 @@
     stub_request(:get, 'http://example.com/success?hello=there').to_return(status: 200)
     stub_request(:post, 'http://example.com/failure').to_return(status: 500)
     stub_request(:get, 'https://example.com/timeout').to_timeout
+    stub_request(:get, 'http://example.com/users/123').to_return(status: 200)
   end
 
   after do
@@ -214,5 +215,22 @@
         headers: { 'Traceparent' => "00-#{span.hex_trace_id}-#{span.hex_span_id}-01" }
       )
     end
+
+    it 'uses url.template in span name when present in client context' do
+      client_context_attrs = { 'url.template' => '/users/{id}' }
+      OpenTelemetry::Common::HTTP::ClientContext.with_attributes(client_context_attrs) do
+        HTTP.get('http://example.com/users/123')
+      end
+
+      _(exporter.finished_spans.size).must_equal 1
+      _(span.name).must_equal 'GET /users/{id}'
+      _(span.attributes['http.request.method']).must_equal 'GET'
+      _(span.attributes['url.template']).must_equal '/users/{id}'
+      assert_requested(
+        :get,
+        'http://example.com/users/123',
+        headers: { 'Traceparent' => "00-#{span.hex_trace_id}-#{span.hex_span_id}-01" }
+      )
+    end
   end
 end

instrumentation/net_http/test/opentelemetry/instrumentation/net/http/dup/instrumentation_test.rb

@@ -23,6 +23,7 @@
     stub_request(:get, 'http://example.com/success?hello=there').to_return(status: 200)
     stub_request(:post, 'http://example.com/failure').to_return(status: 500)
     stub_request(:get, 'https://example.com/timeout').to_timeout
+    stub_request(:get, 'http://example.com/users/123').to_return(status: 200)
 
     # this is currently a noop but this will future proof the test
     @orig_propagation = OpenTelemetry.propagation
@@ -381,6 +382,24 @@ def fake_socket.close; end
       WebMock.disable_net_connect!
     end
 
+    it 'uses url.template in span name when present in client context' do
+      client_context_attrs = { 'url.template' => '/users/{id}' }
+      OpenTelemetry::Common::HTTP::ClientContext.with_attributes(client_context_attrs) do
+        Net::HTTP.get('example.com', '/users/123')
+      end
+
+      _(exporter.finished_spans.size).must_equal 1
+      _(span.name).must_equal 'GET /users/{id}'
+      _(span.attributes['http.method']).must_equal 'GET'
+      _(span.attributes['http.request.method']).must_equal 'GET'
+      _(span.attributes['url.template']).must_equal '/users/{id}'
+      assert_requested(
+        :get,
+        'http://example.com/users/123',
+        headers: { 'Traceparent' => "00-#{span.hex_trace_id}-#{span.hex_span_id}-01" }
+      )
+    end
+
     it 'emits a "connect" span when connecting through an non-ssl proxy' do
       WebMock.allow_net_connect!
 

instrumentation/net_http/test/opentelemetry/instrumentation/net/http/stable/instrumentation_test.rb

@@ -23,6 +23,7 @@
     stub_request(:get, 'http://example.com/success?hello=there').to_return(status: 200)
     stub_request(:post, 'http://example.com/failure').to_return(status: 500)
     stub_request(:get, 'https://example.com/timeout').to_timeout
+    stub_request(:get, 'http://example.com/users/123').to_return(status: 200)
 
     # this is currently a noop but this will future proof the test
     @orig_propagation = OpenTelemetry.propagation
@@ -355,5 +356,22 @@ def fake_socket.close; end
     ensure
       WebMock.disable_net_connect!
     end
+
+    it 'uses url.template in span name when present in client context' do
+      client_context_attrs = { 'url.template' => '/users/{id}' }
+      OpenTelemetry::Common::HTTP::ClientContext.with_attributes(client_context_attrs) do
+        Net::HTTP.get('example.com', '/users/123')
+      end
+
+      _(exporter.finished_spans.size).must_equal 1
+      _(span.name).must_equal 'GET /users/{id}'
+      _(span.attributes['http.request.method']).must_equal 'GET'
+      _(span.attributes['url.template']).must_equal '/users/{id}'
+      assert_requested(
+        :get,
+        'http://example.com/users/123',
+        headers: { 'Traceparent' => "00-#{span.hex_trace_id}-#{span.hex_span_id}-01" }
+      )
+    end
   end
 end