Skip to content

Commit

Permalink
tests proving dotnet#4988
Browse files Browse the repository at this point in the history
  • Loading branch information
@vlada-shubina
vlada-shubina committed Sep 14, 2022
1 parent 1ebdcbc commit 7b805ba
Show file tree
Hide file tree
Showing 4 changed files with 205 additions and 3 deletions.
5 changes: 3 additions & 2 deletions test/Microsoft.TemplateEngine.Core.UnitTests/ConditionalTests.CStyleEvaluator.cs
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#nullable enable

using System.Globalization;
using System.IO;
using System.Text;
Expand Down Expand Up @@ -1633,8 +1635,7 @@ public void VerifyMisstypedIfTokenDoesntCrash(string varName, bool varValue)
{
string value = @"#ifdef
GAGA
#endif
";
#endif";
string expected = varName == "def" && varValue ? @"GAGA
" : "";

Expand Down
30 changes: 30 additions & 0 deletions test/Microsoft.TemplateEngine.Core.UnitTests/ConditionalTests.XmlBlockComments.cs
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#nullable enable

using System.Collections.Generic;
using System.IO;
using System.Text;
using Microsoft.TemplateEngine.Core.Contracts;
using Xunit;

Expand Down Expand Up @@ -1341,5 +1345,31 @@ Trailing stuff
RunAndVerify(test, outerElseHappensExpectedValue, processor, 9999);
}
}

#pragma warning disable xUnit1004 // Test methods should not be skipped
[Fact(Skip = "https://github.com/dotnet/templating/issues/4988")]
#pragma warning restore xUnit1004 // Test methods should not be skipped
public void VerifyXMLConditionAtEnd()
{
string value = @"Hello
<!--#if (B)
bar
#endif -->
";
string expected = @"Hello
";

byte[] valueBytes = Encoding.UTF8.GetBytes(value);
MemoryStream input = new MemoryStream(valueBytes);
MemoryStream output = new MemoryStream();

VariableCollection vc = new VariableCollection();
IProcessor processor = SetupXmlStyleProcessor(vc);

//Changes should be made
bool changed = processor.Run(input, output, 50);
Verify(Encoding.UTF8, output, changed, value, expected);
}

}
}
171 changes: 171 additions & 0 deletions ...t.TemplateEngine.Orchestrator.RunnableProjects.UnitTests/RunnableProjectGeneratorTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -642,5 +642,176 @@ public async void Test_CoaleseWithInvalidSetup()
string resultContent = settings.Host.FileSystem.ReadAllText(Path.Combine(targetDir, "sourceFile"));
Assert.Equal(expectedSnippet, resultContent);
}

#pragma warning disable xUnit1004 // Test methods should not be skipped
[Fact(Skip = "https://github.com/dotnet/templating/issues/4988")]
#pragma warning restore xUnit1004 // Test methods should not be skipped
public async void XMLConditionFailure()
{
//
// Template content preparation
//

var templateConfig = new
{
identity = "test.template",
symbols = new
{
A = new
{
type = "parameter",
dataType = "bool",
defaultValue = "false"
},
B = new
{
type = "parameter",
dataType = "bool",
defaultValue = "false"
},
}
};

string sourceSnippet = @"
<!--#if (A) -->
<!-- comment foo -->
foo
<!--#endif -->
<!--#if (B) -->
This text should not be generated, just to make file content longer to prove the bug.
If the buffer is advanced when evaluating condition, the bug won't be reproduced.
This text ensures that buffer is long enough even considering very-very-long env variable names available on CI machine.
<!--#endif -->
";

string expectedSnippet = @"
<!-- comment foo -->
foo
";

IDictionary<string, string?> templateSourceFiles = new Dictionary<string, string?>
{
// template.json
{ TestFileSystemHelper.DefaultConfigRelativePath, JsonConvert.SerializeObject(templateConfig, Formatting.Indented) },

//content
{ "sourceFile.md", sourceSnippet }
};

//
// Dependencies preparation and mounting
//
IEngineEnvironmentSettings settings = _environmentSettingsHelper.CreateEnvironment(virtualize: true);
string sourceBasePath = FileSystemHelpers.GetNewVirtualizedPath(settings);
string targetDir = FileSystemHelpers.GetNewVirtualizedPath(settings);

TestFileSystemHelper.WriteTemplateSource(settings, sourceBasePath, templateSourceFiles);
IMountPoint? sourceMountPoint = TestFileSystemHelper.CreateMountPoint(settings, sourceBasePath);
RunnableProjectGenerator rpg = new();

TemplateConfigModel configModel = TemplateConfigModel.FromJObject(JObject.FromObject(templateConfig));
RunnableProjectConfig runnableConfig = new(settings, rpg, configModel, sourceMountPoint.FileInfo(TestFileSystemHelper.DefaultConfigRelativePath));
ParameterSetData parameters = new(
runnableConfig,
new Dictionary<string, object?>() { { "A", true } });
IDirectory sourceDir = sourceMountPoint!.DirectoryInfo("/")!;

//
// Running the actual scenario: template files processing and generating output (including macros processing)
//
await rpg.CreateAsync(settings, runnableConfig, sourceDir, parameters, targetDir, CancellationToken.None);

//
// Veryfying the outputs
//

string resultContent = settings.Host.FileSystem.ReadAllText(Path.Combine(targetDir, "sourceFile.md"));
Assert.Equal(expectedSnippet, resultContent);
}

#pragma warning disable xUnit1004 // Test methods should not be skipped
[Fact(Skip = "https://github.com/dotnet/templating/issues/4988")]
#pragma warning restore xUnit1004 // Test methods should not be skipped
public async void HashConditionFailure()
{
//
// Template content preparation
//

var templateConfig = new
{
identity = "test.template",
symbols = new
{
A = new
{
type = "parameter",
dataType = "bool",
defaultValue = "false"
},
B = new
{
type = "parameter",
dataType = "bool",
defaultValue = "false"
},
}
};

string sourceSnippet = @"
#if (A)
# comment foo
foo
#endif
##if (B)
This text should not be generated, just to make file content longer to prove the bug.
If the buffer is advanced when evaluating condition, the bug won't be reproduced.
This text ensures that buffer is long enough even considering very-very-long env variable names available on CI machine.
#endif
";

string expectedSnippet = @"
# comment foo
foo
";

IDictionary<string, string?> templateSourceFiles = new Dictionary<string, string?>
{
// template.json
{ TestFileSystemHelper.DefaultConfigRelativePath, JsonConvert.SerializeObject(templateConfig, Formatting.Indented) },

//content
{ "sourceFile.yaml", sourceSnippet }
};

//
// Dependencies preparation and mounting
//
IEngineEnvironmentSettings settings = _environmentSettingsHelper.CreateEnvironment(virtualize: true);
string sourceBasePath = FileSystemHelpers.GetNewVirtualizedPath(settings);
string targetDir = FileSystemHelpers.GetNewVirtualizedPath(settings);

TestFileSystemHelper.WriteTemplateSource(settings, sourceBasePath, templateSourceFiles);
IMountPoint? sourceMountPoint = TestFileSystemHelper.CreateMountPoint(settings, sourceBasePath);
RunnableProjectGenerator rpg = new();
TemplateConfigModel configModel = TemplateConfigModel.FromJObject(JObject.FromObject(templateConfig));
RunnableProjectConfig runnableConfig = new(settings, rpg, configModel, sourceMountPoint.FileInfo(TestFileSystemHelper.DefaultConfigRelativePath));
ParameterSetData parameters = new(
runnableConfig,
new Dictionary<string, object?>() { { "A", true } });
IDirectory sourceDir = sourceMountPoint!.DirectoryInfo("/")!;

//
// Running the actual scenario: template files processing and generating output (including macros processing)
//
await rpg.CreateAsync(settings, runnableConfig, sourceDir, parameters, targetDir, CancellationToken.None);

//
// Veryfying the outputs
//

string resultContent = settings.Host.FileSystem.ReadAllText(Path.Combine(targetDir, "sourceFile.yaml"));
Assert.Equal(expectedSnippet, resultContent);
}
}
}
2 changes: 1 addition & 1 deletion test/Microsoft.TemplateEngine.TestHelper/TestHost.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ internal TestHost(

_loggerFactory = new TestLoggerFactory();
addLoggerProviders?.ToList().ForEach(_loggerFactory.AddProvider);
_logger = _loggerFactory.CreateLogger("Test Host");
_logger = _loggerFactory.CreateLogger(hostIdentifier);
_fallbackNames = fallbackNames ?? new[] { "dotnetcli" };
}

Expand Down

0 comments on commit 7b805ba

Please sign in to comment.