-
Notifications
You must be signed in to change notification settings - Fork 12
/
telem_test.go
406 lines (369 loc) · 14.1 KB
/
telem_test.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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
// Copyright 2023 Synnax Labs, Inc.
//
// Use of this software is governed by the Business Source License included in the file
// licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with the Business Source
// License, use of this software will be governed by the Apache License, Version 2.0,
// included in the file licenses/APL.txt.
package telem_test
import (
"fmt"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"github.com/synnaxlabs/x/telem"
"time"
)
var _ = Describe("Telem", func() {
Describe("TimeStamp", func() {
Describe("Now", func() {
It("Should return the current time", func() {
Expect(telem.Now().Time()).To(BeTemporally("~", time.Now(), time.Millisecond))
})
})
Describe("Stringer", func() {
It("Should format a time properly", func() {
ts := 90*telem.DayTS + 20*telem.MinuteTS + 283*telem.MillisecondTS + 900*telem.MicrosecondTS
Expect(fmt.Sprintf("%v", ts)).To(Equal("1970-04-01T00:20:00.283Z"))
})
It("Should do EoT", func() {
Expect(fmt.Sprintf("%v", telem.TimeStampMax)).To(Equal("end of time"))
})
})
Describe("Name", func() {
It("Should initialize a new timestamp based on the provided time", func() {
t := time.Now()
t0 := telem.NewTimeStamp(t)
Expect(t0.Time()).To(BeTemporally("~", t, time.Millisecond))
})
})
Describe("IsZero", func() {
It("Should return true if the timestamp is zero", func() {
Expect(telem.TimeStampMin.IsZero()).To(BeTrue())
Expect(telem.TimeStampMax.IsZero()).To(BeFalse())
})
})
Describe("Before", func() {
It("Should return true if the timestamp is after the provided one", func() {
Expect(telem.TimeStampMin.After(telem.TimeStampMax)).To(BeFalse())
Expect(telem.TimeStampMax.After(telem.TimeStampMin)).To(BeTrue())
})
It("Should return false if the timestamp is equal to the provided one", func() {
Expect(telem.TimeStampMin.After(telem.TimeStampMin)).To(BeFalse())
Expect(telem.TimeStampMax.After(telem.TimeStampMax)).To(BeFalse())
})
})
Describe("After", func() {
It("Should return true if the timestamp is before the provided one", func() {
Expect(telem.TimeStampMin.Before(telem.TimeStampMax)).To(BeTrue())
Expect(telem.TimeStampMax.Before(telem.TimeStampMin)).To(BeFalse())
})
It("Should return false if the timestamp is equal to the provided one", func() {
Expect(telem.TimeStampMin.Before(telem.TimeStampMin)).To(BeFalse())
Expect(telem.TimeStampMax.Before(telem.TimeStampMax)).To(BeFalse())
})
})
Describe("add", func() {
It("Should return a new timestamp with the provided timespan added to it", func() {
t0 := telem.TimeStamp(0)
t1 := t0.Add(telem.Second)
Expect(t1).To(Equal(telem.TimeStamp(1 * telem.Second)))
})
})
Describe("sub", func() {
It("Should return a new timestamp with the provided timespan subtracted from it", func() {
t0 := telem.TimeStamp(0)
t1 := t0.Sub(telem.Second)
Expect(t1).To(Equal(telem.TimeStamp(-1 * telem.Second)))
})
})
Describe("SpanRange", func() {
It("Should return the correct time range", func() {
t0 := telem.TimeStamp(0)
r := t0.SpanRange(telem.Second)
Expect(r.Start).To(Equal(t0))
Expect(r.End).To(Equal(t0.Add(telem.Second)))
})
It("Should swap the start and end if the start is after the end", func() {
t0 := telem.TimeStamp(0)
r := telem.TimeStamp(telem.Second).SpanRange(-1 * telem.Second)
Expect(r.Start).To(Equal(t0))
Expect(r.End).To(Equal(t0.Add(telem.Second)))
})
})
Describe("Bounds", func() {
It("Should return the correct time range", func() {
t0 := telem.TimeStamp(0)
t1 := t0.Add(telem.Second)
r := t0.Range(t1)
Expect(r.Start).To(Equal(t0))
Expect(r.End).To(Equal(t1))
})
})
})
Describe("TimeRange", func() {
Describe("Stringer", func() {
It("Should format a time range properly", func() {
ts1 := 2*telem.DayTS + 20*telem.MinuteTS + 283*telem.MillisecondTS + 900*telem.MicrosecondTS
ts2 := 4*telem.DayTS + 20*telem.MinuteTS + 283*telem.MillisecondTS + 900*telem.MicrosecondTS
Expect(fmt.Sprintf("%v", ts1.Range(ts2))).To(Equal("1970-01-03T00:20:00.283Z - 1970-01-05T00:20:00.283Z"))
})
})
Describe("SpanTo", func() {
It("Should return the correct time span", func() {
tr := telem.TimeRange{
Start: telem.TimeStamp(0),
End: telem.TimeStamp(telem.Second),
}
Expect(tr.Span()).To(Equal(telem.Second))
})
})
Describe("IsZero", func() {
It("Should return true if the time range is zero", func() {
Expect(telem.TimeRangeMin.IsZero()).To(BeFalse())
Expect(telem.TimeRangeMax.IsZero()).To(BeFalse())
Expect(telem.TimeRangeZero.IsZero()).To(BeTrue())
})
})
Describe("BoundBy", func() {
It("Should bound the time range to the provided constraints", func() {
tr := telem.TimeRange{
Start: telem.TimeStamp(telem.Second),
End: telem.TimeStamp(telem.Second * 4),
}
bound := telem.TimeRange{
Start: telem.TimeStamp(2 * telem.Second),
End: telem.TimeStamp(telem.Second * 3),
}
bounded := tr.BoundBy(bound)
Expect(bounded.Start).To(Equal(bound.Start))
Expect(bounded.End).To(Equal(bound.End))
})
It("Should bound the time range even if the start is after the end", func() {
tr := telem.TimeRange{
Start: telem.TimeStamp(telem.Second * 4),
End: telem.TimeStamp(telem.Second),
}
bound := telem.TimeRange{
Start: telem.TimeStamp(2 * telem.Second),
End: telem.TimeStamp(telem.Second * 3),
}
bounded := tr.BoundBy(bound)
Expect(bounded.Start).To(Equal(bound.End))
Expect(bounded.End).To(Equal(bound.Start))
})
})
Describe("ContainsStamp", func() {
It("Should return true when the range contains the timestamp", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
Expect(tr.ContainsStamp(telem.TimeStamp(4 * telem.Second))).To(BeTrue())
By("Being inclusive at the lower bound")
Expect(tr.ContainsStamp(telem.TimeStamp(0 * telem.Second))).To(BeTrue())
By("Being exclusive at the upper bound")
Expect(tr.ContainsStamp(telem.TimeStamp(5 * telem.Second))).To(BeFalse())
})
})
Describe("ContainsRange", func() {
It("Should return true when the ranges overlap with one another", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
Expect(tr.ContainsRange(telem.TimeStamp(1).SpanRange(2 * telem.Second))).To(BeTrue())
})
It("Should return false when the start of one range is the end of another", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
tr2 := telem.TimeStamp(5 * telem.Second).SpanRange(5 * telem.Second)
Expect(tr.ContainsRange(tr2)).To(BeFalse())
Expect(tr2.ContainsRange(tr)).To(BeFalse())
})
It("Should return true if checked against itself", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
Expect(tr.ContainsRange(tr))
})
})
Describe("WhereOverlapsWith", func() {
It("Should return true when the ranges overlap with one another", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
Expect(tr.OverlapsWith(telem.TimeStamp(1).SpanRange(2 * telem.Second))).To(BeTrue())
})
It("Should return false when the start of one range is the end of another", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
tr2 := telem.TimeStamp(5 * telem.Second).SpanRange(5 * telem.Second)
Expect(tr.OverlapsWith(tr2)).To(BeFalse())
Expect(tr2.OverlapsWith(tr)).To(BeFalse())
})
It("Should return true if checked against itself", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
Expect(tr.OverlapsWith(tr))
})
It("Should return false if the ranges do not overlap", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
tr2 := telem.TimeStamp(5 * telem.Second).SpanRange(5 * telem.Second)
Expect(tr.OverlapsWith(tr2)).To(BeFalse())
Expect(tr2.OverlapsWith(tr)).To(BeFalse())
})
It("Should return true if one range is contained within the other", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
tr2 := telem.TimeStamp(1).SpanRange(2 * telem.Second)
Expect(tr.OverlapsWith(tr2)).To(BeTrue())
Expect(tr2.OverlapsWith(tr)).To(BeTrue())
})
})
Describe("Swap", func() {
It("Should swap the start and end times", func() {
tr := telem.TimeStamp(0).SpanRange(5 * telem.Second)
Expect(tr.Start).To(Equal(telem.TimeStamp(0)))
Expect(tr.End).To(Equal(telem.TimeStamp(5 * telem.Second)))
tr = tr.Swap()
Expect(tr.Start).To(Equal(telem.TimeStamp(5 * telem.Second)))
Expect(tr.End).To(Equal(telem.TimeStamp(0)))
})
})
Describe("Intersection", func() {
Specify("Overlap, first before second", func() {
tr := (0 * telem.SecondTS).Range(5 * telem.SecondTS)
tr2 := (3 * telem.SecondTS).Range(8 * telem.SecondTS)
union := tr.Intersection(tr2)
Expect(union.Start).To(Equal(3 * telem.SecondTS))
Expect(union.End).To(Equal(5 * telem.SecondTS))
})
Specify("Overlap, second before first", func() {
tr2 := (0 * telem.SecondTS).Range(5 * telem.SecondTS)
tr := (3 * telem.SecondTS).Range(8 * telem.SecondTS)
union := tr.Intersection(tr2)
Expect(union.Start).To(Equal(3 * telem.SecondTS))
Expect(union.End).To(Equal(5 * telem.SecondTS))
})
Specify("1 Fully contain 2", func() {
tr := (0 * telem.SecondTS).Range(10 * telem.SecondTS)
tr2 := (3 * telem.SecondTS).Range(8 * telem.SecondTS)
union := tr.Intersection(tr2)
Expect(union.Start).To(Equal(3 * telem.SecondTS))
Expect(union.End).To(Equal(8 * telem.SecondTS))
})
Specify("2 Fully contain 1", func() {
tr := (2 * telem.SecondTS).Range(5 * telem.SecondTS)
tr2 := (1 * telem.SecondTS).Range(8 * telem.SecondTS)
union := tr.Intersection(tr2)
Expect(union.Start).To(Equal(2 * telem.SecondTS))
Expect(union.End).To(Equal(5 * telem.SecondTS))
})
})
Describe("Union", func() {
Specify("Overlap, first before second", func() {
tr := (0 * telem.SecondTS).Range(5 * telem.SecondTS)
tr2 := (3 * telem.SecondTS).Range(8 * telem.SecondTS)
union := tr.Union(tr2)
Expect(union.Start).To(Equal(telem.TimeStamp(0)))
Expect(union.End).To(Equal(8 * telem.SecondTS))
})
Specify("Overlap, second before first", func() {
tr2 := (0 * telem.SecondTS).Range(5 * telem.SecondTS)
tr := (3 * telem.SecondTS).Range(8 * telem.SecondTS)
union := tr.Union(tr2)
Expect(union.Start).To(Equal(telem.TimeStamp(0)))
Expect(union.End).To(Equal(8 * telem.SecondTS))
})
Specify("1 Fully contain 2", func() {
tr := (0 * telem.SecondTS).Range(10 * telem.SecondTS)
tr2 := (3 * telem.SecondTS).Range(8 * telem.SecondTS)
union := tr.Union(tr2)
Expect(union.Start).To(Equal(0 * telem.SecondTS))
Expect(union.End).To(Equal(10 * telem.SecondTS))
})
Specify("2 Fully contain 1", func() {
tr := (2 * telem.SecondTS).Range(5 * telem.SecondTS)
tr2 := (1 * telem.SecondTS).Range(8 * telem.SecondTS)
union := tr.Union(tr2)
Expect(union.Start).To(Equal(1 * telem.SecondTS))
Expect(union.End).To(Equal(8 * telem.SecondTS))
})
})
Describe("TimeSpan", func() {
Describe("Duration", func() {
It("Should return the correct time span", func() {
ts := telem.Second
Expect(ts.Duration()).To(Equal(time.Second))
})
})
Describe("Stringer", func() {
DescribeTable("Should format a timespan properly", func(span telem.TimeSpan, expected string) {
Expect(fmt.Sprintf("%v", span)).To(Equal(expected))
},
Entry("nano", 1*telem.Nanosecond, "1ns"),
Entry("micro", 1*telem.Microsecond, "1µs"),
Entry("milli", 1*telem.Millisecond, "1ms"),
Entry("second", 1*telem.Second, "1s"),
Entry("minute", 1*telem.Minute, "1m"),
Entry("hour", 1*telem.Hour, "1h"),
Entry("max", telem.TimeSpanMax, "max time span"),
Entry("combine", 2*telem.Day+80*telem.Minute+1*telem.Millisecond+500*telem.Microsecond+5*telem.Nanosecond, "2d 1h 20m 1ms 500µs 5ns"),
)
})
Describe("Seconds", func() {
It("Should return the correct number of seconds in the span", func() {
ts := telem.Millisecond
Expect(ts.Seconds()).To(Equal(0.001))
})
})
Describe("IsZero", func() {
It("Should return true if the time span is zero", func() {
Expect(telem.TimeSpanMax.IsZero()).To(BeFalse())
Expect(telem.TimeSpanZero.IsZero()).To(BeTrue())
})
})
Describe("IsMax", func() {
It("Should return true if the time span is the maximum", func() {
Expect(telem.TimeSpanMax.IsMax()).To(BeTrue())
Expect(telem.TimeSpanZero.IsMax()).To(BeFalse())
})
})
Describe("ByteSize", func() {
It("Should return the correct byte size", func() {
Expect(telem.Second.ByteSize(1, 8)).To(Equal(telem.Size(8)))
})
})
})
Describe("size", func() {
Describe("Report", func() {
It("Should return the correct string", func() {
s := telem.Size(0)
Expect(s.String()).To(Equal("0B"))
})
})
})
Describe("Rate", func() {
Describe("Period", func() {
It("Should return the correct period for the data rate", func() {
Expect(telem.Rate(1).Period()).To(Equal(telem.Second))
})
})
Describe("Distance", func() {
It("Should return the number of samples that fit in the span", func() {
Expect(telem.Rate(10).SampleCount(telem.Second)).To(Equal(10))
})
})
Describe("SpanTo", func() {
It("Should return the span of the provided samples", func() {
Expect(telem.Rate(10).Span(10)).To(Equal(telem.Second))
})
})
Describe("SizeSpan", func() {
It("Should return the span of the provided number of bytes", func() {
Expect(telem.Rate(10).SizeSpan(16, telem.Bit64)).To(Equal(200 * telem.Millisecond))
})
})
})
})
Describe("Marshal", func() {
Specify("marshal int", func() {
og := []int16{1, 2, 3, 4}
marshalled := telem.MarshalSlice(og, telem.Int16T)
unmarshalled := telem.UnmarshalSlice[int16](marshalled, telem.Int16T)
Expect(og).To(Equal(unmarshalled))
})
Specify("marshal float not implemented", func() {
og := []float64{1.1, 2, 3, 4}
Expect(func() { telem.MarshalSlice(og, telem.Float64T) }).To(Panic())
Expect(func() { telem.UnmarshalSlice[float64]([]byte{0, 1, 2, 3}, telem.Float64T) }).To(Panic())
})
})
})