Data driven new project wizard #93
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| { | ||
| "xUnit": { | ||
| "description": "Use xUnit v2 test executor with Reqnroll", | ||
| "dependencies": { | ||
| "Reqnroll_Lib": { | ||
| "name": "Reqnroll.xUnit", | ||
| "version": "2.4.1" | ||
| }, | ||
| "TestFramework_Lib": { | ||
| "name": "xunit", | ||
| "version": "2.8.1" | ||
| }, | ||
| "Adapter_Lib": { | ||
| "name": "xunit.runner.visualstudio", | ||
| "version": "2.8.1" | ||
| } | ||
| } | ||
| }, | ||
| "MsTest": { | ||
| "description": "Use MsTest v3 test executor with Reqnroll", | ||
| "dependencies": { | ||
| "Reqnroll_Lib": { | ||
| "name": "Reqnroll.MsTest", | ||
| "version": "2.4.1" | ||
| }, | ||
| "TestFramework_Lib": { | ||
| "name": "MSTest.TestFramework", | ||
| "version": "3.4.3" | ||
| }, | ||
| "Adapter_Lib": { | ||
| "name": "MSTest.TestAdapter", | ||
| "version": "3.4.3" | ||
| } | ||
| } | ||
| }, | ||
| "NUnit": { | ||
| "description": "Use NUnit v3 test executor with Reqnroll", | ||
| "dependencies": { | ||
| "Reqnroll_Lib": { | ||
| "name": "Reqnroll.NUnit", | ||
| "version": "2.4.1" | ||
| }, | ||
| "TestFramework_Lib": { | ||
| "name": "nunit", | ||
| "version": "3.14.0" | ||
| }, | ||
| "Adapter_Lib": { | ||
| "name": "NUnit3TestAdapter", | ||
| "version": "4.5.0" | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| namespace Reqnroll.VisualStudio.Wizards.Infrastructure; | ||
|
|
||
| public interface INewProjectMetaDataProvider | ||
| { | ||
| IEnumerable<string> TestFrameworks { get; } | ||
| IDictionary<string, NugetPackageDescriptor> DependenciesOf(string testFramework); | ||
| } | ||
| public record NugetPackageDescriptor(string name, string version); | ||
| public record TestFrameworkInfoModel(string description, Dictionary<string, NugetPackageDescriptor> dependencies); | ||
|
|
||
| [Export(typeof(INewProjectMetaDataProvider))] | ||
| public class NewProjectMetaDataProvider : INewProjectMetaDataProvider | ||
| { | ||
| private Dictionary<string, TestFrameworkInfoModel> _testFrameworkDescriptors = new(); | ||
| private Task<Dictionary<string, TestFrameworkInfoModel>> _httpTask; | ||
| private Lazy<Dictionary<string, TestFrameworkInfoModel>> _resolvedTestFrameworkDescriptors; | ||
|
|
||
| [ImportingConstructor] | ||
| public NewProjectMetaDataProvider() | ||
| { | ||
| // read static metadata from a resource file, deserialize the resulting json, storing it in the _testFrameworkDescriptors field | ||
| var resourceName = "Reqnroll.VisualStudio.Resources.TestFrameworkDescriptors.json"; | ||
| using (var stream = typeof(NewProjectMetaDataProvider).Assembly.GetManifestResourceStream(resourceName)) | ||
| using (var reader = new StreamReader(stream)) | ||
| { | ||
| var json = reader.ReadToEnd(); | ||
| var data = JsonSerialization.DeserializeObject<Dictionary<string, TestFrameworkInfoModel>>(json); | ||
| if (data != null) | ||
| _testFrameworkDescriptors = data; | ||
| } | ||
|
|
||
| // launch a task to read metadata from http resource and deserialize the resulting json, save the Task to a field | ||
| _httpTask = Task.Run(async () => | ||
|
Check warning on line 33 in Reqnroll.VisualStudio/Wizards/Infrastructure/NewProjectMetaDataProvider.cs
|
||
| { | ||
| try | ||
| { | ||
| using (var httpClient = new System.Net.Http.HttpClient()) | ||
| { | ||
| var httpJson = await httpClient.GetStringAsync("https://example.com/testframeworks.json").ConfigureAwait(false); | ||
| var httpData = JsonSerialization.DeserializeObject<Dictionary<string, TestFrameworkInfoModel>>(httpJson); | ||
| return httpData; | ||
| } | ||
| } | ||
| catch | ||
| { | ||
| return null; | ||
| } | ||
| }); | ||
|
|
||
| _resolvedTestFrameworkDescriptors = new Lazy<Dictionary<string, TestFrameworkInfoModel>>(FinishRetrievalOfTestFrameworkDescriptors); | ||
| } | ||
|
|
||
| public IEnumerable<string> TestFrameworks | ||
| { | ||
| get | ||
| { | ||
| var descriptors = _resolvedTestFrameworkDescriptors.Value; | ||
| return descriptors.Keys; | ||
| } | ||
| } | ||
|
|
||
| public IDictionary<string, NugetPackageDescriptor> DependenciesOf(string testFramework) | ||
| { | ||
| var descriptors = _resolvedTestFrameworkDescriptors.Value; | ||
| return descriptors[testFramework].dependencies; | ||
| } | ||
|
|
||
| private Dictionary<string, TestFrameworkInfoModel> FinishRetrievalOfTestFrameworkDescriptors() | ||
| { | ||
| // Wait for the HTTP task to complete | ||
| if (_httpTask == null) | ||
| return _testFrameworkDescriptors; | ||
|
|
||
| try | ||
| { | ||
| var result = _httpTask.GetAwaiter().GetResult(); | ||
| if (result != null) | ||
| { | ||
| _testFrameworkDescriptors = result; | ||
| } | ||
| } | ||
| catch | ||
| { | ||
| // Ignore exceptions, keep existing _testFrameworkDescriptors | ||
| } | ||
| return _testFrameworkDescriptors; | ||
| } | ||
| } | ||
This file contains hidden or 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.
I fear that there will be test frameworks that require more than one dependencies (maybe in some combinations we might need even multiple Reqnroll dependencies too), so I think I would prefer having a general list of dependencies that we just add and not have that categorization.
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.
I understand your rationale. When allowing for a more flexible set of package references, the wizard code must then generate a
<PackageReference>string for each and the number of them can't be predicted ahead of time. That means the template would have a single substitution token into which all of the package reference strings must go.I've spent all afternoon on this and keep running in to the same problem.
Template substitution works fine when the substitution variable represents a single xml element to be injected into the csproj (or a subsection of an element's textual representation).
When there are multiple items to be injected, each has to have its own substitution variable. Any attempt to include more than one line or more than one xml element causes an error.
I've attempted every way I can think of to join multiple together, but MSBuild keeps complaining that there is invalid xml (specifically 'The element <#text> beneath element
<ItemGroup>is unrecognized'). I've joined the package reference strings withEnvironment.NewLine, with a hard-coded '\n' and with no separation at all. All result in the same error.Have you seen this problem before? (I'm struggling to find reliable docs and information on what is/is-not allowed)
Uh oh!
There was an error while loading. Please reload this page.
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.
It sounds like the system is rejecting XML fragments. Could you add a complete
<ItemGroup>with all its descendants?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.
It is rejecting multi-line substitution variable values.
I tried the suggestion of substituting the entire
<ItemGroup>element, but ended up with the same error.