Skip to content

Commit 0812595

Browse files
committed
chore: update Readme
1 parent d63dd96 commit 0812595

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,3 +202,34 @@ There are two Grunt tasks you can use to build the frontend project:
202202
- restart Chrome
203203
- you should be able to run the dev environment on both localhost and 127.0.0.1 (to check if it's working fine, open the console: you'll find a red message: **"[MSW] Mocking enabled."**)
204204
</details>
205+
206+
## Test
207+
208+
### .NET Serilog.UI Projects
209+
210+
The test projects are located inside the */tests* folder.
211+
212+
Each Serilog.Ui project has a separate test project.
213+
Each project is based onto the **xUnit** test framework.
214+
215+
**Serilog.Ui.Common.Tests**: contains anything that can be shared between the tests projects.
216+
217+
To run the tests, use Test Explorer in Visual Studio or run from the root folder:
218+
219+
```
220+
dotnet test
221+
```
222+
223+
### JS UI assets
224+
225+
Tests are located inside src/Serilog.Ui.Web/assets/__tests__
226+
227+
Tests are based onto Jest test framework, with the help of JSDOM and testing-library packages. Any HTTP request is mocked through [msw](https://mswjs.io/).
228+
229+
Jest configuration can be found in src/Serilog.Ui.Web/jest.config.js; any additional setup item is located inside src/Serilog.Ui.Web/assets/__tests__/util (this folder is excluded from test runs).
230+
231+
To run the tests, open a terminal in src/Serilog.Ui.Web/ and launch this command (watch-mode):
232+
233+
```
234+
npm test
235+
```

0 commit comments

Comments
 (0)