Load functions trying to find files in snippets test runner

[miqm]

@miqm - I thought this is a simple fix, but I cannot get the tests working.

1. Complains about missing file
2. main.combined.bicep is always generated incorrectly

I am not sure what I am doing wrong.

Originally posted by @rajyraman in #3919 (comment)

[anthony-c-martin]

I think part of the problem is the missing } in placeholder 3. It should be /*${3:'REQUIRED'}*/ rather than /*${3:'REQUIRED'*/.

EDIT: That explains the second error, not the first.

[anthony-c-martin]

One way you could solve the first problem is by adding a JSON file to the same SnippetTemplates directory and referencing it with:

json(loadTextContent(/*${3:'./res-logic-app-file-workflow.json'}*/'./res-logic-app-file-workflow.json'))

[miqm]

Now that I looked closer is that it should be done in this way. However I didn't test it if it works - I remember that I needed to do some work to get files to be copied to test directory for proper referencing.

@rajyraman can you check if @anthony-c-martin suggestions work?

[anthony-c-martin]

My suggestion is taking advantage of the fact that .json files get copied to the output directory for the snippet tests. It's definitely a little hacky, and I'm not fully confident it'll work:

bicep/src/Bicep.LangServer.IntegrationTests/Bicep.LangServer.IntegrationTests.csproj

Line 29 in 1f7253b

<EmbeddedResource Include="./Completions/SnippetTemplates/**/*.json" LogicalName="$([System.String]::new('Completions/SnippetTemplates/%(RecursiveDir)%(Filename)%(Extension)').Replace('\', '/'))" />

The other potential option is to add a similar check to

bicep/src/Bicep.LangServer.IntegrationTests/SnippetTemplatesTests.cs

Lines 39 to 43 in 1f7253b

	if (prefix == "module")
	{
	var paramUri = new Uri("file:///param.bicep");
	files.Add(paramUri, "param myParam string = 'test'");
	}

e.g. something like:

if (prefix == "res-logic-app-file")
{
     var requiredContents = @"{
     ""definition"": {}
}";
     files.Add(new Uri("file:///REQUIRED"), requiredContents); 
}

[anthony-c-martin]

@bhsubra do you have any other suggestions?

[miqm]

In https://github.com/Azure/bicep/main/src/Bicep.Core.Samples/Bicep.Core.Samples.csproj#L13 I added that all files in assets subdir are included in output, perhaps something similar we could do for snippet integration tests.

[bhsubra]

@bhsubra do you have any other suggestions?

I tried below:

if (prefix == "module") 
{ 
   var paramUri = new Uri("file:///param.bicep"); 
   files.Add(paramUri, "param myParam string = 'test'"); 
} 

This won't work as it hits below code path and tries to load file from local path:

Bicep.Core.dll!Bicep.Core.Semantics.Namespaces.SystemNamespaceSymbol.LoadTextContentTypeBuilder(Bicep.Core.Semantics.IBinder binder, Bicep.Core.FileSystem.IFileResolver fileResolver, Bicep.Core.Diagnostics.IDiagnosticWriter diagnostics, System.Collections.Immutable.ImmutableArray<Bicep.Core.Syntax.FunctionArgumentSyntax> arguments, System.Collections.Immutable.ImmutableArray<Bicep.Core.TypeSystem.TypeSymbol> argumentTypes) Line 466	C#

@miqm, I haven't tried option #1 suggested by @anthony-c-martin . Did that work for you?

[rajyraman]

@anthony-c-martin - I tried your suggestion, but it did not work. Not sure why it is looking in root folder.

[rajyraman]

@miqm - I am still getting this error even after rebasing. It is complaining about TEST_OUTPUT_DIR folder and not about root folder now.

[miqm]

It's because test suite is looking for file called REQUIRED. We had discussion and snippet code should be compilable. You probably need to change the second 'REQUIRED' (the one not in comment) to logicApp.json

Did you push your changes to repo so I could checkout?