/
cltest.go
1575 lines (1345 loc) · 50.3 KB
/
cltest.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
package cltest
import (
"bytes"
"context"
crand "crypto/rand"
"encoding/json"
"errors"
"fmt"
"io"
"math/big"
"math/rand"
"net/http"
"net/http/httptest"
"net/url"
"os"
"reflect"
"testing"
"time"
"github.com/ethereum/go-ethereum/accounts/abi/bind/backends"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/types"
"github.com/ethereum/go-ethereum/rpc"
"github.com/gin-gonic/gin"
"github.com/google/uuid"
"github.com/gorilla/securecookie"
"github.com/gorilla/sessions"
"github.com/manyminds/api2go/jsonapi"
"github.com/onsi/gomega"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
"github.com/tidwall/gjson"
"github.com/jmoiron/sqlx"
ocrtypes "github.com/smartcontractkit/libocr/offchainreporting/types"
"github.com/smartcontractkit/chainlink-common/pkg/loop"
"github.com/smartcontractkit/chainlink-common/pkg/utils/mailbox"
"github.com/smartcontractkit/chainlink/v2/common/client"
commonmocks "github.com/smartcontractkit/chainlink/v2/common/types/mocks"
"github.com/smartcontractkit/chainlink/v2/core/auth"
"github.com/smartcontractkit/chainlink/v2/core/bridges"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/assets"
evmclient "github.com/smartcontractkit/chainlink/v2/core/chains/evm/client"
evmclimocks "github.com/smartcontractkit/chainlink/v2/core/chains/evm/client/mocks"
evmconfig "github.com/smartcontractkit/chainlink/v2/core/chains/evm/config"
httypes "github.com/smartcontractkit/chainlink/v2/core/chains/evm/headtracker/types"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/txmgr"
evmtypes "github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"
evmutils "github.com/smartcontractkit/chainlink/v2/core/chains/evm/utils"
ubig "github.com/smartcontractkit/chainlink/v2/core/chains/evm/utils/big"
"github.com/smartcontractkit/chainlink/v2/core/chains/legacyevm"
"github.com/smartcontractkit/chainlink/v2/core/cmd"
"github.com/smartcontractkit/chainlink/v2/core/internal/testutils"
"github.com/smartcontractkit/chainlink/v2/core/internal/testutils/configtest"
"github.com/smartcontractkit/chainlink/v2/core/internal/testutils/evmtest"
clhttptest "github.com/smartcontractkit/chainlink/v2/core/internal/testutils/httptest"
"github.com/smartcontractkit/chainlink/v2/core/internal/testutils/keystest"
"github.com/smartcontractkit/chainlink/v2/core/logger"
"github.com/smartcontractkit/chainlink/v2/core/logger/audit"
"github.com/smartcontractkit/chainlink/v2/core/services/chainlink"
"github.com/smartcontractkit/chainlink/v2/core/services/job"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/cosmoskey"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/csakey"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/dkgencryptkey"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/dkgsignkey"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/ethkey"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/ocr2key"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/ocrkey"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/p2pkey"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/solkey"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/starkkey"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/vrfkey"
"github.com/smartcontractkit/chainlink/v2/core/services/pg"
"github.com/smartcontractkit/chainlink/v2/core/services/pipeline"
"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/wsrpc"
"github.com/smartcontractkit/chainlink/v2/core/services/relay/evm/mercury/wsrpc/cache"
"github.com/smartcontractkit/chainlink/v2/core/services/webhook"
clsessions "github.com/smartcontractkit/chainlink/v2/core/sessions"
"github.com/smartcontractkit/chainlink/v2/core/static"
"github.com/smartcontractkit/chainlink/v2/core/store/models"
"github.com/smartcontractkit/chainlink/v2/core/utils"
"github.com/smartcontractkit/chainlink/v2/core/web"
webauth "github.com/smartcontractkit/chainlink/v2/core/web/auth"
webpresenters "github.com/smartcontractkit/chainlink/v2/core/web/presenters"
"github.com/smartcontractkit/chainlink/v2/plugins"
// Force import of pgtest to ensure that txdb is registered as a DB driver
_ "github.com/smartcontractkit/chainlink/v2/core/internal/testutils/pgtest"
)
const (
// Collection of test fixture DB user emails per role
APIEmailAdmin = "apiuser@chainlink.test"
APIEmailEdit = "apiuser-edit@chainlink.test"
APIEmailRun = "apiuser-run@chainlink.test"
APIEmailViewOnly = "apiuser-view-only@chainlink.test"
// Password just a password we use everywhere for testing
Password = testutils.Password
// SessionSecret is the hardcoded secret solely used for test
SessionSecret = "clsession_test_secret"
// DefaultPeerID is the peer ID of the default p2p key
DefaultPeerID = configtest.DefaultPeerID
// DefaultOCRKeyBundleID is the ID of the default ocr key bundle
DefaultOCRKeyBundleID = "f5bf259689b26f1374efb3c9a9868796953a0f814bb2d39b968d0e61b58620a5"
// DefaultOCR2KeyBundleID is the ID of the fixture ocr2 key bundle
DefaultOCR2KeyBundleID = "92be59c45d0d7b192ef88d391f444ea7c78644f8607f567aab11d53668c27a4d"
// Private key seed of test keys created with `big.NewInt(1)`, representations of value present in `scrub_logs` script
KeyBigIntSeed = 1
)
var (
DefaultP2PPeerID p2pkey.PeerID
FixtureChainID = *testutils.FixtureChainID
DefaultCosmosKey = cosmoskey.MustNewInsecure(keystest.NewRandReaderFromSeed(KeyBigIntSeed))
DefaultCSAKey = csakey.MustNewV2XXXTestingOnly(big.NewInt(KeyBigIntSeed))
DefaultOCRKey = ocrkey.MustNewV2XXXTestingOnly(big.NewInt(KeyBigIntSeed))
DefaultOCR2Key = ocr2key.MustNewInsecure(keystest.NewRandReaderFromSeed(KeyBigIntSeed), "evm")
DefaultP2PKey = p2pkey.MustNewV2XXXTestingOnly(big.NewInt(KeyBigIntSeed))
DefaultSolanaKey = solkey.MustNewInsecure(keystest.NewRandReaderFromSeed(KeyBigIntSeed))
DefaultStarkNetKey = starkkey.MustNewInsecure(keystest.NewRandReaderFromSeed(KeyBigIntSeed))
DefaultVRFKey = vrfkey.MustNewV2XXXTestingOnly(big.NewInt(KeyBigIntSeed))
DefaultDKGSignKey = dkgsignkey.MustNewXXXTestingOnly(big.NewInt(KeyBigIntSeed))
DefaultDKGEncryptKey = dkgencryptkey.MustNewXXXTestingOnly(big.NewInt(KeyBigIntSeed))
)
func init() {
gin.SetMode(gin.TestMode)
gomega.SetDefaultEventuallyTimeout(testutils.DefaultWaitTimeout)
gomega.SetDefaultEventuallyPollingInterval(DBPollingInterval)
gomega.SetDefaultConsistentlyDuration(time.Second)
gomega.SetDefaultConsistentlyPollingInterval(100 * time.Millisecond)
logger.InitColor(true)
gin.DebugPrintRouteFunc = func(httpMethod, absolutePath, handlerName string, nuHandlers int) {
fmt.Printf("[gin] %-6s %-25s --> %s (%d handlers)\n", httpMethod, absolutePath, handlerName, nuHandlers)
}
err := DefaultP2PPeerID.UnmarshalString(configtest.DefaultPeerID)
if err != nil {
panic(err)
}
}
func NewRandomPositiveInt64() int64 {
id := rand.Int63()
return id
}
func MustRandomBytes(t *testing.T, l int) (b []byte) {
t.Helper()
b = make([]byte, l)
_, err := crand.Read(b)
if err != nil {
t.Fatal(err)
}
return b
}
func FormatWithPrefixedChainID(chainID, id string) string {
return fmt.Sprintf("%s/%s", chainID, id)
}
type JobPipelineV2TestHelper struct {
Prm pipeline.ORM
Jrm job.ORM
Pr pipeline.Runner
}
type JobPipelineConfig interface {
pipeline.Config
MaxSuccessfulRuns() uint64
}
func NewJobPipelineV2(t testing.TB, cfg pipeline.BridgeConfig, jpcfg JobPipelineConfig, dbCfg pg.QConfig, legacyChains legacyevm.LegacyChainContainer, db *sqlx.DB, keyStore keystore.Master, restrictedHTTPClient, unrestrictedHTTPClient *http.Client) JobPipelineV2TestHelper {
lggr := logger.TestLogger(t)
prm := pipeline.NewORM(db, lggr, dbCfg, jpcfg.MaxSuccessfulRuns())
btORM := bridges.NewORM(db, lggr, dbCfg)
jrm := job.NewORM(db, prm, btORM, keyStore, lggr, dbCfg)
pr := pipeline.NewRunner(prm, btORM, jpcfg, cfg, legacyChains, keyStore.Eth(), keyStore.VRF(), lggr, restrictedHTTPClient, unrestrictedHTTPClient)
return JobPipelineV2TestHelper{
prm,
jrm,
pr,
}
}
// TestApplication holds the test application and test servers
type TestApplication struct {
t testing.TB
*chainlink.ChainlinkApplication
Logger logger.Logger
Server *httptest.Server
Started bool
Backend *backends.SimulatedBackend
Keys []ethkey.KeyV2
}
// NewApplicationEVMDisabled creates a new application with default config but EVM disabled
// Useful for testing controllers
func NewApplicationEVMDisabled(t *testing.T) *TestApplication {
t.Helper()
c := configtest.NewGeneralConfig(t, nil)
return NewApplicationWithConfig(t, c)
}
// NewApplication creates a New TestApplication along with a NewConfig
// It mocks the keystore with no keys or accounts by default
func NewApplication(t testing.TB, flagsAndDeps ...interface{}) *TestApplication {
t.Helper()
c := configtest.NewGeneralConfig(t, nil)
return NewApplicationWithConfig(t, c, flagsAndDeps...)
}
// NewApplicationWithKey creates a new TestApplication along with a new config
// It uses the native keystore and will load any keys that are in the database
func NewApplicationWithKey(t *testing.T, flagsAndDeps ...interface{}) *TestApplication {
t.Helper()
config := configtest.NewGeneralConfig(t, nil)
return NewApplicationWithConfigAndKey(t, config, flagsAndDeps...)
}
// NewApplicationWithConfigAndKey creates a new TestApplication with the given testorm
// it will also provide an unlocked account on the keystore
func NewApplicationWithConfigAndKey(t testing.TB, c chainlink.GeneralConfig, flagsAndDeps ...interface{}) *TestApplication {
ctx := testutils.Context(t)
app := NewApplicationWithConfig(t, c, flagsAndDeps...)
chainID := *ubig.New(&FixtureChainID)
for _, dep := range flagsAndDeps {
switch v := dep.(type) {
case *ubig.Big:
chainID = *v
}
}
if len(app.Keys) == 0 {
k, _ := MustInsertRandomKey(t, app.KeyStore.Eth(), chainID)
app.Keys = []ethkey.KeyV2{k}
} else {
id, ks := chainID.ToInt(), app.KeyStore.Eth()
for _, k := range app.Keys {
ks.XXXTestingOnlyAdd(ctx, k)
require.NoError(t, ks.Add(ctx, k.Address, id))
require.NoError(t, ks.Enable(ctx, k.Address, id))
}
}
return app
}
func setKeys(t testing.TB, app *TestApplication, flagsAndDeps ...interface{}) (chainID ubig.Big) {
require.NoError(t, app.KeyStore.Unlock(Password))
for _, dep := range flagsAndDeps {
switch v := dep.(type) {
case ethkey.KeyV2:
app.Keys = append(app.Keys, v)
case p2pkey.KeyV2:
require.NoError(t, app.GetKeyStore().P2P().Add(v))
case csakey.KeyV2:
require.NoError(t, app.GetKeyStore().CSA().Add(v))
case ocr2key.KeyBundle:
require.NoError(t, app.GetKeyStore().OCR2().Add(v))
}
}
return
}
const (
UseRealExternalInitiatorManager = "UseRealExternalInitiatorManager"
)
// NewApplicationWithConfig creates a New TestApplication with specified test config.
// This should only be used in full integration tests. For controller tests, see NewApplicationEVMDisabled.
func NewApplicationWithConfig(t testing.TB, cfg chainlink.GeneralConfig, flagsAndDeps ...interface{}) *TestApplication {
t.Helper()
testutils.SkipShortDB(t)
var lggr logger.Logger
for _, dep := range flagsAndDeps {
argLggr, is := dep.(logger.Logger)
if is {
lggr = argLggr
break
}
}
if lggr == nil {
lggr = logger.TestLogger(t)
}
var auditLogger audit.AuditLogger
for _, dep := range flagsAndDeps {
audLgger, is := dep.(audit.AuditLogger)
if is {
auditLogger = audLgger
break
}
}
if auditLogger == nil {
auditLogger = audit.NoopLogger
}
url := cfg.Database().URL()
db, err := pg.NewConnection(url.String(), cfg.Database().Dialect(), cfg.Database())
require.NoError(t, err)
t.Cleanup(func() { assert.NoError(t, db.Close()) })
var ethClient evmclient.Client
var externalInitiatorManager webhook.ExternalInitiatorManager
externalInitiatorManager = &webhook.NullExternalInitiatorManager{}
var useRealExternalInitiatorManager bool
for _, flag := range flagsAndDeps {
switch dep := flag.(type) {
case evmclient.Client:
ethClient = dep
case webhook.ExternalInitiatorManager:
externalInitiatorManager = dep
default:
switch flag {
case UseRealExternalInitiatorManager:
externalInitiatorManager = webhook.NewExternalInitiatorManager(db, clhttptest.NewTestLocalOnlyHTTPClient(), lggr, cfg.Database())
}
}
}
keyStore := keystore.NewInMemory(db, utils.FastScryptParams, lggr, cfg.Database())
mailMon := mailbox.NewMonitor(cfg.AppID().String(), lggr.Named("Mailbox"))
loopRegistry := plugins.NewLoopRegistry(lggr, nil)
mercuryPool := wsrpc.NewPool(lggr, cache.Config{
LatestReportTTL: cfg.Mercury().Cache().LatestReportTTL(),
MaxStaleAge: cfg.Mercury().Cache().MaxStaleAge(),
LatestReportDeadline: cfg.Mercury().Cache().LatestReportDeadline(),
})
relayerFactory := chainlink.RelayerFactory{
Logger: lggr,
LoopRegistry: loopRegistry,
GRPCOpts: loop.GRPCOpts{},
MercuryPool: mercuryPool,
}
evmOpts := chainlink.EVMFactoryConfig{
ChainOpts: legacyevm.ChainOpts{
AppConfig: cfg,
MailMon: mailMon,
DB: db,
},
CSAETHKeystore: keyStore,
}
if cfg.EVMEnabled() {
if ethClient == nil {
ethClient = evmclient.NewNullClient(evmtest.MustGetDefaultChainID(t, cfg.EVMConfigs()), lggr)
}
chainId := ethClient.ConfiguredChainID()
evmOpts.GenEthClient = func(_ *big.Int) evmclient.Client {
if chainId.Cmp(evmtest.MustGetDefaultChainID(t, cfg.EVMConfigs())) != 0 {
t.Fatalf("expected eth client ChainID %d to match evm config chain id %d", chainId, evmtest.MustGetDefaultChainID(t, cfg.EVMConfigs()))
}
return ethClient
}
}
testCtx := testutils.Context(t)
// evm alway enabled for backward compatibility
initOps := []chainlink.CoreRelayerChainInitFunc{chainlink.InitEVM(testCtx, relayerFactory, evmOpts)}
if cfg.CosmosEnabled() {
cosmosCfg := chainlink.CosmosFactoryConfig{
Keystore: keyStore.Cosmos(),
TOMLConfigs: cfg.CosmosConfigs(),
DB: db,
QConfig: cfg.Database(),
}
initOps = append(initOps, chainlink.InitCosmos(testCtx, relayerFactory, cosmosCfg))
}
if cfg.SolanaEnabled() {
solanaCfg := chainlink.SolanaFactoryConfig{
Keystore: keyStore.Solana(),
TOMLConfigs: cfg.SolanaConfigs(),
}
initOps = append(initOps, chainlink.InitSolana(testCtx, relayerFactory, solanaCfg))
}
if cfg.StarkNetEnabled() {
starkCfg := chainlink.StarkNetFactoryConfig{
Keystore: keyStore.StarkNet(),
TOMLConfigs: cfg.StarknetConfigs(),
}
initOps = append(initOps, chainlink.InitStarknet(testCtx, relayerFactory, starkCfg))
}
relayChainInterops, err := chainlink.NewCoreRelayerChainInteroperators(initOps...)
if err != nil {
t.Fatal(err)
}
c := clhttptest.NewTestLocalOnlyHTTPClient()
appInstance, err := chainlink.NewApplication(chainlink.ApplicationOpts{
Config: cfg,
MailMon: mailMon,
SqlxDB: db,
KeyStore: keyStore,
RelayerChainInteroperators: relayChainInterops,
Logger: lggr,
AuditLogger: auditLogger,
CloseLogger: lggr.Sync,
ExternalInitiatorManager: externalInitiatorManager,
RestrictedHTTPClient: c,
UnrestrictedHTTPClient: c,
SecretGenerator: MockSecretGenerator{},
LoopRegistry: plugins.NewLoopRegistry(lggr, nil),
MercuryPool: mercuryPool,
})
require.NoError(t, err)
app := appInstance.(*chainlink.ChainlinkApplication)
ta := &TestApplication{
t: t,
ChainlinkApplication: app,
Logger: lggr,
}
srvr := httptest.NewUnstartedServer(web.Router(t, app, nil))
srvr.Config.WriteTimeout = cfg.WebServer().HTTPWriteTimeout()
srvr.Start()
ta.Server = srvr
if !useRealExternalInitiatorManager {
app.ExternalInitiatorManager = externalInitiatorManager
}
setKeys(t, ta, flagsAndDeps...)
return ta
}
func NewEthMocksWithDefaultChain(t testing.TB) (c *evmclimocks.Client) {
testutils.SkipShortDB(t)
c = NewEthMocks(t)
c.On("ConfiguredChainID").Return(&FixtureChainID).Maybe()
return
}
func NewEthMocks(t testing.TB) *evmclimocks.Client {
return evmclimocks.NewClient(t)
}
func NewEthMocksWithStartupAssertions(t testing.TB) *evmclimocks.Client {
testutils.SkipShort(t, "long test")
c := NewEthMocks(t)
c.On("Dial", mock.Anything).Maybe().Return(nil)
c.On("SubscribeNewHead", mock.Anything, mock.Anything).Maybe().Return(EmptyMockSubscription(t), nil)
c.On("SendTransaction", mock.Anything, mock.Anything).Maybe().Return(nil)
c.On("HeadByNumber", mock.Anything, (*big.Int)(nil)).Maybe().Return(Head(0), nil)
c.On("ConfiguredChainID").Maybe().Return(&FixtureChainID)
c.On("CallContract", mock.Anything, mock.Anything, mock.Anything).Maybe().Return([]byte{}, nil)
c.On("SubscribeFilterLogs", mock.Anything, mock.Anything, mock.Anything).Maybe().Return(nil, errors.New("mocked"))
c.On("CodeAt", mock.Anything, mock.Anything, mock.Anything).Maybe().Return([]byte{}, nil)
c.On("Close").Maybe().Return()
block := &types.Header{
Number: big.NewInt(100),
}
c.On("HeaderByNumber", mock.Anything, mock.Anything).Maybe().Return(block, nil)
return c
}
// NewEthMocksWithTransactionsOnBlocksAssertions sets an Eth mock with transactions on blocks
func NewEthMocksWithTransactionsOnBlocksAssertions(t testing.TB) *evmclimocks.Client {
testutils.SkipShort(t, "long test")
c := NewEthMocks(t)
c.On("Dial", mock.Anything).Maybe().Return(nil)
c.On("SubscribeNewHead", mock.Anything, mock.Anything).Maybe().Return(EmptyMockSubscription(t), nil)
c.On("SendTransaction", mock.Anything, mock.Anything).Maybe().Return(nil)
c.On("SendTransactionReturnCode", mock.Anything, mock.Anything, mock.Anything).Maybe().Return(client.Successful, nil)
// Construct chain
h2 := Head(2)
h1 := HeadWithHash(1, h2.ParentHash)
h0 := HeadWithHash(0, h1.ParentHash)
c.On("HeadByNumber", mock.Anything, (*big.Int)(nil)).Maybe().Return(h2, nil)
c.On("HeadByHash", mock.Anything, h1.Hash).Maybe().Return(h1, nil)
c.On("HeadByHash", mock.Anything, h0.Hash).Maybe().Return(h0, nil)
c.On("BatchCallContext", mock.Anything, mock.Anything).Maybe().Return(nil).Run(func(args mock.Arguments) {
elems := args.Get(1).([]rpc.BatchElem)
if len(elems) > 0 {
elems[0].Result = &evmtypes.Block{
Number: 42,
Hash: evmutils.NewHash(),
Transactions: LegacyTransactionsFromGasPrices(9001, 9002),
}
}
if len(elems) > 1 {
elems[1].Result = &evmtypes.Block{
Number: 41,
Hash: evmutils.NewHash(),
Transactions: LegacyTransactionsFromGasPrices(9003, 9004),
}
}
})
c.On("ConfiguredChainID").Maybe().Return(&FixtureChainID)
c.On("Close").Maybe().Return()
block := &types.Header{
Number: big.NewInt(100),
}
c.On("HeaderByHash", mock.Anything, mock.Anything).Maybe().Return(block, nil)
return c
}
// Start starts the chainlink app and registers Stop to clean up at end of test.
func (ta *TestApplication) Start(ctx context.Context) error {
ta.t.Helper()
ta.Started = true
err := ta.ChainlinkApplication.KeyStore.Unlock(Password)
if err != nil {
return err
}
err = ta.ChainlinkApplication.Start(ctx)
if err != nil {
return err
}
ta.t.Cleanup(func() { require.NoError(ta.t, ta.Stop()) })
return nil
}
// Stop will stop the test application and perform cleanup
func (ta *TestApplication) Stop() error {
ta.t.Helper()
if !ta.Started {
ta.t.Fatal("TestApplication Stop() called on an unstarted application")
}
// TODO: Here we double close, which is less than ideal.
// We would prefer to invoke a method on an interface that
// cleans up only in test.
// FIXME: TestApplication probably needs to simply be removed
err := ta.ChainlinkApplication.StopIfStarted()
if ta.Server != nil {
ta.Server.Close()
}
return err
}
func (ta *TestApplication) MustSeedNewSession(email string) (id string) {
session := NewSession()
ta.Logger.Infof("TestApplication creating session (id: %s, email: %s, last used: %s)", session.ID, email, session.LastUsed.String())
err := ta.GetSqlxDB().Get(&id, `INSERT INTO sessions (id, email, last_used, created_at) VALUES ($1, $2, $3, NOW()) RETURNING id`, session.ID, email, session.LastUsed)
require.NoError(ta.t, err)
return id
}
// ImportKey adds private key to the application keystore and database
func (ta *TestApplication) Import(ctx context.Context, content string) {
require.NoError(ta.t, ta.KeyStore.Unlock(Password))
_, err := ta.KeyStore.Eth().Import(ctx, []byte(content), Password, &FixtureChainID)
require.NoError(ta.t, err)
}
type User struct {
Email string
Role clsessions.UserRole
}
func (ta *TestApplication) NewHTTPClient(user *User) HTTPClientCleaner {
ta.t.Helper()
if user == nil {
user = &User{}
}
if user.Email == "" {
user.Email = fmt.Sprintf("%s@chainlink.test", uuid.New())
}
if user.Role == "" {
user.Role = clsessions.UserRoleAdmin
}
u, err := clsessions.NewUser(user.Email, Password, user.Role)
require.NoError(ta.t, err)
err = ta.BasicAdminUsersORM().CreateUser(&u)
require.NoError(ta.t, err)
sessionID := ta.MustSeedNewSession(user.Email)
return HTTPClientCleaner{
HTTPClient: NewMockAuthenticatedHTTPClient(ta.Logger, ta.NewClientOpts(), sessionID),
t: ta.t,
}
}
func (ta *TestApplication) NewClientOpts() cmd.ClientOpts {
return cmd.ClientOpts{RemoteNodeURL: *MustParseURL(ta.t, ta.Server.URL), InsecureSkipVerify: true}
}
// NewShellAndRenderer creates a new cmd.Shell for the test application
func (ta *TestApplication) NewShellAndRenderer() (*cmd.Shell, *RendererMock) {
hc := ta.NewHTTPClient(nil)
r := &RendererMock{}
lggr := logger.TestLogger(ta.t)
client := &cmd.Shell{
Renderer: r,
Config: ta.GetConfig(),
Logger: lggr,
AppFactory: seededAppFactory{ta.ChainlinkApplication},
FallbackAPIInitializer: NewMockAPIInitializer(ta.t),
Runner: EmptyRunner{},
HTTP: hc.HTTPClient,
CookieAuthenticator: MockCookieAuthenticator{t: ta.t},
FileSessionRequestBuilder: &MockSessionRequestBuilder{},
PromptingSessionRequestBuilder: &MockSessionRequestBuilder{},
ChangePasswordPrompter: &MockChangePasswordPrompter{},
}
return client, r
}
func (ta *TestApplication) NewAuthenticatingShell(prompter cmd.Prompter) *cmd.Shell {
lggr := logger.TestLogger(ta.t)
cookieAuth := cmd.NewSessionCookieAuthenticator(ta.NewClientOpts(), &cmd.MemoryCookieStore{}, lggr)
client := &cmd.Shell{
Renderer: &RendererMock{},
Config: ta.GetConfig(),
Logger: lggr,
AppFactory: seededAppFactory{ta.ChainlinkApplication},
FallbackAPIInitializer: NewMockAPIInitializer(ta.t),
Runner: EmptyRunner{},
HTTP: cmd.NewAuthenticatedHTTPClient(ta.Logger, ta.NewClientOpts(), cookieAuth, clsessions.SessionRequest{}),
CookieAuthenticator: cookieAuth,
FileSessionRequestBuilder: cmd.NewFileSessionRequestBuilder(lggr),
PromptingSessionRequestBuilder: cmd.NewPromptingSessionRequestBuilder(prompter),
ChangePasswordPrompter: &MockChangePasswordPrompter{},
}
return client
}
// NewKeyStore returns a new, unlocked keystore
func NewKeyStore(t testing.TB, db *sqlx.DB, cfg pg.QConfig) keystore.Master {
keystore := keystore.NewInMemory(db, utils.FastScryptParams, logger.TestLogger(t), cfg)
require.NoError(t, keystore.Unlock(Password))
return keystore
}
func ParseJSON(t testing.TB, body io.Reader) models.JSON {
t.Helper()
b, err := io.ReadAll(body)
require.NoError(t, err)
return models.JSON{Result: gjson.ParseBytes(b)}
}
func ParseJSONAPIErrors(t testing.TB, body io.Reader) *models.JSONAPIErrors {
t.Helper()
b, err := io.ReadAll(body)
require.NoError(t, err)
var respJSON models.JSONAPIErrors
err = json.Unmarshal(b, &respJSON)
require.NoError(t, err)
return &respJSON
}
// MustReadFile loads a file but should never fail
func MustReadFile(t testing.TB, file string) []byte {
t.Helper()
content, err := os.ReadFile(file)
require.NoError(t, err)
return content
}
type HTTPClientCleaner struct {
HTTPClient cmd.HTTPClient
t testing.TB
}
func (r *HTTPClientCleaner) Get(path string, headers ...map[string]string) (*http.Response, func()) {
resp, err := r.HTTPClient.Get(testutils.Context(r.t), path, headers...)
return bodyCleaner(r.t, resp, err)
}
func (r *HTTPClientCleaner) Post(path string, body io.Reader) (*http.Response, func()) {
resp, err := r.HTTPClient.Post(testutils.Context(r.t), path, body)
return bodyCleaner(r.t, resp, err)
}
func (r *HTTPClientCleaner) Put(path string, body io.Reader) (*http.Response, func()) {
resp, err := r.HTTPClient.Put(testutils.Context(r.t), path, body)
return bodyCleaner(r.t, resp, err)
}
func (r *HTTPClientCleaner) Patch(path string, body io.Reader, headers ...map[string]string) (*http.Response, func()) {
resp, err := r.HTTPClient.Patch(testutils.Context(r.t), path, body, headers...)
return bodyCleaner(r.t, resp, err)
}
func (r *HTTPClientCleaner) Delete(path string) (*http.Response, func()) {
resp, err := r.HTTPClient.Delete(testutils.Context(r.t), path)
return bodyCleaner(r.t, resp, err)
}
func bodyCleaner(t testing.TB, resp *http.Response, err error) (*http.Response, func()) {
t.Helper()
require.NoError(t, err)
return resp, func() { require.NoError(t, resp.Body.Close()) }
}
// ParseResponseBody will parse the given response into a byte slice
func ParseResponseBody(t testing.TB, resp *http.Response) []byte {
t.Helper()
b, err := io.ReadAll(resp.Body)
require.NoError(t, err)
return b
}
// ParseJSONAPIResponse parses the response and returns the JSONAPI resource.
func ParseJSONAPIResponse(t testing.TB, resp *http.Response, resource interface{}) error {
t.Helper()
input := ParseResponseBody(t, resp)
err := jsonapi.Unmarshal(input, resource)
if err != nil {
return fmt.Errorf("web: unable to unmarshal data, %+v", err)
}
return nil
}
// ParseJSONAPIResponseMeta parses the bytes of the root document and returns a
// map of *json.RawMessage's within the 'meta' key.
func ParseJSONAPIResponseMeta(input []byte) (map[string]*json.RawMessage, error) {
var root map[string]*json.RawMessage
err := json.Unmarshal(input, &root)
if err != nil {
return root, err
}
var meta map[string]*json.RawMessage
err = json.Unmarshal(*root["meta"], &meta)
return meta, err
}
// ParseJSONAPIResponseMetaCount parses the bytes of the root document and
// returns the value of the 'count' key from the 'meta' section.
func ParseJSONAPIResponseMetaCount(input []byte) (int, error) {
meta, err := ParseJSONAPIResponseMeta(input)
if err != nil {
return -1, err
}
var metaCount int
err = json.Unmarshal(*meta["count"], &metaCount)
return metaCount, err
}
func CreateJobViaWeb(t testing.TB, app *TestApplication, request []byte) job.Job {
t.Helper()
client := app.NewHTTPClient(nil)
resp, cleanup := client.Post("/v2/jobs", bytes.NewBuffer(request))
defer cleanup()
AssertServerResponse(t, resp, http.StatusOK)
var createdJob job.Job
err := ParseJSONAPIResponse(t, resp, &createdJob)
require.NoError(t, err)
return createdJob
}
func CreateJobViaWeb2(t testing.TB, app *TestApplication, spec string) webpresenters.JobResource {
t.Helper()
client := app.NewHTTPClient(nil)
resp, cleanup := client.Post("/v2/jobs", bytes.NewBufferString(spec))
defer cleanup()
AssertServerResponse(t, resp, http.StatusOK)
var jobResponse webpresenters.JobResource
err := ParseJSONAPIResponse(t, resp, &jobResponse)
require.NoError(t, err)
return jobResponse
}
func DeleteJobViaWeb(t testing.TB, app *TestApplication, jobID int32) {
t.Helper()
client := app.NewHTTPClient(nil)
resp, cleanup := client.Delete(fmt.Sprintf("/v2/jobs/%v", jobID))
defer cleanup()
AssertServerResponse(t, resp, http.StatusNoContent)
}
func AwaitJobActive(t testing.TB, jobSpawner job.Spawner, jobID int32, waitFor time.Duration) {
t.Helper()
require.Eventually(t, func() bool {
_, exists := jobSpawner.ActiveJobs()[jobID]
return exists
}, waitFor, 100*time.Millisecond)
}
func CreateJobRunViaExternalInitiatorV2(
t testing.TB,
app *TestApplication,
jobID uuid.UUID,
eia auth.Token,
body string,
) webpresenters.PipelineRunResource {
t.Helper()
headers := make(map[string]string)
headers[static.ExternalInitiatorAccessKeyHeader] = eia.AccessKey
headers[static.ExternalInitiatorSecretHeader] = eia.Secret
url := app.Server.URL + "/v2/jobs/" + jobID.String() + "/runs"
bodyBuf := bytes.NewBufferString(body)
resp, cleanup := UnauthenticatedPost(t, url, bodyBuf, headers)
defer cleanup()
AssertServerResponse(t, resp, 200)
var pr webpresenters.PipelineRunResource
err := ParseJSONAPIResponse(t, resp, &pr)
require.NoError(t, err)
// assert.Equal(t, j.ID, pr.JobSpecID)
return pr
}
func CreateJobRunViaUser(
t testing.TB,
app *TestApplication,
jobID uuid.UUID,
body string,
) webpresenters.PipelineRunResource {
t.Helper()
bodyBuf := bytes.NewBufferString(body)
client := app.NewHTTPClient(nil)
resp, cleanup := client.Post("/v2/jobs/"+jobID.String()+"/runs", bodyBuf)
defer cleanup()
AssertServerResponse(t, resp, 200)
var pr webpresenters.PipelineRunResource
err := ParseJSONAPIResponse(t, resp, &pr)
require.NoError(t, err)
return pr
}
// CreateExternalInitiatorViaWeb creates a bridgetype via web using /v2/bridge_types
func CreateExternalInitiatorViaWeb(
t testing.TB,
app *TestApplication,
payload string,
) *webpresenters.ExternalInitiatorAuthentication {
t.Helper()
client := app.NewHTTPClient(nil)
resp, cleanup := client.Post("/v2/external_initiators", bytes.NewBufferString(payload))
defer cleanup()
AssertServerResponse(t, resp, http.StatusCreated)
ei := &webpresenters.ExternalInitiatorAuthentication{}
err := ParseJSONAPIResponse(t, resp, ei)
require.NoError(t, err)
return ei
}
const (
// DBPollingInterval can't be too short to avoid DOSing the test database
DBPollingInterval = 100 * time.Millisecond
// AssertNoActionTimeout shouldn't be too long, or it will slow down tests
AssertNoActionTimeout = 3 * time.Second
)
// WaitForSpecErrorV2 polls until the passed in jobID has count number
// of job spec errors.
func WaitForSpecErrorV2(t *testing.T, db *sqlx.DB, jobID int32, count int) []job.SpecError {
t.Helper()
g := gomega.NewWithT(t)
var jse []job.SpecError
g.Eventually(func() []job.SpecError {
err := db.Select(&jse, `SELECT * FROM job_spec_errors WHERE job_id = $1`, jobID)
assert.NoError(t, err)
return jse
}, testutils.WaitTimeout(t), DBPollingInterval).Should(gomega.HaveLen(count))
return jse
}
func WaitForPipelineError(t testing.TB, nodeID int, jobID int32, expectedPipelineRuns int, expectedTaskRuns int, jo job.ORM, timeout, poll time.Duration) []pipeline.Run {
t.Helper()
return WaitForPipeline(t, nodeID, jobID, expectedPipelineRuns, expectedTaskRuns, jo, timeout, poll, pipeline.RunStatusErrored)
}
func WaitForPipelineComplete(t testing.TB, nodeID int, jobID int32, expectedPipelineRuns int, expectedTaskRuns int, jo job.ORM, timeout, poll time.Duration) []pipeline.Run {
t.Helper()
return WaitForPipeline(t, nodeID, jobID, expectedPipelineRuns, expectedTaskRuns, jo, timeout, poll, pipeline.RunStatusCompleted)
}
func WaitForPipeline(t testing.TB, nodeID int, jobID int32, expectedPipelineRuns int, expectedTaskRuns int, jo job.ORM, timeout, poll time.Duration, state pipeline.RunStatus) []pipeline.Run {
t.Helper()
var pr []pipeline.Run
gomega.NewWithT(t).Eventually(func() bool {
prs, _, err := jo.PipelineRuns(&jobID, 0, 1000)
require.NoError(t, err)
var matched []pipeline.Run
for _, pr := range prs {
if !pr.State.Finished() || pr.State != state {
continue
}
// txdb effectively ignores transactionality of queries, so we need to explicitly expect a number of task runs
// (if the read occurs mid-transaction and a job run is inserted but task runs not yet).
if len(pr.PipelineTaskRuns) == expectedTaskRuns {
matched = append(matched, pr)
}
}
if len(matched) >= expectedPipelineRuns {
pr = matched
return true
}
return false
}, timeout, poll).Should(
gomega.BeTrue(),
fmt.Sprintf(`expected at least %d runs with status "%s" on node %d for job %d, total runs %d`,
expectedPipelineRuns,
state,
nodeID,
jobID,
len(pr),
),
)
return pr
}
// AssertPipelineRunsStays asserts that the number of pipeline runs for a particular job remains at the provided values
func AssertPipelineRunsStays(t testing.TB, pipelineSpecID int32, db *sqlx.DB, want int) []pipeline.Run {
t.Helper()
g := gomega.NewWithT(t)
var prs []pipeline.Run
g.Consistently(func() []pipeline.Run {
err := db.Select(&prs, `SELECT * FROM pipeline_runs WHERE pipeline_spec_id = $1`, pipelineSpecID)
assert.NoError(t, err)
return prs
}, AssertNoActionTimeout, DBPollingInterval).Should(gomega.HaveLen(want))
return prs
}
// AssertEthTxAttemptCountStays asserts that the number of tx attempts remains at the provided value
func AssertEthTxAttemptCountStays(t testing.TB, txStore txmgr.TestEvmTxStore, want int) []int64 {
g := gomega.NewWithT(t)
var txaIds []int64
g.Consistently(func() []txmgr.TxAttempt {
attempts, err := txStore.GetAllTxAttempts(testutils.Context(t))
assert.NoError(t, err)
return attempts
}, AssertNoActionTimeout, DBPollingInterval).Should(gomega.HaveLen(want))
return txaIds
}
// Head given the value convert it into an Head
func Head(val interface{}) *evmtypes.Head {
var h evmtypes.Head
time := uint64(0)
switch t := val.(type) {
case int:
h = evmtypes.NewHead(big.NewInt(int64(t)), evmutils.NewHash(), evmutils.NewHash(), time, ubig.New(&FixtureChainID))
case uint64:
h = evmtypes.NewHead(big.NewInt(int64(t)), evmutils.NewHash(), evmutils.NewHash(), time, ubig.New(&FixtureChainID))
case int64:
h = evmtypes.NewHead(big.NewInt(t), evmutils.NewHash(), evmutils.NewHash(), time, ubig.New(&FixtureChainID))
case *big.Int:
h = evmtypes.NewHead(t, evmutils.NewHash(), evmutils.NewHash(), time, ubig.New(&FixtureChainID))
default:
panic(fmt.Sprintf("Could not convert %v of type %T to Head", val, val))