Microsoft.TestPlatform.CommunicationUtilities

Implements ICommunicationEndpointFactory.

Handles test session events received from vstest console process.

Use to cancel data collection test case events monitoring if test run is canceled.

Initializes a new instance of the class.

The communication manager. The message sink. The data collection manager. The data collection test case event handler. Serializer for serialization and deserialization of the messages. File Helper Request data

Gets the singleton instance of DataCollectionRequestHandler.

Creates singleton instance of DataCollectionRequestHandler.

Handles socket communication. Message sink for sending messages to execution process. The instance of .

Process requests.

Sends datacollection message.

The args.

The dispose.

Closes the connection

Update the test adapter paths provided through run settings to be used by the test plugin cache.

The before test run start payload

Utility class that facilitates the IPC communication. Acts as server.

Initializes a new instance of the class.

The communication manager. The data serializer.

Creates an endpoint and listens for client connection asynchronously

Port number

Waits for Request Handler to be connected

Time to wait for connection True, if Handler is connected

The dispose.

Closes the connection

The test case data collection request handler.

Initializes a new instance of the class.

Sink for messages Communication manager implementation. Data collection manager implementation. Serializer for serialization and deserialization of the messages.

The DataCollectionRequestHandler interface.

Setups client based on port

port number to connect

Waits for Request Handler to connect to Request Sender

Timeout for establishing connection True if connected, false if timed-out

Listens to the commands from server

Closes the connection

Defines contract to send test platform requests to test host

Initializes the communication for sending requests

Port Number of the communication channel

Waits for Request Handler to be connected

Time to wait for connection True, if Handler is connected

Close the Sender

Sends the TestHostLaunched event

Test host launched payload

Sends the BeforeTestRunStart event and waits for result

Run settings for test run. Test run sources Telemetry opted in flag. Test message event handler for handling messages. BeforeTestRunStartResult containing environment variables

Sends the AfterTestRunEnd event and waits for result

Test message event handler for handling messages. The value to specify whether the test run is canceled or not. AfterTestRunEndResult containing dataCollector attachments and metrics

Initializes a new instance of the class.

Communication manager. Serializer for serialization and deserialization of the messages.

Gets the singleton instance of DataCollectionTestCaseEventSender.

Gets singleton instance of DataCollectionRequestHandler.

A singleton instance of

The test discovery event handler.

Initializes a new instance of the class.

The Request Handler.

Handles discovered tests

List of test cases

Handle discovery complete.

Discovery Complete Events Args. The last chunk.

The handle discovery message.

Logging level. Logging message.

The test run events handler.

Initializes a new instance of the class.

test request handler

Handles a test run message.

The level. The message.

The test run events handler.

Initializes a new instance of the class.

test request handler

Handle test run stats change.

The test run changed args.

Handle test run complete.

The test run complete args. The last chunk args. The run context attachments. The executor uris.

Handles a test run message.

The level. The message.

Launches a process with a given process info under debugger Adapter get to call into this to launch any additional processes under debugger

Process start info ProcessId of the launched process

Exception thrown when communication on a channel fails.

Initializes a new instance of the class.

Initializes a new instance of the class with provided message.

Message describing the error.

Initializes a new instance of the class with provided message and inner exception.

Message describing the error. Inner exception.

Provides properties for the connected communication channel.

Initializes a new instance of the class.

Communication channel for this connection.

Gets the communication channel based on this connection.

Gets a value indicating whether channel is connected or not, true if it's connected.

Gets the exception if it's not connected.

Provides information on disconnection of a communication channel.

Gets or sets if there's an error on disconnection.

Event raised when data is received on the communication channel.

Frames and sends the provided data over communication channel.

Data to send over the channel. A implying async nature of the function.

Notification from server/client that data is available.

A implying async nature of the function.

Provides a framed data and related properties.

Gets or sets the data contained in message frame.

Event raised when an endPoint is connected.

Event raised when an endPoint is disconnected on failure. It should not be notified when we are just closing the connection after success.

Starts the endPoint and channel.

Address to connect Address of the connected endPoint

Stops the endPoint and closes the underlying communication channel.

Create communication endpoint.

Endpoint role. Return communication endpoint object.

The Communication Manager interface.

Host a server and listens on endpoint for requests

End point where server is hosted Port number of the listening endpoint

Accepts client connection asynchronously

A representing the asynchronous operation.

Waits for client to be connected to this server Whoever hosting the server should use this method to wait for a client to connect

Time to wait for the connection True, if Server got a connection from client

Waits for server to be connected Whoever creating the client and trying to connect to a server should use this method to wait for connection to be established with server

Time to wait for the connection True, if Server got a connection from client

Stops any hosted server

Creates a Client Channel and connects to server on given port number

End point for client to connect to A representing the asynchronous operation.

Stops any client connected to server

Writes message to the binary writer.

Type of Message to be sent, for instance TestSessionStart

Reads message from the binary reader

Returns message read from the binary reader

Reads message from the binary reader

Raw message string

Reads message from the binary reader using read timeout

The cancellation Token. Returns message read from the binary reader

Reads message from the binary reader using read timeout

The cancellation Token. Raw message string

Writes message to the binary writer with payload

Type of Message to be sent, for instance TestSessionStart payload to be sent

Writes message to the binary writer with payload

Type of Message to be sent, for instance TestSessionStart payload to be sent version to be sent

Send serialized raw message

serialized message

Deserializes the Message into actual TestPlatform objects

The type of object to deserialize to. Message object TestPlatform object

Interface for interacting with execution process for getting test case events in data collection process.

Initializes the communication for sending requests

Port Number of the communication channel

Waits for Request Handler to be connected.

Time to wait for connection True, if Handler is connected

Close the handler

Listens to the commands from execution process

Interface for sending test case events from test execution process to data collection process

Setups client based on port

port number to connect

Waits for Request Handler to connect to Request Sender

Timeout for establishing connection True if connected, false if timed-out

Closes the connection

Sends the TestCaseStart event.

The args containing info about TestCaseStart event.

Sends the TestCaseCompleted event along with outcome.

The args containing info about TestResult event. The Collection of TestCase attachments.

Sends the SessionEnd event. This is used to as a trigger to close communication channel between datacollector process and testhost process.

The args containing info about SessionEnd event.

IDataSerializer interface for serializing data

Deserializes the raw message into Message

Raw message off the IPC channel Message object

Deserializes the Message into actual TestPlatform objects

The type of object to deserialize to. Message object TestPlatform object

Serializes and creates a raw message given a message type

Message Type Raw Serialized message

Serializes and creates a raw message given a message type and the object payload

Message Type Payload of the message Raw Serialized message

Serializes and creates a raw message given a message type and the object payload

Message Type Payload of the message version to be sent Raw Serialized message

Creates cloned object for given object.

The type of object to be cloned. Object to be cloned. Newly cloned object.

Defines the contract for handling test platform requests

Gets or sets connection info for to start server/client.

Setups client based on port

Waits for Request Handler to connect to Request Sender

Timeout for establishing connection True if connected, false if timed-out

Listens to the commands from server

the test host manager.

Closes the connection

The send test cases.

The discovered test cases.

The send test run statistics.

The test run changed args.

Sends the logs back to the server.

The message level. The message.

The send execution complete.

The test run complete args. The last chunk args. The run context attachments. The executor uris.

The discovery complete handler

Discovery Complete Event Args The last Chunk.

Launches a process with a given process info under debugger Adapter get to call into this to launch any additional processes under debugger

Process start info ProcessId of the launched process

Attach debugger to an already running process.

Process ID and tfm of the process to which the debugger should be attached. if the debugger was successfully attached to the requested process, otherwise.

Defines contract to send test platform requests to test host

Initializes the communication for sending requests

Port Number of the communication channel

Used for protocol version check with TestHost

Waits for Request Handler to be connected

Time to wait for connection Cancellation token True, if Handler is connected

Close the Sender

Initializes the Discovery

Paths to check for additional extensions

Initializes the Execution

Paths to check for additional extensions

Discovers the tests

DiscoveryCriteria for discovery EventHandler for discovery events

Starts the TestRun with given sources and criteria

RunCriteria for test run EventHandler for test run events

Starts the TestRun with given test cases and criteria

RunCriteria for test run EventHandler for test run events

Ends the Session

Send the request to cancel the test run

Send the request to abort the test run

Sends the request to abort the discovery.

Handle client process exit

Standard error output

The transport Layer Interface

Initializes Transport Layer

Endpoint

Waits for the connection over transport layer to established

Time to wait for connection True if connection is established

JsonDataSerializes serializes and deserializes data using Json format

Prevents a default instance of the class from being created.

Gets the JSON Serializer instance.

Deserialize a from raw JSON text.

JSON string. A instance.

Deserialize the for a message.

A object. Payload type. The deserialized payload.

Try getting substring until a given delimiter, but don't search more characters than maxSearchLength.

Deserialize raw JSON to an object using the default serializer.

JSON string. Version of serializer to be used. Target type to deserialize. An instance of .

Serialize an empty message.

Type of the message. Serialized message.

Serialize a message with payload.

Type of the message. Payload for the message. Serialized message.

Serialize a message with payload.

Type of the message. Payload for the message. Version for the message. Serialized message.

Serialize an object to JSON using default serialization settings.

Type of object to serialize. Instance of the object to serialize. Version to be stamped. JSON string.

Serialize data.

Type of data. Serializer. Data to be serialized. Serialized data.

Deserialize data.

Type of data. Serializer. Data to be deserialized. Deserialized data.

Deserialize JToken object to T object.

Type of data. Serializer. JToken to be deserialized. Deserialized data.

Just the header from versioned messages, to avoid touching the Payload when we deserialize message.

Container for the rawMessage string, to avoid changing how messages are passed. This allows us to pass MessageWithRawMessage the same way that Message is passed for protocol version 1. And VersionedMessage is passed for later protocol versions, but without touching the payload string when we just need to know the header. !! This message does not populate the Payload property even though it is still present because that comes from Message.

This grabs payload from the message, we already know version and message type.

For serialization directly into string, without first converting to JToken, and then from JToken to string.

Gets or sets the version of the message

Gets or sets the message type.

Gets or sets the payload.

A communication channel using a length prefix packet frame for communication.

Sync object for sending messages Write for binarywriter is NOT thread-safe

The before test run start payload

Gets or sets run settings xml.

Gets or sets list of test sources.

Gets or sets a value indicating whether telemetry is enabled.

The discovery complete payload.

Gets or sets the total number of tests discovered.

Gets or sets the last chunk of discovered tests.

Gets or sets a value indicating whether discovery was aborted.

Gets or sets the Metrics

Gets or sets list of sources which were fully discovered.

Gets or sets list of sources which were partially discovered (started discover tests, but then discovery aborted).

Gets or sets list of sources which were not discovered at all.

Gets or sets list of sources which skipped in discovery on purpose, e.g. because they are known dlls that have no tests, or there is no runtime provider to run them.

Gets or sets the collection of discovered extensions.

The message type.

The session start.

The session end.

The is aborted.

The session connected.

Test Message

Protocol Version

Protocol Error

The session start.

The discovery started.

The test cases found.

The discovery complete.

Cancel Test Discovery

The session start.

Cancel the current test run

Start test execution.

The test run stats change.

The execution complete.

The message to get runner process startInfo for run all tests in given sources

The message to get runner process startInfo for run selected tests

CustomTestHostLaunch

Custom Test Host launch callback

Test run attachments processing

Test run attachments processing callback

Test run attachments processing progress

Cancel test run attachments processing

Extensions Initialization

Start Test Run All Sources

Start Test Run - Testcases

Launch Adapter Process With DebuggerAttached

Attach debugger to process.

Attach debugger to process callback.

Attach debugger to process.

Attach debugger to process callback.

Data Collection Message

StartTestSession message.

StartTestSession callback message.

StopTestSession message.

StopTestSession callback message.

Event message type sent to datacollector process right after test host process has started.

Event message type send to datacollector process before test run starts.

Event message type used by datacollector to send results after receiving test run start event.

Event message type send to datacollector process after test run ends.

Event message type used by datacollector to send result on receiving test run end event.

Event message type send to datacollector process before test case execution starts.

Event message type used to signal datacollector process that test case execution has ended.

Event message type used by datacollector to send result on receiving TestEnd.

Ack Event message type send to datacollector process before test case execution starts.

Attach debugger to process.

Telemetry event.

Gets or sets the test run process id of test host.

The test message payload.

Gets or sets the message level.

Gets or sets the message.

Test run attachments processing complete payload.

Gets or sets the test run attachments processing complete args.

Gets or sets the attachments.

Test run attachments processing complete payload.

Gets or sets the test run attachments processing complete args.

The test run complete payload.

Gets or sets the test run complete args.

Gets or sets the last run tests.

Gets or sets the run attachments.

Gets or sets the executor uris that were used to run the tests.

The test run stats payload.

Gets or sets the test run changed event args.

Gets or sets the in progress test cases.

The test run criteria with sources.

Initializes a new instance of the class.

The adapter source map. The package which actually contain sources. A testhost can at max execute for one package at time Package can be null if test source, and package are same The run settings. The test Execution Context.

Gets the adapter source map.

Gets the run settings.

Gets or sets the test execution context.

Gets the test Containers (e.g. .appx, .appxrecipie)

The test run criteria with tests.

Initializes a new instance of the class. Ensure that names of constructor parameters match the public property names of the same for JSON serialization

The tests. The package which actually contain sources. A testhost can at max execute for one package at time Package can be null if test source, and package are same The test run settings. The test Execution Context.

Gets the tests.

Gets the test run settings.

Gets or sets the test execution context.

Gets the test Containers (e.g. .appx, .appxrecipie)

Construct used for communication

Gets or sets the message type.

Gets or sets the payload.

To string implementation.

The .

Construct with version used for communication Introduced in 15.1.0 version and default message protocol v2 onwards.

Gets or sets the version of the message

The original protocol with no versioning. It sends and receives a Message that carries just data and has no Version field. It is used during negotiation to ensure that we communicate at the lowest available version the other side can be.

Adds versioning to the protocol by introducing VersionedMessage.

Changed serialization because the serialization of properties in bag was too verbose, so common properties are considered built-in and serialized without type info.

Added attach debugger messages to allow attaching to external process. /!\ This protocol version should not be used. It incorrectly serializes using the old version 1 serializer that is very slow. Added messages:

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to The active test discovery was aborted..

Looks up a localized string similar to The active test discovery was aborted. Reason: {0}.

Looks up a localized string similar to The active test run was aborted. Reason: {0}.

Looks up a localized string similar to Cannot attach the debugger to the default test host..

Looks up a localized string similar to An existing connection was forcibly closed by the remote host..

Looks up a localized string similar to {0} process failed to connect to {1} process after {2} seconds. This may occur due to machine slowness, please set environment variable {3} to increase timeout..

Looks up a localized string similar to Test host process crashed.

Looks up a localized string similar to Unable to communicate with test host process..

Looks up a localized string similar to Unexpected message received. Expected MessageType : {0} Actual MessageType: {1}.

Looks up a localized string similar to Protocol version check failed. Make sure test runner and host are compatible..

Looks up a localized string similar to Failed to negotiate protocol, waiting for response timed out after {0} seconds. This may occur due to machine slowness, please set environment variable {1} to increase timeout..

JSON contract resolver for mapping test platform types.

TODO: This is not used now, but I was experimenting with this quite a bit for performance, leaving it here in case I was wrong and the serializer settings actually have signigicant impact on the speed.

JSON contract resolver for mapping test platform types.

Converter used by v1 protocol serializer to serialize TestCase object to and from v1 json

JSON converter for the and derived entities.

JSON contract resolver for mapping test platform types for v1 serialization.

Converter used by v1 protocol serializer to serialize TestResult object to and from v1 json

JSON converter for converting ITestRunStatistics to TestRunStatistics

Communication client implementation over sockets.

Facilitates communication using sockets

The server stream read timeout constant (in microseconds).

TCP Listener to host TCP channel and listen

TCP Client that can connect to a TCP listener

Binary Writer to write to channel stream

Binary reader to read from channel stream

Serializer for the data objects

Event used to maintain client connection state

Sync object for sending messages SendMessage over socket channel is NOT thread-safe

Sync object for receiving messages

Initializes a new instance of the class.

Host TCP Socket Server and start listening

End point where server is hosted Port of the listener

Accepts client async

A representing the asynchronous operation.

Waits for Client Connection

Time to Wait for the connection True if Client is connected, false otherwise

Stop Listener

Connects to server async

EndPointAddress for client to connect A representing the asynchronous operation.

Waits for server to be connected Whoever creating the client and trying to connect to a server should use this method to wait for connection to be established with server

Time to wait for the connection True, if Server got a connection from client

Stop Listener

Writes message to the binary writer.

Type of Message to be sent, for instance TestSessionStart

Writes message to the binary writer with payload

Type of Message to be sent, for instance TestSessionStart payload to be sent

Writes message to the binary writer with payload

Type of Message to be sent, for instance TestSessionStart payload to be sent version to be sent

Send serialized raw message

serialized message

Reads message from the binary reader

Returns message read from the binary reader

Reads message from the binary reader using read timeout

The cancellation Token. Returns message read from the binary reader

Reads message from the binary reader

Raw message string

Reads message from the binary reader using read timeout

The cancellation Token. Raw message string

Deserializes the Message into actual TestPlatform objects

The type of object to deserialize to. Message object TestPlatform object

Writes the data on socket and flushes the buffer

message to write

Communication server implementation over sockets.

Initializes a new instance of the class.

Initializes a new instance of the class with given channel factory implementation.

Factory to create communication channel.

Stop the connection when error was encountered. Dispose all communication, and notify subscribers of Disconnected event that we aborted.

Specifies whether the resolver is disposed or not

Converts a given string endpoint address to valid Ipv4, Ipv6 IPEndpoint

Input endpoint address IPEndpoint from give string

Converts a given string endpoint address to valid Ipv4, Ipv6 IPEndpoint

Input endpoint address IPEndpoint from give string, if its not a valid string. It will create endpoint with loop back address with port 0

Test request sender implementation.

Initializes a new instance of the class.

Protocol configuration. The runtime provider.

Initializes a new instance of the class. Used only for testing to inject communication endpoint.

Communication server implementation. ConnectionInfo to set up transport layer Serializer implementation. Protocol configuration. Time to wait for client process exit.