Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lite_bootstrap/bootstrappers/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ def bootstrap(self) -> ApplicationT:
return self._prepare_application()

def teardown(self) -> None:
if not self.is_bootstrapped:
return
self.is_bootstrapped = False
errors: list[tuple[str, BaseException]] = []
for one_instrument in reversed(self.instruments):
Expand Down
6 changes: 4 additions & 2 deletions lite_bootstrap/instruments/logging_instrument.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,5 +207,7 @@ def teardown(self) -> None:
h.close()
root_logger.setLevel(logging.WARNING)
if self._logger_factory is not None:
self._logger_factory.close_handlers()
object.__setattr__(self, "_logger_factory", None)
try:
self._logger_factory.close_handlers()
finally:
object.__setattr__(self, "_logger_factory", None)
6 changes: 4 additions & 2 deletions lite_bootstrap/instruments/opentelemetry_instrument.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,5 +138,7 @@ def teardown(self) -> None:
else:
one_instrumentor.uninstrument()
if self._tracer_provider is not None:
self._tracer_provider.shutdown()
object.__setattr__(self, "_tracer_provider", None)
try:
self._tracer_provider.shutdown()
finally:
object.__setattr__(self, "_tracer_provider", None)
19 changes: 19 additions & 0 deletions tests/instruments/test_logging_instrument.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import logging
from io import StringIO
from unittest.mock import patch

import pytest
import structlog
from opentelemetry.trace import get_tracer

Expand Down Expand Up @@ -117,3 +119,20 @@ def test_memory_logger_factory_error() -> None:
error_message = "error message"
test_logger.error(error_message)
assert error_message in test_stream.getvalue()


def test_logging_instrument_teardown_resets_factory_when_close_handlers_raises() -> None:
instrument = LoggingInstrument(
bootstrap_config=LoggingConfig(logging_buffer_capacity=0),
)
instrument.bootstrap()
factory = instrument._logger_factory # noqa: SLF001
assert factory is not None

with (
patch.object(factory, "close_handlers", side_effect=RuntimeError("boom")),
pytest.raises(RuntimeError, match="boom"),
):
instrument.teardown()

assert instrument._logger_factory is None # noqa: SLF001
19 changes: 19 additions & 0 deletions tests/instruments/test_opentelemetry_instrument.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
from unittest.mock import patch

import pytest

from lite_bootstrap.instruments.opentelemetry_instrument import (
InstrumentorWithParams,
OpentelemetryConfig,
Expand Down Expand Up @@ -49,3 +51,20 @@ def test_opentelemetry_instrument_teardown_shuts_down_tracer_provider() -> None:

mock_shutdown.assert_called_once_with()
assert instrument._tracer_provider is None # noqa: SLF001


def test_opentelemetry_instrument_teardown_resets_tracer_provider_when_shutdown_raises() -> None:
instrument = OpenTelemetryInstrument(
bootstrap_config=OpentelemetryConfig(opentelemetry_log_traces=True),
)
instrument.bootstrap()
tracer_provider = instrument._tracer_provider # noqa: SLF001
assert tracer_provider is not None

with (
patch.object(tracer_provider, "shutdown", side_effect=RuntimeError("boom")),
pytest.raises(RuntimeError, match="boom"),
):
instrument.teardown()

assert instrument._tracer_provider is None # noqa: SLF001
16 changes: 16 additions & 0 deletions tests/test_free_bootstrap.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,19 @@ def test_free_bootstrapper_with_missing_instrument_dependency(
) -> None:
with emulate_package_missing(package_name), pytest.warns(UserWarning, match=package_name):
FreeBootstrapper(bootstrap_config=free_bootstrapper_config)


def test_teardown_is_idempotent(free_bootstrapper_config: FreeBootstrapperConfig) -> None:
bootstrapper = FreeBootstrapper(bootstrap_config=free_bootstrapper_config)
bootstrapper.bootstrap()

first = MagicMock()
second = MagicMock()
bootstrapper.instruments = [first, second]

bootstrapper.teardown()
bootstrapper.teardown()

first.teardown.assert_called_once()
second.teardown.assert_called_once()
assert not bootstrapper.is_bootstrapped
Loading