fix: some krw fixes for component onboarding

scoheb · scoheb · commit 93d02d9f202b · 2025-07-06T09:54:29.000-04:00
- reconfigure pac if github throws error
  re-annotate the component to let it retry onboarding
- delete old branches script protects against deleting
  new branches by mistake.
- delete old branches only handles branches from the
  currently running test suite via new test env var
  called component_type which is now added to each
  test suite and checked for at run time.

Signed-off-by: Scott Hebert &lt;scoheb@gmail.com&gt;
diff --git a/integration-tests/collectors/test.env b/integration-tests/collectors/test.env
@@ -11,7 +11,8 @@ export tenant_namespace=dev-release-team-tenant
 export managed_namespace=managed-release-team-tenant
 
 export application_name=e2eapp-${uuid}
-export component_name=collector-${uuid}
+export component_type=collector
+export component_name=${component_type}-${uuid}
 export component_branch=${component_name}
 ## do not change this. it is a known branch created by Konflux
 export appstudio_component_branch="appstudio-${component_name}"
diff --git a/integration-tests/fbc-release/test.env b/integration-tests/fbc-release/test.env
@@ -11,7 +11,8 @@ export tenant_namespace=dev-release-team-tenant
 export managed_namespace=managed-release-team-tenant
 
 export application_name=e2eapp-${uuid}
-export component_name=fbc-release-${uuid}
+export component_type=fbc-release
+export component_name=${component_type}-${uuid}
 export component_branch=${component_name}
 ## do not change this. it is a known branch created by Konflux
 export appstudio_component_branch="appstudio-${component_name}"
diff --git a/integration-tests/lib/test-functions.sh b/integration-tests/lib/test-functions.sh
@@ -8,6 +8,11 @@ log_error() {
     exit "${2:-1}" # Exit with provided code or 1 by default
 }
 
+# Helper function to log errors
+log_warning() {
+    echo "⚠️ Warning: $1"
+}
+
 # Function to check for required environment variables
 check_env_vars() {
     echo "Checking required environment variables..."
@@ -19,13 +24,42 @@ check_env_vars() {
         ["RELEASE_CATALOG_GIT_REVISION"]="Missing RELEASE_CATALOG_GIT_REVISION"
     )
 
+    # Check core required variables
     for var_name in "${!required_vars[@]}"; do
         if [ -z "${!var_name}" ]; then
             echo "❌ error: ${required_vars[$var_name]}"
             missing_vars=$((missing_vars + 1))
         fi
     done
 
+    # Check variables from test.env files (static list of all variables found in test.env files)
+    echo "Checking test environment variables..."
+    local -a test_env_vars=(
+        "application_name"
+        "appstudio_component_branch"
+        "component_base_branch"
+        "component_branch"
+        "component_git_url"
+        "component_name"
+        "component_repo_name"
+        "component_type"
+        "managed_namespace"
+        "managed_sa_name"
+        "originating_tool"
+        "tenant_namespace"
+        "tenant_sa_name"
+    )
+    for var_name in "${test_env_vars[@]}"; do
+        # Check if variable is set
+        if [ -z "${!var_name}" ]; then
+            echo "❌ error: Missing test environment variable: $var_name"
+            missing_vars=$((missing_vars + 1))
+        else
+            echo "✅ $var_name is set"
+        fi
+    done
+
+    # Special file validation
     if [ -n "$VAULT_PASSWORD_FILE" ] && [ ! -f "$VAULT_PASSWORD_FILE" ]; then
         echo "❌ error: env var VAULT_PASSWORD_FILE points to a non-existent file: $VAULT_PASSWORD_FILE"
         missing_vars=$((missing_vars + 1))
@@ -38,7 +72,7 @@ check_env_vars() {
     if [ -n "$KUBECONFIG" ] ; then
       echo "Using provided KUBECONFIG"
     else
-      echo "⚠️ Warning: KUBECONFIG is not set. Assuming kubectl is configured correctly."
+      log_warning "KUBECONFIG is not set. Assuming kubectl is configured correctly."
     fi
     echo "Environment variable check complete."
 }
@@ -92,7 +126,7 @@ get_build_pipeline_run_url() { # args are ns, app, name
   console_url=${console_url%/}
 
   if [ -z "$console_url" ]; then
-      echo "⚠️ Warning: Could not retrieve custom-console-url. URL might be incomplete."
+      log_warning "Could not retrieve custom-console-url. URL might be incomplete."
       echo "kubectl get cm/pipelines-as-code -n openshift-pipelines -ojson" # Add command for easier debugging
       echo "${ns}/applications/${app}/pipelineruns/${name}" # Fallback or partial URL
   else
@@ -150,6 +184,7 @@ cleanup_resources() {
   echo "Killing any child processes..." >> "${cleanup_log_file}"
   pkill -e  -P $$
 
+  cat "${cleanup_log_file}"
   if [ "$err" -ne 0 ]; then
     exit "$err"
   fi
@@ -239,21 +274,54 @@ create_kubernetes_resources() {
 # Modifies global variables: component_pr, pr_number
 # Relies on global variables: component_name, tenant_namespace
 wait_for_component_initialization() {
-    echo -n "Waiting for component ${component_name} in namespace ${tenant_namespace} to be initialized: "
+    echo "Waiting for component ${component_name} in namespace ${tenant_namespace} to be initialized..."
+
+    local max_attempts=60  # 10 minutes with 10-second intervals
+    local attempt=1
     local component_annotations=""
-    while [ -z "${component_annotations}" ]; do
-      sleep 1
-      echo -n "."
+    local initialization_success=false
+
+    while [ $attempt -le $max_attempts ]; do
+      echo "Initialization check attempt ${attempt}/${max_attempts}..."
+
+      # Try to get component annotations
       component_annotations=$(kubectl get component/"${component_name}" -n "${tenant_namespace}" -ojson 2>/dev/null | \
         jq -r --arg k "build.appstudio.openshift.io/status" '.metadata.annotations[$k] // ""')
+
+      if [ -n "${component_annotations}" ]; then
+        # component_pr is made global by not declaring it local
+        component_pr=$(jq -r '.pac."merge-url" // ""' <<< "${component_annotations}")
+        if [ -n "${component_pr}" ]; then
+            echo "✅ Component initialized successfully"
+            initialization_success=true
+            break
+        else
+            log_warning "Could not get component PR from annotations: ${component_annotations}"
+            echo "Requesting a new configure-pac..."
+            kubectl annotate components/${component_name} build.appstudio.openshift.io/request=configure-pac -n "${tenant_namespace}"
+            echo "Waiting 10 seconds before retry..."
+            sleep 10
+        fi
+
+      else
+        log_warning "Component not yet initialized (attempt ${attempt}/${max_attempts})"
+
+        # Wait before retrying (except on the last attempt)
+        if [ $attempt -lt $max_attempts ]; then
+          echo "Waiting 10 seconds before retry..."
+          sleep 10
+        fi
+      fi
+
+      attempt=$((attempt + 1))
     done
-    echo ""
-    echo "️✅️ Initialized."
 
-    # component_pr is made global by not declaring it local
-    component_pr=$(jq -r '.pac."merge-url" // ""' <<< "${component_annotations}")
-    if [ -z "${component_pr}" ]; then
-      log_error "Could not get component PR from annotations: ${component_annotations}"
+    # Check if initialization ultimately succeeded
+    if [ "$initialization_success" = false ]; then
+      echo "🔴 error: component ${component_name} failed to initialize after ${max_attempts} attempts ($(($max_attempts * 10 / 60)) minutes)"
+      echo "   - Component may not exist in namespace ${tenant_namespace}"
+      echo "   - Component creation may have failed"
+      exit 1
     fi
 
     # pr_number is made global by not declaring it local
@@ -286,7 +354,7 @@ merge_github_pr() {
     # Retry loop for PR merge
     while [ $attempt -le $max_attempts ] && [ "$success" = false ]; do
         echo "Merge attempt ${attempt}/${max_attempts}..."
-        
+
         set +e
         merge_result=$(curl -L \
           -X PUT \
@@ -511,7 +579,8 @@ cleanup_old_resources() {
 #   - GITHUB_TOKEN environment variable must be set
 delete_old_branches() {
     local repo_name="$1"
-    local cutoff_days="${2:-1}"
+    local branch_prefix="$2"
+    local cutoff_days="${3:-1}"
 
     if [ -z "$repo_name" ]; then
         echo "🔴 Error: Repository name is required (format: owner/repo)"
@@ -531,5 +600,5 @@ delete_old_branches() {
     fi
 
     echo "🔍 Deleting branches in ${repo_name} older than ${cutoff_days} day(s)..."
-    CUTOFF_DATE="${cutoff_days} day" bash "$script_path" "$repo_name"
+    CUTOFF_DATE="${cutoff_days} day" bash "$script_path" "$repo_name" "$branch_prefix"
 }
diff --git a/integration-tests/push-to-addons-registry/test.env b/integration-tests/push-to-addons-registry/test.env
@@ -11,7 +11,8 @@ export tenant_namespace=dev-release-team-tenant
 export managed_namespace=managed-release-team-tenant
 
 export application_name=e2eapp-${uuid}
-export component_name=push-to-addons-registry-${uuid}
+export component_type=push-to-addons-registry
+export component_name=${component_type}-${uuid}
 export component_branch=${component_name}
 ## do not change this. it is a known branch created by Konflux
 export appstudio_component_branch="appstudio-${component_name}"
diff --git a/integration-tests/rhtap-service-push/test.env b/integration-tests/rhtap-service-push/test.env
@@ -11,7 +11,8 @@ export tenant_namespace=dev-release-team-tenant
 export managed_namespace=managed-release-team-tenant
 
 export application_name=e2eapp-${uuid}
-export component_name=rhtap-service-push-${uuid}
+export component_type=rhtap-service-push
+export component_name=${component_type}-${uuid}
 export component_branch=${component_name}
 ## do not change this. it is a known branch created by Konflux
 export appstudio_component_branch="appstudio-${component_name}"
diff --git a/integration-tests/run-test.sh b/integration-tests/run-test.sh
@@ -125,7 +125,7 @@ check_env_vars "$@" # Pass all args for consistency, though check_env_vars doesn
 parse_options "$@" # Parses options and sets CLEANUP, NO_CVE
 
 decrypt_secrets
-delete_old_branches "${component_repo_name}" 2
+delete_old_branches "${component_repo_name}" "${component_branch_prefix}" 2
 create_github_branch
 setup_namespaces # Ensures correct context before resource creation
 cleanup_old_resources "${originating_tool}"
diff --git a/integration-tests/scripts/delete-old-branches.sh b/integration-tests/scripts/delete-old-branches.sh
@@ -7,22 +7,30 @@
 # --------
 # This script automatically cleans up old branches in a GitHub repository by
 # deleting branches that haven't had any commits within a specified timeframe.
+# It only considers branches that start with a specified prefix.
 # It skips branches ending in "-base" and the "main" branch for safety.
 #
+# Branch deletion logic:
+# - Branches with commits after creation: deleted if last commit is older than cutoff
+# - Branches with no commits after creation: deleted only if branch is older than 2 days
+#
 # Features:
 # --------
 # - Identifies branches with no recent commits
 # - Configurable cutoff period (default: 1 day)
 # - Safe deletion with base branch protection
+# - Branch prefix filtering to target specific branch types
+# - Smart branch deletion: preserves new branches without commits, removes old unused branches
 # - Handles pagination for repositories with many branches
 # - Provides detailed output of deleted branches
 #
 # Usage:
 # -----
-#   ./delete-old-branches.sh <owner/repository>
+#   ./delete-old-branches.sh <owner/repository> <branch_prefix>
 #
 # Example:
-#   ./delete-old-branches.sh redhat/release-service
+#   ./delete-old-branches.sh redhat/release-service e2e-test
+#   ./delete-old-branches.sh konflux-ci/release-service-catalog integration-test
 #
 # Required Environment Variables:
 # ----------------------------
@@ -57,10 +65,21 @@ if [ -z "$repo_name" ] ; then
   exit 1
 fi
 
+branch_prefix=$2
+if [ -z "$branch_prefix" ] ; then
+  echo "🔴 error: missing parameter branch_prefix"
+  echo "Usage: $0 <owner/repository> <branch_prefix>"
+  exit 1
+fi
+
 CUTOFF_DATE="${CUTOFF_DATE:-1 day}"
 CUTOFF_SECONDS=$(date -d "$CUTOFF_DATE ago" +%s)
 
-echo "Finding branches in $repo_name with no commits for $CUTOFF_DATE..."
+# Additional cutoff for branches with no commits after creation
+BRANCH_AGE_CUTOFF_SECONDS=$(date -d "2 days ago" +%s)
+
+echo "Finding branches in $repo_name starting with '$branch_prefix' with no commits for $CUTOFF_DATE..."
+echo "Also checking for unused branches older than 2 days..."
 echo "------------------------------------------------------------------"
 
 # --- Main Logic ---
@@ -84,8 +103,32 @@ echo "$branches_data" | jq -r '.[] | .name + " " + .commit.sha' | while read -r
   if [[ "${branch_name}" == *"-base" ]] || [[ "${branch_name}" == "main" ]] ; then
     continue
   fi
-    
-  # 2. For each branch, get the date of its last commit
+
+  # Only consider branches that start with the specified prefix
+  if [[ "${branch_name}" != "${branch_prefix}"* ]] ; then
+    continue
+  fi
+
+  # 2. Get the branch creation date from git ref
+  branch_ref_data=$(curl -s -L \
+    -H "Accept: application/vnd.github+json" \
+    -H "Authorization: Bearer $GITHUB_TOKEN" \
+    -H "X-GitHub-Api-Version: 2022-11-28" \
+    "https://api.github.com/repos/$repo_name/git/refs/heads/$branch_name")
+
+  # Get the commit that created the branch
+  branch_creation_sha=$(echo "$branch_ref_data" | jq -r '.object.sha')
+  # Get the branch creation commit details
+  branch_creation_commit_data=$(curl -s -L \
+    -H "Accept: application/vnd.github+json" \
+    -H "Authorization: Bearer $GITHUB_TOKEN" \
+    -H "X-GitHub-Api-Version: 2022-11-28" \
+    "https://api.github.com/repos/$repo_name/commits/$branch_creation_sha")
+
+  branch_creation_date_str=$(echo "$branch_creation_commit_data" | jq -r '.commit.committer.date')
+  branch_creation_date_seconds=$(date -d "$branch_creation_date_str" +%s)
+
+  # 3. For each branch, get the date of its last commit
   commit_data=$(curl -s -L \
     -H "Accept: application/vnd.github+json" \
     -H "Authorization: Bearer $GITHUB_TOKEN" \
@@ -95,18 +138,45 @@ echo "$branches_data" | jq -r '.[] | .name + " " + .commit.sha' | while read -r
   commit_date_str=$(echo "$commit_data" | jq -r '.commit.committer.date')
   commit_date_seconds=$(date -d "$commit_date_str" +%s)
 
-  # 3. Compare the commit date with the cutoff date
-  if [ "$commit_date_seconds" -lt "$CUTOFF_SECONDS" ]; then
-    printf "Branch: %-40s Last Commit Date: %s\n" "$branch_name" "$commit_date_str"
+  # 4. Check if branch has commits after creation
+  if [ "$commit_date_seconds" -le "$branch_creation_date_seconds" ]; then
+    # No commits after branch creation - check if branch is older than 2 days
+    if [ "$branch_creation_date_seconds" -lt "$BRANCH_AGE_CUTOFF_SECONDS" ]; then
+      echo "Branch: $branch_name - No commits after creation but branch is older than 2 days"
+      echo "  Branch created: $branch_creation_date_str"
+      echo "  Last commit:   $commit_date_str"
 
-    echo "- Deleting $branch_name in $repo_name"
-    curl -L \
-    -X DELETE \
-    -H "Accept: application/vnd.github+json" \
-    -H "Authorization: Bearer $GITHUB_TOKEN" \
-    -H "X-GitHub-Api-Version: 2022-11-28" \
-    https://api.github.com/repos/$repo_name/git/refs/heads/$branch_name
+      echo "- Deleting $branch_name in $repo_name"
+      curl -L \
+      -X DELETE \
+      -H "Accept: application/vnd.github+json" \
+      -H "Authorization: Bearer $GITHUB_TOKEN" \
+      -H "X-GitHub-Api-Version: 2022-11-28" \
+      https://api.github.com/repos/$repo_name/git/refs/heads/$branch_name
+    else
+      echo "Branch: $branch_name SKIPPED - No commits after branch creation (branch too new)"
+      echo "  Branch created: $branch_creation_date_str"
+      echo "  Last commit:   $commit_date_str"
+    fi
+  else
+    # 5. Branch has commits after creation - use regular cutoff logic
+    if [ "$commit_date_seconds" -lt "$CUTOFF_SECONDS" ]; then
+      echo "Branch: $branch_name Last Commit Date: $commit_date_str"
+      echo "  Branch created: $branch_creation_date_str"
+      echo "  Has commits after branch creation: YES"
+
+      echo "- Deleting $branch_name in $repo_name"
+      curl -L \
+      -X DELETE \
+      -H "Accept: application/vnd.github+json" \
+      -H "Authorization: Bearer $GITHUB_TOKEN" \
+      -H "X-GitHub-Api-Version: 2022-11-28" \
+      https://api.github.com/repos/$repo_name/git/refs/heads/$branch_name
 
+    else
+      echo "Branch: $branch_name SKIPPED - Recent commits (within cutoff)"
+      echo "  Last commit: $commit_date_str"
+    fi
   fi
 done
 
diff --git a/tasks/managed/collect-data/collect-data.yaml b/tasks/managed/collect-data/collect-data.yaml
@@ -6,6 +6,7 @@ metadata:
   annotations:
     tekton.dev/pipelines.minVersion: "0.12.1"
     tekton.dev/tags: release
+    test: "scott"
 spec:
   description: >-
     Tekton task to collect data from release resources and verify that they do not contain any
