Skip to content

Commit

Permalink
Spelling / conventions and grammar fixes (#2338)
Browse files Browse the repository at this point in the history
* Convention, spelling & grammar fixes.

* major amount of whitespace fixes and some other spelling and convention fixes

* revert some breaking tests
  • Loading branch information
HeroMaxPower authored Feb 26, 2020
1 parent e7ef9a6 commit 5752756
Show file tree
Hide file tree
Showing 369 changed files with 3,985 additions and 4,002 deletions.
2 changes: 1 addition & 1 deletion samples/Microsoft.TestPlatform.E2ETest/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace Microsoft.TestPlatform.E2ETest
using Microsoft.VisualStudio.TestPlatform.CoreUtilities.Extensions;
using System.Diagnostics;
using System.IO;

public class Program
{
public static void Main(string[] args)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public static class MessageType
/// The discovery started.
/// </summary>
public const string StartDiscovery = "TestDiscovery.Start";

/// <summary>
/// The test cases found.
/// </summary>
Expand Down Expand Up @@ -104,12 +104,12 @@ public static class MessageType
public const string GetTestRunnerProcessStartInfoForRunSelected = "TestExecution.GetTestRunnerProcessStartInfoForRunSelected";

/// <summary>
/// CustomTestHostLaunch
/// CustomTestHostLaunch
/// </summary>
public const string CustomTestHostLaunch = "TestExecution.CustomTestHostLaunch";

/// <summary>
/// Custom Test Host launch callback
/// Custom Test Host launch callback
/// </summary>
public const string CustomTestHostLaunchCallback = "TestExecution.CustomTestHostLaunchCallback";

Expand All @@ -119,7 +119,7 @@ public static class MessageType
public const string ExtensionsInitialize = "Extensions.Initialize";

/// <summary>
/// Start Test Run All Sources
/// Start Test Run All Sources
/// </summary>
public const string TestRunAllSourcesWithDefaultHost = "TestExecution.RunAllWithDefaultHost";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ namespace Microsoft.TestPlatform.Protocol
using System.Net.Sockets;
using System.Threading;
using System.Threading.Tasks;

/// <summary>
/// Facilitates communication using sockets
/// </summary>
/// </summary>
public class SocketCommunicationManager
{
/// <summary>
/// TCP Listener to host TCP channel and listen
/// </summary>
private TcpListener tcpListener;

/// <summary>
/// Binary Writer to write to channel stream
/// </summary>
Expand All @@ -39,9 +39,9 @@ public class SocketCommunicationManager
/// Event used to maintain client connection state
/// </summary>
private ManualResetEvent clientConnectedEvent = new ManualResetEvent(false);

/// <summary>
/// Sync object for sending messages
/// Sync object for sending messages
/// SendMessage over socket channel is NOT thread-safe
/// </summary>
private object sendSyncObject = new object();
Expand Down Expand Up @@ -130,7 +130,7 @@ public void StopServer()
}

#endregion

/// <summary>
/// Writes message to the binary writer.
/// </summary>
Expand Down Expand Up @@ -181,7 +181,7 @@ public string ReceiveRawMessage()
Console.WriteLine(rawMessage);
return rawMessage;
}

/// <summary>
/// Deserializes the Message into actual TestPlatform objects
/// </summary>
Expand All @@ -192,7 +192,7 @@ public T DeserializePayload<T>(Message message)
{
return this.dataSerializer.DeserializePayload<T>(message);
}

/// <summary>
/// Writes the data on socket and flushes the buffer
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ namespace Microsoft.TestPlatform.Protocol
public class DiscoveryRequestPayload
{
/// <summary>
/// Settings used for the discovery request.
/// Settings used for the discovery request.
/// </summary>
[DataMember]
public IEnumerable<string> Sources { get; set; }

/// <summary>
/// Settings used for the discovery request.
/// Settings used for the discovery request.
/// </summary>
[DataMember]
public string RunSettings { get; set; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ public class TestRunRequestPayload
public dynamic TestCases { get; set; }

/// <summary>
/// Gets or sets the settings used for the test run request.
/// Gets or sets the settings used for the test run request.
/// </summary>
[DataMember]
public string RunSettings { get; set; }

/// <summary>
/// Settings used for the Run request.
/// Settings used for the Run request.
/// </summary>
[DataMember]
public bool KeepAlive { get; set; }

/// <summary>
/// Is Debugging enabled
/// Is Debugging enabled
/// </summary>
[DataMember]
public bool DebuggingEnabled { get; set; }
Expand Down
12 changes: 6 additions & 6 deletions samples/Microsoft.TestPlatform.Protocol/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public static int Main(string[] args)
</RunSettings>";
}

// Intialize the extensions
// Initialize the extensions
if (testadapterPath != null)
{
communicationManager.SendMessage(MessageType.ExtensionsInitialize, new List<string>() { testadapterPath });
Expand All @@ -110,7 +110,7 @@ public static int Main(string[] args)
case "discovery":
discoveredTestCases = DiscoverTests(testadapterPath, testAssembly, settingsXml);
break;

case "runselected":
discoveredTestCases = DiscoverTests(testadapterPath, testAssembly, settingsXml);
RunSelectedTests(discoveredTestCases, settingsXml);
Expand Down Expand Up @@ -180,7 +180,7 @@ static dynamic DiscoverTests(string testadapterPath, string testAssembly, string
{
dynamic discoveryCompletePayload =
JsonDataSerializer.Instance.DeserializePayload<dynamic>(message);

// Handle discovery complete here
isDiscoveryComplete = true;
}
Expand All @@ -193,14 +193,14 @@ static dynamic DiscoverTests(string testadapterPath, string testAssembly, string

return testCases;
}

static void RunAllTests(List<string> sources, string settingsXml)
{
Console.WriteLine("Starting Operation: RunAll");
communicationManager.SendMessage(MessageType.TestRunAllSourcesWithDefaultHost, new TestRunRequestPayload() { Sources = sources, RunSettings = settingsXml });
RecieveRunMesagesAndHandleRunComplete();
}

static void RunSelectedTests(dynamic testCases, string settingsXml)
{
Console.WriteLine("Starting Operation: RunSelected");
Expand Down Expand Up @@ -262,7 +262,7 @@ static void RecieveRunMesagesAndHandleRunComplete()
{
var testProcessStartInfo = dataSerializer.DeserializePayload<dynamic>(message);

// Launch Test Host here and Send the acknowledgement
// Launch Test Host here and Send the acknowledgment
var ackPayload = new CustomHostLaunchAckPayload() { HostProcessId = -1, ErrorMessage = null };

Process process = new Process();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public void StartProcess(string[] args)
{
this.process = new Process();
process.StartInfo.FileName = GetDotnetHostFullPath();

if (args != null)
{
process.StartInfo.Arguments = args.Length < 2 ? args[0] : string.Join(" ", args);
Expand All @@ -56,7 +56,7 @@ public void StartProcess(string[] args)

process.StartInfo.UseShellExecute = false;
process.StartInfo.CreateNoWindow = true;

process.Start();
process.EnableRaisingEvents = true;
process.Exited += Process_Exited;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public CollectorNameValueConfigurationManager(XmlElement configurationElement)
}

// Save the name/value pair in the dictionary. Note that duplicate settings are
// overwritten with the last occurrance's value.
// overwritten with the last occurrence's value.
if (this.nameValuePairs.ContainsKey(settingName))
{
if (EqtTrace.IsVerboseEnabled)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ internal string WriteEventLogs(List<EventLogEntry> eventLogEntries, int maxLogEn
/// <summary>
/// Cleans up resources allocated by the data collector
/// </summary>
/// <param name="disposing">Not used since this class does not have a finaliser.</param>
/// <param name="disposing">Not used since this class does not have a finalizer.</param>
protected override void Dispose(bool disposing)
{
// Unregister events
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace Microsoft.TestPlatform.Extensions.EventLogCollector
using System.Collections.Generic;

/// <summary>
/// Stores the start and end index for EventLogEntries correspoinding to a data collection session.
/// Stores the start and end index for EventLogEntries corresponding to a data collection session.
/// </summary>
internal class EventLogSessionContext
{
Expand Down
4 changes: 2 additions & 2 deletions src/DataCollectors/TraceDataCollector/ProcessJobObject.cs
Original file line number Diff line number Diff line change
Expand Up @@ -667,7 +667,7 @@ private struct ExtendedLimits32
public BasicLimits32 BasicLimits;

/// <summary>
/// Resereved.
/// Reserved.
/// </summary>
[FieldOffset(48)]
public IoCounters32 IoInfo;
Expand Down Expand Up @@ -718,7 +718,7 @@ private struct ExtendedLimits64
public BasicLimits64 BasicLimits;

/// <summary>
/// Resereved.
/// Reserved.
/// </summary>
[FieldOffset(64)]
public IoCounters64 IoInfo;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ protected override void OnInitialize(XmlElement configurationElement)
}
catch (Exception ex)
{
EqtTrace.Error("DynamicCoverageDataCollector.OnInitialize: Failed to initialize code coverage datacolector with exception: {0}", ex);
EqtTrace.Error("DynamicCoverageDataCollector.OnInitialize: Failed to initialize code coverage datacollector with exception: {0}", ex);
this.Logger.LogError(
this.AgentContext.SessionDataCollectionContext,
string.Format(CultureInfo.CurrentUICulture, Resources.FailedToInitializeCodeCoverageDataCollector, ex));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ internal class DynamicCoverageDataCollectorImpl : IDynamicCoverageDataCollectorI
private const string ConfigCodeCoverageElementName = "CodeCoverage";

/// <summary>
/// File name which conatins config for vanguard process.
/// File name which contains config for vanguard process.
/// </summary>
private const string VanguardConfigFileName = "CodeCoverage.config";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ internal class Vanguard : IVanguard
private const uint WaitObject0 = 0x00000000;

/// <summary>
/// Time limit for vangaurd process exit event
/// Time limit for vanguard process exit event
/// </summary>
private const int ProcessExitWaitLimit = 60000;

Expand All @@ -38,7 +38,7 @@ internal class Vanguard : IVanguard
private const string GlobalEventNamePrefix = "Global\\";

/// <summary>
/// Stop() will use this event to check wheather the stop vanguard commnad
/// Stop() will use this event to check whether the stop vanguard command
/// successful stop the collect command codecoverage.exe.
/// </summary>
private ManualResetEvent vanguardProcessExitEvent;
Expand Down Expand Up @@ -98,7 +98,7 @@ internal Vanguard(
}

/// <summary>
/// Gets a value indicating whether whether vanguard is running
/// Gets a value indicating whether vanguard is running
/// </summary>
private bool IsRunning
{
Expand Down Expand Up @@ -139,7 +139,7 @@ public virtual void Start(string outputName, DataCollectionContext context)
/// <inheritdoc />
public virtual void Stop()
{
EqtTrace.Info("Vanguard.Stop: Stoping Vanguard.");
EqtTrace.Info("Vanguard.Stop: Stopping Vanguard.");
if (this.IsRunning)
{
var shutdownCommand = this.vanguardCommandBuilder.GenerateCommandLine(
Expand All @@ -151,7 +151,7 @@ public virtual void Stop()

if (this.vanguardProcessExitEvent.WaitOne(ProcessExitWaitLimit) == false)
{
EqtTrace.Warning("Vanguard.Stop: Vangurad process not exited in {0} ms", ProcessExitWaitLimit);
EqtTrace.Warning("Vanguard.Stop: Vanguard process not exited in {0} ms", ProcessExitWaitLimit);
}

if (this.processJobObject != null)
Expand Down Expand Up @@ -275,12 +275,12 @@ private Process StartVanguardProcess(
}
else if (this.processJobObject != null)
{
EqtTrace.Info("Vanguard.StartVanguardProcess: Add Vangaurd process to the project object");
EqtTrace.Info("Vanguard.StartVanguardProcess: Add Vanguard process to the project object");
this.processJobObject.AddProcess(process.SafeHandle.DangerousGetHandle());
}

EqtTrace.Info(
"Vanguard.StartVanguardProcess: Started Vangaurd process id :{0}",
"Vanguard.StartVanguardProcess: Started Vanguard process id :{0}",
Vanguard.GetProcessId(process));

return process;
Expand Down Expand Up @@ -340,7 +340,7 @@ private void WaitForRunningEvent()
/// <param name="e">Event args. </param>
private void LoggerProcessExited(object sender, EventArgs e)
{
EqtTrace.Info("Vanguard.LoggerProcessExited: Vangaurd process exit callback started.");
EqtTrace.Info("Vanguard.LoggerProcessExited: Vanguard process exit callback started.");
if (this.vanguardProcess != null)
{
if (this.vanguardProcess.HasExited == true && this.vanguardProcess.ExitCode != 0)
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.TestPlatform.Build/ArgumentEscaper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public static class ArgumentEscaper
/// <summary>
/// Undo the processing which took place to create string[] args in Main,
/// so that the next process will receive the same string[] args
///
///
/// See here for more info:
/// http://blogs.msdn.com/b/twistylittlepassagesallalike/archive/2011/04/23/everyone-quotes-arguments-the-wrong-way.aspx
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace Microsoft.VisualStudio.TestPlatform.Client.DesignMode
using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;

/// <summary>
/// Registers the discovery and test run events for designmode flow
/// Registers the discovery and test run events for design mode flow
/// </summary>
public class DesignModeTestEventsRegistrar : ITestDiscoveryEventsRegistrar, ITestRunEventsRegistrar
{
Expand Down Expand Up @@ -54,10 +54,10 @@ public void UnregisterTestRunEvents(ITestRunRequest testRunRequest)
/// <param name="rawMessage">RawMessage from the testhost</param>
private void OnRawMessageReceived(object sender, string rawMessage)
{
// Directly send the data to translation layer instead of deserializing it here
// Directly send the data to translation layer instead of de-serializing it here
this.designModeClient.SendRawMessage(rawMessage);
}

public void LogWarning(string message)
{
this.designModeClient.SendTestMessage(TestMessageLevel.Warning, message);
Expand Down
Loading

0 comments on commit 5752756

Please sign in to comment.