Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tests: Attempt to fix flaky test in reloader on directories changes #4765

Merged
merged 2 commits into from
Oct 12, 2021
Merged

Tests: Attempt to fix flaky test in reloader on directories changes #4765

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7837051
Fix by catching up on missed steps
matej-g Oct 10, 2021
df1d094
Review feedback - simplify mutex unlock
matej-g Oct 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 87 additions & 78 deletions pkg/reloader/reloader_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,84 @@ func TestReloader_DirectoriesApply(t *testing.T) {
testutil.Ok(t, os.Symlink(path.Join(dir2, "rule3-source.yaml"), path.Join(dir2, "rule3-001.yaml")))
testutil.Ok(t, ioutil.WriteFile(path.Join(dir2, "rule-dir", "rule4.yaml"), []byte("rule4"), os.ModePerm))

stepFunc := func(rel int) {
t.Log("Performing step number", rel)
switch rel {
case 0:
// Create rule2.yaml.
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml
// └─ rule2.yaml (*)
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml
// ├─ rule3-001.yaml -> rule3-source.yaml
// └─ rule3-source.yaml
testutil.Ok(t, ioutil.WriteFile(path.Join(dir, "rule2.yaml"), []byte("rule2"), os.ModePerm))
case 1:
// Update rule1.yaml.
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml (*)
// └─ rule2.yaml
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml
// ├─ rule3-001.yaml -> rule3-source.yaml
// └─ rule3-source.yaml
testutil.Ok(t, os.Rename(tempRule1File, path.Join(dir, "rule1.yaml")))
case 2:
// Create dir/rule3.yaml (symlink to rule3-001.yaml).
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml
// ├─ rule2.yaml
// └─ rule3.yaml -> dir2/rule3-001.yaml (*)
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml
// ├─ rule3-001.yaml -> rule3-source.yaml
// └─ rule3-source.yaml
testutil.Ok(t, os.Symlink(path.Join(dir2, "rule3-001.yaml"), path.Join(dir2, "rule3.yaml")))
testutil.Ok(t, os.Rename(path.Join(dir2, "rule3.yaml"), path.Join(dir, "rule3.yaml")))
case 3:
// Update the symlinked file and replace the symlink file to trigger fsnotify.
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml
// ├─ rule2.yaml
// └─ rule3.yaml -> dir2/rule3-002.yaml (*)
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml
// ├─ rule3-002.yaml -> rule3-source.yaml (*)
// └─ rule3-source.yaml (*)
testutil.Ok(t, os.Rename(tempRule3File, path.Join(dir2, "rule3-source.yaml")))
testutil.Ok(t, os.Symlink(path.Join(dir2, "rule3-source.yaml"), path.Join(dir2, "rule3-002.yaml")))
testutil.Ok(t, os.Symlink(path.Join(dir2, "rule3-002.yaml"), path.Join(dir2, "rule3.yaml")))
testutil.Ok(t, os.Rename(path.Join(dir2, "rule3.yaml"), path.Join(dir, "rule3.yaml")))
testutil.Ok(t, os.Remove(path.Join(dir2, "rule3-001.yaml")))
case 4:
// Update rule4.yaml in the symlinked directory.
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml
// ├─ rule2.yaml
// └─ rule3.yaml -> rule3-source.yaml
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml (*)
// └─ rule3-source.yaml
testutil.Ok(t, os.Rename(tempRule4File, path.Join(dir2, "rule-dir", "rule4.yaml")))
}
}

ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
g := sync.WaitGroup{}
g.Add(1)
Expand All @@ -267,90 +345,21 @@ func TestReloader_DirectoriesApply(t *testing.T) {

reloadsMtx.Lock()
rel := reloads
reloadsMtx.Unlock()
if init && rel <= reloadsSeen {
reloadsMtx.Unlock()
continue
matej-g marked this conversation as resolved.
Show resolved Hide resolved
}
reloadsMtx.Unlock()
init = true
reloadsSeen = rel

t.Log("Performing step number", rel)
switch rel {
case 0:
// Create rule2.yaml.
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml
// └─ rule2.yaml (*)
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml
// ├─ rule3-001.yaml -> rule3-source.yaml
// └─ rule3-source.yaml
testutil.Ok(t, ioutil.WriteFile(path.Join(dir, "rule2.yaml"), []byte("rule2"), os.ModePerm))
case 1:
// Update rule1.yaml.
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml (*)
// └─ rule2.yaml
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml
// ├─ rule3-001.yaml -> rule3-source.yaml
// └─ rule3-source.yaml
testutil.Ok(t, os.Rename(tempRule1File, path.Join(dir, "rule1.yaml")))
case 2:
// Create dir/rule3.yaml (symlink to rule3-001.yaml).
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml
// ├─ rule2.yaml
// └─ rule3.yaml -> dir2/rule3-001.yaml (*)
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml
// ├─ rule3-001.yaml -> rule3-source.yaml
// └─ rule3-source.yaml
testutil.Ok(t, os.Symlink(path.Join(dir2, "rule3-001.yaml"), path.Join(dir2, "rule3.yaml")))
testutil.Ok(t, os.Rename(path.Join(dir2, "rule3.yaml"), path.Join(dir, "rule3.yaml")))
case 3:
// Update the symlinked file and replace the symlink file to trigger fsnotify.
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml
// ├─ rule2.yaml
// └─ rule3.yaml -> dir2/rule3-002.yaml (*)
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml
// ├─ rule3-002.yaml -> rule3-source.yaml (*)
// └─ rule3-source.yaml (*)
testutil.Ok(t, os.Rename(tempRule3File, path.Join(dir2, "rule3-source.yaml")))
testutil.Ok(t, os.Symlink(path.Join(dir2, "rule3-source.yaml"), path.Join(dir2, "rule3-002.yaml")))
testutil.Ok(t, os.Symlink(path.Join(dir2, "rule3-002.yaml"), path.Join(dir2, "rule3.yaml")))
testutil.Ok(t, os.Rename(path.Join(dir2, "rule3.yaml"), path.Join(dir, "rule3.yaml")))
testutil.Ok(t, os.Remove(path.Join(dir2, "rule3-001.yaml")))
case 4:
// Update rule4.yaml in the symlinked directory.
//
// dir
// ├─ rule-dir -> dir2/rule-dir
// ├─ rule1.yaml
// ├─ rule2.yaml
// └─ rule3.yaml -> rule3-source.yaml
// dir2
// ├─ rule-dir
// │ └─ rule4.yaml (*)
// └─ rule3-source.yaml
testutil.Ok(t, os.Rename(tempRule4File, path.Join(dir2, "rule-dir", "rule4.yaml")))
// Catch up if reloader is step(s) ahead.
for skipped := rel - reloadsSeen - 1; skipped > 0; skipped-- {
stepFunc(rel - skipped)
}

stepFunc(rel)

init = true
reloadsSeen = rel

if rel > 4 {
// All good.
return
Expand Down