Add integration tests #85
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| //go:build integration | ||
| // +build integration | ||
|
|
||
| package babylon_integration_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "os" | ||
| "testing" | ||
| "time" | ||
|
|
||
| appparams "github.com/babylonchain/babylon/app/params" | ||
| bbl "github.com/babylonchain/babylon/types" | ||
| lightclient "github.com/babylonchain/babylon/x/btclightclient/types" | ||
| ref "github.com/cosmos/cosmos-sdk/client/grpc/reflection" | ||
| "google.golang.org/grpc" | ||
| ) | ||
|
|
||
| // Addresses of all nodes in local testnet. | ||
| // TODO: instead of hardcoding them it would be nice to get them from env variables | ||
| // so docker-compose and this file would stay compatible | ||
| var addresses = []string{ | ||
| "localhost:9090", | ||
| "localhost:9091", | ||
| "localhost:9092", | ||
| "localhost:9093", | ||
| } | ||
|
|
||
| var clients []*grpc.ClientConn | ||
|
|
||
| func checkInterfacesWithRetries(client *grpc.ClientConn, maxTries int, sleepTime time.Duration) error { | ||
| tries := 0 | ||
| refClient := ref.NewReflectionServiceClient(client) | ||
| for { | ||
| _, err := refClient.ListAllInterfaces(context.Background(), &ref.ListAllInterfacesRequest{}) | ||
|
|
||
| if err == nil { | ||
| // successful call to client, finish calling | ||
| return nil | ||
| } | ||
|
|
||
| tries++ | ||
|
|
||
| if tries > maxTries { | ||
| return errors.New("Failed to call client") | ||
| } | ||
|
|
||
| <-time.After(sleepTime) | ||
| } | ||
| } | ||
|
|
||
| func TestMain(m *testing.M) { | ||
|
|
||
| // This is needed so that all address prefixes are in bbl format | ||
| appparams.SetAddressPrefixes() | ||
|
|
||
| for _, addr := range addresses { | ||
| grpcConn, err := grpc.Dial( | ||
| addr, // Or your gRPC server address. | ||
| grpc.WithInsecure(), // The Cosmos SDK doesn't support any transport security mechanism. | ||
| ) | ||
|
|
||
| if err != nil { | ||
| panic("Grpc connection failed cannot perform integration tests") | ||
| } | ||
|
|
||
| clients = append(clients, grpcConn) | ||
| } | ||
| //runs all following tests | ||
| exitVal := m.Run() | ||
|
|
||
| for _, c := range clients { | ||
| // close all connections after the tests | ||
| c.Close() | ||
| } | ||
|
|
||
| os.Exit(exitVal) | ||
| } | ||
|
|
||
| // This test serves as a waiting point for testnet to start, it is needed as | ||
| // docker compose is usually started in detached mode in CI, therefore tests | ||
| // are started even before all nodes are up. | ||
| // TODO: investigate starting testnet from golang test file. | ||
| func TestTestnetRuninng(t *testing.T) { | ||
|
Comment on lines
+81
to
+85
There was a problem hiding this comment. According to https://stackoverflow.com/a/31204016 the execution order of tests should not be relied upon. It suggests calling this from There was a problem hiding this comment. oh I didn't know that. From what I see one can also provide flag So I think I prefer to just add this flag to make target There was a problem hiding this comment. If |
||
|
|
||
| for _, c := range clients { | ||
| err := checkInterfacesWithRetries(c, 40, 5*time.Second) | ||
|
|
||
| if err != nil { | ||
| panic("Could not start integration tests. Testnet not running") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Check all nodes are properly initialized to genesis | ||
| // TODO ultimatly we would like to check genesis related to all modules here. | ||
| func TestBtcLightClientGenesis(t *testing.T) { | ||
| // TODO currently btclightclient hardcodes this header in some function. Ultimately | ||
| // we would like to get it from config file, and assert here that each node | ||
| // start with genesis header from this config file | ||
| hardcodedHeaderHash, _ := bbl.NewBTCHeaderHashBytesFromHex("00000000000000000002bf1c218853bc920f41f74491e6c92c6bc6fdc881ab47") | ||
| hardcodedHeaderHeight := uint64(736056) | ||
|
|
||
| for i, c := range clients { | ||
| lc := lightclient.NewQueryClient(c) | ||
|
|
||
| res, err := lc.BestHeader(context.Background(), lightclient.NewQueryBestHeaderRequest()) | ||
|
There was a problem hiding this comment. I'm not sure the The There was a problem hiding this comment. As mention in earlier comment, I intend for those tests to be stateful and deterministic, so as this will be the first test which will run, then at this point best header should be be genesis header. In later tests, after ingesting few header tip should move by expected amount of headers. There was a problem hiding this comment. Sorry that's not what I meant. I meant that according to the PR description you start with Admittedly it will probably not move on before this test executes, but just wanted to point out that there is a deterministic endpoint for you to use. |
||
|
|
||
| if err != nil { | ||
| // this is fatal, as it means we most probably did not get any response and | ||
| // at least one of the nodes is down | ||
| t.Fatalf("Test failed due to client error: %v to node with address %s", err, addresses[i]) | ||
| } | ||
|
|
||
| if res.Header.Height != hardcodedHeaderHeight || !res.Header.Hash.Eq(&hardcodedHeaderHash) { | ||
| t.Errorf("Node with address %s started with unexpected header", addresses[i]) | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing against "best header", just curious, why introduce new names for already existing concepts? Do you think "tip" is confusing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find it a bit ambiguous to be honest it can mean tip of the blockchain, or maybe some tip to the miner. It can be interpreted in too many ways to my taste. I find
best headerhaving a bit more precise.But I can change it to tip, to not introduce new terminolgy. We can debate naming of external apis when we will have some kind public testnet, and biger sample of people using those apis.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually I saw that "best block" is a thing in Bitcoin, so it's fine with me.