Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-09 06:45:49 +01:00
Code Issues Packages Projects Releases Activity

feat(docs): add developer guide

Browse Source
This commit is contained in:
Elian Doran
2025-04-12 01:36:03 +03:00
parent 21e84dd95e
commit d2a1655de5
105 changed files with 7098 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/Developer Guide/Developer Guide/Testing.md Normal file
View File

@@ -0,0 +1,33 @@
# Testing
## Unit testing and integration testing
Using `vitest`, there are some unit and integration tests done for both the client and the server.
These tests can be found by looking for the corresponding `.spec.ts` in the same directory as the source file.
<figure class="table"><table><tbody><tr><td><p>To run the server-side tests:</p><pre><code class="language-text-x-trilium-auto">npm run server:test</code></pre><p>To view the code coverage for the server:</p><pre><code class="language-text-x-trilium-auto">npm run server:coverage</code></pre><p>Afterwards, a friendly HTML report can be found in <code>/coverage/index.html</code>.</p></td><td><p>To run the client-side tests:</p><pre><code class="language-text-x-trilium-auto">npm run client:test</code></pre><p>To view the code coverage for the client:</p><pre><code class="language-text-x-trilium-auto">npm run client:coverage</code></pre><p>Afterwards, a friendly HTML report can be found in <code>/src/public/app/coverage/index.html</code>.</p></td></tr></tbody></table></figure>
To run both client and server-side tests:
```
npm run test
```
Note that some integration tests rely on an in-memory database in order to function. 
### REST API testing for the server
Some original work was done by Zadam in `/test-etapi`, using `.http` files.
New effort using `vitest` and `supertest` to initialize the Express server and run assertions without having to make actual requests to the server.
An important aspect is that we have access to the Express `app` which allows for interesting assertions such as checking the state of the server, registering debug middleware and so on.
One example is `src/share/routes.spec.ts`.
These integration tests are run alongside unit tests.
## End-to-end testing
* This tests both the client and the server, by running the server and then using Playwright to query the state of the page.
* These can be found in `/e2e`.