|
| 1 | +// Copyright 2024 The Gitea Authors. All rights reserved. |
| 2 | +// SPDX-License-Identifier: MIT |
| 3 | + |
| 4 | +package integration |
| 5 | + |
| 6 | +import ( |
| 7 | + "encoding/base64" |
| 8 | + "fmt" |
| 9 | + "net/http" |
| 10 | + "net/url" |
| 11 | + "testing" |
| 12 | + "time" |
| 13 | + |
| 14 | + actions_model "code.gitea.io/gitea/models/actions" |
| 15 | + auth_model "code.gitea.io/gitea/models/auth" |
| 16 | + "code.gitea.io/gitea/models/unittest" |
| 17 | + user_model "code.gitea.io/gitea/models/user" |
| 18 | + api "code.gitea.io/gitea/modules/structs" |
| 19 | + |
| 20 | + runnerv1 "code.gitea.io/actions-proto-go/runner/v1" |
| 21 | + |
| 22 | + "github.com/stretchr/testify/assert" |
| 23 | +) |
| 24 | + |
| 25 | +func TestJobWithNeeds(t *testing.T) { |
| 26 | + testCases := []struct { |
| 27 | + treePath string |
| 28 | + fileContent string |
| 29 | + execPolicies map[string]*taskExecPolicy |
| 30 | + expectedStatuses map[string]string |
| 31 | + }{ |
| 32 | + { |
| 33 | + treePath: ".gitea/workflows/job-with-needs.yml", |
| 34 | + fileContent: `name: test |
| 35 | +on: push |
| 36 | +jobs: |
| 37 | + job1: |
| 38 | + runs-on: ubuntu-latest |
| 39 | + steps: |
| 40 | + - run: echo job1 |
| 41 | + job2: |
| 42 | + runs-on: ubuntu-latest |
| 43 | + needs: [job1] |
| 44 | + steps: |
| 45 | + - run: echo job2 |
| 46 | +`, |
| 47 | + execPolicies: map[string]*taskExecPolicy{ |
| 48 | + "job1": { |
| 49 | + result: runnerv1.Result_RESULT_SUCCESS, |
| 50 | + }, |
| 51 | + "job2": { |
| 52 | + result: runnerv1.Result_RESULT_SUCCESS, |
| 53 | + }, |
| 54 | + }, |
| 55 | + expectedStatuses: map[string]string{ |
| 56 | + "job1": actions_model.StatusSuccess.String(), |
| 57 | + "job2": actions_model.StatusSuccess.String(), |
| 58 | + }, |
| 59 | + }, |
| 60 | + { |
| 61 | + treePath: ".gitea/workflows/job-with-needs-fail.yml", |
| 62 | + fileContent: `name: test |
| 63 | +on: push |
| 64 | +jobs: |
| 65 | + job1: |
| 66 | + runs-on: ubuntu-latest |
| 67 | + steps: |
| 68 | + - run: echo job1 |
| 69 | + job2: |
| 70 | + runs-on: ubuntu-latest |
| 71 | + needs: [job1] |
| 72 | + steps: |
| 73 | + - run: echo job2 |
| 74 | +`, |
| 75 | + execPolicies: map[string]*taskExecPolicy{ |
| 76 | + "job1": { |
| 77 | + result: runnerv1.Result_RESULT_FAILURE, |
| 78 | + }, |
| 79 | + }, |
| 80 | + expectedStatuses: map[string]string{ |
| 81 | + "job1": actions_model.StatusFailure.String(), |
| 82 | + "job2": actions_model.StatusSkipped.String(), |
| 83 | + }, |
| 84 | + }, |
| 85 | + } |
| 86 | + onGiteaRun(t, func(t *testing.T, u *url.URL) { |
| 87 | + runner := newMockRunner(t) |
| 88 | + runner.registerAsGlobalRunner(t, "mock-runner", []string{"ubuntu-latest"}) |
| 89 | + |
| 90 | + user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}) |
| 91 | + session := loginUser(t, user2.Name) |
| 92 | + token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository, auth_model.AccessTokenScopeWriteUser) |
| 93 | + |
| 94 | + // create the repo |
| 95 | + req := NewRequestWithJSON(t, "POST", "/api/v1/user/repos", &api.CreateRepoOption{ |
| 96 | + Name: "actions-jobs-with-needs", |
| 97 | + Description: "test jobs with needs", |
| 98 | + Private: false, |
| 99 | + Readme: "Default", |
| 100 | + AutoInit: true, |
| 101 | + DefaultBranch: "main", |
| 102 | + }).AddTokenAuth(token) |
| 103 | + resp := MakeRequest(t, req, http.StatusCreated) |
| 104 | + var apiRepo api.Repository |
| 105 | + DecodeJSON(t, resp, &apiRepo) |
| 106 | + |
| 107 | + for _, tc := range testCases { |
| 108 | + // create the workflow file |
| 109 | + createFileOptions := &api.CreateFileOptions{ |
| 110 | + FileOptions: api.FileOptions{ |
| 111 | + BranchName: "main", |
| 112 | + Message: fmt.Sprintf("create %s", tc.treePath), |
| 113 | + Author: api.Identity{ |
| 114 | + Name: user2.Name, |
| 115 | + Email: user2.Email, |
| 116 | + }, |
| 117 | + Committer: api.Identity{ |
| 118 | + Name: user2.Name, |
| 119 | + Email: user2.Email, |
| 120 | + }, |
| 121 | + Dates: api.CommitDateOptions{ |
| 122 | + Author: time.Now(), |
| 123 | + Committer: time.Now(), |
| 124 | + }, |
| 125 | + }, |
| 126 | + ContentBase64: base64.StdEncoding.EncodeToString([]byte(tc.fileContent)), |
| 127 | + } |
| 128 | + req = NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, apiRepo.Name, tc.treePath), createFileOptions). |
| 129 | + AddTokenAuth(token) |
| 130 | + var fileResponse api.FileResponse |
| 131 | + resp = MakeRequest(t, req, http.StatusCreated) |
| 132 | + DecodeJSON(t, resp, &fileResponse) |
| 133 | + |
| 134 | + // fetch and execute task |
| 135 | + for i := 0; i < len(tc.execPolicies); i++ { |
| 136 | + task := runner.fetchTask(t) |
| 137 | + assert.NotNil(t, task) |
| 138 | + jobName := getTaskJobNameByTaskID(t, token, user2.Name, apiRepo.Name, task.Id) |
| 139 | + policy := tc.execPolicies[jobName] |
| 140 | + assert.NotNil(t, policy) |
| 141 | + runner.execTask(t, task, policy) |
| 142 | + } |
| 143 | + |
| 144 | + // check result |
| 145 | + req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/actions/tasks", user2.Name, apiRepo.Name)). |
| 146 | + AddTokenAuth(token) |
| 147 | + resp = MakeRequest(t, req, http.StatusOK) |
| 148 | + var actionTaskRespAfter api.ActionTaskResponse |
| 149 | + DecodeJSON(t, resp, &actionTaskRespAfter) |
| 150 | + for _, apiTask := range actionTaskRespAfter.Entries { |
| 151 | + if apiTask.HeadSHA != fileResponse.Commit.SHA { |
| 152 | + continue |
| 153 | + } |
| 154 | + status := apiTask.Status |
| 155 | + assert.Equal(t, status, tc.expectedStatuses[apiTask.Name]) |
| 156 | + } |
| 157 | + } |
| 158 | + }) |
| 159 | +} |
| 160 | + |
| 161 | +// getTaskJobNameByTaskID get the job name of the task by task ID |
| 162 | +// there is currently not an API for querying a task by ID so we have to list all the tasks |
| 163 | +func getTaskJobNameByTaskID(t *testing.T, authToken, repoOwner, repoName string, taskID int64) string { |
| 164 | + t.Helper() |
| 165 | + // TODO: we may need to query several pages |
| 166 | + req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/actions/tasks", repoOwner, repoName)). |
| 167 | + AddTokenAuth(authToken) |
| 168 | + resp := MakeRequest(t, req, http.StatusOK) |
| 169 | + var taskRespBefore api.ActionTaskResponse |
| 170 | + DecodeJSON(t, resp, &taskRespBefore) |
| 171 | + for _, apiTask := range taskRespBefore.Entries { |
| 172 | + if apiTask.ID == taskID { |
| 173 | + return apiTask.Name |
| 174 | + } |
| 175 | + } |
| 176 | + return "" |
| 177 | +} |
0 commit comments