1
0
Fork 0
mirror of https://github.com/VSadov/Satori.git synced 2025-06-10 10:00:57 +09:00

Updated mono testing doc (#44360)

* Update testing.md

* Create testing-mono.md

* Update mono testing doc

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* PR feedback

* Fix format

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* PR feedback

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Update docs/workflow/testing/mono/testing.md

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>

* Replace bullet points with sub-headers

* Update sub-headers to remove the duplicated part

Co-authored-by: Ryan Lucia <rylucia@microsoft.com>
This commit is contained in:
Fan Yang 2020-11-20 14:27:44 -05:00 committed by GitHub
parent b9630c4a9b
commit a6b3b236ef
Signed by: github
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,54 +1,108 @@
# Running Tests using Mono Runtime
# Running test suites using Mono
## Running Runtime Tests
We currently only support running tests against coreclr. There are additional mono runtime tests in mono/mono, but they
have not been moved over yet. Simply run the following command:
Before running tests, [build Mono](../../building/mono/README.md) using the desired configuration.
## Runtime Tests
### Desktop Mono:
To build the runtime tests for Mono JIT or interpreter, execute the following command from `$(REPO_ROOT)/src/tests`
```
dotnet build /t:RunCoreClrTests $(REPO_ROOT)/src/mono/mono.proj
./build.sh excludemonofailures <release|debug>
```
If you want to run individual tests, execute this command:
Run individual test:
```
dotnet build /t:RunCoreClrTest /p:CoreClrTest="<TestName>" $(REPO_ROOT)/src/mono/mono.proj
cd ../mono/netcore
make run-tests-coreclr CoreClrTest="bash ../../artifacts/tests/coreclr/OSX.x64.Release/JIT/opt/InstructionCombining/DivToMul/DivToMul.sh"
```
## Running Library Tests
Running library tests against Mono is straightforward regardless of configuration. Simply run the following commands:
1. Build and set the RuntimeFlavor
```bash
./build.sh /p:RuntimeFlavor=mono
Run all tests:
```
or on Windows
```bat
build.cmd /p:RuntimeFlavor=mono
cd ../mono/netcore
make run-tests-coreclr-all
```
2. cd into the test library of your choice (`cd src/libraries/<library>/tests`)
3. Run the tests
### WebAssembly:
Build the runtime tests for WebAssembly
```
dotnet build /t:Test /p:RuntimeFlavor=mono
$(REPO_ROOT)/src/tests/build.sh -skipstressdependencies -excludemonofailures os Browser wasm <Release/Debug>
```
# Patching Local dotnet (.dotnet-mono)
Another way to test mono out is by 'patching' a local dotnet with our runtime bits. This is a good way to write simple
test programs and get a glimpse of how mono will work with the dotnet tooling.
To generate a local .dotnet-mono, execute this command:
The last few lines of the build log should contain something like this:
```
dotnet build /t:PatchLocalMonoDotnet $(REPO_ROOT)/src/mono/mono.proj
--------------------------------------------------
Example run.sh command
src/tests/run.sh --coreOverlayDir=<repo_root>artifacts/tests/coreclr/Browser.wasm.Release/Tests/Core_Root --testNativeBinDir=<repo_root>/artifacts/obj/coreclr/Browser.wasm.Release/tests --testRootDir=<repo_root>/artifacts/tests/coreclr/Browser.wasm.Release --copyNativeTestBin Release
--------------------------------------------------
```
You can then, for example, run our HelloWorld sample via:
To run all tests, execute that command, adding `wasm` to the end.
### Android:
Build the runtime tests for Android x64
```
$(REPO_ROOT)/src/tests/build.sh -skipstressdependencies -excludemonofailures os Android x64 <Release/Debug>
```
The last few lines of the build log should contain something like this:
```
--------------------------------------------------
Example run.sh command
src/tests/run.sh --coreOverlayDir=<repo_root>artifacts/tests/coreclr/Android.x64.Release/Tests/Core_Root --testNativeBinDir=<repo_root>/artifacts/obj/coreclr/Android.x64.Release/tests --testRootDir=<repo_root>/artifacts/tests/coreclr/Android.x64.Release --copyNativeTestBin Release
--------------------------------------------------
```
To run all tests, execute that command, adding `Android` at the end.
### Additional Documents
For more details about internals of the runtime tests, please refer to the [CoreCLR testing documents](../coreclr)
## Libraries tests
### Desktop Mono
Build and run library tests against Mono JIT or interpreter
```
$(REPO_ROOT)/dotnet.sh build /t:Test /p:RuntimeFlavor=mono /p:Configuration=<Release/Debug> $(REPO_ROOT)/src/libraries/<library>/tests
```
Alternatively, you could execute the following command from `$(REPO_ROOT)/src/mono/netcore`
```
make run-tests-corefx-<library>
```
For example, the following command is for running System.Runtime tests:
```
make run-tests-corefx-System.Runtime
```
### Mobile targets and WebAssembly
Build and run library tests against Webassembly, Android or iOS. See instructions located in [Library testing document folder](../libraries/)
# Running the Mono samples
There are a few convenient samples located in `$(REPO_ROOT)/src/mono/netcore/sample`, which could help you test your program easily with different flavors of Mono or do a sanity check on the build. The samples are set up to work with a specific configuration; please refer to the relevant Makefile for specifics. If you would like to work with a different configuration, you can edit the Makefile.
## Desktop Mono
To run the desktop Mono sample, cd to `HelloWorld` and execute:
```
dotnet build -c Release $(REPO_ROOT)/src/mono/netcore/sample/HelloWorld
MONO_ENV_OPTIONS="" COMPlus_DebugWriteToStdErr=1 \
$(REPO_ROOT)/.dotnet-mono/dotnet $(REPO_ROOT)/src/mono/netcore/sample/HelloWorld/bin/HelloWorld.dll
make run
```
Note that the default configuration of this sample is LLVM JIT.
## WebAssembly
To run the WebAssembly sample, cd to `wasm`. There are two sub-folders `browser` and `console`. One is set up to run the progam in browser, the other is set up to run the program in console. Enter the desirable sub-folder and execute
```
make build && make run
```
## Android
To run the Android sample, cd to `Android` and execute
```
make run
```
## iOS
To run the iOS sample, cd to `iOS` and execute
```
make run
```