Visual Studio 2019 Test-related API removal #1830
Description
Visual Studio 2019 Test-related API removal
In previous releases of Visual Studio there were several test-related APIs marked public, but were never documented or intended for external use. With Visual Studio 2019, we plan to deprecate and/or remove the APIs listed in the tables below. We know this could affect extension owners so we are communicating this very early and before the first preview release of Visual Studio 2019.
Only public APIs under Microsoft.VisualStudio.TestWindow.Interfaces.dll will be available to extend.
If this impacts you and your customers please comment so we can better understand your scenario.
Microsoft.VisualStudio.TestPlatform
| API Name | Remarks | Recommendation |
|---|---|---|
| Common.Internal.ITestDiscovererCapabilities | ||
| Common.RockSteady.TestPluginsFramework.TestPluginCache | ||
| Common.RunSettings | ||
| Common.TestPluginsFramework.LazyExtension`2 | ||
| Core.DiscoveryContext | ||
| Core.DiscoveryManager | ||
| Core.IFrameworkHandleInternal | ||
| Core.ITestCaseLog | ||
| Core.ITestRunLog | ||
| Core.TestExecutionContext | ||
| Core.TestExecutionManager | ||
| Core.TestRunStats | ||
| ObjectModel.Client.ITestExecutorLauncher | Not supported, as it is not required with the new design and new API surface for ITestPlatform. | ITestHostLauncher to be considered. |
| ObjectModel.Client.ITestPlatform | Re-designed. Slight changes in the API surface to accommodate the new design, removal of redundancies. | Recommendation for clients is to use the TranslationLayer APIs to interact with Test platform v2. |
| ObjectModel.TestCaseProperties | Supported in TPv2 | |
| Utilities.AppContainerUtilities | Not supported in TPv2 : Helper utilities for running tests for Windows Store apps | Do not use. |
| Utilities.ClientUtilities | ||
| Utilities.FakesUtilities | Not supported. | |
| Utilities.InferSettingsHelper | Not supported. | |
| Utilities.IPackageDebugSettings | ||
| Utilities.MSTestSettingsUtilities | Not supported. | |
| Utilities.PackageDebugSettings | ||
| Utilities.PhoneAppUtilitiesImplementation | ||
| Utilities.UtilitiesException | Redundant exception, mainly used in AppContainer context. | Do not use. |
Microsoft.VisualStudio.TestWindow (under Microsoft.VisualStudio.TestWindow.Interfaces.dll)
| API Name | Remarks |
|---|---|
| Extensibility.ICustomSettingsImporter (Deprecated) | 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. |
| Extensibility.ICommandContainer (Deprecated) | |
| Extensibility.IDeployService (Deprecated) | This API is no longer supported for deployment of UWP based apps. |
| Extensibility.IOpenTarget (Deprecated) | Please use VS shell supported APIs to open files or hyperlinks in your extensions. |
| Extensibility.IProperty (Deprecated) | |
| Extensibility.IResult (Deprecated) | |
| Extensibility.IRunCommands (Deprecated) | |
| Extensibility.ISelectionCommands (Deprecated) | |
| Extensibility.ITest (Deprecated) | |
| Extensibility.ITestsService (Deprecated) | |
| Extensibility.IUICommandContainer (Deprecated) | |
| Extensibility.RunCommand (Deprecated) | |
| Extensibility.SelectionCommand (Deprecated) | |
| Extensibility.ValidateArgProperty (Deprecated) | |
| Extensibility.IIncrementalUnitTestChange | |
| Extensibility.ISourceBasedTestDiscoverer | |
| Extensibility.ISourceInformationProvider | |
| Extensibility.ITestContainer2 | |
| Extensibility.ITestContainer3 | |
| Extensibility.ITestDataDelta | |
| Extensibility.ITestDiscoveryListener | |
| Extensibility.ITestExplorerService | |
| Extensibility.ITestExplorerServiceContainerDiscoverer | |
| Extensibility.ITestSourceLocationLookupService | |
| Extensibility.SourceLocation | |
| Extensibility.TestDataChangeReason | |
| Extensibility.TestMethodSourceInformation | |
| Telemetry. ITestWindowTelemetry |
Microsoft.VisualStudio.TestWindow
The following APIs not under Microsoft.VisualStudio.TestWindow.Interfaces.dll are amongst the list of APIs removed.
| API Name | Remarks |
|---|---|
| Controller.DiscoverAllOrRunOnInitializeOperation | |
| Controller.DiscoveryConfiguration | |
| Controller.IDebugLauncher | |
| Controller.IOperationData | |
| Controller.IRequestFactory | |
| Controller.ITestContainerProvider | |
| Controller.IUserRunSettings | |
| Controller.Operation | |
| Controller.OperationData | |
| Controller.RequestConfiguration | |
| Controller.RequestConfigurationFactory | |
| Controller.SafeDispatcher | |
| Controller.TestContainerConfiguration | |
| Controller.TestPlatformProvider | |
| Controller.TestRunConfiguration | |
| Data.ChangedContainer | |
| Data.TestsService | |
| Extensibility.ILoggerExtensions | |
| VsAdapters.AbstractDeviceAppxPackageUtilities | |
| VsAdapters.VsPhoneAppxPackageUtilities | |
| VsHost.DebugLauncher | |
| VsHost.IToolWindow | |
| VsHost.RemoteDebugLauncher | |
| VsHost.TestWindowPackage |