-
Notifications
You must be signed in to change notification settings - Fork 8
/
logger.go
218 lines (192 loc) · 5.08 KB
/
logger.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
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
// Copyright 2018 Appliscale
//
// Maintainers and contributors are listed in README file inside repository.
//
// 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 logger provides logger tool for perun for control standard I/O
// usage.
package logger
import (
"fmt"
"strings"
)
// Logger contains information type of logger tool.
type LoggerInt interface {
Always(message string)
Warning(warning string)
Error(err string)
Info(info string)
Debug(debug string)
Trace(trace string)
GetInput(message string, v ...interface{}) error
PrintValidationErrors()
HasValidationErrors() bool
HasValidationWarnings() bool
AddResourceForValidation(resourceName string) *ResourceValidation
SetVerbosity(verbosity string)
}
type Logger struct {
Quiet bool
Yes bool
Verbosity Verbosity
resourceValidation []*ResourceValidation
}
// ResourceValidation contains name of resource and errors.
type ResourceValidation struct {
ResourceName string
Errors []string
Warnings []string
}
// Verbosity - type of logger.
type Verbosity int
const (
TRACE Verbosity = iota
DEBUG
INFO
ERROR
WARNING
)
var verboseModes = [...]string{
"TRACE",
"DEBUG",
"INFO",
"ERROR",
"WARNING",
}
func (verbosity Verbosity) String() string {
return verboseModes[verbosity]
}
// Create default logger.
func CreateDefaultLogger() Logger {
return Logger{
Quiet: false,
Yes: false,
Verbosity: INFO,
}
}
// Create quiet logger.
func CreateQuietLogger() Logger {
return Logger{
Quiet: true,
Yes: false,
Verbosity: INFO,
}
}
// Log always - no matter the verbosity level.
func (logger *Logger) Always(message string) {
fmt.Println(message)
}
// Log error.
func (logger *Logger) Warning(warning string) {
logger.log(WARNING, warning)
}
// Log error.
func (logger *Logger) Error(err string) {
logger.log(ERROR, err)
}
// Log info.
func (logger *Logger) Info(info string) {
logger.log(INFO, info)
}
// Log debug.
func (logger *Logger) Debug(debug string) {
logger.log(DEBUG, debug)
}
// Log trace.
func (logger *Logger) Trace(trace string) {
logger.log(TRACE, trace)
}
// Log validation error.
func (resourceValidation *ResourceValidation) AddValidationError(error string) {
resourceValidation.Errors = append(resourceValidation.Errors, error)
}
// Log validation error.
func (resourceValidation *ResourceValidation) AddValidationWarning(warning string) {
resourceValidation.Warnings = append(resourceValidation.Warnings, warning)
}
// Get input from command line.
func (logger *Logger) GetInput(message string, v ...interface{}) error {
fmt.Printf("%s: ", message)
_, err := fmt.Scanln(v...)
if err != nil {
return err
}
return nil
}
func (logger *Logger) log(verbosity Verbosity, message string) {
if !logger.Quiet && verbosity >= logger.Verbosity {
fmt.Println(verbosity.String() + ": " + message)
}
}
// Print validation error.
func (logger *Logger) PrintValidationErrors() {
if !logger.Quiet {
for _, resourceValidation := range logger.resourceValidation {
if len(resourceValidation.Errors) != 0 || len(resourceValidation.Warnings) != 0 {
fmt.Println(resourceValidation.ResourceName)
for _, err := range resourceValidation.Errors {
fmt.Println(" ", err)
}
for _, warning := range resourceValidation.Warnings {
fmt.Println(" ", warning)
}
}
}
}
}
// HasValidationErrors checks if resource has errors. It's used in validateResources().
func (logger *Logger) HasValidationErrors() bool {
for _, resourceValidation := range logger.resourceValidation {
if len(resourceValidation.Errors) > 0 {
return true
}
}
return false
}
func (logger *Logger) HasValidationWarnings() bool {
for _, resourceValidation := range logger.resourceValidation {
if len(resourceValidation.Warnings) > 0 {
return true
}
}
return false
}
// AddResourceForValidation : Adds resource for validation. It's used in validateResources().
func (logger *Logger) AddResourceForValidation(resourceName string) *ResourceValidation {
resourceValidation := &ResourceValidation{
ResourceName: resourceName,
}
logger.resourceValidation = append(logger.resourceValidation, resourceValidation)
return resourceValidation
}
// Set logger verbosity.
func (logger *Logger) SetVerbosity(verbosity string) {
for index, element := range verboseModes {
if strings.ToUpper(verbosity) == element {
logger.Verbosity = Verbosity(index)
}
}
}
// Check if verbosity is one of the given types.
func IsVerbosityValid(verbosity string) bool {
switch verbosity {
case
"TRACE",
"DEBUG",
"INFO",
"WARNING",
"ERROR":
return true
}
return false
}