diff --git a/src/Platform/Microsoft.Testing.Extensions.AzureDevOpsReport/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.AzureDevOpsReport/PACKAGE.md index 214ac847f6..a7f24e3859 100644 --- a/src/Platform/Microsoft.Testing.Extensions.AzureDevOpsReport/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.AzureDevOpsReport/PACKAGE.md @@ -1,9 +1,35 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.AzureDevOpsReport -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.AzureDevOpsReport is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that reports individual test failures as errors or warnings in Azure DevOps CI builds, with file/line annotations when available. -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.AzureDevOpsReport` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.AzureDevOpsReport +``` ## About -This package extends Microsoft Testing Platform to provide Azure DevOps reporting. +This package extends Microsoft.Testing.Platform with: + +- **Azure DevOps reporting**: emits individual CI errors/warnings for each test failure via the Azure DevOps logging commands +- **Configurable severity**: supports `--report-azdo-severity` (`error` or `warning`) +- **CI auto-detection**: detects Azure DevOps environments through the `TF_BUILD` variable + +Enable Azure DevOps reporting with the `--report-azdo` command line option. + +## Related packages + +- [Microsoft.Testing.Extensions.TrxReport](https://www.nuget.org/packages/Microsoft.Testing.Extensions.TrxReport): TRX report generation for standardized test result files + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.AzureFoundry/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.AzureFoundry/PACKAGE.md new file mode 100644 index 0000000000..f51a68f006 --- /dev/null +++ b/src/Platform/Microsoft.Testing.Extensions.AzureFoundry/PACKAGE.md @@ -0,0 +1,33 @@ +# Microsoft.Testing.Extensions.AzureFoundry + +Microsoft.Testing.Extensions.AzureFoundry is an AI provider extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that integrates with Azure AI Foundry (Azure OpenAI) to enable AI-powered testing capabilities. + +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.AzureFoundry` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.AzureFoundry +``` + +## About + +This package extends Microsoft.Testing.Platform with: + +- **Azure AI Foundry integration**: provides an `IChatClientProvider` implementation backed by Azure OpenAI +- **Provider implementation**: supplies chat client capabilities to extensions using `Microsoft.Testing.Platform.AI` +- **Environment-based configuration**: reads Azure OpenAI settings from environment variables + +This package is a reference implementation of the [Microsoft.Testing.Platform.AI](https://www.nuget.org/packages/Microsoft.Testing.Platform.AI) abstractions. + +## Related packages + +- [Microsoft.Testing.Platform.AI](https://www.nuget.org/packages/Microsoft.Testing.Platform.AI): AI extensibility abstractions for the testing platform + +## Documentation + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.CrashDump/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.CrashDump/PACKAGE.md index 88c8efbf23..6edac3ba07 100644 --- a/src/Platform/Microsoft.Testing.Extensions.CrashDump/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.CrashDump/PACKAGE.md @@ -1,9 +1,36 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.CrashDump -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.CrashDump is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that captures a crash dump of the test host process when an unhandled exception or crash occurs. -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.CrashDump` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.CrashDump +``` ## About -This package extends Microsoft Testing Platform to provide a crash dump functionality. +This package extends Microsoft.Testing.Platform with: + +- **Crash dump collection**: automatically captures a memory dump when the test process crashes +- **Post-mortem debugging**: collected dumps can be analyzed with tools like Visual Studio, WinDbg, or `dotnet-dump` +- **Cross-platform**: supported on Windows, Linux, and macOS. Note that dumps collected on macOS can only be analyzed on macOS +- **Runtime behavior**: supported for .NET 6+; on .NET Framework this extension is ignored + +Enable crash dump collection via the `--crashdump` command line option. + +## Related packages + +- [Microsoft.Testing.Extensions.HangDump](https://www.nuget.org/packages/Microsoft.Testing.Extensions.HangDump): captures dumps when the test process hangs + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.HangDump/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.HangDump/PACKAGE.md index 776c34d531..1aba709ddc 100644 --- a/src/Platform/Microsoft.Testing.Extensions.HangDump/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.HangDump/PACKAGE.md @@ -1,9 +1,37 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.HangDump -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.HangDump is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that captures a memory dump when the test host process appears to be hung (exceeds a configurable timeout). -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.HangDump` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.HangDump +``` ## About -This package provides Windows Hang dump extensions to Microsoft Testing Platform. +This package extends Microsoft.Testing.Platform with: + +- **Hang detection**: monitors the test host process and detects when it exceeds a configurable timeout without any activity. +- **Dump collection**: captures a memory dump of the hanging process for post-mortem analysis +- **Deadlock investigation**: collected dumps can be analyzed with tools like Visual Studio, WinDbg, or `dotnet-dump` to diagnose deadlocks and other hang causes + +The timeout defaults to `30m` and can be configured in values such as `90s`, `5m`, or `1.5h`. + +Enable hang dump collection via the `--hangdump` command line option, and configure the timeout with `--hangdump-timeout`. + +## Related packages + +- [Microsoft.Testing.Extensions.CrashDump](https://www.nuget.org/packages/Microsoft.Testing.Extensions.CrashDump): captures dumps when the test process crashes + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.HotReload/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.HotReload/PACKAGE.md index 7975720586..b4d7b1df5b 100644 --- a/src/Platform/Microsoft.Testing.Extensions.HotReload/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.HotReload/PACKAGE.md @@ -1,9 +1,31 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.HotReload -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.HotReload is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that enables Hot Reload support, allowing you to apply code changes to your running tests without restarting the test host process. -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.HotReload` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.HotReload +``` ## About -This package extends Microsoft Testing Platform to provide Hot Reload support. +This package extends Microsoft.Testing.Platform with: + +- **Hot Reload integration**: apply code changes to your test project without restarting the test host +- **Faster inner loop**: reduces the time between making a change and seeing the test results +- **Console-mode support**: currently supported in console mode (not in Visual Studio/VS Code Test Explorer) + +Enable Hot Reload support by setting `TESTINGPLATFORM_HOTRELOAD_ENABLED=1`. + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md index 866192516c..f6ed6bb69a 100644 --- a/src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.OpenTelemetry/PACKAGE.md @@ -1,9 +1,29 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.OpenTelemetry -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.OpenTelemetry is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that instruments test execution with [OpenTelemetry](https://opentelemetry.io/)-compatible traces and metrics. -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.OpenTelemetry` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.OpenTelemetry +``` ## About -This package provides Open Telemetry extension to Microsoft Testing Platform. +This package extends Microsoft.Testing.Platform with: + +- **OpenTelemetry integration**: instruments test execution and produces OpenTelemetry-compatible traces and metrics that can be exported by user-configured exporters (for example, OTLP exporters) +- **Observability**: enables you to route test execution data, via your own OpenTelemetry exporter configuration, into observability backends (e.g. Jaeger, Prometheus, Grafana) +- **Standards-based**: leverages the OpenTelemetry .NET SDK so that data is sent only to the telemetry exporters and endpoints that you configure + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.Retry/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.Retry/PACKAGE.md index 1d728ad78d..ac00f1458c 100644 --- a/src/Platform/Microsoft.Testing.Extensions.Retry/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.Retry/PACKAGE.md @@ -1,9 +1,31 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.Retry -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.Retry is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that provides test resilience and transient-fault handling by rerunning failed tests. -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.Retry` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.Retry +``` ## About -This package extends Microsoft Testing Platform to provide a retry policy system that allows to restart tests on failure. +This package extends Microsoft.Testing.Platform with: + +- **Automatic retry**: automatically re-runs failed tests up to a configurable number of times +- **Retry guards**: can stop retries when failure thresholds are exceeded (`--retry-failed-tests-max-percentage`, `--retry-failed-tests-max-tests`) +- **Integration-test focus**: intended for scenarios where transient environment issues can cause intermittent failures + +Configure retry using `--retry-failed-tests `, and optionally limit retries with `--retry-failed-tests-max-percentage` or `--retry-failed-tests-max-tests`. + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.Telemetry/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.Telemetry/PACKAGE.md index 46232617ad..c9016f7874 100644 --- a/src/Platform/Microsoft.Testing.Extensions.Telemetry/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.Telemetry/PACKAGE.md @@ -1,9 +1,31 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.Telemetry -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.Telemetry is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that collects usage telemetry to help the Microsoft.Testing.Platform team improve the product. -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.Telemetry` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.Telemetry +``` ## About -This package provides telemetry extensions to Microsoft Testing Platform. +This package extends Microsoft.Testing.Platform with: + +- **Usage telemetry**: collects usage data to help understand product usage and prioritize improvements +- **Opt-out support**: telemetry can be disabled via the `TESTINGPLATFORM_TELEMETRY_OPTOUT` or `DOTNET_CLI_TELEMETRY_OPTOUT` environment variables +- **Disclosure**: telemetry information is shown on first run, with opt-out guidance + +This package is an optional, opt-in extension. To enable telemetry when using Microsoft.Testing.Platform (including when running tests with [MSTest](https://www.nuget.org/packages/MSTest)), you must explicitly reference the `Microsoft.Testing.Extensions.Telemetry` package from your test project or from your own test framework or tooling package. + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.TrxReport.Abstractions/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.TrxReport.Abstractions/PACKAGE.md index 19953e6fef..e46172cd91 100644 --- a/src/Platform/Microsoft.Testing.Extensions.TrxReport.Abstractions/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.TrxReport.Abstractions/PACKAGE.md @@ -1,11 +1,36 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.TrxReport.Abstractions -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.TrxReport.Abstractions provides the interfaces and data objects for extensions that need to interoperate with TRX report functionality in [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform). -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.TrxReport.Abstractions` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.TrxReport.Abstractions +``` ## About -This package provides interfaces and data objects used by extensions willing to interoperate with TRX functionality. +This package provides: + +- **TRX abstractions**: interfaces and data types for extensions that need to contribute to or consume TRX report data +- **Extensibility**: allows third-party extensions to enrich TRX reports with additional information + +> **Note**: This package provides only the abstractions. To generate TRX reports, install [Microsoft.Testing.Extensions.TrxReport](https://www.nuget.org/packages/Microsoft.Testing.Extensions.TrxReport). +> +> For most test projects, you should install `Microsoft.Testing.Extensions.TrxReport` instead of referencing this package directly. + +## Related packages + +- [Microsoft.Testing.Extensions.TrxReport](https://www.nuget.org/packages/Microsoft.Testing.Extensions.TrxReport): TRX report generation extension + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing -This package does not bring support for telemetry, for this you would need to install Microsoft.Testing.Extensions.TrxReport package. +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.TrxReport/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.TrxReport/PACKAGE.md index 69685e9b2b..25e4c90857 100644 --- a/src/Platform/Microsoft.Testing.Extensions.TrxReport/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.TrxReport/PACKAGE.md @@ -1,9 +1,36 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.TrxReport -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.TrxReport is an extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform) that generates TRX (Visual Studio Test Results) report files. -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.TrxReport` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.TrxReport +``` ## About -This package extends Microsoft Testing Platform to provide TRX test reports. +This package extends Microsoft.Testing.Platform with: + +- **TRX report generation**: produces `.trx` report files compatible with Visual Studio and Azure DevOps +- **Standardized format**: TRX is a widely supported XML-based test results format +- **CI integration**: TRX files can be published to Azure DevOps, GitHub Actions and other CI systems for rich test result visualization + +Enable TRX report generation via the `--report-trx` command line option. + +## Related packages + +- [Microsoft.Testing.Extensions.TrxReport.Abstractions](https://www.nuget.org/packages/Microsoft.Testing.Extensions.TrxReport.Abstractions): interfaces for extensions interoperating with TRX reports +- [Microsoft.Testing.Extensions.AzureDevOpsReport](https://www.nuget.org/packages/Microsoft.Testing.Extensions.AzureDevOpsReport): Azure DevOps CI error/warning reporting for test failures + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Extensions.VSTestBridge/PACKAGE.md b/src/Platform/Microsoft.Testing.Extensions.VSTestBridge/PACKAGE.md index e11b0ee9a9..ff9bf58c1a 100644 --- a/src/Platform/Microsoft.Testing.Extensions.VSTestBridge/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Extensions.VSTestBridge/PACKAGE.md @@ -1,9 +1,31 @@ -# Microsoft.Testing +# Microsoft.Testing.Extensions.VSTestBridge -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Extensions.VSTestBridge is a **test framework author** extension for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform). It provides a compatibility layer with VSTest so frameworks can support Microsoft.Testing.Platform while continuing VSTest-mode workflows. -Documentation can be found at . +> **Note**: This package is **not intended for end-user test projects**. It is designed for framework and adapter maintainers who need compatibility with both VSTest and Microsoft.Testing.Platform. + +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Extensions.VSTestBridge` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Extensions.VSTestBridge +``` ## About -This package provides bridge extensions to Microsoft Testing Platform to help test framework authors support both Test Anywhere and the old VSTest Test Platform. +This package provides: + +- **VSTest compatibility layer**: helps frameworks keep existing VSTest-mode workflows (`vstest.console.exe`, `dotnet test`, VSTest task, Test Explorer) +- **Migration path**: enables framework authors to gradually adopt Microsoft.Testing.Platform while maintaining compatibility +- **Runsettings and filter support**: enables VSTest `.runsettings`/`--filter` compatibility where supported by the framework + +## Documentation + +For this extension, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Platform.AI/PACKAGE.md b/src/Platform/Microsoft.Testing.Platform.AI/PACKAGE.md new file mode 100644 index 0000000000..82b2bd8ec8 --- /dev/null +++ b/src/Platform/Microsoft.Testing.Platform.AI/PACKAGE.md @@ -0,0 +1,33 @@ +# Microsoft.Testing.Platform.AI + +Microsoft.Testing.Platform.AI provides the AI extensibility abstractions for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform), enabling test frameworks and extensions to leverage Large Language Models (LLMs) and AI capabilities for intelligent testing activities. + +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Platform.AI` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Platform.AI +``` + +## About + +This package provides: + +- **IChatClientProvider abstraction**: a standardized interface for AI providers to integrate with the testing platform +- **Unified AI access**: allows extensions to consume AI capabilities without implementing provider-specific logic +- **Microsoft.Extensions.AI integration**: leverages the industry-standard [Microsoft.Extensions.AI](https://www.nuget.org/packages/Microsoft.Extensions.AI) abstractions for broad AI provider compatibility + +> **Note**: This package provides the abstractions only. You need an AI provider implementation (such as [Microsoft.Testing.Extensions.AzureFoundry](https://www.nuget.org/packages/Microsoft.Testing.Extensions.AzureFoundry)) to supply the actual AI capabilities. + +## Related packages + +- [Microsoft.Testing.Extensions.AzureFoundry](https://www.nuget.org/packages/Microsoft.Testing.Extensions.AzureFoundry): Azure AI Foundry (Azure OpenAI) provider implementation + +## Documentation + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Platform.MSBuild/PACKAGE.md b/src/Platform/Microsoft.Testing.Platform.MSBuild/PACKAGE.md index 145cfef903..740c88bd3c 100644 --- a/src/Platform/Microsoft.Testing.Platform.MSBuild/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Platform.MSBuild/PACKAGE.md @@ -1,9 +1,31 @@ -# Microsoft.Testing +# Microsoft.Testing.Platform.MSBuild -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Platform.MSBuild provides the MSBuild tasks needed for [Microsoft.Testing.Platform](https://www.nuget.org/packages/Microsoft.Testing.Platform), including entry-point generation and test configuration file support. -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Platform.MSBuild` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Platform.MSBuild +``` ## About -This package provides MSBuild integration for Microsoft Testing Platform. +This package provides: + +- **Entry-point generation**: generates the required entry point for Microsoft.Testing.Platform test projects +- **Configuration file support**: copies `testconfig.json` from the project into the output directory as `$(AssemblyName).testconfig.json` +- **`dotnet test` compatibility**: enables running MTP-based test projects through the VSTest-based `dotnet test` command on .NET SDKs + +This package is typically **not referenced directly**. Instead, test framework packages (such as [MSTest](https://www.nuget.org/packages/MSTest)) reference it automatically. + +## Documentation + +For this package, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository. diff --git a/src/Platform/Microsoft.Testing.Platform/PACKAGE.md b/src/Platform/Microsoft.Testing.Platform/PACKAGE.md index 76fe07c7eb..5b39823b2b 100644 --- a/src/Platform/Microsoft.Testing.Platform/PACKAGE.md +++ b/src/Platform/Microsoft.Testing.Platform/PACKAGE.md @@ -1,9 +1,35 @@ -# Microsoft.Testing +# Microsoft.Testing.Platform -Microsoft Testing is a set of platform, framework and protocol intended to make it possible to run any test on any target or device. +Microsoft.Testing.Platform is a lightweight and portable alternative to [VSTest](https://github.com/microsoft/vstest) for running tests in CLI, continuous integration (CI) pipelines, Visual Studio Test Explorer, and Visual Studio Code Test Explorer. Microsoft.Testing.Platform is embedded directly in your test projects and test applications can be run directly. -Documentation can be found at . +Microsoft.Testing.Platform is open source. You can find `Microsoft.Testing.Platform` code in the [microsoft/testfx](https://github.com/microsoft/testfx) GitHub repository. + +## Install the package + +```dotnetcli +dotnet add package Microsoft.Testing.Platform +``` ## About -This package provides the test platform. +This package provides the core platform and the .NET implementation of the testing protocol. It includes: + +- **Test application host**: test projects are built as executables that can be run directly +- **Extensibility model**: a rich extensibility model allowing test frameworks, tools and extensions to interoperate +- **Protocol**: the `Microsoft Testing Platform protocol` enabling communication between the test host and external consumers (e.g. IDE, CI) + +This package is typically **not referenced directly**. Instead, test framework packages (such as [MSTest](https://www.nuget.org/packages/MSTest)) reference it automatically. + +## Related packages + +- [Microsoft.Testing.Platform.MSBuild](https://www.nuget.org/packages/Microsoft.Testing.Platform.MSBuild): MSBuild integration for `dotnet test` and CI pipeline support + +## Documentation + +For this package, see . + +For comprehensive documentation, see . + +## Feedback & contributing + +Microsoft.Testing.Platform is an open source project. Provide feedback or report issues in the [microsoft/testfx](https://github.com/microsoft/testfx/issues) GitHub repository.