From: Ilona Tomkowicz <32700855+ilonatommy@users.noreply.github.com>
Date: Tue, 31 Jan 2023 13:54:46 +0000 (+0100)
Subject: [wasm][debugger][libs] Documentation: How to debug library tests (#77368)
X-Git-Tag: accepted/tizen/unified/riscv/20231226.055536~4321
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f8ab5554091d2124dffa6002650d9a5ca0a7fba3;p=platform%2Fupstream%2Fdotnet%2Fruntime.git

[wasm][debugger][libs] Documentation: How to debug library tests (#77368)

* Draft.

* DevTools as IDE instructions.

* VS Code as IDE instructions.

* Correction: `WebRoot` is not required.

* Added: expect long wait & new pic without webRoot

* Renamed as suggested by @pavelsavara.

* The first bp is not automatic, user has to set it on their own.
---

diff --git a/docs/workflow/testing/libraries/debugging-wasm.md b/docs/workflow/testing/libraries/debugging-wasm.md
new file mode 100644
index 0000000..8c7f4d2
--- /dev/null
+++ b/docs/workflow/testing/libraries/debugging-wasm.md
@@ -0,0 +1,57 @@
+# Debugging libraries
+
+For building libraries or testing them without debugging, read:
+- [Building libraries](https://github.com/dotnet/runtime/blob/main/docs/workflow/building/libraries/README.md),
+- [Testing libraries](https://github.com/dotnet/runtime/blob/main/docs/workflow/testing/libraries/testing.md).
+
+## Run the tests with debugger support
+
+Run the selected library tests in the browser, e.g. `System.Collections.Concurrent.Tests` this way:
+```
+dotnet run -r browser-wasm -c Debug --project src/libraries/System.Collections/tests/System.Collections.Tests.csproj --debug --host browser -p:DebuggerSupport=true
+```
+where we choose `browser-wasm` as the runtime and by setting `DebuggerSupport=true` we ensure that tests won't start execution before the debugger will get attached. In the output, among others you should see:
+
+```
+Debug proxy for chrome now listening on http://127.0.0.1:58346/. And expecting chrome at http://localhost:9222/
+App url: http://127.0.0.1:9000/index.html?arg=--debug&arg=--run&arg=WasmTestRunner.dll&arg=System.Collections.Concurrent.Tests.dll
+```
+The proxy's url/port will be used in the next step.
+
+You may need to close all Chrome instances. Then, start the browser with debugging mode enabled:
+
+`chrome --remote-debugging-port=9222 <APP_URL>`
+
+Now you can choose an IDE to start debugging. Remember that the tests wait only till the debugger gets attached. Once it does, they start running. You may want to set breakpoints first, before attaching the debugger, e.g. setting one in `src\libraries\Common\tests\WasmTestRunner\WasmTestRunner.cs` on the first line of `Main()` will prevent any test to be run before you get prepared.
+
+## Debug with Chrome DevTools
+Open `chrome://inspect/#devices` in a new tab in the browser you started. Select `Configure`:
+
+![image](https://user-images.githubusercontent.com/32700855/201867874-7f707eb1-e859-441c-8205-abb70a7a0d0b.png)
+
+and paste the address of proxy that was provided in the program output.
+
+![image](https://user-images.githubusercontent.com/32700855/201862487-df76a06c-b24d-41a0-bf06-6959bba59a58.png)
+
+New remote targets will be displayed, select the address you opened in the other tab by clicking `Inspect`.
+
+![image](https://user-images.githubusercontent.com/32700855/201863048-6a4fe20b-a215-435d-b594-47750fcb2872.png)
+
+A new window with Chrome DevTools will be opened. In the tab `sources` you should look for `file://` directory. There you can browse through libraries file tree and open the source code. It can take some time to load the files. When the IDE is ready the tests will start running. You cannot set a breakpoints in Chrome DevTools before the files get loaded, so you might want to use the first run for setting the initial breakpoint in `WasmTestRunner.cs` and then rerun the app. DevTools will stop on the previously set breakpoint and you will have time to set breakpoints in the libs you want to debug and click Resume.
+
+## Debug with VS Code
+
+Add following configuration to your `.vscode/launch.json`:
+```
+        {
+            "name": "Libraries",
+            "request": "attach",
+            "type": "chrome",
+            "address": "localhost",
+            "port": <PROXY'S_PORT>
+        }
+```
+Set at least one breakpoint in the libraries, you can do it initially in `WasmTestRunner.cs`.
+
+Run the configuration and be patient, it can take some time. Wait till VS Code will get stopped in `WasmTestRunner`. Set breakpoints in the libs you want to debug and click Resume.
+![image](https://user-images.githubusercontent.com/32700855/201894003-fc5394ad-9848-4d07-a132-f687ecd17c50.png)