feat: check E2E test naming convention with linter

Introduced a new script, `hack/check-e2e-test-naming.sh`, to enforce a
naming convention for end-to-end tests. This script validates that test
function names start with specific prefixes (e.g., `TestGithub*`,
`TestGitlab*`) or include "Concurrency" to ensure they can be correctly
categorized and executed by CI jobs.

The Makefile was updated to include this new linting step, and the
GitHub Actions workflow configuration (`.github/workflows/e2e.yaml`) was
adjusted to correctly pass necessary secrets and variables for testing
against Bitbucket Cloud and GitHub. A minor adjustment was also made to
the `github_second_controller` test selection in
`hack/gh-workflow-ci.sh` to include "Others" tests.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>

Author: chmouel

.github/workflows/e2e.yaml

@@ -61,6 +61,7 @@ jobs:
       TARGET_TEAM_SLUGS: "pipeline-as-code,pipeline-as-code-contributors"
       TEST_BITBUCKET_CLOUD_API_URL: https://api.bitbucket.org/2.0
       TEST_BITBUCKET_CLOUD_E2E_REPOSITORY: cboudjna/pac-e2e-tests
+      TEST_BITBUCKET_CLOUD_TOKEN: ${{ secrets.BITBUCKET_CLOUD_TOKEN }}
       TEST_BITBUCKET_CLOUD_USER: cboudjna
       TEST_BITBUCKET_SERVER_API_URL: ${{ secrets.BITBUCKET_SERVER_API_URL }}
       TEST_BITBUCKET_SERVER_E2E_REPOSITORY: PAC/pac-e2e-tests
@@ -77,18 +78,17 @@ jobs:
       TEST_GITHUB_API_URL: api.github.com
       TEST_GITHUB_PRIVATE_TASK_NAME: task-remote
       TEST_GITHUB_PRIVATE_TASK_URL: https://github.com/openshift-pipelines/pipelines-as-code-e2e-tests-private/blob/main/remote_task.yaml
+      TEST_GITHUB_REPO_INSTALLATION_ID: ${{ vars.INSTALLATION_ID }}
       TEST_GITHUB_REPO_OWNER_GITHUBAPP: openshift-pipelines/pipelines-as-code-e2e-tests
       TEST_GITHUB_REPO_OWNER_WEBHOOK: openshift-pipelines/pipelines-as-code-e2e-tests-webhook
       TEST_GITHUB_SECOND_API_URL: ghe.pipelinesascode.com
       TEST_GITHUB_SECOND_EL_URL: http://ghe.paac-127-0-0-1.nip.io
       TEST_GITHUB_SECOND_REPO_INSTALLATION_ID: 1
       TEST_GITHUB_SECOND_REPO_OWNER_GITHUBAPP: pipelines-as-code/e2e
+      TEST_GITHUB_SECOND_TOKEN: ${{ secrets.TEST_GITHUB_SECOND_TOKEN }}
+      TEST_GITHUB_TOKEN: ${{ secrets.GH_APPS_TOKEN }}
       TEST_GITLAB_API_URL: https://gitlab.com
       TEST_GITLAB_PROJECT_ID: ${{ vars.TEST_GITLAB_PROJECT_ID }}
-      TEST_BITBUCKET_CLOUD_TOKEN: ${{ secrets.BITBUCKET_CLOUD_TOKEN }}
-      TEST_GITHUB_REPO_INSTALLATION_ID: ${{ vars.INSTALLATION_ID }}
-      TEST_GITHUB_TOKEN: ${{ secrets.GH_APPS_TOKEN }}
-      TEST_GITHUB_SECOND_TOKEN: ${{ secrets.TEST_GITHUB_SECOND_TOKEN }}
       TEST_GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}
     steps:
       - uses: actions/checkout@v6

Makefile

@@ -83,7 +83,12 @@ html-coverage: ## generate html coverage
 
 ##@ Linting
 .PHONY: lint
-lint: lint-go lint-yaml lint-md lint-python lint-shell ## run all linters
+lint: lint-go lint-yaml lint-md lint-python lint-shell lint-e2e-naming ## run all linters
+
+.PHONY: lint-e2e-naming
+lint-e2e-naming: ## check e2e test naming conventions
+	@echo "Checking E2E test naming conventions..."
+	@./hack/check-e2e-test-naming.sh
 
 .PHONY: lint-go
 lint-go: ## runs go linter on all go files

hack/check-e2e-test-naming.sh

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+# Validates that all E2E test functions follow the naming convention so they
+# can be properly partitioned into CI jobs by hack/gh-workflow-ci.sh.
+#
+# Valid prefixes: TestGithub*, TestGitea*, TestGitlab*, TestBitbucket*, TestOthers*
+# Concurrency tests (any name containing "Concurrency") are also allowed.
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+REPO_ROOT="$(cd "${SCRIPT_DIR}/.." && pwd)"
+
+# Find all test files in the test directory (excluding subdirectories)
+mapfile -t testfiles < <(find "${REPO_ROOT}/test/" -maxdepth 1 -name '*_test.go' 2>/dev/null)
+
+if [[ ${#testfiles[@]} -eq 0 ]]; then
+    echo "No test files found in ${REPO_ROOT}/test/"
+    exit 0
+fi
+
+# Extract all Test* function names
+all_tests=$(grep -hE '^func[[:space:]]+Test[[:alnum:]_]+' "${testfiles[@]}" | sed -E 's/^func[[:space:]]+([[:alnum:]_]+).*/\1/')
+
+# Valid patterns: TestGithub*, TestGitea*, TestGitlab*, TestBitbucket*, TestOthers*, or *Concurrency*
+valid_pattern='^Test(Github|Gitea|Gitlab|Bitbucket|Others)|Concurrency'
+
+orphaned_tests=()
+while IFS= read -r test; do
+    [[ -z "${test}" ]] && continue
+    if ! echo "${test}" | grep -qE "${valid_pattern}"; then
+        orphaned_tests+=("${test}")
+    fi
+done <<< "${all_tests}"
+
+if [[ ${#orphaned_tests[@]} -gt 0 ]]; then
+    echo "ERROR: The following E2E tests do not follow the naming convention:"
+    echo ""
+    for test in "${orphaned_tests[@]}"; do
+        # Find which file contains this test
+        file=$(grep -l "func ${test}" "${testfiles[@]}" 2>/dev/null | head -1)
+        echo "  - ${test} (in ${file:-unknown})"
+    done
+    echo ""
+    echo "Tests must start with one of: TestGithub*, TestGitea*, TestGitlab*, TestBitbucket*, TestOthers*"
+    echo "Or contain 'Concurrency' in the name for concurrency tests."
+    echo ""
+    echo "This ensures tests are properly assigned to CI jobs in hack/gh-workflow-ci.sh"
+    exit 1
+fi
+
+echo "All E2E tests follow the naming convention."

hack/gh-workflow-ci.sh

@@ -118,7 +118,7 @@ get_tests() {
     fi
     ;;
   github_second_controller)
-    printf '%s\n' "${all_tests}" | grep -iP 'GithubSecond' | grep -ivP 'Concurrency'
+    printf '%s\n' "${all_tests}" | grep -iP 'GithubSecond|Others' | grep -ivP 'Concurrency'
     ;;
   gitlab_bitbucket)
     printf '%s\n' "${all_tests}" | grep -iP 'Gitlab|Bitbucket' | grep -ivP 'Concurrency'