Merge pull request #19767 from abdurrehman107/abdur-rehman/antithesis-itegration-pr-3

Add Antithesis package imports

Author: serathius

tests/antithesis/test-template/go-delete-keys/go.mod

@@ -7,6 +7,7 @@ toolchain go1.24.2
 require go.etcd.io/etcd/client/v3 v3.5.21
 
 require (
+	github.com/antithesishq/antithesis-sdk-go v0.4.3
 	github.com/coreos/go-semver v0.3.0 // indirect
 	github.com/coreos/go-systemd/v22 v22.3.2 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect

tests/antithesis/test-template/go-delete-keys/go.sum

@@ -1,3 +1,5 @@
+github.com/antithesishq/antithesis-sdk-go v0.4.3 h1:a2hGdDogClzHzFu20r1z0tzD6zwSWUipiaerAjZVP90=
+github.com/antithesishq/antithesis-sdk-go v0.4.3/go.mod h1:IUpT2DPAKh6i/YhSbt6Gl3v2yvUZjmKncl7U91fup7E=
 github.com/coreos/go-semver v0.3.0 h1:wkHLiw0WNATZnSG7epLsujiMCgPAc9xhjJ4tgnAxmfM=
 github.com/coreos/go-semver v0.3.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
 github.com/coreos/go-systemd/v22 v22.3.2 h1:D9/bQk5vlXQFZ6Kwuu6zaiXJ9oTPe68++AzAJc1DzSI=

tests/antithesis/test-template/go-delete-keys/serial_driver_delete_keys.go

@@ -6,47 +6,54 @@ import (
 	"os"
 	"time"
 
+	"github.com/antithesishq/antithesis-sdk-go/assert"
+	"github.com/antithesishq/antithesis-sdk-go/random"
 	clientv3 "go.etcd.io/etcd/client/v3"
 )
 
-// Connect to an etcd node
 func Connect() *clientv3.Client {
-	hosts := [][]string{[]string{"etcd0:2379"}, []string{"etcd1:2379"}, []string{"etcd2:2379"}}
-
-	// Randomly choose one host to connect to (just for simplicity)
-	host := hosts[0] // You can implement a random choice function here if needed
+	// This function returns a client connection to an etcd node
 
-	// Create an etcd client
+	hosts := [][]string{[]string{"etcd0:2379"}, []string{"etcd1:2379"}, []string{"etcd2:2379"}}
+	host := random.RandomChoice(hosts)
 	cli, err := clientv3.New(clientv3.Config{
 		Endpoints:   host,
 		DialTimeout: 5 * time.Second,
 	})
 	if err != nil {
 		log.Fatalf("Failed to connect to etcd: %v", err)
+		// Antithesis Assertion: client should always be able to connect to an etcd host
+		assert.Unreachable("Client failed to connect to an etcd host", map[string]interface{}{"host": host, "error": err})
 		os.Exit(1)
 	}
 	return cli
 }
 
-// This function will:
-// 1. Get all keys
-// 2. Select half of the keys received
-// 3. Attempt to delete the keys selected
-// 4. Check that the keys were deleted
 func DeleteKeys() {
+	// This function will:
+	// 1. Get all keys
+	// 2. Select half of the keys received
+	// 3. Attempt to delete the keys selected
+	// 4. Check that the keys were deleted
+
 	ctx := context.Background()
 
 	// Connect to an etcd node
 	cli := Connect()
 
-	// Get all keys with the prefix
+	// Get all keys
 	resp, err := cli.Get(ctx, "", clientv3.WithPrefix())
+
+	// Antithesis Assertion: sometimes get with prefix requests are successful. A failed request is OK since we expect them to happen.
+	assert.Sometimes(err == nil, "Client can make successful get all requests", map[string]interface{}{"error": err})
+	cli.Close()
+
 	if err != nil {
 		log.Printf("Client failed to get all keys: %v", err)
 		os.Exit(0)
 	}
 
-	// Choose half of the keys to delete
+	// Choose half of the keys
 	var keys []string
 	for _, k := range resp.Kvs {
 		keys = append(keys, string(k.Key))
@@ -57,10 +64,12 @@ func DeleteKeys() {
 	// Connect to a new etcd node
 	cli = Connect()
 
-	// Delete half of the selected keys
+	// Delete half of the keys chosen
 	var deletedKeys []string
 	for _, k := range halfKeys {
 		_, err := cli.Delete(ctx, k)
+		// Antithesis Assertion: sometimes delete requests are successful. A failed request is OK since we expect them to happen.
+		assert.Sometimes(err == nil, "Client can make successful delete requests", map[string]interface{}{"error": err})
 		if err != nil {
 			log.Printf("Failed to delete key %s: %v", k, err)
 		} else {
@@ -73,26 +82,24 @@ func DeleteKeys() {
 	// Connect to a new etcd node
 	cli = Connect()
 
-	// Check if the deleted keys exist
+	// Check to see if those keys were deleted / exist
 	for _, k := range deletedKeys {
 		resp, err := cli.Get(ctx, k)
+		// Antithesis Assertion: sometimes get requests are successful. A failed request is OK since we expect them to happen.
+		assert.Sometimes(err == nil, "Client can make successful get requests", map[string]interface{}{"error": err})
 		if err != nil {
 			log.Printf("Client failed to get key %s: %v", k, err)
 			continue
 		}
-
-		// Assert that the key was deleted correctly (now simply check if the key count is 0)
-		if resp.Count != 0 {
-			log.Printf("Key %s was not deleted correctly", k)
-		} else {
-			log.Printf("Key %s was deleted correctly", k)
-		}
+		// Antithesis Assertion: if we deleted a key, we should not get a value
+		assert.Always(resp.Count == 0, "Key was deleted correctly", map[string]interface{}{"key": k})
 	}
 	cli.Close()
 
-	log.Printf("Completion of key deleting check")
+	assert.Reachable("Completion of a key deleting check", nil)
+	log.Printf("Completion of a key deleting check")
 }
 
 func main() {
 	DeleteKeys()
-}
+}