-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
engine_test.go
1260 lines (1086 loc) · 35.2 KB
/
engine_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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
*
* k6 - a next-generation load testing tool
* Copyright (C) 2016 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 core
import (
"context"
"fmt"
"net/url"
"runtime"
"testing"
"time"
"github.com/sirupsen/logrus"
"github.com/spf13/afero"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gopkg.in/guregu/null.v3"
"go.k6.io/k6/core/local"
"go.k6.io/k6/errext"
"go.k6.io/k6/js"
"go.k6.io/k6/lib"
"go.k6.io/k6/lib/executor"
"go.k6.io/k6/lib/metrics"
"go.k6.io/k6/lib/testutils"
"go.k6.io/k6/lib/testutils/httpmultibin"
"go.k6.io/k6/lib/testutils/minirunner"
"go.k6.io/k6/lib/testutils/mockoutput"
"go.k6.io/k6/lib/types"
"go.k6.io/k6/loader"
"go.k6.io/k6/output"
"go.k6.io/k6/stats"
)
const isWindows = runtime.GOOS == "windows"
// Wrapper around NewEngine that applies a logger and manages the options.
func newTestEngine( //nolint:golint
t *testing.T, runCtx context.Context, runner lib.Runner, outputs []output.Output, opts lib.Options,
) (engine *Engine, run func() error, wait func()) {
if runner == nil {
runner = &minirunner.MiniRunner{}
}
globalCtx, globalCancel := context.WithCancel(context.Background())
var runCancel func()
if runCtx == nil {
runCtx, runCancel = context.WithCancel(globalCtx)
}
logger := logrus.New()
logger.SetOutput(testutils.NewTestOutput(t))
newOpts, err := executor.DeriveScenariosFromShortcuts(lib.Options{
MetricSamplesBufferSize: null.NewInt(200, false),
}.Apply(runner.GetOptions()).Apply(opts), logger)
require.NoError(t, err)
require.Empty(t, newOpts.Validate())
require.NoError(t, runner.SetOptions(newOpts))
execScheduler, err := local.NewExecutionScheduler(runner, logger)
require.NoError(t, err)
registry := metrics.NewRegistry()
builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
engine, err = NewEngine(execScheduler, opts, lib.RuntimeOptions{}, outputs, logger, builtinMetrics)
require.NoError(t, err)
run, waitFn, err := engine.Init(globalCtx, runCtx)
require.NoError(t, err)
return engine, run, func() {
if runCancel != nil {
runCancel()
}
globalCancel()
waitFn()
}
}
func TestNewEngine(t *testing.T) {
t.Parallel()
newTestEngine(t, nil, nil, nil, lib.Options{})
}
func TestEngineRun(t *testing.T) {
t.Parallel()
logrus.SetLevel(logrus.DebugLevel)
t.Run("exits with context", func(t *testing.T) {
t.Parallel()
done := make(chan struct{})
runner := &minirunner.MiniRunner{
Fn: func(ctx context.Context, _ *lib.State, _ chan<- stats.SampleContainer) error {
<-ctx.Done()
close(done)
return nil
},
}
duration := 100 * time.Millisecond
ctx, cancel := context.WithTimeout(context.Background(), duration)
defer cancel()
_, run, wait := newTestEngine(t, ctx, runner, nil, lib.Options{})
defer wait()
startTime := time.Now()
assert.NoError(t, run())
assert.WithinDuration(t, startTime.Add(duration), time.Now(), 100*time.Millisecond)
<-done
})
t.Run("exits with executor", func(t *testing.T) {
t.Parallel()
e, run, wait := newTestEngine(t, nil, nil, nil, lib.Options{
VUs: null.IntFrom(10),
Iterations: null.IntFrom(100),
})
defer wait()
assert.NoError(t, run())
assert.Equal(t, uint64(100), e.ExecutionScheduler.GetState().GetFullIterationCount())
})
// Make sure samples are discarded after context close (using "cutoff" timestamp in local.go)
t.Run("collects samples", func(t *testing.T) {
t.Parallel()
testMetric := stats.New("test_metric", stats.Trend)
signalChan := make(chan interface{})
runner := &minirunner.MiniRunner{
Fn: func(ctx context.Context, _ *lib.State, out chan<- stats.SampleContainer) error {
stats.PushIfNotDone(ctx, out, stats.Sample{Metric: testMetric, Time: time.Now(), Value: 1})
close(signalChan)
<-ctx.Done()
stats.PushIfNotDone(ctx, out, stats.Sample{Metric: testMetric, Time: time.Now(), Value: 1})
return nil
},
}
mockOutput := mockoutput.New()
ctx, cancel := context.WithCancel(context.Background())
_, run, wait := newTestEngine(t, ctx, runner, []output.Output{mockOutput}, lib.Options{
VUs: null.IntFrom(1),
Iterations: null.IntFrom(1),
})
errC := make(chan error)
go func() { errC <- run() }()
<-signalChan
cancel()
assert.NoError(t, <-errC)
wait()
found := 0
for _, s := range mockOutput.Samples {
if s.Metric != testMetric {
continue
}
found++
assert.Equal(t, 1.0, s.Value, "wrong value")
}
assert.Equal(t, 1, found, "wrong number of samples")
})
}
func TestEngineAtTime(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), 50*time.Millisecond)
defer cancel()
_, run, wait := newTestEngine(t, ctx, nil, nil, lib.Options{
VUs: null.IntFrom(2),
Duration: types.NullDurationFrom(20 * time.Second),
})
defer wait()
assert.NoError(t, run())
}
func TestEngineStopped(t *testing.T) {
t.Parallel()
ctx, cancel := context.WithTimeout(context.Background(), 50*time.Millisecond)
defer cancel()
e, run, wait := newTestEngine(t, ctx, nil, nil, lib.Options{
VUs: null.IntFrom(1),
Duration: types.NullDurationFrom(20 * time.Second),
})
defer wait()
assert.NoError(t, run())
assert.Equal(t, false, e.IsStopped(), "engine should be running")
e.Stop()
assert.Equal(t, true, e.IsStopped(), "engine should be stopped")
e.Stop() // test that a second stop doesn't panic
}
func TestEngineOutput(t *testing.T) {
t.Parallel()
testMetric := stats.New("test_metric", stats.Trend)
runner := &minirunner.MiniRunner{
Fn: func(ctx context.Context, _ *lib.State, out chan<- stats.SampleContainer) error {
out <- stats.Sample{Metric: testMetric}
return nil
},
}
mockOutput := mockoutput.New()
e, run, wait := newTestEngine(t, nil, runner, []output.Output{mockOutput}, lib.Options{
VUs: null.IntFrom(1),
Iterations: null.IntFrom(1),
})
assert.NoError(t, run())
wait()
cSamples := []stats.Sample{}
for _, sample := range mockOutput.Samples {
if sample.Metric == testMetric {
cSamples = append(cSamples, sample)
}
}
metric := e.Metrics["test_metric"]
if assert.NotNil(t, metric) {
sink := metric.Sink.(*stats.TrendSink)
if assert.NotNil(t, sink) {
numOutputSamples := len(cSamples)
numEngineSamples := len(sink.Values)
assert.Equal(t, numEngineSamples, numOutputSamples)
}
}
}
func TestEngine_processSamples(t *testing.T) {
t.Parallel()
metric := stats.New("my_metric", stats.Gauge)
t.Run("metric", func(t *testing.T) {
t.Parallel()
e, _, wait := newTestEngine(t, nil, nil, nil, lib.Options{})
defer wait()
e.processSamples(
[]stats.SampleContainer{stats.Sample{Metric: metric, Value: 1.25, Tags: stats.IntoSampleTags(&map[string]string{"a": "1"})}},
)
assert.IsType(t, &stats.GaugeSink{}, e.Metrics["my_metric"].Sink)
})
t.Run("submetric", func(t *testing.T) {
t.Parallel()
ths := stats.NewThresholds([]string{`value<2`})
gotParseErr := ths.Parse()
require.NoError(t, gotParseErr)
e, _, wait := newTestEngine(t, nil, nil, nil, lib.Options{
Thresholds: map[string]stats.Thresholds{
"my_metric{a:1}": ths,
},
})
defer wait()
sms := e.submetrics["my_metric"]
assert.Len(t, sms, 1)
assert.Equal(t, "my_metric{a:1}", sms[0].Name)
assert.EqualValues(t, map[string]string{"a": "1"}, sms[0].Tags.CloneTags())
e.processSamples(
[]stats.SampleContainer{stats.Sample{Metric: metric, Value: 1.25, Tags: stats.IntoSampleTags(&map[string]string{"a": "1", "b": "2"})}},
)
assert.IsType(t, &stats.GaugeSink{}, e.Metrics["my_metric"].Sink)
assert.IsType(t, &stats.GaugeSink{}, e.Metrics["my_metric{a:1}"].Sink)
})
}
func TestEngineThresholdsWillAbort(t *testing.T) {
t.Parallel()
metric := stats.New("my_metric", stats.Gauge)
// The incoming samples for the metric set it to 1.25. Considering
// the metric is of type Gauge, value > 1.25 should always fail, and
// trigger an abort.
ths := stats.NewThresholds([]string{"value>1.25"})
gotParseErr := ths.Parse()
require.NoError(t, gotParseErr)
ths.Thresholds[0].AbortOnFail = true
thresholds := map[string]stats.Thresholds{metric.Name: ths}
e, _, wait := newTestEngine(t, nil, nil, nil, lib.Options{Thresholds: thresholds})
defer wait()
e.processSamples(
[]stats.SampleContainer{stats.Sample{Metric: metric, Value: 1.25, Tags: stats.IntoSampleTags(&map[string]string{"a": "1"})}},
)
assert.True(t, e.processThresholds())
}
func TestEngineAbortedByThresholds(t *testing.T) {
t.Parallel()
metric := stats.New("my_metric", stats.Gauge)
// The MiniRunner sets the value of the metric to 1.25. Considering
// the metric is of type Gauge, value > 1.25 should always fail, and
// trigger an abort.
// **N.B**: a threshold returning an error, won't trigger an abort.
ths := stats.NewThresholds([]string{"value>1.25"})
gotParseErr := ths.Parse()
require.NoError(t, gotParseErr)
ths.Thresholds[0].AbortOnFail = true
thresholds := map[string]stats.Thresholds{metric.Name: ths}
done := make(chan struct{})
runner := &minirunner.MiniRunner{
Fn: func(ctx context.Context, _ *lib.State, out chan<- stats.SampleContainer) error {
out <- stats.Sample{Metric: metric, Value: 1.25, Tags: stats.IntoSampleTags(&map[string]string{"a": "1"})}
<-ctx.Done()
close(done)
return nil
},
}
_, run, wait := newTestEngine(t, nil, runner, nil, lib.Options{Thresholds: thresholds})
defer wait()
go func() {
assert.NoError(t, run())
}()
select {
case <-done:
return
case <-time.After(10 * time.Second):
assert.Fail(t, "Test should have completed within 10 seconds")
}
}
func TestEngine_processThresholds(t *testing.T) {
t.Parallel()
metric := stats.New("my_metric", stats.Gauge)
testdata := map[string]struct {
pass bool
ths map[string][]string
abort bool
}{
"passing": {true, map[string][]string{"my_metric": {"value<2"}}, false},
"failing": {false, map[string][]string{"my_metric": {"value>1.25"}}, false},
"aborting": {false, map[string][]string{"my_metric": {"value>1.25"}}, true},
"submetric,match,passing": {true, map[string][]string{"my_metric{a:1}": {"value<2"}}, false},
"submetric,match,failing": {false, map[string][]string{"my_metric{a:1}": {"value>1.25"}}, false},
"submetric,nomatch,passing": {true, map[string][]string{"my_metric{a:2}": {"value<2"}}, false},
"submetric,nomatch,failing": {true, map[string][]string{"my_metric{a:2}": {"value>1.25"}}, false},
}
for name, data := range testdata {
name, data := name, data
t.Run(name, func(t *testing.T) {
t.Parallel()
thresholds := make(map[string]stats.Thresholds, len(data.ths))
for m, srcs := range data.ths {
ths := stats.NewThresholds(srcs)
gotParseErr := ths.Parse()
require.NoError(t, gotParseErr)
ths.Thresholds[0].AbortOnFail = data.abort
thresholds[m] = ths
}
e, _, wait := newTestEngine(t, nil, nil, nil, lib.Options{Thresholds: thresholds})
defer wait()
e.processSamples(
[]stats.SampleContainer{stats.Sample{Metric: metric, Value: 1.25, Tags: stats.IntoSampleTags(&map[string]string{"a": "1"})}},
)
assert.Equal(t, data.abort, e.processThresholds())
assert.Equal(t, data.pass, !e.IsTainted())
})
}
}
func getMetricSum(mo *mockoutput.MockOutput, name string) (result float64) {
for _, sc := range mo.SampleContainers {
for _, s := range sc.GetSamples() {
if s.Metric.Name == name {
result += s.Value
}
}
}
return
}
func getMetricCount(mo *mockoutput.MockOutput, name string) (result uint) {
for _, sc := range mo.SampleContainers {
for _, s := range sc.GetSamples() {
if s.Metric.Name == name {
result++
}
}
}
return
}
func getMetricMax(mo *mockoutput.MockOutput, name string) (result float64) {
for _, sc := range mo.SampleContainers {
for _, s := range sc.GetSamples() {
if s.Metric.Name == name && s.Value > result {
result = s.Value
}
}
}
return
}
const expectedHeaderMaxLength = 550
// FIXME: This test is too brittle, consider simplifying.
func TestSentReceivedMetrics(t *testing.T) {
t.Parallel()
tb := httpmultibin.NewHTTPMultiBin(t)
tr := tb.Replacer.Replace
type testScript struct {
Code string
NumRequests int64
ExpectedDataSent int64
ExpectedDataReceived int64
}
testScripts := []testScript{
{tr(`import http from "k6/http";
export default function() {
http.get("HTTPBIN_URL/bytes/15000");
}`), 1, 0, 15000},
// NOTE: This needs to be improved, in the case of HTTPS IN URL
// it's highly possible to meet the case when data received is out
// of in the possible interval
{tr(`import http from "k6/http";
export default function() {
http.get("HTTPBIN_URL/bytes/5000");
http.get("HTTPSBIN_URL/bytes/5000");
http.batch(["HTTPBIN_URL/bytes/10000", "HTTPBIN_URL/bytes/20000", "HTTPSBIN_URL/bytes/10000"]);
}`), 5, 0, 50000},
{tr(`import http from "k6/http";
let data = "0123456789".repeat(100);
export default function() {
http.post("HTTPBIN_URL/ip", {
file: http.file(data, "test.txt")
});
}`), 1, 1000, 100},
// NOTE(imiric): This needs to keep testing against /ws-echo-invalid because
// this test is highly sensitive to metric data, and slightly differing
// WS server implementations might introduce flakiness.
// See https://github.com/k6io/k6/pull/1149
{tr(`import ws from "k6/ws";
let data = "0123456789".repeat(100);
export default function() {
ws.connect("WSBIN_URL/ws-echo-invalid", null, function (socket) {
socket.on('open', function open() {
socket.send(data);
});
socket.on('message', function (message) {
socket.close();
});
});
}`), 2, 1000, 1000},
}
type testCase struct{ Iterations, VUs int64 }
testCases := []testCase{
{1, 1}, {2, 2}, {2, 1}, {5, 2}, {25, 2}, {50, 5},
}
runTest := func(t *testing.T, ts testScript, tc testCase, noConnReuse bool) (float64, float64) {
registry := metrics.NewRegistry()
builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
r, err := js.New(
testutils.NewLogger(t),
&loader.SourceData{URL: &url.URL{Path: "/script.js"}, Data: []byte(ts.Code)},
nil,
lib.RuntimeOptions{},
builtinMetrics,
registry,
)
require.NoError(t, err)
mockOutput := mockoutput.New()
_, run, wait := newTestEngine(t, nil, r, []output.Output{mockOutput}, lib.Options{
Iterations: null.IntFrom(tc.Iterations),
VUs: null.IntFrom(tc.VUs),
Hosts: tb.Dialer.Hosts,
InsecureSkipTLSVerify: null.BoolFrom(true),
NoVUConnectionReuse: null.BoolFrom(noConnReuse),
Batch: null.IntFrom(20),
})
errC := make(chan error)
go func() { errC <- run() }()
select {
case <-time.After(10 * time.Second):
t.Fatal("Test timed out")
case err := <-errC:
require.NoError(t, err)
}
wait()
checkData := func(name string, expected int64) float64 {
data := getMetricSum(mockOutput, name)
expectedDataMin := float64(expected * tc.Iterations)
expectedDataMax := float64((expected + ts.NumRequests*expectedHeaderMaxLength) * tc.Iterations)
if data < expectedDataMin || data > expectedDataMax {
t.Errorf(
"The %s sum should be in the interval [%f, %f] but was %f",
name, expectedDataMin, expectedDataMax, data,
)
}
return data
}
return checkData(metrics.DataSentName, ts.ExpectedDataSent),
checkData(metrics.DataReceivedName, ts.ExpectedDataReceived)
}
getTestCase := func(t *testing.T, ts testScript, tc testCase) func(t *testing.T) {
return func(t *testing.T) {
t.Parallel()
noReuseSent, noReuseReceived := runTest(t, ts, tc, true)
reuseSent, reuseReceived := runTest(t, ts, tc, false)
if noReuseSent < reuseSent {
t.Errorf("reuseSent=%f is greater than noReuseSent=%f", reuseSent, noReuseSent)
}
if noReuseReceived < reuseReceived {
t.Errorf("reuseReceived=%f is greater than noReuseReceived=%f", reuseReceived, noReuseReceived)
}
}
}
// This Run will not return until the parallel subtests complete.
t.Run("group", func(t *testing.T) {
t.Parallel()
for tsNum, ts := range testScripts {
for tcNum, tc := range testCases {
t.Run(
fmt.Sprintf("SentReceivedMetrics_script[%d]_case[%d](%d,%d)", tsNum, tcNum, tc.Iterations, tc.VUs),
getTestCase(t, ts, tc),
)
}
}
})
}
func TestRunTags(t *testing.T) {
t.Parallel()
tb := httpmultibin.NewHTTPMultiBin(t)
runTagsMap := map[string]string{"foo": "bar", "test": "mest", "over": "written"}
runTags := stats.NewSampleTags(runTagsMap)
script := []byte(tb.Replacer.Replace(`
import http from "k6/http";
import ws from "k6/ws";
import { Counter } from "k6/metrics";
import { group, check, fail } from "k6";
let customTags = { "over": "the rainbow" };
let params = { "tags": customTags};
let statusCheck = { "status is 200": (r) => r.status === 200 }
let myCounter = new Counter("mycounter");
export default function() {
group("http", function() {
check(http.get("HTTPSBIN_URL", params), statusCheck, customTags);
check(http.get("HTTPBIN_URL/status/418", params), statusCheck, customTags);
})
group("websockets", function() {
var response = ws.connect("WSBIN_URL/ws-echo", params, function (socket) {
socket.on('open', function open() {
console.log('ws open and say hello');
socket.send("hello");
});
socket.on('message', function (message) {
console.log('ws got message ' + message);
if (message != "hello") {
fail("Expected to receive 'hello' but got '" + message + "' instead !");
}
console.log('ws closing socket...');
socket.close();
});
socket.on('close', function () {
console.log('ws close');
});
socket.on('error', function (e) {
console.log('ws error: ' + e.error());
});
});
console.log('connect returned');
check(response, { "status is 101": (r) => r && r.status === 101 }, customTags);
})
myCounter.add(1, customTags);
}
`))
registry := metrics.NewRegistry()
builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
r, err := js.New(
testutils.NewLogger(t),
&loader.SourceData{URL: &url.URL{Path: "/script.js"}, Data: script},
nil,
lib.RuntimeOptions{},
builtinMetrics,
registry,
)
require.NoError(t, err)
mockOutput := mockoutput.New()
_, run, wait := newTestEngine(t, nil, r, []output.Output{mockOutput}, lib.Options{
Iterations: null.IntFrom(3),
VUs: null.IntFrom(2),
Hosts: tb.Dialer.Hosts,
RunTags: runTags,
SystemTags: &stats.DefaultSystemTagSet,
InsecureSkipTLSVerify: null.BoolFrom(true),
})
errC := make(chan error)
go func() { errC <- run() }()
select {
case <-time.After(10 * time.Second):
t.Fatal("Test timed out")
case err := <-errC:
require.NoError(t, err)
}
wait()
systemMetrics := []string{
metrics.VUsName, metrics.VUsMaxName, metrics.IterationsName, metrics.IterationDurationName,
metrics.GroupDurationName, metrics.DataSentName, metrics.DataReceivedName,
}
getExpectedOverVal := func(metricName string) string {
for _, sysMetric := range systemMetrics {
if sysMetric == metricName {
return runTagsMap["over"]
}
}
return "the rainbow"
}
for _, s := range mockOutput.Samples {
for key, expVal := range runTagsMap {
val, ok := s.Tags.Get(key)
if key == "over" {
expVal = getExpectedOverVal(s.Metric.Name)
}
assert.True(t, ok)
assert.Equalf(t, expVal, val, "Wrong tag value in sample for metric %#v", s.Metric)
}
}
}
func TestSetupTeardownThresholds(t *testing.T) {
t.Parallel()
tb := httpmultibin.NewHTTPMultiBin(t)
script := []byte(tb.Replacer.Replace(`
import http from "k6/http";
import { check } from "k6";
import { Counter } from "k6/metrics";
let statusCheck = { "status is 200": (r) => r.status === 200 }
let myCounter = new Counter("setup_teardown");
export let options = {
iterations: 5,
thresholds: {
"setup_teardown": ["count == 2"],
"iterations": ["count == 5"],
"http_reqs": ["count == 7"],
},
};
export function setup() {
check(http.get("HTTPBIN_IP_URL"), statusCheck) && myCounter.add(1);
};
export default function () {
check(http.get("HTTPBIN_IP_URL"), statusCheck);
};
export function teardown() {
check(http.get("HTTPBIN_IP_URL"), statusCheck) && myCounter.add(1);
};
`))
registry := metrics.NewRegistry()
builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
runner, err := js.New(
testutils.NewLogger(t),
&loader.SourceData{URL: &url.URL{Path: "/script.js"}, Data: script},
nil,
lib.RuntimeOptions{},
builtinMetrics,
registry,
)
require.NoError(t, err)
engine, run, wait := newTestEngine(t, nil, runner, nil, lib.Options{
SystemTags: &stats.DefaultSystemTagSet,
SetupTimeout: types.NullDurationFrom(3 * time.Second),
TeardownTimeout: types.NullDurationFrom(3 * time.Second),
VUs: null.IntFrom(3),
})
defer wait()
errC := make(chan error)
go func() { errC <- run() }()
select {
case <-time.After(10 * time.Second):
t.Fatal("Test timed out")
case err := <-errC:
require.NoError(t, err)
require.False(t, engine.IsTainted())
}
}
func TestSetupException(t *testing.T) {
t.Parallel()
script := []byte(`
import bar from "./bar.js";
export function setup() {
bar();
};
export default function() {
};
`)
memfs := afero.NewMemMapFs()
require.NoError(t, afero.WriteFile(memfs, "/bar.js", []byte(`
export default function () {
baz();
}
function baz() {
throw new Error("baz");
}
`), 0x666))
registry := metrics.NewRegistry()
builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
runner, err := js.New(
testutils.NewLogger(t),
&loader.SourceData{URL: &url.URL{Scheme: "file", Path: "/script.js"}, Data: script},
map[string]afero.Fs{"file": memfs},
lib.RuntimeOptions{},
builtinMetrics,
registry,
)
require.NoError(t, err)
_, run, wait := newTestEngine(t, nil, runner, nil, lib.Options{
SystemTags: &stats.DefaultSystemTagSet,
SetupTimeout: types.NullDurationFrom(3 * time.Second),
TeardownTimeout: types.NullDurationFrom(3 * time.Second),
VUs: null.IntFrom(3),
})
defer wait()
errC := make(chan error)
go func() { errC <- run() }()
select {
case <-time.After(10 * time.Second):
t.Fatal("Test timed out")
case err := <-errC:
require.Error(t, err)
var exception errext.Exception
require.ErrorAs(t, err, &exception)
require.Equal(t, "Error: baz\n\tat baz (file:///bar.js:6:16(3))\n"+
"\tat file:///bar.js:3:8(3)\n\tat setup (file:///script.js:4:2(4))\n\tat native\n",
err.Error())
}
}
func TestVuInitException(t *testing.T) {
t.Parallel()
script := []byte(`
export let options = {
vus: 3,
iterations: 5,
};
export default function() {};
if (__VU == 2) {
throw new Error('oops in ' + __VU);
}
`)
logger := testutils.NewLogger(t)
registry := metrics.NewRegistry()
builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
runner, err := js.New(
logger,
&loader.SourceData{URL: &url.URL{Scheme: "file", Path: "/script.js"}, Data: script},
nil, lib.RuntimeOptions{},
builtinMetrics,
registry,
)
require.NoError(t, err)
opts, err := executor.DeriveScenariosFromShortcuts(runner.GetOptions(), nil)
require.NoError(t, err)
require.Empty(t, opts.Validate())
require.NoError(t, runner.SetOptions(opts))
execScheduler, err := local.NewExecutionScheduler(runner, logger)
require.NoError(t, err)
engine, err := NewEngine(execScheduler, opts, lib.RuntimeOptions{}, nil, logger, builtinMetrics)
require.NoError(t, err)
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
_, _, err = engine.Init(ctx, ctx) // no need for 2 different contexts
require.Error(t, err)
var exception errext.Exception
require.ErrorAs(t, err, &exception)
assert.Equal(t, "Error: oops in 2\n\tat file:///script.js:10:9(31)\n", err.Error())
var errWithHint errext.HasHint
require.ErrorAs(t, err, &errWithHint)
assert.Equal(t, "error while initializing VU #2 (script exception)", errWithHint.Hint())
}
func TestEmittedMetricsWhenScalingDown(t *testing.T) {
t.Parallel()
tb := httpmultibin.NewHTTPMultiBin(t)
script := []byte(tb.Replacer.Replace(`
import http from "k6/http";
import { sleep } from "k6";
export let options = {
systemTags: ["iter", "vu", "url"],
scenarios: {
we_need_hard_stop_and_ramp_down: {
executor: "ramping-vus",
// Start with 2 VUs for 4 seconds and then quickly scale down to 1 for the next 4s and then quit
startVUs: 2,
stages: [
{ duration: "4s", target: 2 },
{ duration: "0s", target: 1 },
{ duration: "4s", target: 1 },
],
gracefulStop: "0s",
gracefulRampDown: "0s",
},
},
};
export default function () {
console.log("VU " + __VU + " starting iteration #" + __ITER);
http.get("HTTPBIN_IP_URL/bytes/15000");
sleep(3.1);
http.get("HTTPBIN_IP_URL/bytes/15000");
console.log("VU " + __VU + " ending iteration #" + __ITER);
};
`))
registry := metrics.NewRegistry()
builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
runner, err := js.New(
testutils.NewLogger(t),
&loader.SourceData{URL: &url.URL{Path: "/script.js"}, Data: script},
nil,
lib.RuntimeOptions{},
builtinMetrics,
registry,
)
require.NoError(t, err)
mockOutput := mockoutput.New()
engine, run, wait := newTestEngine(t, nil, runner, []output.Output{mockOutput}, lib.Options{})
errC := make(chan error)
go func() { errC <- run() }()
select {
case <-time.After(12 * time.Second):
t.Fatal("Test timed out")
case err := <-errC:
require.NoError(t, err)
wait()
require.False(t, engine.IsTainted())
}
// The 3.1 sleep in the default function would cause the first VU to complete 2 full iterations
// and stat executing its third one, while the second VU will only fully complete 1 iteration
// and will be canceled in the middle of its second one.
assert.Equal(t, 3.0, getMetricSum(mockOutput, metrics.IterationsName))
// That means that we expect to see 8 HTTP requests in total, 3*2=6 from the complete iterations
// and one each from the two iterations that would be canceled in the middle of their execution
assert.Equal(t, 8.0, getMetricSum(mockOutput, metrics.HTTPReqsName))
// And we expect to see the data_received for all 8 of those requests. Previously, the data for
// the 8th request (the 3rd one in the first VU before the test ends) was cut off by the engine
// because it was emitted after the test officially ended. But that was mostly an unintended
// consequence of the fact that those metrics were emitted only after an iteration ended when
// it was interrupted.
dataReceivedExpectedMin := 15000.0 * 8
dataReceivedExpectedMax := (15000.0 + expectedHeaderMaxLength) * 8
dataReceivedActual := getMetricSum(mockOutput, metrics.DataReceivedName)
if dataReceivedActual < dataReceivedExpectedMin || dataReceivedActual > dataReceivedExpectedMax {
t.Errorf(
"The data_received sum should be in the interval [%f, %f] but was %f",
dataReceivedExpectedMin, dataReceivedExpectedMax, dataReceivedActual,
)
}
// Also, the interrupted iterations shouldn't affect the average iteration_duration in any way, only
// complete iterations should be taken into account
durationCount := float64(getMetricCount(mockOutput, metrics.IterationDurationName))
assert.Equal(t, 3.0, durationCount)
durationSum := getMetricSum(mockOutput, metrics.IterationDurationName)
assert.InDelta(t, 3.35, durationSum/(1000*durationCount), 0.25)
}
func TestMetricsEmission(t *testing.T) {
if !isWindows {
t.Parallel()
}
testCases := []struct {
method string
minIterDuration string
defaultBody string
expCount, expIters float64
}{
// Since emission of Iterations happens before the minIterationDuration
// sleep is done, we expect to receive metrics for all executions of
// the `default` function, despite of the lower overall duration setting.
{"minIterationDuration", `"300ms"`, "testCounter.add(1);", 16.0, 16.0},
// With the manual sleep method and no minIterationDuration, the last
// `default` execution will be cutoff by the duration setting, so only
// 3 sets of metrics are expected.
{"sleepBeforeCounterAdd", "null", "sleep(0.3); testCounter.add(1); ", 12.0, 12.0},
// The counter should be sent, but the last iteration will be incomplete
{"sleepAfterCounterAdd", "null", "testCounter.add(1); sleep(0.3); ", 16.0, 12.0},
}
for _, tc := range testCases {
tc := tc
t.Run(tc.method, func(t *testing.T) {
if !isWindows {
t.Parallel()
}
registry := metrics.NewRegistry()
builtinMetrics := metrics.RegisterBuiltinMetrics(registry)
runner, err := js.New(
testutils.NewLogger(t),
&loader.SourceData{URL: &url.URL{Path: "/script.js"}, Data: []byte(fmt.Sprintf(`
import { sleep } from "k6";
import { Counter } from "k6/metrics";
let testCounter = new Counter("testcounter");
export let options = {
scenarios: {