Skip to content

Commit 39022a2

Browse files
JanKrivanekJanKrivanek
authored
Expose dotnet command configuration via API (#5560)
* Expose dotnet command configuration via API * Add proper setting of home folder * Reflect review comments
1 parent 7178f7b commit 39022a2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+515
-136
lines changed

‎docs/authoring-tools/Templates-Testing-Tooling.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,23 @@ Configuration of the scenario run is done via `TemplateVerifierOptions` type.
128128
- TargetFramework
129129
- TargetFrameworkAndVersion
130130

131-
- **`string? DotnetNewCommandAssemblyPath`** - Applicable for internal tests of dotnet assembly. Path to custom assembly implementing the new command.
131+
- **`string? DotnetExecutablePath`** - Path to custom dotnet executable (e.g. x-copy install scenario).
132+
133+
- **`IReadOnlyDictionary<string, string>? Environment`** - Custom environment variable collection to be passed to execution of dotnet commands.
134+
135+
Custom environment variables can as well be added via fluent API `WithCustomEnvironment` and `WithEnvironmentVariable`. Sample usage:
136+
137+
```cs
138+
options.WithCustomEnvironment(
139+
new Dictionary<string, string>()
140+
{
141+
{ name1, value1 },
142+
{ name2, value2 },
143+
{ name3, value3 },
144+
}
145+
);
146+
```
147+
132148

133149
- **<a name="ScenarioName"></a>`string? ScenarioName`** - Custom scenario name; if specified it will be used as part of verification snapshot name.
134150

‎src/Microsoft.TemplateEngine.Utils/DictionaryExtensions.cs‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,27 @@ namespace Microsoft.TemplateEngine.Utils
88
{
99
public static class DictionaryExtensions
1010
{
11+
/// <summary>
12+
/// Way of resolving keys conflicts.
13+
/// </summary>
14+
public enum ConflictingKeysResolution
15+
{
16+
/// <summary>
17+
/// Force overwrite values in original dictionary in case of conflict.
18+
/// </summary>
19+
Overwrite,
20+
21+
/// <summary>
22+
/// Preserve original values in case of conflict.
23+
/// </summary>
24+
PreserveOriginal,
25+
26+
/// <summary>
27+
/// Throw in case of conflict.
28+
/// </summary>
29+
Throw
30+
}
31+
1132
public static IReadOnlyDictionary<string, T> CloneIfDifferentComparer<T>(this IReadOnlyDictionary<string, T> source, StringComparer comparer)
1233
{
1334
if (((Dictionary<string, T>)source).Comparer == comparer)
@@ -25,5 +46,32 @@ public static IReadOnlyDictionary<string, T> CloneIfDifferentComparer<T>(this IR
2546
return cloneDict;
2647
}
2748
}
49+
50+
/// <summary>
51+
/// Adds a content of given dictionary to current dictionary.
52+
/// </summary>
53+
/// <typeparam name="TKey"></typeparam>
54+
/// <typeparam name="TValue"></typeparam>
55+
/// <param name="dict">Dictionary to receive another values.</param>
56+
/// <param name="another">Dictionary to be merged into current.</param>
57+
/// <param name="conflictingKeysResolution">Way of resolving keys conflicts.</param>
58+
/// <exception cref="Exception">Thrown if key is already present in current dictionary and <see cref="ConflictingKeysResolution.Throw"/> strategy was requested.</exception>
59+
public static void Merge<TKey, TValue>(
60+
this IDictionary<TKey, TValue> dict,
61+
IReadOnlyDictionary<TKey, TValue> another,
62+
ConflictingKeysResolution conflictingKeysResolution = ConflictingKeysResolution.Overwrite)
63+
{
64+
foreach (var pair in another)
65+
{
66+
if (conflictingKeysResolution == ConflictingKeysResolution.Overwrite || !dict.ContainsKey(pair.Key))
67+
{
68+
dict[pair.Key] = pair.Value;
69+
}
70+
else if (conflictingKeysResolution == ConflictingKeysResolution.Throw)
71+
{
72+
throw new ArgumentException(string.Format(LocalizableStrings.DictionaryExtensions_Error_KeyExists, pair.Key));
73+
}
74+
}
75+
}
2876
}
2977
}

‎src/Microsoft.TemplateEngine.Utils/LocalizableStrings.Designer.cs‎

Lines changed: 72 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Microsoft.TemplateEngine.Utils/LocalizableStrings.resx‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="DictionaryExtensions_Error_KeyExists" xml:space="preserve">
121+
<value>Key [{0}] is already present.</value>
122+
<comment>{0} contains the actual key</comment>
123+
</data>
124+
</root>

‎src/Microsoft.TemplateEngine.Utils/Microsoft.TemplateEngine.Utils.csproj‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,19 @@
1818
<PackageReference Include="Newtonsoft.Json" />
1919
<ProjectReference Include="$(SrcDir)Microsoft.TemplateEngine.Abstractions\Microsoft.TemplateEngine.Abstractions.csproj" />
2020
</ItemGroup>
21+
22+
<ItemGroup>
23+
<Compile Update="LocalizableStrings.Designer.cs">
24+
<DesignTime>True</DesignTime>
25+
<AutoGen>True</AutoGen>
26+
<DependentUpon>LocalizableStrings.resx</DependentUpon>
27+
</Compile>
28+
</ItemGroup>
29+
30+
<ItemGroup>
31+
<EmbeddedResource Update="LocalizableStrings.resx">
32+
<Generator>ResXFileCodeGenerator</Generator>
33+
<LastGenOutput>LocalizableStrings.Designer.cs</LastGenOutput>
34+
</EmbeddedResource>
35+
</ItemGroup>
2136
</Project>

‎src/Microsoft.TemplateEngine.Utils/PublicAPI.Unshipped.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Microsoft.TemplateEngine.Utils.AsyncLazy<T>.AsyncLazy(System.Func<System.Threading.Tasks.Task<T>!>! taskFactory) -> void
33
Microsoft.TemplateEngine.Utils.AsyncLazy<T>.AsyncLazy(System.Func<T>! valueFactory) -> void
44
Microsoft.TemplateEngine.Utils.AsyncLazy<T>.GetAwaiter() -> System.Runtime.CompilerServices.TaskAwaiter<T>
5+
Microsoft.TemplateEngine.Utils.DictionaryExtensions.ConflictingKeysResolution
6+
Microsoft.TemplateEngine.Utils.DictionaryExtensions.ConflictingKeysResolution.Overwrite = 0 -> Microsoft.TemplateEngine.Utils.DictionaryExtensions.ConflictingKeysResolution
7+
Microsoft.TemplateEngine.Utils.DictionaryExtensions.ConflictingKeysResolution.PreserveOriginal = 1 -> Microsoft.TemplateEngine.Utils.DictionaryExtensions.ConflictingKeysResolution
8+
Microsoft.TemplateEngine.Utils.DictionaryExtensions.ConflictingKeysResolution.Throw = 2 -> Microsoft.TemplateEngine.Utils.DictionaryExtensions.ConflictingKeysResolution
59
Microsoft.TemplateEngine.Utils.IPatternMatcher
610
Microsoft.TemplateEngine.Utils.IPatternMatcher.IsMatch(string! test) -> bool
11+
static Microsoft.TemplateEngine.Utils.DictionaryExtensions.Merge<TKey, TValue>(this System.Collections.Generic.IDictionary<TKey, TValue>! dict, System.Collections.Generic.IReadOnlyDictionary<TKey, TValue>! another, Microsoft.TemplateEngine.Utils.DictionaryExtensions.ConflictingKeysResolution conflictingKeysResolution = Microsoft.TemplateEngine.Utils.DictionaryExtensions.ConflictingKeysResolution.Overwrite) -> void
712
static readonly Microsoft.TemplateEngine.Utils.Glob.MatchAll -> Microsoft.TemplateEngine.Utils.IPatternMatcher!

‎src/Microsoft.TemplateEngine.Utils/xlf/LocalizableStrings.cs.xlf‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
3+
<file datatype="xml" source-language="en" target-language="cs" original="../LocalizableStrings.resx">
4+
<body>
5+
<trans-unit id="DictionaryExtensions_Error_KeyExists">
6+
<source>Key [{0}] is already present.</source>
7+
<target state="new">Key [{0}] is already present.</target>
8+
<note>{0} contains the actual key</note>
9+
</trans-unit>
10+
</body>
11+
</file>
12+
</xliff>

‎src/Microsoft.TemplateEngine.Utils/xlf/LocalizableStrings.de.xlf‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
3+
<file datatype="xml" source-language="en" target-language="de" original="../LocalizableStrings.resx">
4+
<body>
5+
<trans-unit id="DictionaryExtensions_Error_KeyExists">
6+
<source>Key [{0}] is already present.</source>
7+
<target state="new">Key [{0}] is already present.</target>
8+
<note>{0} contains the actual key</note>
9+
</trans-unit>
10+
</body>
11+
</file>
12+
</xliff>

‎src/Microsoft.TemplateEngine.Utils/xlf/LocalizableStrings.es.xlf‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
3+
<file datatype="xml" source-language="en" target-language="es" original="../LocalizableStrings.resx">
4+
<body>
5+
<trans-unit id="DictionaryExtensions_Error_KeyExists">
6+
<source>Key [{0}] is already present.</source>
7+
<target state="new">Key [{0}] is already present.</target>
8+
<note>{0} contains the actual key</note>
9+
</trans-unit>
10+
</body>
11+
</file>
12+
</xliff>

‎src/Microsoft.TemplateEngine.Utils/xlf/LocalizableStrings.fr.xlf‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2" xsi:schemaLocation="urn:oasis:names:tc:xliff:document:1.2 xliff-core-1.2-transitional.xsd">
3+
<file datatype="xml" source-language="en" target-language="fr" original="../LocalizableStrings.resx">
4+
<body>
5+
<trans-unit id="DictionaryExtensions_Error_KeyExists">
6+
<source>Key [{0}] is already present.</source>
7+
<target state="new">Key [{0}] is already present.</target>
8+
<note>{0} contains the actual key</note>
9+
</trans-unit>
10+
</body>
11+
</file>
12+
</xliff>

0 commit comments

Comments
 (0)