loads of improvements, can now actually start the agent without it crashing immediately

On-behalf-of: @SAP christoph.mewes@sap.com

Author: xrstf

.gitignore

@@ -1,6 +1,8 @@
 /_build/
 /_tools/
 /vendor/
+/.kcp.e2e/
+/.e2e/
 .cover
 *.kubeconfig
 *.pem

go.mod

@@ -5,6 +5,7 @@ go 1.22.0
 require (
 	github.com/Masterminds/sprig/v3 v3.3.0
 	github.com/evanphx/json-patch/v5 v5.9.0
+	github.com/go-logr/logr v1.4.2
 	github.com/go-logr/zapr v1.3.0
 	github.com/kcp-dev/apimachinery/v2 v2.0.1-0.20240817110845-a9eb9752bfeb
 	github.com/kcp-dev/client-go v0.0.0-20240912145314-f5949d81732a
@@ -44,7 +45,6 @@ require (
 	github.com/fatih/color v1.18.0 // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/fxamacker/cbor/v2 v2.7.0 // indirect
-	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-openapi/jsonpointer v0.19.6 // indirect
 	github.com/go-openapi/jsonreference v0.20.2 // indirect
 	github.com/go-openapi/swag v0.22.4 // indirect

hack/ci/run-e2e-tests.sh

@@ -17,6 +17,15 @@
 set -euo pipefail
 source hack/lib.sh
 
+# have a place to store things
+if [ -z "${ARTIFACTS:-}" ]; then
+  ARTIFACTS=.e2e/artifacts
+  mkdir -p "$ARTIFACTS"
+fi
+
+echodate "Build artifacts will be placed in $ARTIFACTS."
+export ARTIFACTS="$(realpath "$ARTIFACTS")"
+
 # build the agent, we will start it many times during the tests
 echodate "Building the api-syncagent…"
 make build
@@ -31,27 +40,44 @@ KUBEBUILDER_ASSETS="$(realpath "$KUBEBUILDER_ASSETS")"
 make _tools/kcp
 
 KCP_ROOT_DIRECTORY=.kcp.e2e
-KCP_LOGFILE=kcp.e2e.log
+KCP_LOGFILE="$ARTIFACTS/kcp.log"
+KCP_TOKENFILE=hack/ci/testdata/e2e-kcp.tokens
 
 echodate "Starting kcp…"
 rm -rf "$KCP_ROOT_DIRECTORY" "$KCP_LOGFILE"
 _tools/kcp start \
+  -v4 \
+  --token-auth-file "$KCP_TOKENFILE" \
   --root-directory "$KCP_ROOT_DIRECTORY" 1>"$KCP_LOGFILE" 2>&1 &
 
 stop_kcp() {
-  echodate "Stopping kcp processes…"
+  echodate "Stopping kcp processes (set \$KEEP_KCP=true to not do this)…"
   pkill -e kcp
 }
-append_trap stop_kcp EXIT
+
+if [[ -v KEEP_KCP ]] && $KEEP_KCP; then
+  echodate "\$KEEP_KCP is set, will not stop kcp once the script is finished."
+else
+  append_trap stop_kcp EXIT
+fi
+
+# make the token available to the Go tests
+export KCP_AGENT_TOKEN="$(grep e2e "$KCP_TOKENFILE" | cut -f1 -d,)"
 
 # Wait for kcp to be ready; this env name is also hardcoded in the Go tests.
 export KCP_KUBECONFIG="$KCP_ROOT_DIRECTORY/admin.kubeconfig"
 
-if ! retry_linear 3 20 kubectl --kubeconfig "$KCP_KUBECONFIG" get logicalcluster; then
+# the tenancy API becomes available pretty late during startup, so it's a good readiness check
+if ! retry_linear 3 20 kubectl --kubeconfig "$KCP_KUBECONFIG" get workspaces; then
   echodate "kcp never became ready."
   exit 1
 fi
 
+# makes it easier to reference thesefiles from various _test.go files.
+export ROOT_DIRECTORY="$(realpath .)"
+export KCP_KUBECONFIG="$(realpath "$KCP_KUBECONFIG")"
+export AGENT_BINARY="$(realpath _build/api-syncagent)"
+
 # time to run the tests
 echodate "Running e2e tests…"
 (set -x; go test -tags e2e -timeout 2h -v ./test/e2e/...)

hack/ci/testdata/e2e-kcp.tokens

@@ -0,0 +1 @@
+topphemmelig,api-syncagent-e2e,1111-2222-3333-4444,"api-syncagents"

hack/ci/testdata/kcp-kind-values.yaml

@@ -0,0 +1,56 @@
+//go:build e2e
+
+/*
+Copyright 2025 The KCP Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package apiresourceschema
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/go-logr/logr"
+
+	"github.com/kcp-dev/api-syncagent/test/utils"
+
+	ctrlruntime "sigs.k8s.io/controller-runtime"
+)
+
+func TestARSAreCreated(t *testing.T) {
+	ctx := context.Background()
+	ctrlruntime.SetLogger(logr.Discard())
+
+	// setup a test environment in kcp
+	fooKubconfig := utils.CreateHomeWorkspace(t, ctx, "foo", "my-api")
+
+	// start a service cluster
+	envtestKubeconfig, _, _ := utils.RunEnvtest(t)
+
+	t.Run("my subtest", func(t *testing.T) {
+		utils.RunAgent(
+			ctx,
+			t,
+			"bob",
+			fooKubconfig,
+			envtestKubeconfig,
+			"my-api",
+		)
+
+		time.Sleep(5 * time.Second)
+	})
+
+}