ITestRun Interface

Article
09/08/2015

Represents an execution of a set of tests against a specific build.

Namespace: Microsoft.TeamFoundation.TestManagement.Client
Assembly: Microsoft.TeamFoundation.TestManagement.Client (in Microsoft.TeamFoundation.TestManagement.Client.dll)

Syntax

public interface ITestRun : ITestMessageLogOwner, ITestRunBase, 
    IIdentifiable<int>, IAttachmentOwner, INotifyPropertyChanged

public interface class ITestRun : ITestMessageLogOwner, ITestRunBase, 
    IIdentifiable<int>, IAttachmentOwner, INotifyPropertyChanged

type ITestRun = 
    interface
        interface ITestMessageLogOwner
        interface ITestRunBase
        interface IIdentifiable<int>
        interface IAttachmentOwner
        interface INotifyPropertyChanged
    end

Public Interface ITestRun
    Inherits ITestMessageLogOwner, ITestRunBase, IIdentifiable(Of Integer),
    IAttachmentOwner, INotifyPropertyChanged

Properties

	Name	Description
	Attachments	Gets the collection of attachments.(Inherited from IAttachmentOwner.)
	BuildConfigurationId	Gets the build configuration ID for this test run.
	BuildDirectory	Gets or sets the path of the output of the build.
	BuildFlavor	Gets or sets the flavor of the build (that is, "Release" or "Debug").
	BuildNumber	Name of the build.(Inherited from ITestRunBase.)
	BuildPlatform	Gets or sets the platform of the build.
	BuildUri	Name (as a URI) of the build the run was executed against. As an example: new Uri("vstfs:///Build/Build/1")(Inherited from ITestRunBase.)
	Comment	Comments entered by those analyzing the run.(Inherited from ITestRunBase.)
	Controller	The name of the controller of this run(Inherited from ITestRunBase.)
	DateCompleted	Date the last test completed.(Inherited from ITestRunBase.)
	DateCreated	Date the run was created.(Inherited from ITestRunBase.)
	DateDue	Gets the date that this test run is due.
	DateStarted	Date the run was started.(Inherited from ITestRunBase.)
	ErrorMessage	Gets or sets a short description of a failure, if any.
	Id	Gets the identifier.(Inherited from IIdentifiable<TKey>.)
	IncompleteTests	The number of tests that are not completed.
	IsAutomated	Gets or sets a value that indicates whether the test run contains tests that should be automatically executed.
	IsBvt	Gets or sets a value that indicates whether this test run is a build verification test.
	IsDirty	Returns true if the test run has been changed since the last Save().(Inherited from ITestRunBase.)
	Iteration	Gets or sets the number of times that this test run has been executed.
	LastUpdated	Date the run was last modified (title or owner set).(Inherited from ITestRunBase.)
	LastUpdatedBy	Last person to update run(Inherited from ITestRunBase.)
	LastUpdatedByName	Last person to update run(Inherited from ITestRunBase.)
	LinkedWorkItemCount	The total number of bugs associated with the test results.(Inherited from ITestRunBase.)
	NotApplicableTests
	Owner	User who started the run.(Inherited from ITestRunBase.)
	OwnerName	User who started the run.(Inherited from ITestRunBase.)
	OwnerTeamFoundationId	User who started the run.(Inherited from ITestRunBase.)
	PassedTests	The number of tests that passed.
	PostProcessState	Gets the state of any post-process activities that occur on the server.
	Project	Gets the team project for this run.
	Revision	Revision number of TestRun for concurrency control(Inherited from ITestRunBase.)
	State	Gets the current state of this test run.
	Statistics	Gets the statistics that detail the number of test cases in various states in this test run.
	TestEnvironmentId	The test environment for this run(Inherited from ITestRunBase.)
	TestMessageLogEntries	Gets a collection of test message log entries.(Inherited from ITestMessageLogOwner.)
	TestPlanId	Returns the ID of the test plan that contains this run or 0 if this is an ad-hoc run.(Inherited from ITestRunBase.)
	TestSettings	The test settings being used for this test run execution. Null if the run has no test settings.(Inherited from ITestRunBase.)
	TestSettingsId	ID of the public test settings being used for this test run.(Inherited from ITestRunBase.)
	Title	Title of the associated run template.(Inherited from ITestRunBase.)
	TotalTests	The total number of tests in this run.
	Type	Gets the type of this test run.
	UnanalyzedTests	The number of tests that are not analyzed.
	Version	Gets the client version that ran the test.

Methods

	Name	Description
	Abort()	Aborts this test run.
	Abort(TestRunAbortOptions)	Aborts this test run by using the given options.
	AddTest(Int32, Int32, TeamFoundationIdentity)	Adds a test case and configuration to the test run.
	AddTest(Int32, String, String, ITmiTestImplementation)	Creates a new test result in the test run against a test configuration. Does not require an existing test case for the test result. Must be followed by a Save().
	AddTest(String)	Adds a new test with given name. Must be followed by a Save()
	AddTestPoint(ITestPoint, TeamFoundationIdentity)	Adds a new test point to this test run.
	AddTestPoints(IEnumerable<ITestPoint>, TeamFoundationIdentity)	Adds new test points to the test run. Must be followed by a Save(). The test result objects returned by this call are not usable until after the save.
	CopyTestSettings(ITestSettings)	Copy the test settings and associate it to the test run.(Inherited from ITestRunBase.)
	CreateAttachment(Byte[], Int32, Int32)	Creates an attachment for a Test Result from a byte array.(Inherited from ITestRunBase.)
	CreateAttachment(String)	Creates an attachment from a file. (Inherited from IAttachmentOwner.)
	CreateAttachment(String, SourceFileAction)	Creates an attachment from a file, optionally deleting the source file after uploading.(Inherited from IAttachmentOwner.)
	CreateLogEntry(String, TestMessageLogEntryLevel)	Creates a test message log entry and adds it to the TestMessageLogEntryCollection.(Inherited from ITestMessageLogOwner.)
	Delete()	Removes the given test run and its results from the server.(Inherited from ITestRunBase.)
	QueryResults()	Returns a collection that contains all test results for this test run.
	QueryResults(Boolean)	Returns all test results for this run.
	QueryResultsByOutcome(TestOutcome)	Returns a collection of test results for this test run that has the provided test outcome.
	QueryResultsByOwner(TeamFoundationIdentity)	Returns a collection of test results for this test run that has the provided test owner.
	QueryResultsByStatus(TestResultState)	Returns a collection of test results for this test run that has the provided test status.
	Refresh()	Updates the run with new data from the server.(Inherited from ITestRunBase.)
	Refresh(DateTime)	Updates the test run with the new data from the server only if there exists a test run with newer timestamp than lastUpdated parameter Returns true if test run was updated with the new data and false otherwise
	RefreshLogEntries()	Refreshes the log entries from the server.(Inherited from ITestMessageLogOwner.)
	Save()	Writes the new or updated test run to the server.(Inherited from ITestRunBase.)
	SaveLogEntries()	Saves changed log entries to the server.(Inherited from ITestMessageLogOwner.)

Events

	Name	Description
	AttachmentUploadCompleted	This event is raised when the attachment upload is completed.(Inherited from IAttachmentOwner.)
	PropertyChanged	(Inherited from INotifyPropertyChanged.)

Remarks

No content here will be updated; please do not add material here.