improvement: add e2e tests poc

[fangpenlin]

Description 📣

ref: https://linear.app/infisical/issue/PLATFRM-125/update-the-current-poc-with-design-doc-feedbacks

Type ✨

• Bug fix
• New feature
• Improvement
• Breaking change
• Documentation

Tests 🛠️

To run the tests, first, you need to set the path pointing to the infisical repo's backend folder as INFISICAL_BACKEND_DIR (keep in mind, you need to have feature flags set correctly, we will fix that in the future, but for now it needs to be done manually). For example:

export INFISICAL_BACKEND_DIR=/Users/fangpenlin/workspace/infisical/backend

next, the e2e test by default runs the executable as a subprocess, we need a path t
o the executable of CLI:

INFISICAL_CLI_EXECUTABLE=/Users/fangpenlin/works
pace/cli/infisical-merge

With these, you can then cd into the e2e folder and run the test like this

cd e2e
go test github.com/infisical/cli/e2e-tests/relay

or, you can run the above in just one line:

INFISICAL_BACKEND_DIR=/Users/fangpenlin/workspace/infisical/backend INFISICAL_CLI_EXECUTABLE=/Users/fangpenlin/works
pace/cli/infisical-merge go test github.com/infisical/cli/e2e-tests/rela

To make it possible to trace into the CLI code with a debugger, we also provide functionCall as an alt way to run the CLI main function. By doing so, you don't need INFISICAL_CLI_EXECUTABLE set. Instead, you need CLI_E2E_DEFAULT_RUN_METHOD=functionCall:

export CLI_E2E_DEFAULT_RUN_METHOD=functionCall

Or, you can run it with one line:

INFISICAL_BACKEND_DIR=/Users/fangpenlin/workspace/infisical/backend CLI_E2E_DEFAULT_RUN_METHOD=functionCall go test github.com/infisical/cli/e2e-tests/relay

[gitguardian]

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
9387833	Triggered	Generic Password	50ab9f6	e2e/packages/infisical/compose.go	View secret
8529478	Triggered	Generic High Entropy Secret	50ab9f6	e2e/packages/infisical/compose.go	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

[greptile-apps]

Greptile Summary

• Introduces comprehensive end-to-end testing infrastructure for Infisical CLI with Docker Compose orchestration, automated client code generation, and relay functionality testing
• Modifies CLI command execution pattern to support better testing by returning errors instead of calling os.Exit(1) and adding context-aware execution
• Adds automated OpenAPI client generation with endpoint filtering for focused E2E testing using oapi-codegen and proper Makefile automation

Important Files Changed

Filename	Overview
e2e/relay/relay_test.go	New comprehensive E2E test validating relay registration and heartbeat communication with proper Docker environment setup
main.go	Updated main function to properly handle command errors and exit with status code 1 on failures
packages/relay/relay.go	Added graceful shutdown handling with net.ErrClosed checks to support clean relay termination in tests
e2e/packages/client/provisioner.go	New provisioner for bootstrapping test environments with admin accounts and tokens; contains error message bug on line 83
e2e/compose.yaml	Docker Compose configuration using hardcoded credentials suitable for testing but lacking health checks

Confidence score: 4/5

• This PR implements a well-structured E2E testing framework with comprehensive Docker orchestration and proper abstraction layers
• Score reflects one bug found in error handling (wrong variable in error message) and some security considerations around hardcoded test credentials
• Pay close attention to e2e/packages/client/provisioner.go line 83 where the error message uses wrong response variable

[greptile-apps]

_{16 files reviewed, 7 comments}

_{Edit Code Review Agent Settings | Greptile}