-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3541 from Microsoft/users/kavipriya/settings
Users/kavipriya/settings
- Loading branch information
Showing
9 changed files
with
474 additions
and
499 deletions.
There are no files selected for viewing
This file contains 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 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 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 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,290 @@ | ||
| import tl = require('vsts-task-lib/task'); | ||
| import path = require('path'); | ||
| import Q = require('q'); | ||
| import models = require('./models') | ||
| import utilities = require('./utilities') | ||
|
|
||
| var os = require('os'); | ||
| var uuid = require('node-uuid'); | ||
| var fs = require('fs'); | ||
| var xml2js = require('xml2js'); | ||
| var parser = new xml2js.Parser(); | ||
| var builder = new xml2js.Builder(); | ||
| var headlessBuilder = new xml2js.Builder({headless: true}); | ||
|
|
||
| const runSettingsExt = ".runsettings"; | ||
| const testSettingsExt = ".testsettings"; | ||
|
|
||
| const TestSettingsAgentNameTag = "agent-5d76a195-1e43-4b90-a6ce-4ec3de87ed25"; | ||
| const TestSettingsNameTag = "testSettings-5d76a195-1e43-4b90-a6ce-4ec3de87ed25"; | ||
| const TestSettingsIDTag = "5d76a195-1e43-4b90-a6ce-4ec3de87ed25"; | ||
| const TestSettingsXmlnsTag = "http://microsoft.com/schemas/VisualStudio/TeamTest/2010" | ||
|
|
||
| //TestImpact collector | ||
| const TestImpactFriendlyName = "Test Impact"; | ||
| const TestImpactDataCollectorTemplate = "<DataCollector uri=\"datacollector://microsoft/TestImpact/1.0\" assemblyQualifiedName=\"Microsoft.VisualStudio.TraceCollector.TestImpactDataCollector, Microsoft.VisualStudio.TraceCollector, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\" friendlyName=\"Test Impact\"><Configuration><RootPath></RootPath></Configuration></DataCollector>"; | ||
|
|
||
| //Video collector | ||
| const VideoCollectorFriendlyName ="Screen and Voice Recorder"; | ||
| const VideoDataCollectorTemplate = "<DataCollector uri=\"datacollector://microsoft/VideoRecorder/1.0\" assemblyQualifiedName=\"Microsoft.VisualStudio.TestTools.DataCollection.VideoRecorder.VideoRecorderDataCollector, Microsoft.VisualStudio.TestTools.DataCollection.VideoRecorder, Version=14.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\" friendlyName=\"Screen and Voice Recorder\"></DataCollector>"; | ||
|
|
||
| //Parallel configuration | ||
| var runSettingsForParallel = '<?xml version="1.0" encoding="utf-8"?><RunSettings><RunConfiguration><MaxCpuCount>0</MaxCpuCount></RunConfiguration></RunSettings>'; | ||
|
|
||
| const testSettingsTemplate ="<?xml version=\"1.0\" encoding=\"UTF-8\"?>" + | ||
| "<TestSettings name=\"testSettings-5d76a195-1e43-4b90-a6ce-4ec3de87ed25\" id=\"5d76a195-1e43-4b90-a6ce-4ec3de87ed25\" xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\">" + | ||
| "<Execution>" + | ||
| "<AgentRule name=\"agent-5d76a195-1e43-4b90-a6ce-4ec3de87ed25\">" + | ||
| "<DataCollectors>" + | ||
| "</DataCollectors>" + | ||
| "</AgentRule>" + | ||
| "</Execution>" + | ||
| "</TestSettings>"; | ||
|
|
||
| const runSettingsTemplate = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" + | ||
| "<RunSettings>" + | ||
| "<DataCollectionRunSettings>" + | ||
| "<DataCollectors>" + | ||
| "</DataCollectors>" + | ||
| "</DataCollectionRunSettings>" + | ||
| "</RunSettings>"; | ||
|
|
||
| export async function updateSettingsFileAsRequired(settingsFile: string, isParallelRun: boolean, tiaConfig: models.TiaConfiguration, vsVersion: any, videoCollector: boolean) : Promise<string> | ||
| { | ||
| var defer=Q.defer<string>(); | ||
| var result: any; | ||
|
|
||
| if(!isParallelRun && !videoCollector && !tiaConfig.tiaEnabled) { | ||
| defer.resolve(settingsFile); | ||
| return defer.promise; | ||
| } | ||
|
|
||
| //Get extension of settings file and contents | ||
| var settingsExt = null; | ||
| if (settingsFile && fs.lstatSync(settingsFile).isFile() && settingsFile.split('.').pop().toLowerCase() === "testsettings") { | ||
| settingsExt=testSettingsExt; | ||
| result = await utilities.getXmlContents(settingsFile); | ||
| if(!result || result.TestSettings === undefined) { | ||
| tl.warning(tl.loc('FailedToSetRunConfiguration')); | ||
| settingsExt = null; | ||
| } | ||
| } else if (settingsFile && utilities.pathExistsAsFile(settingsFile)) { | ||
| settingsExt = runSettingsExt; | ||
| result = await utilities.getXmlContents(settingsFile); | ||
| if(!result || result.RunSettings === undefined) { | ||
| tl.warning(tl.loc('FailedToSetRunConfiguration')); | ||
| settingsExt = null; | ||
| } | ||
| } | ||
|
|
||
| if (isParallelRun) { | ||
| if (settingsExt === testSettingsExt) { | ||
| tl.warning(tl.loc('RunInParallelNotSupported')); | ||
| } else if (settingsExt === runSettingsExt) { | ||
| tl.debug("Enabling run in parallel by editing given runsettings.") | ||
| result = await setupRunSettingsFileForRunConfig(result, {MaxCpuCount: 0}); | ||
| } else { | ||
| tl.debug("Enabling run in parallel by creating new runsettings."); | ||
| settingsExt = runSettingsExt; | ||
| result = await CreateSettings(runSettingsForParallel); | ||
| } | ||
| } | ||
|
|
||
| if (videoCollector) { | ||
| //Enable video collector only in test settings. | ||
| var videoCollectorNode = null; | ||
| parser.parseString(VideoDataCollectorTemplate, function(err, data) { | ||
| if(err) { | ||
| defer.reject(err); | ||
| } | ||
| videoCollectorNode = data; | ||
| }); | ||
| if (settingsExt === testSettingsExt) { | ||
| tl.debug("Enabling video data collector by editing given testsettings.") | ||
| result = updateTestSettingsWithDataCollector(result, VideoCollectorFriendlyName, videoCollectorNode); | ||
| } else if (settingsExt === runSettingsExt) { | ||
| tl.warning(tl.loc('VideoCollectorNotSupportedWithRunSettings')); | ||
| } else { | ||
| tl.debug("Enabling video data collection by creating new test settings.") | ||
| settingsExt = testSettingsExt; | ||
| result = await CreateSettings(testSettingsTemplate); | ||
| result = updateTestSettingsWithDataCollector(result, VideoCollectorFriendlyName, videoCollectorNode) | ||
| } | ||
| } | ||
|
|
||
| if (tiaConfig.tiaEnabled) { | ||
| var testImpactCollectorNode = null; | ||
| parser.parseString(TestImpactDataCollectorTemplate, function(err, data) { | ||
| if(err) { | ||
| defer.reject(err); | ||
| } | ||
| testImpactCollectorNode = data; | ||
| if(tiaConfig.useNewCollector) { | ||
| testImpactCollectorNode.DataCollector.$.codebase = getTraceCollectorUri(vsVersion); | ||
| } | ||
| testImpactCollectorNode.DataCollector.Configuration[0].ImpactLevel = getTIALevel(tiaConfig); | ||
| if (getTIALevel(tiaConfig) === 'file') { | ||
| testImpactCollectorNode.DataCollector.Configuration[0].LogFilePath = 'true'; | ||
| } | ||
| if (tiaConfig.context === "CD") { | ||
| testImpactCollectorNode.DataCollector.Configuration[0].RootPath = ""; | ||
| } else { | ||
| testImpactCollectorNode.DataCollector.Configuration[0].RootPath = tiaConfig.sourcesDir; | ||
| } | ||
| }); | ||
| //var baseLineBuildId = await utilities.readFileContents(tiaConfig.baseLineBuildIdFile, "utf-8"); | ||
|
|
||
| if(settingsExt === testSettingsExt) | ||
| { | ||
| tl.debug("Enabling Test Impact collector by editing given testsettings.") | ||
| result = updateTestSettingsWithDataCollector(result, TestImpactFriendlyName, testImpactCollectorNode); | ||
| //result = await setupTestSettingsFileForRunConfig(result, { TestImpact : { '$': {enabled: 'true'} }, BaseLineRunId : baseLineBuildId}); | ||
| } else if (settingsExt === runSettingsExt) { | ||
| tl.debug("Enabling Test Impact collector by editing given runsettings.") | ||
| result = updateRunSettingsWithDataCollector(result, TestImpactFriendlyName, testImpactCollectorNode); | ||
| //result = await setupRunSettingsFileForRunConfig(result, { TestImpact : { '$': {enabled: 'true'} }, BaseLineRunId : baseLineBuildId}); | ||
| } else { | ||
| tl.debug("Enabling test impact data collection by creating new runsettings.") | ||
| settingsExt = runSettingsExt; | ||
| result = await CreateSettings(runSettingsTemplate); | ||
| result = updateRunSettingsWithDataCollector(result, TestImpactFriendlyName, testImpactCollectorNode); | ||
| //result = await setupRunSettingsFileForRunConfig(result, { TestImpact : { '$': {enabled: 'true'} }, BaseLineRunId : baseLineBuildId}); | ||
| } | ||
| } | ||
|
|
||
| if (result) { | ||
| utilities.writeXmlFile(result, settingsFile, settingsExt) | ||
| .then(function (filename) { | ||
| defer.resolve(filename); | ||
| }); | ||
| } else { | ||
| tl.debug("Not editing settings file. Using specified file as it is.") | ||
| defer.resolve(settingsFile); | ||
| } | ||
| return defer.promise; | ||
| } | ||
|
|
||
| function updateRunSettingsWithDataCollector(result: any, dataCollectorFriendlyName: string, dataCollectorNodeToAdd) { | ||
| if (!result.RunSettings) { | ||
| tl.debug("Updating runsettings file from RunSettings node"); | ||
| result.RunSettings = { DataCollectionRunSettings: { DataCollectors: dataCollectorNodeToAdd } }; | ||
| } else if (!result.RunSettings.DataCollectionRunSettings) { | ||
| tl.debug("Updating runsettings file from DataCollectionSettings node"); | ||
| result.RunSettings.DataCollectionRunSettings = { DataCollectors: dataCollectorNodeToAdd }; | ||
| } else if (!result.RunSettings.DataCollectionRunSettings[0].DataCollectors) { | ||
| tl.debug("Updating runsettings file from DataCollectors node"); | ||
| result.RunSettings.DataCollectionRunSettings[0] = { DataCollectors: dataCollectorNodeToAdd }; | ||
| } else { | ||
| var dataCollectorArray = result.RunSettings.DataCollectionRunSettings[0].DataCollectors[0].DataCollector; | ||
| if (!dataCollectorArray) { | ||
| tl.debug("Updating runsettings file from DataCollector node"); | ||
| result.RunSettings.DataCollectionRunSettings[0] = { DataCollectors: dataCollectorNodeToAdd }; | ||
| } else { | ||
| if (!isDataCollectorPresent(dataCollectorArray, dataCollectorFriendlyName)) { | ||
| tl.debug("Updating runsettings file, adding a DataCollector node"); | ||
| dataCollectorArray.push(dataCollectorNodeToAdd.DataCollector); | ||
| } | ||
| } | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| function isDataCollectorPresent(dataCollectorArray, dataCollectorFriendlyName: string): Boolean { | ||
| var found = false; | ||
| for (var node of dataCollectorArray) { | ||
| if (node.$.friendlyName && node.$.friendlyName.toUpperCase() === dataCollectorFriendlyName.toUpperCase()) { | ||
| tl.debug("Data collector already present, will not add the node."); | ||
| found = true; | ||
| break; | ||
| } | ||
| } | ||
| return found; | ||
| } | ||
|
|
||
| function updateTestSettingsWithDataCollector(result: any, dataCollectorFriendlyName: string, dataCollectorNodeToAdd) { | ||
| if (!result.TestSettings) { | ||
| tl.debug("Updating testsettings file from TestSettings node"); | ||
| result.TestSettings = { Execution: { AgentRule: { DataCollectors: dataCollectorNodeToAdd } } }; | ||
| result.TestSettings.Execution.AgentRule.$ = { name: TestSettingsAgentNameTag }; | ||
| result.TestSettings.$ = { name: TestSettingsNameTag, id: TestSettingsIDTag, xmlns: TestSettingsXmlnsTag }; | ||
| } else if (!result.TestSettings.Execution) { | ||
| tl.debug("Updating testsettings file from Execution node"); | ||
| result.TestSettings.Execution = { AgentRule: { DataCollectors: dataCollectorNodeToAdd } }; | ||
| result.TestSettings.Execution.AgentRule.$ = { name: TestSettingsAgentNameTag }; | ||
| } else if (!result.TestSettings.Execution[0].AgentRule) { | ||
| tl.debug("Updating testsettings file from AgentRule node"); | ||
| result.TestSettings.Execution[0] = { AgentRule: { DataCollectors: dataCollectorNodeToAdd } }; | ||
| result.TestSettings.Execution[0].AgentRule.$ = { name: TestSettingsAgentNameTag }; | ||
| } else if (!result.TestSettings.Execution[0].AgentRule[0].DataCollectors) { | ||
| tl.debug("Updating testsettings file from DataCollectors node"); | ||
| result.TestSettings.Execution[0].AgentRule[0] = { DataCollectors: dataCollectorNodeToAdd }; | ||
| result.TestSettings.Execution[0].AgentRule.$ = { name: TestSettingsAgentNameTag }; | ||
| } else { | ||
| var dataCollectorArray = result.TestSettings.Execution[0].AgentRule[0].DataCollectors[0].DataCollector; | ||
| if (!dataCollectorArray) { | ||
| tl.debug("Updating testsettings file from DataCollector node"); | ||
| result.TestSettings.Execution[0].AgentRule[0].DataCollectors[0] = dataCollectorNodeToAdd; | ||
| } else { | ||
| if (!isDataCollectorPresent(dataCollectorArray, dataCollectorFriendlyName)) { | ||
| tl.debug("Updating testsettings file, adding a DataCollector node"); | ||
| dataCollectorArray.push(dataCollectorNodeToAdd.DataCollector); | ||
| } | ||
| } | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| function CreateSettings(runSettingsContents: string) : Q.Promise<any> { | ||
| var defer=Q.defer<any>(); | ||
| parser.parseString(runSettingsContents, function (err, result) { | ||
| if(err) { | ||
| defer.reject(err); | ||
| } | ||
| defer.resolve(result); | ||
| }); | ||
| return defer.promise; | ||
| } | ||
|
|
||
| function setupRunSettingsFileForRunConfig(result: any, innerNode: any) : Q.Promise<any> { | ||
| var defer=Q.defer<any>(); | ||
| if (!result.RunSettings) { | ||
| result.RunSettings = { RunConfiguration: innerNode }; | ||
| } | ||
| else if (!result.RunSettings.RunConfiguration || !result.RunSettings.RunConfiguration[0]) { | ||
| result.RunSettings.RunConfiguration = innerNode ; | ||
| } | ||
| defer.resolve(result); | ||
| return defer.promise; | ||
| } | ||
|
|
||
| function setupTestSettingsFileForRunConfig(result: any, innerNode: any) : Q.Promise<any> { | ||
| var defer=Q.defer<any>(); | ||
| if (!result || result.TestSettings === undefined) { | ||
| tl.warning(tl.loc('FailedToSetRunConfiguration')); | ||
| defer.resolve(null); | ||
| } | ||
| if (!result.TestSettings) { | ||
| result.RunSettings = { Execution: innerNode }; | ||
| } | ||
| else if (!result.TestSettings.Execution || !result.TestSettings.Execution[0]) { | ||
| result.TestSettings.Execution = innerNode ; | ||
| } | ||
| defer.resolve(result); | ||
| return defer.promise; | ||
| } | ||
|
|
||
| function getTraceCollectorUri(vsVersion: any): string { | ||
| if(vsVersion === 15) { | ||
| return "file://" + path.join(__dirname, "TestSelector/Microsoft.VisualStudio.TraceCollector.dll"); | ||
| } | ||
| else { | ||
| return "file://" + path.join(__dirname, "TestSelector/14.0/Microsoft.VisualStudio.TraceCollector.dll"); | ||
| } | ||
| } | ||
|
|
||
| function getTIALevel(tiaConfig: models.TiaConfiguration) { | ||
| if (tiaConfig.fileLevel && tiaConfig.fileLevel.toUpperCase() === "FALSE") { | ||
| return "method"; | ||
| } | ||
| return "file"; | ||
| } |
Oops, something went wrong.