Fix issues related to tempfile on Windows

Author: TimPansino

tests/agent_features/test_agent_control_health_check.py

@@ -12,12 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import re
+import sys
 import threading
 import time
 from pathlib import Path
 
 import pytest
-import sys
 from testing_support.fixtures import initialize_agent
 from testing_support.http_client_recorder import HttpClientRecorder
 

tests/agent_features/test_configuration.py

@@ -17,11 +17,11 @@
 import logging
 import pathlib
 import sys
-import tempfile
 import urllib.parse as urlparse
 
 import pytest
 from testing_support.fixtures import override_generic_settings
+from testing_support.util import NamedTemporaryFile
 
 from newrelic.api.exceptions import ConfigurationError
 from newrelic.common.object_names import callable_name
@@ -637,7 +637,7 @@ def test_initialize():
 def test_initialize_raises_if_config_does_not_match_previous():
     error_message = "Configuration has already been done against differing configuration file or environment.*"
     with pytest.raises(ConfigurationError, match=error_message):
-        with tempfile.NamedTemporaryFile() as f:
+        with NamedTemporaryFile() as f:
             f.write(newrelic_ini_contents)
             f.seek(0)
 
@@ -646,7 +646,7 @@ def test_initialize_raises_if_config_does_not_match_previous():
 
 def test_initialize_via_config_file():
     _reset_configuration_done()
-    with tempfile.NamedTemporaryFile() as f:
+    with NamedTemporaryFile() as f:
         f.write(newrelic_ini_contents)
         f.seek(0)
 
@@ -667,7 +667,7 @@ def test_initialize_config_file_does_not_exist():
 
 def test_initialize_environment():
     _reset_configuration_done()
-    with tempfile.NamedTemporaryFile() as f:
+    with NamedTemporaryFile() as f:
         f.write(newrelic_ini_contents)
         f.seek(0)
 
@@ -676,7 +676,7 @@ def test_initialize_environment():
 
 def test_initialize_log_level():
     _reset_configuration_done()
-    with tempfile.NamedTemporaryFile() as f:
+    with NamedTemporaryFile() as f:
         f.write(newrelic_ini_contents)
         f.seek(0)
 
@@ -685,7 +685,7 @@ def test_initialize_log_level():
 
 def test_initialize_log_file():
     _reset_configuration_done()
-    with tempfile.NamedTemporaryFile() as f:
+    with NamedTemporaryFile() as f:
         f.write(newrelic_ini_contents)
         f.seek(0)
 
@@ -700,7 +700,7 @@ def test_initialize_config_file_feature_flag(feature_flag, expect_warning, logge
     apply_config_setting(settings, "feature_flag", feature_flag)
     _reset_configuration_done()
 
-    with tempfile.NamedTemporaryFile() as f:
+    with NamedTemporaryFile() as f:
         f.write(newrelic_ini_contents)
         f.seek(0)
 
@@ -759,7 +759,7 @@ def test_initialize_config_file_with_traces(setting_name, setting_value, expect_
     apply_config_setting(settings, setting_name, setting_value)
     _reset_configuration_done()
 
-    with tempfile.NamedTemporaryFile() as f:
+    with NamedTemporaryFile() as f:
         f.write(newrelic_ini_contents)
         f.seek(0)
 
@@ -951,7 +951,7 @@ def test_initialize_developer_mode(section, expect_error, logger):
     _reset_instrumentation_done()
     _reset_config_parser()
 
-    with tempfile.NamedTemporaryFile() as f:
+    with NamedTemporaryFile() as f:
         f.write(newrelic_ini_contents)
         f.write(section)
         f.seek(0)
@@ -1019,7 +1019,7 @@ def test_toml_parse_development():
     _reset_config_parser()
     _reset_instrumentation_done()
 
-    with tempfile.NamedTemporaryFile(suffix=".toml") as f:
+    with NamedTemporaryFile(suffix=".toml") as f:
         f.write(newrelic_toml_contents)
         f.seek(0)
 
@@ -1041,7 +1041,7 @@ def test_toml_parse_production():
     _reset_config_parser()
     _reset_instrumentation_done()
 
-    with tempfile.NamedTemporaryFile(suffix=".toml") as f:
+    with NamedTemporaryFile(suffix=".toml") as f:
         f.write(newrelic_toml_contents)
         f.seek(0)
 
@@ -1061,7 +1061,7 @@ def test_config_file_path_types_ini(pathtype):
     _reset_config_parser()
     _reset_instrumentation_done()
 
-    with tempfile.NamedTemporaryFile(suffix=".ini") as f:
+    with NamedTemporaryFile(suffix=".ini") as f:
         f.write(newrelic_ini_contents)
         f.seek(0)
 
@@ -1081,7 +1081,7 @@ def test_config_file_path_types_toml(pathtype):
     _reset_config_parser()
     _reset_instrumentation_done()
 
-    with tempfile.NamedTemporaryFile(suffix=".toml") as f:
+    with NamedTemporaryFile(suffix=".toml") as f:
         f.write(newrelic_toml_contents)
         f.seek(0)
 

tests/agent_unittests/conftest.py

@@ -13,12 +13,12 @@
 # limitations under the License.
 
 import sys
-import tempfile
 from importlib import reload
 
 import pytest
 from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture
 from testing_support.fixtures import newrelic_caplog as caplog
+from testing_support.util import NamedTemporaryFile
 
 from newrelic.core.agent import agent_instance
 
@@ -72,7 +72,7 @@ def global_settings(request, monkeypatch):
     reload(core_config)
     reload(config)
 
-    with tempfile.NamedTemporaryFile() as ini_file:
+    with NamedTemporaryFile() as ini_file:
         ini_file.write(ini_contents)
         ini_file.seek(0)
 

tests/agent_unittests/test_agent_protocol.py

@@ -522,7 +522,8 @@ def test_audit_logging():
     protocol = AgentProtocol(settings, client_cls=HttpClientRecorder)
     protocol.send("preconnect")
 
-    with Path(f.name).open() as f:
+    audit_log_path = Path(f.name)
+    with audit_log_path.open() as f:
         audit_log_contents = f.read()
 
     assert audit_log_contents.startswith("*\n")

tests/agent_unittests/test_utilization_settings.py

@@ -12,12 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
-import tempfile
 from importlib import reload
 
 import pytest
 from testing_support.fixtures import Environ
+from testing_support.util import NamedTemporaryFile
 
 # these will be reloaded for each test
 import newrelic.config
@@ -73,8 +72,7 @@
 def reset_agent_config(ini_contents, env_dict):
     @function_wrapper
     def reset(wrapped, instance, args, kwargs):
-        with Environ(env_dict):
-            ini_file = tempfile.NamedTemporaryFile()
+        with Environ(env_dict), NamedTemporaryFile() as ini_file:
             ini_file.write(ini_contents)
             ini_file.seek(0)
 

tests/cross_agent/test_boot_id_utilization_data.py

@@ -14,10 +14,10 @@
 
 import json
 import sys
-import tempfile
 from pathlib import Path
 
 import pytest
+from testing_support.util import NamedTemporaryFile
 from testing_support.validators.validate_internal_metrics import validate_internal_metrics
 
 from newrelic.common.system_info import BootIdUtilization
@@ -57,7 +57,7 @@ def __init__(self, boot_id):
 
     def __enter__(self):
         if self.boot_id is not None:
-            self.boot_id_file = tempfile.NamedTemporaryFile()
+            self.boot_id_file = NamedTemporaryFile().__enter__()
             self.boot_id_file.write(self.boot_id.encode("utf8"))
             self.boot_id_file.seek(0)
             BootIdUtilization.METADATA_URL = self.boot_id_file.name
@@ -68,7 +68,7 @@ def __enter__(self):
     def __exit__(self, *args, **kwargs):
         sys.platform = SYS_PLATFORM
         if self.boot_id:
-            del self.boot_id_file  # close and thus delete the tempfile
+            self.boot_id_file.__exit__(*args, **kwargs)  # close and thus delete the tempfile
 
 
 @pytest.mark.parametrize(_parameters, _boot_id_tests)

tests/cross_agent/test_collector_hostname.py

@@ -16,11 +16,11 @@
 import multiprocessing
 import os
 import sys
-import tempfile
 from importlib import reload
 from pathlib import Path
 
 import pytest
+from testing_support.util import NamedTemporaryFile
 
 FIXTURE = Path(__file__).parent / "fixtures" / "collector_hostname.json"
 
@@ -70,11 +70,12 @@ def _test_collector_hostname(
         reload(core_config)
         reload(config)
 
-        ini_file = tempfile.NamedTemporaryFile()
-        ini_file.write(ini_contents.encode("utf-8"))
-        ini_file.seek(0)
+        with NamedTemporaryFile() as ini_file:
+            ini_file.write(ini_contents.encode("utf-8"))
+            ini_file.seek(0)
+
+            config.initialize(ini_file.name)
 
-        config.initialize(ini_file.name)
         settings = core_config.global_settings()
         assert settings.host == hostname
 

tests/cross_agent/test_utilization_configs.py

@@ -15,7 +15,6 @@
 import json
 import os
 import sys
-import tempfile
 from importlib import reload
 from pathlib import Path
 
@@ -24,6 +23,7 @@
 # NOTE: the test_utilization_settings_from_env_vars test mocks several of the
 # methods in newrelic.core.data_collector and does not put them back!
 from testing_support.mock_http_client import create_client_cls
+from testing_support.util import NamedTemporaryFile
 
 import newrelic.core.config
 from newrelic.common.object_wrapper import function_wrapper
@@ -132,19 +132,19 @@ def _patch_boot_id_file(wrapped, instance, args, kwargs):
         boot_id_file = None
         initial_sys_platform = sys.platform
 
-        if test.get("input_boot_id"):
-            boot_id_file = tempfile.NamedTemporaryFile()
-            boot_id_file.write(test.get("input_boot_id"))
-            boot_id_file.seek(0)
-            BootIdUtilization.METADATA_URL = boot_id_file.name
-            sys.platform = "linux-mock-testing"  # ensure boot_id is gathered
-        else:
-            # do not gather boot_id at all, this will ensure there is nothing
-            # extra in the gathered utilizations data
-            sys.platform = "not-linux"
-
         try:
-            return wrapped(*args, **kwargs)
+            if test.get("input_boot_id"):
+                with NamedTemporaryFile() as boot_id_file:
+                    boot_id_file.write(test.get("input_boot_id"))
+                    boot_id_file.seek(0)
+                    BootIdUtilization.METADATA_URL = boot_id_file.name
+                    sys.platform = "linux-mock-testing"  # ensure boot_id is gathered
+                    return wrapped(*args, **kwargs)
+            else:
+                # do not gather boot_id at all, this will ensure there is nothing
+                # extra in the gathered utilizations data
+                sys.platform = "not-linux"
+                return wrapped(*args, **kwargs)
         finally:
             del boot_id_file  # close and thus delete the tempfile
             sys.platform = initial_sys_platform

tests/testing_support/util.py

@@ -14,8 +14,11 @@
 
 import re
 import socket
+import sys
+import tempfile
 import time
 from functools import wraps
+from pathlib import Path
 
 
 def _to_int(version_str):
@@ -83,3 +86,26 @@ def wrapper(*args, **kwargs):
         return wrapper
 
     return decorator
+
+
+def NamedTemporaryFile(*args, **kwargs):
+    """A wrapper around tempfile.NamedTemporaryFile that fixes issues with file flags on Windows."""
+    if sys.platform == "win32":
+        # Set delete=False to prevent file flags being set incorrectly on Windows.
+        kwargs["delete"] = False
+
+    # Create the temporary file
+    temp_file = tempfile.NamedTemporaryFile(*args, **kwargs)
+    temp_file.path = Path(temp_file.name)  # Add path attribute for convenience
+
+    # Patch the __exit__ method to manually remove the file on exit
+    original_exit = temp_file.__exit__
+
+    def remove_on_exit(*args, **kwargs):
+        original_exit(*args, **kwargs)
+        # Clean up the file manually
+        temp_file.path.unlink(missing_ok=True)
+
+    temp_file.__exit__ = remove_on_exit
+
+    return temp_file