Skip to content

Commit

Permalink
Add test base class with local HTTP server. (#2101)
Browse files Browse the repository at this point in the history
  • Loading branch information
Oberon00 authored Sep 20, 2021
1 parent 45a2b35 commit d9c22a8
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
([#2071](https://github.com/open-telemetry/opentelemetry-python/pull/2071))
- Do not skip sequence attribute on decode error
([#2097](https://github.com/open-telemetry/opentelemetry-python/pull/2097))
- `opentelemetry-test`: Add `HttpTestBase` to allow tests with actual TCP sockets
([#2101](https://github.com/open-telemetry/opentelemetry-python/pull/2101))

## [1.5.0-0.24b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.5.0-0.24b0) - 2021-08-26

Expand Down
68 changes: 68 additions & 0 deletions tests/util/src/opentelemetry/test/httptest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# 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 re
import unittest
from http import HTTPStatus
from http.server import BaseHTTPRequestHandler, HTTPServer
from threading import Thread


class HttpTestBase(unittest.TestCase):
DEFAULT_RESPONSE = b"Hello!"

class Handler(BaseHTTPRequestHandler):
protocol_version = "HTTP/1.1" # Support keep-alive.
# timeout = 3 # No timeout -- if shutdown hangs, make sure to close your connection

STATUS_RE = re.compile(r"/status/(\d+)")

def do_GET(self): # pylint:disable=invalid-name
status_match = self.STATUS_RE.fullmatch(self.path)
status = 200
if status_match:
status = int(status_match.group(1))
if status == 200:
body = HttpTestBase.DEFAULT_RESPONSE
self.send_response(HTTPStatus.OK)
self.send_header("Content-Length", str(len(body)))
self.end_headers()
self.wfile.write(body)
else:
self.send_error(status)

@classmethod
def create_server(cls):
server_address = ("127.0.0.1", 0) # Only bind to localhost.
return HTTPServer(server_address, cls.Handler)

@classmethod
def run_server(cls):
httpd = cls.create_server()
worker = Thread(
target=httpd.serve_forever, daemon=True, name="Test server worker"
)
worker.start()
return worker, httpd

@classmethod
def setUpClass(cls):
super().setUpClass()
cls.server_thread, cls.server = cls.run_server()

@classmethod
def tearDownClass(cls):
cls.server.shutdown()
cls.server_thread.join()
super().tearDownClass()

0 comments on commit d9c22a8

Please sign in to comment.