Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use SendMessage method of Microsoft.TestPlatform.Protocol.SocketCommunicationManager class

Best Vstest code snippet using Microsoft.TestPlatform.Protocol.SocketCommunicationManager.SendMessage

CommunicationChannel.cs

Source:CommunicationChannel.cs

...48        private ManualResetEvent clientConnectedEvent = new ManualResetEvent(false);4950        /// <summary>51        /// Sync object for sending messages52        /// SendMessage over socket channel is NOT thread-safe53        /// </summary>54        private object sendSyncObject = new object();5556        private Socket socket;5758        /// <summary>59        /// Initializes a new instance of the <see cref="SocketCommunicationManager"/> class.60        /// </summary>61        public CommunicationChannel()62            : this(JsonDataSerializer.Instance)63        {64        }6566        internal CommunicationChannel(JsonDataSerializer dataSerializer)67        {68            this.dataSerializer = dataSerializer;69        }7071        #region ServerMethods7273        /// <summary>74        /// Host TCP Socket Server and start listening75        /// </summary>76        /// <param name="endpoint">End point where server is hosted</param>77        /// <returns>Port of the listener</returns>78        public IPEndPoint HostServer(IPEndPoint endpoint)79        {80            this.tcpListener = new TcpListener(endpoint);81            this.tcpListener.Start();82            EqtTrace.Info("Listening on Endpoint : {0}", (IPEndPoint)this.tcpListener.LocalEndpoint);8384            return (IPEndPoint)this.tcpListener.LocalEndpoint;85        }8687        /// <summary>88        /// Accepts client async89        /// </summary>90        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>91        public async Task AcceptClientAsync()92        {93            if (this.tcpListener != null)94            {95                this.clientConnectedEvent.Reset();9697                var client = await this.tcpListener.AcceptTcpClientAsync();98                this.socket = client.Client;99                this.socket.NoDelay = true;100101                // Using Buffered stream only in case of write, and Network stream in case of read.102                var bufferedStream = new PlatformStream().CreateBufferedStream(client.GetStream(), JSTest.Constants.StreamBufferSize);103                var networkStream = client.GetStream();104                this.binaryReader = new BinaryReader(networkStream);105                this.binaryWriter = new BinaryWriter(bufferedStream);106107                this.clientConnectedEvent.Set();108                if (EqtTrace.IsInfoEnabled)109                {110                    EqtTrace.Info("Using the buffer size of {0} bytes", JSTest.Constants.StreamBufferSize);111                    EqtTrace.Info("Accepted Client request and set the flag");112                }113            }114        }115116        /// <summary>117        /// Waits for Client Connection118        /// </summary>119        /// <param name="clientConnectionTimeout">Time to Wait for the connection</param>120        /// <returns>True if Client is connected, false otherwise</returns>121        public bool WaitForClientConnection(int clientConnectionTimeout)122        {123            return this.clientConnectedEvent.WaitOne(clientConnectionTimeout);124        }125126        /// <summary>127        /// Stop Listener128        /// </summary>129        public void StopServer()130        {131            this.tcpListener?.Stop();132            this.tcpListener = null;133            this.binaryReader?.Dispose();134            this.binaryWriter?.Dispose();135        }136137        #endregion138        139        /// <summary>140        /// Writes message to the binary writer.141        /// </summary>142        /// <param name="messageType">Type of Message to be sent, for instance TestSessionStart</param>143        public void SendMessage(string messageType )144        {145            var serializedObject = this.dataSerializer.SerializePayload(messageType, null, JSTest.Constants.MessageProtocolVersion);146            this.WriteAndFlushToChannel(serializedObject);147148            var ph = new ProcessHelper();149            EqtTrace.Info("PROTOCOL    {0} Send: {1}", ph.GetProcessName(ph.GetCurrentProcessId()), serializedObject);150        }151152        /// <summary>153        ///  Writes message to the binary writer with payload154        /// </summary>155        /// <param name="messageType">Type of Message to be sent, for instance TestSessionStart</param>156        /// <param name="payload">payload to be sent</param>157        public void SendMessage(string messageType, object payload)158        {159            var rawMessage = this.dataSerializer.SerializePayload(messageType, payload, JSTest.Constants.MessageProtocolVersion);160            this.WriteAndFlushToChannel(rawMessage);161162            var ph = new ProcessHelper();163            EqtTrace.Info("PROTOCOL    {0} Send: {1}", ph.GetProcessName(ph.GetCurrentProcessId()), rawMessage);164        }165166167        /// <summary>168        /// Reads message from the binary reader169        /// </summary>170        /// <returns>Returns message read from the binary reader</returns>171        public Message ReceiveMessage()
...

SocketCommunicationManager.cs

Source:SocketCommunicationManager.cs

...34        /// </summary>35        private ManualResetEvent clientConnectedEvent = new ManualResetEvent(false);36        /// <summary>37        /// Sync object for sending messages38        /// SendMessage over socket channel is NOT thread-safe39        /// </summary>40        private object sendSyncObject = new object();41        /// <summary>42        /// Stream to use read timeout43        /// </summary>44        private NetworkStream stream;45        private Socket socket;46        /// <summary>47        /// The server stream read timeout constant (in microseconds).48        /// </summary>49        private const int StreamReadTimeout = 1000 * 1000;50        /// <summary>51        /// Initializes a new instance of the <see cref="SocketCommunicationManager"/> class.52        /// </summary>53        public SocketCommunicationManager() : this(JsonDataSerializer.Instance)54        {55        }56        internal SocketCommunicationManager(JsonDataSerializer dataSerializer)57        {58            this.dataSerializer = dataSerializer;59        }60        #region ServerMethods61        /// <summary>62        /// Host TCP Socket Server and start listening63        /// </summary>64        /// <returns></returns>65        public int HostServer()66        {67            var endpoint = new IPEndPoint(IPAddress.Loopback, 0);68            this.tcpListener = new TcpListener(endpoint);69            this.tcpListener.Start();70            var portNumber = ((IPEndPoint)this.tcpListener.LocalEndpoint).Port;71            Console.WriteLine("Server started. Listening at port : {0}", portNumber);72            return portNumber;73        }74        /// <summary>75        /// Accepts client async76        /// </summary>77        public async Task AcceptClientAsync()78        {79            if (this.tcpListener != null)80            {81                this.clientConnectedEvent.Reset();82                var client = await this.tcpListener.AcceptTcpClientAsync();83                this.socket = client.Client;84                this.stream = client.GetStream();85                this.binaryReader = new BinaryReader(this.stream);86                this.binaryWriter = new BinaryWriter(this.stream);87                this.clientConnectedEvent.Set();88                Console.WriteLine("Accepted Client request and set the flag");89            }90        }91        /// <summary>92        /// Waits for Client Connection93        /// </summary>94        /// <param name="clientConnectionTimeout">Time to Wait for the connection</param>95        /// <returns>True if Client is connected, false otherwise</returns>96        public bool WaitForClientConnection(int clientConnectionTimeout)97        {98            return this.clientConnectedEvent.WaitOne(clientConnectionTimeout);99        }100        /// <summary>101        /// Stop Listener102        /// </summary>103        public void StopServer()104        {105            this.tcpListener?.Stop();106            this.tcpListener = null;107            this.binaryReader?.Dispose();108            this.binaryWriter?.Dispose();109        }110        #endregion111        /// <summary>112        /// Writes message to the binary writer.113        /// </summary>114        /// <param name="messageType">Type of Message to be sent, for instance TestSessionStart</param>115        public void SendMessage(string messageType)116        {117            var serializedObject = this.dataSerializer.SerializeMessage(messageType);118            this.WriteAndFlushToChannel(serializedObject);119        }120        /// <summary>121        /// Reads message from the binary reader122        /// </summary>123        /// <returns>Returns message read from the binary reader</returns>124        public Message ReceiveMessage()125        {126            var rawMessage = this.ReceiveRawMessage();127            return this.dataSerializer.DeserializeMessage(rawMessage);128        }129        /// <summary>130        ///  Writes message to the binary writer with payload131        /// </summary>132        /// <param name="messageType">Type of Message to be sent, for instance TestSessionStart</param>133        /// <param name="payload">payload to be sent</param>134        public void SendMessage(string messageType, object payload)135        {136            var rawMessage = this.dataSerializer.SerializePayload(messageType, payload);137            this.WriteAndFlushToChannel(rawMessage);138        }139        /// <summary>140        /// The send hand shake message.141        /// </summary>142        public void SendHandShakeMessage()143        {144            this.SendMessage(MessageType.SessionStart);145        }146        /// <summary>147        /// Reads message from the binary reader148        /// </summary>149        /// <returns> Raw message string </returns>150        public string ReceiveRawMessage()151        {152            var rawMessage =  this.binaryReader.ReadString();153            Console.WriteLine("\n=========== Receiving Message ===========");154            Console.WriteLine(rawMessage);155            return rawMessage;156        }157        /// <summary>158        /// Deserializes the Message into actual TestPlatform objects...

SendMessage

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.TestPlatform.CommunicationUtilities;7using Microsoft.TestPlatform.CommunicationUtilities.Interfaces;8using Microsoft.TestPlatform.CommunicationUtilities.ObjectModel;9{10    {11        static void Main(string[] args)12        {13            SocketCommunicationManager communicationManager = new SocketCommunicationManager();14            communicationManager.StartServer();15            communicationManager.WaitForClientConnection(5000);16            communicationManager.SendMessage(MessageType.TestMessage, "Hello");17            communicationManager.StopServer();18        }19    }20}21using System;22using System.Collections.Generic;23using System.Linq;24using System.Text;25using System.Threading.Tasks;26using Microsoft.TestPlatform.CommunicationUtilities;27using Microsoft.TestPlatform.CommunicationUtilities.Interfaces;28using Microsoft.TestPlatform.CommunicationUtilities.ObjectModel;29{30    {31        static void Main(string[] args)32        {33            SocketCommunicationManager communicationManager = new SocketCommunicationManager();34            communicationManager.StartClient();35            var message = communicationManager.ReceiveMessage();36            Console.WriteLine(message);37            communicationManager.StopClient();38        }39    }40}41using System;42using System.Collections.Generic;43using System.Linq;44using System.Text;45using System.Threading.Tasks;46using Microsoft.TestPlatform.CommunicationUtilities;47using Microsoft.TestPlatform.CommunicationUtilities.Interfaces;48using Microsoft.TestPlatform.CommunicationUtilities.ObjectModel;49{50    {51        static void Main(string[] args)52        {53            SocketCommunicationManager communicationManager = new SocketCommunicationManager();54            communicationManager.StartServer();55            communicationManager.WaitForClientConnection(5000);56            communicationManager.SendPayload("Hello");57            communicationManager.StopServer();58        }59    }60}61using System;62using System.Collections.Generic;63using System.Linq;64using System.Text;65using System.Threading.Tasks;66using Microsoft.TestPlatform.CommunicationUtilities;67using Microsoft.TestPlatform.CommunicationUtilities.Interfaces;68using Microsoft.TestPlatform.CommunicationUtilities.ObjectModel;69{70    {71        static void Main(string[] args)72        {73            SocketCommunicationManager communicationManager = new SocketCommunicationManager();

SendMessage

Using AI Code Generation

1using Microsoft.TestPlatform.CommunicationUtilities;2using Microsoft.TestPlatform.CommunicationUtilities.Interfaces;3using Microsoft.TestPlatform.CommunicationUtilities.ObjectModel;4using Microsoft.VisualStudio.TestPlatform.ObjectModel;5using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;6using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;7using Microsoft.VisualStudio.TestPlatform.ObjectModel.Logging;8using System;9using System.Collections.Generic;10using System.Linq;11using System.Text;12using System.Threading.Tasks;13using System.Xml;14using System.Xml.Linq;15{16    {17        static void Main(string[] args)18        {19            SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();20            socketCommunicationManager.InitializeCommunication();21            socketCommunicationManager.SendMessage(MessageType.VersionCheck, 1);22            socketCommunicationManager.SendMessage(MessageType.TestRunRequest, GetTestRunPayload());23            socketCommunicationManager.SendMessage(MessageType.TestRunStatsChange, GetTestRunStatsChangePayload());24            socketCommunicationManager.SendMessage(MessageType.TestRunComplete, GetTestRunCompletePayload());25            socketCommunicationManager.SendMessage(MessageType.TestMessage, GetTestMessagePayload());26            socketCommunicationManager.SendMessage(MessageType.ExecutionComplete, GetExecutionCompletePayload());27            socketCommunicationManager.SendMessage(MessageType.SessionConnected, GetSessionConnectedPayload());28            socketCommunicationManager.SendMessage(MessageType.SessionEnded, GetSessionEndedPayload());29            socketCommunicationManager.SendMessage(MessageType.DiscoveryComplete, GetDiscoveryCompletePayload());30            socketCommunicationManager.SendMessage(MessageType.DiscoveryMessage, GetDiscoveryMessagePayload());31            socketCommunicationManager.SendMessage(MessageType.DiscoveryRequest, GetDiscoveryRequestPayload());

SendMessage

Using AI Code Generation

1using Microsoft.TestPlatform.CommunicationUtilities;2using Microsoft.TestPlatform.CommunicationUtilities.Interfaces;3using Microsoft.TestPlatform.CommunicationUtilities.ObjectModel;4using System;5using System.Collections.Generic;6using System.Diagnostics;7using System.IO;8using System.Linq;9using System.Net.Sockets;10using System.Text;11using System.Threading;12using System.Threading.Tasks;13{14    {15        static void Main(string[] args)16        {17            var socketCommunicationManager = new SocketCommunicationManager();18            socketCommunicationManager.ClientConnected += SocketCommunicationManager_ClientConnected;19            socketCommunicationManager.ClientDisconnected += SocketCommunicationManager_ClientDisconnected;20            socketCommunicationManager.MessageReceived += SocketCommunicationManager_MessageReceived;21            socketCommunicationManager.StartClient(new System.Net.IPEndPoint(System.Net.IPAddress.Loopback, 12345));22            var message = new Message() { MessageType = MessageType.TestRunStatsChange };

SendMessage

Using AI Code Generation

1using System;2using Microsoft.TestPlatform.Protocol;3{4    {5        static void Main(string[] args)6        {7            SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();8            socketCommunicationManager.SendMessage("1");9            Console.ReadLine();10        }11    }12}13using System;14using Microsoft.TestPlatform.Protocol;15{16    {17        static void Main(string[] args)18        {19            SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();20            string message = socketCommunicationManager.ReceiveMessage();21            Console.WriteLine("Received message: " + message);22            Console.ReadLine();23        }24    }25}26using System;27using Microsoft.TestPlatform.Protocol;28{29    {30        static void Main(string[] args)31        {32            SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();33            string message = socketCommunicationManager.ReceiveMessage();34            Console.WriteLine("Received message: " + message);35            Console.ReadLine();36        }37    }38}39using System;40using Microsoft.TestPlatform.Protocol;41{42    {43        static void Main(string[] args)44        {45            SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();46            string message = socketCommunicationManager.ReceiveMessage();47            Console.WriteLine("Received message: " + message);48            Console.ReadLine();49        }50    }51}52using System;53using Microsoft.TestPlatform.Protocol;54{55    {56        static void Main(string[] args)57        {58            SocketCommunicationManager socketCommunicationManager = new SocketCommunicationManager();59            string message = socketCommunicationManager.ReceiveMessage();60            Console.WriteLine("Received message: " + message);61            Console.ReadLine();62        }63    }64}65using System;66using Microsoft.TestPlatform.Protocol;67{68    {69        static void Main(string[]

SendMessage

Using AI Code Generation

1using System;2using System.Collections.Generic;3using System.Linq;4using System.Text;5using System.Threading.Tasks;6using Microsoft.TestPlatform.Protocol;7using System.Net.Sockets;8using System.Net;9using System.Diagnostics;10{11    {12        static void Main(string[] args)13        {14            SocketCommunicationManager manager = new SocketCommunicationManager();15            manager.SendMessage("Hello World");16        }17    }18}19using System;20using System.Collections.Generic;21using System.Linq;22using System.Text;23using System.Threading.Tasks;24using Microsoft.TestPlatform.Protocol;25using System.Net.Sockets;26using System.Net;27using System.Diagnostics;28{29    {30        static void Main(string[] args)31        {32            SocketCommunicationManager manager = new SocketCommunicationManager();33            string message = manager.ReceiveMessage();34            Console.WriteLine(message);35        }36    }37}38using System;39using System.Collections.Generic;40using System.Linq;41using System.Text;42using System.Threading.Tasks;43using Microsoft.TestPlatform.Protocol;44using System.Net.Sockets;45using System.Net;46using System.Diagnostics;47{48    {49        static void Main(string[] args)50        {51            SocketCommunicationManager manager = new SocketCommunicationManager();52            manager.SendData("Hello World");53        }54    }55}56using System;57using System.Collections.Generic;58using System.Linq;59using System.Text;60using System.Threading.Tasks;61using Microsoft.TestPlatform.Protocol;62using System.Net.Sockets;63using System.Net;64using System.Diagnostics;65{66    {67        static void Main(string[] args)68        {69            SocketCommunicationManager manager = new SocketCommunicationManager();70            string message = manager.ReceiveData();71            Console.WriteLine(message);72        }73    }74}75using System;76using System.Collections.Generic;77using System.Linq;78using System.Text;79using System.Threading.Tasks;80using Microsoft.TestPlatform.Protocol;81using System.Net.Sockets;82using System.Net;83using System.Diagnostics;84{85    {

SendMessage

Using AI Code Generation

1using Microsoft.TestPlatform.CommunicationUtilities;2using Microsoft.TestPlatform.CommunicationUtilities.Interfaces;3using Microsoft.TestPlatform.CommunicationUtilities.ObjectModel;4using Microsoft.VisualStudio.TestPlatform.ObjectModel;5using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;6using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;7using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine.ClientProtocol;8using Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine.TesthostProtocol;9using System;10using System.Collections.Generic;11using System.Linq;12using System.Text;13using System.Threading.Tasks;14{15    {16        private ITestHostLauncher testHostLauncher;17        private ICommunicationManager communicationManager;18        private int portNumber;19        private bool isCommunicationEstablished;20        private ITestHostLauncher customTestHostLauncher;21        public TestHostManager()22        {23            this.testHostLauncher = new DefaultTestHostLauncher();24            this.communicationManager = new SocketCommunicationManager();25            this.isCommunicationEstablished = false;26        }27        public TestHostManager(ITestHostLauncher customTestHostLauncher)28        {29            this.customTestHostLauncher = customTestHostLauncher;30            this.communicationManager = new SocketCommunicationManager();31            this.isCommunicationEstablished = false;32        }33        public void Close()34        {35            this.communicationManager?.StopServer();36        }37        public void Initialize(TestProcessStartInfo testHostStartInfo)38        {39            this.portNumber = this.communicationManager.HostServer();40            testHostStartInfo.EnvironmentVariables["VSTEST_CONNECTION_PORT"] = this.portNumber.ToString();41            testHostStartInfo.EnvironmentVariables["VSTEST_HOST_DEBUG"] = "1";42            this.testHostLauncher = this.customTestHostLauncher ?? new DefaultTestHostLauncher();43            this.testHostLauncher.LaunchTestHost(testHostStartInfo);44            this.communicationManager.WaitForClientConnection(10000);45            this.isCommunicationEstablished = true;46        }47        public void LaunchTestHost(TestProcessStartInfo testHostStartInfo)48        {49            throw new NotImplementedException();50        }51        public void StartSession()52        {53            if (!this.isCommunicationEstablished)54            {55                throw new InvalidOperationException("Test host communication is not established.");56            }57            this.communicationManager.SendMessage(MessageType.VersionCheck, 1);58            var versionCheckResponse = this.communicationManager.ReceiveMessage();59            if (versionCheckResponse.MessageType != MessageType.VersionCheck)60            {61                throw new TestPlatformException("Test host version check failed.");

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.