[1704] Clarify why we update the environment in check_environment_unchanged()

diff --git a/src/bin/bind10/tests/bind10_test.py.in b/src/bin/bind10/tests/bind10_test.py.in
index 5e5afbac75bf1c08a2a96dcfe72575f6ddf9868e..188ba8b02f8b336b7b483b680c27f77e463bad44 100644 (file)
--- a/src/bin/bind10/tests/bind10_test.py.in
+++ b/src/bin/bind10/tests/bind10_test.py.in
@@ -684,6 +684,11 @@ class TestStartStopProcessesBob(unittest.TestCase):
     """
     def check_environment_unchanged(self):
         # Check whether the environment has not been changed
+
+        # First, we delete the B10_LOCKFILE_DIR_FROM_BUILD key from both
+        # environments' copies. This is because this key can be
+        # set/updated during initialization and we don't care if it
+        # changes. We only test the rest of the environment.
         cur_os_environ = copy.deepcopy(os.environ)
         if "B10_LOCKFILE_DIR_FROM_BUILD" in original_os_environ:
             original_os_environ.pop("B10_LOCKFILE_DIR_FROM_BUILD")