Add chaos tests readme and update bug report template (#6610)

* Add chaos ReadMe and update bug report template

Signed-off-by: yanliang567 <yanliang.qiao@zilliz.com>

* [skip ci] Update code format in ReadMe

Signed-off-by: yanliang567 <yanliang.qiao@zilliz.com>

* [skip ci] Update code format in ReadMe

Signed-off-by: yanliang567 <yanliang.qiao@zilliz.com>

* Update reg exp to match test pass document

Signed-off-by: yanliang567 <yanliang.qiao@zilliz.com>

* Add deployment mode in report template

Signed-off-by: yanliang567 <yanliang.qiao@zilliz.com>
pull/6619/head
yanliang567 2021-07-19 16:13:10 +08:00 committed by GitHub
parent b98b30b96f
commit 345a1db4c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 71 additions and 8 deletions

View File

@ -8,17 +8,20 @@ assignees: ''
---
<!-- Please state your issue using the following template and, most importantly, in English. -->
#### Describe the bug:
#### Expected behavior:
#### Steps/Code to reproduce:
#### Expected result:
#### Actual results:
#### Environment:
- Milvus version(e.g. v1.1.0 or 8b23a93):
- Milvus version(e.g. v2.0.0-RC2 or 8b23a93):
- Deployment mode(standalone or cluster):
- SDK version(e.g. pymilvus v2.0.0rc2):
- OS(Ubuntu or CentOS):
- CPU/Memory:

2
.github/mergify.yml vendored
View File

@ -34,7 +34,7 @@ pull_request_rules:
conditions:
- base=master
- -files~=^[^\.]+$
- -files~=\.(?!md|png)
- -files~=\S+\.(?!md$|png$)
actions:
label:
add:

View File

@ -1 +1,61 @@
Chaos Tests
# Chaos Tests
## Goal
Chaos tests are designed to check the reliability of Milvus.
For instance, if one pod is killed:
- verify that it restarts automatically
- verify that the related operation fails, while the other operations keep working successfully during the absence of the pod
- verify that all the operations work successfully after the pod back to running state
- verify that no data lost
## Prerequisite
Chaos tests run in pytest framework, same as e2e tests.
Please refer to [Run E2E Tests](https://github.com/milvus-io/milvus/blob/master/tests/README.md)
## Test Scenarios
### Milvus in cluster mode
1. root coordinator pod is killed
2. proxy pod is killed
3. data coordinator pod is killed
4. data node pod is killed
5. index coordinator pod is killed
6. index node pod is killed
7. query coordinator pod is killed
8. query node pod is killed
9. minio pod is killed
### Milvus in standalone mode
1. standalone pod is killed
2. minio pod is killed
## How it works
- Test scenarios are designed by different chaos objects
- Every chaos object is defined in one yaml file locates in folder <code>chaos_objects</code>
- Every chaos yaml file specified by <code>ALL_CHAOS_YAMLS</code> in <code>constants.py</code> would be parsed as a parameter and be passed into <code>test_chaos.py</code>
- All expectations of every scenario are defined in <code>testcases.yaml</code> locates in folder <code>chaos_objects</code>
- [Chaos Mesh](https://chaos-mesh.org/) is used to inject chaos into Milvus in <code>test_chaos.py</code>
## Run
### Manually
Run a single test scenario manually(take query node pod is killed as instance):
1. update <code>ALL_CHAOS_YAMLS = 'chaos_querynode*.yaml'</code> in <code>constants.py</code>
2. run the commands below:
```bash
cd /milvus/tests20/python_client/chaos
pytest test_chaos.py --host x.x.x.x -v
```
### Nightly
still in planning