f1196ad1a1
## Description Closes: #12101 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
241 lines
8.0 KiB
Go
241 lines
8.0 KiB
Go
//go:build linux
|
|
// +build linux
|
|
|
|
package cosmovisor_test
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/stretchr/testify/suite"
|
|
|
|
"github.com/cosmos/cosmos-sdk/cosmovisor"
|
|
upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
|
|
)
|
|
|
|
type processTestSuite struct {
|
|
suite.Suite
|
|
}
|
|
|
|
func TestProcessTestSuite(t *testing.T) {
|
|
suite.Run(t, new(processTestSuite))
|
|
}
|
|
|
|
// TestLaunchProcess will try running the script a few times and watch upgrades work properly
|
|
// and args are passed through
|
|
func (s *processTestSuite) TestLaunchProcess() {
|
|
// binaries from testdata/validate directory
|
|
require := s.Require()
|
|
home := copyTestData(s.T(), "validate")
|
|
cfg := &cosmovisor.Config{Home: home, Name: "dummyd", PollInterval: 20, UnsafeSkipBackup: true}
|
|
logger := cosmovisor.NewLogger()
|
|
|
|
// should run the genesis binary and produce expected output
|
|
stdout, stderr := NewBuffer(), NewBuffer()
|
|
currentBin, err := cfg.CurrentBin()
|
|
require.NoError(err)
|
|
require.Equal(cfg.GenesisBin(), currentBin)
|
|
|
|
launcher, err := cosmovisor.NewLauncher(logger, cfg)
|
|
require.NoError(err)
|
|
|
|
upgradeFile := cfg.UpgradeInfoFilePath()
|
|
|
|
args := []string{"foo", "bar", "1234", upgradeFile}
|
|
doUpgrade, err := launcher.Run(args, stdout, stderr)
|
|
require.NoError(err)
|
|
require.True(doUpgrade)
|
|
require.Equal("", stderr.String())
|
|
require.Equal(fmt.Sprintf("Genesis foo bar 1234 %s\nUPGRADE \"chain2\" NEEDED at height: 49: {}\n", upgradeFile), stdout.String())
|
|
|
|
// ensure this is upgraded now and produces new output
|
|
currentBin, err = cfg.CurrentBin()
|
|
require.NoError(err)
|
|
|
|
require.Equal(cfg.UpgradeBin("chain2"), currentBin)
|
|
args = []string{"second", "run", "--verbose"}
|
|
stdout.Reset()
|
|
stderr.Reset()
|
|
|
|
doUpgrade, err = launcher.Run(args, stdout, stderr)
|
|
require.NoError(err)
|
|
require.False(doUpgrade)
|
|
require.Equal("", stderr.String())
|
|
require.Equal("Chain 2 is live!\nArgs: second run --verbose\nFinished successfully\n", stdout.String())
|
|
|
|
// ended without other upgrade
|
|
require.Equal(cfg.UpgradeBin("chain2"), currentBin)
|
|
}
|
|
|
|
func (s *processTestSuite) TestLaunchProcessWithRestartDelay() {
|
|
// binaries from testdata/validate directory
|
|
require := s.Require()
|
|
home := copyTestData(s.T(), "validate")
|
|
cfg := &cosmovisor.Config{Home: home, Name: "dummyd", RestartDelay: 5 * time.Second, PollInterval: 20, UnsafeSkipBackup: true}
|
|
logger := cosmovisor.NewLogger()
|
|
|
|
// should run the genesis binary and produce expected output
|
|
stdout, stderr := NewBuffer(), NewBuffer()
|
|
currentBin, err := cfg.CurrentBin()
|
|
require.NoError(err)
|
|
require.Equal(cfg.GenesisBin(), currentBin)
|
|
|
|
launcher, err := cosmovisor.NewLauncher(logger, cfg)
|
|
require.NoError(err)
|
|
|
|
upgradeFile := cfg.UpgradeInfoFilePath()
|
|
|
|
start := time.Now()
|
|
|
|
doUpgrade, err := launcher.Run([]string{"foo", "bar", "1234", upgradeFile}, stdout, stderr)
|
|
require.NoError(err)
|
|
require.True(doUpgrade)
|
|
|
|
// may not be the best way but the fastest way to check we meet the delay
|
|
// in addition to comparing both the runtime of this test and TestLaunchProcess in addition
|
|
if time.Since(start) < cfg.RestartDelay {
|
|
require.FailNow("restart delay not met")
|
|
}
|
|
}
|
|
|
|
// TestLaunchProcess will try running the script a few times and watch upgrades work properly
|
|
// and args are passed through
|
|
func (s *processTestSuite) TestLaunchProcessWithDownloads() {
|
|
// test case upgrade path (binaries from testdata/download directory):
|
|
// genesis -> chain2-zip_bin
|
|
// chain2-zip_bin -> ref_to_chain3-zip_dir.json = (json for the next download instructions) -> chain3-zip_dir
|
|
// chain3-zip_dir - doesn't upgrade
|
|
require := s.Require()
|
|
home := copyTestData(s.T(), "download")
|
|
cfg := &cosmovisor.Config{Home: home, Name: "autod", AllowDownloadBinaries: true, PollInterval: 100, UnsafeSkipBackup: true}
|
|
logger := cosmovisor.NewLogger()
|
|
upgradeFilename := cfg.UpgradeInfoFilePath()
|
|
|
|
// should run the genesis binary and produce expected output
|
|
currentBin, err := cfg.CurrentBin()
|
|
require.NoError(err)
|
|
require.Equal(cfg.GenesisBin(), currentBin)
|
|
|
|
launcher, err := cosmovisor.NewLauncher(logger, cfg)
|
|
require.NoError(err)
|
|
|
|
stdout, stderr := NewBuffer(), NewBuffer()
|
|
args := []string{"some", "args", upgradeFilename}
|
|
doUpgrade, err := launcher.Run(args, stdout, stderr)
|
|
|
|
require.NoError(err)
|
|
require.True(doUpgrade)
|
|
require.Equal("", stderr.String())
|
|
require.Equal("Genesis autod. Args: some args "+upgradeFilename+"\n"+`ERROR: UPGRADE "chain2" NEEDED at height: 49: zip_binary`+"\n", stdout.String())
|
|
currentBin, err = cfg.CurrentBin()
|
|
require.NoError(err)
|
|
require.Equal(cfg.UpgradeBin("chain2"), currentBin)
|
|
|
|
// start chain2
|
|
stdout.Reset()
|
|
stderr.Reset()
|
|
args = []string{"run", "--fast", upgradeFilename}
|
|
doUpgrade, err = launcher.Run(args, stdout, stderr)
|
|
require.NoError(err)
|
|
|
|
require.Equal("", stderr.String())
|
|
require.Equal("Chain 2 from zipped binary\nArgs: run --fast "+upgradeFilename+"\n"+`ERROR: UPGRADE "chain3" NEEDED at height: 936: ref_to_chain3-zip_dir.json module=main`+"\n", stdout.String())
|
|
// ended with one more upgrade
|
|
require.True(doUpgrade)
|
|
currentBin, err = cfg.CurrentBin()
|
|
require.NoError(err)
|
|
require.Equal(cfg.UpgradeBin("chain3"), currentBin)
|
|
|
|
// run the last chain
|
|
args = []string{"end", "--halt", upgradeFilename}
|
|
stdout.Reset()
|
|
stderr.Reset()
|
|
doUpgrade, err = launcher.Run(args, stdout, stderr)
|
|
require.NoError(err)
|
|
require.False(doUpgrade)
|
|
require.Equal("", stderr.String())
|
|
require.Equal("Chain 3 from zipped directory\nArgs: end --halt "+upgradeFilename+"\n", stdout.String())
|
|
|
|
// and this doesn't upgrade
|
|
currentBin, err = cfg.CurrentBin()
|
|
require.NoError(err)
|
|
require.Equal(cfg.UpgradeBin("chain3"), currentBin)
|
|
}
|
|
|
|
// TestSkipUpgrade tests heights that are identified to be skipped and return if upgrade height matches the skip heights
|
|
func TestSkipUpgrade(t *testing.T) {
|
|
cases := []struct {
|
|
args []string
|
|
upgradeInfo upgradetypes.Plan
|
|
expectRes bool
|
|
}{{
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades"},
|
|
upgradeInfo: upgradetypes.Plan{Name: "upgrade1", Info: "some info", Height: 123},
|
|
expectRes: false,
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades", "--abcd"},
|
|
upgradeInfo: upgradetypes.Plan{Name: "upgrade1", Info: "some info", Height: 123},
|
|
expectRes: false,
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades", "10", "--abcd"},
|
|
upgradeInfo: upgradetypes.Plan{Name: "upgrade1", Info: "some info", Height: 11},
|
|
expectRes: false,
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades", "10", "20", "--abcd"},
|
|
upgradeInfo: upgradetypes.Plan{Name: "upgrade1", Info: "some info", Height: 20},
|
|
expectRes: true,
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades", "10", "20", "--abcd", "34"},
|
|
upgradeInfo: upgradetypes.Plan{Name: "upgrade1", Info: "some info", Height: 34},
|
|
expectRes: false,
|
|
}}
|
|
|
|
for i := range cases {
|
|
tc := cases[i]
|
|
require := require.New(t)
|
|
h := cosmovisor.IsSkipUpgradeHeight(tc.args, tc.upgradeInfo)
|
|
require.Equal(h, tc.expectRes)
|
|
}
|
|
}
|
|
|
|
// TestUpgradeSkipHeights tests if correct skip upgrade heights are identified from the cli args
|
|
func TestUpgradeSkipHeights(t *testing.T) {
|
|
cases := []struct {
|
|
args []string
|
|
expectRes []int
|
|
}{{
|
|
args: []string{},
|
|
expectRes: nil,
|
|
}, {
|
|
args: []string{"appb", "start"},
|
|
expectRes: nil,
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades"},
|
|
expectRes: nil,
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades", "--abcd"},
|
|
expectRes: nil,
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades", "10", "--abcd"},
|
|
expectRes: []int{10},
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades", "10", "20", "--abcd"},
|
|
expectRes: []int{10, 20},
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades", "10", "20", "--abcd", "34"},
|
|
expectRes: []int{10, 20},
|
|
}, {
|
|
args: []string{"appb", "start", "--unsafe-skip-upgrades", "10", "as", "20", "--abcd"},
|
|
expectRes: []int{10, 20},
|
|
}}
|
|
|
|
for i := range cases {
|
|
tc := cases[i]
|
|
require := require.New(t)
|
|
h := cosmovisor.UpgradeSkipHeights(tc.args)
|
|
require.Equal(h, tc.expectRes)
|
|
}
|
|
}
|