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
219
220
221
|
// Copyright (C) 2019-2021 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand 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.
//
// go-algorand 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 go-algorand. If not, see <https://www.gnu.org/licenses/>.
package logging
import (
"io/ioutil"
"os"
"path/filepath"
"testing"
"github.com/sirupsen/logrus"
"github.com/stretchr/testify/require"
"github.com/algorand/go-algorand/config"
)
func TestTelemetryConfig(t *testing.T) {
a := require.New(t)
cfg := createTelemetryConfig()
expectedEnabled := false
a.Equal(expectedEnabled, cfg.Enable)
a.Equal("", cfg.URI)
a.NotZero(len(cfg.GUID))
a.Equal(logrus.WarnLevel, cfg.MinLogLevel)
a.Equal(logrus.WarnLevel, cfg.ReportHistoryLevel)
}
func TestLoadDefaultConfig(t *testing.T) {
a := require.New(t)
configDir, err := ioutil.TempDir("", "testdir")
defer os.RemoveAll(configDir)
currentRoot := config.SetGlobalConfigFileRoot(configDir)
defer config.SetGlobalConfigFileRoot(currentRoot)
_, err = EnsureTelemetryConfig(nil, "")
a.Nil(err)
}
func isDefault(cfg TelemetryConfig) bool {
defaultCfg := createTelemetryConfig()
cfg.FilePath = "" // Reset to compare the rest
cfg.GUID = ""
cfg.ChainID = ""
defaultCfg.GUID = ""
return cfg == defaultCfg
}
func TestLoggingConfigDataDirFirst(t *testing.T) {
a := require.New(t)
globalConfigRoot, err := ioutil.TempDir("", "globalConfigRoot")
defer os.RemoveAll(globalConfigRoot)
oldConfigRoot := config.SetGlobalConfigFileRoot(globalConfigRoot)
defer config.SetGlobalConfigFileRoot(oldConfigRoot)
globalLoggingPath := filepath.Join(globalConfigRoot, TelemetryConfigFilename)
dataDir, err := ioutil.TempDir("", "dataDir")
defer os.RemoveAll(dataDir)
dataDirLoggingPath := filepath.Join(dataDir, TelemetryConfigFilename)
_, err = os.Stat(globalLoggingPath)
a.True(os.IsNotExist(err))
_, err = os.Stat(dataDirLoggingPath)
a.True(os.IsNotExist(err))
defaultCfg := createTelemetryConfig()
a.False(defaultCfg.Enable) // if the default becomes true, flip the logic in this test to make it more interesting.
fout, err := os.Create(dataDirLoggingPath)
a.Nil(err)
fout.Write([]byte("{\"Enable\":true}"))
fout.Close()
cfg, err := EnsureTelemetryConfig(&dataDir, "")
a.Nil(err)
_, err = os.Stat(globalLoggingPath)
a.True(os.IsNotExist(err))
_, err = os.Stat(dataDirLoggingPath)
a.Nil(err)
a.Equal(cfg.FilePath, dataDirLoggingPath)
a.NotEqual(cfg.GUID, defaultCfg.GUID)
// We got this from the tiny file we wrote to earlier.
a.True(cfg.Enable)
err = cfg.Save(cfg.FilePath)
a.Nil(err)
}
func TestLoggingConfigGlobalSecond(t *testing.T) {
a := require.New(t)
globalConfigRoot, err := ioutil.TempDir("", "globalConfigRoot")
defer os.RemoveAll(globalConfigRoot)
oldConfigRoot := config.SetGlobalConfigFileRoot(globalConfigRoot)
defer config.SetGlobalConfigFileRoot(oldConfigRoot)
globalLoggingPath := filepath.Join(globalConfigRoot, TelemetryConfigFilename)
_, err = os.Stat(globalLoggingPath)
a.True(os.IsNotExist(err))
cfgPath := "/missing-directory"
cfg, err := EnsureTelemetryConfig(&cfgPath, "")
a.Nil(err)
_, err = os.Stat(globalLoggingPath)
a.Nil(err)
// Returned cfg should be same as default except
// for the FilePath and GUID
defaultCfg := createTelemetryConfig()
a.Equal(cfg.FilePath, globalLoggingPath)
a.NotEqual(cfg.GUID, defaultCfg.GUID)
a.True(isDefault(cfg))
err = cfg.Save(cfg.FilePath)
a.Nil(err)
}
func TestSaveLoadConfig(t *testing.T) {
a := require.New(t)
globalConfigRoot, err := ioutil.TempDir("", "globalConfigRoot")
defer os.RemoveAll(globalConfigRoot)
oldConfigRoot := config.SetGlobalConfigFileRoot(globalConfigRoot)
defer config.SetGlobalConfigFileRoot(oldConfigRoot)
configDir, err := ioutil.TempDir("", "testdir")
os.RemoveAll(configDir)
err = os.Mkdir(configDir, 0777)
cfg, err := EnsureTelemetryConfig(&configDir, "")
cfg.Name = "testname"
err = cfg.Save(cfg.FilePath)
a.NoError(err)
cfgLoad, err := LoadTelemetryConfig(cfg.FilePath)
// ChainId isn't stored.
a.NotEmpty(cfg.ChainID)
a.Empty(cfgLoad.ChainID)
cfg.ChainID = ""
a.NoError(err)
a.Equal("testname", cfgLoad.Name)
a.Equal(cfgLoad, cfg)
os.RemoveAll(configDir)
}
func TestAsyncTelemetryHook_CloseDrop(t *testing.T) {
const entryCount = 100
filling := make(chan struct{})
testHook := makeMockTelemetryHook(logrus.DebugLevel)
testHook.cb = func(entry *logrus.Entry) {
<-filling // Block while filling
}
hook := createAsyncHook(&testHook, 4, entryCount)
hook.ready = true
for i := 0; i < entryCount; i++ {
entry := logrus.Entry{
Level: logrus.ErrorLevel,
}
hook.Fire(&entry)
}
close(filling)
hook.Close()
// To not block, we drop messages when they come in faster than the network sends them.
require.Less(t, len(testHook.entries()), entryCount)
}
func TestAsyncTelemetryHook_QueueDepth(t *testing.T) {
const entryCount = 100
const maxDepth = 10
filling := make(chan struct{})
testHook := makeMockTelemetryHook(logrus.DebugLevel)
testHook.cb = func(entry *logrus.Entry) {
<-filling // Block while filling
}
hook := createAsyncHook(&testHook, entryCount, maxDepth)
hook.ready = true
for i := 0; i < entryCount; i++ {
entry := logrus.Entry{
Level: logrus.ErrorLevel,
}
hook.Fire(&entry)
}
close(filling)
hook.Close()
require.Equal(t, maxDepth, len(testHook.entries()))
}
|
