private async Task VerifyBicepFileOpenTelemetry(
string?bicepConfigFileContents,
string mainBicepFileContents,
string referencedBicepFileContents,
IDictionary <string, string>?linterRuleStateOnBicepFileOpenTelemetryEventProperties,
IDictionary <string, string> bicepFileOpenTelemetryEventProperties)
{
var testOutputPath = Path.Combine(TestContext.ResultsDirectory, Guid.NewGuid().ToString());
if (bicepConfigFileContents is not null)
{
FileHelper.SaveResultFile(TestContext, "bicepconfig.json", bicepConfigFileContents, testOutputPath);
}
var fileSystemDict = new Dictionary <Uri, string>();
var mainBicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", mainBicepFileContents, testOutputPath);
var mainUri = DocumentUri.FromFileSystemPath(mainBicepFilePath);
fileSystemDict[mainUri.ToUri()] = mainBicepFileContents;
var referencedBicepFilePath = FileHelper.SaveResultFile(TestContext, "groups.bicep", referencedBicepFileContents, testOutputPath);
var moduleUri = DocumentUri.FromFileSystemPath(referencedBicepFilePath);
fileSystemDict[moduleUri.ToUri()] = referencedBicepFileContents;
var telemetryEventsListener = new MultipleMessageListener <BicepTelemetryEvent>();
using var helper = await LanguageServerHelper.StartServerWithClientConnectionAsync(
TestContext,
options =>
{
options.OnTelemetryEvent <BicepTelemetryEvent>(telemetry => telemetryEventsListener.AddMessage(telemetry));
},
creationOptions : new Server.CreationOptions(FileResolver: new InMemoryFileResolver(fileSystemDict)));
var client = helper.Client;
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUri()], 1));
var bicepTelemetryEvent = await telemetryEventsListener.WaitNext();
if (linterRuleStateOnBicepFileOpenTelemetryEventProperties is not null)
{
bicepTelemetryEvent.EventName.Should().Be(TelemetryConstants.EventNames.LinterRuleStateOnBicepFileOpen);
bicepTelemetryEvent.Properties.Should().Contain(linterRuleStateOnBicepFileOpenTelemetryEventProperties);
}
bicepTelemetryEvent = await telemetryEventsListener.WaitNext();
bicepTelemetryEvent.EventName.Should().Be(TelemetryConstants.EventNames.BicepFileOpen);
bicepTelemetryEvent.Properties.Should().Contain(bicepFileOpenTelemetryEventProperties);
}
public async Task ServerProcess_e2e_test_with_console_io()
{
var cancellationToken = GetCancellationTokenWithTimeout(TimeSpan.FromSeconds(60));
var publishDiagsListener = new MultipleMessageListener <PublishDiagnosticsParams>();
var documentUri = DocumentUri.From("/template.bicep");
var bicepFile = @"
#disable-next-line no-unused-params
param foo string = 123 // trigger a type error
";
using var process = StartServerProcessWithConsoleIO();
try
{
var input = process.StandardOutput.BaseStream;
var output = process.StandardInput.BaseStream;
using var client = await InitializeLanguageClient(input, output, publishDiagsListener, cancellationToken);
client.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(documentUri, bicepFile, 0));
var publishDiagsResult = await publishDiagsListener.WaitNext();
publishDiagsResult.Diagnostics.Should().SatisfyRespectively(
d =>
{
d.Range.Should().HaveRange((2, 19), (2, 22));
d.Should().HaveCodeAndSeverity("BCP027", DiagnosticSeverity.Error);
});
}
finally
{
process.Kill(entireProcessTree: true);
process.Dispose();
}
}
private async Task <BicepTelemetryEvent> ResolveCompletionAsync(string text, string prefix, Position position)
{
var fileSystemDict = new Dictionary <Uri, string>();
var telemetryEventsListener = new MultipleMessageListener <BicepTelemetryEvent>();
using var helper = await LanguageServerHelper.StartServerWithClientConnectionAsync(
TestContext,
options =>
{
options.OnTelemetryEvent <BicepTelemetryEvent>(telemetry => telemetryEventsListener.AddMessage(telemetry));
},
new Server.CreationOptions(NamespaceProvider: BicepTestConstants.NamespaceProvider, FileResolver: new InMemoryFileResolver(fileSystemDict)));
var client = helper.Client;
var mainUri = DocumentUri.FromFileSystemPath("/main.bicep");
fileSystemDict[mainUri.ToUri()] = text;
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUri()], 1));
var bicepTelemetryEvent = await telemetryEventsListener.WaitNext();
bicepTelemetryEvent.EventName.Should().Be(TelemetryConstants.EventNames.LinterRuleStateOnBicepFileOpen);
bicepTelemetryEvent = await telemetryEventsListener.WaitNext();
bicepTelemetryEvent.EventName.Should().Be(TelemetryConstants.EventNames.BicepFileOpen);
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 telemetryEventsListener.WaitNext());
}
public async Task ServerProcess_e2e_test_with_socket_io()
{
var cancellationToken = GetCancellationTokenWithTimeout(TimeSpan.FromSeconds(60));
var publishDiagsListener = new MultipleMessageListener <PublishDiagnosticsParams>();
var documentUri = DocumentUri.From("/template.bicep");
var bicepFile = @"
#disable-next-line no-unused-params
param foo string = 123 // trigger a type error
";
var tcpListener = new TcpListener(IPAddress.Loopback, 0);
tcpListener.Start();
var tcpPort = (tcpListener.LocalEndpoint as IPEndPoint) !.Port;
using var process = StartServerProcessWithSocketIo(tcpPort);
using var tcpClient = await tcpListener.AcceptTcpClientAsync(cancellationToken);
var tcpStream = tcpClient.GetStream();
try
{
using var client = await InitializeLanguageClient(tcpStream, tcpStream, publishDiagsListener, cancellationToken);
client.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(documentUri, bicepFile, 0));
var publishDiagsResult = await publishDiagsListener.WaitNext();
publishDiagsResult.Diagnostics.Should().SatisfyRespectively(
d =>
{
d.Range.Should().HaveRange((2, 19), (2, 22));
d.Should().HaveCodeAndSeverity("BCP027", DiagnosticSeverity.Error);
});
}
finally
{
process.Kill(entireProcessTree: true);
process.Dispose();
}
}
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);
using var helper = await LanguageServerHelper.StartServerWithClientConnectionAsync(
this.TestContext,
options => options.OnPublishDiagnostics(diagnosticsParams => diagnosticsListener.AddMessage(diagnosticsParams)),
new LanguageServer.Server.CreationOptions(
NamespaceProvider: BuiltInTestTypes.Create(),
Features: features));
var client = helper.Client;
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);
}
private static async Task VerifyDiagnosticsAsync(MultipleMessageListener <PublishDiagnosticsParams> diagsListener,
string message,
DocumentUri documentUri,
DiagnosticSeverity diagnosticSeverity,
Position start,
Position end,
string code)
{
var diagsParams = await diagsListener.WaitNext();
diagsParams.Uri.Should().Be(documentUri);
diagsParams.Diagnostics.Should().SatisfyRespectively(
x =>
{
x.Message.Should().Contain(message);
x.Severity.Should().Be(diagnosticSeverity);
x.Code?.String.Should().Be(code);
x.Range.Should().Be(new Range
{
Start = start,
End = end
});
});
}
public async Task ServerProcess_e2e_test_with_named_pipes_io()
{
var cancellationToken = GetCancellationTokenWithTimeout(TimeSpan.FromSeconds(60));
var publishDiagsListener = new MultipleMessageListener <PublishDiagnosticsParams>();
var documentUri = DocumentUri.From("/template.bicep");
var bicepFile = @"
#disable-next-line no-unused-params
param foo string = 123 // trigger a type error
";
var pipeName = Guid.NewGuid().ToString();
using var pipeStream = new NamedPipeServerStream(pipeName, PipeDirection.InOut, NamedPipeServerStream.MaxAllowedServerInstances, PipeTransmissionMode.Byte, PipeOptions.Asynchronous);
using var process = StartServerProcessWithNamedPipeIo(pipeName);
try
{
await pipeStream.WaitForConnectionAsync(cancellationToken);
using var client = await InitializeLanguageClient(pipeStream, pipeStream, publishDiagsListener, cancellationToken);
client.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(documentUri, bicepFile, 0));
var publishDiagsResult = await publishDiagsListener.WaitNext();
publishDiagsResult.Diagnostics.Should().SatisfyRespectively(
d =>
{
d.Range.Should().HaveRange((2, 19), (2, 22));
d.Should().HaveCodeAndSeverity("BCP027", DiagnosticSeverity.Error);
});
}
finally
{
process.Kill(entireProcessTree: true);
process.Dispose();
}
}
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 BicepFileOpen_ShouldFireTelemetryEvent()
{
var testOutputPath = Path.Combine(TestContext.ResultsDirectory, Guid.NewGuid().ToString());
var bicepConfigFileContents = @"{
""analyzers"": {
""core"": {
""verbose"": false,
""enabled"": true,
""rules"": {
""no-unused-params"": {
""level"": ""warning""
},
""no-unused-vars"": {
""level"": ""info""
}
}
}
}
}";
FileHelper.SaveResultFile(TestContext, "bicepconfig.json", bicepConfigFileContents, testOutputPath);
var fileSystemDict = new Dictionary <Uri, string>();
var mainBicepFileContents = @"param appInsightsName string = 'testAppInsightsName'
var deployGroups = true
resource applicationInsights 'Microsoft.Insights/components@2015-05-01' = {
name: appInsightsName
location: resourceGroup().location
kind: 'web'
properties: {
Application_Type: 'web'
}
resource favorites 'favorites@2015-05-01'{
name: 'testName'
}
}
module apimGroups 'groups.bicep' = if (deployGroups) {
name: 'apimGroups'
}
param location string = 'testLocation'
#disable-next-line";
var mainBicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", mainBicepFileContents, testOutputPath);
var mainUri = DocumentUri.FromFileSystemPath(mainBicepFilePath);
fileSystemDict[mainUri.ToUri()] = mainBicepFileContents;
var referencedBicepFileContents = @"resource parentAPIM 'Microsoft.ApiManagement/service@2019-01-01' existing = {
name: 'testApimInstanceName'
}
resource apimGroup 'Microsoft.ApiManagement/service/groups@2020-06-01-preview' = {
name: 'apiManagement/groups'
}
param storageAccount string = 'testStorageAccount'
param location string = 'testLocation'
var useDefaultSettings = true";
var referencedBicepFilePath = FileHelper.SaveResultFile(TestContext, "groups.bicep", referencedBicepFileContents, testOutputPath);
var moduleUri = DocumentUri.FromFileSystemPath(referencedBicepFilePath);
fileSystemDict[moduleUri.ToUri()] = referencedBicepFileContents;
var telemetryEventsListener = new MultipleMessageListener <BicepTelemetryEvent>();
using var helper = await LanguageServerHelper.StartServerWithClientConnectionAsync(
TestContext,
options =>
{
options.OnTelemetryEvent <BicepTelemetryEvent>(telemetry => telemetryEventsListener.AddMessage(telemetry));
},
creationOptions : new Server.CreationOptions(FileResolver: new InMemoryFileResolver(fileSystemDict)));
var client = helper.Client;
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(mainUri, fileSystemDict[mainUri.ToUri()], 1));
var bicepTelemetryEvent = await telemetryEventsListener.WaitNext();
IDictionary <string, string> properties = new Dictionary <string, string>
{
{ "enabled", "true" },
{ "simplify-interpolation", "warning" },
{ "no-unused-vars", "info" },
{ "no-hardcoded-env-urls", "warning" },
{ "no-unused-params", "warning" },
{ "prefer-interpolation", "warning" },
{ "protect-commandtoexecute-secrets", "warning" },
{ "no-unnecessary-dependson", "warning" },
{ "adminusername-should-not-be-literal", "warning" },
{ "use-stable-vm-image", "warning" },
{ "secure-parameter-default", "warning" },
{ "outputs-should-not-contain-secrets", "warning" },
};
bicepTelemetryEvent.EventName.Should().Be(TelemetryConstants.EventNames.LinterRuleStateOnBicepFileOpen);
bicepTelemetryEvent.Properties.Should().Contain(properties);
properties = new Dictionary <string, string>
{
{ "modules", "1" },
{ "parameters", "2" },
{ "resources", "2" },
{ "variables", "1" },
{ "fileSizeInBytes", "488" },
{ "lineCount", "23" },
{ "errors", "2" },
{ "warnings", "1" },
{ "modulesInReferencedFiles", "0" },
{ "parentResourcesInReferencedFiles", "2" },
{ "parametersInReferencedFiles", "2" },
{ "variablesInReferencedFiles", "1" }
};
bicepTelemetryEvent = await telemetryEventsListener.WaitNext();
bicepTelemetryEvent.EventName.Should().Be(TelemetryConstants.EventNames.BicepFileOpen);
bicepTelemetryEvent.Properties.Should().Contain(properties);
}
public async Task VerifyDisableNextLineCodeActionInvocationFiresTelemetryEvent()
{
var bicepFileContents = @"param storageAccount string = 'testStorageAccount'";
var bicepFilePath = FileHelper.SaveResultFile(TestContext, "main.bicep", bicepFileContents);
var documentUri = DocumentUri.FromFileSystemPath(bicepFilePath);
var uri = documentUri.ToUri();
var files = new Dictionary <Uri, string>
{
[uri] = bicepFileContents,
};
var compilation = new Compilation(BicepTestConstants.NamespaceProvider, SourceFileGroupingFactory.CreateForFiles(files, uri, BicepTestConstants.FileResolver, BicepTestConstants.BuiltInConfiguration), BicepTestConstants.BuiltInConfiguration, BicepTestConstants.LinterAnalyzer);
var diagnostics = compilation.GetEntrypointSemanticModel().GetAllDiagnostics();
var telemetryEventsListener = new MultipleMessageListener <BicepTelemetryEvent>();
using var helper = await LanguageServerHelper.StartServerWithClientConnectionAsync(
TestContext,
options =>
{
options.OnTelemetryEvent <BicepTelemetryEvent>(telemetry => telemetryEventsListener.AddMessage(telemetry));
},
new Server.CreationOptions(NamespaceProvider: BicepTestConstants.NamespaceProvider, FileResolver: new InMemoryFileResolver(files)));
var client = helper.Client;
client.TextDocument.DidOpenTextDocument(TextDocumentParamHelper.CreateDidOpenDocumentParams(documentUri, files[uri], 1));
var bicepTelemetryEvent = await telemetryEventsListener.WaitNext();
bicepTelemetryEvent.EventName.Should().Be(TelemetryConstants.EventNames.LinterRuleStateOnBicepFileOpen);
bicepTelemetryEvent = await telemetryEventsListener.WaitNext();
bicepTelemetryEvent.EventName.Should().Be(TelemetryConstants.EventNames.BicepFileOpen);
var lineStarts = compilation.SourceFileGrouping.EntryPoint.LineStarts;
var codeActions = await client.RequestCodeAction(new CodeActionParams
{
TextDocument = new TextDocumentIdentifier(documentUri),
Range = diagnostics.First().ToRange(lineStarts)
});
var disableNextLineCodeAction = codeActions.First(x => x.CodeAction !.Title == "Disable no-unused-params for this line").CodeAction;
_ = await client !.ResolveCodeAction(disableNextLineCodeAction !);
Command?command = disableNextLineCodeAction !.Command;
JArray? arguments = command !.Arguments;
await client.Workspace.ExecuteCommand(command);
bicepTelemetryEvent = await telemetryEventsListener.WaitNext();
IDictionary <string, string> properties = new Dictionary <string, string>
{
{ "code", "no-unused-params" }
};
bicepTelemetryEvent.EventName.Should().Be(TelemetryConstants.EventNames.DisableNextLineDiagnostics);
bicepTelemetryEvent.Properties.Should().Equal(properties);
}
