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

Fix flaky docker integration test #31097

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Fix flaky docker integration test #31097

merged 1 commit into from
Nov 14, 2024

Conversation

sblumenthal
Copy link
Member

@sblumenthal sblumenthal commented Nov 14, 2024 •
edited
Loading

What does this PR do?

Fix a race condition in the TestDockerListenerSuite/TestListenBeforeStart and TestDockerListenerSuite/TestListenAfterStart integration tests

Motivation

The tests started failing around 8/28 with the following errors:

    --- FAIL: TestDockerListenerSuite/TestListenAfterStart (11.95s)
        docker_listener_test.go:235: 
                Error Trace:    /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:235
                                                        /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:186
                Error:          Expected nil, but got: &errors.errorString{s:"timeout listening for services, only got 0, expecting 2"}
                Test:           TestDockerListenerSuite/TestListenAfterStart
        docker_listener_test.go:236: 
                Error Trace:    /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:236
                                                        /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:186
                Error:          "map[]" should have 2 item(s), but has 0
                Test:           TestDockerListenerSuite/TestListenAfterStart
        docker_listener_test.go:279: 
                Error Trace:    /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:279
                                                        /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:186
                Error:          "map[]" should have 2 item(s), but has 0
                Test:           TestDockerListenerSuite/TestListenAfterStart
    mock.go:33: 2024-08-28 19:45:52 UTC | INFO | (comp/core/autodiscovery/listeners/workloadmeta.go:142 in Listen) | ad-containerlistener initialized successfully
    --- FAIL: TestDockerListenerSuite/TestListenBeforeStart (11.94s)
        docker_listener_test.go:235: 
                Error Trace:    /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:235
                                                        /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:202
                Error:          Expected nil, but got: &errors.errorString{s:"timeout listening for services, only got 0, expecting 2"}
                Test:           TestDockerListenerSuite/TestListenBeforeStart
        docker_listener_test.go:236: 
                Error Trace:    /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:236
                                                        /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:202
                Error:          "map[]" should have 2 item(s), but has 0
                Test:           TestDockerListenerSuite/TestListenBeforeStart
        docker_listener_test.go:279: 
                Error Trace:    /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:279
                                                        /go/src/github.com/DataDog/datadog-agent/test/integration/listeners/docker/docker_listener_test.go:202
                Error:          "map[]" should have 2 item(s), but has 0
                Test:           TestDockerListenerSuite/TestListenBeforeStart
FAIL


FAIL    github.com/DataDog/datadog-agent/test/integration/listeners/docker      27.564s
FAIL

Looking at the debug logs, I see:

    mock.go:33: 2024-08-28 19:45:40 UTC | INFO | (comp/core/workloadmeta/impl/store.go:557 in startCandidates) | workloadmeta collector "docker" could not start. error: component workloadmeta-docker is disabled: Agent is not running on Docker

Which leads us to think this is a race condition because the WLM component start is possibly not a blocking operation

Job failures on main

Describe how to test/QA your changes

Integration test suite should remain green

Possible Drawbacks / Trade-offs

Additional Notes

Possibly related to #28703

@sblumenthal sblumenthal added team/containers changelog/no-changelog qa/done Skip QA week as QA was done before merge and regressions are covered by tests labels Nov 14, 2024
@sblumenthal sblumenthal added this to the 7.61.0 milestone Nov 14, 2024
@sblumenthal sblumenthal requested a review from a team as a code owner November 14, 2024 16:52
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label Nov 14, 2024
@agent-platform-auto-pr
Copy link
Contributor

[Fast Unit Tests Report]

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

Jobs:
  • tests_deb-arm64-py3
  • tests_deb-x64-py3
  • tests_flavor_dogstatsd_deb-x64
  • tests_flavor_heroku_deb-x64
  • tests_flavor_iot_deb-x64
  • tests_rpm-arm64-py3
  • tests_rpm-x64-py3
  • tests_windows-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=49041511 --os-family=ubuntu

Note: This applies to commit 8a6b71d

@cit-pr-commenter cit-pr-commenter
Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 2ec61c06-37ff-4c2c-86dd-7bcb65abc571

Baseline: 10b7a6c
Comparison: 8a6b71d
Diff

Optimization Goals: ❌ Significant changes detected

perf experiment goal Δ mean % Δ mean % CI trials links
❌ pycheck_lots_of_tags % cpu utilization +5.87 [+2.33, +9.40] 1 Logs
✅ basic_py_check % cpu utilization -5.55 [-9.09, -2.02] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
❌ pycheck_lots_of_tags % cpu utilization +5.87 [+2.33, +9.40] 1 Logs
➖ quality_gate_idle memory utilization +0.69 [+0.65, +0.74] 1 Logs bounds checks dashboard
➖ otel_to_otel_logs ingress throughput +0.54 [-0.17, +1.24] 1 Logs
➖ file_to_blackhole_1000ms_latency_linear_load egress throughput +0.14 [-0.35, +0.63] 1 Logs
➖ file_to_blackhole_500ms_latency egress throughput +0.09 [-0.15, +0.33] 1 Logs
➖ file_to_blackhole_100ms_latency egress throughput +0.04 [-0.29, +0.36] 1 Logs
➖ file_to_blackhole_300ms_latency egress throughput +0.03 [-0.15, +0.22] 1 Logs
➖ file_to_blackhole_0ms_latency egress throughput +0.01 [-0.48, +0.49] 1 Logs
➖ tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
➖ uds_dogstatsd_to_api ingress throughput -0.00 [-0.10, +0.09] 1 Logs
➖ tcp_syslog_to_blackhole ingress throughput -0.36 [-0.40, -0.33] 1 Logs
➖ file_to_blackhole_1000ms_latency egress throughput -0.37 [-0.85, +0.11] 1 Logs
➖ uds_dogstatsd_to_api_cpu % cpu utilization -0.46 [-1.18, +0.26] 1 Logs
➖ quality_gate_idle_all_features memory utilization -0.47 [-0.58, -0.37] 1 Logs bounds checks dashboard
➖ file_tree memory utilization -0.55 [-0.68, -0.41] 1 Logs
✅ basic_py_check % cpu utilization -5.55 [-9.09, -2.02] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
❌ quality_gate_idle memory_usage 8/10 bounds checks dashboard
❌ file_to_blackhole_100ms_latency lost_bytes 9/10
❌ quality_gate_idle_all_features memory_usage 9/10 bounds checks dashboard
✅ file_to_blackhole_0ms_latency lost_bytes 10/10
✅ file_to_blackhole_0ms_latency memory_usage 10/10
✅ file_to_blackhole_1000ms_latency memory_usage 10/10
✅ file_to_blackhole_1000ms_latency_linear_load 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".

@sblumenthal
Copy link
Member Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 14, 2024 •
edited
Loading

Devflow running: /merge

View all feedbacks in Devflow UI.

2024-11-14 19:25:05 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 24m.

2024-11-14 19:25:07 UTC ℹ️ MergeQueue: merge request added to the queue

The median merge time in main is 24m.

@dd-mergequeue dd-mergequeue bot merged commit 438bf1b into main Nov 14, 2024
235 checks passed
@dd-mergequeue dd-mergequeue bot deleted the sblumenthal/fix-integration-tests branch November 14, 2024 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@L3n41c L3n41c L3n41c approved these changes

Assignees
No one assigned
Labels
changelog/no-changelog qa/done Skip QA week as QA was done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/containers
Projects
None yet
Milestone
7.61.0
Development

Successfully merging this pull request may close these issues.
2 participants
@sblumenthal @L3n41c