starred/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-01-11 20:00:28 +01:00
Code Issues 98 Packages Projects Releases 10 Wiki Activity

[PR #2023] [MERGED] Fix data race issues in EphemeralGarbageCollector tests #2456

New Issue
Closed
opened 2025-12-29 03:21:21 +01:00 by adam · 0 comments
adam commented 2025-12-29 03:21:21 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2023
Author: @nadongjun
Created: 7/22/2024
Status: ✅ Merged
Merged: 7/22/2024
Merged by: @kradalby

Base: main ← Head: fix-test

📝 Commits (3)

  • c04e75d Fix data race issues in EphemeralGarbageCollector tests
  • b3f5f4e Add defer for mutex unlock in TestEphemeralGarbageCollectorOrder
  • 9aed416 Fix mutex unlock order in closure by updating defer placement

📊 Changes

1 file changed (+11 additions, -1 deletions)

View changed files

📝 hscontrol/db/node_test.go (+11 -1)

📄 Description

  • have read the CONTRIBUTING.md file
  • raised a GitHub issue or discussed it on the projects chat beforehand
  • added unit tests
  • added integration tests
  • updated documentation if needed
  • updated CHANGELOG.md
  • This PR addresses data race issues detected by the -race flag during gotestsum -- -short -coverprofile=coverage.out ./... execution for the EphemeralGarbageCollector tests.

The changes include:

  • Added necessary synchronization with mutex locks to prevent concurrent access issues.
  • Ensured that shared data structures are properly protected during test execution.

Log

  • gotestsum -- -race -coverprofile=coverage.out ./...
=== Failed
=== FAIL: hscontrol/db TestEphemeralGarbageCollectorOrder (6.00s)
==================
WARNING: DATA RACE
Read at 0x00c00057e198 by goroutine 276:
  github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder()
      /Users/dongjunna/headscale/hscontrol/db/node_test.go:620 +0x414
  testing.tRunner()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180
  testing.(*T).Run.gowrap1()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x40

Previous write at 0x00c00057e198 by goroutine 293:
  github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder.func1()
      /Users/dongjunna/headscale/hscontrol/db/node_test.go:605 +0xa4
  github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start.gowrap1()
      /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x44

Goroutine 276 (running) created at:
  testing.(*T).Run()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x5e4
  testing.runTests.func1()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2161 +0x80
  testing.tRunner()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180
  testing.runTests()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2159 +0x6e0
  testing.(*M).Run()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2027 +0xb74
  main.main()
      _testmain.go:101 +0x2b4

Goroutine 293 (finished) created at:
  github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start()
      /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x94
  github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder.gowrap1()
      /Users/dongjunna/headscale/hscontrol/db/node_test.go:607 +0x34
==================
==================
WARNING: DATA RACE
Read at 0x00c000010f38 by goroutine 276:
  reflect.Value.Uint()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/reflect/value.go:2753 +0xa80
  github.com/google/go-cmp/cmp.(*state).compareAny()
      /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:277 +0x894
  github.com/google/go-cmp/cmp.(*state).statelessCompare()
      /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:232 +0xbc
  github.com/google/go-cmp/cmp.(*state).compareSlice.func2()
      /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:480 +0xdc
  github.com/google/go-cmp/cmp/internal/diff.Difference()
      /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/internal/diff/diff.go:286 +0x4b8
  github.com/google/go-cmp/cmp.(*state).compareSlice()
      /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:479 +0xad0
  github.com/google/go-cmp/cmp.(*state).compareAny()
      /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:291 +0xf70
  github.com/google/go-cmp/cmp.Diff()
      /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:122 +0x94
  github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder()
      /Users/dongjunna/headscale/hscontrol/db/node_test.go:620 +0x458
  testing.tRunner()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180
  testing.(*T).Run.gowrap1()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x40

Previous write at 0x00c000010f38 by goroutine 293:
  github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder.func1()
      /Users/dongjunna/headscale/hscontrol/db/node_test.go:605 +0x8c
  github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start.gowrap1()
      /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x44

Goroutine 276 (running) created at:
  testing.(*T).Run()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x5e4
  testing.runTests.func1()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2161 +0x80
  testing.tRunner()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180
  testing.runTests()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2159 +0x6e0
  testing.(*M).Run()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2027 +0xb74
  main.main()
      _testmain.go:101 +0x2b4

Goroutine 293 (finished) created at:
  github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start()
      /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x94
  github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder.gowrap1()
      /Users/dongjunna/headscale/hscontrol/db/node_test.go:607 +0x34
==================
    testing.go:1398: race detected during execution of test

=== FAIL: hscontrol/db TestEphemeralGarbageCollectorLoads (10.01s)
==================
WARNING: DATA RACE
Read at 0x00c00057e2a0 by goroutine 294:
  github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorLoads()
      /Users/dongjunna/headscale/hscontrol/db/node_test.go:647 +0x48c
  testing.tRunner()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180
  testing.(*T).Run.gowrap1()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x40

Previous write at 0x00c00057e2a0 by goroutine 4873:
  github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorLoads.func1()
      /Users/dongjunna/headscale/hscontrol/db/node_test.go:636 +0x11c
  github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start.gowrap1()
      /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x44

Goroutine 294 (running) created at:
  testing.(*T).Run()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x5e4
  testing.runTests.func1()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2161 +0x80
  testing.tRunner()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180
  testing.runTests()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2159 +0x6e0
  testing.(*M).Run()
      /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2027 +0xb74
  main.main()
      _testmain.go:101 +0x2b4

Goroutine 4873 (finished) created at:
  github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start()
      /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x94
  github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorLoads.gowrap1()
      /Users/dongjunna/headscale/hscontrol/db/node_test.go:638 +0x34
==================
    testing.go:1398: race detected during execution of test

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/juanfont/headscale/pull/2023 **Author:** [@nadongjun](https://github.com/nadongjun) **Created:** 7/22/2024 **Status:** ✅ Merged **Merged:** 7/22/2024 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `fix-test` --- ### 📝 Commits (3) - [`c04e75d`](https://github.com/juanfont/headscale/commit/c04e75d6d97bb654653d540fd944c7072b38f3fb) Fix data race issues in EphemeralGarbageCollector tests - [`b3f5f4e`](https://github.com/juanfont/headscale/commit/b3f5f4e90ece9fb47d8eeda7453f23f4c0def2c7) Add defer for mutex unlock in TestEphemeralGarbageCollectorOrder - [`9aed416`](https://github.com/juanfont/headscale/commit/9aed416363bd9d00df4da0236eb41a0662d0de48) Fix mutex unlock order in closure by updating defer placement ### 📊 Changes **1 file changed** (+11 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `hscontrol/db/node_test.go` (+11 -1) </details> ### 📄 Description <!-- Headscale is "Open Source, acknowledged contribution", this means that any contribution will have to be discussed with the Maintainers before being submitted. This model has been chosen to reduce the risk of burnout by limiting the maintenance overhead of reviewing and validating third-party code. Headscale is open to code contributions for bug fixes without discussion. If you find mistakes in the documentation, please submit a fix to the documentation. --> <!-- Please tick if the following things apply. You… --> - [x] have read the [CONTRIBUTING.md](./CONTRIBUTING.md) file - [ ] raised a GitHub issue or discussed it on the projects chat beforehand - [ ] added unit tests - [ ] added integration tests - [ ] updated documentation if needed - [ ] updated CHANGELOG.md <!-- If applicable, please reference the issue using `Fixes #XXX` and add tests to cover your new code. --> - This PR addresses data race issues detected by the `-race` flag during `gotestsum -- -short -coverprofile=coverage.out ./...` execution for the `EphemeralGarbageCollector` tests. The changes include: - Added necessary synchronization with mutex locks to prevent concurrent access issues. - Ensured that shared data structures are properly protected during test execution. ## Log - gotestsum -- -race -coverprofile=coverage.out ./... ``` === Failed === FAIL: hscontrol/db TestEphemeralGarbageCollectorOrder (6.00s) ================== WARNING: DATA RACE Read at 0x00c00057e198 by goroutine 276: github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder() /Users/dongjunna/headscale/hscontrol/db/node_test.go:620 +0x414 testing.tRunner() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180 testing.(*T).Run.gowrap1() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x40 Previous write at 0x00c00057e198 by goroutine 293: github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder.func1() /Users/dongjunna/headscale/hscontrol/db/node_test.go:605 +0xa4 github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start.gowrap1() /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x44 Goroutine 276 (running) created at: testing.(*T).Run() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x5e4 testing.runTests.func1() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2161 +0x80 testing.tRunner() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180 testing.runTests() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2159 +0x6e0 testing.(*M).Run() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2027 +0xb74 main.main() _testmain.go:101 +0x2b4 Goroutine 293 (finished) created at: github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start() /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x94 github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder.gowrap1() /Users/dongjunna/headscale/hscontrol/db/node_test.go:607 +0x34 ================== ================== WARNING: DATA RACE Read at 0x00c000010f38 by goroutine 276: reflect.Value.Uint() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/reflect/value.go:2753 +0xa80 github.com/google/go-cmp/cmp.(*state).compareAny() /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:277 +0x894 github.com/google/go-cmp/cmp.(*state).statelessCompare() /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:232 +0xbc github.com/google/go-cmp/cmp.(*state).compareSlice.func2() /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:480 +0xdc github.com/google/go-cmp/cmp/internal/diff.Difference() /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/internal/diff/diff.go:286 +0x4b8 github.com/google/go-cmp/cmp.(*state).compareSlice() /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:479 +0xad0 github.com/google/go-cmp/cmp.(*state).compareAny() /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:291 +0xf70 github.com/google/go-cmp/cmp.Diff() /Users/dongjunna/go/pkg/mod/github.com/google/go-cmp@v0.6.0/cmp/compare.go:122 +0x94 github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder() /Users/dongjunna/headscale/hscontrol/db/node_test.go:620 +0x458 testing.tRunner() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180 testing.(*T).Run.gowrap1() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x40 Previous write at 0x00c000010f38 by goroutine 293: github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder.func1() /Users/dongjunna/headscale/hscontrol/db/node_test.go:605 +0x8c github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start.gowrap1() /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x44 Goroutine 276 (running) created at: testing.(*T).Run() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x5e4 testing.runTests.func1() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2161 +0x80 testing.tRunner() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180 testing.runTests() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2159 +0x6e0 testing.(*M).Run() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2027 +0xb74 main.main() _testmain.go:101 +0x2b4 Goroutine 293 (finished) created at: github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start() /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x94 github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorOrder.gowrap1() /Users/dongjunna/headscale/hscontrol/db/node_test.go:607 +0x34 ================== testing.go:1398: race detected during execution of test === FAIL: hscontrol/db TestEphemeralGarbageCollectorLoads (10.01s) ================== WARNING: DATA RACE Read at 0x00c00057e2a0 by goroutine 294: github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorLoads() /Users/dongjunna/headscale/hscontrol/db/node_test.go:647 +0x48c testing.tRunner() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180 testing.(*T).Run.gowrap1() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x40 Previous write at 0x00c00057e2a0 by goroutine 4873: github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorLoads.func1() /Users/dongjunna/headscale/hscontrol/db/node_test.go:636 +0x11c github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start.gowrap1() /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x44 Goroutine 294 (running) created at: testing.(*T).Run() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1742 +0x5e4 testing.runTests.func1() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2161 +0x80 testing.tRunner() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:1689 +0x180 testing.runTests() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2159 +0x6e0 testing.(*M).Run() /nix/store/05saqcgidraqmn4z82prsp7rbj9hjmwm-go-1.22.5/share/go/src/testing/testing.go:2027 +0xb74 main.main() _testmain.go:101 +0x2b4 Goroutine 4873 (finished) created at: github.com/juanfont/headscale/hscontrol/db.(*EphemeralGarbageCollector).Start() /Users/dongjunna/headscale/hscontrol/db/node.go:792 +0x94 github.com/juanfont/headscale/hscontrol/db.TestEphemeralGarbageCollectorLoads.gowrap1() /Users/dongjunna/headscale/hscontrol/db/node_test.go:638 +0x34 ================== testing.go:1398: race detected during execution of test ``` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 03:21:21 +01:00
adam closed this issue 2025-12-29 03:21:21 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
CLI
DERP
DNS
Nix
OIDC
SSH
bug
database
documentation
duplicate
enhancement
faq
good first issue
grants
help wanted
might-come
needs design doc
needs investigation
no-stale-bot
out of scope
performance
policy 📝
pull-request
Mirrored from GitHub Pull Request
 question
regression
routes
stale
tags
tailscale-feature-gap
well described ❤️
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2456
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?