From eb12661342651ea5fc3c17b9ab610ec4485e9b52 Mon Sep 17 00:00:00 2001 From: Muhammed Mustafa Date: Wed, 21 Sep 2022 18:30:21 +0530 Subject: [PATCH] fix(nocodb): Improved test docs --- packages/noco-docs/content/en/engineering/testing.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/noco-docs/content/en/engineering/testing.md b/packages/noco-docs/content/en/engineering/testing.md index e8e2383ce6..cb841a152d 100644 --- a/packages/noco-docs/content/en/engineering/testing.md +++ b/packages/noco-docs/content/en/engineering/testing.md @@ -12,7 +12,7 @@ menuTitle: "Testing" - MySQL is preferrable - however we fallback to SQLite -#### Setup +### Setup - All the tests are in `packages/nocodb` folder, which will be our working directory. Use the following command to get into that folder. @@ -49,24 +49,24 @@ open tests/unit/.env -## How to run tests +### How to run tests ``` npm run test:unit ``` -## Key points +### Key points - All individual unit tests are independent of each other. We don't use any shared state between tests. - Test environment includes `sakila` sample database and any change to it by a test is reverted before running other tests. - While running unit tests, it tries to connect to mysql server running on `localhost:3306` with username `root` and password `password`(which can be configured) and if not found, it will use `sqlite` as a fallback, hence no requirement of any sql server to run tests. -## Walk through of writing a unit test +### Walk through of writing a unit test We will create an `Table` test suite as an example. -### Configure test +#### Configure test We will configure `beforeEach` which is called before each test is executed. We will use `init` function from `nocodb/packages/tests/unit/init/index.ts`, which is a helper function which configures the test environment(i.e resetting state, etc.).