public static async Task <ILanguageClient> StartServerWithTextAsync(TestContext testContext, string text, DocumentUri documentUri, Action <LanguageClientOptions>?onClientOptions = null, IResourceTypeProvider?resourceTypeProvider = null, IFileResolver?fileResolver = null)
{
var diagnosticsPublished = new TaskCompletionSource <PublishDiagnosticsParams>();
fileResolver ??= new InMemoryFileResolver(new Dictionary <Uri, string> {
[documentUri.ToUri()] = text,
});
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(
testContext,
options =>
{
onClientOptions?.Invoke(options);
options.OnPublishDiagnostics(p =>
{
testContext.WriteLine($"Received {p.Diagnostics.Count()} diagnostic(s).");
diagnosticsPublished.SetResult(p);
});
},
resourceTypeProvider : resourceTypeProvider,
fileResolver : fileResolver);
// send open document notification
client.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(documentUri, text, 0));
testContext.WriteLine($"Opened file {documentUri}.");
// notifications don't produce responses,
// but our server should send us diagnostics when it receives the notification
await IntegrationTestHelper.WithTimeoutAsync(diagnosticsPublished.Task);
return(client);
}
public async Task RequestDocumentFormattingShouldReturnFullRangeTextEdit()
{
var documentUri = DocumentUri.From("/template.bicep");
var diagnosticsReceived = new TaskCompletionSource <PublishDiagnosticsParams>();
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(this.TestContext, options =>
{
options.OnPublishDiagnostics(diagnostics => {
diagnosticsReceived.SetResult(diagnostics);
});
});
// client opens the document
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(documentUri, @"
param myParam object
// line comment
var myVar1 = 1 + mod(1, 2)
var myVar2 = myParam.foo[1]
resource myResource 'myRP/provider@2020-11-01' = {
/* block
comment
*/
name: 'test'
}
module myModule './module.bicep' = {
name: 'test'
}
output myOutput string = 'value'", 0));
// client requests symbols
var textEditContainer = await client.TextDocument.RequestDocumentFormatting(new DocumentFormattingParams
{
TextDocument = new TextDocumentIdentifier
{
Uri = documentUri
},
Options = new FormattingOptions
{
TabSize = 4,
InsertSpaces = true,
InsertFinalNewline = true,
}
});
textEditContainer.Should().NotBeNull();
textEditContainer.Should().HaveCount(1);
}
public static async Task <ILanguageClient> StartServerWithTextAsync(string text, DocumentUri uri, Action <LanguageClientOptions>?onClientOptions = null, Func <IResourceTypeProvider>?typeProviderBuilder = null)
{
var diagnosticsPublished = new TaskCompletionSource <PublishDiagnosticsParams>();
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(options =>
{
onClientOptions?.Invoke(options);
options.OnPublishDiagnostics(p => diagnosticsPublished.SetResult(p));
}, typeProviderBuilder);
// send open document notification
client.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(uri, text, 0));
// notifications don't produce responses,
// but our server should send us diagnostics when it receives the notification
await IntegrationTestHelper.WithTimeoutAsync(diagnosticsPublished.Task);
return(client);
}
private async Task <(ILanguageClient, MultipleMessageListener <PublishDiagnosticsParams>, string testOutputPath)> StartServerWithClientConnectionAsync()
{
var fileSystemDict = new Dictionary <Uri, string>();
var fileResolver = new InMemoryFileResolver(fileSystemDict);
var diagsListener = new MultipleMessageListener <PublishDiagnosticsParams>();
var serverOptions = new Server.CreationOptions(FileResolver: fileResolver);
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(
TestContext,
options =>
{
options.OnPublishDiagnostics(diags => diagsListener.AddMessage(diags));
},
serverOptions);
var testOutputPath = Path.Combine(TestContext.ResultsDirectory, Guid.NewGuid().ToString());
return(client, diagsListener, testOutputPath);
}
private async Task <BicepTelemetryEvent> ResolveCompletionAsync(string text, string prefix, Position position)
{
var fileSystemDict = new Dictionary <Uri, string>();
var telemetryReceived = new TaskCompletionSource <BicepTelemetryEvent>();
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(
TestContext,
options =>
{
options.OnTelemetryEvent <BicepTelemetryEvent>(telemetry => telemetryReceived.SetResult(telemetry));
},
resourceTypeProvider : AzResourceTypeProvider.CreateWithAzTypes(),
fileResolver : new InMemoryFileResolver(fileSystemDict));
var mainUri = DocumentUri.FromFileSystemPath("/main.bicep");
fileSystemDict[mainUri.ToUri()] = text;
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUri()], 1));
var completions = await client.RequestCompletion(new CompletionParams
{
TextDocument = new TextDocumentIdentifier(mainUri),
Position = position,
});
CompletionItem completionItem = completions.Where(x => x.Kind == CompletionItemKind.Snippet && x.Label == prefix).First();
Command? command = completionItem.Command;
JArray? arguments = command !.Arguments;
BicepTelemetryEvent?telemetryEvent = arguments !.First().ToObject <BicepTelemetryEvent>();
await client.ResolveCompletion(completionItem);
await client.Workspace.ExecuteCommand(command);
return(await IntegrationTestHelper.WithTimeoutAsync(telemetryReceived.Task));
}
public async Task Build_command_should_generate_template_with_symbolic_names_if_enabled()
{
var diagnosticsListener = new MultipleMessageListener <PublishDiagnosticsParams>();
var features = BicepTestConstants.CreateFeaturesProvider(
TestContext,
symbolicNameCodegenEnabled: true,
assemblyFileVersion: BicepTestConstants.DevAssemblyFileVersion);
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(
this.TestContext,
options => options.OnPublishDiagnostics(diagnosticsParams => diagnosticsListener.AddMessage(diagnosticsParams)),
new LanguageServer.Server.CreationOptions(
NamespaceProvider: BuiltInTestTypes.Create(),
Features: features));
var outputDirectory = FileHelper.SaveEmbeddedResourcesWithPathPrefix(
TestContext,
typeof(ExamplesTests).Assembly,
"Bicep.Core.Samples/Resources_CRLF");
var bicepFilePath = Path.Combine(outputDirectory, "main.bicep");
var expectedJson = File.ReadAllText(Path.Combine(outputDirectory, "main.symbolicnames.json"));
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParamsFromFile(bicepFilePath, 1));
await diagnosticsListener.WaitNext();
await client.Workspace.ExecuteCommand(new Command {
Name = "build",
Arguments = new JArray {
bicepFilePath,
}
});
var buildCommandOutput = File.ReadAllText(Path.ChangeExtension(bicepFilePath, ".json"));
buildCommandOutput.Should().BeEquivalentToIgnoringNewlines(expectedJson);
}
public async Task RequestDeploymentGraphShouldReturnDeploymentGraph()
{
var diagnosticsListener = new MultipleMessageListener <PublishDiagnosticsParams>();
var fileSystemDict = new Dictionary <Uri, string>();
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(
this.TestContext,
options => options.OnPublishDiagnostics(diagnosticsParams => diagnosticsListener.AddMessage(diagnosticsParams)),
BuiltInTestTypes.Create(),
new InMemoryFileResolver(fileSystemDict));
var mainUri = DocumentUri.FromFileSystemPath("/main.bicep");
fileSystemDict[mainUri.ToUri()] = @"
resource res1 'Test.Rp/basicTests@2020-01-01' = {
name: 'res1'
}
resource res2 'Test.Rp/readWriteTests@2020-01-01' = {
name: 'res2'
properites: {
readwrite: mod1.outputs.output1
}
}
resource unknownRes = {
}
module mod1 './modules/module1.bicep' = {
name: 'mod1'
}
module mod2 './modules/module2.bicep' = {
name: 'mod2'
}
module nonExistingMod './path/to/nonExistingModule.bicep' = {
}
";
var module1Uri = DocumentUri.FromFileSystemPath("/modules/module1.bicep");
fileSystemDict[module1Uri.ToUri()] = @"
resource res3 'Test.Rp/basicTests@2020-01-01' = {
name: 'res3'
}
output output1 int = 123
";
var module2Uri = DocumentUri.FromFileSystemPath("/modules/module2.bicep");
fileSystemDict[module2Uri.ToUri()] = @"
resource res4 'Test.Rp/basicTests@2020-01-01' = {
name: 'res4'
}
module nestedMod './nestedModules/nestedModule.bicep' = [for x in []: {
name: 'nestedMod'
dependsOn: [
res4
]
}]
";
var nestedModuleUri = DocumentUri.FromFileSystemPath("/modules/nestedModules/nestedModule.bicep");
fileSystemDict[nestedModuleUri.ToUri()] = @"
resource res5 'Test.Rp/basicTests@2020-01-01' = {
name: 'res5'
}
";
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUri()], 1));
await diagnosticsListener.WaitNext();
var deploymentGraph = await client.SendRequest(new BicepDeploymentGraphParams(new TextDocumentIdentifier(mainUri)), default);
deploymentGraph.Should().NotBeNull();
deploymentGraph !.Nodes.Should().Equal(
new BicepDeploymentGraphNode("mod1", "<module>", false, CreateTextRange(15, 0, 17, 1), true, false, Path.GetFullPath(module1Uri.GetFileSystemPath())),
new BicepDeploymentGraphNode("mod1::res3", "Test.Rp/basicTests", false, CreateTextRange(1, 0, 3, 1), false, false, Path.GetFullPath(module1Uri.GetFileSystemPath())),
new BicepDeploymentGraphNode("mod2", "<module>", false, CreateTextRange(19, 0, 21, 1), true, false, Path.GetFullPath(module2Uri.GetFileSystemPath())),
new BicepDeploymentGraphNode("mod2::nestedMod", "<module>", true, CreateTextRange(5, 0, 9, 1), true, false, Path.GetFullPath(nestedModuleUri.GetFileSystemPath())),
new BicepDeploymentGraphNode("mod2::nestedMod::res5", "Test.Rp/basicTests", false, CreateTextRange(1, 0, 3, 1), false, false, Path.GetFullPath(nestedModuleUri.GetFileSystemPath())),
new BicepDeploymentGraphNode("mod2::res4", "Test.Rp/basicTests", false, CreateTextRange(1, 0, 3, 1), false, false, Path.GetFullPath(module2Uri.GetFileSystemPath())),
new BicepDeploymentGraphNode("nonExistingMod", "<module>", false, CreateTextRange(23, 0, 24, 1), false, true, Path.GetFullPath("/path/to/nonExistingModule.bicep")),
new BicepDeploymentGraphNode("res1", "Test.Rp/basicTests", false, CreateTextRange(1, 0, 3, 1), false, false, Path.GetFullPath(mainUri.GetFileSystemPath())),
new BicepDeploymentGraphNode("res2", "Test.Rp/readWriteTests", false, CreateTextRange(5, 0, 10, 1), false, true, Path.GetFullPath(mainUri.GetFileSystemPath())));
deploymentGraph !.Edges.Should().Equal(
new BicepDeploymentGraphEdge("mod2::nestedMod", "mod2::res4"),
new BicepDeploymentGraphEdge("res2", "mod1"));
deploymentGraph !.ErrorCount.Should().Be(7);
}
public async Task RequestDocumentSymbol_should_return_full_symbol_list()
{
var documentUri = DocumentUri.From("/template.bicep");
var diagsReceived = new TaskCompletionSource <PublishDiagnosticsParams>();
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(options =>
{
options.OnPublishDiagnostics(diags => {
diagsReceived.SetResult(diags);
});
});
// client opens the document
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(documentUri, @"
param myParam string = 'test'
resource myRes 'myRp/provider@2019-01-01' = {
name: 'test'
}
module myMod './module.bicep' = {
name: 'test'
}
output myOutput string = 'myOutput'
", 0));
// client requests symbols
var symbols = await client.TextDocument.RequestDocumentSymbol(new DocumentSymbolParams
{
TextDocument = new TextDocumentIdentifier
{
Uri = documentUri,
},
});
symbols.Should().SatisfyRespectively(
x => {
x.DocumentSymbol !.Name.Should().Be("myParam");
x.DocumentSymbol.Kind.Should().Be(SymbolKind.Field);
},
x => {
x.DocumentSymbol !.Name.Should().Be("myRes");
x.DocumentSymbol.Kind.Should().Be(SymbolKind.Object);
},
x => {
x.DocumentSymbol !.Name.Should().Be("myMod");
x.DocumentSymbol.Kind.Should().Be(SymbolKind.Module);
},
x => {
x.DocumentSymbol !.Name.Should().Be("myOutput");
x.DocumentSymbol.Kind.Should().Be(SymbolKind.Interface);
}
);
// client deletes the output and renames the resource
client.TextDocument.DidChangeTextDocument(TextDocumentParamHelper.CreateDidChangeTextDocumentParams(documentUri, @"
param myParam string = 'test'
resource myRenamedRes 'myRp/provider@2019-01-01' = {
name: 'test'
}
module myMod './module.bicep' = {
name: 'test'
}
", 1));
// client requests symbols
symbols = await client.TextDocument.RequestDocumentSymbol(new DocumentSymbolParams
{
TextDocument = new TextDocumentIdentifier
{
Uri = documentUri,
},
});
symbols.Should().SatisfyRespectively(
x => {
x.DocumentSymbol !.Name.Should().Be("myParam");
x.DocumentSymbol.Kind.Should().Be(SymbolKind.Field);
},
x => {
x.DocumentSymbol !.Name.Should().Be("myRenamedRes");
x.DocumentSymbol.Kind.Should().Be(SymbolKind.Object);
},
x => {
x.DocumentSymbol !.Name.Should().Be("myMod");
x.DocumentSymbol.Kind.Should().Be(SymbolKind.Module);
}
);
}
public async Task DidOpenTextDocument_should_trigger_PublishDiagnostics()
{
var documentUri = DocumentUri.From("/template.bicep");
var diagsReceived = new TaskCompletionSource <PublishDiagnosticsParams>();
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(options =>
{
options.OnPublishDiagnostics(diags => {
diagsReceived.SetResult(diags);
});
});
// open document
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(documentUri, @"
param myParam string = 2
resource myRes 'invalidFormat' = {
}
randomToken
", 1));
var response = await IntegrationTestHelper.WithTimeoutAsync(diagsReceived.Task);
response.Diagnostics.Should().SatisfyRespectively(
d => {
d.Range.Should().HaveRange((1, 23), (1, 24));
d.Should().HaveCodeAndSeverity("BCP027", DiagnosticSeverity.Error);
},
d => {
d.Range.Should().HaveRange((2, 15), (2, 30));
d.Should().HaveCodeAndSeverity("BCP029", DiagnosticSeverity.Error);
},
d => {
d.Range.Should().HaveRange((5, 0), (5, 11));
d.Should().HaveCodeAndSeverity("BCP007", DiagnosticSeverity.Error);
}
);
// change document
diagsReceived = new TaskCompletionSource <PublishDiagnosticsParams>();
client.TextDocument.DidChangeTextDocument(TextDocumentParamHelper.CreateDidChangeTextDocumentParams(documentUri, @"
param myParam string = 'fixed!'
resource myRes 'invalidFormat' = {
}
randomToken
", 2));
response = await IntegrationTestHelper.WithTimeoutAsync(diagsReceived.Task);
response.Diagnostics.Should().SatisfyRespectively(
d => {
d.Range.Should().HaveRange((2, 15), (2, 30));
d.Should().HaveCodeAndSeverity("BCP029", DiagnosticSeverity.Error);
},
d => {
d.Range.Should().HaveRange((5, 0), (5, 11));
d.Should().HaveCodeAndSeverity("BCP007", DiagnosticSeverity.Error);
}
);
// close document
diagsReceived = new TaskCompletionSource <PublishDiagnosticsParams>();
client.TextDocument.DidCloseTextDocument(TextDocumentParamHelper.CreateDidCloseTextDocumentParams(documentUri, 3));
response = await IntegrationTestHelper.WithTimeoutAsync(diagsReceived.Task);
response.Diagnostics.Should().BeEmpty();
}
public async Task DidOpenTextDocument_should_trigger_PublishDiagnostics()
{
var documentUri = DocumentUri.From("/template.bicep");
var diagsReceived = new TaskCompletionSource <PublishDiagnosticsParams>();
var client = await IntegrationTestHelper.StartServerWithClientConnectionAsync(this.TestContext, options =>
{
options.OnPublishDiagnostics(diags => {
diagsReceived.SetResult(diags);
});
});
// open document
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(documentUri, @"
param myParam string = 2
resource myRes 'invalidFormat' = {
}
randomToken
", 1));
var response = await IntegrationTestHelper.WithTimeoutAsync(diagsReceived.Task);
response.Diagnostics.Should().SatisfyRespectively(
d => {
d.Range.Should().HaveRange((1, 6), (1, 13));
// note documentation pretty printing moves Uri to code for output
d.Should().HaveCodeAndSeverity(new NoUnusedParametersRule().Uri !.AbsoluteUri, DiagnosticSeverity.Warning);
},
d => {
d.Range.Should().HaveRange((1, 23), (1, 24));
d.Should().HaveCodeAndSeverity("BCP027", DiagnosticSeverity.Error);
},
d => {
d.Range.Should().HaveRange((2, 15), (2, 30));
d.Should().HaveCodeAndSeverity("BCP029", DiagnosticSeverity.Error);
},
d => {
d.Range.Should().HaveRange((5, 0), (5, 11));
d.Should().HaveCodeAndSeverity("BCP007", DiagnosticSeverity.Error);
}
);
// change document
diagsReceived = new TaskCompletionSource <PublishDiagnosticsParams>();
client.TextDocument.DidChangeTextDocument(TextDocumentParamHelper.CreateDidChangeTextDocumentParams(documentUri, @"
param myParam string = 'fixed!'
resource myRes 'invalidFormat' = {
}
randomToken
", 2));
response = await IntegrationTestHelper.WithTimeoutAsync(diagsReceived.Task);
response.Diagnostics.Should().SatisfyRespectively(
d => {
d.Range.Should().HaveRange((1, 6), (1, 13));
// documentation provided with linter sets code to uri for pretty link print outs
d.Should().HaveCodeAndSeverity(new NoUnusedParametersRule().Uri !.AbsoluteUri, DiagnosticSeverity.Warning);
},
d => {
d.Range.Should().HaveRange((2, 15), (2, 30));
d.Should().HaveCodeAndSeverity("BCP029", DiagnosticSeverity.Error);
},
d => {
d.Range.Should().HaveRange((5, 0), (5, 11));
d.Should().HaveCodeAndSeverity("BCP007", DiagnosticSeverity.Error);
}
);
// close document
diagsReceived = new TaskCompletionSource <PublishDiagnosticsParams>();
client.TextDocument.DidCloseTextDocument(TextDocumentParamHelper.CreateDidCloseTextDocumentParams(documentUri, 3));
response = await IntegrationTestHelper.WithTimeoutAsync(diagsReceived.Task);
response.Diagnostics.Should().BeEmpty();
}