CLOUDP-341025: Refactor of existing snippets on master #366
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
MCK 1.3.1 Release Notes |
lsierant force-pushed the lsierant/snippets-refactor branch 2 times, most recently from 3420ed1 to be64ad8 Compare lsierant changed the title lsierant force-pushed the lsierant/snippets-refactor branch from d5fd23e to b08575c Compare lsierant force-pushed the lsierant/snippets-refactor branch from b08575c to d6f389d Compare 
lucian-tosa approved these changes Aug 26, 2025
| @@ -1,16 +1,36 @@ | |||
| #!/usr/bin/env bash | |||
| #!/bin/bash | |||
There was a problem hiding this comment.
oh, thanks, it's a debugging leftover!
Comment on lines 109 to 128
| # Capture output first to check if it contains actual resources | ||
| local temp_output | ||
| temp_output=$(kubectl --context="${context}" -n "${namespace}" ${action} "${object}" 2>&1) | ||
| | ||
| # Check if output contains actual resources (not just empty list) | ||
| # Skip if it's an empty YAML list (contains "items: []") | ||
| if printf '%s\n' "${temp_output}" | grep -Fq "items: []"; then | ||
| # Empty list, don't create file | ||
| return | ||
| fi | ||
| | ||
| if [[ -n "${out_file}" ]]; then | ||
| { | ||
| header "${msg}" | ||
| echo "${temp_output}" | ||
| } > "${out_file}" | ||
| else | ||
| header "${msg}" | ||
| kubectl --context="${context}" -n "${namespace}" ${action} "${object}" 2>&1 | ||
| fi |
There was a problem hiding this comment.
nit: This indentation looks off in github.
lsierant force-pushed the lsierant/snippets-refactor branch from bc7095f to 9380a5a Compare lsierant added the skip-changelog lsierant force-pushed the lsierant/snippets-refactor branch 2 times, most recently from 674c669 to 6d985d9 Compare 
anandsyncs reviewed Sep 1, 2025
| | ||
| run 9100_delete_backup_namespaces.sh & | ||
| run 9200_delete_om.sh & | ||
| run ra-06_9100_delete_backup_namespaces.sh & |
There was a problem hiding this comment.
What is the significance of this ra prefix?
Edit: I released it probably stands for reference architecture(s) 😄
anandsyncs reviewed Sep 1, 2025
| @@ -1,4 +1,4 @@ | |||
| kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${OPERATOR_NAMESPACE}" rollout status deployment/mongodb-kubernetes-operator-multi-cluster | |||
| kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${OPERATOR_NAMESPACE}" rollout status --timeout=2m deployment/mongodb-kubernetes-operator-multi-cluster | |||
There was a problem hiding this comment.
Yes, but I don't have any proof anymore 🙈
I mean - not stuck, sometimes it took longer than default timeout on GKE clusters. Not sure why.
anandsyncs approved these changes Sep 1, 2025
lsierant force-pushed the lsierant/snippets-refactor branch 3 times, most recently from d63c5c1 to 56dbb8b Compare 
| evergreen refresh |
lsierant force-pushed the lsierant/snippets-refactor branch from 56dbb8b to ed39d15 Compare 
lsierant force-pushed the lsierant/snippets-refactor branch from 3588fa1 to d9d020a Compare This was referenced Sep 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Summary
This PR refactors how we generate and manage outputs from snippet tests.
Before, every snippet module has its own output/ directory. But because snippet modules were reused across different tests we had no way of storing the outputs from different test runs (the files were overwritten).
Changes were needed to accommodate upcoming Search snippets, but due to the large scale of this refactoring it was extracted onto master.
Only changes to public/architectures has been made performed in this PR. Existing search snippets are left intact and will be refactored on the search feature branch. After this PR is approved, a followup PR in the docs repo will be created adjusting for the new include paths.
This PR incorporated changes from #150 to fix diagnostic dumps from GKE clusters.
What this change will help
scripts/code_snippets/tests/outputs/test_*instead of traversing the tree and dealing with the conflicts pushed from different test runs.Glossary
Snippet module- directory containingtest.shand scripts in acode_snippetssub directory. It's a reusable set of scripts, e.g.public/architectures/setup-multi-cluster/ra-01-setup-gke.scripts/code_snippets/tests/test_gke_multi_cluster_no_mesh_snippets.sh,scripts/code_snippets/test_gke_multi_cluster_snippets.sh.scripts/code_snippetsdir (e.g.scripts/code_snippets/task_gke_multi_cluster_no_mesh_snippets_test.sh).Snippet outputs- output files (.out) gathered from aSnippet test.Changes
scripts/code_snippets/tests/outputs/<test name>directory, which is gathering all outputs from a given snippet test.scripts/code_snippets/validate_snippets.py) added topre-committhat enforces this convention., e.g.ra-02-setup-operator. Every snippet file belonging to this module should be also prefixed (e.g.ra-02_0046_create_image_pull_secrets.sh`)Here is the fragment of the current directory structure:
Proof of Work
Green EVG run for all snippets.
Checklist
skip-changeloglabel if not needed