1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
22 "github.com/ghodss/yaml"
23 "github.com/prometheus/client_golang/prometheus"
24 check "gopkg.in/check.v1"
27 type TestableUnixVolume struct {
32 func NewTestableUnixVolume(t TB, serialize bool, readonly bool) *TestableUnixVolume {
33 d, err := ioutil.TempDir("", "volume_test")
37 var locker sync.Locker
39 locker = &sync.Mutex{}
41 return &TestableUnixVolume{
42 UnixVolume: UnixVolume{
51 // PutRaw writes a Keep block directly into a UnixVolume, even if
52 // the volume is readonly.
53 func (v *TestableUnixVolume) PutRaw(locator string, data []byte) {
54 defer func(orig bool) {
58 err := v.Put(context.Background(), locator, data)
64 func (v *TestableUnixVolume) TouchWithDate(locator string, lastPut time.Time) {
65 err := syscall.Utime(v.blockPath(locator), &syscall.Utimbuf{lastPut.Unix(), lastPut.Unix()})
71 func (v *TestableUnixVolume) Teardown() {
72 if err := os.RemoveAll(v.Root); err != nil {
77 // serialize = false; readonly = false
78 func TestUnixVolumeWithGenericTests(t *testing.T) {
79 DoGenericVolumeTests(t, func(t TB) TestableVolume {
80 return NewTestableUnixVolume(t, false, false)
84 // serialize = false; readonly = true
85 func TestUnixVolumeWithGenericTestsReadOnly(t *testing.T) {
86 DoGenericVolumeTests(t, func(t TB) TestableVolume {
87 return NewTestableUnixVolume(t, false, true)
91 // serialize = true; readonly = false
92 func TestUnixVolumeWithGenericTestsSerialized(t *testing.T) {
93 DoGenericVolumeTests(t, func(t TB) TestableVolume {
94 return NewTestableUnixVolume(t, true, false)
98 // serialize = false; readonly = false
99 func TestUnixVolumeHandlersWithGenericVolumeTests(t *testing.T) {
100 DoHandlersWithGenericVolumeTests(t, func(t TB) (*RRVolumeManager, []TestableVolume) {
101 vols := make([]Volume, 2)
102 testableUnixVols := make([]TestableVolume, 2)
104 for i := range vols {
105 v := NewTestableUnixVolume(t, false, false)
107 testableUnixVols[i] = v
110 return MakeRRVolumeManager(vols), testableUnixVols
114 func TestReplicationDefault1(t *testing.T) {
119 metrics := newVolumeMetricsVecs(prometheus.NewRegistry())
120 if err := v.Start(metrics.opsCounters, metrics.errCounters, metrics.ioBytes); err != nil {
123 if got := v.Replication(); got != 1 {
124 t.Errorf("Replication() returned %d, expected 1 if no config given", got)
128 func TestGetNotFound(t *testing.T) {
129 v := NewTestableUnixVolume(t, false, false)
131 v.Put(context.Background(), TestHash, TestBlock)
133 buf := make([]byte, BlockSize)
134 n, err := v.Get(context.Background(), TestHash2, buf)
136 case os.IsNotExist(err):
139 t.Errorf("Read should have failed, returned %+q", buf[:n])
141 t.Errorf("Read expected ErrNotExist, got: %s", err)
145 func TestPut(t *testing.T) {
146 v := NewTestableUnixVolume(t, false, false)
149 err := v.Put(context.Background(), TestHash, TestBlock)
153 p := fmt.Sprintf("%s/%s/%s", v.Root, TestHash[:3], TestHash)
154 if buf, err := ioutil.ReadFile(p); err != nil {
156 } else if bytes.Compare(buf, TestBlock) != 0 {
157 t.Errorf("Write should have stored %s, did store %s",
158 string(TestBlock), string(buf))
162 func TestPutBadVolume(t *testing.T) {
163 v := NewTestableUnixVolume(t, false, false)
166 os.Chmod(v.Root, 000)
167 err := v.Put(context.Background(), TestHash, TestBlock)
169 t.Error("Write should have failed")
173 func TestUnixVolumeReadonly(t *testing.T) {
174 v := NewTestableUnixVolume(t, false, true)
177 v.PutRaw(TestHash, TestBlock)
179 buf := make([]byte, BlockSize)
180 _, err := v.Get(context.Background(), TestHash, buf)
182 t.Errorf("got err %v, expected nil", err)
185 err = v.Put(context.Background(), TestHash, TestBlock)
186 if err != MethodDisabledError {
187 t.Errorf("got err %v, expected MethodDisabledError", err)
190 err = v.Touch(TestHash)
191 if err != MethodDisabledError {
192 t.Errorf("got err %v, expected MethodDisabledError", err)
195 err = v.Trash(TestHash)
196 if err != MethodDisabledError {
197 t.Errorf("got err %v, expected MethodDisabledError", err)
201 func TestIsFull(t *testing.T) {
202 v := NewTestableUnixVolume(t, false, false)
205 fullPath := v.Root + "/full"
206 now := fmt.Sprintf("%d", time.Now().Unix())
207 os.Symlink(now, fullPath)
209 t.Errorf("%s: claims not to be full", v)
213 // Test with an expired /full link.
214 expired := fmt.Sprintf("%d", time.Now().Unix()-3605)
215 os.Symlink(expired, fullPath)
217 t.Errorf("%s: should no longer be full", v)
221 func TestNodeStatus(t *testing.T) {
222 v := NewTestableUnixVolume(t, false, false)
225 // Get node status and make a basic sanity check.
226 volinfo := v.Status()
227 if volinfo.MountPoint != v.Root {
228 t.Errorf("GetNodeStatus mount_point %s, expected %s", volinfo.MountPoint, v.Root)
230 if volinfo.DeviceNum == 0 {
231 t.Errorf("uninitialized device_num in %v", volinfo)
233 if volinfo.BytesFree == 0 {
234 t.Errorf("uninitialized bytes_free in %v", volinfo)
236 if volinfo.BytesUsed == 0 {
237 t.Errorf("uninitialized bytes_used in %v", volinfo)
241 func TestUnixVolumeGetFuncWorkerError(t *testing.T) {
242 v := NewTestableUnixVolume(t, false, false)
245 v.Put(context.Background(), TestHash, TestBlock)
246 mockErr := errors.New("Mock error")
247 err := v.getFunc(context.Background(), v.blockPath(TestHash), func(rdr io.Reader) error {
251 t.Errorf("Got %v, expected %v", err, mockErr)
255 func TestUnixVolumeGetFuncFileError(t *testing.T) {
256 v := NewTestableUnixVolume(t, false, false)
260 err := v.getFunc(context.Background(), v.blockPath(TestHash), func(rdr io.Reader) error {
265 t.Errorf("Expected error opening non-existent file")
268 t.Errorf("Worker func should not have been called")
272 func TestUnixVolumeGetFuncWorkerWaitsOnMutex(t *testing.T) {
273 v := NewTestableUnixVolume(t, false, false)
276 v.Put(context.Background(), TestHash, TestBlock)
278 mtx := NewMockMutex()
281 funcCalled := make(chan struct{})
282 go v.getFunc(context.Background(), v.blockPath(TestHash), func(rdr io.Reader) error {
283 funcCalled <- struct{}{}
287 case mtx.AllowLock <- struct{}{}:
289 t.Fatal("Function was called before mutex was acquired")
290 case <-time.After(5 * time.Second):
291 t.Fatal("Timed out before mutex was acquired")
295 case mtx.AllowUnlock <- struct{}{}:
296 t.Fatal("Mutex was released before function was called")
297 case <-time.After(5 * time.Second):
298 t.Fatal("Timed out waiting for funcCalled")
301 case mtx.AllowUnlock <- struct{}{}:
302 case <-time.After(5 * time.Second):
303 t.Fatal("Timed out waiting for getFunc() to release mutex")
307 func TestUnixVolumeCompare(t *testing.T) {
308 v := NewTestableUnixVolume(t, false, false)
311 v.Put(context.Background(), TestHash, TestBlock)
312 err := v.Compare(context.Background(), TestHash, TestBlock)
314 t.Errorf("Got err %q, expected nil", err)
317 err = v.Compare(context.Background(), TestHash, []byte("baddata"))
318 if err != CollisionError {
319 t.Errorf("Got err %q, expected %q", err, CollisionError)
322 v.Put(context.Background(), TestHash, []byte("baddata"))
323 err = v.Compare(context.Background(), TestHash, TestBlock)
324 if err != DiskHashError {
325 t.Errorf("Got err %q, expected %q", err, DiskHashError)
328 p := fmt.Sprintf("%s/%s/%s", v.Root, TestHash[:3], TestHash)
330 err = v.Compare(context.Background(), TestHash, TestBlock)
331 if err == nil || strings.Index(err.Error(), "permission denied") < 0 {
332 t.Errorf("Got err %q, expected %q", err, "permission denied")
336 func TestUnixVolumeContextCancelPut(t *testing.T) {
337 v := NewTestableUnixVolume(t, true, false)
340 ctx, cancel := context.WithCancel(context.Background())
342 time.Sleep(50 * time.Millisecond)
344 time.Sleep(50 * time.Millisecond)
347 err := v.Put(ctx, TestHash, TestBlock)
348 if err != context.Canceled {
349 t.Errorf("Put() returned %s -- expected short read / canceled", err)
353 func TestUnixVolumeContextCancelGet(t *testing.T) {
354 v := NewTestableUnixVolume(t, false, false)
356 bpath := v.blockPath(TestHash)
357 v.PutRaw(TestHash, TestBlock)
359 err := syscall.Mkfifo(bpath, 0600)
361 t.Fatalf("Mkfifo %s: %s", bpath, err)
363 defer os.Remove(bpath)
364 ctx, cancel := context.WithCancel(context.Background())
366 time.Sleep(50 * time.Millisecond)
369 buf := make([]byte, len(TestBlock))
370 n, err := v.Get(ctx, TestHash, buf)
371 if n == len(TestBlock) || err != context.Canceled {
372 t.Errorf("Get() returned %d, %s -- expected short read / canceled", n, err)
376 var _ = check.Suite(&UnixVolumeSuite{})
378 type UnixVolumeSuite struct {
379 volume *TestableUnixVolume
382 func (s *UnixVolumeSuite) TearDownTest(c *check.C) {
388 func (s *UnixVolumeSuite) TestStats(c *check.C) {
389 s.volume = NewTestableUnixVolume(c, false, false)
390 stats := func() string {
391 buf, err := json.Marshal(s.volume.InternalStats())
392 c.Check(err, check.IsNil)
396 c.Check(stats(), check.Matches, `.*"StatOps":0,.*`)
397 c.Check(stats(), check.Matches, `.*"Errors":0,.*`)
399 loc := "acbd18db4cc2f85cedef654fccc4a4d8"
400 _, err := s.volume.Get(context.Background(), loc, make([]byte, 3))
401 c.Check(err, check.NotNil)
402 c.Check(stats(), check.Matches, `.*"StatOps":[^0],.*`)
403 c.Check(stats(), check.Matches, `.*"Errors":[^0],.*`)
404 c.Check(stats(), check.Matches, `.*"\*os\.PathError":[^0].*`)
405 c.Check(stats(), check.Matches, `.*"InBytes":0,.*`)
406 c.Check(stats(), check.Matches, `.*"OpenOps":0,.*`)
407 c.Check(stats(), check.Matches, `.*"CreateOps":0,.*`)
409 err = s.volume.Put(context.Background(), loc, []byte("foo"))
410 c.Check(err, check.IsNil)
411 c.Check(stats(), check.Matches, `.*"OutBytes":3,.*`)
412 c.Check(stats(), check.Matches, `.*"CreateOps":1,.*`)
413 c.Check(stats(), check.Matches, `.*"OpenOps":0,.*`)
414 c.Check(stats(), check.Matches, `.*"UtimesOps":0,.*`)
416 err = s.volume.Touch(loc)
417 c.Check(err, check.IsNil)
418 c.Check(stats(), check.Matches, `.*"FlockOps":1,.*`)
419 c.Check(stats(), check.Matches, `.*"OpenOps":1,.*`)
420 c.Check(stats(), check.Matches, `.*"UtimesOps":1,.*`)
422 _, err = s.volume.Get(context.Background(), loc, make([]byte, 3))
423 c.Check(err, check.IsNil)
424 err = s.volume.Compare(context.Background(), loc, []byte("foo"))
425 c.Check(err, check.IsNil)
426 c.Check(stats(), check.Matches, `.*"InBytes":6,.*`)
427 c.Check(stats(), check.Matches, `.*"OpenOps":3,.*`)
429 err = s.volume.Trash(loc)
430 c.Check(err, check.IsNil)
431 c.Check(stats(), check.Matches, `.*"FlockOps":2,.*`)
434 func (s *UnixVolumeSuite) TestConfig(c *check.C) {
436 err := yaml.Unmarshal([]byte(`
439 StorageClasses: ["class_a", "class_b"]
442 c.Check(err, check.IsNil)
443 c.Check(cfg.Volumes[0].GetStorageClasses(), check.DeepEquals, []string{"class_a", "class_b"})