Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mark early testhost startup APIs as internal #2765

Closed
wants to merge 3 commits into from
Closed

Mark early testhost startup APIs as internal #2765

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
abafc4f
Marked test session APIs as internal
Feb 22, 2021
acf5ce8
Merge branch 'master' into dev/copoiena/perf-apis-internal
Feb 22, 2021
b7750e6
Made APIs truly internal
Feb 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ...icrosoft.TestPlatform.Common/Interfaces/Engine/ClientProtocol/IProxyTestSessionManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,22 @@ namespace Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine
using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Orchestrates test session related functionality for the engine communicating with the
/// client.
/// </summary>
public interface IProxyTestSessionManager
{
/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Initialize the proxy.
/// </summary>
///
/// <param name="skipDefaultAdapters">Skip default adapters flag.</param>
void Initialize(bool skipDefaultAdapters);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts the test session based on the test session criteria.
/// </summary>
///
Expand All @@ -31,6 +34,7 @@ void StartSession(
ITestSessionEventsHandler eventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Stops the test session.
/// </summary>
void StopSession();
Expand Down
1 change: 1 addition & 0 deletions src/Microsoft.TestPlatform.Common/Interfaces/Engine/ClientProtocol/ITestEngine.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ IProxyExecutionManager GetExecutionManager(
TestRunCriteria testRunCriteria);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Fetches the TestSessionManager for this engine. This manager would provide all
/// functionality required for test session management.
/// </summary>
Expand Down
4 changes: 4 additions & 0 deletions src/Microsoft.TestPlatform.CrossPlatEngine/TestSession/ProxyTestSessionManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ namespace Microsoft.VisualStudio.TestPlatform.CrossPlatEngine
using CrossPlatResources = Microsoft.VisualStudio.TestPlatform.CrossPlatEngine.Resources.Resources;

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Orchestrates test session operations for the engine communicating with the client.
/// </summary>
public class ProxyTestSessionManager : IProxyTestSessionManager
Expand All @@ -27,6 +28,7 @@ public class ProxyTestSessionManager : IProxyTestSessionManager
private IDictionary<Guid, ProxyOperationManagerContainer> proxyMap;

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Initializes a new instance of the <see cref="ProxyTestSessionManager"/> class.
/// </summary>
///
Expand Down Expand Up @@ -100,6 +102,7 @@ public void StopSession()
}

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Dequeues a proxy to be used either by discovery or execution.
/// </summary>
///
Expand Down Expand Up @@ -133,6 +136,7 @@ public ProxyOperationManager DequeueProxy()
}

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Enqueues a proxy back once discovery or executions is done with it.
/// </summary>
///
Expand Down
7 changes: 7 additions & 0 deletions src/Microsoft.TestPlatform.CrossPlatEngine/TestSession/TestSessionPool.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ namespace Microsoft.VisualStudio.TestPlatform.CrossPlatEngine
using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client;

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Represents the test session pool.
/// </summary>
public class TestSessionPool
Expand All @@ -22,6 +23,7 @@ public class TestSessionPool
private Dictionary<TestSessionInfo, ProxyTestSessionManager> sessionPool;

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Initializes a new instance of the <see cref="TestSessionPool"/> class.
/// </summary>
private TestSessionPool()
Expand All @@ -30,6 +32,7 @@ private TestSessionPool()
}

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Gets the test session pool instance.
/// </summary>
///
Expand All @@ -54,6 +57,7 @@ public static TestSessionPool Instance
}

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Adds a session to the pool.
/// </summary>
///
Expand All @@ -80,6 +84,7 @@ public bool AddSession(
}

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Kills and removes a session from the pool.
/// </summary>
///
Expand Down Expand Up @@ -111,6 +116,7 @@ public bool KillSession(TestSessionInfo testSessionInfo)
}

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Gets a reference to the proxy object from the session pool.
/// </summary>
///
Expand All @@ -134,6 +140,7 @@ public ProxyOperationManager TakeProxy(TestSessionInfo testSessionInfo)
}

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Returns the proxy object to the session pool.
/// </summary>
///
Expand Down
1 change: 1 addition & 0 deletions src/Microsoft.TestPlatform.ObjectModel/Client/Interfaces/ITestPlatform.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ ITestRunRequest CreateTestRunRequest(
TestPlatformOptions options);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test session.
/// </summary>
///
Expand Down
1 change: 1 addition & 0 deletions src/Microsoft.TestPlatform.ObjectModel/Client/TestSessionInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ namespace Microsoft.VisualStudio.TestPlatform.ObjectModel.Client
using System.Runtime.Serialization;

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Defines the test session info object to be passed around between vstest.console and
/// vstest.console wrapper in order to indentify the current session.
/// </summary>
Expand Down
15 changes: 15 additions & 0 deletions src/Microsoft.TestPlatform.VsTestConsole.TranslationLayer/Interfaces/ITestSession.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ namespace Microsoft.VisualStudio.TestPlatform.VsTestConsole.TranslationLayer.Int
using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client.Interfaces;

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Defines a test session that can be used to make calls to the vstest.console
/// process.
/// </summary>
public interface ITestSession : ITestSessionAsync
{
/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts test discovery.
/// </summary>
///
Expand All @@ -28,6 +30,7 @@ void DiscoverTests(
ITestDiscoveryEventsHandler discoveryEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts test discovery.
/// </summary>
///
Expand All @@ -42,11 +45,13 @@ void DiscoverTests(
ITestDiscoveryEventsHandler2 discoveryEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Cancels the last discovery request.
/// </summary>
new void CancelDiscovery();

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -59,6 +64,7 @@ void RunTests(
ITestRunEventsHandler testRunEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -73,6 +79,7 @@ void RunTests(
ITestRunEventsHandler testRunEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -85,6 +92,7 @@ void RunTests(
ITestRunEventsHandler testRunEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -99,6 +107,7 @@ void RunTests(
ITestRunEventsHandler testRunEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -113,6 +122,7 @@ void RunTestsWithCustomTestHost(
ITestHostLauncher customTestHostLauncher);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -129,6 +139,7 @@ void RunTestsWithCustomTestHost(
ITestHostLauncher customTestHostLauncher);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -143,6 +154,7 @@ void RunTestsWithCustomTestHost(
ITestHostLauncher customTestHostLauncher);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -159,6 +171,7 @@ void RunTestsWithCustomTestHost(
ITestHostLauncher customTestHostLauncher);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Stops the test session.
/// </summary>
///
Expand All @@ -168,11 +181,13 @@ void RunTestsWithCustomTestHost(
bool StopTestSession(ITestSessionEventsHandler eventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Cancels the last test run.
/// </summary>
new void CancelTestRun();

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Aborts the last test run.
/// </summary>
new void AbortTestRun();
Expand Down
15 changes: 15 additions & 0 deletions src/Microsoft.TestPlatform.VsTestConsole.TranslationLayer/Interfaces/ITestSessionAsync.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ namespace Microsoft.VisualStudio.TestPlatform.VsTestConsole.TranslationLayer.Int
using Microsoft.VisualStudio.TestPlatform.ObjectModel.Client.Interfaces;

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Defines a test session that can be used to make async calls to the vstest.console
/// process.
/// </summary>
public interface ITestSessionAsync
{
/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts test discovery.
/// </summary>
///
Expand All @@ -29,6 +31,7 @@ Task DiscoverTestsAsync(
ITestDiscoveryEventsHandler discoveryEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts test discovery.
/// </summary>
///
Expand All @@ -43,11 +46,13 @@ Task DiscoverTestsAsync(
ITestDiscoveryEventsHandler2 discoveryEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Cancels the last discovery request.
/// </summary>
void CancelDiscovery();

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -60,6 +65,7 @@ Task RunTestsAsync(
ITestRunEventsHandler testRunEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -74,6 +80,7 @@ Task RunTestsAsync(
ITestRunEventsHandler testRunEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -86,6 +93,7 @@ Task RunTestsAsync(
ITestRunEventsHandler testRunEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -100,6 +108,7 @@ Task RunTestsAsync(
ITestRunEventsHandler testRunEventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -114,6 +123,7 @@ Task RunTestsWithCustomTestHostAsync(
ITestHostLauncher customTestHostLauncher);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -130,6 +140,7 @@ Task RunTestsWithCustomTestHostAsync(
ITestHostLauncher customTestHostLauncher);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -144,6 +155,7 @@ Task RunTestsWithCustomTestHostAsync(
ITestHostLauncher customTestHostLauncher);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Starts a test run.
/// </summary>
///
Expand All @@ -160,6 +172,7 @@ Task RunTestsWithCustomTestHostAsync(
ITestHostLauncher customTestHostLauncher);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Stops the test session.
/// </summary>
///
Expand All @@ -170,11 +183,13 @@ Task<bool> StopTestSessionAsync(
ITestSessionEventsHandler eventsHandler);

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Cancels the last test run.
/// </summary>
void CancelTestRun();

/// <summary>
/// THIS API IS INTERNAL AND IT'S SUBJECT TO CHANGE.
/// Aborts the last test run.
/// </summary>
void AbortTestRun();
Expand Down
Loading