/// <summary>
/// Validates code gen by comparing it against a file containing the expected output.
/// </summary>
/// <remarks>
/// If no language is specified, C# and VB are both tested.
/// </remarks>
/// <param name="options">The options specifying the type of validation to perform</param>
internal static void ValidateCodeGen(CodeGenValidationOptions options)
{
if (string.IsNullOrEmpty(options.Language))
{
string errorMessage = string.Empty;
options.FailOnDiff = false;
options.Language = "C#";
errorMessage += TestHelper.ValidateLanguageCodeGen(options);
options.Language = "VB";
errorMessage += TestHelper.ValidateLanguageCodeGen(options);
if (!string.IsNullOrEmpty(errorMessage))
{
Assert.Fail(errorMessage);
}
}
else
{
TestHelper.ValidateLanguageCodeGen(options);
}
}
/// <summary>
/// Validates code gen for a specific language by comparing it against a file containing the expected output.
/// </summary>
/// <param name="codeGenOptions">The options specifying the type of validation to perform</param>
/// <returns>A command that updates the comparison file</returns>
internal static string ValidateLanguageCodeGen(CodeGenValidationOptions codeGenOptions)
{
Assert.IsFalse(string.IsNullOrEmpty(codeGenOptions.Language));
var outDataDir = GetOutputTestDataDir(codeGenOptions.RelativeDeployDir);
var extension = ExtensionFromLanguage(codeGenOptions.Language);
var diffMessage = string.Empty;
// Compose the abs path to where the test file got deployed by MSTest
string referenceFileName = TestHelper.GetTestFileName(codeGenOptions.RelativeDeployDir, codeGenOptions.BaseReferenceFileName + extension);
Assert.IsTrue(File.Exists(referenceFileName), "Cannot find reference file " + referenceFileName);
string generatedCode = string.Empty;
ClientCodeGenerationOptions options = new ClientCodeGenerationOptions()
{
Language = codeGenOptions.Language,
ClientRootNamespace = codeGenOptions.RootNamespace,
ClientProjectPath = "MockProject.proj",
UseFullTypeNames = codeGenOptions.UseFullTypeNames
};
MockCodeGenerationHost host = TestHelper.CreateMockCodeGenerationHost(codeGenOptions.Logger, codeGenOptions.SharedCodeService);
ILogger logger = host as ILogger;
EntityCatalog catalog = new EntityCatalog(codeGenOptions.EntityTypes, logger);
IClientCodeGenerator generator;
using (ClientCodeGenerationDispatcher dispatcher = new ClientCodeGenerationDispatcher())
{
generator = dispatcher.FindCodeGenerator(host, options, /*compositionAssemblies*/ null, /*codeGeneratorName*/ null);
}
Assert.IsNotNull(generator, "Failed to find a code generator");
generatedCode = generator.GenerateCode(host, catalog.EntityDescriptions, options);
ConsoleLogger consoleLogger = logger as ConsoleLogger;
string errors = consoleLogger == null ? "" : consoleLogger.Errors;
Assert.IsTrue(generatedCode.Length > 0, "No code was generated: " + errors);
// Dump the generated code into a file for comparison
bool isCSharp = options.Language.Equals("C#", StringComparison.InvariantCultureIgnoreCase);
string generatedFileName = Path.Combine(outDataDir, Path.GetFileName(referenceFileName) + ".testgen");
File.WriteAllText(generatedFileName, generatedCode);
// TODO: (ron M3) Solve inability to get right MSBuild after checkin
// First see if we compile
List <string> referenceAssemblies = CompilerHelper.GetClientAssemblies(codeGenOptions.RelativeDeployDir);
List <string> files = new List <string>();
files.Add(generatedFileName);
// Unconditionally force generation of Xml doc comments to catch errors
string documentationFile = Path.GetTempFileName();
try
{
if (isCSharp)
{
files.AddRange(codeGenOptions.SharedFiles.Where(sharedFile => Path.GetExtension(sharedFile).Equals(".cs")));
CompilerHelper.CompileCSharpSource(files, referenceAssemblies, documentationFile);
}
else
{
files.AddRange(codeGenOptions.SharedFiles.Where(sharedFile => Path.GetExtension(sharedFile).Equals(".vb")));
CompilerHelper.CompileVisualBasicSource(files, referenceAssemblies, options.ClientRootNamespace, documentationFile);
}
}
finally
{
File.Delete(documentationFile);
}
// Do the diff
if (codeGenOptions.FailOnDiff)
{
TestHelper.ValidateFilesEqual(codeGenOptions.RelativeTestDir, codeGenOptions.RelativeDeployDir, generatedFileName, referenceFileName, codeGenOptions.Language);
}
else
{
TestHelper.FilesMatch(codeGenOptions.RelativeTestDir, codeGenOptions.RelativeDeployDir, generatedFileName, referenceFileName, codeGenOptions.Language, out diffMessage);
}
return(diffMessage);
}
/// <summary>
/// Validates code gen for a specific language by comparing it against a file containing the expected output.
/// </summary>
/// <param name="codeGenOptions">The options specifying the type of validation to perform</param>
/// <returns>A command that updates the comparison file</returns>
internal static string ValidateLanguageCodeGen(CodeGenValidationOptions codeGenOptions)
{
Assert.IsFalse(string.IsNullOrEmpty(codeGenOptions.Language));
string outDataDir = TestHelper.GetOutputTestDataDir(codeGenOptions.RelativeDeployDir);
string extension = TestHelper.ExtensionFromLanguage(codeGenOptions.Language);
string diffMessage = string.Empty;
// Compose the abs path to where the test file got deployed by MSTest
string referenceFileName = TestHelper.GetTestFileName(codeGenOptions.RelativeTestDir, codeGenOptions.BaseReferenceFileName + extension);
Assert.IsTrue(File.Exists(referenceFileName), "Cannot find reference file " + referenceFileName);
string generatedCode = string.Empty;
ClientCodeGenerationOptions options = new ClientCodeGenerationOptions()
{
Language = codeGenOptions.Language,
ClientRootNamespace = codeGenOptions.RootNamespace,
ClientProjectPath = "MockProject.proj",
IsApplicationContextGenerationEnabled = codeGenOptions.GenerateApplicationContexts,
UseFullTypeNames = codeGenOptions.UseFullTypeNames,
ClientProjectTargetPlatform = TargetPlatform.Silverlight
};
MockCodeGenerationHost host = TestHelper.CreateMockCodeGenerationHost(codeGenOptions.Logger, codeGenOptions.SharedCodeService);
ILogger logger = host as ILogger;
DomainServiceCatalog catalog = new DomainServiceCatalog(codeGenOptions.DomainServiceTypes, logger);
IDomainServiceClientCodeGenerator generator;
using (ClientCodeGenerationDispatcher dispatcher = new ClientCodeGenerationDispatcher())
{
generator = dispatcher.FindCodeGenerator(host, options, /*compositionAssemblies*/ null, /*codeGeneratorName*/ null);
}
Assert.IsNotNull(generator, "Failed to find a code generator");
generatedCode = generator.GenerateCode(host, catalog.DomainServiceDescriptions, options);
ConsoleLogger consoleLogger = logger as ConsoleLogger;
string errors = consoleLogger == null ? "" : consoleLogger.Errors;
Assert.IsTrue(generatedCode.Length > 0, "No code was generated: " + errors);
// Dump the generated code into a file for comparison
bool isCSharp = options.Language.Equals("C#", StringComparison.InvariantCultureIgnoreCase);
string generatedFileName = Path.Combine(outDataDir, Path.GetFileName(referenceFileName) + ".testgen");
File.WriteAllText(generatedFileName, generatedCode);
// TODO: (ron M3) Solve inability to get right MSBuild after checkin
// First see if we compile
List<string> referenceAssemblies = CompilerHelper.GetSilverlightClientAssemblies(codeGenOptions.RelativeDeployDir);
List<string> files = new List<string>();
files.Add(generatedFileName);
// Unconditionally force generation of Xml doc comments to catch errors
string documentationFile = Path.GetTempFileName();
try
{
if (isCSharp)
{
files.AddRange(codeGenOptions.SharedFiles.Where(sharedFile => Path.GetExtension(sharedFile).Equals(".cs")));
CompilerHelper.CompileCSharpSource(files, referenceAssemblies, documentationFile);
}
else
{
files.AddRange(codeGenOptions.SharedFiles.Where(sharedFile => Path.GetExtension(sharedFile).Equals(".vb")));
CompilerHelper.CompileVisualBasicSource(files, referenceAssemblies, options.ClientRootNamespace, documentationFile);
}
}
finally
{
File.Delete(documentationFile);
}
// Do the diff
if (codeGenOptions.FailOnDiff)
{
TestHelper.ValidateFilesEqual(codeGenOptions.RelativeTestDir, codeGenOptions.RelativeDeployDir, generatedFileName, referenceFileName, codeGenOptions.Language);
}
else
{
TestHelper.FilesMatch(codeGenOptions.RelativeTestDir, codeGenOptions.RelativeDeployDir, generatedFileName, referenceFileName, codeGenOptions.Language, out diffMessage);
}
return diffMessage;
}
/// <summary>
/// Validates code gen by comparing it against a file containing the expected output.
/// </summary>
/// <remarks>
/// If no language is specified, C# and VB are both tested.
/// </remarks>
/// <param name="options">The options specifying the type of validation to perform</param>
internal static void ValidateCodeGen(CodeGenValidationOptions options)
{
if (string.IsNullOrEmpty(options.Language))
{
string errorMessage = string.Empty;
options.FailOnDiff = false;
options.Language = "C#";
errorMessage += TestHelper.ValidateLanguageCodeGen(options);
options.Language = "VB";
errorMessage += TestHelper.ValidateLanguageCodeGen(options);
if (!string.IsNullOrEmpty(errorMessage))
{
Assert.Fail(errorMessage);
}
}
else
{
TestHelper.ValidateLanguageCodeGen(options);
}
}
