create some common funcs

Author: Zettat123

tests/integration/actions_job_test.go

@@ -121,86 +121,98 @@ jobs:
 		},
 	}
 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
-		runner := newMockRunner(t)
-		runner.registerAsGlobalRunner(t, "mock-runner", []string{"ubuntu-latest"})
-
 		user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 		session := loginUser(t, user2.Name)
 		token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository, auth_model.AccessTokenScopeWriteUser)
 
-		// create the repo
-		req := NewRequestWithJSON(t, "POST", "/api/v1/user/repos", &api.CreateRepoOption{
-			Name:          "actions-jobs-with-needs",
-			Description:   "test jobs with needs",
-			Private:       false,
-			Readme:        "Default",
-			AutoInit:      true,
-			DefaultBranch: "main",
-		}).AddTokenAuth(token)
-		resp := MakeRequest(t, req, http.StatusCreated)
-		var apiRepo api.Repository
-		DecodeJSON(t, resp, &apiRepo)
+		apiRepo := createActionsTestRepo(t, token, "actions-jobs-with-needs", false)
+
+		runner := newMockRunner()
+		runner.registerAsRepoRunner(t, user2.Name, apiRepo.Name, "mock-runner", []string{"ubuntu-latest"})
 
 		for _, tc := range testCases {
-			// create the workflow file
-			createFileOptions := &api.CreateFileOptions{
-				FileOptions: api.FileOptions{
-					BranchName: "main",
-					Message:    fmt.Sprintf("create %s", tc.treePath),
-					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(tc.fileContent)),
-			}
-			req = NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/repos/%s/%s/contents/%s", user2.Name, apiRepo.Name, tc.treePath), createFileOptions).
-				AddTokenAuth(token)
-			var fileResponse api.FileResponse
-			resp = MakeRequest(t, req, http.StatusCreated)
-			DecodeJSON(t, resp, &fileResponse)
+			t.Run(fmt.Sprintf("test %s", tc.treePath), func(t *testing.T) {
+				// create the workflow file
+				opts := getWorkflowCreateFileOptions(user2, apiRepo.DefaultBranch, fmt.Sprintf("create %s", 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.execPolicies); i++ {
-				task := runner.fetchTask(t)
-				assert.NotNil(t, task)
-				jobName := getTaskJobNameByTaskID(t, token, user2.Name, apiRepo.Name, task.Id)
-				policy := tc.execPolicies[jobName]
-				assert.NotNil(t, policy)
-				runner.execTask(t, task, policy)
-			}
+				// fetch and execute task
+				for i := 0; i < len(tc.execPolicies); i++ {
+					task := runner.fetchTask(t)
+					jobName := getTaskJobNameByTaskID(t, token, user2.Name, apiRepo.Name, task.Id)
+					policy := tc.execPolicies[jobName]
+					assert.NotNil(t, policy)
+					runner.execTask(t, task, policy)
+				}
 
-			// 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 != fileResponse.Commit.SHA {
-					continue
+				// 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])
 				}
-				status := apiTask.Status
-				assert.Equal(t, status, tc.expectedStatuses[apiTask.Name])
-			}
+			})
 		}
 	})
 }
 
+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, repoOwner, repoName string, taskID int64) string {
-	t.Helper()
+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", repoOwner, repoName)).
+	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

tests/integration/actions_runner_test.go

@@ -35,8 +35,7 @@ type mockRunnerClient struct {
 	runnerServiceClient runnerv1connect.RunnerServiceClient
 }
 
-func newMockRunner(t testing.TB) *mockRunner {
-	t.Helper()
+func newMockRunner() *mockRunner {
 	client := newMockRunnerClient("", "")
 	return &mockRunner{client: client}
 }
@@ -86,16 +85,16 @@ func (r *mockRunner) doRegister(t *testing.T, name, token string, labels []strin
 	r.client = newMockRunnerClient(resp.Msg.Runner.Uuid, resp.Msg.Runner.Token)
 }
 
-func (r *mockRunner) registerAsGlobalRunner(t *testing.T, name string, labels []string) {
-	session := loginUser(t, "user1")
-	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteAdmin)
-	req := NewRequest(t, "GET", "/api/v1/admin/runners/registration-token").AddTokenAuth(token)
+func (r *mockRunner) registerAsRepoRunner(t *testing.T, ownerName, repoName, runnerName string, labels []string) {
+	session := loginUser(t, ownerName)
+	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
+	req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/actions/runners/registration-token", ownerName, repoName)).AddTokenAuth(token)
 	resp := MakeRequest(t, req, http.StatusOK)
 	var registrationToken struct {
 		Token string `json:"token"`
 	}
 	DecodeJSON(t, resp, &registrationToken)
-	r.doRegister(t, name, registrationToken.Token, labels)
+	r.doRegister(t, runnerName, registrationToken.Token, labels)
 }
 
 func (r *mockRunner) fetchTask(t *testing.T, timeout ...time.Duration) *runnerv1.Task {
@@ -104,17 +103,20 @@ func (r *mockRunner) fetchTask(t *testing.T, timeout ...time.Duration) *runnerv1
 		fetchTimeout = timeout[0]
 	}
 	ddl := time.Now().Add(fetchTimeout)
+	var task *runnerv1.Task
 	for time.Now().Before(ddl) {
 		resp, err := r.client.runnerServiceClient.FetchTask(context.Background(), connect.NewRequest(&runnerv1.FetchTaskRequest{
 			TasksVersion: 0,
 		}))
 		assert.NoError(t, err)
 		if resp.Msg.Task != nil {
-			return resp.Msg.Task
+			task = resp.Msg.Task
+			break
 		}
 		time.Sleep(time.Second)
 	}
-	return nil
+	assert.NotNil(t, task, "failed to fetch a task")
+	return task
 }
 
 type taskExecPolicy struct {