File size: 10,593 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Management.Automation.Language;
using System.Management.Automation.Subsystem;
using System.Management.Automation.Subsystem.Prediction;
using System.Threading;
using Xunit;
namespace PSTests.Sequential
{
public class MyPredictor : ICommandPredictor
{
private readonly Guid _id;
private readonly string _name, _description;
private readonly bool _delay;
public List<string> History { get; }
public List<string> Results { get; }
public List<string> AcceptedSuggestions { get; }
public List<string> DisplayedSuggestions { get; }
public static readonly MyPredictor SlowPredictor, FastPredictor;
static MyPredictor()
{
SlowPredictor = new MyPredictor(
Guid.NewGuid(),
"Test Predictor #1",
"Description for #1 predictor.",
delay: true);
FastPredictor = new MyPredictor(
Guid.NewGuid(),
"Test Predictor #2",
"Description for #2 predictor.",
delay: false);
}
private MyPredictor(Guid id, string name, string description, bool delay)
{
_id = id;
_name = name;
_description = description;
_delay = delay;
History = new List<string>();
Results = new List<string>();
AcceptedSuggestions = new List<string>();
DisplayedSuggestions = new List<string>();
}
public void Clear()
{
History.Clear();
Results.Clear();
AcceptedSuggestions.Clear();
DisplayedSuggestions.Clear();
}
#region "Interface implementation"
public Guid Id => _id;
public string Name => _name;
public string Description => _description;
bool ICommandPredictor.CanAcceptFeedback(PredictionClient client, PredictorFeedbackKind feedback) => true;
public SuggestionPackage GetSuggestion(PredictionClient client, PredictionContext context, CancellationToken cancellationToken)
{
if (_delay)
{
// The delay is exaggerated to make the test reliable.
// xUnit must spin up a lot tasks, which makes the test unreliable when the time difference between 'delay' and 'timeout' is small.
Thread.Sleep(3000);
}
// You can get the user input from the AST.
var userInput = context.InputAst.Extent.Text;
var entries = new List<PredictiveSuggestion>
{
new PredictiveSuggestion($"'{userInput}' from '{client.Name}' - TEST-1 from {Name}"),
new PredictiveSuggestion($"'{userInput}' from '{client.Name}' - TeSt-2 from {Name}"),
};
return new SuggestionPackage(56, entries);
}
public void OnSuggestionDisplayed(PredictionClient client, uint session, int countOrIndex)
{
DisplayedSuggestions.Add($"{client.Name}-{session}-{countOrIndex}");
}
public void OnSuggestionAccepted(PredictionClient client, uint session, string acceptedSuggestion)
{
AcceptedSuggestions.Add($"{client.Name}-{session}-{acceptedSuggestion}");
}
public void OnCommandLineAccepted(PredictionClient client, IReadOnlyList<string> history)
{
foreach (string item in history)
{
History.Add($"{client.Name}-{item}");
}
}
public void OnCommandLineExecuted(PredictionClient client, string commandLine, bool success)
{
Results.Add($"{client.Name}-{commandLine}-{success}");
}
#endregion
}
public static class CommandPredictionTests
{
private const string Client = "PredictionTest";
private const uint Session = 56;
private static readonly PredictionClient predClient = new(Client, PredictionClientKind.Terminal);
[Fact]
public static void PredictInput()
{
const string Input = "Hello world";
MyPredictor slow = MyPredictor.SlowPredictor;
MyPredictor fast = MyPredictor.FastPredictor;
Ast ast = Parser.ParseInput(Input, out Token[] tokens, out _);
// Returns null when no predictor implementation registered
List<PredictionResult> results = CommandPrediction.PredictInputAsync(predClient, ast, tokens).Result;
Assert.Null(results);
try
{
// Register 2 predictor implementations
SubsystemManager.RegisterSubsystem<ICommandPredictor, MyPredictor>(slow);
SubsystemManager.RegisterSubsystem(SubsystemKind.CommandPredictor, fast);
// Expect the results from 'fast' predictor only b/c the 'slow' one
// cannot finish before the specified timeout.
// The specified timeout is exaggerated to make the test reliable.
// xUnit must spin up a lot tasks, which makes the test unreliable when the time difference between 'delay' and 'timeout' is small.
results = CommandPrediction.PredictInputAsync(predClient, ast, tokens, millisecondsTimeout: 1500).Result;
Assert.Single(results);
PredictionResult res = results[0];
Assert.Equal(fast.Id, res.Id);
Assert.Equal(Session, res.Session);
Assert.Equal(2, res.Suggestions.Count);
Assert.Equal($"'{Input}' from '{Client}' - TEST-1 from {fast.Name}", res.Suggestions[0].SuggestionText);
Assert.Equal($"'{Input}' from '{Client}' - TeSt-2 from {fast.Name}", res.Suggestions[1].SuggestionText);
// Expect the results from both 'slow' and 'fast' predictors
// Same here -- the specified timeout is exaggerated to make the test reliable.
// xUnit must spin up a lot tasks, which makes the test unreliable when the time difference between 'delay' and 'timeout' is small.
results = CommandPrediction.PredictInputAsync(predClient, ast, tokens, millisecondsTimeout: 4000).Result;
Assert.Equal(2, results.Count);
PredictionResult res1 = results[0];
Assert.Equal(slow.Id, res1.Id);
Assert.Equal(Session, res1.Session);
Assert.Equal(2, res1.Suggestions.Count);
Assert.Equal($"'{Input}' from '{Client}' - TEST-1 from {slow.Name}", res1.Suggestions[0].SuggestionText);
Assert.Equal($"'{Input}' from '{Client}' - TeSt-2 from {slow.Name}", res1.Suggestions[1].SuggestionText);
PredictionResult res2 = results[1];
Assert.Equal(fast.Id, res2.Id);
Assert.Equal(Session, res2.Session);
Assert.Equal(2, res2.Suggestions.Count);
Assert.Equal($"'{Input}' from '{Client}' - TEST-1 from {fast.Name}", res2.Suggestions[0].SuggestionText);
Assert.Equal($"'{Input}' from '{Client}' - TeSt-2 from {fast.Name}", res2.Suggestions[1].SuggestionText);
}
finally
{
SubsystemManager.UnregisterSubsystem<ICommandPredictor>(slow.Id);
SubsystemManager.UnregisterSubsystem(SubsystemKind.CommandPredictor, fast.Id);
}
}
[Fact]
public static void Feedback()
{
MyPredictor slow = MyPredictor.SlowPredictor;
MyPredictor fast = MyPredictor.FastPredictor;
slow.Clear();
fast.Clear();
try
{
// Register 2 predictor implementations
SubsystemManager.RegisterSubsystem<ICommandPredictor, MyPredictor>(slow);
SubsystemManager.RegisterSubsystem(SubsystemKind.CommandPredictor, fast);
var history = new[] { "hello", "world" };
var ids = new HashSet<Guid> { slow.Id, fast.Id };
CommandPrediction.OnCommandLineAccepted(predClient, history);
CommandPrediction.OnCommandLineExecuted(predClient, "last_input", true);
CommandPrediction.OnSuggestionDisplayed(predClient, slow.Id, Session, 2);
CommandPrediction.OnSuggestionDisplayed(predClient, fast.Id, Session, -1);
CommandPrediction.OnSuggestionAccepted(predClient, slow.Id, Session, "Yeah");
// The feedback calls are queued in thread pool, so let's wait a bit to make sure the calls are done.
while (slow.History.Count == 0 || fast.History.Count == 0 ||
slow.Results.Count == 0 || fast.Results.Count == 0 ||
slow.DisplayedSuggestions.Count == 0 || fast.DisplayedSuggestions.Count == 0 ||
slow.AcceptedSuggestions.Count == 0)
{
Thread.Sleep(300);
}
Assert.Equal(2, slow.History.Count);
Assert.Equal($"{Client}-{history[0]}", slow.History[0]);
Assert.Equal($"{Client}-{history[1]}", slow.History[1]);
Assert.Equal(2, fast.History.Count);
Assert.Equal($"{Client}-{history[0]}", fast.History[0]);
Assert.Equal($"{Client}-{history[1]}", fast.History[1]);
Assert.Single(slow.Results);
Assert.Equal($"{Client}-last_input-True", slow.Results[0]);
Assert.Single(fast.Results);
Assert.Equal($"{Client}-last_input-True", fast.Results[0]);
Assert.Single(slow.DisplayedSuggestions);
Assert.Equal($"{Client}-{Session}-2", slow.DisplayedSuggestions[0]);
Assert.Single(fast.DisplayedSuggestions);
Assert.Equal($"{Client}-{Session}--1", fast.DisplayedSuggestions[0]);
Assert.Single(slow.AcceptedSuggestions);
Assert.Equal($"{Client}-{Session}-Yeah", slow.AcceptedSuggestions[0]);
Assert.Empty(fast.AcceptedSuggestions);
}
finally
{
SubsystemManager.UnregisterSubsystem<ICommandPredictor>(slow.Id);
SubsystemManager.UnregisterSubsystem(SubsystemKind.CommandPredictor, fast.Id);
}
}
}
}
|