Skip to content

Commit

Permalink
chore: update doc and name
Browse files Browse the repository at this point in the history
  • Loading branch information
yangbodong22011 committed Dec 5, 2024
1 parent e13c4b9 commit 899144e
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Summary: version: 6.2.0, total tests: 260, passed: 260, rate: 100.00%
```

## genhtml
您可以使用 `--genhtml` 选项来生成和此[网站](https://tair-opensource.github.io/compatibility-test-suite-for-redis/)相同的 html 报告。 请注意,当使用此选项时候,将会读取 [config.yaml](config.yaml) 文件中的配置进行测试,此时命令行中的 `specific-version` 将会被文件中的覆盖。
您可以使用 `--genhtml` 选项来生成和此[网站](https://tair-opensource.github.io/resp-compatibility/)相同的 html 报告。 请注意,当使用此选项时候,将会读取 [config.yaml](config.yaml) 文件中的配置进行测试,此时命令行中的 `specific-version` 将会被文件中的覆盖。
```
$ python3.9 resp_compatibility.py --testfile cts.json --genhtml --show-failed
directory html already exists, will be deleted and renewed.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# resp-compatibility

[![4.0](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/4.0.yaml/badge.svg)](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/4.0.yaml) [![5.0](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/5.0.yaml/badge.svg)](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/5.0.yaml) [![6.0](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/6.0.yaml/badge.svg)](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/6.0.yaml) [![6.2](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/6.2.yaml/badge.svg)](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/6.2.yaml) [![7.0](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/7.0.yaml/badge.svg)](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/7.0.yaml) [![7.2](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/7.2.yaml/badge.svg)](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/7.2.yaml) [![unstable](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/unstable.yaml/badge.svg)](https://github.com/tair-opensource/compatibility-test-suite-for-redis/actions/workflows/unstable.yaml)
[![4.0](https://github.com/tair-opensource/resp-compatibility/actions/workflows/4.0.yaml/badge.svg)](https://github.com/tair-opensource/resp-compatibility/actions/workflows/4.0.yaml) [![5.0](https://github.com/tair-opensource/resp-compatibility/actions/workflows/5.0.yaml/badge.svg)](https://github.com/tair-opensource/resp-compatibility/actions/workflows/5.0.yaml) [![6.0](https://github.com/tair-opensource/resp-compatibility/actions/workflows/6.0.yaml/badge.svg)](https://github.com/tair-opensource/resp-compatibility/actions/workflows/6.0.yaml) [![6.2](https://github.com/tair-opensource/resp-compatibility/actions/workflows/6.2.yaml/badge.svg)](https://github.com/tair-opensource/resp-compatibility/actions/workflows/6.2.yaml) [![7.0](https://github.com/tair-opensource/resp-compatibility/actions/workflows/7.0.yaml/badge.svg)](https://github.com/tair-opensource/resp-compatibility/actions/workflows/7.0.yaml) [![7.2](https://github.com/tair-opensource/resp-compatibility/actions/workflows/7.2.yaml/badge.svg)](https://github.com/tair-opensource/resp-compatibility/actions/workflows/7.2.yaml) [![unstable](https://github.com/tair-opensource/resp-compatibility/actions/workflows/unstable.yaml/badge.svg)](https://github.com/tair-opensource/resp-compatibility/actions/workflows/unstable.yaml)

resp-compatibility is used to test whether your redis-like database is compatible with Redis versions (such as
6.0, 7.0, etc.) [中文文档](README-CN.md)
Expand Down Expand Up @@ -60,7 +60,7 @@ Summary: version: 6.2.0, total tests: 260, passed: 260, rate: 100.00%
```

## genhtml
You can use `--genhtml` to generate a test report similar to the html of this [website](https://tair-opensource.github.io/compatibility-test-suite-for-redis/). It should be noted that this option will read the configuration in [config.yaml](config.yaml) for testing. Special attention needs to be paid, at this time the `specific-version` specified in your command line will be overwritten by the one in the configuration file.
You can use `--genhtml` to generate a test report similar to the html of this [website](https://tair-opensource.github.io/resp-compatibility/). It should be noted that this option will read the configuration in [config.yaml](config.yaml) for testing. Special attention needs to be paid, at this time the `specific-version` specified in your command line will be overwritten by the one in the configuration file.
```
$ python3.9 resp_compatibility.py --testfile cts.json --genhtml --show-failed
directory html already exists, will be deleted and renewed.
Expand Down
4 changes: 2 additions & 2 deletions Terraform/Aliyun/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ resource "alicloud_kvstore_instance" "my_tair_cluster" {
instance_class = "tair.rdb.with.proxy.1g"
instance_type = "Redis"
engine_version = "7.0"
shard_count = "8"
shard_count = "2"
zone_id = local.selected_zone_id
vswitch_id = alicloud_vswitch.my_vswitch.id
payment_type = "PostPaid"
Expand Down Expand Up @@ -145,7 +145,7 @@ resource "alicloud_kvstore_instance" "my_redis_cluster" {
instance_class = "redis.shard.with.proxy.small.ce"
instance_type = "Redis"
engine_version = "7.0"
shard_count = "8"
shard_count = "2"
zone_id = local.selected_zone_id
vswitch_id = alicloud_vswitch.my_vswitch.id
payment_type = "PostPaid"
Expand Down
2 changes: 1 addition & 1 deletion cts_refer.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> 1. The table content consists of the commands supported by CTS (compatibility-test-suite-for-redis) and their version information
> 1. The table content consists of the commands supported by CTS (resp-compatibility) and their version information
> 2. This table is generated based on the command JSON format description of Redis 7.2. If you have any doubts, you can refer to the relevant files
> 3. If the table information does not match the actual testing, please submit an Issue :)
- Supported major versions
Expand Down
2 changes: 1 addition & 1 deletion resp_compatibility.py
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ def generate_html_report(logdir, configs):
filepath = f"{logdir}/index.html"
html = open(filepath, "w")
html.write("This page is automatically generated by <a href=\"https://github.com/tair-opensource/"
"compatibility-test-suite-for-redis\">compatibility-test-suite-for-redis</a> "
"resp-compatibility\">resp-compatibility</a> "
"to show the compatibility of the following Redis-Like systems and different versions of Redis.<br><br>")

# Separate databases into cluster and standalone
Expand Down

0 comments on commit 899144e

Please sign in to comment.