summaryrefslogtreecommitdiffhomepage
path: root/syncs/locked_test.go
blob: 32b9b64e0cb2233ca35c2415522f074fec9883a0 (plain)
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
// Copyright (c) 2020 Tailscale Inc & AUTHORS All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// +build go1.13,!go1.16

//lint:file-ignore SA2001 the empty critical sections are part of triggering different internal mutex states

package syncs

import (
	"sync"
	"testing"
	"time"
)

func wantPanic(t *testing.T, fn func()) {
	t.Helper()
	defer func() {
		recover()
	}()
	fn()
	t.Fatal("failed to panic")
}

func TestAssertLocked(t *testing.T) {
	m := new(sync.Mutex)
	wantPanic(t, func() { AssertLocked(m) })
	m.Lock()
	AssertLocked(m)
	m.Unlock()
	wantPanic(t, func() { AssertLocked(m) })
	// Test correct handling of mutex with waiter.
	m.Lock()
	AssertLocked(m)
	go func() {
		m.Lock()
		m.Unlock()
	}()
	// Give the goroutine above a few moments to get started.
	// The test will pass whether or not we win the race,
	// but we want to run sometimes, to get the test coverage.
	time.Sleep(10 * time.Millisecond)
	AssertLocked(m)
}

func TestAssertWLocked(t *testing.T) {
	m := new(sync.RWMutex)
	wantPanic(t, func() { AssertWLocked(m) })
	m.Lock()
	AssertWLocked(m)
	m.Unlock()
	wantPanic(t, func() { AssertWLocked(m) })
	// Test correct handling of mutex with waiter.
	m.Lock()
	AssertWLocked(m)
	go func() {
		m.Lock()
		m.Unlock()
	}()
	// Give the goroutine above a few moments to get started.
	// The test will pass whether or not we win the race,
	// but we want to run sometimes, to get the test coverage.
	time.Sleep(10 * time.Millisecond)
	AssertWLocked(m)
}

func TestAssertRLocked(t *testing.T) {
	m := new(sync.RWMutex)
	wantPanic(t, func() { AssertRLocked(m) })

	m.Lock()
	AssertRLocked(m)
	m.Unlock()

	m.RLock()
	AssertRLocked(m)
	m.RUnlock()

	wantPanic(t, func() { AssertRLocked(m) })

	// Test correct handling of mutex with waiter.
	m.RLock()
	AssertRLocked(m)
	go func() {
		m.RLock()
		m.RUnlock()
	}()
	// Give the goroutine above a few moments to get started.
	// The test will pass whether or not we win the race,
	// but we want to run sometimes, to get the test coverage.
	time.Sleep(10 * time.Millisecond)
	AssertRLocked(m)
	m.RUnlock()

	// Test correct handling of rlock with write waiter.
	m.RLock()
	AssertRLocked(m)
	go func() {
		m.Lock()
		m.Unlock()
	}()
	// Give the goroutine above a few moments to get started.
	// The test will pass whether or not we win the race,
	// but we want to run sometimes, to get the test coverage.
	time.Sleep(10 * time.Millisecond)
	AssertRLocked(m)
	m.RUnlock()

	// Test correct handling of rlock with other rlocks.
	// This is a bit racy, but losing the race hurts nothing,
	// and winning the race means correct test coverage.
	m.RLock()
	AssertRLocked(m)
	go func() {
		m.RLock()
		time.Sleep(10 * time.Millisecond)
		m.RUnlock()
	}()
	time.Sleep(5 * time.Millisecond)
	AssertRLocked(m)
	m.RUnlock()
}