NH-34752 Add config file tests + small changes

solarwinds_apm/apm_config.py

@@ -112,11 +112,9 @@ def __init__(
             "histogram_precision": -1,
             "reporter_file_single": 0,
             "enable_sanitize_sql": True,
-            "inst_enabled": defaultdict(lambda: True),
             "log_trace_id": "never",
             "proxy": "",
             "transaction": defaultdict(lambda: True),
-            "inst": defaultdict(lambda: True),
             "is_grpc_clean_hack_enabled": False,
             "transaction_filters": [],
         }
@@ -484,33 +482,37 @@ def get(self, key: str, default: Any = None):
         )
         return value if value is not None else default
 
-    def update_with_cnf_file(self) -> None:
-        """Update the settings with the config file (json), if any."""
-
-        def _snake_to_camel_case(key):
-            key_parts = key.split("_")
-            camel_head = key_parts[0]
-            camel_body = "".join(part.title() for part in key_parts[1:])
-            return f"{camel_head}{camel_body}"
-
+    def get_cnf_dict(self) -> Any:
+        """Load Python dict from confg file (json), if any"""
         cnf_filepath = os.environ.get(
             "SW_APM_CONFIG_FILE", "./solarwinds-apm-config.json"
         )
-        if not cnf_filepath:
-            return
         cnf_dict = None
         try:
             with open(cnf_filepath, encoding="utf-8") as cnf_file:
                 try:
-                    cnf_dict = json.load(cnf_file)
+                    file_content = cnf_file.read()
+                    cnf_dict = json.loads(file_content)
                 except ValueError as ex:
                     logger.error(
                         "Invalid config file, must be valid json. Ignoring: %s",
                         ex,
                     )
-                    return
         except FileNotFoundError as ex:
             logger.error("Invalid config file path. Ignoring: %s", ex)
+        return cnf_dict
+
+    def update_with_cnf_file(self) -> None:
+        """Update the settings with the config file (json), if any."""
+
+        def _snake_to_camel_case(key):
+            key_parts = key.split("_")
+            camel_head = key_parts[0]
+            camel_body = "".join(part.title() for part in key_parts[1:])
+            return f"{camel_head}{camel_body}"
+
+        cnf_dict = self.get_cnf_dict()
+        if not cnf_dict:
             return
 
         try:
@@ -594,7 +596,7 @@ def update_with_env_var(self) -> None:
         available_envvs = set(self.__config.keys())
         # TODO after alpha: is_lambda
         for key in available_envvs:
-            if key in {"inst_enabled", "transaction", "inst"}:
+            if key == "transaction":
                 # we do not allow complex config options to be set via environment variables
                 continue
             env = "SW_APM_" + key.upper()
@@ -717,9 +719,5 @@ def _convert_to_bool(val):
         except (ValueError, TypeError):
             logger.warning(
                 "Ignore config option with invalid (non-convertible or out-of-range) type: %s",
-                ".".join(
-                    keys
-                    if keys[0] not in ["inst", "transaction"]
-                    else keys[1:]
-                ),
+                ".".join(keys if keys[0] != "transaction" else keys[1:]),
             )

tests/unit/test_apm_config/fixtures/cnf_dict.py

@@ -0,0 +1,34 @@
+import pytest
+
+@pytest.fixture
+def fixture_cnf_dict():
+    return {
+        "agentEnabled": True,
+        "tracingMode": "enabled",
+        "triggerTrace": "enabled",
+        "collector": "foo-bar",
+        "reporter": "udp",
+        "debugLevel": 6,
+        "serviceKey": "not-good-to-put-here:wont-be-used",
+        "hostnameAlias": "foo-bar",
+        "trustedpath": "foo-bar",
+        "eventsFlushInterval": 2,
+        "maxRequestSizeBytes": 2,
+        "ec2MetadataTimeout": 1234,
+        "maxFlushWaitTime": 2,
+        "maxTransactions": 2,
+        "logname": "foo-bar",
+        "traceMetrics": 2,
+        "tokenBucketCapacity": 2,
+        "tokenBucketRate": 2,
+        "bufsize": 2,
+        "histogramPrecision": 2,
+        "reporterFileSingle": 2,
+        "enableSanitizeSql": True,
+        "logTraceId": "always",
+        "proxy": "http://foo-bar",
+        "transaction": {
+            "prependDomain": True
+        },
+        "isGrpcCleanHackEnabled": True,
+    }

tests/unit/test_apm_config/fixtures/cnf_file.py

@@ -0,0 +1,14 @@
+import pytest
+
+@pytest.fixture
+def fixture_cnf_file(mocker):
+    read_data = '{"foo": "bar"}'
+    mocked_cnf_file_data = mocker.mock_open(read_data=read_data)
+    builtin_open = "builtins.open"
+    mocker.patch(builtin_open, mocked_cnf_file_data)
+
+@pytest.fixture
+def fixture_cnf_file_invalid_json(mocker):
+    mocked_cnf_file_data = mocker.mock_open(read_data="invalid-foo")
+    builtin_open = "builtins.open"
+    mocker.patch(builtin_open, mocked_cnf_file_data)

tests/unit/test_apm_config/fixtures/env_vars.py

@@ -0,0 +1,15 @@
+import os
+import pytest
+
+from solarwinds_apm.apm_constants import (
+    INTL_SWO_DEFAULT_PROPAGATORS,
+    INTL_SWO_DEFAULT_TRACES_EXPORTER,
+)
+
+@pytest.fixture(name="mock_env_vars")
+def fixture_mock_env_vars(mocker):
+    mocker.patch.dict(os.environ, {
+        "OTEL_PROPAGATORS": ",".join(INTL_SWO_DEFAULT_PROPAGATORS),
+        "OTEL_TRACES_EXPORTER": INTL_SWO_DEFAULT_TRACES_EXPORTER,
+        "SW_APM_SERVICE_KEY": "valid:key",
+    })

tests/unit/test_apm_config.py → tests/unit/test_apm_config/test_apm_config.py

@@ -4,7 +4,6 @@
 #
 # 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 json
 import os
 import pytest
 
@@ -14,18 +13,10 @@
 from solarwinds_apm.apm_constants import (
     INTL_SWO_AO_COLLECTOR,
     INTL_SWO_AO_STG_COLLECTOR,
-    INTL_SWO_DEFAULT_PROPAGATORS,
-    INTL_SWO_DEFAULT_TRACES_EXPORTER,
 )
 
-@pytest.fixture(name="mock_env_vars")
-def fixture_mock_env_vars(mocker):
-    mocker.patch.dict(os.environ, {
-        "OTEL_PROPAGATORS": ",".join(INTL_SWO_DEFAULT_PROPAGATORS),
-        "OTEL_TRACES_EXPORTER": INTL_SWO_DEFAULT_TRACES_EXPORTER,
-        "SW_APM_SERVICE_KEY": "valid:key",
-    })
-
+# pylint: disable=unused-import
+from .fixtures.env_vars import fixture_mock_env_vars
 
 class TestSolarWindsApmConfig:
     """