-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
timeout_error.go
68 lines (58 loc) · 1.88 KB
/
timeout_error.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
/*
*
* k6 - a next-generation load testing tool
* Copyright (C) 2019 Load Impact
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package lib
import (
"fmt"
"time"
"github.com/loadimpact/k6/lib/consts"
)
// TimeoutError is used when somethings timeouts
type TimeoutError struct {
place string
d time.Duration
}
// NewTimeoutError returns a new TimeoutError reporting that timeout has happened
// at the given place and given duration.
func NewTimeoutError(place string, d time.Duration) TimeoutError {
return TimeoutError{place: place, d: d}
}
// String returns timeout error in human readable format.
func (t TimeoutError) String() string {
return fmt.Sprintf("%s() execution timed out after %.f seconds", t.place, t.d.Seconds())
}
// Error implements error interface.
func (t TimeoutError) Error() string {
return t.String()
}
// Place returns the place where timeout occurred.
func (t TimeoutError) Place() string {
return t.place
}
// Hint returns a hint message for logging with given stage.
func (t TimeoutError) Hint() string {
hint := ""
switch t.place {
case consts.SetupFn:
hint = "You can increase the time limit via the setupTimeout option"
case consts.TeardownFn:
hint = "You can increase the time limit via the teardownTimeout option"
}
return hint
}