forked from k3s-io/kubernetes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
timer.go
126 lines (106 loc) · 3.4 KB
/
timer.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
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
/*
Copyright 2017 The Kubernetes Authors.
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 timer
import (
"time"
"bytes"
"fmt"
"k8s.io/kubernetes/test/e2e/framework"
"k8s.io/kubernetes/test/e2e/perftype"
"sync"
)
var now = time.Now
// Represents a phase of a test. Phases can overlap.
type Phase struct {
sequenceNumber int
name string
startTime time.Time
endTime time.Time
}
func (phase *Phase) ended() bool {
return !phase.endTime.IsZero()
}
// End marks the phase as ended, unless it had already been ended before.
func (phase *Phase) End() {
if !phase.ended() {
phase.endTime = now()
}
}
func (phase *Phase) label() string {
return fmt.Sprintf("%03d-%s", phase.sequenceNumber, phase.name)
}
func (phase *Phase) duration() time.Duration {
endTime := phase.endTime
if !phase.ended() {
endTime = now()
}
return endTime.Sub(phase.startTime)
}
func (phase *Phase) humanReadable() string {
if phase.ended() {
return fmt.Sprintf("Phase %s: %v\n", phase.label(), phase.duration())
} else {
return fmt.Sprintf("Phase %s: %v so far\n", phase.label(), phase.duration())
}
}
// A TestPhaseTimer groups phases and provides a way to export their measurements as JSON or human-readable text.
// It is safe to use concurrently.
type TestPhaseTimer struct {
lock sync.Mutex
phases []*Phase
}
// NewTestPhaseTimer creates a new TestPhaseTimer.
func NewTestPhaseTimer() *TestPhaseTimer {
return &TestPhaseTimer{}
}
// StartPhase starts a new phase.
// sequenceNumber is an integer prepended to phaseName in the output, such that lexicographic sorting
// of phases in perfdash reconstructs the order of execution. Unfortunately it needs to be
// provided manually, since a simple incrementing counter would have the effect that inserting
// a new phase would renumber subsequent phases, breaking the continuity of historical records.
func (timer *TestPhaseTimer) StartPhase(sequenceNumber int, phaseName string) *Phase {
timer.lock.Lock()
defer timer.lock.Unlock()
newPhase := &Phase{sequenceNumber: sequenceNumber, name: phaseName, startTime: now()}
timer.phases = append(timer.phases, newPhase)
return newPhase
}
func (timer *TestPhaseTimer) SummaryKind() string {
return "TestPhaseTimer"
}
func (timer *TestPhaseTimer) PrintHumanReadable() string {
buf := bytes.Buffer{}
timer.lock.Lock()
defer timer.lock.Unlock()
for _, phase := range timer.phases {
buf.WriteString(phase.humanReadable())
}
return buf.String()
}
func (timer *TestPhaseTimer) PrintJSON() string {
data := perftype.PerfData{
Version: "v1",
DataItems: []perftype.DataItem{{
Unit: "s",
Labels: map[string]string{"test": "phases"},
Data: make(map[string]float64)}}}
timer.lock.Lock()
defer timer.lock.Unlock()
for _, phase := range timer.phases {
data.DataItems[0].Data[phase.label()] = phase.duration().Seconds()
if !phase.ended() {
data.DataItems[0].Labels["ended"] = "false"
}
}
return framework.PrettyPrintJSON(data)
}