Kong / Kong/kubernetes-testing-framework

Allow running integration and E2E tests in tests workflow for external contributors

Open
#596 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/ci area/tests
Dominant language
Go
Stars
44
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Is there an existing issue for this?
  • I have searched the existing issues
Problem Statement

KTF's integration and E2E tests require secrets to run (for the Kong license, and for access to GKE). That makes them fail for PRs from external contributors. We'd like to run them against every PR, therefore we need to come up with a solution to that.

Proposed Solution

Trigger tests.yaml workflow on pull_request_target and ensure that in case a pull request author is an external contributor, the PR has to have a predefined label assigned (e.g. verified-for-running-ci) that would be assigned by a reviewer after ensuring that no potential secrets leak can happen due to the changes from PR.

Implement the workflow described by Michael Heap in his blogpost.

Additional information

No response

Acceptance Criteria
  • Integration and E2E tests can be run against PRs submitted by external contributors

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the tests.yaml workflow and the linked blog post about accessing secrets from forks. Determine how integration and E2E tests currently use the Kong license and GKE access, then define a safe workflow for external pull requests. Done means those tests run against PRs from external contributors without exposing secrets.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, go
Domain
ci-cd, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.