Run E2E Tests with Telepresence (#515)

Author: chatton

Makefile

@@ -64,6 +64,15 @@ fmt:
 vet:
 	go vet ./...
 
+# Run e2e tests locally using go build while also setting up a proxy in the shell to allow
+# the test to run as if it were inside the cluster. This enables mongodb connectivity while running locally.
+e2e-telepresence: install
+	telepresence connect; \
+	telepresence status; \
+	eval $$(scripts/dev/get_e2e_env_vars.py $(cleanup)); \
+    go test -v -timeout=30m -failfast ./test/e2e/$(test); \
+	telepresence quit
+
 # Run e2e test by deploying test image in kubernetes.
 e2e-k8s: install e2e-image
 	python scripts/dev/e2e.py --perform-cleanup --test $(test)
@@ -126,3 +135,5 @@ rm -rf $$TMP_DIR ;\
 }
 endef
 
+install-prerequisites-macos:
+	scripts/dev/install_prerequisites.sh

docs/contributing.md

@@ -201,6 +201,19 @@ make e2e-k8s test=<test-name>
 This will run the `replica_set` E2E test which is a simple test which installs a
 MongoDB Replica Set and asserts that the deployed server can be connected to.
 
+
+### Run the test locally with go test & Telepresence
+```sh
+make e2e-telepresence test=<test-name>
+```
+
+This method uses telepresence to allow connectivity as if your local machine is in the kubernetes cluster,
+there will be full MongoDB connectivity using `go test` locally.
+
+Note: you must install [telepresence](https://www.getambassador.io/docs/telepresence/latest/quick-start/) before using this method.
+
+If on MacOS, you can run `make install-prerequisites-macos` which will perform the installation.
+
 ## Troubleshooting
 When you run a test locally, if the `e2e-test` pod is present, you will have to
 first manually delete it; failing to do so will cause the `e2e-test` pod to fail.

scripts/dev/install_prerequisites.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+if ! command -v telepresence &> /dev/null; then \
+	echo "Telepresence not found, installing now"
+	sudo curl -fL https://app.getambassador.io/download/tel2/darwin/amd64/latest/telepresence -o /usr/local/bin/telepresence
+	sudo chmod a+x /usr/local/bin/telepresence
+else
+	echo "Telepresence already installed."
+fi