|
| 1 | +// Copyright 2025 The Cockroach Authors. |
| 2 | +// |
| 3 | +// Use of this software is governed by the CockroachDB Software License |
| 4 | +// included in the /LICENSE file. |
| 5 | + |
| 6 | +package ioctx |
| 7 | + |
| 8 | +import ( |
| 9 | + "context" |
| 10 | + "io" |
| 11 | + "testing" |
| 12 | + |
| 13 | + "github.com/cockroachdb/errors" |
| 14 | + "github.com/stretchr/testify/require" |
| 15 | +) |
| 16 | + |
| 17 | +// mockReadCloserCtx is a mock that implements ReadCloserCtx, ReaderAtCtx, and SeekerCtx |
| 18 | +type mockReadCloserCtx struct { |
| 19 | + data []byte |
| 20 | + pos int64 |
| 21 | + closed bool |
| 22 | + seekCalls int |
| 23 | + readCalls int |
| 24 | +} |
| 25 | + |
| 26 | +func newMockReadCloserCtx(data []byte) *mockReadCloserCtx { |
| 27 | + return &mockReadCloserCtx{ |
| 28 | + data: data, |
| 29 | + } |
| 30 | +} |
| 31 | + |
| 32 | +func (m *mockReadCloserCtx) Read(ctx context.Context, p []byte) (int, error) { |
| 33 | + m.readCalls++ |
| 34 | + if m.pos >= int64(len(m.data)) { |
| 35 | + return 0, io.EOF |
| 36 | + } |
| 37 | + n := copy(p, m.data[m.pos:]) |
| 38 | + m.pos += int64(n) |
| 39 | + return n, nil |
| 40 | +} |
| 41 | + |
| 42 | +func (m *mockReadCloserCtx) Close(ctx context.Context) error { |
| 43 | + m.closed = true |
| 44 | + return nil |
| 45 | +} |
| 46 | + |
| 47 | +func (m *mockReadCloserCtx) ReadAt(ctx context.Context, p []byte, off int64) (int, error) { |
| 48 | + if off >= int64(len(m.data)) { |
| 49 | + return 0, io.EOF |
| 50 | + } |
| 51 | + n := copy(p, m.data[off:]) |
| 52 | + if n < len(p) { |
| 53 | + return n, io.EOF |
| 54 | + } |
| 55 | + return n, nil |
| 56 | +} |
| 57 | + |
| 58 | +func (m *mockReadCloserCtx) Seek(ctx context.Context, offset int64, whence int) (int64, error) { |
| 59 | + m.seekCalls++ |
| 60 | + var newPos int64 |
| 61 | + switch whence { |
| 62 | + case io.SeekStart: |
| 63 | + newPos = offset |
| 64 | + case io.SeekCurrent: |
| 65 | + newPos = m.pos + offset |
| 66 | + case io.SeekEnd: |
| 67 | + newPos = int64(len(m.data)) + offset |
| 68 | + default: |
| 69 | + return 0, errors.Newf("invalid whence: %d", whence) |
| 70 | + } |
| 71 | + |
| 72 | + if newPos < 0 { |
| 73 | + return 0, errors.New("negative position") |
| 74 | + } |
| 75 | + |
| 76 | + m.pos = newPos |
| 77 | + return newPos, nil |
| 78 | +} |
| 79 | + |
| 80 | +// mockReadCloserCtxNoSeek implements ReadCloserCtx but NOT SeekerCtx |
| 81 | +type mockReadCloserCtxNoSeek struct { |
| 82 | + data []byte |
| 83 | + pos int64 |
| 84 | +} |
| 85 | + |
| 86 | +func (m *mockReadCloserCtxNoSeek) Read(ctx context.Context, p []byte) (int, error) { |
| 87 | + if m.pos >= int64(len(m.data)) { |
| 88 | + return 0, io.EOF |
| 89 | + } |
| 90 | + n := copy(p, m.data[m.pos:]) |
| 91 | + m.pos += int64(n) |
| 92 | + return n, nil |
| 93 | +} |
| 94 | + |
| 95 | +func (m *mockReadCloserCtxNoSeek) Close(ctx context.Context) error { |
| 96 | + return nil |
| 97 | +} |
| 98 | + |
| 99 | +func (m *mockReadCloserCtxNoSeek) ReadAt(ctx context.Context, p []byte, off int64) (int, error) { |
| 100 | + if off >= int64(len(m.data)) { |
| 101 | + return 0, io.EOF |
| 102 | + } |
| 103 | + n := copy(p, m.data[off:]) |
| 104 | + if n < len(p) { |
| 105 | + return n, io.EOF |
| 106 | + } |
| 107 | + return n, nil |
| 108 | +} |
| 109 | + |
| 110 | +// mockReadCloserCtxBrokenSeek implements SeekerCtx but Seek always fails |
| 111 | +type mockReadCloserCtxBrokenSeek struct { |
| 112 | + data []byte |
| 113 | + pos int64 |
| 114 | +} |
| 115 | + |
| 116 | +func (m *mockReadCloserCtxBrokenSeek) Read(ctx context.Context, p []byte) (int, error) { |
| 117 | + if m.pos >= int64(len(m.data)) { |
| 118 | + return 0, io.EOF |
| 119 | + } |
| 120 | + n := copy(p, m.data[m.pos:]) |
| 121 | + m.pos += int64(n) |
| 122 | + return n, nil |
| 123 | +} |
| 124 | + |
| 125 | +func (m *mockReadCloserCtxBrokenSeek) Close(ctx context.Context) error { |
| 126 | + return nil |
| 127 | +} |
| 128 | + |
| 129 | +func (m *mockReadCloserCtxBrokenSeek) ReadAt( |
| 130 | + ctx context.Context, p []byte, off int64, |
| 131 | +) (int, error) { |
| 132 | + if off >= int64(len(m.data)) { |
| 133 | + return 0, io.EOF |
| 134 | + } |
| 135 | + n := copy(p, m.data[off:]) |
| 136 | + if n < len(p) { |
| 137 | + return n, io.EOF |
| 138 | + } |
| 139 | + return n, nil |
| 140 | +} |
| 141 | + |
| 142 | +func (m *mockReadCloserCtxBrokenSeek) Seek( |
| 143 | + ctx context.Context, offset int64, whence int, |
| 144 | +) (int64, error) { |
| 145 | + return 0, errors.New("seek operation failed") |
| 146 | +} |
| 147 | + |
| 148 | +func TestReaderAtSeekerAdapterBasicOperations(t *testing.T) { |
| 149 | + ctx := context.Background() |
| 150 | + testData := []byte("Hello, World! This is test data for seeking.") |
| 151 | + mock := newMockReadCloserCtx(testData) |
| 152 | + |
| 153 | + adapter, err := ReaderAtSeekerAdapter(ctx, mock) |
| 154 | + require.NoError(t, err) |
| 155 | + require.NotNil(t, adapter) |
| 156 | + |
| 157 | + // Test that the initial seek test was called |
| 158 | + require.Equal(t, 1, mock.seekCalls, "adapter should test seek during construction") |
| 159 | + |
| 160 | + // Test Read |
| 161 | + buf := make([]byte, 5) |
| 162 | + n, err := adapter.Read(buf) |
| 163 | + require.NoError(t, err) |
| 164 | + require.Equal(t, 5, n) |
| 165 | + require.Equal(t, []byte("Hello"), buf) |
| 166 | + |
| 167 | + // Test ReadAt (should read at specific offset) |
| 168 | + buf = make([]byte, 5) |
| 169 | + n, err = adapter.ReadAt(buf, 7) |
| 170 | + require.NoError(t, err) |
| 171 | + require.Equal(t, 5, n) |
| 172 | + require.Equal(t, []byte("World"), buf) |
| 173 | + |
| 174 | + // Test Seek to start |
| 175 | + pos, err := adapter.Seek(0, io.SeekStart) |
| 176 | + require.NoError(t, err) |
| 177 | + require.Equal(t, int64(0), pos) |
| 178 | + |
| 179 | + // Test Seek current |
| 180 | + pos, err = adapter.Seek(5, io.SeekCurrent) |
| 181 | + require.NoError(t, err) |
| 182 | + require.Equal(t, int64(5), pos) |
| 183 | + |
| 184 | + // Test Seek from end |
| 185 | + pos, err = adapter.Seek(-5, io.SeekEnd) |
| 186 | + require.NoError(t, err) |
| 187 | + require.Equal(t, int64(len(testData)-5), pos) |
| 188 | + |
| 189 | + // Test Close |
| 190 | + err = adapter.Close() |
| 191 | + require.NoError(t, err) |
| 192 | + require.True(t, mock.closed) |
| 193 | +} |
| 194 | + |
| 195 | +func TestReaderAtSeekerAdapterMissingReaderAtCtx(t *testing.T) { |
| 196 | + ctx := context.Background() |
| 197 | + |
| 198 | + // Create a reader that doesn't implement ReaderAtCtx |
| 199 | + reader := ReadCloserAdapter(io.NopCloser(nil)) |
| 200 | + |
| 201 | + adapter, err := ReaderAtSeekerAdapter(ctx, reader) |
| 202 | + require.Error(t, err) |
| 203 | + require.Nil(t, adapter) |
| 204 | + require.Contains(t, err.Error(), "does not implement ioctx.ReaderAtCtx") |
| 205 | +} |
| 206 | + |
| 207 | +func TestReaderAtSeekerAdapterMissingSeekerCtx(t *testing.T) { |
| 208 | + ctx := context.Background() |
| 209 | + |
| 210 | + // Create a reader that implements ReaderAtCtx but not SeekerCtx |
| 211 | + reader := &mockReadCloserCtxNoSeek{ |
| 212 | + data: []byte("test data"), |
| 213 | + } |
| 214 | + |
| 215 | + adapter, err := ReaderAtSeekerAdapter(ctx, reader) |
| 216 | + require.Error(t, err) |
| 217 | + require.Nil(t, adapter) |
| 218 | + require.Contains(t, err.Error(), "does not implement ioctx.SeekerCtx") |
| 219 | +} |
| 220 | + |
| 221 | +func TestReaderAtSeekerAdapterBrokenSeek(t *testing.T) { |
| 222 | + ctx := context.Background() |
| 223 | + |
| 224 | + // Create a reader that implements SeekerCtx but seek fails |
| 225 | + reader := &mockReadCloserCtxBrokenSeek{ |
| 226 | + data: []byte("test data"), |
| 227 | + } |
| 228 | + |
| 229 | + adapter, err := ReaderAtSeekerAdapter(ctx, reader) |
| 230 | + require.Error(t, err) |
| 231 | + require.Nil(t, adapter) |
| 232 | + require.Contains(t, err.Error(), "test seek failed") |
| 233 | +} |
| 234 | + |
| 235 | +func TestReaderAtSeekerAdapterReadAtEOF(t *testing.T) { |
| 236 | + ctx := context.Background() |
| 237 | + testData := []byte("short") |
| 238 | + mock := newMockReadCloserCtx(testData) |
| 239 | + |
| 240 | + adapter, err := ReaderAtSeekerAdapter(ctx, mock) |
| 241 | + require.NoError(t, err) |
| 242 | + |
| 243 | + // Try to read past EOF |
| 244 | + buf := make([]byte, 10) |
| 245 | + n, err := adapter.ReadAt(buf, int64(len(testData))) |
| 246 | + require.Equal(t, io.EOF, err) |
| 247 | + require.Equal(t, 0, n) |
| 248 | +} |
| 249 | + |
| 250 | +func TestReaderAtSeekerAdapterInvalidSeek(t *testing.T) { |
| 251 | + ctx := context.Background() |
| 252 | + testData := []byte("test data") |
| 253 | + mock := newMockReadCloserCtx(testData) |
| 254 | + |
| 255 | + adapter, err := ReaderAtSeekerAdapter(ctx, mock) |
| 256 | + require.NoError(t, err) |
| 257 | + |
| 258 | + // Negative position |
| 259 | + _, err = adapter.Seek(-10, io.SeekStart) |
| 260 | + require.Error(t, err) |
| 261 | + require.Contains(t, err.Error(), "negative position") |
| 262 | +} |
0 commit comments