chore: improve scripts for semi-manual testing

test-resources/bin/README.md

@@ -0,0 +1,7 @@
+Test Scripts
+============
+
+The scripts in this folder are meant for running semi-manual tests.
+They deploy the operator and applications under monitoring - this part is automated via scripts.
+Whether the instrumentation was successful or not needs to be verified manually.
+This can also be tested in a fully automated way by the tests in `test/e2e`.

test-resources/bin/ensure-namespace-exists.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+set -euo pipefail
+
+target_namespace=${1:-default}
+
+if [[ "${target_namespace}" == default  ]]; then
+  exit 0
+fi
+
+if ! kubectl get ns ${target_namespace} &> /dev/null; then
+  kubectl create ns ${target_namespace}
+fi

test-resources/bin/test-cleanup.sh

@@ -1,10 +1,17 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
+
 cd "$(dirname ${BASH_SOURCE})"/../..
 
-kubectl delete -k config/samples || true
+target_namespace=${1:-default}
+
+kubectl delete -n ${target_namespace} -k config/samples || true
 make uninstall || true
 make undeploy || true
-test-resources/node.js/express/undeploy.sh
-test-resources/collector/undeploy.sh
+test-resources/node.js/express/undeploy.sh ${target_namespace}
+test-resources/collector/undeploy.sh ${target_namespace}

test-resources/bin/test-roundtrip-01-aum-cr-operator.sh

@@ -1,44 +1,55 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 cd "$(dirname ${BASH_SOURCE})"/../..
 
-echo Make sure cert-manager is deployed as well:
-echo test-resources/cert-manager/deploy.sh
+if ! kubectl get ns cert-manager &> /dev/null; then
+  echo cert-manager namespace not found, deploying cert-manager
+  test-resources/cert-manager/deploy.sh
+fi
+
+target_namespace=${1:-default}
+
+echo "STEP 1: creating target namespace (if necessary)"
+test-resources/bin/ensure-namespace-exists.sh ${target_namespace}
 
-echo STEP 1: remove old test resources
-test-resources/bin/test-cleanup.sh
+echo "STEP 2: remove old test resources"
+test-resources/bin/test-cleanup.sh ${target_namespace}
 echo
 echo
 
-echo STEP 2: deploy the collector
-test-resources/collector/deploy.sh
+echo "STEP 3: deploy the collector to namespace ${target_namespace}"
+test-resources/collector/deploy.sh ${target_namespace}
 echo
 echo
 
-echo STEP 3: rebuild the operator image
+echo "STEP 4: rebuild the operator image"
 make docker-build
 echo
 echo
 
-echo STEP 4: deploy application under monitoring
-test-resources/node.js/express/build-and-deploy.sh
+echo "STEP 5: deploy application under monitoring"
+test-resources/node.js/express/build-and-deploy.sh ${target_namespace}
 echo
 echo
 
-echo STEP 5: install the custom resource definition
+echo "STEP 6: install the custom resource definition"
 make install
 echo
 echo
 
 sleep 5
 
-echo STEP 6: deploy the Dash0 custom resource to the target namespace
-kubectl apply -k config/samples
+echo "STEP 7: deploy the Dash0 custom resource to namespace ${target_namespace}"
+kubectl apply -n ${target_namespace} -k config/samples
 echo
 echo
 
 sleep 5
 
-echo STEP 7: deploy the Dash0 operator
-make deploy
+echo "STEP 8: deploy the Dash0 operator"
+make deploy

test-resources/bin/test-roundtrip-02-aum-operator-cr.sh

@@ -1,44 +1,55 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 cd "$(dirname ${BASH_SOURCE})"/../..
 
-echo Make sure cert-manager is deployed as well:
-echo test-resources/cert-manager/deploy.sh
+if ! kubectl get ns cert-manager &> /dev/null; then
+  echo cert-manager namespace not found, deploying cert-manager
+  test-resources/cert-manager/deploy.sh
+fi
+
+target_namespace=${1:-default}
+
+echo "STEP 1: creating target namespace (if necessary)"
+test-resources/bin/ensure-namespace-exists.sh ${target_namespace}
 
-echo STEP 1: remove old test resources
-test-resources/bin/test-cleanup.sh
+echo "STEP 2: remove old test resources"
+test-resources/bin/test-cleanup.sh ${target_namespace}
 echo
 echo
 
-echo STEP 2: deploy the collector
-test-resources/collector/deploy.sh
+echo "STEP 3: deploy the collector to namespace ${target_namespace}"
+test-resources/collector/deploy.sh ${target_namespace}
 echo
 echo
 
-echo STEP 3: rebuild the operator image
+echo "STEP 4: rebuild the operator image"
 make docker-build
 echo
 echo
 
-echo STEP 4: deploy application under monitoring
-test-resources/node.js/express/build-and-deploy.sh
+echo "STEP 5: deploy application under monitoring"
+test-resources/node.js/express/build-and-deploy.sh ${target_namespace}
 echo
 echo
 
-echo STEP 5: install the custom resource definition
+echo "STEP 6: install the custom resource definition"
 make install
 echo
 echo
 
 sleep 5
 
-echo STEP 6: deploy the Dash0 operator
+echo "STEP 7: deploy the Dash0 operator"
 make deploy
 echo
 echo
 
 sleep 5
 
-echo STEP 7: deploy the Dash0 custom resource to the target namespace
-kubectl apply -k config/samples
+echo "STEP 8: deploy the Dash0 custom resource to namespace ${target_namespace}"
+kubectl apply -n ${target_namespace} -k config/samples

test-resources/bin/test-roundtrip-03-operator-cr-aum.sh

@@ -1,46 +1,57 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 cd "$(dirname ${BASH_SOURCE})"/../..
 
-echo Make sure cert-manager is deployed as well:
-echo test-resources/cert-manager/deploy.sh
+if ! kubectl get ns cert-manager &> /dev/null; then
+  echo cert-manager namespace not found, deploying cert-manager
+  test-resources/cert-manager/deploy.sh
+fi
+
+target_namespace=${1:-default}
+
+echo "STEP 1: creating target namespace (if necessary)"
+test-resources/bin/ensure-namespace-exists.sh ${target_namespace}
 
-echo STEP 1: remove old test resources
-test-resources/bin/test-cleanup.sh
+echo "STEP 2: remove old test resources"
+test-resources/bin/test-cleanup.sh ${target_namespace}
 echo
 echo
 
-echo STEP 2: deploy the collector
-test-resources/collector/deploy.sh
+echo "STEP 3: deploy the collector to namespace ${target_namespace}"
+test-resources/collector/deploy.sh ${target_namespace}
 echo
 echo
 
-echo STEP 3: rebuild the operator image
+echo "STEP 4: rebuild the operator image"
 make docker-build
 echo
 echo
 
-echo STEP 4: install the custom resource definition
+echo "STEP 5: install the custom resource definition"
 make install
 echo
 echo
 
 sleep 5
 
-echo STEP 5: deploy the Dash0 operator
+echo "STEP 6: deploy the Dash0 operator"
 make deploy
 echo
 echo
 
 sleep 5
 
-echo STEP 6: deploy the Dash0 custom resource to the target namespace
-kubectl apply -k config/samples
+echo "STEP 7: deploy the Dash0 custom resource to namespace ${target_namespace}"
+kubectl apply -n ${target_namespace} -k config/samples
 echo
 echo
 
 sleep 5
 
-echo STEP 7: deploy application under monitoring
-test-resources/node.js/express/build-and-deploy.sh
+echo "STEP 8: deploy application under monitoring"
+test-resources/node.js/express/build-and-deploy.sh ${target_namespace}

test-resources/cert-manager/deploy.sh

@@ -1,17 +1,20 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 cd "$(dirname ${BASH_SOURCE})"
 
-
-echo undeploying
+echo "removing any left-overs from previous cert-manager installations (if any)"
 ./undeploy.sh
 
-echo deploying cert-manager
+echo "deploying cert-manager and waiting for it to become ready, this might take up to five minutes"
 helm install \
   cert-manager jetstack/cert-manager \
   --namespace cert-manager \
   --create-namespace \
   --version v1.14.5 \
   --set installCRDs=true \
-  --timeout 10s
+  --timeout 5m

test-resources/cert-manager/undeploy.sh

@@ -1,4 +1,8 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 cd "$(dirname ${BASH_SOURCE})"
@@ -7,4 +11,5 @@ helm uninstall \
   cert-manager \
   --namespace cert-manager \
   --ignore-not-found
-kubectl delete namespace cert-manager --ignore-not-found
+
+kubectl delete namespace cert-manager --ignore-not-found

test-resources/collector/deploy.sh

@@ -1,4 +1,8 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 cd "$(dirname ${BASH_SOURCE})"
@@ -8,12 +12,15 @@ if [[ ! -f values.yaml ]]; then
   exit 1
 fi
 
-# TODO deploy to a Dash0-specific namespace
+target_namespace=${1:-default}
 
 # helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
-helm uninstall dash0-opentelemetry-collector-daemonset --ignore-not-found
+
+./undeploy.sh ${target_namespace}
+
 helm install \
   dash0-opentelemetry-collector-daemonset \
   open-telemetry/opentelemetry-collector \
+  --namespace ${target_namespace} \
   --values values.yaml \
-  --set image.repository="otel/opentelemetry-collector-k8s"
+  --set image.repository="otel/opentelemetry-collector-k8s"

test-resources/collector/undeploy.sh

@@ -1,6 +1,12 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 cd "$(dirname ${BASH_SOURCE})"
 
-helm uninstall dash0-opentelemetry-collector-daemonset --ignore-not-found
+target_namespace=${1:-default}
+
+helm uninstall dash0-opentelemetry-collector-daemonset --namespace ${target_namespace} --ignore-not-found

test-resources/node.js/express/Dockerfile

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 ARG NODE_VERSION=20.13.1
 ARG ALPINE_VERSION=3.19
 

test-resources/node.js/express/build-and-deploy.sh

@@ -1,11 +1,17 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 cd "$(dirname ${BASH_SOURCE})"
 
+target_namespace=${1:-default}
+
 if [[ -z ${SKIP_DOCKER_BUILD:-} ]]; then
   docker build . -t dash0-operator-nodejs-20-express-test-app
 fi
 
-kubectl delete -f deploy.yaml || true
-kubectl apply -f deploy.yaml
+./undeploy.sh ${target_namespace}
+kubectl apply -n ${target_namespace} -f deploy.yaml

test-resources/node.js/express/deploy.yaml

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 apiVersion: v1
 kind: Service
 metadata:

test-resources/node.js/express/undeploy.sh

@@ -1,6 +1,12 @@
 #!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: Copyright 2024 Dash0 Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 set -euo pipefail
 
 cd "$(dirname ${BASH_SOURCE})"
 
-kubectl delete -f deploy.yaml || true
+target_namespace=${1:-default}
+
+kubectl delete -n ${target_namespace} -f deploy.yaml || true