chore: cleanup documentation (#29552)

This commit is contained in:
Emad Rad
2024-07-12 01:09:23 +03:30
committed by GitHub
parent 3f6b7e2456
commit 84a1cd245c
8 changed files with 62 additions and 31 deletions

View File

@@ -26,48 +26,56 @@ You can use a different DB backend by defining `SUPERSET__SQLALCHEMY_DATABASE_UR
This script will not install any dependencies for you, so you must be on an already set virtualenv
## Use:
## Usage
To show all supported switches:
```$bash
```bash
scripts/tests/run.sh --help
```
From the superset repo root directory:
- Example run all tests:
```$bash
```bash
scripts/tests/run.sh
```
- Example run a single test module:
```$bash
```bash
scripts/tests/run.sh --module tests/charts/api_tests.py
```
- Example run a single test:
```$bash
```bash
scripts/tests/run.sh --module tests/charts/api_tests.py::TestChartApi::test_get_charts
```
- Example run a single test, without any init procedures. Init procedures include:
resetting test database, db upgrade, superset init, loading example data. If your tests
are idempotent, after the first run, subsequent runs are really fast
```$bash
```bash
scripts/tests/run.sh --module tests/charts/api_tests.py::TestChartApi::test_get_charts --no-init
```
- Example for not recreating the test DB (will still run all the tests init procedures)
```$bash
```bash
scripts/tests/run.sh --module tests/charts/api_tests.py::TestChartApi::test_get_charts --no-reset-db
```
- Example for not running tests just initialize the test DB (drop/create, upgrade and load examples)
```$bash
```bash
scripts/tests/run.sh --no-tests
```
- Example for just resetting the tests DB
```$bash
```bash
scripts/tests/run.sh --reset-db --no-tests
```