aboutsummaryrefslogtreecommitdiffstats
path: root/tests/integration/actions_log_test.go
blob: 503bda97c93faa323cf7e1189e108da99926d0b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
// Copyright 2024 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package integration

import (
	"fmt"
	"net/http"
	"net/url"
	"strconv"
	"strings"
	"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/setting"
	"code.gitea.io/gitea/modules/storage"
	"code.gitea.io/gitea/modules/test"

	runnerv1 "code.gitea.io/actions-proto-go/runner/v1"
	"github.com/stretchr/testify/assert"
	"google.golang.org/protobuf/types/known/timestamppb"
)

func TestDownloadTaskLogs(t *testing.T) {
	now := time.Now()
	testCases := []struct {
		treePath    string
		fileContent string
		outcome     []*mockTaskOutcome
		zstdEnabled bool
	}{
		{
			treePath: ".gitea/workflows/download-task-logs-zstd.yml",
			fileContent: `name: download-task-logs-zstd
on:
  push:
    paths:
      - '.gitea/workflows/download-task-logs-zstd.yml'
jobs:
    job1:
      runs-on: ubuntu-latest
      steps:
        - run: echo job1 with zstd enabled
    job2:
      runs-on: ubuntu-latest
      steps:
        - run: echo job2 with zstd enabled
`,
			outcome: []*mockTaskOutcome{
				{
					result: runnerv1.Result_RESULT_SUCCESS,
					logRows: []*runnerv1.LogRow{
						{
							Time:    timestamppb.New(now.Add(1 * time.Second)),
							Content: "  \U0001F433  docker create image",
						},
						{
							Time:    timestamppb.New(now.Add(2 * time.Second)),
							Content: "job1 zstd enabled",
						},
						{
							Time:    timestamppb.New(now.Add(3 * time.Second)),
							Content: "\U0001F3C1  Job succeeded",
						},
					},
				},
				{
					result: runnerv1.Result_RESULT_SUCCESS,
					logRows: []*runnerv1.LogRow{
						{
							Time:    timestamppb.New(now.Add(1 * time.Second)),
							Content: "  \U0001F433  docker create image",
						},
						{
							Time:    timestamppb.New(now.Add(2 * time.Second)),
							Content: "job2 zstd enabled",
						},
						{
							Time:    timestamppb.New(now.Add(3 * time.Second)),
							Content: "\U0001F3C1  Job succeeded",
						},
					},
				},
			},
			zstdEnabled: true,
		},
		{
			treePath: ".gitea/workflows/download-task-logs-no-zstd.yml",
			fileContent: `name: download-task-logs-no-zstd
on:
  push:
    paths:
      - '.gitea/workflows/download-task-logs-no-zstd.yml'
jobs:
    job1:
      runs-on: ubuntu-latest
      steps:
        - run: echo job1 with zstd disabled
    job2:
      runs-on: ubuntu-latest
      steps:
        - run: echo job2 with zstd disabled
`,
			outcome: []*mockTaskOutcome{
				{
					result: runnerv1.Result_RESULT_SUCCESS,
					logRows: []*runnerv1.LogRow{
						{
							Time:    timestamppb.New(now.Add(4 * time.Second)),
							Content: "  \U0001F433  docker create image",
						},
						{
							Time:    timestamppb.New(now.Add(5 * time.Second)),
							Content: "job1 zstd disabled",
						},
						{
							Time:    timestamppb.New(now.Add(6 * time.Second)),
							Content: "\U0001F3C1  Job succeeded",
						},
					},
				},
				{
					result: runnerv1.Result_RESULT_SUCCESS,
					logRows: []*runnerv1.LogRow{
						{
							Time:    timestamppb.New(now.Add(4 * time.Second)),
							Content: "  \U0001F433  docker create image",
						},
						{
							Time:    timestamppb.New(now.Add(5 * time.Second)),
							Content: "job2 zstd disabled",
						},
						{
							Time:    timestamppb.New(now.Add(6 * time.Second)),
							Content: "\U0001F3C1  Job succeeded",
						},
					},
				},
			},
			zstdEnabled: false,
		},
	}
	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-download-task-logs", false)
		repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: apiRepo.ID})
		runner := newMockRunner()
		runner.registerAsRepoRunner(t, user2.Name, repo.Name, "mock-runner", []string{"ubuntu-latest"}, false)

		for _, tc := range testCases {
			t.Run("test "+tc.treePath, func(t *testing.T) {
				var resetFunc func()
				if tc.zstdEnabled {
					resetFunc = test.MockVariableValue(&setting.Actions.LogCompression, "zstd")
					assert.True(t, setting.Actions.LogCompression.IsZstd())
				} else {
					resetFunc = test.MockVariableValue(&setting.Actions.LogCompression, "none")
					assert.False(t, setting.Actions.LogCompression.IsZstd())
				}

				// create the workflow file
				opts := getWorkflowCreateFileOptions(user2, repo.DefaultBranch, "create "+tc.treePath, tc.fileContent)
				createWorkflowFile(t, token, user2.Name, repo.Name, tc.treePath, opts)

				// fetch and execute tasks
				for jobIndex, outcome := range tc.outcome {
					task := runner.fetchTask(t)
					runner.execTask(t, task, outcome)

					// check whether the log file exists
					logFileName := fmt.Sprintf("%s/%02x/%d.log", repo.FullName(), task.Id%256, task.Id)
					if setting.Actions.LogCompression.IsZstd() {
						logFileName += ".zst"
					}
					_, err := storage.Actions.Stat(logFileName)
					assert.NoError(t, err)

					// download task logs and check content
					runIndex := task.Context.GetFields()["run_number"].GetStringValue()
					req := NewRequest(t, "GET", fmt.Sprintf("/%s/%s/actions/runs/%s/jobs/%d/logs", user2.Name, repo.Name, runIndex, jobIndex)).
						AddTokenAuth(token)
					resp := MakeRequest(t, req, http.StatusOK)
					logTextLines := strings.Split(strings.TrimSpace(resp.Body.String()), "\n")
					assert.Len(t, logTextLines, len(outcome.logRows))
					for idx, lr := range outcome.logRows {
						assert.Equal(
							t,
							fmt.Sprintf("%s %s", lr.Time.AsTime().Format("2006-01-02T15:04:05.0000000Z07:00"), lr.Content),
							logTextLines[idx],
						)
					}

					runID, _ := strconv.ParseInt(task.Context.GetFields()["run_id"].GetStringValue(), 10, 64)

					jobs, err := actions_model.GetRunJobsByRunID(t.Context(), runID)
					assert.NoError(t, err)
					assert.Len(t, jobs, len(tc.outcome))
					jobID := jobs[jobIndex].ID

					// download task logs from API and check content
					req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/actions/jobs/%d/logs", user2.Name, repo.Name, jobID)).
						AddTokenAuth(token)
					resp = MakeRequest(t, req, http.StatusOK)
					logTextLines = strings.Split(strings.TrimSpace(resp.Body.String()), "\n")
					assert.Len(t, logTextLines, len(outcome.logRows))
					for idx, lr := range outcome.logRows {
						assert.Equal(
							t,
							fmt.Sprintf("%s %s", lr.Time.AsTime().Format("2006-01-02T15:04:05.0000000Z07:00"), lr.Content),
							logTextLines[idx],
						)
					}
				}
				resetFunc()
			})
		}
	})
}