Extend Templates testing framework to test through API #5677
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| Microsoft.TemplateEngine.Edge.DefaultEnvironment.DefaultEnvironment(System.Collections.Generic.IReadOnlyDictionary<string!, string!>? additionalVirtualEnvironemnt) -> void | ||
| Microsoft.TemplateEngine.Edge.Settings.ITemplateInfoHostJsonCache.HostData.get -> string? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| Microsoft.TemplateEngine.IDE.Bootstrapper.Bootstrapper(Microsoft.TemplateEngine.Abstractions.ITemplateEngineHost! host, bool virtualizeConfiguration, bool loadDefaultComponents = true, string? hostSettingsLocation = null, System.Collections.Generic.IReadOnlyDictionary<string!, string!>? additionalVirtualEnvironemnt = null) -> void | ||
| Microsoft.TemplateEngine.IDE.Bootstrapper.CreateAsync(Microsoft.TemplateEngine.Abstractions.ITemplateInfo! info, string? name, string! outputPath, Microsoft.TemplateEngine.Edge.Template.InputDataSet? inputParameters, string? baselineName = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Microsoft.TemplateEngine.Edge.Template.ITemplateCreationResult!>! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using Microsoft.Extensions.Logging; | ||
| using Microsoft.TemplateEngine.Authoring.TemplateApiVerifier; | ||
| using Microsoft.TemplateEngine.TestHelper; | ||
| using Microsoft.TemplateEngine.Tests; | ||
| using Xunit.Abstractions; | ||
|
|
@@ -17,6 +18,10 @@ public ExampleTemplateTest(ITestOutputHelper log) | |
| _log = new XunitLoggerProvider(log).CreateLogger("TestRun"); | ||
| } | ||
|
|
||
| // Following 2 tests share identical snapshot folder - that's the reason for the additional | ||
| // naming parameters (DoNotPrependCallerMethodNameToScenarioName, DoNotAppendTemplateArgsToScenarioName, ScenarioName) | ||
| // The identity of snapshots ilustrates that execution through API and through full blown command leads to identical results | ||
|
|
||
| [Fact] | ||
| public async void VerificationEngineSampleDogfoodTest() | ||
| { | ||
|
|
@@ -33,10 +38,47 @@ public async void VerificationEngineSampleDogfoodTest() | |
| SnapshotsDirectory = "Snapshots", | ||
| OutputDirectory = workingDir, | ||
| VerifyCommandOutput = true, | ||
| DoNotPrependCallerMethodNameToScenarioName = true, | ||
| DoNotAppendTemplateArgsToScenarioName = true, | ||
| ScenarioName = "SampleDogfoodTest", | ||
| // This is here just for testing and documentation purposes - showing functionality of differing snapshots for arch | ||
| UniqueFor = UniqueForOption.Architecture, | ||
| } | ||
| .WithCustomScrubbers( | ||
| ScrubbersDefinition.Empty | ||
| .AddScrubber(sb => sb.Replace("B is enabled", "*******")) | ||
| .AddScrubber((path, content) => | ||
| { | ||
| if (path.Replace(Path.DirectorySeparatorChar, '/') == "std-streams/stdout.txt") | ||
| { | ||
| content.Replace("SampleTestTemplate", "%TEMPLATE%"); | ||
| } | ||
| })); | ||
|
|
||
| VerificationEngine engine = new VerificationEngine(_log); | ||
| await engine.Execute(options); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async void VerificationEngineSampleDogfoodTest_ExecThroughApi() | ||
| { | ||
| string workingDir = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName().Replace(".", string.Empty)); | ||
| string templateShortName = "TestAssets.SampleTestTemplate"; | ||
|
|
||
| //get the template location | ||
| string templateLocation = Path.Combine(TestTemplatesLocation, "TestTemplate"); | ||
|
|
||
| TemplateVerifierOptions options = new TemplateVerifierOptions(templateName: templateShortName) | ||
| { | ||
| TemplatePath = templateLocation, | ||
| SnapshotsDirectory = "Snapshots", | ||
| OutputDirectory = workingDir, | ||
| VerifyCommandOutput = true, | ||
| DoNotPrependCallerMethodNameToScenarioName = true, | ||
| ScenarioName = "SampleDogfoodTest", | ||
| UniqueFor = UniqueForOption.Architecture, | ||
| } | ||
| .WithInstantiationThroughTemplateCreatorApi(new Dictionary<string, string?>() { { "paramB", "true" } }) | ||
|
There was a problem hiding this comment. @YuliiaKovalova this can be inspiration how the imported sample templates might be tested (only |
||
| .WithCustomScrubbers( | ||
| ScrubbersDefinition.Empty | ||
| .AddScrubber(sb => sb.Replace("B is enabled", "*******")) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just a thought - would it be better to do own implementation? Maybe something as
ExtendedEnvironment?another thought: https://github.com/dotnet/sdk/blob/main/src/Cli/Microsoft.TemplateEngine.Cli/CliEnvironment.cs we can get rid of this custom implementation with this class now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There were few options:
DefaultEnvironmentand extend.DefaultEnvironmentlogic and add custom logicDefaultEnvironmentThe last one felt as the one with least dept incured. Though I might miss some obvious reason why it might not be an optional choice - so I'm open to alternative thoughts :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My preference is the first one, just to intentionally keep it separate, so it is not misused, however I don't insist.