Skip to content

Commit 5f0889f

Browse files
committed
docs: update README with correct Go version, relative paths, and file tree
1 parent 518cbeb commit 5f0889f

1 file changed

Lines changed: 13 additions & 16 deletions

File tree

grpc-protoscope/README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -263,18 +263,16 @@ On the next run (test mode), the `rand.Shuffle` may flip the inner field order,
263263

264264
### Prerequisites
265265

266-
- Go 1.21+
266+
- Go 1.26+
267267
- `protoc` compiler (only needed if modifying the `.proto` file)
268268

269269
### Run without Keploy
270270

271271
```bash
272272
# Terminal 1 — start the server
273-
cd /home/anju/grpc-protoscope
274273
go run ./server/
275274
276275
# Terminal 2 — call it (run multiple times to see different field orderings)
277-
cd /home/anju/grpc-protoscope
278276
go run ./client/
279277
go run ./client/
280278
go run ./client/
@@ -286,26 +284,26 @@ You'll see the facet entries printed in different orders across calls.
286284

287285
## 5. Reproducing the Bug with Keploy
288286

289-
### Step 1: Build Keploy from source (if needed)
287+
### Step 1: Install Keploy
288+
289+
Install Keploy using the [official installation guide](https://keploy.io/docs/server/installation/), or build from source:
290290

291291
```bash
292-
cd /home/anju/keploy
292+
git clone https://github.com/keploy/keploy.git && cd keploy
293293
go build -ldflags="-X main.apiServerURI=https://api.keploy.io" -o keploy
294+
export PATH=$PWD:$PATH
294295
```
295296

296297
### Step 2: Record a test case
297298

298299
```bash
299-
cd /home/anju/grpc-protoscope
300-
301300
# Start recording
302-
/home/anju/keploy/keploy record -c "go run ./server/"
301+
keploy record -c "go run ./server/"
303302
```
304303

305304
In another terminal, trigger the gRPC call:
306305

307306
```bash
308-
cd /home/anju/grpc-protoscope
309307
go run ./client/
310308
```
311309

@@ -314,8 +312,7 @@ Then press `Ctrl+C` in the recording terminal. Keploy saves the test case in `ke
314312
### Step 3: Replay (test mode)
315313

316314
```bash
317-
cd /home/anju/grpc-protoscope
318-
/home/anju/keploy/keploy test -c "go run ./server/"
315+
keploy test -c "go run ./server/"
319316
```
320317

321318
**Expected result:** Because `rand.Shuffle` randomizes field ordering each time, ~50% of test runs will produce a different wire order than the recording, triggering:
@@ -336,14 +333,14 @@ If the test passes (same random order happened to match), delete the `keploy/` f
336333
```
337334
grpc-protoscope/
338335
├── README.md ← This file
336+
├── go.mod
337+
├── go.sum
339338
├── proto/search.proto ← Protobuf schema matching the bug report structure
340339
├── searchpb/ ← Generated Go protobuf/gRPC code
341340
│ ├── search.pb.go
342341
│ └── search_grpc.pb.go
343342
├── server/main.go ← gRPC server with randomized wire field ordering
344-
├── client/main.go ← gRPC client that calls the Search RPC
345-
├── go.mod
346-
├── go.sum
347-
└── keploy/ ← Keploy test artifacts (created after recording)
348-
└── test-set-0/tests/test-1.yaml
343+
└── client/main.go ← gRPC client that calls the Search RPC
349344
```
345+
346+
> **Note:** The `keploy/` directory (test artifacts) is generated at runtime when you run `keploy record` and is not checked into the repository.

0 commit comments

Comments
 (0)