/// <summary>
/// Executes Tests
/// </summary>
public static void Execute(ExecutionSettings settings)
{
Stack <ICleanableCommand> cleanupCommands = new Stack <ICleanableCommand>();
try
{
//Elevation Service is hitting Error #5 "Access Denied" in XP - We don't have run time dependencies on it right now, so disabling.
//cleanupCommands.Push(ElevationServiceCommand.Apply(infraBinariesDirectory));
cleanupCommands.Push(LogDirectoryCommand.Apply(settings.LogFilesPath, settings.SkipDxDiag));
ExecutionComponents executionComponents = new ExecutionComponents();
executionComponents.DebuggingEngine = DebuggingEngineCommand.Apply(settings.InfraBinariesDirectory, settings.JitDebuggerCommand);
cleanupCommands.Push(executionComponents.DebuggingEngine);
ExecutionEventLog.RecordStatus("Creating LoggingMediator.");
executionComponents.LoggingMediator = new LoggingMediator(settings.DebugTests); //Consider using dispose pattern.
executionComponents.LoggingMediator.StartService(executionComponents.DebuggingEngine, settings.Tests.TestCollection.Count(record => record.ExecutionEnabled));
//
cleanupCommands.Push(ExecutionGroupLogCommand.Apply("InfraExecution", settings.LogFilesPath, executionComponents.LoggingMediator));
if (settings.CodeCoverageEnabled)
{
cleanupCommands.Push(MergeCodeCoverageDataCommand.Apply(settings.LogFilesPath));
}
cleanupCommands.Push(TemporaryDirectoryCommand.Apply(settings.ExecutionRootDirectory));
cleanupCommands.Push(MoveWindowCommand.Apply());
cleanupCommands.Push(ExecutionEventLog.Apply(settings.LogFilesPath, !settings.ContinueExecution));
try
{
ExecuteTestStateGroups(settings, executionComponents);
}
catch (Exception e)
{
ExecutionEventLog.RecordException(e);
}
finally
{
ExecutionEventLog.RecordStatus("Ending Test Sequence.");
ExecutionEventLog.RecordStatus("Shutting down test logging system.");
executionComponents.LoggingMediator.StopService();
}
}
finally
{
Cleanup(cleanupCommands);
Console.WriteLine("Test Execution has finished.\n");
}
}
/// <summary>
/// Bucketize collection of tests by matching State management needs, and run through each group.
/// Notion of Execution group + a tracking counter variable seem to be critical elements.
/// This (and supportfiles one) can likely get generalized+factored well to the ExecutionGroup class with some thought.
/// </summary>
private static void ExecuteTestStateGroups(ExecutionSettings settings, ExecutionComponents executionComponents)
{
ExecutionEventLog.RecordStatus("Running Test Sequence.");
List <TestRecord> enabledTests = new List <TestRecord>(settings.Tests.TestCollection.Where(test => (test.ExecutionEnabled == true)));
int stateGroupIndex = 0;
// NOTE: Hash method for Deployments is order sensitive.
IEnumerable <List <TestRecord> > testGroups = ExecutionGrouper.Bucketize(enabledTests,
ExecutionGroupingLevel.SharedStateManagement,
x => x.TestInfo.Area + x.TestInfo.Deployments.ToCommaSeparatedList());
foreach (List <TestRecord> stateManagementGroup in testGroups)
{
ExecutionEventLog.RecordStatus("Running State Group # " + stateGroupIndex + " of " + testGroups.Count());
Stack <ICleanableCommand> stateCleanupCommands = new Stack <ICleanableCommand>();
ExecutionGroupRecord stateGroupRecord = ExecutionGroupRecord.Begin(ExecutionGroupType.State, stateManagementGroup[0].TestInfo.Area);
try
{
settings.Tests.ExecutionGroupRecords.Add(stateGroupRecord);
DirectoryInfo stateLogPath = settings.DetermineTestLogDirectory(settings.DetermineGroupPath(stateGroupIndex));
ExecutionGroupLogCommand command = ExecutionGroupLogCommand.Apply("StateManagement", stateLogPath, executionComponents.LoggingMediator);
stateCleanupCommands.Push(command);
stateCleanupCommands.Push(ExecutionStateCommand.Apply(stateManagementGroup.First(), settings.TestBinariesDirectory));
ExecuteTestSupportFileGroups(settings, stateManagementGroup, stateGroupRecord, stateGroupIndex, executionComponents);
}
catch (Exception e)
{
ExecutionEventLog.RecordException(e);
}
finally
{
Cleanup(stateCleanupCommands);
stateGroupRecord.End();
stateGroupIndex++;
}
}
}
/// <summary>
/// Runs the specified test
/// </summary>
private static TimeSpan ExecuteTest(ExecutionSettings settings, TestRecord test, ExecutionComponents components, DirectoryInfo executionDirectory, DirectoryInfo executionLogPath)
{
TimeSpan processDuration = TimeSpan.Zero;
Stack <ICleanableCommand> cleanupCommands = new Stack <ICleanableCommand>();
try
{
List <TestRecord> tests = new List <TestRecord>();
tests.Add(test);
//Perform the following set of commands, and unwind at cleanup in reverse order, regardless of success/failure
cleanupCommands.Push(ListenToTestsCommand.Apply(tests, components.LoggingMediator, executionLogPath, settings.DebugTests));
if (settings.CodeCoverageEnabled)
{
cleanupCommands.Push(GatherTestCodeCoverageCommand.Apply(test, executionLogPath));
}
ExecutionEventLog.RecordStatus("Starting Test.");
processDuration = DriverLauncher.Launch(settings, tests, executionDirectory, components.DebuggingEngine);
if (settings.RerunFailures && ShouldRerun(tests))
{
// Run cleanup to end any active logs...
// *************************************
// ATTENTION!
// This behavior (clear cleanup commands, then re-push them) used for re-run has only been tested to work with the CodeCoverage and ListenToTestsCommands.
// Since the stack is instantiated here and used here, this is a very contained assumption.
// If you need to add more types of cleanup commands, please ensure they work with RerunFailures.
// *************************************
Cleanup(cleanupCommands);
cleanupCommands.Clear();
//Perform the following set of commands, and unwind at cleanup in reverse order, regardless of success/failure
cleanupCommands.Push(ListenToTestsCommand.Apply(tests, components.LoggingMediator, executionLogPath, settings.DebugTests));
if (settings.CodeCoverageEnabled)
{
cleanupCommands.Push(GatherTestCodeCoverageCommand.Apply(test, executionLogPath));
}
ClearResult(test);
// Then re-run the test...
ExecutionEventLog.RecordStatus("Not all test variations passed but no crashes recorded, attempting to re-run. (ExecuteTest Variation)");
processDuration = processDuration.Add(DriverLauncher.Launch(settings, tests, executionDirectory, components.DebuggingEngine));
}
ExecutionEventLog.RecordStatus("Test Execution sequence completed normally.");
}
catch (Exception e)
{
ExecutionEventLog.RecordException(e);
}
finally
{
Cleanup(cleanupCommands);
}
return(processDuration);
}
private static void ExecuteUniformTestGroup(ExecutionSettings settings, List <TestRecord> uniformTestGroup, ExecutionGroupRecord fileGroupRecord, int stateGroupIndex, int supportFileGroupIndex, ExecutionComponents components)
{
string groupPath = settings.DetermineGroupPath(stateGroupIndex, supportFileGroupIndex);
DirectoryInfo executionDirectory = settings.DetermineTestExecutionDirectory(groupPath);
string executionLabel = "(" + stateGroupIndex + "," + supportFileGroupIndex + ")";
IEnumerable <List <TestRecord> > testGroups;
if (settings.CodeCoverageEnabled) // When using Code Coverage, we do not group test Appdomains together
{
testGroups = ExecutionGrouper.MakeGroupPerTest(uniformTestGroup);
}
else //Normal logic: Bucketize based on support for Shared App domains and driver
{
testGroups = ExecutionGrouper.Bucketize(
uniformTestGroup,
ExecutionGroupingLevel.SharedAppDomains,
x => x.TestInfo.Driver.Executable + x.TestInfo.DriverParameters["SecurityLevel"]);
}
int testCount = 0;
foreach (List <TestRecord> tests in testGroups)
{
ExecutionGroupRecord appDomainRecord = ExecutionGroupRecord.Begin(ExecutionGroupType.AppDomain, fileGroupRecord.Area);
fileGroupRecord.ExecutionGroupRecords.Add(appDomainRecord);
TestInfo first = tests.First().TestInfo;
//Tests which allow grouping & use STI get to be run as a group during normal runs.
//All tests must run separately with Code coverage runs.
bool runAsGroup = !settings.CodeCoverageEnabled &&
first.Driver.Executable.Equals("Sti.exe", StringComparison.OrdinalIgnoreCase) && first.ExecutionGroupingLevel >= ExecutionGroupingLevel.SharedAppDomains;
TimeSpan processDuration;
if (runAsGroup)//STI gets special treatment
{
ExecutionEventLog.RecordStatus(string.Format(CultureInfo.InvariantCulture, "Starting Shared AppDomain Test Process #{0}-{1}", groupPath, testCount));
DirectoryInfo testLogDirectory = settings.DetermineTestLogDirectory(settings.DetermineGroupPath(stateGroupIndex, supportFileGroupIndex));
processDuration = ExecuteSti(settings, tests, components, executionDirectory, testLogDirectory);
ExecutionEventLog.RecordStatus(string.Format(CultureInfo.InvariantCulture, "Finished Shared AppDomain Test Process #{0}-{1}", groupPath, testCount));
}
else
{
ExecutionEventLog.RecordStatus(string.Format(CultureInfo.InvariantCulture, "Starting Test Process #{0}-{4} Runtests.cmd /Area={1} /Name={3} /Subarea={2}", groupPath, first.Area, first.SubArea, first.Name, testCount));
if (tests.Count > 1)
{
throw new InvalidDataException("[Infra bug]Tests should be hashed into lists of individual tests.");
}
DirectoryInfo testLogDirectory = settings.DetermineTestLogDirectory(settings.DetermineGroupPath(stateGroupIndex, supportFileGroupIndex, testCount));
PrepLogDirectory(testLogDirectory);//HACK: Ideally logging can guarantee this in final configuration.
processDuration = ExecuteTest(settings, tests.First(), components, executionDirectory, testLogDirectory);
ExecutionEventLog.RecordStatus(string.Format(CultureInfo.InvariantCulture, "Finished Test Process #{0}-{4} /Area={1} /Name={3} /Subarea={2}", groupPath, first.Area, first.SubArea, first.Name, testCount));
}
Reporting.ReportingUtilities.ApplyProcessCost(tests, processDuration);
appDomainRecord.End();
testCount++;
}
}
/// <summary>
/// Retrieve previously generated execution results, if they are present.
/// </summary>
private static bool GetCachedExecutionResult(ExecutionSettings settings, List <TestRecord> executionGroup, DirectoryInfo executionLogPath, ExecutionComponents components)
{
List <TestRecord> previousResults = null;
if (settings.ContinueExecution)
{
previousResults = ExecutionBackupStore.LoadIntermediateTestRecords(executionLogPath);
}
if (previousResults != null)
{
//Confirm we have a match for all the tests
if (executionGroup.Count != previousResults.Count)
{
return(false);
}
for (int i = 0; i < executionGroup.Count; i++)
{
if (executionGroup[i].TestInfo.Name != previousResults[i].TestInfo.Name)
{
return(false); //Note: We should probably ---- previous log results
}
}
for (int i = 0; i < executionGroup.Count; i++)
{
TestRecord test = executionGroup[i];
TestRecord previous = previousResults[i];
test.Log = previous.Log;
foreach (FileInfo file in previous.LoggedFiles)
{
test.LoggedFiles.Add(file);
}
test.Machine = previous.Machine;
foreach (VariationRecord record in previous.Variations)
{
test.Variations.Add(record);
}
}
return(true);
}
else
{
return(false);
}
}
/// <summary>
/// Bucketize and run through groups of matching support file needs.
/// </summary>
private static void ExecuteTestSupportFileGroups(ExecutionSettings settings, List <TestRecord> stateManagementGroup, ExecutionGroupRecord stateGroupRecord, int stateGroupIndex, ExecutionComponents components)
{
int supportFileGroupIndex = 0;
//Bucketize
// NOTE: Hash method for SupportFiles is order sensitive.
IEnumerable <List <TestRecord> > testGroups = ExecutionGrouper.Bucketize(
stateManagementGroup,
ExecutionGroupingLevel.SharedSupportFiles,
x => HashSupportFileGroup(x));
foreach (List <TestRecord> supportFileGroup in testGroups)
{
Stack <ICleanableCommand> filecleanupCommands = new Stack <ICleanableCommand>();
ExecutionGroupRecord supportFileGroupRecord = ExecutionGroupRecord.Begin(ExecutionGroupType.Files, stateGroupRecord.Area);
stateGroupRecord.ExecutionGroupRecords.Add(supportFileGroupRecord);
DirectoryInfo executionDirectory = settings.DetermineTestExecutionDirectory(settings.DetermineGroupPath(stateGroupIndex, supportFileGroupIndex));
DirectoryInfo logDirectory = settings.DetermineTestLogDirectory(settings.DetermineGroupPath(stateGroupIndex, supportFileGroupIndex));
PrepLogDirectory(logDirectory);//HACK: Ideally logging can guarantee this in final configuration.
if (GetCachedExecutionResult(settings, supportFileGroup, logDirectory, components))
{
ExecutionEventLog.RecordStatus("Successfully retrieved previously stored execution result. ");
}
else
{
ExecutionEventLog.RecordStatus("Applying Support Files and Executing.");
ExecutionGroupLogCommand command = ExecutionGroupLogCommand.Apply("SupportFiles", logDirectory, components.LoggingMediator);
filecleanupCommands.Push(command);
filecleanupCommands.Push(DesktopSnapshotCommand.Apply(logDirectory));
// Create temporary directory, but if we are using a fixed test execution directory, don't delete it if it was pre-existing.
filecleanupCommands.Push(TemporaryDirectoryCommand.Apply(executionDirectory, settings.FixedTestExecutionDirectory != null));
filecleanupCommands.Push(SupportFileCommand.Apply(supportFileGroup, settings.TestBinariesDirectory, executionDirectory));
filecleanupCommands.Push(BackupRecordsCommand.Apply(supportFileGroup, logDirectory));
filecleanupCommands.Push(ProcessLogsCommand.Apply(supportFileGroup, components.LoggingMediator));
try
{
ExecuteUniformTestGroup(settings, supportFileGroup, supportFileGroupRecord, stateGroupIndex, supportFileGroupIndex, components);
}
catch (Exception e)
{
ExecutionEventLog.RecordException(e);
}
finally
{
Cleanup(filecleanupCommands);
}
}
supportFileGroupRecord.End();
supportFileGroupIndex++;
}
}
