Philip O'Toole
1 year ago
parent
9b65b45065
commit
f3f6611eb6
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@ -0,0 +1,157 @@
|
||||
package wal
|
||||
|
||||
import (
|
||||
"encoding/binary"
|
||||
"fmt"
|
||||
"io"
|
||||
)
|
||||
|
||||
// SQLite constants
|
||||
const (
|
||||
WALHeaderSize = 32
|
||||
WALFrameHeaderSize = 24
|
||||
)
|
||||
|
||||
// WALReader wraps an io.Reader and parses SQLite WAL frames.
|
||||
//
|
||||
// This reader verifies the salt & checksum integrity while it reads. It does
|
||||
// not enforce transaction boundaries (i.e. it may return uncommitted frames).
|
||||
// It is the responsibility of the caller to handle this.
|
||||
//
|
||||
// WALReader has been copied from the litefs source code. Many thanks to the
|
||||
// authors of that software. See https://github.com/superfly/litefs for more
|
||||
// details.
|
||||
type WALReader struct {
|
||||
r io.Reader
|
||||
frameN int
|
||||
|
||||
bo binary.ByteOrder
|
||||
pageSize uint32
|
||||
seq uint32
|
||||
|
||||
salt1, salt2 uint32
|
||||
chksum1, chksum2 uint32
|
||||
}
|
||||
|
||||
// NewWALReader returns a new instance of WALReader.
|
||||
func NewWALReader(r io.Reader) *WALReader {
|
||||
return &WALReader{r: r}
|
||||
}
|
||||
|
||||
// PageSize returns the page size from the header. Must call ReadHeader() first.
|
||||
func (r *WALReader) PageSize() uint32 { return r.pageSize }
|
||||
|
||||
// Offset returns the file offset of the last read frame.
|
||||
// Returns zero if no frames have been read.
|
||||
func (r *WALReader) Offset() int64 {
|
||||
if r.frameN == 0 {
|
||||
return 0
|
||||
}
|
||||
return WALHeaderSize + ((int64(r.frameN) - 1) * (WALFrameHeaderSize + int64(r.pageSize)))
|
||||
}
|
||||
|
||||
// ReadHeader reads the WAL header into the reader. Returns io.EOF if WAL is invalid.
|
||||
func (r *WALReader) ReadHeader() error {
|
||||
// If we have a partial WAL, then mark WAL as done.
|
||||
hdr := make([]byte, WALHeaderSize)
|
||||
if _, err := io.ReadFull(r.r, hdr); err == io.ErrUnexpectedEOF {
|
||||
return io.EOF
|
||||
} else if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Determine byte order of checksums.
|
||||
switch magic := binary.BigEndian.Uint32(hdr[0:]); magic {
|
||||
case 0x377f0682:
|
||||
r.bo = binary.LittleEndian
|
||||
case 0x377f0683:
|
||||
r.bo = binary.BigEndian
|
||||
default:
|
||||
return fmt.Errorf("invalid wal header magic: %x", magic)
|
||||
}
|
||||
|
||||
// If the header checksum doesn't match then we may have failed with
|
||||
// a partial WAL header write during checkpointing.
|
||||
chksum1 := binary.BigEndian.Uint32(hdr[24:])
|
||||
chksum2 := binary.BigEndian.Uint32(hdr[28:])
|
||||
if v0, v1 := WALChecksum(r.bo, 0, 0, hdr[:24]); v0 != chksum1 || v1 != chksum2 {
|
||||
return io.EOF
|
||||
}
|
||||
|
||||
// Verify version is correct.
|
||||
if version := binary.BigEndian.Uint32(hdr[4:]); version != 3007000 {
|
||||
return fmt.Errorf("unsupported wal version: %d", version)
|
||||
}
|
||||
|
||||
r.pageSize = binary.BigEndian.Uint32(hdr[8:])
|
||||
r.seq = binary.BigEndian.Uint32(hdr[12:])
|
||||
r.salt1 = binary.BigEndian.Uint32(hdr[16:])
|
||||
r.salt2 = binary.BigEndian.Uint32(hdr[20:])
|
||||
r.chksum1, r.chksum2 = chksum1, chksum2
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// ReadFrame reads the next frame from the WAL and returns the page number.
|
||||
// Returns io.EOF at the end of the valid WAL.
|
||||
func (r *WALReader) ReadFrame(data []byte) (pgno, commit uint32, err error) {
|
||||
if len(data) != int(r.pageSize) {
|
||||
return 0, 0, fmt.Errorf("WALReader.ReadFrame(): buffer size (%d) must match page size (%d)", len(data), r.pageSize)
|
||||
}
|
||||
|
||||
// Read WAL frame header.
|
||||
hdr := make([]byte, WALFrameHeaderSize)
|
||||
if _, err := io.ReadFull(r.r, hdr); err == io.ErrUnexpectedEOF {
|
||||
return 0, 0, io.EOF
|
||||
} else if err != nil {
|
||||
return 0, 0, err
|
||||
}
|
||||
|
||||
// Read WAL page data.
|
||||
if _, err := io.ReadFull(r.r, data); err == io.ErrUnexpectedEOF {
|
||||
return 0, 0, io.EOF
|
||||
} else if err != nil {
|
||||
return 0, 0, err
|
||||
}
|
||||
|
||||
// Verify salt matches the salt in the header.
|
||||
salt1 := binary.BigEndian.Uint32(hdr[8:])
|
||||
salt2 := binary.BigEndian.Uint32(hdr[12:])
|
||||
if r.salt1 != salt1 || r.salt2 != salt2 {
|
||||
return 0, 0, io.EOF
|
||||
}
|
||||
|
||||
// Verify the checksum is valid.
|
||||
chksum1 := binary.BigEndian.Uint32(hdr[16:])
|
||||
chksum2 := binary.BigEndian.Uint32(hdr[20:])
|
||||
r.chksum1, r.chksum2 = WALChecksum(r.bo, r.chksum1, r.chksum2, hdr[:8]) // frame header
|
||||
r.chksum1, r.chksum2 = WALChecksum(r.bo, r.chksum1, r.chksum2, data) // frame data
|
||||
if r.chksum1 != chksum1 || r.chksum2 != chksum2 {
|
||||
return 0, 0, io.EOF
|
||||
}
|
||||
|
||||
pgno = binary.BigEndian.Uint32(hdr[0:])
|
||||
commit = binary.BigEndian.Uint32(hdr[4:])
|
||||
|
||||
r.frameN++
|
||||
|
||||
return pgno, commit, nil
|
||||
}
|
||||
|
||||
// WALChecksum computes a running SQLite WAL checksum over a byte slice.
|
||||
func WALChecksum(bo binary.ByteOrder, s0, s1 uint32, b []byte) (uint32, uint32) {
|
||||
assert(len(b)%8 == 0, "misaligned checksum byte slice")
|
||||
|
||||
// Iterate over 8-byte units and compute checksum.
|
||||
for i := 0; i < len(b); i += 8 {
|
||||
s0 += bo.Uint32(b[i:]) + s1
|
||||
s1 += bo.Uint32(b[i+4:]) + s0
|
||||
}
|
||||
return s0, s1
|
||||
}
|
||||
|
||||
func assert(condition bool, msg string) {
|
||||
if !condition {
|
||||
panic("assertion failed: " + msg)
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,252 @@
|
||||
package wal
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestWALReader(t *testing.T) {
|
||||
t.Run("OK", func(t *testing.T) {
|
||||
buf := make([]byte, 4096)
|
||||
b, err := os.ReadFile("testdata/wal-reader/ok/wal")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// Initialize reader with header info.
|
||||
r := NewWALReader(bytes.NewReader(b))
|
||||
if err := r.ReadHeader(); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if got, want := r.PageSize(), uint32(4096); got != want {
|
||||
t.Fatalf("PageSize()=%d, want %d", got, want)
|
||||
} else if got, want := r.Offset(), int64(0); got != want {
|
||||
t.Fatalf("Offset()=%d, want %d", got, want)
|
||||
}
|
||||
|
||||
// Read first frame.
|
||||
if pgno, commit, err := r.ReadFrame(buf); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if got, want := pgno, uint32(1); got != want {
|
||||
t.Fatalf("pgno=%d, want %d", got, want)
|
||||
} else if got, want := commit, uint32(0); got != want {
|
||||
t.Fatalf("commit=%d, want %d", got, want)
|
||||
} else if !bytes.Equal(buf, b[56:4152]) {
|
||||
t.Fatal("page data mismatch")
|
||||
} else if got, want := r.Offset(), int64(32); got != want {
|
||||
t.Fatalf("Offset()=%d, want %d", got, want)
|
||||
}
|
||||
|
||||
// Read second frame. End of transaction.
|
||||
if pgno, commit, err := r.ReadFrame(buf); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if got, want := pgno, uint32(2); got != want {
|
||||
t.Fatalf("pgno=%d, want %d", got, want)
|
||||
} else if got, want := commit, uint32(2); got != want {
|
||||
t.Fatalf("commit=%d, want %d", got, want)
|
||||
} else if !bytes.Equal(buf, b[4176:8272]) {
|
||||
t.Fatal("page data mismatch")
|
||||
} else if got, want := r.Offset(), int64(4152); got != want {
|
||||
t.Fatalf("Offset()=%d, want %d", got, want)
|
||||
}
|
||||
|
||||
// Read third frame.
|
||||
if pgno, commit, err := r.ReadFrame(buf); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if got, want := pgno, uint32(2); got != want {
|
||||
t.Fatalf("pgno=%d, want %d", got, want)
|
||||
} else if got, want := commit, uint32(2); got != want {
|
||||
t.Fatalf("commit=%d, want %d", got, want)
|
||||
} else if !bytes.Equal(buf, b[8296:12392]) {
|
||||
t.Fatal("page data mismatch")
|
||||
} else if got, want := r.Offset(), int64(8272); got != want {
|
||||
t.Fatalf("Offset()=%d, want %d", got, want)
|
||||
}
|
||||
|
||||
if _, _, err := r.ReadFrame(buf); err != io.EOF {
|
||||
t.Fatalf("unexpected error: %s", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("SaltMismatch", func(t *testing.T) {
|
||||
buf := make([]byte, 4096)
|
||||
b, err := os.ReadFile("testdata/wal-reader/salt-mismatch/wal")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// Initialize reader with header info.
|
||||
r := NewWALReader(bytes.NewReader(b))
|
||||
if err := r.ReadHeader(); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if got, want := r.PageSize(), uint32(4096); got != want {
|
||||
t.Fatalf("PageSize()=%d, want %d", got, want)
|
||||
} else if got, want := r.Offset(), int64(0); got != want {
|
||||
t.Fatalf("Offset()=%d, want %d", got, want)
|
||||
}
|
||||
|
||||
// Read first frame.
|
||||
if pgno, commit, err := r.ReadFrame(buf); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if got, want := pgno, uint32(1); got != want {
|
||||
t.Fatalf("pgno=%d, want %d", got, want)
|
||||
} else if got, want := commit, uint32(0); got != want {
|
||||
t.Fatalf("commit=%d, want %d", got, want)
|
||||
} else if !bytes.Equal(buf, b[56:4152]) {
|
||||
t.Fatal("page data mismatch")
|
||||
}
|
||||
|
||||
// Read second frame. Salt has been altered so it doesn't match header.
|
||||
if _, _, err := r.ReadFrame(buf); err != io.EOF {
|
||||
t.Fatalf("unexpected error: %s", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("FrameChecksumMismatch", func(t *testing.T) {
|
||||
buf := make([]byte, 4096)
|
||||
b, err := os.ReadFile("testdata/wal-reader/frame-checksum-mismatch/wal")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// Initialize reader with header info.
|
||||
r := NewWALReader(bytes.NewReader(b))
|
||||
if err := r.ReadHeader(); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if got, want := r.PageSize(), uint32(4096); got != want {
|
||||
t.Fatalf("PageSize()=%d, want %d", got, want)
|
||||
} else if got, want := r.Offset(), int64(0); got != want {
|
||||
t.Fatalf("Offset()=%d, want %d", got, want)
|
||||
}
|
||||
|
||||
// Read first frame.
|
||||
if pgno, commit, err := r.ReadFrame(buf); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if got, want := pgno, uint32(1); got != want {
|
||||
t.Fatalf("pgno=%d, want %d", got, want)
|
||||
} else if got, want := commit, uint32(0); got != want {
|
||||
t.Fatalf("commit=%d, want %d", got, want)
|
||||
} else if !bytes.Equal(buf, b[56:4152]) {
|
||||
t.Fatal("page data mismatch")
|
||||
}
|
||||
|
||||
// Read second frame. Checksum has been altered so it doesn't match.
|
||||
if _, _, err := r.ReadFrame(buf); err != io.EOF {
|
||||
t.Fatalf("unexpected error: %s", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ZeroLength", func(t *testing.T) {
|
||||
r := NewWALReader(bytes.NewReader(nil))
|
||||
if err := r.ReadHeader(); err != io.EOF {
|
||||
t.Fatalf("unexpected error: %#v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("PartialHeader", func(t *testing.T) {
|
||||
r := NewWALReader(bytes.NewReader(make([]byte, 10)))
|
||||
if err := r.ReadHeader(); err != io.EOF {
|
||||
t.Fatalf("unexpected error: %#v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("BadMagic", func(t *testing.T) {
|
||||
r := NewWALReader(bytes.NewReader(make([]byte, 32)))
|
||||
if err := r.ReadHeader(); err == nil || err.Error() != `invalid wal header magic: 0` {
|
||||
t.Fatalf("unexpected error: %#v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("BadHeaderChecksum", func(t *testing.T) {
|
||||
data := []byte{
|
||||
0x37, 0x7f, 0x06, 0x83, 0x00, 0x00, 0x00, 0x00,
|
||||
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
||||
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
||||
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}
|
||||
r := NewWALReader(bytes.NewReader(data))
|
||||
if err := r.ReadHeader(); err != io.EOF {
|
||||
t.Fatalf("unexpected error: %#v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("BadHeaderVersion", func(t *testing.T) {
|
||||
data := []byte{
|
||||
0x37, 0x7f, 0x06, 0x83, 0x00, 0x00, 0x00, 0x01,
|
||||
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
||||
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
||||
0x15, 0x7b, 0x20, 0x92, 0xbb, 0xf8, 0x34, 0x1d}
|
||||
r := NewWALReader(bytes.NewReader(data))
|
||||
if err := r.ReadHeader(); err == nil || err.Error() != `unsupported wal version: 1` {
|
||||
t.Fatalf("unexpected error: %#v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ErrBufferSize", func(t *testing.T) {
|
||||
b, err := os.ReadFile("testdata/wal-reader/ok/wal")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// Initialize reader with header info.
|
||||
r := NewWALReader(bytes.NewReader(b))
|
||||
if err := r.ReadHeader(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, _, err := r.ReadFrame(make([]byte, 512)); err == nil || err.Error() != `WALReader.ReadFrame(): buffer size (512) must match page size (4096)` {
|
||||
t.Fatalf("unexpected error: %#v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ErrPartialFrameHeader", func(t *testing.T) {
|
||||
b, err := os.ReadFile("testdata/wal-reader/ok/wal")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
r := NewWALReader(bytes.NewReader(b[:40]))
|
||||
if err := r.ReadHeader(); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if _, _, err := r.ReadFrame(make([]byte, 4096)); err != io.EOF {
|
||||
t.Fatalf("unexpected error: %#v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ErrFrameHeaderOnly", func(t *testing.T) {
|
||||
b, err := os.ReadFile("testdata/wal-reader/ok/wal")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
r := NewWALReader(bytes.NewReader(b[:56]))
|
||||
if err := r.ReadHeader(); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if _, _, err := r.ReadFrame(make([]byte, 4096)); err != io.EOF {
|
||||
t.Fatalf("unexpected error: %#v", err)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ErrPartialFrameData", func(t *testing.T) {
|
||||
b, err := os.ReadFile("testdata/wal-reader/ok/wal")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
r := NewWALReader(bytes.NewReader(b[:1000]))
|
||||
if err := r.ReadHeader(); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if _, _, err := r.ReadFrame(make([]byte, 4096)); err != io.EOF {
|
||||
t.Fatalf("unexpected error: %#v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
type errWriter struct{ afterN int }
|
||||
|
||||
func (w *errWriter) Write(p []byte) (int, error) {
|
||||
if w.afterN -= len(p); w.afterN <= 0 {
|
||||
return 0, fmt.Errorf("write error occurred")
|
||||
}
|
||||
return len(p), nil
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading…
Reference in New Issue