Refactor e2e suite and cleanup (#384)

* Refactor e2e suite and cleanup

Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

* Ensure hanging repo deleted

Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

* Add README for api tests

Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

* Remove redundant testdata

Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

* Refactor to table driven and cleanup

Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

* Revert set-annotations on pkg update

Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

* Add edit task assertions

Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

---------

Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

Author: efiacor

.github/workflows/porch-e2e-ci-jobs.yaml

@@ -86,12 +86,12 @@ jobs:
         include:
           - name: "Porch E2E Tests"
             make_target: "run-in-kind"
-            test_path: "${GITHUB_WORKSPACE}/test/e2e"
+            test_path: "${GITHUB_WORKSPACE}/test/e2e/api"
             test_env: "E2E=1"
             log_name: "porch-e2e-server.log"
           - name: "Porch E2E Tests (DB Cache)"
             make_target: "run-in-kind-db-cache"
-            test_path: "${GITHUB_WORKSPACE}/test/e2e"
+            test_path: "${GITHUB_WORKSPACE}/test/e2e/api"
             test_env: "E2E=1 DB_CACHE=1"
             log_name: "porch-e2e-dbcache-server.log"
           - name: "Porch CLI E2E Tests"

test/e2e/api/README.md

@@ -0,0 +1,46 @@
+# Porch E2E API Tests
+
+## Prerequisites
+```bash
+export E2E=1
+```
+
+## Running Tests
+
+### Run Entire Suite
+```bash
+E2E=1 go test -v ./test/e2e/api
+```
+
+### Run Single Test
+```bash
+E2E=1 go test -v ./test/e2e/api -run "TestE2E/TestGitRepository"
+```
+
+### Run Table-Driven Sub-Test
+```bash
+E2E=1 go test -v ./test/e2e/api -run "TestE2E/TestBasicLifecycle/ProposeApprove"
+```
+
+### Pattern Matching
+```bash
+E2E=1 go test -v ./test/e2e/api -run "TestE2E/.*Evaluator"
+```
+
+### List All Available Tests
+```bash
+# List all test method names with source files
+grep "func.*Test" ./test/e2e/api/*_test.go | grep -o "[^/]*_test.go:.*Test[A-Za-z0-9]*" | sort
+```
+
+## Test Structure
+
+- **Suite-based**: All tests run under `TestE2E` using testify/suite
+- **Individual methods**: `TestCloneFromUpstream`, `TestConcurrentEdits`, etc.
+- **Table-driven sub-tests**: Some tests have sub-cases with `/` separator
+
+## Common Issues
+
+1. **"no tests to run"**: Use correct test method name (e.g., `TestCloneFromUpstream`)
+2. **Missing E2E env var**: Set `E2E=1` before running
+3. **Timeout issues**: Tests may take several minutes in slow environments