1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
|
package streamcache
import (
"bytes"
"io"
"math/rand"
"os"
"path/filepath"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper"
)
func createPipe(t *testing.T) (*pipeReader, *pipe) {
t.Helper()
f, err := os.Create(filepath.Join(testhelper.TempDir(t), "gitaly-streamcache-test"))
require.NoError(t, err)
pr, p, err := newPipe(f)
require.NoError(t, err)
t.Cleanup(func() {
_ = p.RemoveFile()
p.Close()
})
return pr, p
}
func writeBytes(w io.WriteCloser, buf []byte, progress *int64) error {
for i := 0; i < len(buf); i++ {
n, err := w.Write(buf[i : i+1])
if err != nil {
return err
}
if n != 1 {
return io.ErrShortWrite
}
if progress != nil {
atomic.AddInt64(progress, int64(n))
}
}
return w.Close()
}
func TestPipe(t *testing.T) {
pr, p := createPipe(t)
readers := []io.ReadCloser{pr}
defer func() {
for _, r := range readers {
r.Close()
}
}()
const N = 10
for len(readers) < N {
r, err := p.OpenReader()
require.NoError(t, err)
readers = append(readers, r)
}
output := make([]bytes.Buffer, N)
outErrors := make([]error, N)
wg := &sync.WaitGroup{}
for i := 0; i < N; i++ {
wg.Add(1)
go func(i int) {
defer wg.Done()
_, outErrors[i] = io.Copy(&output[i], readers[i])
}(i)
}
input := make([]byte, 4096)
n, err := rand.Read(input)
require.NoError(t, err)
require.Equal(t, len(input), n)
require.NoError(t, writeBytes(p, input, nil)) // write input only once
wg.Wait()
// Check that we read back the input N times
for i := 0; i < N; i++ {
require.Equal(t, input, output[i].Bytes())
require.NoError(t, outErrors[i])
}
}
func TestPipe_readAfterClose(t *testing.T) {
pr1, p := createPipe(t)
defer pr1.Close()
defer p.Close()
input := "hello world"
werr := make(chan error, 1)
go func() { werr <- writeBytes(p, []byte(input), nil) }()
out1, err := io.ReadAll(pr1)
require.NoError(t, err)
require.Equal(t, input, string(out1))
require.NoError(t, <-werr)
require.Equal(t, errWriterAlreadyClosed, p.Close(), "write end should already have been closed")
pr2, err := p.OpenReader()
require.NoError(t, err)
defer pr2.Close()
out2, err := io.ReadAll(pr2)
require.NoError(t, err)
require.Equal(t, input, string(out2))
}
func TestPipe_backpressure(t *testing.T) {
pr, p := createPipe(t)
defer p.Close()
defer pr.Close()
input := "hello world"
werr := make(chan error, 1)
var wprogress int64
go func() { werr <- writeBytes(p, []byte(input), &wprogress) }()
var output []byte
buf := make([]byte, 1)
_, err := io.ReadFull(pr, buf)
require.NoError(t, err)
output = append(output, buf...)
require.Eventually(t, func() bool {
return atomic.LoadInt64(&wprogress) == 2
}, time.Minute, time.Millisecond, "writer should have read 2 bytes")
// We should not see any progress until we try to read more bytes.
time.Sleep(10 * time.Millisecond)
require.Equal(t, int64(2), atomic.LoadInt64(&wprogress), "writer should be blocked after 2 bytes")
_, err = io.ReadFull(pr, buf)
require.NoError(t, err)
output = append(output, buf...)
require.Eventually(t, func() bool {
return atomic.LoadInt64(&wprogress) == 3
}, time.Minute, time.Millisecond, "writer should have been unblocked after having reading 1 byte")
rest, err := io.ReadAll(pr)
require.NoError(t, err)
output = append(output, rest...)
require.Equal(t, input, string(output))
require.NoError(t, <-werr, "writer should have been unblocked and should have finished")
}
func TestPipe_closeWhenAllReadersLeave(t *testing.T) {
pr1, p := createPipe(t)
defer p.Close()
defer pr1.Close()
werr := make(chan error, 1)
go func() { werr <- writeBytes(p, []byte("hello world"), nil) }()
pr2, err := p.OpenReader()
require.NoError(t, err)
defer pr2.Close()
// Sanity check
select {
case <-werr:
t.Fatal("writer should still be blocked")
default:
}
require.NoError(t, pr1.Close())
time.Sleep(1 * time.Millisecond)
select {
case <-werr:
t.Fatal("writer should still be blocked because there is still an active reader")
default:
}
buf := make([]byte, 1)
_, err = io.ReadFull(pr2, buf)
require.NoError(t, err)
require.Equal(t, "h", string(buf))
require.NoError(t, pr2.Close())
time.Sleep(1 * time.Millisecond)
require.Error(t, <-werr, "writer should see error if all readers close before writer is done")
}
type closeSpy struct {
namedWriteCloser
closed bool
}
func (cs *closeSpy) Close() error {
cs.closed = true
return cs.namedWriteCloser.Close()
}
// Closing the last reader _before_ closing the writer is a failure
// condition. After this happens, opening new readers should fail.
func TestPipe_closeWrongOrder(t *testing.T) {
f, err := os.Create(filepath.Join(testhelper.TempDir(t), "gitaly-streamcache-test"))
require.NoError(t, err)
cs := &closeSpy{namedWriteCloser: f}
pr, p, err := newPipe(cs)
require.NoError(t, err)
defer func() {
_ = p.RemoveFile()
p.Close()
}()
defer p.Close()
defer pr.Close()
_, err = io.WriteString(p, "hello")
require.NoError(t, err)
require.NoError(t, pr.Close(), "close last reader")
_, err = io.WriteString(p, "world")
require.Equal(t, errWrongCloseOrder, err, "writes should fail")
require.Equal(t, errWrongCloseOrder, p.Close(), "closing should fail")
require.True(t, cs.closed)
_, err = p.OpenReader()
require.Equal(t, errWrongCloseOrder, err, "opening should fail")
}
// Closing last reader after closing the writer is the happy path. After
// this happens, opening new readers should work.
func TestPipe_closeOrderHappy(t *testing.T) {
f, err := os.Create(filepath.Join(testhelper.TempDir(t), "gitaly-streamcache-test"))
require.NoError(t, err)
cs := &closeSpy{namedWriteCloser: f}
pr1, p, err := newPipe(cs)
require.NoError(t, err)
defer func() {
_ = p.RemoveFile()
p.Close()
}()
defer p.Close()
defer pr1.Close()
require.NoError(t, p.Close())
require.True(t, cs.closed)
out1, err := io.ReadAll(pr1)
require.NoError(t, err)
require.Empty(t, out1)
pr2, err := p.OpenReader()
require.NoError(t, err, "opening reader after normal close should succeed")
defer pr2.Close()
out2, err := io.ReadAll(pr2)
require.NoError(t, err)
require.Empty(t, out2)
}
func TestPipe_concurrency(t *testing.T) {
pr, p := createPipe(t)
defer p.Close()
defer pr.Close()
const N = 100
wg := &sync.WaitGroup{}
// Prime N new goroutines that will open a reader
start := make(chan struct{})
for i := 0; i < N; i++ {
wg.Add(1)
go func(i int) {
defer wg.Done()
<-start
// This OpenReader call may fail, depending on the order pr and p get
// closed, and whether the current goroutine runs before or after pr and
// p get closed.
if pr, err := p.OpenReader(); err == nil {
_ = pr.Close()
}
}(i)
}
for _, c := range []io.Closer{pr, p} {
wg.Add(1)
go func(c io.Closer) {
defer wg.Done()
<-start
// If pr closes before p, all subsequent calls to p.OpenReader() will
// fail. If p closes before pr, all subsequent calls to p.OpenReader()
// will succeed. We cannot predict which which happen here.
_ = c.Close()
}(c)
}
// Now we have 1 pipe with 1 reader. When we close start, both of them
// will close, and at the same time N new readers will try to open.
close(start)
wg.Wait()
}
|