Skip to content

Commit

Permalink
test(ci): switch all tests to sql backend (#18099)
Browse files Browse the repository at this point in the history
  • Loading branch information
yezizp2012 authored Oct 14, 2024
1 parent a348b8a commit f299941
Show file tree
Hide file tree
Showing 10 changed files with 131 additions and 179 deletions.
7 changes: 3 additions & 4 deletions ci/scripts/run-e2e-test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ if [[ $mode == "standalone" ]]; then
fi

if [[ $mode == "single-node" ]]; then
export RUST_MIN_STACK=4194304
source ci/scripts/single-node-utils.sh
fi

Expand All @@ -37,7 +36,7 @@ cluster_start() {
risedev clean-data
risedev pre-start-dev
start_standalone "$PREFIX_LOG"/standalone.log &
risedev dev standalone-minio-etcd
risedev dev standalone-minio-sqlite
elif [[ $mode == "single-node" ]]; then
mkdir -p "$PREFIX_LOG"
risedev clean-data
Expand Down Expand Up @@ -257,7 +256,7 @@ if [[ "$mode" == "standalone" ]]; then
risedev clean-data
risedev pre-start-dev
start_standalone_without_compactor "$PREFIX_LOG"/standalone.log &
risedev dev standalone-minio-etcd-compactor
risedev dev standalone-minio-sqlite-compactor
wait_standalone
if compactor_is_online
then
Expand All @@ -274,7 +273,7 @@ if [[ "$mode" == "standalone" ]]; then
risedev clean-data
risedev pre-start-dev
start_standalone "$PREFIX_LOG"/standalone.log &
risedev dev standalone-minio-etcd
risedev dev standalone-minio-sqlite
wait_standalone
if ! compactor_is_online
then
Expand Down
2 changes: 1 addition & 1 deletion ci/scripts/run-meta-backup-test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ cluster_start() {
risedev clean-data
risedev pre-start-dev
start_standalone "$PREFIX_LOG"/standalone.log &
risedev dev standalone-minio-etcd
risedev dev standalone-minio-sqlite
elif [[ $mode == "single-node" ]]; then
mkdir -p "$PREFIX_LOG"
risedev clean-data
Expand Down
11 changes: 6 additions & 5 deletions ci/scripts/standalone-utils.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ set -euo pipefail
export RW_PREFIX=$PWD/.risingwave
export PREFIX_BIN=$RW_PREFIX/bin
export PREFIX_LOG=$RW_PREFIX/log
export PREFIX_DATA=$RW_PREFIX/data
export RW_SQLITE_DB=$PREFIX_DATA/metadata.db

# NOTE(kwannoel): Compared to start_standalone below, we omitted the compactor-opts,
# so it should not start.
Expand All @@ -16,8 +18,8 @@ start_standalone_without_compactor() {
--advertise-addr 127.0.0.1:5690 \
--dashboard-host 127.0.0.1:5691 \
--prometheus-host 127.0.0.1:1250 \
--backend etcd \
--etcd-endpoints 127.0.0.1:2388 \
--backend sqlite \
--sql-endpoint sqlite://${RW_SQLITE_DB} \
--state-store hummock+minio://hummockadmin:[email protected]:9301/hummock001 \
--data-directory hummock_001" \
--compute-opts=" \
Expand All @@ -39,7 +41,6 @@ start_standalone_without_compactor() {

# You can fill up this section by consulting
# .risingwave/log/risedev.log, after calling `risedev d full`.
# It is expected that minio, etcd will be started after this is called.
start_standalone() {
RUST_BACKTRACE=1 \
"$PREFIX_BIN"/risingwave/standalone \
Expand All @@ -48,8 +49,8 @@ start_standalone() {
--advertise-addr 127.0.0.1:5690 \
--dashboard-host 127.0.0.1:5691 \
--prometheus-host 127.0.0.1:1250 \
--backend etcd \
--etcd-endpoints 127.0.0.1:2388 \
--backend sqlite \
--sql-endpoint sqlite://${RW_SQLITE_DB} \
--state-store hummock+minio://hummockadmin:[email protected]:9301/hummock001 \
--data-directory hummock_001" \
--compute-opts=" \
Expand Down
2 changes: 1 addition & 1 deletion ci/workflows/main-cron.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ steps:
config: ci/docker-compose.yml
mount-buildkite-agent: true
- ./ci/plugins/upload-failure-logs
timeout_in_minutes: 15
timeout_in_minutes: 25
retry: *auto-retry

- label: "slow end-to-end test (release)"
Expand Down
4 changes: 2 additions & 2 deletions ci/workflows/pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ steps:
config: ci/docker-compose.yml
mount-buildkite-agent: true
- ./ci/plugins/upload-failure-logs
timeout_in_minutes: 23
timeout_in_minutes: 30
retry: *auto-retry

- label: "slow end-to-end test"
Expand Down Expand Up @@ -154,7 +154,7 @@ steps:
config: ci/docker-compose.yml
mount-buildkite-agent: true
- ./ci/plugins/upload-failure-logs
timeout_in_minutes: 17
timeout_in_minutes: 25
retry: *auto-retry

- label: "end-to-end test for opendal (parallel)"
Expand Down
78 changes: 55 additions & 23 deletions docs/dev/src/connector/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Develop Connectors

This page describes the development workflow to develop connectors. For design docs, see

- [Source](./source.md)

RisingWave supports a lot of connectors (sources and sinks).
Expand All @@ -11,16 +12,21 @@ However, developing connectors is tricky because it involves external systems:
- The test relies on the configuration of the setup. e.g., the test needs to know the port of your Kafka in order to
- We need to do the setup for both CI and local development.

Our solution is: we resort to RiseDev, our all-in-one development tool, to help manage external systems and solve these problems.
Our solution is: we resort to RiseDev, our all-in-one development tool, to help manage external systems and solve these
problems.

Before going to the specific methods described in the sections below, the principles we should follow are:
- *environment-independent*: It should easy to start cluster and run tests on your own machine, other developers' machines, and CI.

- *environment-independent*: It should easy to start cluster and run tests on your own machine, other developers'
machines, and CI.
* Don't use hard-coded configurations (e.g., `localhost:9092` for Kafka).
* Don't write too many logic in `ci/scripts`. Let CI scripts be thin wrappers.
- *self-contained* tests: It should be straightforward to run one test case, without worrying about where is the script to prepare the test.
- *self-contained* tests: It should be straightforward to run one test case, without worrying about where is the script
to prepare the test.
* Don't put setup logic, running logic and verification logic of a test in different places.

Reference: for the full explanations of the difficulies and the design of our solution, see [here](https://github.com/risingwavelabs/risingwave/issues/12451#issuecomment-2051861048).
Reference: for the full explanations of the difficulies and the design of our solution,
see [here](https://github.com/risingwavelabs/risingwave/issues/12451#issuecomment-2051861048).

The following sections first walk you through what is the development workflow for
existing connectors, and finally explain how to extend the development framework to support a new connector.
Expand All @@ -29,18 +35,20 @@ existing connectors, and finally explain how to extend the development framework

## Set up the development environment

RiseDev supports starting external connector systems (e.g., Kafka, MySQL) just like how it starts the RisingWave cluster, and other standard systems used as part of the RisingWave Cluster (e.g., MinIO, etcd, Grafana).
RiseDev supports starting external connector systems (e.g., Kafka, MySQL) just like how it starts the RisingWave
cluster, and other standard systems used as part of the RisingWave Cluster (e.g., MinIO, etcd, Grafana).

You write the profile in `risedev.yml` (Or `risedev-profiles.user.yml` ), e.g., the following config includes Kafka and MySQL, which will be used to test sources.
You write the profile in `risedev.yml` (Or `risedev-profiles.user.yml` ), e.g., the following config includes Kafka and
MySQL, which will be used to test sources.

```yml
my-cool-profile:
steps:
# RisingWave cluster
- use: minio
- use: etcd
- use: sqlite
- use: meta-node
meta-backend: etcd
meta-backend: sqlite
- use: compute-node
- use: frontend
- use: compactor
Expand All @@ -66,9 +74,12 @@ For all config options of supported systems, check the comments in `template` se

### Escape hatch: `user-managed` mode

`user-managed` is a special config. When set to `true` , you will need to start the system by yourself. You may wonder why bother to add it to the RiseDev profile if you start it by yourself. In this case, the config will still be loaded by RiseDev, which will be useful in tests. See chapters below for more details.
`user-managed` is a special config. When set to `true` , you will need to start the system by yourself. You may wonder
why bother to add it to the RiseDev profile if you start it by yourself. In this case, the config will still be loaded
by RiseDev, which will be useful in tests. See chapters below for more details.

The `user-managed` mode can be used as a workaround to start a system that is not yet supported by RiseDev, or is buggy. It's also used to config the CI profile. (In CI, all services are pre-started by `ci/docker-compose.yml` )
The `user-managed` mode can be used as a workaround to start a system that is not yet supported by RiseDev, or is buggy.
It's also used to config the CI profile. (In CI, all services are pre-started by `ci/docker-compose.yml` )

Example of the config:

Expand All @@ -82,18 +93,23 @@ Example of the config:
## End-to-end tests
The e2e tests are written in `slt` files. There are 2 main points to note:

1. Use `system ok` to run `bash` commands to interact with external systems.
Use this to prepare the test data, and verify the results. The whole lifecycle of
a test case should be written in the same `slt` file.
2. Use `control substitution on` and then use environment variables to specify the config of the external systems, e.g., the port of Kafka.
2. Use `control substitution on` and then use environment variables to specify the config of the external systems, e.g.,
the port of Kafka.

Refer to the [sqllogictest-rs documentation](https://github.com/risinglightdb/sqllogictest-rs#extension-run-external-shell-commands) for the details of `system` and `substitution` .
Refer to
the [sqllogictest-rs documentation](https://github.com/risinglightdb/sqllogictest-rs#extension-run-external-shell-commands)
for the details of `system` and `substitution` .

---

Take Kafka as an example about how to the tests are written:

When you use `risedev d` to start the external services, related environment variables for Kafka will be available when you run `risedev slt`:
When you use `risedev d` to start the external services, related environment variables for Kafka will be available when
you run `risedev slt`:

```sh
RISEDEV_KAFKA_BOOTSTRAP_SERVERS="127.0.0.1:9092"
Expand Down Expand Up @@ -129,16 +145,20 @@ create source s0 (v1 int, v2 varchar) with (

See `src/risedevtool/src/risedev_env.rs` for variables supported for each service.

> Note again: You need to use `risedev d` to start the cluster, and then use `risedev slt` to run the tests. It doesn't work if you start the cluster by yourself without telling RiseDev, or you use raw `sqllogictest` binary directly.
> Note again: You need to use `risedev d` to start the cluster, and then use `risedev slt` to run the tests. It doesn't
> work if you start the cluster by yourself without telling RiseDev, or you use raw `sqllogictest` binary directly.
>
> How it works: `risedev d` will write env vars to `.risingwave/config/risedev-env`,
> and `risedev slt` will load env vars from this file.
### Tips for writing `system` commands

Refer to the [sqllogictest-rs documentation](https://github.com/risinglightdb/sqllogictest-rs#extension-run-external-shell-commands) for the syntax.
Refer to
the [sqllogictest-rs documentation](https://github.com/risinglightdb/sqllogictest-rs#extension-run-external-shell-commands)
for the syntax.

For simple cases, you can directly write a bash command, e.g.,

```
system ok
mysql -e "
Expand All @@ -156,13 +176,23 @@ cat << EOF | rpk topic produce my_source -f "%p %v\n" -p 0
EOF
```

For more complex cases, you can write a test script, and invoke it in `slt`. Scripts can be written in any language you like, but kindly write a `README.md` to help other developers get started more easily.
For more complex cases, you can write a test script, and invoke it in `slt`. Scripts can be written in any language you
like, but kindly write a `README.md` to help other developers get started more easily.

- For ad-hoc scripts (only used for one test), it's better to put next to the test file.

e.g., [`e2e_test/source_inline/kafka/consumer_group.mjs`](https://github.com/risingwavelabs/risingwave/blob/c22c4265052c2a4f2876132a10a0b522ec7c03c9/e2e_test/source_inline/kafka/consumer_group.mjs), which is invoked by [`consumer_group.slt`](https://github.com/risingwavelabs/risingwave/blob/c22c4265052c2a4f2876132a10a0b522ec7c03c9/e2e_test/source_inline/kafka/consumer_group.slt) next to it.
- For general scripts that can be used under many situations, put it in `e2e_test/commands/`. This directory will be loaded in `PATH` by `risedev slt`, and thus function as kind of "built-in" commands.
e.g., [`e2e_test/source_inline/kafka/consumer_group.mjs`](https://github.com/risingwavelabs/risingwave/blob/c22c4265052c2a4f2876132a10a0b522ec7c03c9/e2e_test/source_inline/kafka/consumer_group.mjs),
which is invoked
by [`consumer_group.slt`](https://github.com/risingwavelabs/risingwave/blob/c22c4265052c2a4f2876132a10a0b522ec7c03c9/e2e_test/source_inline/kafka/consumer_group.slt)
next to it.
- For general scripts that can be used under many situations, put it in `e2e_test/commands/`. This directory will be
loaded in `PATH` by `risedev slt`, and thus function as kind of "built-in" commands.

A common scenario is when a CLI tool does not accept envvars as arguments. In such cases, instead of manually specifying the arguments each time invoking it in `slt`, you can create a wrapper to handle this implicitly, making it more concise. [`e2e_test/commands/mysql`](https://github.com/risingwavelabs/risingwave/blob/c22c4265052c2a4f2876132a10a0b522ec7c03c9/e2e_test/commands/mysql) is a good demonstration.
A common scenario is when a CLI tool does not accept envvars as arguments. In such cases, instead of manually
specifying the arguments each time invoking it in `slt`, you can create a wrapper to handle this implicitly, making it
more
concise. [`e2e_test/commands/mysql`](https://github.com/risingwavelabs/risingwave/blob/c22c4265052c2a4f2876132a10a0b522ec7c03c9/e2e_test/commands/mysql)
is a good demonstration.

---
Tips for debugging:
Expand All @@ -176,14 +206,16 @@ Tips for debugging:
placeholder
```
Then running `risedev slt` will return error "result mismatch", and shows what's the output
of the `echo` command, i.e., the value of `PGPORT`.
Then running `risedev slt` will return error "result mismatch", and shows what's the output
of the `echo` command, i.e., the value of `PGPORT`.
- Use `risedev show-risedev-env` to see the environment variables available for `risedev slt`, after you starting the cluster with `risedev d`.
- Use `risedev show-risedev-env` to see the environment variables available for `risedev slt`, after you starting the
cluster with `risedev d`.
## Adding a new connector to the development framework
Refer to [#16449](https://github.com/risingwavelabs/risingwave/pull/16449) ( `user-managed` only MySQL), and [#16514](https://github.com/risingwavelabs/risingwave/pull/16514) (Docker based MySQL) as examples.
Refer to [#16449](https://github.com/risingwavelabs/risingwave/pull/16449) ( `user-managed` only MySQL),
and [#16514](https://github.com/risingwavelabs/risingwave/pull/16514) (Docker based MySQL) as examples.
1. Add a new service in `template` section of `risedev.yml`.
And add corresponding config in `src/risedevtool/src/service_config.rs` .
Expand Down
2 changes: 2 additions & 0 deletions e2e_test/ddl/secret.slt
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
statement ok
ALTER SYSTEM SET license_key TO '';

sleep 1s

statement error
create secret secret_1 with (
backend = 'fake-backend'
Expand Down
Loading

0 comments on commit f299941

Please sign in to comment.