Skip to content

Commit 7178b0a

Browse files
committed
Make Example errors fatal.
1 parent 8eb9f0e commit 7178b0a

File tree

9 files changed

+62
-56
lines changed

9 files changed

+62
-56
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ package main
141141

142142
import (
143143
"fmt"
144+
"log"
144145

145146
"github.com/linkedin/goavro/v2"
146147
)
@@ -155,7 +156,7 @@ func main() {
155156
]
156157
}`)
157158
if err != nil {
158-
fmt.Println(err)
159+
log.Fatal(err)
159160
}
160161

161162
// NOTE: May omit fields when using default value
@@ -164,25 +165,25 @@ func main() {
164165
// Convert textual Avro data (in Avro JSON format) to native Go form
165166
native, _, err := codec.NativeFromTextual(textual)
166167
if err != nil {
167-
fmt.Println(err)
168+
log.Fatal(err)
168169
}
169170

170171
// Convert native Go form to binary Avro data
171172
binary, err := codec.BinaryFromNative(nil, native)
172173
if err != nil {
173-
fmt.Println(err)
174+
log.Fatal(err)
174175
}
175176

176177
// Convert binary Avro data back to native Go form
177178
native, _, err = codec.NativeFromBinary(binary)
178179
if err != nil {
179-
fmt.Println(err)
180+
log.Fatal(err)
180181
}
181182

182183
// Convert native Go form to textual Avro data
183184
textual, err = codec.TextualFromNative(nil, native)
184185
if err != nil {
185-
fmt.Println(err)
186+
log.Fatal(err)
186187
}
187188

188189
// NOTE: Textual encoding will show all fields, even those with values that
@@ -205,6 +206,7 @@ package main
205206
import (
206207
"bytes"
207208
"fmt"
209+
"log"
208210
"strings"
209211

210212
"github.com/linkedin/goavro/v2"
@@ -234,7 +236,7 @@ func main() {
234236
Schema: avroSchema,
235237
})
236238
if err != nil {
237-
fmt.Println(err)
239+
log.Fatal(err)
238240
}
239241
err = writer.Append([]map[string]interface{}{
240242
{
@@ -251,13 +253,13 @@ func main() {
251253
// Reading OCF data
252254
ocfReader, err := goavro.NewOCFReader(strings.NewReader(ocfFileContents.String()))
253255
if err != nil {
254-
fmt.Println(err)
256+
log.Fatal(err)
255257
}
256258
fmt.Println("Records in OCF File");
257259
for ocfReader.Scan() {
258260
record, err := ocfReader.Read()
259261
if err != nil {
260-
fmt.Println(err)
262+
log.Fatal(err)
261263
}
262264
fmt.Println("record", record)
263265
}
@@ -372,11 +374,11 @@ specified above.
372374
func ExampleUnion() {
373375
codec, err := goavro.NewCodec(`["null","string","int"]`)
374376
if err != nil {
375-
fmt.Println(err)
377+
log.Fatal(err)
376378
}
377379
buf, err := codec.TextualFromNative(nil, goavro.Union("string", "some string"))
378380
if err != nil {
379-
fmt.Println(err)
381+
log.Fatal(err)
380382
}
381383
fmt.Println(string(buf))
382384
// Output: {"string":"some string"}

codec.go

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ type codecBuilder struct {
9393
// ]
9494
// }`)
9595
// if err != nil {
96-
// fmt.Println(err)
96+
// log.Fatal(err)
9797
// }
9898
func NewCodec(schemaSpecification string) (*Codec, error) {
9999
return NewCodecFrom(schemaSpecification, &codecBuilder{
@@ -133,7 +133,7 @@ func NewCodec(schemaSpecification string) (*Codec, error) {
133133
// ]
134134
// }`)
135135
// if err != nil {
136-
// fmt.Println(err)
136+
// log.Fatal(err)
137137
// }
138138
//
139139
// The above will take json of this sort:
@@ -367,7 +367,7 @@ func newSymbolTable() map[string]*Codec {
367367
// ]
368368
// }`)
369369
// if err != nil {
370-
// fmt.Println(err)
370+
// log.Fatal(err)
371371
// }
372372
//
373373
// // Convert native Go form to binary Avro data
@@ -383,7 +383,7 @@ func newSymbolTable() map[string]*Codec {
383383
// },
384384
// })
385385
// if err != nil {
386-
// fmt.Println(err)
386+
// log.Fatal(err)
387387
// }
388388
//
389389
// fmt.Printf("%#v", binary)
@@ -413,15 +413,15 @@ func (c *Codec) BinaryFromNative(buf []byte, datum interface{}) ([]byte, error)
413413
// ]
414414
// }`)
415415
// if err != nil {
416-
// fmt.Println(err)
416+
// log.Fatal(err)
417417
// }
418418
//
419419
// // Convert native Go form to binary Avro data
420420
// binary := []byte{0x2, 0x2, 0x0}
421421
//
422422
// native, _, err := codec.NativeFromBinary(binary)
423423
// if err != nil {
424-
// fmt.Println(err)
424+
// log.Fatal(err)
425425
// }
426426
//
427427
// fmt.Printf("%v", native)
@@ -482,15 +482,15 @@ func (c *Codec) NativeFromSingle(buf []byte) (interface{}, []byte, error) {
482482
// ]
483483
// }`)
484484
// if err != nil {
485-
// fmt.Println(err)
485+
// log.Fatal(err)
486486
// }
487487
//
488488
// // Convert native Go form to text Avro data
489489
// text := []byte(`{"next":{"LongList":{"next":{"LongList":{"next":null}}}}}`)
490490
//
491491
// native, _, err := codec.NativeFromTextual(text)
492492
// if err != nil {
493-
// fmt.Println(err)
493+
// log.Fatal(err)
494494
// }
495495
//
496496
// fmt.Printf("%v", native)
@@ -553,7 +553,7 @@ func (c *Codec) SingleFromNative(buf []byte, datum interface{}) ([]byte, error)
553553
// ]
554554
// }`)
555555
// if err != nil {
556-
// fmt.Println(err)
556+
// log.Fatal(err)
557557
// }
558558
//
559559
// // Convert native Go form to text Avro data
@@ -569,7 +569,7 @@ func (c *Codec) SingleFromNative(buf []byte, datum interface{}) ([]byte, error)
569569
// },
570570
// })
571571
// if err != nil {
572-
// fmt.Println(err)
572+
// log.Fatal(err)
573573
// }
574574
//
575575
// fmt.Printf("%s", text)

codec_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ package goavro
1212
import (
1313
"bytes"
1414
"fmt"
15+
"log"
1516
"os"
1617
"testing"
1718
)
@@ -20,7 +21,7 @@ func ExampleCodec_CanonicalSchema() {
2021
schema := `{"type":"map","values":{"type":"enum","name":"foo","symbols":["alpha","bravo"]}}`
2122
codec, err := NewCodec(schema)
2223
if err != nil {
23-
fmt.Println(err)
24+
log.Fatal(err)
2425
} else {
2526
fmt.Println(codec.CanonicalSchema())
2627
}

doc.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Usage Example:
2929
]
3030
}`)
3131
if err != nil {
32-
fmt.Println(err)
32+
log.Fatal(err)
3333
}
3434
3535
// NOTE: May omit fields when using default value
@@ -38,25 +38,25 @@ Usage Example:
3838
// Convert textual Avro data (in Avro JSON format) to native Go form
3939
native, _, err := codec.NativeFromTextual(textual)
4040
if err != nil {
41-
fmt.Println(err)
41+
log.Fatal(err)
4242
}
4343
4444
// Convert native Go form to binary Avro data
4545
binary, err := codec.BinaryFromNative(nil, native)
4646
if err != nil {
47-
fmt.Println(err)
47+
log.Fatal(err)
4848
}
4949
5050
// Convert binary Avro data back to native Go form
5151
native, _, err = codec.NativeFromBinary(binary)
5252
if err != nil {
53-
fmt.Println(err)
53+
log.Fatal(err)
5454
}
5555
5656
// Convert native Go form to textual Avro data
5757
textual, err = codec.TextualFromNative(nil, native)
5858
if err != nil {
59-
fmt.Println(err)
59+
log.Fatal(err)
6060
}
6161
6262
// NOTE: Textual encoding will show all fields, even those with values that

logical_type_test.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ package goavro
1111

1212
import (
1313
"fmt"
14+
"log"
1415
"math"
1516
"math/big"
1617
"testing"
@@ -247,19 +248,19 @@ func ExampleUnion_logicalType() {
247248
// * decimal - big.Rat
248249
codec, err := NewCodec(`["null", {"type": "long", "logicalType": "timestamp-millis"}]`)
249250
if err != nil {
250-
fmt.Println(err)
251+
log.Fatal(err)
251252
}
252253

253254
// Note the usage of type.logicalType i.e. `long.timestamp-millis` to denote the type in a union. This is due to the single string naming format
254255
// used by goavro. Decimal can be both bytes.decimal or fixed.decimal
255256
bytes, err := codec.BinaryFromNative(nil, map[string]interface{}{"long.timestamp-millis": time.Date(2006, 1, 2, 15, 4, 5, 0, time.UTC)})
256257
if err != nil {
257-
fmt.Println(err)
258+
log.Fatal(err)
258259
}
259260

260261
decoded, _, err := codec.NativeFromBinary(bytes)
261262
if err != nil {
262-
fmt.Println(err)
263+
log.Fatal(err)
263264
}
264265
out := decoded.(map[string]interface{})
265266
fmt.Printf("%#v\n", out["long.timestamp-millis"].(time.Time).String())

record_test.go

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ package goavro
1212
import (
1313
"bytes"
1414
"fmt"
15+
"log"
1516
"testing"
1617
)
1718

@@ -456,7 +457,7 @@ func ExampleCodec_NativeFromTextual_roundTrip() {
456457
}
457458
`)
458459
if err != nil {
459-
fmt.Println(err)
460+
log.Fatal(err)
460461
}
461462

462463
// NOTE: May omit fields when using default value
@@ -465,25 +466,25 @@ func ExampleCodec_NativeFromTextual_roundTrip() {
465466
// Convert textual Avro data (in Avro JSON format) to native Go form
466467
native, _, err := codec.NativeFromTextual(textual)
467468
if err != nil {
468-
fmt.Println(err)
469+
log.Fatal(err)
469470
}
470471

471472
// Convert native Go form to binary Avro data
472473
binary, err := codec.BinaryFromNative(nil, native)
473474
if err != nil {
474-
fmt.Println(err)
475+
log.Fatal(err)
475476
}
476477

477478
// Convert binary Avro data back to native Go form
478479
native, _, err = codec.NativeFromBinary(binary)
479480
if err != nil {
480-
fmt.Println(err)
481+
log.Fatal(err)
481482
}
482483

483484
// Convert native Go form to textual Avro data
484485
textual, err = codec.TextualFromNative(nil, native)
485486
if err != nil {
486-
fmt.Println(err)
487+
log.Fatal(err)
487488
}
488489

489490
// NOTE: Textual encoding will show all fields, even those with values that
@@ -503,7 +504,7 @@ func ExampleCodec_BinaryFromNative_avro() {
503504
}
504505
`)
505506
if err != nil {
506-
fmt.Println(err)
507+
log.Fatal(err)
507508
}
508509

509510
// Convert native Go form to binary Avro data
@@ -519,7 +520,7 @@ func ExampleCodec_BinaryFromNative_avro() {
519520
},
520521
})
521522
if err != nil {
522-
fmt.Println(err)
523+
log.Fatal(err)
523524
}
524525

525526
fmt.Printf("%#v", binary)
@@ -537,15 +538,15 @@ func ExampleCodec_NativeFromBinary_avro() {
537538
}
538539
`)
539540
if err != nil {
540-
fmt.Println(err)
541+
log.Fatal(err)
541542
}
542543

543544
// Convert native Go form to binary Avro data
544545
binary := []byte{0x2, 0x2, 0x0}
545546

546547
native, _, err := codec.NativeFromBinary(binary)
547548
if err != nil {
548-
fmt.Println(err)
549+
log.Fatal(err)
549550
}
550551

551552
fmt.Printf("%v", native)
@@ -563,15 +564,15 @@ func ExampleCodec_NativeFromTextual_avro() {
563564
}
564565
`)
565566
if err != nil {
566-
fmt.Println(err)
567+
log.Fatal(err)
567568
}
568569

569570
// Convert native Go form to text Avro data
570571
text := []byte(`{"next":{"LongList":{"next":{"LongList":{"next":null}}}}}`)
571572

572573
native, _, err := codec.NativeFromTextual(text)
573574
if err != nil {
574-
fmt.Println(err)
575+
log.Fatal(err)
575576
}
576577

577578
fmt.Printf("%v", native)
@@ -589,7 +590,7 @@ func ExampleCodec_TextualFromNative_avro() {
589590
}
590591
`)
591592
if err != nil {
592-
fmt.Println(err)
593+
log.Fatal(err)
593594
}
594595

595596
// Convert native Go form to text Avro data
@@ -605,7 +606,7 @@ func ExampleCodec_TextualFromNative_avro() {
605606
},
606607
})
607608
if err != nil {
608-
fmt.Println(err)
609+
log.Fatal(err)
609610
}
610611

611612
fmt.Printf("%s", text)

schema_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ func TestSchemaFixedNameCanBeUsedLater(t *testing.T) {
137137
// schema := `{"type":"map","values":{"type":"enum","name":"foo","symbols":["alpha","bravo"]}}`
138138
// codec, err := NewCodec(schema)
139139
// if err != nil {
140-
// fmt.Println(err)
140+
// log.Fatal(err)
141141
// }
142142
// fmt.Println(codec.Schema())
143143
// // Output: {"type":"map","values":{"name":"foo","type":"enum","symbols":["alpha","bravo"]}}

0 commit comments

Comments
 (0)