diff --git a/.gitignore b/.gitignore index 320e53e..1d74e21 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1 @@ -_testdata/ -_testdata2/ -logfmt-fuzz.zip -logfmt.test.exe +.vscode/ diff --git a/.travis.yml b/.travis.yml index 25976da..5139309 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,6 +6,8 @@ go: - "1.9.x" - "1.10.x" - "1.11.x" + - "1.12.x" + - "1.13.x" - "tip" before_install: diff --git a/CHANGELOG.md b/CHANGELOG.md index 3455b8e..1a9a27b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.5.0] - 2020-01-03 + +### Changed +- Remove the dependency on github.com/kr/logfmt by [@ChrisHines] +- Move fuzz code to github.com/go-logfmt/fuzzlogfmt by [@ChrisHines] + ## [0.4.0] - 2018-11-21 ### Added @@ -30,6 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Decoder by [@ChrisHines] - MarshalKeyvals by [@ChrisHines] +[0.5.0]: https://github.com/go-logfmt/logfmt/compare/v0.4.0...v0.5.0 [0.4.0]: https://github.com/go-logfmt/logfmt/compare/v0.3.0...v0.4.0 [0.3.0]: https://github.com/go-logfmt/logfmt/compare/v0.2.0...v0.3.0 [0.2.0]: https://github.com/go-logfmt/logfmt/compare/v0.1.0...v0.2.0 diff --git a/decode-bench_test.go b/decode-bench_test.go index f66dc25..96d6a81 100644 --- a/decode-bench_test.go +++ b/decode-bench_test.go @@ -1,11 +1,8 @@ package logfmt import ( - "bufio" "bytes" "testing" - - kr "github.com/kr/logfmt" ) func BenchmarkDecodeKeyval(b *testing.B) { @@ -35,41 +32,3 @@ func BenchmarkDecodeKeyval(b *testing.B) { } } } - -func BenchmarkKRDecode(b *testing.B) { - const rows = 10000 - data := []byte{} - for i := 0; i < rows; i++ { - data = append(data, "a=1 b=\"bar\" ƒ=2h3s r=\"esc\\tmore stuff\" d x=sf \n"...) - } - - b.SetBytes(int64(len(data))) - b.ResetTimer() - for i := 0; i < b.N; i++ { - var ( - s = bufio.NewScanner(bytes.NewReader(data)) - err error - j = 0 - dh discardHandler - ) - for err == nil && s.Scan() { - err = kr.Unmarshal(s.Bytes(), &dh) - j++ - } - if err == nil { - err = s.Err() - } - if err != nil { - b.Errorf("got %v, want %v", err, nil) - } - if j != rows { - b.Errorf("got %v, want %v", j, rows) - } - } -} - -type discardHandler struct{} - -func (discardHandler) HandleLogfmt(key, val []byte) error { - return nil -} diff --git a/decode.go b/decode.go index 04e0eff..2013708 100644 --- a/decode.go +++ b/decode.go @@ -79,7 +79,7 @@ key: dec.pos += p if dec.pos > start { dec.key = line[start:dec.pos] - if multibyte && bytes.IndexRune(dec.key, utf8.RuneError) != -1 { + if multibyte && bytes.ContainsRune(dec.key, utf8.RuneError) { dec.syntaxError(invalidKeyError) return false } @@ -97,7 +97,7 @@ key: dec.pos += p if dec.pos > start { dec.key = line[start:dec.pos] - if multibyte && bytes.IndexRune(dec.key, utf8.RuneError) != -1 { + if multibyte && bytes.ContainsRune(dec.key, utf8.RuneError) { dec.syntaxError(invalidKeyError) return false } @@ -110,7 +110,7 @@ key: dec.pos = len(line) if dec.pos > start { dec.key = line[start:dec.pos] - if multibyte && bytes.IndexRune(dec.key, utf8.RuneError) != -1 { + if multibyte && bytes.ContainsRune(dec.key, utf8.RuneError) { dec.syntaxError(invalidKeyError) return false } diff --git a/fuzz.go b/fuzz.go deleted file mode 100644 index 6553b35..0000000 --- a/fuzz.go +++ /dev/null @@ -1,126 +0,0 @@ -// +build gofuzz - -package logfmt - -import ( - "bufio" - "bytes" - "fmt" - "io" - "reflect" - - kr "github.com/kr/logfmt" -) - -// Fuzz checks reserialized data matches -func Fuzz(data []byte) int { - parsed, err := parse(data) - if err != nil { - return 0 - } - var w1 bytes.Buffer - if err = write(parsed, &w1); err != nil { - panic(err) - } - parsed, err = parse(w1.Bytes()) - if err != nil { - panic(err) - } - var w2 bytes.Buffer - if err = write(parsed, &w2); err != nil { - panic(err) - } - if !bytes.Equal(w1.Bytes(), w2.Bytes()) { - panic(fmt.Sprintf("reserialized data does not match:\n%q\n%q\n", w1.Bytes(), w2.Bytes())) - } - return 1 -} - -// FuzzVsKR checks go-logfmt/logfmt against kr/logfmt -func FuzzVsKR(data []byte) int { - parsed, err := parse(data) - parsedKR, errKR := parseKR(data) - - // github.com/go-logfmt/logfmt is a stricter parser. It returns errors for - // more inputs than github.com/kr/logfmt. Ignore any inputs that have a - // stict error. - if err != nil { - return 0 - } - - // Fail if the more forgiving parser finds an error not found by the - // stricter parser. - if errKR != nil { - panic(fmt.Sprintf("unmatched error: %v", errKR)) - } - - if !reflect.DeepEqual(parsed, parsedKR) { - panic(fmt.Sprintf("parsers disagree:\n%+v\n%+v\n", parsed, parsedKR)) - } - return 1 -} - -type kv struct { - k, v []byte -} - -func parse(data []byte) ([][]kv, error) { - var got [][]kv - dec := NewDecoder(bytes.NewReader(data)) - for dec.ScanRecord() { - var kvs []kv - for dec.ScanKeyval() { - kvs = append(kvs, kv{dec.Key(), dec.Value()}) - } - got = append(got, kvs) - } - return got, dec.Err() -} - -func parseKR(data []byte) ([][]kv, error) { - var ( - s = bufio.NewScanner(bytes.NewReader(data)) - err error - h saveHandler - got [][]kv - ) - for err == nil && s.Scan() { - h.kvs = nil - err = kr.Unmarshal(s.Bytes(), &h) - got = append(got, h.kvs) - } - if err == nil { - err = s.Err() - } - return got, err -} - -type saveHandler struct { - kvs []kv -} - -func (h *saveHandler) HandleLogfmt(key, val []byte) error { - if len(key) == 0 { - key = nil - } - if len(val) == 0 { - val = nil - } - h.kvs = append(h.kvs, kv{key, val}) - return nil -} - -func write(recs [][]kv, w io.Writer) error { - enc := NewEncoder(w) - for _, rec := range recs { - for _, f := range rec { - if err := enc.EncodeKeyval(f.k, f.v); err != nil { - return err - } - } - if err := enc.EndRecord(); err != nil { - return err - } - } - return nil -} diff --git a/go.mod b/go.mod index 63d50f0..df71929 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ module github.com/go-logfmt/logfmt -require github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515 +go 1.13 diff --git a/go.sum b/go.sum deleted file mode 100644 index d0cdc16..0000000 --- a/go.sum +++ /dev/null @@ -1,2 +0,0 @@ -github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515 h1:T+h1c/A9Gawja4Y9mFVWj2vyii2bbUNDw3kt9VxK2EY= -github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=