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(coverage): Pass the coverage flag in macos tests #31380

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

chouetz
Copy link
Member

@chouetz chouetz commented Nov 22, 2024

What does this PR do?

The coverage upload currently fails in macos because the coverage.out file is not generated, see https://gitlab.ddbuild.io/DataDog/datadog-agent/-/jobs/716918465

Motivation

tech debt

Describe how to test/QA your changes

The macos_test codecov upload is passing

Possible Drawbacks / Trade-offs

Additional Notes

@chouetz chouetz added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation labels Nov 22, 2024
@chouetz chouetz requested review from a team as code owners November 22, 2024 14:10
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label Nov 22, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Nov 22, 2024

Gitlab CI Configuration Changes

Modified Jobs

.tests_macos_gitlab
  .tests_macos_gitlab:
    allow_failure: true
    artifacts:
      expire_in: 2 weeks
      paths:
      - $TEST_OUTPUT_FILE
      - junit-*.tgz
      reports:
        annotations:
        - $EXTERNAL_LINKS_PATH
        junit: '**/junit-out-*.xml'
      when: always
    before_script:
    - 'eval $(gimme $(cat .go-version))
  
      export GOPATH=$GOROOT
  
      '
    - PYTHON_VERSION=$(python3 --version | awk '{print $2}')
    - VENV_NAME="datadog-agent-python-$PYTHON_VERSION"
    - VENV_PATH="$(pyenv root)/versions/$VENV_NAME"
    - echo "Using Python $PYTHON_VERSION..."
    - "# Check if the virtual environment directory exists\nif [ ! -d \"$VENV_PATH\"\
      \ ]; then\n  echo \"Creating virtual environment '$VENV_NAME'...\"\n  pyenv virtualenv\
      \ \"$PYTHON_VERSION\" \"$VENV_NAME\"\nelse\n  echo \"Virtual environment '$VENV_NAME'\
      \ already exists. Skipping creation.\"\nfi\n"
    - pyenv activate $VENV_NAME
    - 'echo "Don''t forget to regularly delete Go unused versions. Here are the installed
      Go versions and their disk space on the runner:"
  
      echo "Go:"
  
      du -sh $HOME/.gimme/versions/*
  
      echo "To remove a Go version please run:"
  
      echo "gimme uninstall <version>"
  
      '
    - 'echo "Don''t forget to regularly delete Python unused versions. Here are the
      installed Python versions and their disk space on the runner:"
  
      echo "Python:"
  
      du -sh $(pyenv root)/versions/*
  
      echo "To remove a Python version please run:"
  
      echo "pyenv uninstall -f <version>"
  
      '
    - python3 -m pip install -r requirements.txt -r tasks/libs/requirements-github.txt
      --break-system-packages
    - pyenv rehash
    - inv -e rtloader.make
    - inv -e rtloader.install
    - inv -e install-tools
    needs:
    - go_deps
    - go_tools_deps
    rules:
    - if: $CI_COMMIT_BRANCH =~ /^mq-working-branch-/
      when: never
    - when: on_success
    script:
    - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache.tar.xz -C $GOPATH/pkg/mod/cache
    - rm -f modcache.tar.xz
    - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache_tools.tar.xz -C $GOPATH/pkg/mod/cache
    - rm -f modcache_tools.tar.xz
    - inv -e gitlab.generate-ci-visibility-links --output=$EXTERNAL_LINKS_PATH
    - FAST_TESTS_FLAG=""
    - if [[ "$FAST_TESTS" == "true" ]]; then FAST_TESTS_FLAG="--only-impacted-packages";
      fi
    - inv -e test --rerun-fails=2 --race --profile --cpus 12 --save-result-json $TEST_OUTPUT_FILE
-     --junit-tar "junit-${CI_JOB_NAME}.tgz" $FAST_TESTS_FLAG --test-washer
+     --junit-tar "junit-${CI_JOB_NAME}.tgz" $FAST_TESTS_FLAG --test-washer --coverage
?                                                                          +++++++++++
    - inv -e invoke-unit-tests
    stage: source_test
    variables:
      TEST_OUTPUT_FILE: test_output.json
tests_macos
  tests_macos:
    after_script:
    - $CI_PROJECT_DIR/tools/ci/junit_upload.sh "junit-*-repacked.tgz"
    artifacts:
      expire_in: 2 weeks
      paths:
      - test_output.json
      - junit-*-repacked.tgz
      reports:
        junit:
        - '**/junit-out-*.xml'
      when: always
    image: registry.ddbuild.io/ci/datadog-agent-buildimages/deb_x64$DATADOG_AGENT_BUILDIMAGES_SUFFIX:$DATADOG_AGENT_BUILDIMAGES
    needs:
    - setup_agent_version
    rules:
    - if: $CI_COMMIT_BRANCH == "main"
    - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\.[0-9]+\.x$/
    - if: $CI_COMMIT_BRANCH == "main" || $DEPLOY_AGENT == "true" || $RUN_ALL_BUILDS
        == "true" || $DDR_WORKFLOW_ID != null
    - if: $RUN_UNIT_TESTS == "on"
    - changes:
        compare_to: main
        paths:
        - pkg/fleet/**/*
      variables:
        FAST_TESTS: 'true'
    - allow_failure: true
      when: manual
    script:
    - "if [[ \"$(( RANDOM % 2 ))\" == \"1\" ]]; then\n  GITHUB_KEY_B64=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh\
      \ $MACOS_GITHUB_APP_1 key_b64) || exit $?; export GITHUB_KEY_B64\n  GITHUB_APP_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh\
      \ $MACOS_GITHUB_APP_1 app_id) || exit $?; export GITHUB_APP_ID\n  GITHUB_INSTALLATION_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh\
      \ $MACOS_GITHUB_APP_1 installation_id) || exit $?; export GITHUB_INSTALLATION_ID\n\
      \  echo \"Using GitHub App instance 1\"\nelse\n  GITHUB_KEY_B64=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh\
      \ $MACOS_GITHUB_APP_2 key_b64) || exit $?; export GITHUB_KEY_B64\n  GITHUB_APP_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh\
      \ $MACOS_GITHUB_APP_2 app_id) || exit $?; export GITHUB_APP_ID\n  GITHUB_INSTALLATION_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh\
      \ $MACOS_GITHUB_APP_2 installation_id) || exit $?; export GITHUB_INSTALLATION_ID\n\
      \  echo \"Using GitHub App instance 2\"\nfi\n"
    - $S3_CP_CMD $S3_ARTIFACTS_URI/agent-version.cache .
    - export VERSION_CACHE_CONTENT=$(cat agent-version.cache | base64 -)
    - python3 -m pip install -r tasks/libs/requirements-github.txt --break-system-packages
    - FAST_TESTS_FLAG=""
    - if [[ "$FAST_TESTS" = "true" ]]; then FAST_TESTS_FLAG="--fast-tests true"; fi
    - inv -e github.trigger-macos --workflow-type "test" --datadog-agent-ref "$CI_COMMIT_SHA"
-     --version-cache "$VERSION_CACHE_CONTENT" $FAST_TESTS_FLAG --test-washer $COVERAGE_CACHE_FLAG
?                                                                            ---------------------
+     --version-cache "$VERSION_CACHE_CONTENT" $FAST_TESTS_FLAG --test-washer
    stage: source_test
    tags:
    - arch:amd64
    timeout: 6h
tests_macos_gitlab_amd64
  tests_macos_gitlab_amd64:
    after_script:
    - export VAULT_ADDR=https://vault.us1.ddbuild.io
    - vault login -method=aws -no-print
    - PYTHON_VERSION=$(python3 --version | awk '{print $2}')
    - VENV_NAME="datadog-agent-python-$PYTHON_VERSION"
    - VENV_PATH="$(pyenv root)/versions/$VENV_NAME"
    - echo "Using Python $PYTHON_VERSION..."
    - "# Check if the virtual environment directory exists\nif [ ! -d \"$VENV_PATH\"\
      \ ]; then\n  echo \"Creating virtual environment '$VENV_NAME'...\"\n  pyenv virtualenv\
      \ \"$PYTHON_VERSION\" \"$VENV_NAME\"\nelse\n  echo \"Virtual environment '$VENV_NAME'\
      \ already exists. Skipping creation.\"\nfi\n"
    - pyenv activate $VENV_NAME
    - $CI_PROJECT_DIR/tools/ci/junit_upload.sh
    - CODECOV_TOKEN=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $CODECOV token) || exit
      $?; export CODECOV_TOKEN
    - inv -e coverage.upload-to-codecov $COVERAGE_CACHE_FLAG || true
    allow_failure: true
    artifacts:
      expire_in: 2 weeks
      paths:
      - $TEST_OUTPUT_FILE
      - junit-*.tgz
      reports:
        annotations:
        - $EXTERNAL_LINKS_PATH
        junit:
        - '**/junit-out-*.xml'
      when: always
    before_script:
    - 'eval $(gimme $(cat .go-version))
  
      export GOPATH=$GOROOT
  
      '
    - PYTHON_VERSION=$(python3 --version | awk '{print $2}')
    - VENV_NAME="datadog-agent-python-$PYTHON_VERSION"
    - VENV_PATH="$(pyenv root)/versions/$VENV_NAME"
    - echo "Using Python $PYTHON_VERSION..."
    - "# Check if the virtual environment directory exists\nif [ ! -d \"$VENV_PATH\"\
      \ ]; then\n  echo \"Creating virtual environment '$VENV_NAME'...\"\n  pyenv virtualenv\
      \ \"$PYTHON_VERSION\" \"$VENV_NAME\"\nelse\n  echo \"Virtual environment '$VENV_NAME'\
      \ already exists. Skipping creation.\"\nfi\n"
    - pyenv activate $VENV_NAME
    - 'echo "Don''t forget to regularly delete Go unused versions. Here are the installed
      Go versions and their disk space on the runner:"
  
      echo "Go:"
  
      du -sh $HOME/.gimme/versions/*
  
      echo "To remove a Go version please run:"
  
      echo "gimme uninstall <version>"
  
      '
    - 'echo "Don''t forget to regularly delete Python unused versions. Here are the
      installed Python versions and their disk space on the runner:"
  
      echo "Python:"
  
      du -sh $(pyenv root)/versions/*
  
      echo "To remove a Python version please run:"
  
      echo "pyenv uninstall -f <version>"
  
      '
    - python3 -m pip install -r requirements.txt -r tasks/libs/requirements-github.txt
      --break-system-packages
    - pyenv rehash
    - inv -e rtloader.make
    - inv -e rtloader.install
    - inv -e install-tools
    needs:
    - go_deps
    - go_tools_deps
    rules:
    - if: $CI_COMMIT_BRANCH =~ /^mq-working-branch-/
      when: never
    - when: on_success
    script:
    - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache.tar.xz -C $GOPATH/pkg/mod/cache
    - rm -f modcache.tar.xz
    - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache_tools.tar.xz -C $GOPATH/pkg/mod/cache
    - rm -f modcache_tools.tar.xz
    - inv -e gitlab.generate-ci-visibility-links --output=$EXTERNAL_LINKS_PATH
    - FAST_TESTS_FLAG=""
    - if [[ "$FAST_TESTS" == "true" ]]; then FAST_TESTS_FLAG="--only-impacted-packages";
      fi
    - inv -e test --rerun-fails=2 --race --profile --cpus 12 --save-result-json $TEST_OUTPUT_FILE
-     --junit-tar "junit-${CI_JOB_NAME}.tgz" $FAST_TESTS_FLAG --test-washer
+     --junit-tar "junit-${CI_JOB_NAME}.tgz" $FAST_TESTS_FLAG --test-washer --coverage
?                                                                          +++++++++++
    - inv -e invoke-unit-tests
    stage: source_test
    tags:
    - macos:monterey-amd64
    - specific:true
    variables:
      TEST_OUTPUT_FILE: test_output.json
tests_macos_gitlab_arm64
  tests_macos_gitlab_arm64:
    after_script:
    - export VAULT_ADDR=https://vault.us1.ddbuild.io
    - vault login -method=aws -no-print
    - PYTHON_VERSION=$(python3 --version | awk '{print $2}')
    - VENV_NAME="datadog-agent-python-$PYTHON_VERSION"
    - VENV_PATH="$(pyenv root)/versions/$VENV_NAME"
    - echo "Using Python $PYTHON_VERSION..."
    - "# Check if the virtual environment directory exists\nif [ ! -d \"$VENV_PATH\"\
      \ ]; then\n  echo \"Creating virtual environment '$VENV_NAME'...\"\n  pyenv virtualenv\
      \ \"$PYTHON_VERSION\" \"$VENV_NAME\"\nelse\n  echo \"Virtual environment '$VENV_NAME'\
      \ already exists. Skipping creation.\"\nfi\n"
    - pyenv activate $VENV_NAME
    - $CI_PROJECT_DIR/tools/ci/junit_upload.sh
    - CODECOV_TOKEN=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $CODECOV token) || exit
      $?; export CODECOV_TOKEN
    - inv -e coverage.upload-to-codecov $COVERAGE_CACHE_FLAG || true
    allow_failure: true
    artifacts:
      expire_in: 2 weeks
      paths:
      - $TEST_OUTPUT_FILE
      - junit-*.tgz
      reports:
        annotations:
        - $EXTERNAL_LINKS_PATH
        junit:
        - '**/junit-out-*.xml'
      when: always
    before_script:
    - 'eval $(gimme $(cat .go-version))
  
      export GOPATH=$GOROOT
  
      '
    - PYTHON_VERSION=$(python3 --version | awk '{print $2}')
    - VENV_NAME="datadog-agent-python-$PYTHON_VERSION"
    - VENV_PATH="$(pyenv root)/versions/$VENV_NAME"
    - echo "Using Python $PYTHON_VERSION..."
    - "# Check if the virtual environment directory exists\nif [ ! -d \"$VENV_PATH\"\
      \ ]; then\n  echo \"Creating virtual environment '$VENV_NAME'...\"\n  pyenv virtualenv\
      \ \"$PYTHON_VERSION\" \"$VENV_NAME\"\nelse\n  echo \"Virtual environment '$VENV_NAME'\
      \ already exists. Skipping creation.\"\nfi\n"
    - pyenv activate $VENV_NAME
    - 'echo "Don''t forget to regularly delete Go unused versions. Here are the installed
      Go versions and their disk space on the runner:"
  
      echo "Go:"
  
      du -sh $HOME/.gimme/versions/*
  
      echo "To remove a Go version please run:"
  
      echo "gimme uninstall <version>"
  
      '
    - 'echo "Don''t forget to regularly delete Python unused versions. Here are the
      installed Python versions and their disk space on the runner:"
  
      echo "Python:"
  
      du -sh $(pyenv root)/versions/*
  
      echo "To remove a Python version please run:"
  
      echo "pyenv uninstall -f <version>"
  
      '
    - python3 -m pip install -r requirements.txt -r tasks/libs/requirements-github.txt
      --break-system-packages
    - pyenv rehash
    - inv -e rtloader.make
    - inv -e rtloader.install
    - inv -e install-tools
    needs:
    - go_deps
    - go_tools_deps
    rules:
    - if: $CI_COMMIT_BRANCH =~ /^mq-working-branch-/
      when: never
    - allow_failure: true
      when: manual
    script:
    - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache.tar.xz -C $GOPATH/pkg/mod/cache
    - rm -f modcache.tar.xz
    - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache_tools.tar.xz -C $GOPATH/pkg/mod/cache
    - rm -f modcache_tools.tar.xz
    - inv -e gitlab.generate-ci-visibility-links --output=$EXTERNAL_LINKS_PATH
    - FAST_TESTS_FLAG=""
    - if [[ "$FAST_TESTS" == "true" ]]; then FAST_TESTS_FLAG="--only-impacted-packages";
      fi
    - inv -e test --rerun-fails=2 --race --profile --cpus 12 --save-result-json $TEST_OUTPUT_FILE
-     --junit-tar "junit-${CI_JOB_NAME}.tgz" $FAST_TESTS_FLAG --test-washer
+     --junit-tar "junit-${CI_JOB_NAME}.tgz" $FAST_TESTS_FLAG --test-washer --coverage
?                                                                          +++++++++++
    - inv -e invoke-unit-tests
    stage: source_test
    tags:
    - macos:monterey-arm64
    - specific:true
    variables:
      TEST_OUTPUT_FILE: test_output.json

Changes Summary

Removed Modified Added Renamed
0 4 0 0

ℹ️ Diff available in the job log.

Copy link

cit-pr-commenter bot commented Nov 22, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 1d320c76-ff4b-416f-8c04-0d53fed9bb39

Baseline: b67a6e6
Comparison: 4435c0f
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_all_features memory utilization +2.41 [+2.27, +2.55] 1 Logs bounds checks dashboard
basic_py_check % cpu utilization +1.98 [-1.93, +5.89] 1 Logs
file_tree memory utilization +1.17 [+1.02, +1.31] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.46 [-0.26, +1.19] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.39 [-0.39, +1.17] 1 Logs
pycheck_lots_of_tags % cpu utilization +0.11 [-3.34, +3.56] 1 Logs
quality_gate_idle memory utilization +0.10 [+0.04, +0.17] 1 Logs bounds checks dashboard
uds_dogstatsd_to_api ingress throughput +0.01 [-0.11, +0.13] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.01 [-0.85, +0.87] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.00 [-0.75, +0.75] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.01 [-0.77, +0.76] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.02 [-0.63, +0.60] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.47 [-0.92, -0.01] 1 Logs
otel_to_otel_logs ingress throughput -0.74 [-1.36, -0.12] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.88 [-0.97, -0.78] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
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 lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency lost_bytes 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard

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".

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

The coverage upload currently fails in macos because the `coverage.out` file is not generated, see https://gitlab.ddbuild.io/DataDog/datadog-agent/-/jobs/716918465
@@ -22,7 +22,7 @@ tests_macos:
- python3 -m pip install -r tasks/libs/requirements-github.txt --break-system-packages
- FAST_TESTS_FLAG=""
- if [[ "$FAST_TESTS" = "true" ]]; then FAST_TESTS_FLAG="--fast-tests true"; fi
- inv -e github.trigger-macos --workflow-type "test" --datadog-agent-ref "$CI_COMMIT_SHA" --version-cache "$VERSION_CACHE_CONTENT" $FAST_TESTS_FLAG --test-washer $COVERAGE_CACHE_FLAG
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This variable is not meant for this task, but for coverage.upload-to-codecov

@github-actions github-actions bot added medium review PR review might take time and removed short review PR is simple enough to be reviewed quickly labels Nov 22, 2024
@chouetz
Copy link
Member Author

chouetz commented Nov 27, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 27, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-27 09:26:53 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 23m.

@dd-mergequeue dd-mergequeue bot merged commit 4afce70 into main Nov 27, 2024
215 of 216 checks passed
@dd-mergequeue dd-mergequeue bot deleted the nschweitzer/coverage branch November 27, 2024 09:59
@github-actions github-actions bot added this to the 7.61.0 milestone Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog medium review PR review might take time qa/no-code-change No code change in Agent code requiring validation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants