Switch context by test

Author: lsierant

Makefile

@@ -62,6 +62,9 @@ precommit:
 switch:
 	@ scripts/dev/switch_context.sh $(context) $(additional_override)
 
+switcht:
+	@ scripts/dev/switch_context_by_test.sh $(test)
+
 # builds the Operator binary file and docker image and pushes it to the remote registry if using a remote registry. Deploys it to
 # k8s cluster
 operator: configure-operator build-and-push-operator-image

config/manifests/bases/mongodb-kubernetes.clusterserviceversion.yaml

@@ -8,9 +8,9 @@ metadata:
     certified: "true"
     containerImage: quay.io/mongodb/mongodb-kubernetes:1.1.0
     createdAt: ""
-    description: The MongoDB Controllers for Kubernetes enable easy deploys of 
-      MongoDB into Kubernetes clusters, using our management, monitoring and 
-      backup platforms, Ops Manager and Cloud Manager.
+    description: The MongoDB Controllers for Kubernetes enable easy deploys of MongoDB
+      into Kubernetes clusters, using our management, monitoring and backup platforms,
+      Ops Manager and Cloud Manager.
     features.operators.openshift.io/disconnected: "true"
     features.operators.openshift.io/fips-compliant: "false"
     features.operators.openshift.io/proxy-aware: "false"
@@ -51,8 +51,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:text
         - urn:alm:descriptor:com.tectonic.ui:fieldGroup:ClusterConfiguration
-      - description: In a Replica Set deployment type, specifies the amount of 
-          members.
+      - description: In a Replica Set deployment type, specifies the amount of members.
         displayName: Members of a Replica Set
         path: members
         x-descriptors:
@@ -66,8 +65,7 @@ spec:
       - description: Project configuration for this deployment
         displayName: Ops Manager project configuration
         path: opsManager
-      - description: Name of the ConfigMap with the configuration for this 
-          project
+      - description: Name of the ConfigMap with the configuration for this project
         displayName: Ops Manager Project Configuration
         path: opsManager.configMapRef.name
         x-descriptors:
@@ -166,8 +164,7 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:text
         - urn:alm:descriptor:com.tectonic.ui:fieldGroup:ClusterConfiguration
-      - description: In a Replica Set deployment type, specifies the amount of 
-          members.
+      - description: In a Replica Set deployment type, specifies the amount of members.
         displayName: Members of a Replica Set
         path: members
         x-descriptors:
@@ -181,8 +178,7 @@ spec:
       - description: Project configuration for this deployment
         displayName: Ops Manager project configuration
         path: opsManager
-      - description: Name of the ConfigMap with the configuration for this 
-          project
+      - description: Name of the ConfigMap with the configuration for this project
         displayName: Ops Manager Project Configuration
         path: opsManager.configMapRef.name
         x-descriptors:
@@ -194,8 +190,8 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:booleanSwitch
         - urn:alm:descriptor:com.tectonic.ui:fieldGroup:ClusterConfiguration
-      - description: Optional. Specify whether to duplicate service objects 
-          among different Kubernetes clusters.
+      - description: Optional. Specify whether to duplicate service objects among
+          different Kubernetes clusters.
         displayName: Duplicate Service Objects
         path: duplicateServiceObjects
         x-descriptors:
@@ -256,8 +252,7 @@ spec:
         path: passwordSecretKeyRef.name
         x-descriptors:
         - urn:alm:descriptor:io.kubernetes:Secret
-      - displayName: Name of the MongoDB resource to which this user is 
-          associated.
+      - displayName: Name of the MongoDB resource to which this user is associated.
         path: mongodbResourceRef.name
         x-descriptors:
         - urn:alm:descriptor:io.kubernetes:mongodb
@@ -313,8 +308,8 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:io.kubernetes:Secret
         - urn:alm:descriptor:com.tectonic.ui:fieldGroup:OpsManagerConfiguration
-      - displayName: Secret to enable TLS for Ops Manager allowing it to serve 
-          traffic over HTTPS.
+      - displayName: Secret to enable TLS for Ops Manager allowing it to serve traffic
+          over HTTPS.
         path: security.tls.secretRef.name
         x-descriptors:
         - urn:alm:descriptor:io.kubernetes:Secret
@@ -324,8 +319,8 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:number
         - urn:alm:descriptor:com.tectonic.ui:fieldGroup:ApplicationDatabase
-      - displayName: Secret containing the TLS certificate signed by known or 
-          custom CA.
+      - displayName: Secret containing the TLS certificate signed by known or custom
+          CA.
         path: applicationDatabase.security.tls.secretRef.name
         x-descriptors:
         - urn:alm:descriptor:io.kubernetes:Secret

helm_chart/Chart.yaml

@@ -1,8 +1,7 @@
 apiVersion: v2
 name: mongodb-kubernetes
-description: MongoDB Controllers for Kubernetes translate the human knowledge of
-  creating a MongoDB instance into a scalable, repeatable, and standardized 
-  method.
+description: MongoDB Controllers for Kubernetes translate the human knowledge of creating
+  a MongoDB instance into a scalable, repeatable, and standardized method.
 version: 1.1.0
 kubeVersion: '>=1.16-0'
 type: application

scripts/__init__.py

@@ -0,0 +1 @@
+# Makes 'scripts' a Python package.

scripts/dev/contexts/root-context

@@ -116,3 +116,8 @@ export MDB_SEARCH_COMMUNITY_VERSION
 
 export MDB_SEARCH_COMMUNITY_NAME="mongodb-search-community"
 export MDB_SEARCH_COMMUNITY_REPO_URL="quay.io/mongodb"
+
+
+if [[ ${MDB_BASH_DEBUG:-0} == 1 ]]; then
+  export PS4='+(${BASH_SOURCE}:${LINENO})[^$?]: ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
+fi

scripts/dev/launch_e2e.sh

@@ -2,6 +2,7 @@
 
 set -Eeou pipefail
 
+test "${MDB_BASH_DEBUG:-0}" -eq 1 && set -x
 
 # The script launches e2e test. Note, that the Operator and necessary resources are deployed
 # inside the test
@@ -49,5 +50,3 @@ else
 fi
 
 title "E2e test ${test} is finished"
-
-

scripts/dev/set_env_context.sh

@@ -1,13 +1,14 @@
 #!/usr/bin/env bash
 
 set -Eeou pipefail
+test "${MDB_BASH_DEBUG:-0}" -eq 1 && set -x
 
 # shellcheck disable=1091
 source scripts/funcs/errors
 
 script_name=$(readlink -f "${BASH_SOURCE[0]}")
 script_dir=$(dirname "${script_name}")
-context_file="${script_dir}/../../.generated/context.export.env"
+context_file="$(realpath "${script_dir}/../../.generated/context.export.env")"
 
 if [[ ! -f ${context_file} ]]; then
     fatal "File ${context_file} not found! Make sure to follow this guide to get started: https://wiki.corp.mongodb.com/display/MMS/Setting+up+local+development+and+E2E+testing#SettinguplocaldevelopmentandE2Etesting-GettingStartedGuide(VariantSwitching)"

scripts/dev/switch_context_by_test.sh

@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+
+set -Eeou pipefail
+test "${MDB_BASH_DEBUG:-0}" -eq 1 && set -x
+
+usage() {
+  echo "Switch context by passing the test (evergreen task name or full evergreen task URL)."
+  echo "If there is more than one variant running given test, then fzf picker is used."
+  echo "Usage: $0 <test>"
+  echo "  <test> is a task name from .evergreen.yml (e.g. 'e2e_search_community_basic') or a full Evergreen task URL."
+}
+
+source scripts/funcs/errors
+
+list_pytest_marks() {
+  rg -g '*.py' -o --no-line-number --no-heading --replace '$1' -m 1 \
+    '@(?:pytest\.)?mark\.(e2e_[a-zA-Z0-9_]+)' \
+    docker/mongodb-kubernetes-tests
+}
+
+pick_test_by_file_mark_or_task_url() {
+    if ! test_list="$(list_pytest_marks | sort -u)"; then
+      echo "Couldn't list pytest marks."
+      echo "${test_list}"
+      return 1
+    fi
+
+    test=$(fzf --print-query --header-first --with-nth '{2}: {1}' -d ':' --accept-nth 2 \
+      --header "Select file or task to find contexts where its used. You can paste full task's evergreen url here" <<< "${test_list}") || true
+    if [[ -z ${test} ]]; then
+      echo "Aborted selecting test"
+      return 1
+    fi
+
+    # test may contain one or two lines (file:mark or just mark/url)
+    number_of_selected_lines=$(wc -l <<< "${test}")
+    if [[ ${number_of_selected_lines} -eq 2 ]]; then
+      test="$(tail -n 1 <<< "${test}")"
+    elif [[ ${number_of_selected_lines} -gt 2 ]]; then
+      echo "Too many lines selected: ${test}"
+      return 1
+    fi
+
+    echo "${test}"
+}
+
+main() {
+  test="${1:-}"
+
+  if [[ -z ${test} ]]; then
+    test=$(pick_test_by_file_mark_or_task_url)
+    echo "Selected test: ${test}"
+  fi
+
+  if [[ "${test}" = *spruce.mongodb.com* ]]; then
+    find_variant_arg="--task-url"
+  else
+    find_variant_arg="--task-name"
+  fi
+
+  if ! contexts=$(scripts/evergreen/run_python.sh scripts/python/find_test_variants.py "${find_variant_arg}" "${test}"); then
+    echo "Couldn't find any test contexts running test: ${test}"
+    echo "${contexts}"
+    exit 1
+  fi
+
+  echo "Found contexts that are running test: ${test}"
+  echo "${contexts}"
+
+  selected_context="${contexts}"
+  if [[ $(wc -l <<< "${contexts}") -gt 1 ]]; then
+    if ! selected_context=$(fzf --header "${test} runs in multiple variants/contexts. Select one to switch context into." --header-first --layout=reverse <<< "${contexts}"); then
+      echo "Aborted selecting context"
+      exit 1
+    fi
+  fi
+
+  scripts/dev/switch_context.sh "${selected_context}"
+}
+
+main "$@"

scripts/evergreen/flakiness-report.py renamed to scripts/evergreen/flakiness_report.py

@@ -1,9 +1,9 @@
-import json
-import os
 import sys
 
 import requests
 
+from scripts.python.evergreen_api import get_evergreen_auth_headers
+
 EVERGREEN_API = "https://evergreen.mongodb.com/api"
 
 
@@ -18,16 +18,13 @@ def print_usage():
 
 
 def get_variants_with_retried_tasks() -> dict[str, list[dict]]:
-    evg_user = os.environ.get("EVERGREEN_USER", "")
-    api_key = os.environ.get("API_KEY", "")
-
-    if len(sys.argv) != 2 or evg_user == "" or api_key == "":
+    if len(sys.argv) != 2:
         print_usage()
-        exit(1)
+        raise RuntimeError("Exactly one argument (patch version number) must be provided")
 
     version = sys.argv[1]
+    headers = get_evergreen_auth_headers()
 
-    headers = {"Api-User": evg_user, "Api-Key": api_key}
     print("Fetching build variants...", file=sys.stderr)
     build_ids = requests.get(url=f"{EVERGREEN_API}/rest/v2/versions/{version}", headers=headers).json()
     build_statuses = [build_status for build_status in build_ids["build_variants_status"]]

scripts/funcs/checks

@@ -1,11 +1,5 @@
 #!/usr/bin/env bash
 
-pushd "${PWD}" > /dev/null || return
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
-cd "${DIR}" || return
-source errors
-popd > /dev/null || return
-
 check_env_var() {
     local var_name="$1"
     local msg="$2"

scripts/funcs/kubernetes

@@ -2,16 +2,9 @@
 
 set -Eeou pipefail
 
-pushd "${PWD}" > /dev/null || return
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
-cd "${DIR}" || return
-# shellcheck source=scripts/funcs/checks
-source checks
-# shellcheck source=scripts/funcs/errors
-source errors
-# shellcheck source=scripts/funcs/printing
-source printing
-popd > /dev/null || return
+source scripts/funcs/checks
+source scripts/funcs/errors
+source scripts/funcs/printing
 
 ensure_namespace() {
     local namespace="${1}"

scripts/python/__init__.py

@@ -0,0 +1 @@
+# Makes 'scripts.python' a Python package.

scripts/python/evergreen_api.py

@@ -0,0 +1,30 @@
+import os
+
+import requests
+
+EVERGREEN_API = "https://evergreen.mongodb.com/api"
+
+
+def get_evergreen_auth_headers() -> dict:
+    """
+    Returns Evergreen API authentication headers using EVERGREEN_USER and EVERGREEN_API_KEY environment variables.
+    Raises RuntimeError if either variable is missing.
+    """
+    evg_user = os.environ.get("EVERGREEN_USER", "")
+    api_key = os.environ.get("EVERGREEN_API_KEY", "")
+    if evg_user == "" or api_key == "":
+        raise RuntimeError("EVERGREEN_USER and EVERGREEN_API_KEY must be set")
+    return {"Api-User": evg_user, "Api-Key": api_key}
+
+
+def get_task_details(task_id: str) -> dict:
+    """
+    Fetch task details from Evergreen API for a given task_id.
+    Returns the JSON response as a dict.
+    Raises requests.HTTPError if the request fails.
+    """
+    url = f"{EVERGREEN_API}/rest/v2/tasks/{task_id}"
+    headers = get_evergreen_auth_headers()
+    response = requests.get(url, headers=headers)
+    response.raise_for_status()
+    return response.json()