docs(pier,seaglass,sunrise,sunscreen,tide): compile README Go examples via src= (quick-261118-qsd)

This commit is contained in:
Jakub Zych
2026-11-18 20:04:47 +01:00
parent 6409837b0c
commit cd55a3980d
9 changed files with 449 additions and 69 deletions

View File

@@ -41,38 +41,48 @@ Use cases:
Record a flow once against the reference backend, then replay it against the port:
```go
spec, err := tide.LoadFlow("testdata/parity/posts.spec.yaml")
if err != nil {
return err
}
flow, err := tide.RecordFlow(ctx, spec, tide.RecordConfig{Target: "http://127.0.0.1:8000"})
if err != nil {
return err
}
if err := tide.SaveFlow("testdata/parity/posts.yaml", flow); err != nil {
return err
}
res, err := tide.ReplayFlow(ctx, flow, tide.ReplayConfig{
Target: "http://127.0.0.1:8080",
BaseDir: "testdata/parity",
})
if err != nil {
return err
}
for _, step := range res.Steps {
for _, d := range step.Diffs {
fmt.Printf("%s %s: want %s, got %s\n", step.ID, d.Path, d.Expected, d.Actual)
```go src=modules/tide/example_test.go#parity
// parity records the flow spec kept in dir against the reference backend
// once, saves the recorded flow next to it, then replays it against the
// port and prints every difference to w.
func parity(ctx context.Context, dir, reference, port string, w io.Writer) error {
spec, err := tide.LoadFlow(filepath.Join(dir, "posts.spec.yaml"))
if err != nil {
return err
}
flow, err := tide.RecordFlow(ctx, spec, tide.RecordConfig{Target: reference})
if err != nil {
return err
}
if err := tide.SaveFlow(filepath.Join(dir, "posts.yaml"), flow); err != nil {
return err
}
res, err := tide.ReplayFlow(ctx, flow, tide.ReplayConfig{
Target: port,
BaseDir: dir,
})
var mismatch *tide.MismatchError
if errors.As(err, &mismatch) {
res = mismatch.Result // a difference is an error carrying the result
} else if err != nil {
return err
}
for _, step := range res.Steps {
for _, d := range step.Diffs {
fmt.Fprintf(w, "%s %s: want %s, got %s\n", step.ID, d.Path, d.Expected, d.Actual)
}
}
return nil
}
```
Record the publications a reference backend sends for one flow step, then compare a new backend's publications with them:
```go
```go src=modules/tide/example_test.go#broadcasts
golden, err := tide.RecordBroadcasts(ctx, spec, tide.BroadcastConfig{
Target: "http://127.0.0.1:8000",
Target: reference, // a loopback URL such as http://127.0.0.1:8000
Listen: listen, // empty: tide.DefaultCentrifugoListen
APIKey: "test-only-key",
Store: store,
Step: "delete",
@@ -81,7 +91,7 @@ golden, err := tide.RecordBroadcasts(ctx, spec, tide.BroadcastConfig{
if err != nil {
return err
}
if err := tide.WriteBroadcastGolden("testdata/broadcasts/deleted.yaml", golden); err != nil {
if err := tide.WriteBroadcastGolden(filepath.Join(dir, "deleted.yaml"), golden); err != nil {
return err
}
@@ -91,7 +101,7 @@ if err != nil {
return err
}
for _, d := range tide.DiffPublications(golden.Publications, norm) {
fmt.Printf("%s: want %s, got %s\n", d.Path, d.Expected, d.Actual)
fmt.Fprintf(w, "%s: want %s, got %s\n", d.Path, d.Expected, d.Actual)
}
```