Don't initialize trace if specifically asked not to (#1490)

* Donot initialize trace if specifically asked not to * For Testhost only Initialize Tracing if --diag is passed * test fix * Tracing for datacollector also to be initialized via --diag switch
microsoft · Mar 26, 2018 · eca43d7 · eca43d7
1 parent abfc9ca
commit eca43d7
Show file tree

Hide file tree

Showing 10 changed files with 59 additions and 17 deletions.
diff --git a/src/Microsoft.TestPlatform.CoreUtilities/Tracing/EqtTrace.cs b/src/Microsoft.TestPlatform.CoreUtilities/Tracing/EqtTrace.cs
@@ -72,6 +72,18 @@ public static string LogFile
             }
         }
 
+        public static bool DoNotInitailize
+        {
+            get
+            {
+                return traceImpl.DoNotInitialize;
+            }
+            set
+            {
+                traceImpl.DoNotInitialize = value;
+            }
+        }
+
         public static string ErrorOnInitialization
         {
             get;

diff --git a/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/Tracing/IPlatformEqtTrace.cs b/src/Microsoft.TestPlatform.PlatformAbstractions/Interfaces/Tracing/IPlatformEqtTrace.cs
@@ -9,6 +9,13 @@ namespace Microsoft.VisualStudio.TestPlatform.ObjectModel
     /// </summary>
     public partial interface IPlatformEqtTrace
     {
+        // This is added to ensure that tracing for testhost/datacollector should not be instantiated if not enabled via --diag switch.
+        bool DoNotInitialize
+        {
+            get;
+            set;
+        }
+
         /// <summary>
         /// Adds the message to the trace log.
         /// The line becomes:

diff --git a/src/Microsoft.TestPlatform.PlatformAbstractions/common/Tracing/PlatformEqtTrace.cs b/src/Microsoft.TestPlatform.PlatformAbstractions/common/Tracing/PlatformEqtTrace.cs
@@ -131,7 +131,7 @@ public static string ErrorOnInitialization
         }
 
         // This is added to ensure that traceSource should not be instantiated in when creating appdomains if EqtTrace is not enabled.
-        internal static bool DoNotInitialize
+        public bool DoNotInitialize
         {
             get;
             set;
@@ -175,7 +175,7 @@ public bool InitializeVerboseTrace(string customLogFile)
         /// <inheritdoc/>
         public bool ShouldTrace(PlatformTraceLevel traceLevel)
         {
-            if (DoNotInitialize)
+            if (this.DoNotInitialize)
             {
                 return false;
             }

diff --git a/src/Microsoft.TestPlatform.PlatformAbstractions/net451/Tracing/PlatformEqtTrace.cs b/src/Microsoft.TestPlatform.PlatformAbstractions/net451/Tracing/PlatformEqtTrace.cs
@@ -53,7 +53,7 @@ public void SetupRemoteEqtTraceListeners(AppDomain childDomain)
                 }
                 else
                 {
-                    remoteEqtTrace.DoNotInitialize = true;
+                    this.DoNotInitialize = true;
                 }
             }
         }

diff --git a/src/Microsoft.TestPlatform.PlatformAbstractions/net451/Tracing/RemoteEqtTrace.cs b/src/Microsoft.TestPlatform.PlatformAbstractions/net451/Tracing/RemoteEqtTrace.cs
@@ -28,17 +28,6 @@ public TraceLevel TraceLevel
             }
         }
 
-        /// <summary>
-        /// This is added to ensure that traceSource should not be instantiated in when creating appdomains if EqtTrace is not enabled.
-        /// </summary>
-        internal bool DoNotInitialize
-        {
-            set
-            {
-                PlatformEqtTrace.DoNotInitialize = value;
-            }
-        }
-
         /// <summary>
         /// Register listeners from parent domain in current domain.
         /// </summary>

diff --git a/src/Microsoft.TestPlatform.PlatformAbstractions/netstandard1.0/Tracing/PlatformEqtTrace.cs b/src/Microsoft.TestPlatform.PlatformAbstractions/netstandard1.0/Tracing/PlatformEqtTrace.cs
@@ -23,6 +23,12 @@ public class PlatformEqtTrace : IPlatformEqtTrace
     {
         public static string ErrorOnInitialization { get; set; }
 
+        public bool DoNotInitialize
+        {
+            get => throw new NotImplementedException();
+            set => throw new NotImplementedException();
+        }
+
         public void WriteLine(PlatformTraceLevel level, string message)
         {
             throw new NotImplementedException();

diff --git a/src/Microsoft.TestPlatform.PlatformAbstractions/uap10.0/Tracing/PlatformEqtTrace.cs b/src/Microsoft.TestPlatform.PlatformAbstractions/uap10.0/Tracing/PlatformEqtTrace.cs
@@ -30,6 +30,12 @@ public class PlatformEqtTrace : IPlatformEqtTrace
 
         public static string LogFile { get; set; }
 
+        public bool DoNotInitialize
+        {
+            get;
+            set;
+        }
+
         private static PlatformTraceLevel TraceLevel { get; set; }
 
         /// <inheritdoc/>

diff --git a/src/datacollector/Program.cs b/src/datacollector/Program.cs
@@ -72,6 +72,10 @@ private static void Run(string[] args)
             {
                 EqtTrace.InitializeVerboseTrace(logFile);
             }
+            else
+            {
+                EqtTrace.DoNotInitailize = true;
+            }
 
             // Attach to exit of parent process
             var parentProcessId = CommandLineArgumentsHelper.GetIntArgFromDict(argsDictionary, ParentProcessArgument);

diff --git a/src/testhost.x86/DefaultEngineInvoker.cs b/src/testhost.x86/DefaultEngineInvoker.cs
@@ -49,12 +49,14 @@ internal class DefaultEngineInvoker :
         public void Invoke(IDictionary<string, string> argsDictionary)
         {
             // Setup logging if enabled
-            string logFile;
-            if (argsDictionary.TryGetValue(LogFileArgument, out logFile))
+            if (argsDictionary.TryGetValue(LogFileArgument, out string logFile))
             {
                 EqtTrace.InitializeVerboseTrace(logFile);
             }
-
+            else
+            {
+                EqtTrace.DoNotInitailize = true;
+            }
 #if NET451
             if (EqtTrace.IsInfoEnabled)
             {

diff --git a/test/Microsoft.TestPlatform.CoreUtilities.UnitTests/Tracing/EqtTraceTests.cs b/test/Microsoft.TestPlatform.CoreUtilities.UnitTests/Tracing/EqtTraceTests.cs
@@ -19,6 +19,8 @@ public class EqtTraceTests
         [ClassInitialize]
         public static void Init(TestContext testContext)
         {
+            // Set DoNotInitailize to false.
+            EqtTrace.DoNotInitailize = false;
             dirPath = Path.Combine(Path.GetTempPath(), "TraceUT");
             try
             {
@@ -119,6 +121,7 @@ public void TraceShouldWriteVerbose()
             EqtTrace.Verbose("Dummy Verbose Message");
             Assert.IsTrue(ReadLogFile().Contains("Dummy Verbose Message"), "Expected Verbose message");
         }
+
         [TestMethod]
         public void TraceShouldWriteInfo()
         {
@@ -131,6 +134,19 @@ public void TraceShouldWriteInfo()
             Assert.IsTrue(ReadLogFile().Contains("Dummy Info Message"), "Expected Info message");
         }
 
+        [TestMethod]
+        public void TraceShouldNotWriteIfDoNotInitializationIsSetToTrue()
+        {
+            EqtTrace.DoNotInitailize = true;
+#if NET451
+            EqtTrace.TraceLevel = TraceLevel.Info;
+#else
+            EqtTrace.TraceLevel = PlatformTraceLevel.Info;
+#endif
+            EqtTrace.Info("Dummy Info Message: TraceShouldNotWriteIfDoNotInitializationIsSetToTrue");
+            Assert.IsTrue(!ReadLogFile().Contains("Dummy Info Message: TraceShouldNotWriteIfDoNotInitializationIsSetToTrue"), "Did not expect Dummy Info message");
+        }
+
         private string ReadLogFile()
         {
             string log = null;