-
Notifications
You must be signed in to change notification settings - Fork 458
/
progress_reporter.go
44 lines (39 loc) · 1.51 KB
/
progress_reporter.go
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
// Copyright 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package flow
import (
"context"
"strings"
)
// ProgressReporterFn is continuously called on progress in a flow.
type ProgressReporterFn func(context.Context, *Stats)
// ProgressReporter is used to report the current progress of a flow.
type ProgressReporter interface {
// Start starts the progress reporter.
Start(context.Context) error
// Stop stops the progress reporter.
Stop()
// Report reports the progress using the current statistics.
Report(context.Context, *Stats)
}
// MakeDescription returns a description based on the stats.
func MakeDescription(stats *Stats) string {
if stats.ProgressPercent() == 0 {
return "Starting " + stats.FlowName
}
if stats.ProgressPercent() == 100 {
return stats.FlowName + " finished"
}
return strings.Join(stats.Running.StringList(), ", ")
}