mirror/prysm-pulse
1
0
Fork 0
mirror of https://gitlab.com/pulsechaincom/prysm-pulse.git synced 2024-12-22 03:30:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fixes issues when running validator client with the --web flag and non existing validator.db file AND/OR prysm-wallet-v2 directory. (#13460)

Browse Source 
* `getLegacyDatabaseLocation`: Add tests.

* `getLegacyDatabaseLocation`: Handle `c.wallet == nil`.

* `saveAuthToken`: Create parent directory if needed.
This commit is contained in:
Manu NALEPA 2024-01-12 16:53:27 +01:00 committed by GitHub
parent 6ddafe1159
commit 22a484c45e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 152 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
validator/node/BUILD.bazel
View File

@ -7,16 +7,20 @@ go_test(
data = glob(["testdata/**"]),
embed = [":go_default_library"],
deps = [
"//cmd:go_default_library",
"//cmd/validator/flags:go_default_library",
"//config/fieldparams:go_default_library",
"//config/params:go_default_library",
"//config/validator/service:go_default_library",
"//consensus-types/validator:go_default_library",
"//encoding/bytesutil:go_default_library",
"//io/file:go_default_library",
"//testing/assert:go_default_library",
"//testing/require:go_default_library",
"//validator/accounts:go_default_library",
"//validator/accounts/wallet:go_default_library",
"//validator/db/iface:go_default_library",
"//validator/db/kv:go_default_library",
"//validator/db/testing:go_default_library",
"//validator/keymanager:go_default_library",
"//validator/keymanager/remote-web3signer:go_default_library",

2
validator/node/node.go
View File

@ -218,7 +218,7 @@ func (c *ValidatorClient) getLegacyDatabaseLocation(
dataFile string,
walletDir string,
) (string, string) {
if isInteropNumValidatorsSet || dataDir != cmd.DefaultDataDir() || file.Exists(dataFile) {
if isInteropNumValidatorsSet || dataDir != cmd.DefaultDataDir() || file.Exists(dataFile) || c.wallet == nil {
return dataDir, dataFile
}

137
validator/node/node_test.go
View File

@ -7,21 +7,26 @@ import (
"net/http"
"net/http/httptest"
"os"
"path"
"path/filepath"
"testing"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/common/hexutil"
"github.com/prysmaticlabs/prysm/v4/cmd"
"github.com/prysmaticlabs/prysm/v4/cmd/validator/flags"
fieldparams "github.com/prysmaticlabs/prysm/v4/config/fieldparams"
"github.com/prysmaticlabs/prysm/v4/config/params"
validatorserviceconfig "github.com/prysmaticlabs/prysm/v4/config/validator/service"
"github.com/prysmaticlabs/prysm/v4/consensus-types/validator"
"github.com/prysmaticlabs/prysm/v4/encoding/bytesutil"
"github.com/prysmaticlabs/prysm/v4/io/file"
"github.com/prysmaticlabs/prysm/v4/testing/assert"
"github.com/prysmaticlabs/prysm/v4/testing/require"
"github.com/prysmaticlabs/prysm/v4/validator/accounts"
"github.com/prysmaticlabs/prysm/v4/validator/accounts/wallet"
"github.com/prysmaticlabs/prysm/v4/validator/db/iface"
"github.com/prysmaticlabs/prysm/v4/validator/db/kv"
dbTest "github.com/prysmaticlabs/prysm/v4/validator/db/testing"
"github.com/prysmaticlabs/prysm/v4/validator/keymanager"
remoteweb3signer "github.com/prysmaticlabs/prysm/v4/validator/keymanager/remote-web3signer"
@ -67,6 +72,138 @@ func TestNode_Builds(t *testing.T) {
require.NoError(t, err)
}
func TestGetLegacyDatabaseLocation(t *testing.T) {
dataDir := t.TempDir()
dataFile := path.Join(dataDir, "dataFile")
nonExistingDataFile := path.Join(dataDir, "nonExistingDataFile")
_, err := os.Create(dataFile)
require.NoError(t, err, "Failed to create data file")
walletDir := t.TempDir()
derivedDir := path.Join(walletDir, "derived")
err = file.MkdirAll(derivedDir)
require.NoError(t, err, "Failed to create derived dir")
derivedDbFile := path.Join(derivedDir, kv.ProtectionDbFileName)
_, err = os.Create(derivedDbFile)
require.NoError(t, err, "Failed to create derived db file")
dbFile := path.Join(walletDir, kv.ProtectionDbFileName)
_, err = os.Create(dbFile)
require.NoError(t, err, "Failed to create db file")
nonExistingWalletDir := t.TempDir()
testCases := []struct {
name string
isInteropNumValidatorsSet bool
isWeb3SignerURLFlagSet bool
dataDir string
dataFile string
walletDir string
validatorClient *ValidatorClient
wallet *wallet.Wallet
expectedDataDir string
expectedDataFile string
}{
{
name: "interop num validators set",
isInteropNumValidatorsSet: true,
dataDir: dataDir,
dataFile: dataFile,
expectedDataDir: dataDir,
expectedDataFile: dataFile,
},
{
name: "dataDir differs from default",
dataDir: dataDir,
dataFile: dataFile,
expectedDataDir: dataDir,
expectedDataFile: dataFile,
},
{
name: "dataFile exists",
dataDir: cmd.DefaultDataDir(),
dataFile: dataFile,
expectedDataDir: cmd.DefaultDataDir(),
expectedDataFile: dataFile,
},
{
name: "wallet is nil",
dataDir: cmd.DefaultDataDir(),
dataFile: nonExistingDataFile,
expectedDataDir: cmd.DefaultDataDir(),
expectedDataFile: nonExistingDataFile,
},
{
name: "web3signer url is not set and legacy data file does not exist",
dataDir: cmd.DefaultDataDir(),
dataFile: nonExistingDataFile,
wallet: wallet.New(&wallet.Config{
WalletDir: nonExistingWalletDir,
KeymanagerKind: keymanager.Derived,
}),
expectedDataDir: cmd.DefaultDataDir(),
expectedDataFile: nonExistingDataFile,
},
{
name: "web3signer url is not set and legacy data file does exist",
dataDir: cmd.DefaultDataDir(),
dataFile: nonExistingDataFile,
wallet: wallet.New(&wallet.Config{
WalletDir: walletDir,
KeymanagerKind: keymanager.Derived,
}),
expectedDataDir: path.Join(walletDir, "derived"),
expectedDataFile: path.Join(walletDir, "derived", kv.ProtectionDbFileName),
},
{
name: "web3signer url is set and legacy data file does not exist",
isWeb3SignerURLFlagSet: true,
dataDir: cmd.DefaultDataDir(),
dataFile: nonExistingDataFile,
walletDir: nonExistingWalletDir,
wallet: wallet.New(&wallet.Config{
WalletDir: walletDir,
KeymanagerKind: keymanager.Derived,
}),
expectedDataDir: cmd.DefaultDataDir(),
expectedDataFile: nonExistingDataFile,
},
{
name: "web3signer url is set and legacy data file does exist",
isWeb3SignerURLFlagSet: true,
dataDir: cmd.DefaultDataDir(),
dataFile: nonExistingDataFile,
walletDir: walletDir,
wallet: wallet.New(&wallet.Config{
WalletDir: walletDir,
KeymanagerKind: keymanager.Derived,
}),
expectedDataDir: walletDir,
expectedDataFile: path.Join(walletDir, kv.ProtectionDbFileName),
},
}
for _, tt := range testCases {
t.Run(tt.name, func(t *testing.T) {
validatorClient := &ValidatorClient{wallet: tt.wallet}
actualDataDir, actualDataFile := validatorClient.getLegacyDatabaseLocation(
tt.isInteropNumValidatorsSet,
tt.isWeb3SignerURLFlagSet,
tt.dataDir,
tt.dataFile,
tt.walletDir,
)
assert.Equal(t, tt.expectedDataDir, actualDataDir, "data dir should be equal")
assert.Equal(t, tt.expectedDataFile, actualDataFile, "data file should be equal")
})
}
}
// TestClearDB tests clearing the database
func TestClearDB(t *testing.T) {
hook := logtest.NewGlobal()

11
validator/rpc/auth_token.go
View File

@ -149,7 +149,16 @@ func saveAuthToken(walletDirPath string, jwtKey []byte, token string) error {
if _, err := bytesBuf.WriteString("\n"); err != nil {
return err
}
return file.WriteFile(hashFilePath, bytesBuf.Bytes())
if err := file.MkdirAll(walletDirPath); err != nil {
return errors.Wrapf(err, "could not create directory %s", walletDirPath)
}
if err := file.WriteFile(hashFilePath, bytesBuf.Bytes()); err != nil {
return errors.Wrapf(err, "could not write to file %s", hashFilePath)
}
return nil
}
func readAuthTokenFile(r io.Reader) (secret []byte, token string, err error) {