Skip to content

Commit acd0861

Browse files
ldmonsterldmonster
committed
refactoring
Signed-off-by: Pavel Okhlopkov <pavel.okhlopkov@flant.com>
1 parent 7262a89 commit acd0861

File tree

7 files changed

+39
-39
lines changed

7 files changed

+39
-39
lines changed

‎pkg/shell-operator/combine_binding_context_test.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ func Test_CombineBindingContext_MultipleHooks(t *testing.T) {
5151
TaskQueues := queue.NewTaskQueueSet().WithMetricStorage(metricStorage)
5252
TaskQueues.WithContext(context.Background())
5353
TaskQueues.NewNamedQueue("test_multiple_hooks",
54-
func(_ context.Context, _ task.Task) task.TaskResult {
55-
return task.TaskResult{
54+
func(_ context.Context, _ task.Task) task.Result {
55+
return task.Result{
5656
Status: "Success",
5757
}
5858
},
@@ -161,8 +161,8 @@ func Test_CombineBindingContext_Nil_On_NoCombine(t *testing.T) {
161161
TaskQueues := queue.NewTaskQueueSet().WithMetricStorage(metricStorage)
162162
TaskQueues.WithContext(context.Background())
163163
TaskQueues.NewNamedQueue("test_no_combine",
164-
func(_ context.Context, _ task.Task) task.TaskResult {
165-
return task.TaskResult{
164+
func(_ context.Context, _ task.Task) task.Result {
165+
return task.Result{
166166
Status: "Success",
167167
}
168168
},
@@ -236,8 +236,8 @@ func Test_CombineBindingContext_Group_Compaction(t *testing.T) {
236236
TaskQueues := queue.NewTaskQueueSet().WithMetricStorage(metricStorage)
237237
TaskQueues.WithContext(context.Background())
238238
TaskQueues.NewNamedQueue("test_multiple_hooks",
239-
func(_ context.Context, _ task.Task) task.TaskResult {
240-
return task.TaskResult{
239+
func(_ context.Context, _ task.Task) task.Result {
240+
return task.Result{
241241
Status: "Success",
242242
}
243243
},
@@ -354,8 +354,8 @@ func Test_CombineBindingContext_Group_Type(t *testing.T) {
354354
TaskQueues := queue.NewTaskQueueSet().WithMetricStorage(metricStorage)
355355
TaskQueues.WithContext(context.Background())
356356
TaskQueues.NewNamedQueue("test_multiple_hooks",
357-
func(_ context.Context, _ task.Task) task.TaskResult {
358-
return task.TaskResult{
357+
func(_ context.Context, _ task.Task) task.Result {
358+
return task.Result{
359359
Status: "Success",
360360
}
361361
},

‎pkg/shell-operator/operator.go‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -463,10 +463,10 @@ func (op *ShellOperator) conversionEventHandler(ctx context.Context, crdName str
463463
}
464464

465465
// taskHandler
466-
func (op *ShellOperator) taskHandler(ctx context.Context, t task.Task) task.TaskResult {
466+
func (op *ShellOperator) taskHandler(ctx context.Context, t task.Task) task.Result {
467467
logEntry := op.logger.With("operator.component", "taskRunner")
468468
hookMeta := task_metadata.HookMetadataAccessor(t)
469-
var res task.TaskResult
469+
var res task.Result
470470

471471
switch t.GetType() {
472472
case task_metadata.HookRun:
@@ -494,7 +494,7 @@ func (op *ShellOperator) taskHandler(ctx context.Context, t task.Task) task.Task
494494
}
495495

496496
// taskHandleEnableKubernetesBindings creates task for each Kubernetes binding in the hook and queues them.
497-
func (op *ShellOperator) taskHandleEnableKubernetesBindings(ctx context.Context, t task.Task) task.TaskResult {
497+
func (op *ShellOperator) taskHandleEnableKubernetesBindings(ctx context.Context, t task.Task) task.Result {
498498
ctx, span := otel.Tracer(serviceName).Start(ctx, "taskHandleEnableKubernetesBindings")
499499
defer span.End()
500500

@@ -507,7 +507,7 @@ func (op *ShellOperator) taskHandleEnableKubernetesBindings(ctx context.Context,
507507
op.MetricStorage.GaugeSet(metrics.HookEnableKubernetesBindingsSeconds, d.Seconds(), metricLabels)
508508
})()
509509

510-
var res task.TaskResult
510+
var res task.Result
511511
hookLogLabels := map[string]string{}
512512
hookLogLabels["hook"] = hookMeta.HookName
513513
hookLogLabels["binding"] = ""
@@ -570,7 +570,7 @@ func (op *ShellOperator) taskHandleEnableKubernetesBindings(ctx context.Context,
570570
}
571571

572572
// TODO use Context to pass labels and a queue name
573-
func (op *ShellOperator) taskHandleHookRun(ctx context.Context, t task.Task) task.TaskResult {
573+
func (op *ShellOperator) taskHandleHookRun(ctx context.Context, t task.Task) task.Result {
574574
ctx, span := otel.Tracer(serviceName).Start(ctx, "taskHandleHookRun")
575575
defer span.End()
576576

@@ -580,7 +580,7 @@ func (op *ShellOperator) taskHandleHookRun(ctx context.Context, t task.Task) tas
580580
err := taskHook.RateLimitWait(context.Background())
581581
if err != nil {
582582
// This could happen when the Context is canceled, so just repeat the task until the queue is stopped.
583-
return task.TaskResult{
583+
return task.Result{
584584
Status: "Repeat",
585585
}
586586
}
@@ -641,7 +641,7 @@ func (op *ShellOperator) taskHandleHookRun(ctx context.Context, t task.Task) tas
641641
}
642642
}
643643

644-
var res task.TaskResult
644+
var res task.Result
645645
// Default when shouldRunHook is false.
646646
res.Status = "Success"
647647

‎pkg/task/queue.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ type TaskQueue interface {
1010
GetStatus() string
1111
SetStatus(status string)
1212
GetName() string
13-
GetHandler() func(ctx context.Context, t Task) TaskResult
14-
SetHandler(handler func(ctx context.Context, t Task) TaskResult)
13+
GetHandler() func(ctx context.Context, t Task) Result
14+
SetHandler(handler func(ctx context.Context, t Task) Result)
1515
Start(ctx context.Context)
1616
Stop()
1717

‎pkg/task/queue/queue_set.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ func (tqs *TaskQueueSet) Add(queue task.TaskQueue) {
7575
tqs.m.Unlock()
7676
}
7777

78-
func (tqs *TaskQueueSet) NewNamedQueue(name string, handler func(ctx context.Context, t task.Task) task.TaskResult, opts ...TaskQueueOption) {
78+
func (tqs *TaskQueueSet) NewNamedQueue(name string, handler func(ctx context.Context, t task.Task) task.Result, opts ...TaskQueueOption) {
7979
q := NewTasksQueue(
8080
tqs.metricStorage,
8181
WithName(name),

‎pkg/task/queue/task_queue_list.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ type TaskQueue struct {
107107
started bool // a flag to ignore multiple starts
108108

109109
name string
110-
handler func(ctx context.Context, t task.Task) task.TaskResult
110+
handler func(ctx context.Context, t task.Task) task.Result
111111
status string
112112

113113
measureActionFn func()
@@ -150,7 +150,7 @@ func WithName(name string) TaskQueueOption {
150150
}
151151

152152
// WithHandler sets the task handler for the TaskQueue
153-
func WithHandler(fn func(ctx context.Context, t task.Task) task.TaskResult) TaskQueueOption {
153+
func WithHandler(fn func(ctx context.Context, t task.Task) task.Result) TaskQueueOption {
154154
return func(q *TaskQueue) {
155155
q.handler = fn
156156
}
@@ -286,13 +286,13 @@ func (q *TaskQueue) GetName() string {
286286
return q.name
287287
}
288288

289-
func (q *TaskQueue) GetHandler() func(ctx context.Context, t task.Task) task.TaskResult {
289+
func (q *TaskQueue) GetHandler() func(ctx context.Context, t task.Task) task.Result {
290290
q.m.RLock()
291291
defer q.m.RUnlock()
292292
return q.handler
293293
}
294294

295-
func (q *TaskQueue) SetHandler(handler func(ctx context.Context, t task.Task) task.TaskResult) {
295+
func (q *TaskQueue) SetHandler(handler func(ctx context.Context, t task.Task) task.Result) {
296296
q.m.RLock()
297297
defer q.m.RUnlock()
298298
q.handler = handler

‎pkg/task/queue/task_queue_requeue_test.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ func Test_TaskQueueList_Requeue(t *testing.T) {
5454
q.DelayOnRepeat = 5 * time.Millisecond
5555

5656
// Define the handler for tasks
57-
q.handler = func(_ context.Context, tsk task.Task) task.TaskResult {
57+
q.handler = func(_ context.Context, tsk task.Task) task.Result {
5858
mu.Lock()
5959
executionOrder = append(executionOrder, tsk.GetId())
6060
mu.Unlock()
6161

6262
if tsk.GetId() == "RequeueTask" {
6363
// If there are other tasks in the queue, move this task to the end.
6464
if q.Length() > 1 {
65-
res := task.TaskResult{Status: task.Success}
65+
res := task.Result{Status: task.Success}
6666
res.AddTailTasks(tsk)
6767

6868
return res
@@ -71,11 +71,11 @@ func Test_TaskQueueList_Requeue(t *testing.T) {
7171
// If no other tasks, wait for the signal to finish.
7272
<-requeueTaskCanFinish
7373
close(requeueTaskFinished)
74-
return task.TaskResult{Status: task.Success}
74+
return task.Result{Status: task.Success}
7575
}
7676

7777
// For simple tasks, just succeed.
78-
return task.TaskResult{Status: task.Success}
78+
return task.Result{Status: task.Success}
7979
}
8080

8181
// Add the "requeue" task first.

pkg/task/task_result.go renamed to pkg/task/result.go

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ import (
44
"time"
55
)
66

7-
type TaskStatus string
7+
type Status string
88

99
const (
10-
Success TaskStatus = "Success"
11-
Fail TaskStatus = "Fail"
12-
Repeat TaskStatus = "Repeat"
13-
Keep TaskStatus = "Keep"
10+
Success Status = "Success"
11+
Fail Status = "Fail"
12+
Repeat Status = "Repeat"
13+
Keep Status = "Keep"
1414
)
1515

16-
type TaskResult struct {
17-
Status TaskStatus
16+
type Result struct {
17+
Status Status
1818
headTasks []Task
1919
tailTasks []Task
2020
afterTasks []Task
@@ -24,35 +24,35 @@ type TaskResult struct {
2424
AfterHandle func()
2525
}
2626

27-
func (res *TaskResult) GetHeadTasks() []Task {
27+
func (res *Result) GetHeadTasks() []Task {
2828
return res.headTasks
2929
}
3030

31-
func (res *TaskResult) GetTailTasks() []Task {
31+
func (res *Result) GetTailTasks() []Task {
3232
return res.tailTasks
3333
}
3434

35-
func (res *TaskResult) GetAfterTasks() []Task {
35+
func (res *Result) GetAfterTasks() []Task {
3636
return res.afterTasks
3737
}
3838

39-
func (res *TaskResult) AddHeadTasks(t ...Task) {
39+
func (res *Result) AddHeadTasks(t ...Task) {
4040
if res.headTasks == nil {
4141
res.headTasks = make([]Task, 0, len(t))
4242
}
4343

4444
res.headTasks = append(res.headTasks, t...)
4545
}
4646

47-
func (res *TaskResult) AddTailTasks(t ...Task) {
47+
func (res *Result) AddTailTasks(t ...Task) {
4848
if res.tailTasks == nil {
4949
res.tailTasks = make([]Task, 0, len(t))
5050
}
5151

5252
res.tailTasks = append(res.tailTasks, t...)
5353
}
5454

55-
func (res *TaskResult) AddAfterTasks(t ...Task) {
55+
func (res *Result) AddAfterTasks(t ...Task) {
5656
if res.afterTasks == nil {
5757
res.afterTasks = make([]Task, 0, len(t))
5858
}

0 commit comments

Comments
 (0)