This directory holds the end-to-end tests for func-e.
By default, end-to-end (e2e) tests verify a func-e binary built from main.go.
End-to-end tests default to look for func-e (or func-e.exe in Windows), in the project root (current directory).
go build --ldflags '-s -w' .
go test -parallel 1 -v -failfast ./e2eWhen run via make, func-e is built on-demand by $(current_binary) target (same as make build).
Ex. $PWD/build/func-e_darwin_amd64/func-e
It is also a good idea to override FUNC_E_HOME when running e2e, since by default it uses $HOME/.func-e.
FUNC_E_HOME=/tmp/test make e2eIf the func-e version is a snapshot and "envoy-versions.json" exists, tests run against the local. This allows local
development and pull requests to verify changes not yet published
or those that effect the schema.
The envoy version used in tests default to /internal/version/last_known_envoy.txt.
This is an end-to-end test of the func-e binary: it is easy to get confused about what is happening when some code
is in the binary and other shared. To avoid confusion, only use code in /internal on an exception basis.
We historically added functions into main only for e2e and left them after they became unused. Adding code into /internal also effects main code health statistics. Hence, we treat e2e as a separate project even though it shares a go.mod with /internal. Specifically, we don't add code into /internal which only needs to exist here.
Currently, e2e shares go.mod with /internal. This is for simplification in build config and details such as linters. However, we carry a risk of dependencies used here ending up accidentally used in /internal. The IDE will think this is the same project as /internal and suggest libraries with auto-complete.
For example, if /internal used "archiver/v3" accidentally, it would bloat the binary by almost 3MB. For this reason, please be careful and only add dependencies absolutely needed.
If go.mod ever supports test-only scope, this risk would go away, because IDEs could hide test dependencies from main auto-complete suggestions. However, it is unlikely go will allow a test scope: golang/go#26913.