mirror of
https://github.com/go-gitea/gitea.git
synced 2026-03-17 14:24:07 +00:00
b3b2d111da
This PR adds per-runner disable/enable support for Gitea Actions so a registered runner can be paused from picking up new jobs without unregistering. Disabled runners stay registered and online but are excluded from new task assignment; running tasks are allowed to finish. Re-enabling restores pickup, and runner list/get responses now expose disabled state. Also added an endpoint for testing http://localhost:3000/devtest/runner-edit/enable <img width="1509" height="701" alt="Bildschirmfoto 2026-02-27 um 22 13 24" src="https://github.com/user-attachments/assets/5328eda9-e59c-46b6-b398-f436e50ee3da" /> Fixes: https://github.com/go-gitea/gitea/issues/36767
762 lines
28 KiB
Go
762 lines
28 KiB
Go
// Copyright 2024 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"encoding/base64"
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"reflect"
|
|
"strconv"
|
|
"testing"
|
|
"time"
|
|
|
|
actions_model "code.gitea.io/gitea/models/actions"
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/json"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
actions_service "code.gitea.io/gitea/services/actions"
|
|
|
|
runnerv1 "code.gitea.io/actions-proto-go/runner/v1"
|
|
"connectrpc.com/connect"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestJobWithNeeds(t *testing.T) {
|
|
testCases := []struct {
|
|
treePath string
|
|
fileContent string
|
|
outcomes map[string]*mockTaskOutcome
|
|
expectedStatuses map[string]string
|
|
}{
|
|
{
|
|
treePath: ".gitea/workflows/job-with-needs.yml",
|
|
fileContent: `name: job-with-needs
|
|
on:
|
|
push:
|
|
paths:
|
|
- '.gitea/workflows/job-with-needs.yml'
|
|
jobs:
|
|
job1:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- run: echo job1
|
|
job2:
|
|
runs-on: ubuntu-latest
|
|
needs: [job1]
|
|
steps:
|
|
- run: echo job2
|
|
`,
|
|
outcomes: map[string]*mockTaskOutcome{
|
|
"job1": {
|
|
result: runnerv1.Result_RESULT_SUCCESS,
|
|
},
|
|
"job2": {
|
|
result: runnerv1.Result_RESULT_SUCCESS,
|
|
},
|
|
},
|
|
expectedStatuses: map[string]string{
|
|
"job1": actions_model.StatusSuccess.String(),
|
|
"job2": actions_model.StatusSuccess.String(),
|
|
},
|
|
},
|
|
{
|
|
treePath: ".gitea/workflows/job-with-needs-fail.yml",
|
|
fileContent: `name: job-with-needs-fail
|
|
on:
|
|
push:
|
|
paths:
|
|
- '.gitea/workflows/job-with-needs-fail.yml'
|
|
jobs:
|
|
job1:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- run: echo job1
|
|
job2:
|
|
runs-on: ubuntu-latest
|
|
needs: [job1]
|
|
steps:
|
|
- run: echo job2
|
|
`,
|
|
outcomes: map[string]*mockTaskOutcome{
|
|
"job1": {
|
|
result: runnerv1.Result_RESULT_FAILURE,
|
|
},
|
|
},
|
|
expectedStatuses: map[string]string{
|
|
"job1": actions_model.StatusFailure.String(),
|
|
"job2": actions_model.StatusSkipped.String(),
|
|
},
|
|
},
|
|
{
|
|
treePath: ".gitea/workflows/job-with-needs-fail-if.yml",
|
|
fileContent: `name: job-with-needs-fail-if
|
|
on:
|
|
push:
|
|
paths:
|
|
- '.gitea/workflows/job-with-needs-fail-if.yml'
|
|
jobs:
|
|
job1:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- run: echo job1
|
|
job2:
|
|
runs-on: ubuntu-latest
|
|
if: ${{ always() }}
|
|
needs: [job1]
|
|
steps:
|
|
- run: echo job2
|
|
`,
|
|
outcomes: map[string]*mockTaskOutcome{
|
|
"job1": {
|
|
result: runnerv1.Result_RESULT_FAILURE,
|
|
},
|
|
"job2": {
|
|
result: runnerv1.Result_RESULT_SUCCESS,
|
|
},
|
|
},
|
|
expectedStatuses: map[string]string{
|
|
"job1": actions_model.StatusFailure.String(),
|
|
"job2": actions_model.StatusSuccess.String(),
|
|
},
|
|
},
|
|
}
|
|
onGiteaRun(t, func(t *testing.T, u *url.URL) {
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
session := loginUser(t, user2.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository, auth_model.AccessTokenScopeWriteUser)
|
|
|
|
apiRepo := createActionsTestRepo(t, token, "actions-jobs-with-needs", false)
|
|
runner := newMockRunner()
|
|
runner.registerAsRepoRunner(t, user2.Name, apiRepo.Name, "mock-runner", []string{"ubuntu-latest"}, false)
|
|
|
|
for _, tc := range testCases {
|
|
t.Run("test "+tc.treePath, func(t *testing.T) {
|
|
// create the workflow file
|
|
opts := getWorkflowCreateFileOptions(user2, apiRepo.DefaultBranch, "create "+tc.treePath, tc.fileContent)
|
|
fileResp := createWorkflowFile(t, token, user2.Name, apiRepo.Name, tc.treePath, opts)
|
|
|
|
// fetch and execute task
|
|
for i := 0; i < len(tc.outcomes); i++ {
|
|
task := runner.fetchTask(t)
|
|
jobName := getTaskJobNameByTaskID(t, token, user2.Name, apiRepo.Name, task.Id)
|
|
outcome := tc.outcomes[jobName]
|
|
assert.NotNil(t, outcome)
|
|
runner.execTask(t, task, outcome)
|
|
}
|
|
|
|
// check result
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/actions/tasks", user2.Name, apiRepo.Name)).
|
|
AddTokenAuth(token)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var actionTaskRespAfter api.ActionTaskResponse
|
|
DecodeJSON(t, resp, &actionTaskRespAfter)
|
|
for _, apiTask := range actionTaskRespAfter.Entries {
|
|
if apiTask.HeadSHA != fileResp.Commit.SHA {
|
|
continue
|
|
}
|
|
status := apiTask.Status
|
|
assert.Equal(t, status, tc.expectedStatuses[apiTask.Name])
|
|
}
|
|
})
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestJobNeedsMatrix(t *testing.T) {
|
|
testCases := []struct {
|
|
treePath string
|
|
fileContent string
|
|
outcomes map[string]*mockTaskOutcome
|
|
expectedTaskNeeds map[string]*runnerv1.TaskNeed // jobID => TaskNeed
|
|
}{
|
|
{
|
|
treePath: ".gitea/workflows/jobs-outputs-with-matrix.yml",
|
|
fileContent: `name: jobs-outputs-with-matrix
|
|
on:
|
|
push:
|
|
paths:
|
|
- '.gitea/workflows/jobs-outputs-with-matrix.yml'
|
|
jobs:
|
|
job1:
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
output_1: ${{ steps.gen_output.outputs.output_1 }}
|
|
output_2: ${{ steps.gen_output.outputs.output_2 }}
|
|
output_3: ${{ steps.gen_output.outputs.output_3 }}
|
|
strategy:
|
|
matrix:
|
|
version: [1, 2, 3]
|
|
steps:
|
|
- name: Generate output
|
|
id: gen_output
|
|
run: |
|
|
version="${{ matrix.version }}"
|
|
echo "output_${version}=${version}" >> "$GITHUB_OUTPUT"
|
|
job2:
|
|
runs-on: ubuntu-latest
|
|
needs: [job1]
|
|
steps:
|
|
- run: echo '${{ toJSON(needs.job1.outputs) }}'
|
|
`,
|
|
outcomes: map[string]*mockTaskOutcome{
|
|
"job1 (1)": {
|
|
result: runnerv1.Result_RESULT_SUCCESS,
|
|
outputs: map[string]string{
|
|
"output_1": "1",
|
|
"output_2": "",
|
|
"output_3": "",
|
|
},
|
|
},
|
|
"job1 (2)": {
|
|
result: runnerv1.Result_RESULT_SUCCESS,
|
|
outputs: map[string]string{
|
|
"output_1": "",
|
|
"output_2": "2",
|
|
"output_3": "",
|
|
},
|
|
},
|
|
"job1 (3)": {
|
|
result: runnerv1.Result_RESULT_SUCCESS,
|
|
outputs: map[string]string{
|
|
"output_1": "",
|
|
"output_2": "",
|
|
"output_3": "3",
|
|
},
|
|
},
|
|
},
|
|
expectedTaskNeeds: map[string]*runnerv1.TaskNeed{
|
|
"job1": {
|
|
Result: runnerv1.Result_RESULT_SUCCESS,
|
|
Outputs: map[string]string{
|
|
"output_1": "1",
|
|
"output_2": "2",
|
|
"output_3": "3",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
treePath: ".gitea/workflows/jobs-outputs-with-matrix-failure.yml",
|
|
fileContent: `name: jobs-outputs-with-matrix-failure
|
|
on:
|
|
push:
|
|
paths:
|
|
- '.gitea/workflows/jobs-outputs-with-matrix-failure.yml'
|
|
jobs:
|
|
job1:
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
output_1: ${{ steps.gen_output.outputs.output_1 }}
|
|
output_2: ${{ steps.gen_output.outputs.output_2 }}
|
|
output_3: ${{ steps.gen_output.outputs.output_3 }}
|
|
strategy:
|
|
matrix:
|
|
version: [1, 2, 3]
|
|
steps:
|
|
- name: Generate output
|
|
id: gen_output
|
|
run: |
|
|
version="${{ matrix.version }}"
|
|
echo "output_${version}=${version}" >> "$GITHUB_OUTPUT"
|
|
job2:
|
|
runs-on: ubuntu-latest
|
|
if: ${{ always() }}
|
|
needs: [job1]
|
|
steps:
|
|
- run: echo '${{ toJSON(needs.job1.outputs) }}'
|
|
`,
|
|
outcomes: map[string]*mockTaskOutcome{
|
|
"job1 (1)": {
|
|
result: runnerv1.Result_RESULT_SUCCESS,
|
|
outputs: map[string]string{
|
|
"output_1": "1",
|
|
"output_2": "",
|
|
"output_3": "",
|
|
},
|
|
},
|
|
"job1 (2)": {
|
|
result: runnerv1.Result_RESULT_FAILURE,
|
|
outputs: map[string]string{
|
|
"output_1": "",
|
|
"output_2": "",
|
|
"output_3": "",
|
|
},
|
|
},
|
|
"job1 (3)": {
|
|
result: runnerv1.Result_RESULT_SUCCESS,
|
|
outputs: map[string]string{
|
|
"output_1": "",
|
|
"output_2": "",
|
|
"output_3": "3",
|
|
},
|
|
},
|
|
},
|
|
expectedTaskNeeds: map[string]*runnerv1.TaskNeed{
|
|
"job1": {
|
|
Result: runnerv1.Result_RESULT_FAILURE,
|
|
Outputs: map[string]string{
|
|
"output_1": "1",
|
|
"output_2": "",
|
|
"output_3": "3",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
onGiteaRun(t, func(t *testing.T, u *url.URL) {
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
session := loginUser(t, user2.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository, auth_model.AccessTokenScopeWriteUser)
|
|
|
|
apiRepo := createActionsTestRepo(t, token, "actions-jobs-outputs-with-matrix", false)
|
|
runner := newMockRunner()
|
|
runner.registerAsRepoRunner(t, user2.Name, apiRepo.Name, "mock-runner", []string{"ubuntu-latest"}, false)
|
|
|
|
for _, tc := range testCases {
|
|
t.Run("test "+tc.treePath, func(t *testing.T) {
|
|
opts := getWorkflowCreateFileOptions(user2, apiRepo.DefaultBranch, "create "+tc.treePath, tc.fileContent)
|
|
createWorkflowFile(t, token, user2.Name, apiRepo.Name, tc.treePath, opts)
|
|
|
|
for i := 0; i < len(tc.outcomes); i++ {
|
|
task := runner.fetchTask(t)
|
|
jobName := getTaskJobNameByTaskID(t, token, user2.Name, apiRepo.Name, task.Id)
|
|
outcome := tc.outcomes[jobName]
|
|
assert.NotNil(t, outcome)
|
|
runner.execTask(t, task, outcome)
|
|
}
|
|
|
|
task := runner.fetchTask(t)
|
|
actualTaskNeeds := task.Needs
|
|
assert.Len(t, actualTaskNeeds, len(tc.expectedTaskNeeds))
|
|
for jobID, tn := range tc.expectedTaskNeeds {
|
|
actualNeed := actualTaskNeeds[jobID]
|
|
assert.Equal(t, tn.Result, actualNeed.Result)
|
|
assert.Len(t, actualNeed.Outputs, len(tn.Outputs))
|
|
for outputKey, outputValue := range tn.Outputs {
|
|
assert.Equal(t, outputValue, actualNeed.Outputs[outputKey])
|
|
}
|
|
}
|
|
})
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestRunnerDisableEnable(t *testing.T) {
|
|
onGiteaRun(t, func(t *testing.T, _ *url.URL) {
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
session := loginUser(t, user2.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository, auth_model.AccessTokenScopeWriteUser)
|
|
|
|
t.Run("BasicDisableEnable", func(t *testing.T) {
|
|
testData := prepareRunnerDisableEnableTest(t, user2, token, "actions-runner-disable-enable", "mock-runner", "runner-disable-enable")
|
|
|
|
task1 := testData.runner.fetchTask(t)
|
|
require.NotNil(t, task1)
|
|
|
|
triggerRunnerDisableEnableRun(t, user2, token, testData.repo, "second-push.txt")
|
|
|
|
req := newRunnerUpdateRequest(t, fmt.Sprintf("/api/v1/repos/%s/%s/actions/runners/%d", user2.Name, testData.repo.Name, testData.runnerID), true).AddTokenAuth(token)
|
|
MakeRequest(t, req, http.StatusOK)
|
|
|
|
testData.runner.execTask(t, task1, &mockTaskOutcome{result: runnerv1.Result_RESULT_SUCCESS})
|
|
testData.runner.fetchNoTask(t, 2*time.Second)
|
|
|
|
req = newRunnerUpdateRequest(t, fmt.Sprintf("/api/v1/repos/%s/%s/actions/runners/%d", user2.Name, testData.repo.Name, testData.runnerID), false).AddTokenAuth(token)
|
|
MakeRequest(t, req, http.StatusOK)
|
|
|
|
task2 := testData.runner.fetchTask(t, 5*time.Second)
|
|
require.NotNil(t, task2)
|
|
testData.runner.execTask(t, task2, &mockTaskOutcome{result: runnerv1.Result_RESULT_SUCCESS})
|
|
})
|
|
|
|
t.Run("TasksVersionPath", func(t *testing.T) {
|
|
testData := prepareRunnerDisableEnableTest(t, user2, token, "actions-runner-version-path", "mock-runner-version-path", "runner-version-path")
|
|
|
|
var firstVersion int64
|
|
var task1 *runnerv1.Task
|
|
ddl := time.Now().Add(5 * time.Second)
|
|
for time.Now().Before(ddl) {
|
|
task1, firstVersion = testData.runner.fetchTaskOnce(t, 0)
|
|
if task1 != nil {
|
|
break
|
|
}
|
|
time.Sleep(200 * time.Millisecond)
|
|
}
|
|
require.NotNil(t, task1, "expected to receive first task")
|
|
require.NotZero(t, firstVersion, "response TasksVersion should be set")
|
|
|
|
// Trigger a second run so there is a pending job after we re-enable the runner
|
|
triggerRunnerDisableEnableRun(t, user2, token, testData.repo, "second-push.txt")
|
|
time.Sleep(500 * time.Millisecond) // allow workflow run to be created
|
|
|
|
req := newRunnerUpdateRequest(t, fmt.Sprintf("/api/v1/repos/%s/%s/actions/runners/%d", user2.Name, testData.repo.Name, testData.runnerID), true).AddTokenAuth(token)
|
|
MakeRequest(t, req, http.StatusOK)
|
|
|
|
testData.runner.execTask(t, task1, &mockTaskOutcome{result: runnerv1.Result_RESULT_SUCCESS})
|
|
|
|
// Fetch with the version we had before disable. Server has bumped version on disable,
|
|
// so we enter PickTask with a re-loaded runner (disabled) and get no task.
|
|
taskAfterDisable, _ := testData.runner.fetchTaskOnce(t, firstVersion)
|
|
assert.Nil(t, taskAfterDisable, "disabled runner must not receive a task when sending previous TasksVersion")
|
|
|
|
req = newRunnerUpdateRequest(t, fmt.Sprintf("/api/v1/repos/%s/%s/actions/runners/%d", user2.Name, testData.repo.Name, testData.runnerID), false).AddTokenAuth(token)
|
|
MakeRequest(t, req, http.StatusOK)
|
|
|
|
task2 := testData.runner.fetchTask(t, 5*time.Second)
|
|
require.NotNil(t, task2, "after re-enable runner should receive tasks again")
|
|
testData.runner.execTask(t, task2, &mockTaskOutcome{result: runnerv1.Result_RESULT_SUCCESS})
|
|
})
|
|
})
|
|
}
|
|
|
|
type runnerDisableEnableTestData struct {
|
|
repo *api.Repository
|
|
runner *mockRunner
|
|
runnerID int64
|
|
}
|
|
|
|
func prepareRunnerDisableEnableTest(t *testing.T, user *user_model.User, authToken, repoName, runnerName, workflowName string) *runnerDisableEnableTestData {
|
|
t.Helper()
|
|
|
|
apiRepo := createActionsTestRepo(t, authToken, repoName, false)
|
|
runner := newMockRunner()
|
|
runner.registerAsRepoRunner(t, user.Name, apiRepo.Name, runnerName, []string{"ubuntu-latest"}, false)
|
|
|
|
wfTreePath := fmt.Sprintf(".gitea/workflows/%s.yml", workflowName)
|
|
wfContent := fmt.Sprintf(`name: %s
|
|
on: [push]
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- run: echo %s
|
|
`, workflowName, workflowName)
|
|
opts := getWorkflowCreateFileOptions(user, apiRepo.DefaultBranch, "create workflow", wfContent)
|
|
createWorkflowFile(t, authToken, user.Name, apiRepo.Name, wfTreePath, opts)
|
|
|
|
return &runnerDisableEnableTestData{
|
|
repo: apiRepo,
|
|
runner: runner,
|
|
runnerID: getRepoRunnerID(t, authToken, user.Name, apiRepo.Name),
|
|
}
|
|
}
|
|
|
|
func triggerRunnerDisableEnableRun(t *testing.T, user *user_model.User, authToken string, repo *api.Repository, treePath string) {
|
|
t.Helper()
|
|
opts := getWorkflowCreateFileOptions(user, repo.DefaultBranch, "second push", "second run")
|
|
createWorkflowFile(t, authToken, user.Name, repo.Name, treePath, opts)
|
|
}
|
|
|
|
func getRepoRunnerID(t *testing.T, authToken, ownerName, repoName string) int64 {
|
|
t.Helper()
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/actions/runners", ownerName, repoName)).AddTokenAuth(authToken)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
runnerList := api.ActionRunnersResponse{}
|
|
DecodeJSON(t, resp, &runnerList)
|
|
require.Len(t, runnerList.Entries, 1)
|
|
return runnerList.Entries[0].ID
|
|
}
|
|
|
|
func TestActionsGiteaContext(t *testing.T) {
|
|
onGiteaRun(t, func(t *testing.T, u *url.URL) {
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
user2Session := loginUser(t, user2.Name)
|
|
user2Token := getTokenForLoggedInUser(t, user2Session, auth_model.AccessTokenScopeWriteRepository, auth_model.AccessTokenScopeWriteUser)
|
|
|
|
apiBaseRepo := createActionsTestRepo(t, user2Token, "actions-gitea-context", false)
|
|
baseRepo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: apiBaseRepo.ID})
|
|
user2APICtx := NewAPITestContext(t, baseRepo.OwnerName, baseRepo.Name, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
runner := newMockRunner()
|
|
runner.registerAsRepoRunner(t, baseRepo.OwnerName, baseRepo.Name, "mock-runner", []string{"ubuntu-latest"}, false)
|
|
|
|
// init the workflow
|
|
wfTreePath := ".gitea/workflows/pull.yml"
|
|
wfFileContent := `name: Pull Request
|
|
on: pull_request
|
|
jobs:
|
|
wf1-job:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- run: echo 'test the pull'
|
|
`
|
|
opts := getWorkflowCreateFileOptions(user2, baseRepo.DefaultBranch, "create "+wfTreePath, wfFileContent)
|
|
createWorkflowFile(t, user2Token, baseRepo.OwnerName, baseRepo.Name, wfTreePath, opts)
|
|
// user2 creates a pull request
|
|
doAPICreateFile(user2APICtx, "user2-patch.txt", &api.CreateFileOptions{
|
|
FileOptions: api.FileOptions{
|
|
NewBranchName: "user2/patch-1",
|
|
Message: "create user2-patch.txt",
|
|
Author: api.Identity{
|
|
Name: user2.Name,
|
|
Email: user2.Email,
|
|
},
|
|
Committer: api.Identity{
|
|
Name: user2.Name,
|
|
Email: user2.Email,
|
|
},
|
|
Dates: api.CommitDateOptions{
|
|
Author: time.Now(),
|
|
Committer: time.Now(),
|
|
},
|
|
},
|
|
ContentBase64: base64.StdEncoding.EncodeToString([]byte("user2-fix")),
|
|
})(t)
|
|
apiPull, err := doAPICreatePullRequest(user2APICtx, baseRepo.OwnerName, baseRepo.Name, baseRepo.DefaultBranch, "user2/patch-1")(t)
|
|
assert.NoError(t, err)
|
|
task := runner.fetchTask(t)
|
|
gtCtx := task.Context.GetFields()
|
|
actionTask := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionTask{ID: task.Id})
|
|
actionRunJob := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: actionTask.JobID})
|
|
actionRun := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: actionRunJob.RunID})
|
|
assert.NoError(t, actionRun.LoadAttributes(t.Context()))
|
|
|
|
assert.Equal(t, user2.Name, gtCtx["actor"].GetStringValue())
|
|
assert.Equal(t, setting.AppURL+"api/v1", gtCtx["api_url"].GetStringValue())
|
|
assert.Equal(t, apiPull.Base.Ref, gtCtx["base_ref"].GetStringValue())
|
|
runEvent := map[string]any{}
|
|
assert.NoError(t, json.Unmarshal([]byte(actionRun.EventPayload), &runEvent))
|
|
assert.True(t, reflect.DeepEqual(gtCtx["event"].GetStructValue().AsMap(), runEvent))
|
|
assert.Equal(t, actionRun.TriggerEvent, gtCtx["event_name"].GetStringValue())
|
|
assert.Equal(t, apiPull.Head.Ref, gtCtx["head_ref"].GetStringValue())
|
|
assert.Equal(t, actionRunJob.JobID, gtCtx["job"].GetStringValue())
|
|
assert.Equal(t, actionRun.Ref, gtCtx["ref"].GetStringValue())
|
|
assert.Equal(t, (git.RefName(actionRun.Ref)).ShortName(), gtCtx["ref_name"].GetStringValue())
|
|
assert.False(t, gtCtx["ref_protected"].GetBoolValue())
|
|
assert.Equal(t, string((git.RefName(actionRun.Ref)).RefType()), gtCtx["ref_type"].GetStringValue())
|
|
assert.Equal(t, actionRun.Repo.OwnerName+"/"+actionRun.Repo.Name, gtCtx["repository"].GetStringValue())
|
|
assert.Equal(t, actionRun.Repo.OwnerName, gtCtx["repository_owner"].GetStringValue())
|
|
assert.Equal(t, actionRun.Repo.HTMLURL(), gtCtx["repositoryUrl"].GetStringValue())
|
|
assert.Equal(t, strconv.FormatInt(actionRunJob.RunID, 10), gtCtx["run_id"].GetStringValue())
|
|
assert.Equal(t, strconv.FormatInt(actionRun.Index, 10), gtCtx["run_number"].GetStringValue())
|
|
assert.Equal(t, strconv.FormatInt(actionRunJob.Attempt, 10), gtCtx["run_attempt"].GetStringValue())
|
|
assert.Equal(t, "Actions", gtCtx["secret_source"].GetStringValue())
|
|
assert.Equal(t, setting.AppURL, gtCtx["server_url"].GetStringValue())
|
|
assert.Equal(t, actionRun.CommitSHA, gtCtx["sha"].GetStringValue())
|
|
assert.Equal(t, actionRun.WorkflowID, gtCtx["workflow"].GetStringValue())
|
|
assert.Equal(t, setting.Actions.DefaultActionsURL.URL(), gtCtx["gitea_default_actions_url"].GetStringValue())
|
|
token := gtCtx["token"].GetStringValue()
|
|
assert.Equal(t, actionTask.TokenLastEight, token[len(token)-8:])
|
|
})
|
|
}
|
|
|
|
// Ephemeral
|
|
func TestActionsGiteaContextEphemeral(t *testing.T) {
|
|
onGiteaRun(t, func(t *testing.T, u *url.URL) {
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
user2Session := loginUser(t, user2.Name)
|
|
user2Token := getTokenForLoggedInUser(t, user2Session, auth_model.AccessTokenScopeWriteRepository, auth_model.AccessTokenScopeWriteUser)
|
|
|
|
apiBaseRepo := createActionsTestRepo(t, user2Token, "actions-gitea-context", false)
|
|
baseRepo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: apiBaseRepo.ID})
|
|
user2APICtx := NewAPITestContext(t, baseRepo.OwnerName, baseRepo.Name, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
runner := newMockRunner()
|
|
runner.registerAsRepoRunner(t, baseRepo.OwnerName, baseRepo.Name, "mock-runner", []string{"ubuntu-latest"}, true)
|
|
|
|
// verify CleanupEphemeralRunners does not remove this runner
|
|
err := actions_service.CleanupEphemeralRunners(t.Context())
|
|
assert.NoError(t, err)
|
|
|
|
// init the workflow
|
|
wfTreePath := ".gitea/workflows/pull.yml"
|
|
wfFileContent := `name: Pull Request
|
|
on: pull_request
|
|
jobs:
|
|
wf1-job:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- run: echo 'test the pull'
|
|
wf2-job:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- run: echo 'test the pull'
|
|
`
|
|
opts := getWorkflowCreateFileOptions(user2, baseRepo.DefaultBranch, "create "+wfTreePath, wfFileContent)
|
|
createWorkflowFile(t, user2Token, baseRepo.OwnerName, baseRepo.Name, wfTreePath, opts)
|
|
// user2 creates a pull request
|
|
doAPICreateFile(user2APICtx, "user2-patch.txt", &api.CreateFileOptions{
|
|
FileOptions: api.FileOptions{
|
|
NewBranchName: "user2/patch-1",
|
|
Message: "create user2-patch.txt",
|
|
Author: api.Identity{
|
|
Name: user2.Name,
|
|
Email: user2.Email,
|
|
},
|
|
Committer: api.Identity{
|
|
Name: user2.Name,
|
|
Email: user2.Email,
|
|
},
|
|
Dates: api.CommitDateOptions{
|
|
Author: time.Now(),
|
|
Committer: time.Now(),
|
|
},
|
|
},
|
|
ContentBase64: base64.StdEncoding.EncodeToString([]byte("user2-fix")),
|
|
})(t)
|
|
apiPull, err := doAPICreatePullRequest(user2APICtx, baseRepo.OwnerName, baseRepo.Name, baseRepo.DefaultBranch, "user2/patch-1")(t)
|
|
assert.NoError(t, err)
|
|
task := runner.fetchTask(t)
|
|
gtCtx := task.Context.GetFields()
|
|
actionTask := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionTask{ID: task.Id})
|
|
actionRunJob := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: actionTask.JobID})
|
|
actionRun := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: actionRunJob.RunID})
|
|
assert.NoError(t, actionRun.LoadAttributes(t.Context()))
|
|
|
|
assert.Equal(t, user2.Name, gtCtx["actor"].GetStringValue())
|
|
assert.Equal(t, setting.AppURL+"api/v1", gtCtx["api_url"].GetStringValue())
|
|
assert.Equal(t, apiPull.Base.Ref, gtCtx["base_ref"].GetStringValue())
|
|
runEvent := map[string]any{}
|
|
assert.NoError(t, json.Unmarshal([]byte(actionRun.EventPayload), &runEvent))
|
|
assert.True(t, reflect.DeepEqual(gtCtx["event"].GetStructValue().AsMap(), runEvent))
|
|
assert.Equal(t, actionRun.TriggerEvent, gtCtx["event_name"].GetStringValue())
|
|
assert.Equal(t, apiPull.Head.Ref, gtCtx["head_ref"].GetStringValue())
|
|
assert.Equal(t, actionRunJob.JobID, gtCtx["job"].GetStringValue())
|
|
assert.Equal(t, actionRun.Ref, gtCtx["ref"].GetStringValue())
|
|
assert.Equal(t, (git.RefName(actionRun.Ref)).ShortName(), gtCtx["ref_name"].GetStringValue())
|
|
assert.False(t, gtCtx["ref_protected"].GetBoolValue())
|
|
assert.Equal(t, string((git.RefName(actionRun.Ref)).RefType()), gtCtx["ref_type"].GetStringValue())
|
|
assert.Equal(t, actionRun.Repo.OwnerName+"/"+actionRun.Repo.Name, gtCtx["repository"].GetStringValue())
|
|
assert.Equal(t, actionRun.Repo.OwnerName, gtCtx["repository_owner"].GetStringValue())
|
|
assert.Equal(t, actionRun.Repo.HTMLURL(), gtCtx["repositoryUrl"].GetStringValue())
|
|
assert.Equal(t, strconv.FormatInt(actionRunJob.RunID, 10), gtCtx["run_id"].GetStringValue())
|
|
assert.Equal(t, strconv.FormatInt(actionRun.Index, 10), gtCtx["run_number"].GetStringValue())
|
|
assert.Equal(t, strconv.FormatInt(actionRunJob.Attempt, 10), gtCtx["run_attempt"].GetStringValue())
|
|
assert.Equal(t, "Actions", gtCtx["secret_source"].GetStringValue())
|
|
assert.Equal(t, setting.AppURL, gtCtx["server_url"].GetStringValue())
|
|
assert.Equal(t, actionRun.CommitSHA, gtCtx["sha"].GetStringValue())
|
|
assert.Equal(t, actionRun.WorkflowID, gtCtx["workflow"].GetStringValue())
|
|
assert.Equal(t, setting.Actions.DefaultActionsURL.URL(), gtCtx["gitea_default_actions_url"].GetStringValue())
|
|
token := gtCtx["token"].GetStringValue()
|
|
assert.Equal(t, actionTask.TokenLastEight, token[len(token)-8:])
|
|
|
|
// verify CleanupEphemeralRunners does not remove this runner
|
|
err = actions_service.CleanupEphemeralRunners(t.Context())
|
|
assert.NoError(t, err)
|
|
|
|
resp, err := runner.client.runnerServiceClient.FetchTask(t.Context(), connect.NewRequest(&runnerv1.FetchTaskRequest{
|
|
TasksVersion: 0,
|
|
}))
|
|
assert.NoError(t, err)
|
|
assert.Nil(t, resp.Msg.Task)
|
|
|
|
// verify CleanupEphemeralRunners does not remove this runner
|
|
err = actions_service.CleanupEphemeralRunners(t.Context())
|
|
assert.NoError(t, err)
|
|
|
|
_, err = runner.client.runnerServiceClient.UpdateTask(t.Context(), connect.NewRequest(&runnerv1.UpdateTaskRequest{
|
|
State: &runnerv1.TaskState{
|
|
Id: actionTask.ID,
|
|
Result: runnerv1.Result_RESULT_SUCCESS,
|
|
},
|
|
}))
|
|
assert.NoError(t, err)
|
|
|
|
resp, err = runner.client.runnerServiceClient.FetchTask(t.Context(), connect.NewRequest(&runnerv1.FetchTaskRequest{
|
|
TasksVersion: 0,
|
|
}))
|
|
assert.Error(t, err)
|
|
assert.Nil(t, resp)
|
|
|
|
resp, err = runner.client.runnerServiceClient.FetchTask(t.Context(), connect.NewRequest(&runnerv1.FetchTaskRequest{
|
|
TasksVersion: 0,
|
|
}))
|
|
assert.Error(t, err)
|
|
assert.Nil(t, resp)
|
|
|
|
// create a runner that picks a job and get force cancelled
|
|
runnerToBeRemoved := newMockRunner()
|
|
runnerToBeRemoved.registerAsRepoRunner(t, baseRepo.OwnerName, baseRepo.Name, "mock-runner-to-be-removed", []string{"ubuntu-latest"}, true)
|
|
|
|
taskToStopAPIObj := runnerToBeRemoved.fetchTask(t)
|
|
|
|
taskToStop := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionTask{ID: taskToStopAPIObj.Id})
|
|
|
|
// verify CleanupEphemeralRunners does not remove the custom crafted runner
|
|
err = actions_service.CleanupEphemeralRunners(t.Context())
|
|
assert.NoError(t, err)
|
|
|
|
runnerToRemove := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{ID: taskToStop.RunnerID})
|
|
|
|
err = actions_model.StopTask(t.Context(), taskToStop.ID, actions_model.StatusFailure)
|
|
assert.NoError(t, err)
|
|
|
|
// verify CleanupEphemeralRunners does remove the custom crafted runner
|
|
err = actions_service.CleanupEphemeralRunners(t.Context())
|
|
assert.NoError(t, err)
|
|
|
|
unittest.AssertNotExistsBean(t, &actions_model.ActionRunner{ID: runnerToRemove.ID})
|
|
})
|
|
}
|
|
|
|
func createActionsTestRepo(t *testing.T, authToken, repoName string, isPrivate bool) *api.Repository {
|
|
req := NewRequestWithJSON(t, "POST", "/api/v1/user/repos", &api.CreateRepoOption{
|
|
Name: repoName,
|
|
Private: isPrivate,
|
|
Readme: "Default",
|
|
AutoInit: true,
|
|
DefaultBranch: "main",
|
|
}).AddTokenAuth(authToken)
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
|
var apiRepo api.Repository
|
|
DecodeJSON(t, resp, &apiRepo)
|
|
return &apiRepo
|
|
}
|
|
|
|
func getWorkflowCreateFileOptions(u *user_model.User, branch, msg, content string) *api.CreateFileOptions {
|
|
return &api.CreateFileOptions{
|
|
FileOptions: api.FileOptions{
|
|
BranchName: branch,
|
|
Message: msg,
|
|
Author: api.Identity{
|
|
Name: u.Name,
|
|
Email: u.Email,
|
|
},
|
|
Committer: api.Identity{
|
|
Name: u.Name,
|
|
Email: u.Email,
|
|
},
|
|
Dates: api.CommitDateOptions{
|
|
Author: time.Now(),
|
|
Committer: time.Now(),
|
|
},
|
|
},
|
|
ContentBase64: base64.StdEncoding.EncodeToString([]byte(content)),
|
|
}
|
|
}
|
|
|
|
func createWorkflowFile(t *testing.T, authToken, ownerName, repoName, treePath string, opts *api.CreateFileOptions) *api.FileResponse {
|
|
req := NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", ownerName, repoName, treePath), opts).
|
|
AddTokenAuth(authToken)
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
|
var fileResponse api.FileResponse
|
|
DecodeJSON(t, resp, &fileResponse)
|
|
return &fileResponse
|
|
}
|
|
|
|
// getTaskJobNameByTaskID get the job name of the task by task ID
|
|
// there is currently not an API for querying a task by ID so we have to list all the tasks
|
|
func getTaskJobNameByTaskID(t *testing.T, authToken, ownerName, repoName string, taskID int64) string {
|
|
// FIXME: we may need to query several pages
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/actions/tasks", ownerName, repoName)).
|
|
AddTokenAuth(authToken)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var taskRespBefore api.ActionTaskResponse
|
|
DecodeJSON(t, resp, &taskRespBefore)
|
|
for _, apiTask := range taskRespBefore.Entries {
|
|
if apiTask.ID == taskID {
|
|
return apiTask.Name
|
|
}
|
|
}
|
|
return ""
|
|
}
|