Microsoft.VisualStudio.TestWindow.Interfaces An for Windows Store app tests. -------------------------------------------------------------------------------------------------------------------- TODO: -------------------------------------------------------------------------------------------------------------------- This interface is pretty much unused at the moment. However, we can choose to make this interface public if we ever run across a case where an external consumer of needs to know path to the recipe file for a UWP test project. We think this scenario is very rare at the moment. The for a UWP container matches the project output path (something.exe) for the corresponding project. Because most of our interactions (with Roslyn, code lens, project system, IVsSolution etc.) involve looking up containers and tests based on project output path, our internal data structures (TestContainerProvider, TestContainerRecord, TestCaseRecord etc.) operate primarily on project output path. However, test platform only knows about the recipe file (something.appxrecipe) for UWP tests. So whenever we need to interact with the test platform, we translate from the project output path to the recipe file (and vice-versa). For example, when we request test execution we map the project output path present in TestCaseRecord.Source to the recipe file and specify this recipe file in TestCase.Source. Similarly, when test platform tells us about discovered tests, we map the recipe file specified in TestCase.Source to the project output path and store this project output path in TestCaseRecord.Source. In the rare case where an extension that consumes needs to interact with test platform (and also needs to support UWP test projects), the extension would need to do the same mapping from to . If we make public, this mapping can be performed by checking and casting the to to retrive the . -------------------------------------------------------------------------------------------------------------------- Path for the .appxrecipe file associated with the Windows Store app tests. Test container that handles its own building Builds the code for the test container. boolean indicating success or not Indicates if a build is required or not Imports a custom settings file and returns a runsettings xml. With runsettings having an extensible format to specify extension specific settings, there isn't a requirement to support multiple custom settings files. Extensions can always provide additional settings in IDE work flows through the IRunSettingsService. NOTE: This interface is primarily used to support .testsettings, .testrunconfig and .vsmdi formats for legacy scenarios Extension of the settings file which need to be imported. It should be non-null and should be valid file extension like ".mysettings". Imports the parameter settings file in the default runsettings. Settings file which need to be imported. The file extension of the settings file will be specified by property. Input RunSettings document to which settings file need to be imported. Updated RunSetting Xml document with imported settings. Used for logging error warning and informational messages. Sends a message to the enabled loggers. Level of the message. The message to be sent. Clear content in the logger. Defines a target to open. This interface is primarily used internally to open files/hyper links. Please use VS shell supported APIs to do the same for your extensions. The name of the target to open. Indicates whether opening functionality is enabled. The file path of the target to open. The file name of the target to open. The line number of the target to open. An update to the container contract that adds additional functionality for test containers. Gets the latest version of a selected container. Unlike the returned container has updated information about the project's properties such as output path or target framework. Latest version of the container or null if the container no longer exists (for instance, if the project was unloaded). Interface which allows test adapter writer to supply file extensions which are used to determine whether context menu "Run/Debug Tests" are enable/disabled in the code file. Returns a collection of file types which adapter can run/debug tests. This is optionally used in conjunction with to determine what exact test can be run. In the event where there's no ITestMethodResolver specified, all tests in the file will be run. Valid format is a dot followed by file extension. E.g. ".cs" represents a C# file. Interface to provide stack trace parser support. Returns ExecutorUri which is capable of parsing stack trace result for TestCase with the same ExecutorUri. This is the same string specified in custom attribute DefaultExecutorUri defined in the adapter. Returns the parsed StackFrames for the given raw error stack trace from adapters. raw stack trace result from adapter parsed stack frames Provides services for getting additional debug engine to be used when debugging unit tests. Return the parsed StackFrame collection of the given uri and raw stack trace uri indicates where the strack trace comes from raw stack trace result from adapter parsed StackTrace which contains stack frames Interface to represent a test container returned by ITestContainerDiscoverer.GetTestContainersWithDiscoveredTests method The that discovered the container Return test container source which allows the test adapter to discover tests within it. must either be a file or a directory on disk. Returns the debug engine(s) to be used by VisualStudio debugger Target .net framework of this test container. Use FrameworkVersion.None if this property is not applicable. Target platform of this test container. Use Architecture.Default if this property is not applicable. True if this is a test container for Windows Store app tests. False otherwise. Deploys the Windows Store app test container and returns info about the deployment, or does nothing and returns null if this is not a Windows Store app test container. [Do not use] Deployment of app containers through this mechanism is no longer supported for apps built against later UWP SDKs. Compares with Creates an snapshot in time of the container Interface implemented to discover test containers. A class that implements this interface will be available for use if it exports its type via MEF, and if its containing assembly is placed in the Extensions folder The Uri for the test adapter that handles test from containers from this discoverer Gets test containers which will be used as the source to discover individual tests Collection of ITestContainer which holds the test container and debug engine ID(s) Event that is fired when test containers maybe updated. (For example on build or save) Interface to provide test method resolver. This is extensibility point where 3rd parties can provide code logic to determine what test is selected in the given file line number with character offset. Returns ExecutorUri which identifies this ITestMethodResolver. Returns the fully qualified method name for the given filePath with the specified location. file where the test exists line position in the file Current character offset in the line selected method name. Return null if it cannot determine the selected method Levels for messages from the Unit Test Explorer No message. Error message. Warning message. Informational message. Debug only message Includes diagnostic logging from the test platform as well. Class to describe stack frames for failed unit test's callstack ctor for creating a stack frame. display method name true to indicate this is a well-formed parsed stack frame ctor for describing a well-formed stack frame. display method name ctor for describing a stack frame with additional filePath and line number. display method name full path name line number Returns whether the stack frame is well formed Returns file name of the current StackFrame Returns the method display name The name of the target to open. Indicates whether opening funcationality is enabled. The file path of the target to open. The line number of the target to open. Class holds a collection of StackFrame. See also ctor which takes a collection of parsed StackFrame object. Returns a readonly collection of frames. Represents the target platform in which test run will be executed. Execute tests in target platform 'x86' Execute tests in target platform 'x64' By default set no architecture preference As of this writing the known defaults for AnyCPU projects are as follows: .NET Fx - x86 (when auto selected) .NET Core -x64 (when auto selected) Execute tests in target platform 'ARM64' Interface the exposes a set of commands Unlike , is called during the package initialization Initializes commands Get a list of variables/expressions at a specific file location that are interesting to inspect while debugging Absolute path to file Zero relative line number Get all the locations that have interesting variables/expressions to evaluate during a debugging session ImmutableDictionary Key: filename - absolute path to code document file line - Zero relative line number within the file Value: IEnumerable of variable names and expression in scope Send back values pertinent to a breakpoint when encountered Absolute path to file Zero relative line number List of variable names and their values Represents an operation performed by the TestWindow. For example test discovery or test execution. The kind of operation this is (Discovery or Execution) Total run time of the operation. Uri of result files consumable by data collectors Uri of data collector Collection of Uri result file Represents a type that broadcasts operation state changes. Event that indicates an operation's state has changed. For example test discovery or execution finishing. Property of a or an Property Id Attributes Property name Property value The result of a Name used in the user interface Run Id of where this result comes from Ordinal received position of this result from backend The outcome of the test. Returns the state of the test. The string of the stack trace if any Error message from the test failure Amount of time taken to execute The standard output The standard error Returns the attachment in raw form. Interface the exposes a set of RunCommands to the TestWindow The primary run command in this set of run commands. This command is displayed on the toolbar in the TestWindow. Collection of all the RunCommands exposed by this object. Run settings file provided by plugins Makes the parameter setting file active in UTE. Path to the settings file Default processor architecture for the test run. Interface that holds information needed for run settings configuration. Returns results folder where the tests output are staged Returns solution directory. List of tests containers in current test run State of Request. Used to disambiguate discovery or execution. Enum to specify if configuration was created during discovery or execution. None Discovery Execution Run settings provided by plugins. (For example data collector settings) Name of the setting service Add run settings node to passed in RunSetting Xml document. Input RunSettings document to which additional settings nodes will be added. RunSettings configuration information. The logger Updated RunSetting Xml document with added xml nodes. Interface that exposes data persistable via a .suo file. Gets the name of the user options key used by this container. Override this property in the descendant classes that need to save options in solution user file. Loads options from a solution user file. A with the provided by this container. Override this method in the descendant classes that need to save options in solution user file. Saves options in a solution user file. A with the provided by this container. Override this method in the descendant classes that need to save options in solution user file. Resets options stored in this container. Override this method in the descendant classes that need to save options in solution user file. Provider of command command containers for a specific test window tab. Returns a container with commands for one tab. Services specific to a given tab. The passed in service provider contains an IMenuCommandService that allows to register commands for that particular tab. A test Unique id of the test Fully qualified name Display name used in the user interface Amount of time this test took to run. ，InMemoryUnitTestWriter.cs This the int representation of a . Please use the field instead. This the int representation of a Test whether it's currently CurrentlyBeingRun/IsNotStale/Stale The following are the possible values. 0 - Indicating TestData is currently running by the runner. Note that this means that the test is considered staled as well. 1 - Test is not stale. Indicating that test result has been received from the current run. 2 - Test is stale. Indicating that test is not being run in the current run operation or we have not yet received result for this test yet. Please use or to determine staleness instead. State of the test based on Does not support deferred execution. False if is up to date Indicates whether the test is currently being run at the moment. The source code file that defines the test The project id Line number in where the test is defined The test container that contains the test The result of the execution of the test Properties on the testdata The unique id of the runner for this test [API Removal log] This API was added in the 15.* timeline primarliy for internal usage. Indicates whether the test is to be run. Properties on the testdata Service to provider access to unit tests This API structure is known to cause a performance bottleneck especially with the API. Avoid usage unless absolutely needed. Gets a query to get tests (currently filtered by playlist) Gets a query to get tests (currently filtered by playlist) for the given set of Id set of test ids collection of ITest which matches the given ids Status of test service readyness to get tests Notify when service gets started Run the specified test Test id The task that performs the run Debug the specified tests collection of test Ids The task that performs the debug For the given result, method tries tries to result into VisualStudio provisional document testId of the open result test name result to be opened in provisional tab Container for UI commands. Initializes commands Interface for UnitTestWriter to raise event notification Handler for notifying when TestCases/TestResults are written to the data store! Holds data related to Windows Store app project deployment The PackageFullName of the deployed project The location of the deployed project The location of the appx recipe file Unique name of deployed project The AppUserModelID of deployed project The PackageMoniker of deployed project The AppContainerBootstrapperLogger logger for target bootstrap EventArgs data for Operation StateChanged events. The new state of the operation. The operation that changed. Null if no operation changed. Creates a new OperationStateChangedEventArgs The operation that has changed. The new state of the operation. Creates a new OperationStateChangedEventArgs The operation that has changed. The new state of the operation. Creates a new OperationStateChangedEventArgs The new state of the operation. Empty default OperationStateChangedEventArgs with no Operation. Interface used by Live Unit Testing to control playlist. Test Store side view ID for Live Unit Testing tab. Controller for the playlist of Live Unit Testing. Defines the set of possible states for a Request Indeterminate state The request is about to be started Request is running tests Request is scheduled for cancel. User has requested that the Request be canceled. Request has completed the run The Request has been Canceled. Represents the various possible run commands. Represents the various possible commands given a selection of tests An identifier which uniquely identifies a single tab. Defines the kind of a tool window. This is a default test explorer window. This represents a playlist window. This represents a live unit testing window. Describes the possible TestOperation states The first three values need to directly correspond to the VS shell's __VSSEARCHFILTERTOKENTYPE enum. If a property can have multiple values, this flag determines if the result match if any of the values matches (flag is off) or all values match the filter. In particular this ensures the special way that the table control filters items out. It specifies which items to exclude, even though for multi value properties it should only exclude properties which have their values as a subset of the search filter. Indicates whether the test service is available to service test related operations. Event fired when the test infrastructure is fully initialized and is ready to take test requests. Fired typically when a solution/folder is opened. Event fired when the test infrastructure is no longer able to service test requests. Fired typically when a solution/folder is closed. Gets tests that satisfy the specified filter. The test filter The filtered test list Runs tests that satisfy the specified filter. The test filter True if the operation is successful Debugs all tests that satisfy the specified filter. The test filter True if the operation is successful The primary reason this exists is so that we can support internal extensions like Code lens or Live Unit Testing without exposing too much to the external surface. We should be able to pull in APIs of interest from here to the external facing surface if there is a customer ask. Gets the VSTest tests based on LUT test case record ids and runs them. Test case record Ids True if the operation was successful Gets the latest LUT discovered tests that match a filter and debugs them. Test case record Ids True if the operation was successful Although we do request to run/debug tests discovered by LUT, the store runner smartly determines if we can find a full fidelity Assembly Based Test with the same test case id and if so, runs that instead. This test is expected to be up-to-date because we perform a discovery before the run operation. If we do not find one we end up running the low fidelity LUT test by name instead. State of the last result from a test run Be careful when changing this enum. The order of these enum values is also the order they are displayed in the UI. Indicates the test has no state yet. Indicates that the test has failed Indicates that the test has skipped Indicates that the test has passed Indicates that the test cannot be found. Indicates that the test has not been run event notification object used by IUnitTestNotifyChanged. Specifies the kind of the operation that unit Specifies guids of the tests that are deleted if any. Indicate all tests has been cleared. Returns the cancellation token. Event handler when data store has process rows of TestCase/TestResult from TestPlatform. the kind of the operation that unit true of clear tests occurred in the storage. Cancellation token tests deleted in the storage Event handler when data store has process rows of TestCase/TestResult from TestPlatform. the kind of the operation that unit true of clear tests occurred in the storage. Returns whether the event is cancellable. Returns string representation of the object. Helper to validate parameters. Throws ArgumentNullException if the argument is null, otherwise passes it through. The argument to check. The parameter name of the argument. Throws ArgumentOutOfRangeException if the argument is less than zero. The argument to check. The parameter name of the argument. Throws ArgumentOutOfRangeException if the argument is less than zero. The argument to check. The parameter name of the argument. Throws ArgumentNullException if the string is null, ArgumentException if the string is empty. The argument to check. The parameter name of the argument. Throws ArgumentNullException if the argument is null, ArgumentException if the argument is not the correct type. The argument to check. The parameter name of the argument. The type of the expected argument. Secret attribute that tells the CA1062 validate arguments rule that this method validates the argument is not null. The specified argument cannot be empty. The specified argument cannot be negative. The specified argument must have the following type: {0}. The specified argument has the following property, which cannot be an empty string: {0}. The specified argument has the following property, which cannot be negative: {0}. The specified argument has the following property, which cannot be null: {0}. The specified argument has the following property: {0}. This property must have the following type: {1}. A test node represents a node under the test store hierarchy. Run details of a test node.