trace2: detect event/normal formats

Add the infrastructure to detect whether a user has enabled the TRACE2
event format or normal format targets. This implementation has been
designed to be extended to include the perf format target in a future
series.

Additionally it involved some refactoring/cleanup to set the Application
Path and InstallationDirectory in the CommandContext, rather than in
GCM/UI helper Program.cs files.

Author: Lessley Dennington

src/shared/Atlassian.Bitbucket.UI.Avalonia/Program.cs

@@ -1,5 +1,5 @@
 using System;
-using System.CommandLine;
+using System.Diagnostics;
 using System.Threading;
 using Atlassian.Bitbucket.UI.Commands;
 using Atlassian.Bitbucket.UI.Controls;
@@ -45,9 +45,7 @@ private static void AppMain(object o)
         {
             string[] args = (string[]) o;
 
-            string appPath = ApplicationBase.GetEntryApplicationPath();
-            string installDir = ApplicationBase.GetInstallationDirectory();
-            using (var context = new CommandContext(appPath, installDir))
+            using (var context = new CommandContext(args))
             using (var app = new HelperApplication(context))
             {
                 app.RegisterCommand(new CredentialsCommandImpl(context));

src/shared/Core.Tests/StringExtensionsTests.cs

@@ -245,6 +245,7 @@ public void StringExtensions_TrimUntilLastIndexOf_Character_Null_ThrowsArgumentN
         [InlineData("foo://", "://", "")]
         [InlineData("foo://bar", "://", "bar")]
         [InlineData("foo://bar/", "://", "bar/")]
+        [InlineData("foo:/bar/baz", ":", "/bar/baz")]
         public void StringExtensions_TrimUntilLastIndexOf_String(string input, string trim, string expected)
         {
             string actual = StringExtensions.TrimUntilLastIndexOf(input, trim);

src/shared/Core.Tests/Trace2Tests.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Text.RegularExpressions;
 using GitCredentialManager.Tests.Objects;
 using Xunit;
@@ -6,6 +7,38 @@ namespace GitCredentialManager.Tests;
 
 public class Trace2Tests
 {
+    [PlatformTheory(Platforms.Posix)]
+    [InlineData("af_unix:foo", "foo")]
+    [InlineData("af_unix:stream:foo-bar", "foo-bar")]
+    [InlineData("af_unix:dgram:foo-bar-baz", "foo-bar-baz")]
+    public void TryParseEventTarget_Posix_Returns_Expected_Value(string input, string expected)
+    {
+        var environment = new TestEnvironment();
+        var settings = new TestSettings();
+
+        var trace2 = new Trace2(environment, settings.GetTrace2Settings(), new []{""}, DateTimeOffset.UtcNow);
+        var isSuccessful = trace2.TryGetPipeName(input, out var actual);
+
+        Assert.True(isSuccessful);
+        Assert.Matches(actual, expected);
+    }
+
+    [PlatformTheory(Platforms.Windows)]
+    [InlineData("\\\\.\\pipe\\git-foo", "git-foo")]
+    [InlineData("\\\\.\\pipe\\git-foo-bar", "git-foo-bar")]
+    [InlineData("\\\\.\\pipe\\foo\\git-bar", "git-bar")]
+    public void TryParseEventTarget_Windows_Returns_Expected_Value(string input, string expected)
+    {
+        var environment = new TestEnvironment();
+        var settings = new TestSettings();
+
+        var trace2 = new Trace2(environment, settings.GetTrace2Settings(), new []{""}, DateTimeOffset.UtcNow);
+        var isSuccessful = trace2.TryGetPipeName(input, out var actual);
+
+        Assert.True(isSuccessful);
+        Assert.Matches(actual, expected);
+    }
+
     [Theory]
     [InlineData("20190408T191610.507018Z-H9b68c35f-P000059a8")]
     [InlineData("")]
@@ -16,7 +49,8 @@ public void SetSid_Envar_Returns_Expected_Value(string parentSid)
         var environment = new TestEnvironment();
         environment.Variables.Add("GIT_TRACE2_PARENT_SID", parentSid);
 
-        var trace2 = new Trace2(environment);
+        var settings = new TestSettings();
+        var trace2 = new Trace2(environment, settings.GetTrace2Settings(), new []{""}, DateTimeOffset.UtcNow);
         var sid = trace2.SetSid();
 
         Assert.Matches(rx, sid);

src/shared/Core/ApplicationBase.cs

@@ -1,7 +1,9 @@
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
 using System.Reflection;
+using System.IO.Pipes;
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
@@ -75,25 +77,16 @@ public Task<int> RunAsync(string[] args)
                 Context.Trace.WriteLine("Tracing of secrets is enabled. Trace output may contain sensitive information.");
             }
 
+            // Enable TRACE2 tracing
+            Context.Trace2.Start(Context.Streams.Error, Context.FileSystem, Context.ApplicationPath);
+
             return RunInternalAsync(args);
         }
 
         protected abstract Task<int> RunInternalAsync(string[] args);
 
         #region Helpers
 
-        public static string GetEntryApplicationPath()
-        {
-            return PlatformUtils.GetNativeEntryPath() ??
-                   Process.GetCurrentProcess().MainModule?.FileName ??
-                   Environment.GetCommandLineArgs()[0];
-        }
-
-        public static string GetInstallationDirectory()
-        {
-            return AppContext.BaseDirectory;
-        }
-
         /// <summary>
         /// Wait until a debugger has attached to the currently executing process.
         /// </summary>

src/shared/Core/CommandContext.cs

@@ -1,4 +1,6 @@
 using System;
+using System.Collections.Generic;
+using System.Diagnostics;
 using System.IO;
 using GitCredentialManager.Interop.Linux;
 using GitCredentialManager.Interop.MacOS;
@@ -15,7 +17,7 @@ public interface ICommandContext : IDisposable
         /// <summary>
         /// Absolute path the application entry executable.
         /// </summary>
-        string ApplicationPath { get; }
+        string ApplicationPath { get; set; }
 
         /// <summary>
         /// Absolute path to the Git Credential Manager installation directory.
@@ -47,6 +49,11 @@ public interface ICommandContext : IDisposable
         /// </summary>
         ITrace Trace { get; }
 
+        /// <summary>
+        /// Application TRACE2 tracing system.
+        /// </summary>
+        ITrace2 Trace2 { get; }
+
         /// <summary>
         /// File system abstraction (exists mainly for testing).
         /// </summary>
@@ -78,12 +85,11 @@ public interface ICommandContext : IDisposable
     /// </summary>
     public class CommandContext : DisposableObject, ICommandContext
     {
-        public CommandContext(string appPath, string installDir)
+        public CommandContext(string[] argv)
         {
-            EnsureArgument.NotNullOrWhiteSpace(appPath, nameof (appPath));
-
-            ApplicationPath = appPath;
-            InstallationDirectory = installDir;
+            var applicationStartTime = DateTimeOffset.UtcNow;
+            ApplicationPath = GetEntryApplicationPath();
+            InstallationDirectory = GetInstallationDirectory();
 
             Streams = new StandardStreams();
             Trace   = new Trace();
@@ -139,6 +145,7 @@ public CommandContext(string appPath, string installDir)
                 throw new PlatformNotSupportedException();
             }
 
+            Trace2 = new Trace2(Environment, Settings.GetTrace2Settings(), argv, applicationStartTime);
             HttpClientFactory = new HttpClientFactory(FileSystem, Trace, Settings, Streams);
             CredentialStore   = new CredentialStore(this);
         }
@@ -177,7 +184,7 @@ private static string GetGitPath(IEnvironment environment, IFileSystem fileSyste
 
         #region ICommandContext
 
-        public string ApplicationPath { get; }
+        public string ApplicationPath { get; set; }
 
         public string InstallationDirectory { get; }
 
@@ -191,6 +198,8 @@ private static string GetGitPath(IEnvironment environment, IFileSystem fileSyste
 
         public ITrace Trace { get; }
 
+        public ITrace2 Trace2 { get; }
+
         public IFileSystem FileSystem { get; }
 
         public ICredentialStore CredentialStore { get; }
@@ -214,5 +223,17 @@ protected override void ReleaseManagedResources()
         }
 
         #endregion
+
+        public static string GetEntryApplicationPath()
+        {
+            return PlatformUtils.GetNativeEntryPath() ??
+                   Process.GetCurrentProcess().MainModule?.FileName ??
+                   System.Environment.GetCommandLineArgs()[0];
+        }
+
+        public static string GetInstallationDirectory()
+        {
+            return AppContext.BaseDirectory;
+        }
     }
 }

src/shared/Core/Constants.cs

@@ -54,6 +54,8 @@ public static class EnvironmentVariables
             public const string GcmAuthority          = "GCM_AUTHORITY";
             public const string GitTerminalPrompts    = "GIT_TERMINAL_PROMPT";
             public const string GcmAllowWia           = "GCM_ALLOW_WINDOWSAUTH";
+            public const string GitTrace2Event        = "GIT_TRACE2_EVENT";
+            public const string GitTrace2Normal       = "GIT_TRACE2";
 
             /*
              * Unlike other environment variables, these proxy variables are normally lowercase only.
@@ -164,6 +166,13 @@ public static class Remote
                 public const string FetchUrl = "url";
                 public const string PushUrl = "pushUrl";
             }
+
+            public static class Trace2
+            {
+                public const string SectionName = "trace2";
+                public const string EventTarget = "eventtarget";
+                public const string NormalTarget = "normaltarget";
+            }
         }
 
         public static class WindowsRegistry

src/shared/Core/Settings.cs

@@ -166,6 +166,12 @@ public interface ISettings : IDisposable
         /// of host provider auto-detection. Use a zero or negative value to disable probing.
         /// </summary>
         int AutoDetectProviderTimeout { get; }
+
+        /// <summary>
+        /// Get TRACE2 settings.
+        /// </summary>
+        /// <returns>TRACE2 settings object.</returns>
+        Trace2Settings GetTrace2Settings();
     }
 
     public class ProxyConfiguration
@@ -504,6 +510,25 @@ public bool IsInteractionAllowed
 
         public bool GetTracingEnabled(out string value) => _environment.Variables.TryGetValue(KnownEnvars.GcmTrace, out value) && !value.IsFalsey();
 
+        public Trace2Settings GetTrace2Settings()
+        {
+            var settings = new Trace2Settings();
+
+            if (TryGetSetting(Constants.EnvironmentVariables.GitTrace2Event, KnownGitCfg.Trace2.SectionName,
+                    Constants.GitConfiguration.Trace2.EventTarget, out string value))
+            {
+                settings.FormatTargetsAndValues.Add(Trace2FormatTarget.Event, value);
+            }
+
+            if (TryGetSetting(Constants.EnvironmentVariables.GitTrace2Normal, KnownGitCfg.Trace2.SectionName,
+                    Constants.GitConfiguration.Trace2.NormalTarget, out value))
+            {
+                settings.FormatTargetsAndValues.Add(Trace2FormatTarget.Normal, value);
+            }
+
+            return settings;
+        }
+
         public bool IsSecretTracingEnabled => _environment.Variables.GetBooleanyOrDefault(KnownEnvars.GcmTraceSecrets, false);
 
         public bool IsMsalTracingEnabled => _environment.Variables.GetBooleanyOrDefault(Constants.EnvironmentVariables.GcmTraceMsAuth, false);

src/shared/Core/StringExtensions.cs

@@ -228,5 +228,17 @@ public static string TrimMiddle(this string str, string value, StringComparison
 
             return str;
         }
+
+        /// <summary>
+        /// Check whether string contains a specified substring.
+        /// </summary>
+        /// <param name="str">String to check.</param>
+        /// <param name="value">String to locate.</param>
+        /// <param name="comparisonType">Comparison rule for comparing the strings.</param>
+        /// <returns>True if the string contains the substring, false if not.</returns>
+        public static bool Contains(this string str, string value, StringComparison comparisonType)
+        {
+            return str?.IndexOf(value, comparisonType) >= 0;
+        }
     }
 }