added tests to SuggestionStore::GetCompletions

Fix dotnet#2147

Author: baradgur

src/System.CommandLine.Suggest.Tests/TestsWithTestApps.cs

@@ -0,0 +1,74 @@
+using System.IO;
+using System.Linq;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace System.CommandLine.Suggest.Tests;
+
+[Collection("TestsWithTestApps")]
+public class TestsWithTestApps : IDisposable
+{
+    protected readonly ITestOutputHelper Output;
+    protected readonly FileInfo EndToEndTestApp;
+    protected readonly FileInfo WaitAndFailTestApp;
+    protected readonly FileInfo DotnetSuggest;
+    protected readonly (string, string)[] EnvironmentVariables;
+    private readonly DirectoryInfo _dotnetHostDir = DotnetMuxer.Path.Directory;
+    private static string _testRoot;
+
+    protected TestsWithTestApps(ITestOutputHelper output)
+    {
+        Output = output;
+
+        // delete sentinel files for TestApps in order to trigger registration when it's run
+        var sentinelsDir = new DirectoryInfo(Path.Combine(Path.GetTempPath(), "system-commandline-sentinel-files"));
+
+        if (sentinelsDir.Exists)
+        {
+            var sentinels = sentinelsDir
+                .EnumerateFiles()
+                .Where(f => f.Name.Contains("EndToEndTestApp") || f.Name.Contains("WaitAndFailTestApp"));
+
+            foreach (var sentinel in sentinels)
+            {
+                sentinel.Delete();
+            }
+        }
+
+        var currentDirectory = Path.Combine(
+            Directory.GetCurrentDirectory(),
+            "TestAssets");
+
+        EndToEndTestApp = new DirectoryInfo(currentDirectory)
+            .GetFiles("EndToEndTestApp".ExecutableName())
+            .SingleOrDefault();
+
+        WaitAndFailTestApp = new DirectoryInfo(currentDirectory)
+            .GetFiles("WaitAndFailTestApp".ExecutableName())
+            .SingleOrDefault();
+            
+        DotnetSuggest = new DirectoryInfo(currentDirectory)
+            .GetFiles("dotnet-suggest".ExecutableName())
+            .SingleOrDefault();
+
+        PrepareTestHomeDirectoryToAvoidPolluteBuildMachineHome();
+
+        EnvironmentVariables = new[] {
+            ("DOTNET_ROOT", _dotnetHostDir.FullName),
+            ("INTERNAL_TEST_DOTNET_SUGGEST_HOME", _testRoot)};
+    }
+
+    public void Dispose()
+    {
+        if (_testRoot != null && Directory.Exists(_testRoot))
+        {
+            Directory.Delete(_testRoot, recursive: true);
+        }
+    }
+
+    private static void PrepareTestHomeDirectoryToAvoidPolluteBuildMachineHome()
+    {
+        _testRoot = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+        Directory.CreateDirectory(_testRoot);
+    }
+}

src/System.CommandLine.Suggest.Tests/WaitAndFailTestApp/Program.cs

@@ -0,0 +1,25 @@
+using System;
+using System.Threading.Tasks;
+
+namespace WaitAndFailTestApp;
+
+public class Program
+{
+    private static TimeSpan defaultWait = TimeSpan.FromMilliseconds(3000);
+    
+    //we should not be able to receive any suggestion from this test app,
+    //so we are not constructing it using CliConfiguration
+    
+    static async Task Main(string[] args)
+    {
+        var waitPeriod = args.Length > 0 && int.TryParse(args[0], out var millisecondsToWaitParsed)
+            ? TimeSpan.FromMilliseconds(millisecondsToWaitParsed)
+            : defaultWait; 
+        
+        await Task.Delay(waitPeriod);
+        Environment.ExitCode = 1;
+        
+        Console.WriteLine("this 'suggestion' is provided too late and/or with invalid app exit code");
+    }
+}
+

src/System.CommandLine.Suggest.Tests/WaitAndFailTestApp/WaitAndFailTestApp.csproj

@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\System.CommandLine\System.CommandLine.csproj" />
+  </ItemGroup>
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+  </PropertyGroup>
+
+</Project>

src/System.CommandLine.Suggest.Tests/dotnet-suggest.Tests.csproj

@@ -13,6 +13,11 @@
     <Content Remove="EndToEndTestApp/**" />
     <EmbeddedResource Remove="EndToEndTestApp/**" />
     <None Remove="EndToEndTestApp/**" />
+    
+    <Compile Remove="WaitAndFailTestApp/**" />
+    <Content Remove="WaitAndFailTestApp/**" />
+    <EmbeddedResource Remove="WaitAndFailTestApp/**" />
+    <None Remove="WaitAndFailTestApp/**" />
   </ItemGroup>
 
   <ItemGroup>
@@ -67,6 +72,12 @@
 
       <MSBuild BuildInParallel="False" Projects="EndToEndTestApp/EndToEndTestApp.csproj" Targets="Build;Publish" Properties="UseAppHost=true;SelfContained=false;RuntimeIdentifier=$(Rid);PublishDir=$(TestAssetsPath);Configuration=Release">
       </MSBuild>
+      
+      <MSBuild BuildInParallel="False" Projects="WaitAndFailTestApp/WaitAndFailTestApp.csproj" Targets="Restore" Properties="UseAppHost=true;SelfContained=false;RuntimeIdentifier=$(Rid);ForceRestoreToEvaluateSeparately=1;Configuration=Release">
+      </MSBuild>
+
+      <MSBuild BuildInParallel="False" Projects="WaitAndFailTestApp/WaitAndFailTestApp.csproj" Targets="Build;Publish" Properties="UseAppHost=true;SelfContained=false;RuntimeIdentifier=$(Rid);PublishDir=$(TestAssetsPath);Configuration=Release">
+      </MSBuild>
 
     </Target>