Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(integration): fix flaky integration tests with proper health checks #16

Merged
merged 4 commits into from
Dec 5, 2024
Merged

test(integration): fix flaky integration tests with proper health checks #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
94e4ebf
test(integration): add health check
jim380 Nov 27, 2024
417599f
test(integration): generate elastic jwt secret each run
jim380 Nov 27, 2024
cfddec3
test: address PR#16 comments
jim380 Dec 4, 2024
ff282d0
ci: fix lint
jim380 Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 28 additions & 17 deletions execution.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"fmt"
"math/big"
"net/http"
"strings"
"time"

"github.com/golang-jwt/jwt/v5"
Expand Down Expand Up @@ -58,23 +59,10 @@ func NewEngineAPIExecutionClient(
return nil, err
}

authToken := ""
if jwtSecret != "" {
secret, err := hex.DecodeString(jwtSecret)
if err != nil {
return nil, err
}

token := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
"exp": time.Now().Add(time.Hour * 1).Unix(), // Expires in 1 hour
"iat": time.Now().Unix(),
})

// Sign the token with the decoded secret
authToken, err = token.SignedString(secret)
if err != nil {
return nil, err
}
authToken, err := getAuthToken(jwtSecret)
if err != nil {
ethClient.Close()
return nil, err
}

engineClient, err := rpc.DialOptions(context.Background(), engineURL,
Expand Down Expand Up @@ -294,3 +282,26 @@ func (c *EngineAPIExecutionClient) SetFinal(ctx context.Context, height uint64)
func (c *EngineAPIExecutionClient) derivePrevRandao(blockHeight uint64) common.Hash {
return common.BigToHash(big.NewInt(int64(blockHeight))) //nolint:gosec // disable G115
}

// Add this function to execution.go
func getAuthToken(jwtSecret string) (string, error) {
if jwtSecret == "" {
return "", nil
}
secret, err := hex.DecodeString(strings.TrimPrefix(jwtSecret, "0x"))
if err != nil {
return "", fmt.Errorf("failed to decode JWT secret: %w", err)
}

token := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
"exp": time.Now().Add(time.Hour * 1).Unix(), // Expires in 1 hour
"iat": time.Now().Unix(),
})

// Sign the token with the decoded secret
authToken, err := token.SignedString(secret)
if err != nil {
return "", fmt.Errorf("failed to sign JWT token: %w", err)
}
return authToken, nil
}
168 changes: 118 additions & 50 deletions integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@ package execution

import (
"context"
"crypto/rand"
"encoding/hex"
"fmt"
"math/big"
"net/http"
"os"
"path/filepath"
"strings"
"testing"
"time"

Expand All @@ -26,34 +31,59 @@ import (
const (
TEST_ETH_URL = "http://localhost:8545"
TEST_ENGINE_URL = "http://localhost:8551"
JWT_SECRET = "09a23c010d96caaebb21c193b85d30bbb62a9bac5bd0a684e9e91c77c811ca65" //nolint:gosec

CHAIN_ID = "1234"
GENESIS_HASH = "0x8bf225d50da44f60dee1c4ee6f810fe5b44723c76ac765654b6692d50459f216"
GENESIS_STATEROOT = "0x362b7d8a31e7671b0f357756221ac385790c25a27ab222dc8cbdd08944f5aea4"
TEST_PRIVATE_KEY = "cece4f25ac74deb1468965160c7185e07dff413f23fcadb611b05ca37ab0a52e"
TEST_TO_ADDRESS = "0x944fDcD1c868E3cC566C78023CcB38A32cDA836E"

DOCKER_CHAIN_PATH = "./docker/chain" // path relative to the test file
DOCKER_JWTSECRET_PATH = "./docker/jwttoken/" //nolint:gosec // path relative to the test file
DOCKER_JWT_SECRET_FILE = "testsecret.hex"
DOCKER_PATH = "./docker"
JWT_FILENAME = "testsecret.hex"
)

func setupTestRethEngine(t *testing.T) {
func generateJWTSecret() (string, error) {
jwtSecret := make([]byte, 32)
_, err := rand.Read(jwtSecret)
if err != nil {
return "", fmt.Errorf("failed to generate random bytes: %w", err)
}

return hex.EncodeToString(jwtSecret), nil
}

func setupTestRethEngine(t *testing.T) string {
t.Helper()

chainPath, err := filepath.Abs(DOCKER_CHAIN_PATH)
chainPath, err := filepath.Abs(filepath.Join(DOCKER_PATH, "chain"))
require.NoError(t, err)

jwtPath, err := filepath.Abs(filepath.Join(DOCKER_PATH, "jwttoken"))
require.NoError(t, err)

err = os.MkdirAll(jwtPath, 0750)
require.NoError(t, err)

jwtSecretPath, err := filepath.Abs(DOCKER_JWTSECRET_PATH)
jwtSecret, err := generateJWTSecret()
require.NoError(t, err)

err = os.WriteFile(DOCKER_JWTSECRET_PATH+DOCKER_JWT_SECRET_FILE, []byte(JWT_SECRET), 0600)
jwtFile := filepath.Join(jwtPath, JWT_FILENAME)
err = os.WriteFile(jwtFile, []byte(jwtSecret), 0600)
require.NoError(t, err)

t.Cleanup(func() {
err := os.Remove(jwtFile)
require.NoError(t, err)
})

cli, err := client.NewClientWithOpts()
require.NoError(t, err)

t.Cleanup(func() {
err := cli.Close()
require.NoError(t, err)
})

rethContainer, err := cli.ContainerCreate(context.Background(),
&container.Config{
Image: "ghcr.io/paradigmxyz/reth:v1.1.1",
Expand Down Expand Up @@ -83,7 +113,7 @@ func setupTestRethEngine(t *testing.T) {
&container.HostConfig{
Binds: []string{
chainPath + ":/root/chain:ro",
jwtSecretPath + ":/root/jwt:ro",
jwtPath + ":/root/jwt:ro",
},
PortBindings: nat.PortMap{
nat.Port("8545/tcp"): []nat.PortBinding{
Expand All @@ -103,24 +133,78 @@ func setupTestRethEngine(t *testing.T) {
nil, nil, "reth")
require.NoError(t, err)

err = cli.ContainerStart(context.Background(), rethContainer.ID, container.StartOptions{})
require.NoError(t, err)

// TODO: check container status instead of sleeping
time.Sleep(5 * time.Second)

t.Cleanup(func() {
jim380 marked this conversation as resolved.
Show resolved Hide resolved
err = cli.ContainerStop(context.Background(), rethContainer.ID, container.StopOptions{})
err := cli.ContainerStop(context.Background(), rethContainer.ID, container.StopOptions{})
require.NoError(t, err)
err = cli.ContainerRemove(context.Background(), rethContainer.ID, container.RemoveOptions{})
require.NoError(t, err)
err = os.Remove(DOCKER_JWTSECRET_PATH + DOCKER_JWT_SECRET_FILE)
require.NoError(t, err)
})

err = cli.ContainerStart(context.Background(), rethContainer.ID, container.StartOptions{})
require.NoError(t, err)

err = waitForRethContainer(t, jwtSecret)
require.NoError(t, err)

return jwtSecret
}

// waitForRethContainer polls the reth endpoints until they're ready or timeout occurs
func waitForRethContainer(t *testing.T, jwtSecret string) error {
t.Helper()

client := &http.Client{
Timeout: 100 * time.Millisecond,
}

timer := time.NewTimer(500 * time.Millisecond)
defer timer.Stop()

for {
select {
case <-timer.C:
return fmt.Errorf("timeout waiting for reth container to be ready")
default:
// check :8545 is ready
rpcReq := strings.NewReader(`{"jsonrpc":"2.0","method":"net_version","params":[],"id":1}`)
resp, err := client.Post(TEST_ETH_URL, "application/json", rpcReq)
if err == nil {
if err := resp.Body.Close(); err != nil {
return fmt.Errorf("failed to close response body: %w", err)
}
if resp.StatusCode == http.StatusOK {
// check :8551 is ready with a stateless call
req, err := http.NewRequest("POST", TEST_ENGINE_URL, strings.NewReader(`{"jsonrpc":"2.0","method":"engine_getClientVersionV1","params":[],"id":1}`))
if err != nil {
return err
}
req.Header.Set("Content-Type", "application/json")

authToken, err := getAuthToken(jwtSecret)
if err != nil {
return err
}

req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", authToken))

resp, err := client.Do(req)
if err == nil {
if err := resp.Body.Close(); err != nil {
return fmt.Errorf("failed to close response body: %w", err)
}
if resp.StatusCode == http.StatusOK {
return nil
}
}
}
}
time.Sleep(100 * time.Millisecond)
}
}
}

func TestExecutionClientLifecycle(t *testing.T) {
setupTestRethEngine(t)
jwtSecret := setupTestRethEngine(t)

initialHeight := uint64(0)
genesisHash := common.HexToHash(GENESIS_HASH)
Expand All @@ -135,20 +219,27 @@ func TestExecutionClientLifecycle(t *testing.T) {
&proxy_json_rpc.Config{},
TEST_ETH_URL,
TEST_ENGINE_URL,
JWT_SECRET,
jwtSecret,
genesisHash,
common.Address{},
)
require.NoError(t, err)

// sub tests are only functional grouping.
t.Run("InitChain", func(t *testing.T) {
require.True(t, t.Run("InitChain", func(t *testing.T) {
stateRoot, gasLimit, err := executionClient.InitChain(context.Background(), genesisTime, initialHeight, CHAIN_ID)
require.NoError(t, err)

require.Equal(t, rollkitGenesisStateRoot, stateRoot)
require.Equal(t, uint64(1000000), gasLimit)
})
}))

require.True(t, t.Run("InitChain_InvalidPayloadTimestamp", func(t *testing.T) {
blockTime := time.Date(2024, 3, 13, 13, 54, 0, 0, time.UTC) // pre-cancun timestamp not supported
_, _, err := executionClient.InitChain(context.Background(), blockTime, initialHeight, CHAIN_ID)
// payload timestamp is not within the cancun timestamp
require.Error(t, err)
require.ErrorContains(t, err, "Unsupported fork")
}))

privateKey, err := crypto.HexToECDSA(TEST_PRIVATE_KEY)
require.NoError(t, err)
Expand All @@ -170,7 +261,7 @@ func TestExecutionClientLifecycle(t *testing.T) {
err = rpcClient.SendTransaction(context.Background(), signedTx)
require.NoError(t, err)

t.Run("GetTxs", func(t *testing.T) {
require.True(t, t.Run("GetTxs", func(t *testing.T) {
txs, err := executionClient.GetTxs(context.Background())
require.NoError(t, err)
assert.Equal(t, 1, len(txs))
Expand All @@ -187,43 +278,20 @@ func TestExecutionClientLifecycle(t *testing.T) {
assert.Equal(t, rSignedTx, r)
assert.Equal(t, sSignedTx, s)
assert.Equal(t, vSignedTx, v)
})
}))

txBytes, err := signedTx.MarshalBinary()
require.NoError(t, err)

blockHeight := uint64(1)
blockTime := genesisTime.Add(10 * time.Second)

t.Run("ExecuteTxs", func(t *testing.T) {
require.True(t, t.Run("ExecuteTxs", func(t *testing.T) {
newStateroot := common.HexToHash("0x362b7d8a31e7671b0f357756221ac385790c25a27ab222dc8cbdd08944f5aea4")

stateroot, gasUsed, err := executionClient.ExecuteTxs(context.Background(), []rollkit_types.Tx{rollkit_types.Tx(txBytes)}, blockHeight, blockTime, rollkitGenesisStateRoot)
require.NoError(t, err)
assert.Greater(t, gasLimit, gasUsed)
assert.Equal(t, rollkit_types.Hash(newStateroot[:]), stateroot)
})
}

func TestExecutionClient_InitChain_InvalidPayloadTimestamp(t *testing.T) {
setupTestRethEngine(t)

initialHeight := uint64(0)
genesisHash := common.HexToHash(GENESIS_HASH)
blockTime := time.Date(2024, 3, 13, 13, 54, 0, 0, time.UTC) // pre-cancun timestamp not supported

executionClient, err := NewEngineAPIExecutionClient(
&proxy_json_rpc.Config{},
TEST_ETH_URL,
TEST_ENGINE_URL,
JWT_SECRET,
genesisHash,
common.Address{},
)
require.NoError(t, err)

_, _, err = executionClient.InitChain(context.Background(), blockTime, initialHeight, CHAIN_ID)
// payload timestamp is not within the cancun timestamp
require.Error(t, err)
require.ErrorContains(t, err, "Unsupported fork")
}))
}
Loading