fix: add AAA test sections and update docformatter config

Author: wtobis-splunk

.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
     rev: v1.7.7
     hooks:
       - id: docformatter
-        args: [--in-place]
+        args: [--in-place, --wrap-summaries, "0", --wrap-descriptions, "0"]
         language_version: python3
 -   repo: https://github.com/PyCQA/flake8
     rev: 5.0.4

solnlib/bulletin_rest_client.py

@@ -40,18 +40,18 @@ def __init__(
         app: str,
         **context: dict,
     ):
-        """Initializes BulletinRestClient. When creating a new bulletin
-        message, you must provide a name, which is a kind of ID. If you try to
-        create another message with the same name (ID), the API will not add
-        another message to the bulletin, but it will overwrite the existing
-        one. Similar behaviour applies to deletion. To delete a message, you
-        must indicate the name (ID) of the message. To provide better and
-        easier control over bulletin messages, this client works in such a way
-        that there is one instance responsible for handling one specific
-        message. If you need to add another message to bulletin create another
-        instance with a different 'message_name' e.g. msg_1 =
-        BulletinRestClient("message_1", "<some session key>") msg_2 =
-        BulletinRestClient("message_2", "<some session key>")
+        """Initializes BulletinRestClient.
+            When creating a new bulletin message, you must provide a name, which is a kind of ID.
+            If you try to create another message with the same name (ID), the API will not add another message
+            to the bulletin, but it will overwrite the existing one. Similar behaviour applies to deletion.
+            To delete a message, you must indicate the name (ID) of the message.
+            To provide better and easier control over bulletin messages, this client works in such a way
+            that there is one instance responsible for handling one specific message.
+            If you need to add another message to bulletin create another instance
+            with a different 'message_name'
+            e.g.
+            msg_1 = BulletinRestClient("message_1", "<some session key>")
+            msg_2 = BulletinRestClient("message_2", "<some session key>")
 
         Arguments:
             message_name: Name of the message in the Splunk's bulletin.

tests/unit/test_observability.py

@@ -86,58 +86,81 @@ def _make_histogram_data_point(name, unit="s"):
 
 class TestLoggerMetricExporter:
     def test_export_counter_returns_success(self, logger):
+        # Arrange
         exporter = LoggerMetricExporter(logger)
+        # Act
         result = exporter.export(_make_counter_data_point("my.metric", 42))
+        # Assert
         assert result == MetricExportResult.SUCCESS
 
     def test_export_counter_logs_value(self, logger):
+        # Arrange
         exporter = LoggerMetricExporter(logger)
+        # Act
         exporter.export(_make_counter_data_point("my.metric", 7, attributes={"a": "b"}))
+        # Assert
         logger.info.assert_called()
         call_args = logger.info.call_args[0]
         assert "my.metric" in call_args[1]
 
     def test_export_counter_no_attributes(self, logger):
+        # Arrange
         exporter = LoggerMetricExporter(logger)
+        # Act
         result = exporter.export(
             _make_counter_data_point("my.metric", 1, attributes=None)
         )
+        # Assert
         assert result == MetricExportResult.SUCCESS
 
     def test_export_histogram_returns_success(self, logger):
+        # Arrange
         exporter = LoggerMetricExporter(logger)
+        # Act
         result = exporter.export(_make_histogram_data_point("my.histogram"))
+        # Assert
         assert result == MetricExportResult.SUCCESS
 
     def test_export_histogram_logs_bucket_info(self, logger):
+        # Arrange
         exporter = LoggerMetricExporter(logger)
+        # Act
         exporter.export(_make_histogram_data_point("my.histogram"))
+        # Assert
         logger.info.assert_called()
         call_args = logger.info.call_args[0]
         assert "my.histogram" in call_args[1]
 
     def test_export_empty_metrics_data(self, logger):
+        # Arrange
         metrics_data = MagicMock()
         metrics_data.resource_metrics = []
         exporter = LoggerMetricExporter(logger)
+        # Act
         result = exporter.export(metrics_data)
+        # Assert
         assert result == MetricExportResult.SUCCESS
         logger.debug.assert_not_called()
 
     def test_export_returns_failure_on_exception(self, logger):
+        # Arrange
         metrics_data = MagicMock()
         metrics_data.resource_metrics.__iter__ = MagicMock(
             side_effect=RuntimeError("boom")
         )
         exporter = LoggerMetricExporter(logger)
+        # Act
         result = exporter.export(metrics_data)
+        # Assert
         assert result == MetricExportResult.FAILURE
         logger.error.assert_called()
 
     def test_shutdown_does_not_raise(self, logger):
+        # Arrange / Act / Assert
         LoggerMetricExporter(logger).shutdown()
 
     def test_force_flush_returns_true(self, logger):
+        # Arrange / Act / Assert
         assert LoggerMetricExporter(logger).force_flush() is True
 
 
@@ -164,20 +187,27 @@ def _make_service(logger, monkeypatch, extra_exporters=None):
 
 class TestObservabilityService:
     def test_counters_are_created(self, logger, monkeypatch):
+        # Arrange / Act
         svc = _make_service(logger, monkeypatch)
+        # Assert
         assert svc.event_count_counter is not None
         assert svc.event_bytes_counter is not None
 
     def test_meter_is_available(self, logger, monkeypatch):
+        # Arrange / Act
         svc = _make_service(logger, monkeypatch)
+        # Assert
         assert svc._meter is not None
 
     def test_extra_exporter_is_added(self, logger, monkeypatch):
+        # Arrange
         extra = MagicMock()
+        # Act / Assert
         _make_service(logger, monkeypatch, extra_exporters=[extra])
         # No assertion needed beyond not raising; the exporter is wrapped internally
 
     def test_missing_ta_name_logs_warning(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.ObservabilityService._create_otlp_exporter",
             lambda self: None,
@@ -186,13 +216,16 @@ def test_missing_ta_name_logs_warning(self, logger, monkeypatch):
             "solnlib.observability.ObservabilityService._read_ta_info",
             lambda self: (None, None),
         )
+        # Act
         svc = ObservabilityService(modinput_type="test-input", logger=logger)
+        # Assert
         assert svc._meter is None
         logger.warning.assert_called()
 
     def test_register_instrument_returns_none_when_meter_missing(
         self, logger, monkeypatch
     ):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.ObservabilityService._create_otlp_exporter",
             lambda self: None,
@@ -202,17 +235,23 @@ def test_register_instrument_returns_none_when_meter_missing(
             lambda self: (None, None),
         )
         svc = ObservabilityService(modinput_type="test-input", logger=logger)
+        # Act
         result = svc.register_instrument(lambda m: m.create_counter("x"))
+        # Assert
         assert result is None
 
     def test_register_instrument_calls_callback(self, logger, monkeypatch):
+        # Arrange
         svc = _make_service(logger, monkeypatch)
         callback = MagicMock(return_value="instrument")
+        # Act
         result = svc.register_instrument(callback)
+        # Assert
         callback.assert_called_once_with(svc._meter)
         assert result == "instrument"
 
     def test_read_ta_info_returns_values(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.get_conf_stanzas",
             lambda conf, **kwargs: {
@@ -224,10 +263,13 @@ def test_read_ta_info_returns_values(self, logger, monkeypatch):
             "solnlib.observability.ObservabilityService._create_otlp_exporter",
             lambda self: None,
         )
+        # Act
         svc = ObservabilityService(modinput_type="test-input", logger=logger)
+        # Assert
         assert svc._meter is not None
 
     def test_read_ta_info_handles_exception(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.ObservabilityService._create_otlp_exporter",
             lambda self: None,
@@ -236,50 +278,63 @@ def test_read_ta_info_handles_exception(self, logger, monkeypatch):
             "solnlib.observability.get_conf_stanzas",
             MagicMock(side_effect=Exception("no btool")),
         )
+        # Act
         svc = ObservabilityService(modinput_type="test-input", logger=logger)
+        # Assert
         assert svc._meter is None
 
     def test_resolve_otlp_port_from_env(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.setenv("SPOTLIGHT_OTEL_RECEIVER_PORT", "4317")
         svc = _make_service(logger, monkeypatch)
+        # Act / Assert
         assert svc._resolve_otlp_port() == "4317"
 
     def test_resolve_otlp_port_falls_back_to_ipc(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.delenv("SPOTLIGHT_OTEL_RECEIVER_PORT", raising=False)
         monkeypatch.setattr(
             "solnlib.observability.ObservabilityService._discover_otlp_port_via_ipc_broker",
             lambda self: "9999",
         )
         svc = _make_service(logger, monkeypatch)
+        # Act / Assert
         assert svc._resolve_otlp_port() == "9999"
 
     def test_get_ipc_broker_port_returns_none_on_error(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.get_conf_stanzas",
             MagicMock(side_effect=Exception("fail")),
         )
         svc = _make_service(logger, monkeypatch)
+        # Act / Assert
         assert svc._get_ipc_broker_port() is None
 
     def test_get_ipc_broker_port_returns_port(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.get_conf_stanzas",
             lambda conf, **kwargs: {"ipc_broker": {"port": "8088"}},
         )
         svc = _make_service(logger, monkeypatch)
+        # Act / Assert
         assert svc._get_ipc_broker_port() == 8088
 
     def test_discover_otlp_port_returns_none_when_ipc_port_missing(
         self, logger, monkeypatch
     ):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.ObservabilityService._get_ipc_broker_port",
             lambda self: None,
         )
         svc = _make_service(logger, monkeypatch)
+        # Act / Assert
         assert svc._discover_otlp_port_via_ipc_broker() is None
 
     def test_discover_otlp_port_returns_none_on_http_error(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.ObservabilityService._get_ipc_broker_port",
             lambda self: 8088,
@@ -289,11 +344,13 @@ def test_discover_otlp_port_returns_none_on_http_error(self, logger, monkeypatch
             MagicMock(side_effect=Exception("connection refused")),
         )
         svc = _make_service(logger, monkeypatch)
+        # Act / Assert
         assert svc._discover_otlp_port_via_ipc_broker() is None
 
     def test_discover_otlp_port_returns_none_on_unsuccessful_response(
         self, logger, monkeypatch
     ):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.ObservabilityService._get_ipc_broker_port",
             lambda self: 8088,
@@ -304,9 +361,11 @@ def test_discover_otlp_port_returns_none_on_unsuccessful_response(
         mock_resp.read.return_value = b'{"success": false}'
         monkeypatch.setattr("urllib.request.urlopen", lambda *a, **kw: mock_resp)
         svc = _make_service(logger, monkeypatch)
+        # Act / Assert
         assert svc._discover_otlp_port_via_ipc_broker() is None
 
     def test_discover_otlp_port_returns_port_on_success(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.setattr(
             "solnlib.observability.ObservabilityService._get_ipc_broker_port",
             lambda self: 8088,
@@ -317,24 +376,30 @@ def test_discover_otlp_port_returns_port_on_success(self, logger, monkeypatch):
         mock_resp.read.return_value = b'{"success": true, "port": 4317}'
         monkeypatch.setattr("urllib.request.urlopen", lambda *a, **kw: mock_resp)
         svc = _make_service(logger, monkeypatch)
+        # Act / Assert
         assert svc._discover_otlp_port_via_ipc_broker() == "4317"
 
     def test_create_otlp_exporter_returns_none_when_no_port(self, logger, monkeypatch):
+        # Arrange
         monkeypatch.delenv("SPOTLIGHT_OTEL_RECEIVER_PORT", raising=False)
         monkeypatch.setattr(
             "solnlib.observability.ObservabilityService._discover_otlp_port_via_ipc_broker",
             lambda self: None,
         )
         svc = _make_service(logger, monkeypatch)
-        # Call the real _create_otlp_exporter now (not patched)
+        # Act — call the real _create_otlp_exporter (not patched)
         result = ObservabilityService._create_otlp_exporter(svc)
+        # Assert
         assert result is None
 
     def test_create_otlp_exporter_returns_none_when_cert_missing(
         self, logger, monkeypatch, tmp_path
     ):
+        # Arrange
         monkeypatch.setenv("SPOTLIGHT_OTEL_RECEIVER_PORT", "4317")
         monkeypatch.setenv("SPLUNK_HOME", str(tmp_path))
         svc = _make_service(logger, monkeypatch)
+        # Act
         result = ObservabilityService._create_otlp_exporter(svc)
+        # Assert
         assert result is None