datadog-agent icon indicating copy to clipboard operation
datadog-agent copied to clipboard

Implement old Argo test with new-e2e

Open KevinFairise2 opened this issue 1 year ago • 4 comments

What does this PR do?

Migrate our last Argo e2e tests to new-e2e testing framework.

The last to migrate was k8s_e2e_cspm. The testing part from https://github.com/DataDog/datadog-agent/blob/b0d6c2d3373c39449f4589a5a0818f28b4f7df90/test/e2e/cws-tests/tests/test_e2e_cspm_kubernetes.py#L1 was moved to the same test defined in Go. All the setup part that was done with Argo is now handled by new-e2e framework.

Motivation

Get rid of old testing frameworks

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

KevinFairise2 avatar Sep 11 '24 13:09 KevinFairise2

Gitlab CI Configuration Changes

Added Jobs

.on_cspm_or_e2e_changes
.on_cspm_or_e2e_changes:
- if: $RUN_E2E_TESTS == "off"
  when: never
- if: $CI_COMMIT_BRANCH =~ /^mq-working-branch-/
  when: never
- if: $RUN_E2E_TESTS == "on"
  when: on_success
- if: $CI_COMMIT_BRANCH == "main"
  when: on_success
- if: $CI_COMMIT_BRANCH =~ /^[0-9]+\.[0-9]+\.x$/
  when: on_success
- if: $CI_COMMIT_TAG =~ /^[0-9]+\.[0-9]+\.[0-9]+-rc\.[0-9]+$/
  when: on_success
- changes:
    compare_to: main
    paths:
    - test/new-e2e/pkg/**/*
    - test/new-e2e/go.mod
- changes:
    compare_to: main
    paths:
    - pkg/security/**/*
    - test/new-e2e/tests/cspm/**/*
  when: on_success
new-e2e-cspm
new-e2e-cspm:
  after_script:
  - $CI_PROJECT_DIR/tools/ci/junit_upload.sh
  artifacts:
    expire_in: 2 weeks
    paths:
    - $E2E_OUTPUT_DIR
    - junit-*.tgz
    reports:
      annotations:
      - $EXTERNAL_LINKS_PATH
    when: always
  before_script:
  - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache_e2e.tar.xz -C $GOPATH/pkg/mod/cache
  - rm -f modcache_e2e.tar.xz
  - mkdir -p ~/.aws
  - $CI_PROJECT_DIR/tools/ci/fetch_secret.sh $AGENT_QA_PROFILE >> ~/.aws/config ||
    exit $?
  - export AWS_PROFILE=agent-qa-ci
  - $CI_PROJECT_DIR/tools/ci/fetch_secret.sh $SSH_PUBLIC_KEY_RSA > $E2E_PUBLIC_KEY_PATH
    || exit $?
  - touch $E2E_PRIVATE_KEY_PATH && chmod 600 $E2E_PRIVATE_KEY_PATH && $CI_PROJECT_DIR/tools/ci/fetch_secret.sh
    $SSH_KEY_RSA > $E2E_PRIVATE_KEY_PATH || exit $?
  - pulumi login "s3://dd-pulumi-state?region=us-east-1&awssdk=v2&profile=$AWS_PROFILE"
  - ARM_CLIENT_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $E2E_TESTS_AZURE_CLIENT_ID)
    || exit $?; export ARM_CLIENT_ID
  - ARM_CLIENT_SECRET=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $E2E_TESTS_AZURE_CLIENT_SECRET)
    || exit $?; export ARM_CLIENT_SECRET
  - ARM_TENANT_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $E2E_TESTS_AZURE_TENANT_ID)
    || exit $?; export ARM_TENANT_ID
  - ARM_SUBSCRIPTION_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $E2E_TESTS_AZURE_SUBSCRIPTION_ID)
    || exit $?; export ARM_SUBSCRIPTION_ID
  - GOOGLE_CREDENTIALS=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $E2E_TESTS_GCP_CREDENTIALS)
    || exit $?; export GOOGLE_CREDENTIALS
  - inv -e gitlab.generate-ci-visibility-links --output=$EXTERNAL_LINKS_PATH
  image: 486234852809.dkr.ecr.us-east-1.amazonaws.com/ci/test-infra-definitions/runner$TEST_INFRA_DEFINITIONS_BUILDIMAGES_SUFFIX:$TEST_INFRA_DEFINITIONS_BUILDIMAGES
  needs:
  - go_e2e_deps
  - qa_agent
  - qa_dca
  rules:
  - if: $RUN_E2E_TESTS == "off"
    when: never
  - if: $CI_COMMIT_BRANCH =~ /^mq-working-branch-/
    when: never
  - if: $RUN_E2E_TESTS == "on"
    when: on_success
  - if: $CI_COMMIT_BRANCH == "main"
    when: on_success
  - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\.[0-9]+\.x$/
    when: on_success
  - if: $CI_COMMIT_TAG =~ /^[0-9]+\.[0-9]+\.[0-9]+-rc\.[0-9]+$/
    when: on_success
  - changes:
      compare_to: main
      paths:
      - test/new-e2e/pkg/**/*
      - test/new-e2e/go.mod
  - changes:
      compare_to: main
      paths:
      - pkg/security/**/*
      - test/new-e2e/tests/cspm/**/*
    when: on_success
  - if: $CI_COMMIT_BRANCH =~ /^mq-working-branch-/
    when: never
  - allow_failure: true
    when: manual
  script:
  - inv -e new-e2e-tests.run --targets $TARGETS -c ddagent:imagePullRegistry=669783387624.dkr.ecr.us-east-1.amazonaws.com
    -c ddagent:imagePullUsername=AWS -c ddagent:imagePullPassword=$(aws ecr get-login-password)
    --junit-tar junit-${CI_JOB_ID}.tgz ${EXTRA_PARAMS} --test-washer
  stage: e2e
  tags:
  - arch:amd64
  variables:
    E2E_COMMIT_SHA: $CI_COMMIT_SHORT_SHA
    E2E_KEY_PAIR_NAME: datadog-agent-ci-rsa
    E2E_OUTPUT_DIR: $CI_PROJECT_DIR/e2e-output
    E2E_PIPELINE_ID: $CI_PIPELINE_ID
    E2E_PRIVATE_KEY_PATH: /tmp/agent-qa-ssh-key
    E2E_PUBLIC_KEY_PATH: /tmp/agent-qa-ssh-key.pub
    EXTERNAL_LINKS_PATH: external_links_$CI_JOB_ID.json
    KUBERNETES_CPU_REQUEST: 6
    KUBERNETES_MEMORY_LIMIT: 16Gi
    KUBERNETES_MEMORY_REQUEST: 12Gi
    SHOULD_RUN_IN_FLAKES_FINDER: 'true'
    TARGETS: ./tests/cspm
    TEAM: cspm

Removed Jobs

  • .k8s_e2e_template_needs_main
  • .k8s_e2e_template_main_with_cws_cspm_init
  • .k8s_e2e_template_needs_dev
  • .k8s-e2e-cws-cspm-init
  • .k8s_e2e_template_main
  • .k8s_e2e_template_dev_with_cws_cspm_init
  • .k8s_e2e_template
  • .k8s_e2e_template_dev
  • k8s-e2e-cspm-dev
  • k8s-e2e-cspm-main

Changes Summary

Removed Modified Added Renamed
10 0 2 0

pr-commenter[bot] avatar Sep 11 '24 13:09 pr-commenter[bot]

[Fast Unit Tests Report]

On pipeline 45005627 (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

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=45005627 --os-family=ubuntu

Note: This applies to commit a50cd736

pr-commenter[bot] avatar Sep 11 '24 13:09 pr-commenter[bot]

Regression Detector

Regression Detector Results

Run ID: e2811c8d-54f4-4f7f-bd34-27ac1addbc78 Metrics dashboard Target profiles

Baseline: 3b921baa5fbb9f1633406c66a9b52aa13a069041 Comparison: a50cd736cc593b0d33ad40c26faafb2676354b2d

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

No significant changes in experiment optimization goals

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

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +1.33 [+0.58, +2.07] 1 Logs
pycheck_lots_of_tags % cpu utilization +1.20 [-1.36, +3.75] 1 Logs
tcp_syslog_to_blackhole ingress throughput +1.07 [+1.03, +1.12] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.09, +0.09] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
idle memory utilization -0.33 [-0.37, -0.28] 1 Logs
file_tree memory utilization -0.66 [-0.75, -0.58] 1 Logs
basic_py_check % cpu utilization -1.16 [-3.93, +1.62] 1 Logs
otel_to_otel_logs ingress throughput -1.88 [-2.68, -1.08] 1 Logs

Bounds Checks

perf experiment bounds_check_name replicates_passed
idle memory_usage 10/10

Explanation

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

pr-commenter[bot] avatar Sep 11 '24 14:09 pr-commenter[bot]

/merge

KevinFairise2 avatar Sep 25 '24 07:09 KevinFairise2

:steam_locomotive: MergeQueue: pull request added to the queue

The median merge time in main is 23m.

Use /merge -c to cancel this operation!

dd-devflow[bot] avatar Sep 25 '24 07:09 dd-devflow[bot]