Skip to content

Commit

Permalink
Mark etcd-local-tester as deprecated so we can remove it in future.
Browse files Browse the repository at this point in the history
Signed-off-by: James Blair <mail@jamesblair.net>
  • Loading branch information
jmhbnz committed Jan 28, 2025
1 parent 35d20d1 commit b2fba02
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions tools/local-tester/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# etcd local-tester

> [!WARNING]
> etcd-local-tester is now deprecated in favor of our much more comprehensive [robustness testing suite](https://github.com/etcd-io/etcd/tree/main/tests/robustness). In a future etcd release this historic tool will be removed as it is no longer maintained.
The etcd local-tester runs a fault injected cluster using local processes. It sets up an etcd cluster with unreliable network bridges on its peer and client interfaces. The cluster runs with a constant stream of `Put` requests to simulate client usage. A fault injection script periodically kills cluster members and disrupts bridge connectivity.

# Requirements
Expand Down
2 changes: 2 additions & 0 deletions tools/local-tester/bridge.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#!/bin/sh

echo "Warning: etcd-local-tester is now deprecated in favor of our robustness testing suite and will be removed in a future release."

exec tools/local-tester/bridge/bridge \
-delay-accept \
-reset-listen \
Expand Down
2 changes: 2 additions & 0 deletions tools/local-tester/bridge/bridge.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
// limitations under the License.

// Package main is the entry point for the local tester network bridge.
// Deprecated: etcd local tester is now deprecated. Use the etcd robustness
// testing suite instead to validate etcd behaviour under failure conditions.
package main

import (
Expand Down
2 changes: 2 additions & 0 deletions tools/local-tester/bridge/dispatch.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Deprecated: etcd local tester is now deprecated. Use the etcd robustness
// testing suite instead to validate etcd behaviour under failure conditions.
package main

import (
Expand Down

0 comments on commit b2fba02

Please sign in to comment.