Skip to content

Commit

Permalink
Improved Test Coverage for HTTP Utility's IP Setting Functionality (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavosett authored Jul 12, 2024
1 parent 6293d6a commit 15f3b97
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions util/opentelemetry-util-http/tests/test_try_set_ip.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Copyright The OpenTelemetry Authors
#
# Licensed 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.

import logging
import socket
import unittest
from http.client import HTTPConnection
from unittest.mock import MagicMock, patch

from opentelemetry.util.http.httplib import trysetip


class TestTrySetIP(unittest.TestCase):
def setUp(self):
# Setup a mock HTTPConnection
self.conn = MagicMock(spec=HTTPConnection)
self.conn.sock = MagicMock(spec=socket.socket)

# Mock state function and Span class
self.mock_state = {"need_ip": [MagicMock()]}
self.mock_getstate = patch(
"opentelemetry.util.http.httplib._getstate",
return_value=self.mock_state,
)
self.mock_getstate.start()

def test_ip_set_successfully(self):
self.conn.sock.getpeername.return_value = ("192.168.1.1", 8080)

success = trysetip(self.conn, loglevel=logging.DEBUG)

# Verify that the IP was set correctly
for span in self.mock_state["need_ip"]:
span.set_attribute.assert_called_once_with(
"net.peer.ip", "192.168.1.1"
)
self.assertTrue(success)

def test_no_socket_connection(self):
# Setup the connection with no socket
self.conn.sock = None

success = trysetip(self.conn, loglevel=logging.DEBUG)

self.assertFalse(success)

def test_exception_during_ip_retrieval(self):
self.conn.sock.getpeername.side_effect = Exception("Test Exception")

with self.assertLogs(level=logging.WARNING) as warning:
success = trysetip(self.conn, loglevel=logging.WARNING)
self.assertEqual(len(warning.records), 1)
self.assertIn(
"Failed to get peer address", warning.records[0].message
)
self.assertTrue(success)

0 comments on commit 15f3b97

Please sign in to comment.