Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 3.05 KB

test.md

File metadata and controls

56 lines (38 loc) · 3.05 KB

Testing the CLR Instrumentation Engine.

Testing locally

Windows

The WindowsLocalTest.ps1 script requires installing the ClrInstrumentationEngine msi or msm and launches a user-specified application (or another PowerShell process) with the COR_PROFILER environment variables set. The script takes switch parameters to configure several environment variables (like DebugWait) as well as one InstrumentationMethod config path and RawProfilerHook Guid and path.

Running unit tests locally

Windows

There are two ways to run the CLR Instrumentation Engine unit tests - Visual Studio Test Explorer and build.ps1 script.

Via Visual Studio Test Explorer

  1. Open InstrumentationEngine.sln
  2. Set the build configuration (Debug or Release) and architecture (x86, x64, AnyCPU) and build locally.
  3. Go to Test > Test Settings > Select Test Settings File > [CLRInstrumentationEngine repo]\tests\TestSettings\.
    • Select the x86.runsettings for x86 and AnyCPU architecture
    • Select the x64.runsettings for x64 architecture.
  4. Click Run All in the Test Explorer.

Via Script

Run the script [CLRInstrumentationEngine repo]\build.ps1 with IncludeTests. This will invoke the unit tests for x86, x64, and AnyCPU against either Debug or Release configuration post-build.

Flag Description
IncludeTests Runs unit tests after build.
SkipBuild Skips building the solutions. Use this with -IncludeTests flag to only run tests.
Release Cause build to run with Release configuration. By default, build uses Debug configuration.
Verbose Sets msbuild verbosity to normal. By default, verbosity is set to ErrorsOnly.

Linux

Prerequisites

The following technologies/tools are required in order to run Linux tests on Windows. These instructions were tested for Ubuntu 18.04 LTS and may require adjustments for other distros/versions.

  • WSL (Windows Subsystem for Linux) 2.0 with Ubuntu 18.04 LTS
    • WSL is available on Windows 10 Build 19041+ and Windows 11.
    • Run this in a command prompt wsl --install -d Ubuntu-18.04 or download Ubuntu 18.04 from the Microsoft Store. Restart as needed and setup a user/pass for your account.
  • Docker Desktop for Linux (Ubuntu)

Steps

  1. On Windows, build InstrumentationEngine for Debug AnyCPU (which builds managed projects and dlls)
  • You can also run dotnet build InstrumentationEngine.sln in the interactive container session from step 2 instead.
  1. Run src\scripts\DockerLocalBuild.ps1 -Wsl -BuildDockerImage -Interactive -RebuildImage. This will build a docker container and drop you in an interactive session. By default builds for Ubuntu/Debian; set -CLib musl if you want to build for Alpine Linux instead.
  2. Run ./src/build.sh within the interactive session. This builds the native shared object files (.so).
  3. Run dotnet test bin/Debug/AnyCPU/net70/InstrEngineTests.dll

Please contact clrieowners@microsoft.com for any details or questions.