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.

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

fix(admission controller): fix unit test data race #30899

Conversation

wdhif
Copy link
Member

@wdhif wdhif commented Nov 8, 2024

What does this PR do?

Fixes data races that can happen when trying to set both c.config.validationEnabled and c.config.mutationEnabled to true. Setting them is not needed as both those config variables defaults to true.

With the following error:

Failed

=== RUN   TestUpdateOutdatedWebhookV1
    mock.go:33: 2024-11-05 16:26:28 UTC | ERROR | (pkg/clusteragent/admission/controllers/webhook/controller_base.go:134 in generateWebhooks) | failed to register CWS Instrumentation webhook: can't initialize CWS Instrumentation in remote_copy mode without providing a service account name in config (cluster_agent.service_account_name)
==================
Read at 0x00c000abe9d0 by goroutine 294:
  github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook.(*ControllerV1).Run()
      /go/src/github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook/controller_v1.go:122 +0x8f8
  github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook.(*fixtureV1).run.gowrap1()
      /go/src/github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook/controller_v1_test.go:1193 +0x44

Previous write at 0x00c000abe9d0 by goroutine 265:
  github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook.TestUpdateOutdatedWebhookV1()
      /go/src/github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook/controller_v1_test.go:148 +0xad2
  testing.tRunner()
      /usr/local/go/src/testing/testing.go:1689 +0x21e
  testing.(*T).Run.gowrap1()
      /usr/local/go/src/testing/testing.go:1742 +0x44

Goroutine 294 (running) created at:
  github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook.(*fixtureV1).run()
      /go/src/github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook/controller_v1_test.go:1193 +0xf0
  github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook.TestUpdateOutdatedWebhookV1()
      /go/src/github.com/DataDog/datadog-agent/pkg/clusteragent/admission/controllers/webhook/controller_v1_test.go:147 +0xabc
  testing.tRunner()
      /usr/local/go/src/testing/testing.go:1689 +0x21e
  testing.(*T).Run.gowrap1()
      /usr/local/go/src/testing/testing.go:1742 +0x44

Goroutine 265 (running) created at:
  testing.(*T).Run()
      /usr/local/go/src/testing/testing.go:1742 +0x825
  testing.runTests.func1()
      /usr/local/go/src/testing/testing.go:2161 +0x85
  testing.tRunner()
      /usr/local/go/src/testing/testing.go:1689 +0x21e
  testing.runTests()
      /usr/local/go/src/testing/testing.go:2159 +0x8be
  testing.(*M).Run()
      /usr/local/go/src/testing/testing.go:2027 +0xf17
  main.main()
      _testmain.go:113 +0x2e4
==================
    testing.go:1398: race detected during execution of test
--- FAIL: TestUpdateOutdatedWebhookV1 (0.72s)

We can see that the values are read on those lines:

if c.config.validationEnabled {
syncedInformer = append(syncedInformer, c.validatingWebhooksSynced)
}
if c.config.mutationEnabled {
syncedInformer = append(syncedInformer, c.mutatingWebhooksSynced)
}

But at the same time in the unit test, right after starting the controller, we have the following lines:

c.config.validationEnabled = true
c.config.mutationEnabled = true

Meaning that it could happen that the variables are being set at the same time when it is being read from the Run() method, causing the Data Race Detector to flag the test as failing.

As those lines are not needed, we might as well remove them.

Motivation

Fixes data race to avoid unit tests flakiness.

Describe how to test/QA your changes

N/A

Possible Drawbacks / Trade-offs

N/A

@wdhif wdhif added the qa/no-code-change Skip QA week as there is no code change in Agent code label Nov 8, 2024
@wdhif wdhif requested a review from a team as a code owner November 8, 2024 12:51
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label Nov 8, 2024
@agent-platform-auto-pr
Copy link
Contributor

[Fast Unit Tests Report]

On pipeline 48552955 (CI Visibility). The following jobs did not run any unit tests:

Jobs:
  • tests_flavor_dogstatsd_deb-x64
  • tests_flavor_heroku_deb-x64
  • tests_flavor_iot_deb-x64

If you modified Go files and expected unit tests to run in these jobs, please double check the job logs. If you think tests should have been executed reach out to #agent-devx-help

@agent-platform-auto-pr
Copy link
Contributor

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv create-vm --pipeline-id=48552955 --os-family=ubuntu

Note: This applies to commit be24b50

Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: c102a4c6-58cf-4c95-804c-f5a5979499e9

Baseline: 03abf3c
Comparison: be24b50
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_idle memory utilization +0.38 [+0.34, +0.43] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput +0.38 [+0.33, +0.43] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.00 [-0.36, +0.37] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.00 [-0.26, +0.25] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.12, +0.11] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.04 [-0.23, +0.16] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.05 [-0.29, +0.20] 1 Logs
file_tree memory utilization -0.33 [-0.45, -0.20] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.36 [-0.84, +0.13] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.42 [-1.15, +0.31] 1 Logs
quality_gate_idle_all_features memory utilization -0.49 [-0.59, -0.39] 1 Logs bounds checks dashboard
pycheck_lots_of_tags % cpu utilization -0.68 [-4.12, +2.75] 1 Logs
basic_py_check % cpu utilization -0.90 [-4.65, +2.85] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 6/10
quality_gate_idle memory_usage 6/10 bounds checks dashboard
file_to_blackhole_100ms_latency lost_bytes 8/10
quality_gate_idle_all_features memory_usage 8/10 bounds checks dashboard
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency memory_usage 10/10

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

@wdhif
Copy link
Member Author

wdhif commented Nov 12, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 12, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-12 13:24:11 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 23m.

@dd-mergequeue dd-mergequeue bot merged commit ad59ebb into main Nov 12, 2024
227 of 229 checks passed
@dd-mergequeue dd-mergequeue bot deleted the CONTP-418/wassim.dhif/fix-admission-controller-test-data-race branch November 12, 2024 13:45
@github-actions github-actions bot added this to the 7.61.0 milestone Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog qa/no-code-change Skip QA week as there is no code change in Agent code short review PR is simple enough to be reviewed quickly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants