Disable TB Testing (aws#275)

Author: NihalHarish

tests/utils.py

@@ -0,0 +1,80 @@
+# Standard Library
+import os
+import shutil
+from pathlib import Path
+
+# First Party
+from smdebug.core.config_constants import (
+    CONFIG_FILE_PATH_ENV_STR,
+    DEFAULT_SAGEMAKER_OUTDIR,
+    DEFAULT_SAGEMAKER_TENSORBOARD_PATH,
+    TENSORBOARD_CONFIG_FILE_PATH_ENV_STR,
+)
+from smdebug.core.utils import remove_file_if_exists
+
+
+class SagemakerSimulator(object):
+    """
+    Creates an environment variable pointing to a JSON config file, and creates the config file.
+    Used for integration testing with zero-code-change.
+
+    If `disable=True`, then we still create the `out_dir` directory, but ignore the config file.
+    """
+
+    def __init__(
+        self,
+        json_config_path="/tmp/zcc_config.json",
+        tensorboard_dir="/tmp/tensorboard",
+        training_job_name="sm_job",
+        json_file_contents="{}",
+        enable_tb=True,
+        cleanup=True,
+    ):
+        self.out_dir = DEFAULT_SAGEMAKER_OUTDIR
+        self.json_config_path = json_config_path
+        self.tb_json_config_path = DEFAULT_SAGEMAKER_TENSORBOARD_PATH
+        self.tensorboard_dir = tensorboard_dir
+        self.training_job_name = training_job_name
+        self.json_file_contents = json_file_contents
+        self.enable_tb = enable_tb
+        self.cleanup = cleanup
+
+    def __enter__(self):
+        if self.cleanup is True:
+            shutil.rmtree(self.out_dir, ignore_errors=True)
+        shutil.rmtree(self.json_config_path, ignore_errors=True)
+        tb_parent_dir = str(Path(self.tb_json_config_path).parent)
+        shutil.rmtree(tb_parent_dir, ignore_errors=True)
+
+        os.environ[CONFIG_FILE_PATH_ENV_STR] = self.json_config_path
+        os.environ["TRAINING_JOB_NAME"] = self.training_job_name
+        with open(self.json_config_path, "w+") as my_file:
+            # We'll just use the defaults, but the file is expected to exist
+            my_file.write(self.json_file_contents)
+
+        if self.enable_tb is True:
+            os.environ[TENSORBOARD_CONFIG_FILE_PATH_ENV_STR] = self.tb_json_config_path
+            os.makedirs(tb_parent_dir, exist_ok=True)
+            with open(self.tb_json_config_path, "w+") as my_file:
+                my_file.write(
+                    f"""
+                    {{
+                        "LocalPath": "{self.tensorboard_dir}"
+                    }}
+                    """
+                )
+
+        return self
+
+    def __exit__(self, *args):
+        # Throws errors when the writers try to close.
+        # shutil.rmtree(self.out_dir, ignore_errors=True)
+        if self.cleanup is True:
+            remove_file_if_exists(self.json_config_path)
+            remove_file_if_exists(self.tb_json_config_path)
+            if CONFIG_FILE_PATH_ENV_STR in os.environ:
+                del os.environ[CONFIG_FILE_PATH_ENV_STR]
+            if "TRAINING_JOB_NAME" in os.environ:
+                del os.environ["TRAINING_JOB_NAME"]
+            if TENSORBOARD_CONFIG_FILE_PATH_ENV_STR in os.environ:
+                del os.environ[TENSORBOARD_CONFIG_FILE_PATH_ENV_STR]

tests/zero_code_change/test_tensorflow2_integration.py

@@ -20,11 +20,11 @@
 # Third Party
 import pytest
 import tensorflow.compat.v2 as tf
+from tests.utils import SagemakerSimulator
 
 # First Party
 import smdebug.tensorflow as smd
 from smdebug.core.collection import CollectionKeys
-from smdebug.core.utils import SagemakerSimulator
 
 
 def get_keras_model_v2():
@@ -52,7 +52,8 @@ def helper_test_keras_v2(script_mode: bool = False, eager_mode: bool = True):
     tf.keras.backend.clear_session()
     if not eager_mode:
         tf.compat.v1.disable_eager_execution()
-    with SagemakerSimulator() as sim:
+    enable_tb = False if tf.__version__ == "2.0.2" else True
+    with SagemakerSimulator(enable_tb=enable_tb) as sim:
         model = get_keras_model_v2()
         (x_train, y_train), (x_test, y_test) = get_keras_data()
         x_train, x_test = x_train / 255, x_test / 255
@@ -102,7 +103,8 @@ def helper_test_keras_v2_json_config(
     tf.keras.backend.clear_session()
     if not eager_mode:
         tf.compat.v1.disable_eager_execution()
-    with SagemakerSimulator(json_file_contents=json_file_contents) as sim:
+    enable_tb = False if tf.__version__ == "2.0.2" else True
+    with SagemakerSimulator(json_file_contents=json_file_contents, enable_tb=enable_tb) as sim:
         model = get_keras_model_v2()
         (x_train, y_train), (x_test, y_test) = get_keras_data()
         x_train, x_test = x_train / 255, x_test / 255