helpers_for_test.go

package main_test

import (
	"bytes"
	"context"
	"encoding/json"
	"fmt"
	"io"
	"log/slog"
	"os"
	"path/filepath"
	"slices"
	"strings"
	"sync"
	"sync/atomic"
	"testing"
	"time"

	svrcmd "github.com/cosmos/cosmos-sdk/server/cmd"
	"github.com/gordian-engine/gcosmos/internal/copy/gtest"
	"github.com/gordian-engine/gcosmos/internal/gci"
	"github.com/spf13/cobra"
	"github.com/stretchr/testify/require"
)

var FixedMnemonics = [...]string{
	"abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon art",
	"ability ability ability ability ability ability ability ability ability ability ability ability ability ability ability ability ability ability ability ability ability ability ability able",
}

type ChainConfig struct {
	ID string

	NVals int

	// Affects only the validators.
	StakeStrategy StakeStrategy

	// How many "fixed accounts" to create.
	// The fixed accounts are created with mnemonics from the FixedMnemonics array.
	NFixedAccounts int

	FixedAccountInitialBalance uint64
}

type StakeStrategy func(idx int) string

func ConstantStakeStrategy(amount uint64) StakeStrategy {
	stake := fmt.Sprintf("%dstake", amount)
	return func(int) string {
		return stake
	}
}

func DecrementingStakeStrategy(initialCount uint64) StakeStrategy {
	return func(idx int) string {
		return fmt.Sprintf("%dstake", initialCount-uint64(idx))
	}
}

type Chain struct {
	RootCmds []CmdEnv

	FixedAddresses []string

	// Path to a canonical genesis.
	// This file must be treated as read-only.
	CanonicalGenesisPath string
}

func ConfigureChain(t *testing.T, ctx context.Context, cfg ChainConfig) Chain {
	t.Helper()

	if cfg.ID == "" {
		panic("test setup issue: ChainConfig.ID must not be empty")
	}

	if cfg.NVals <= 0 {
		panic("test setup issue: ChainConfig.NVals must be greater than zero")
	}

	if cfg.NFixedAccounts > len(FixedMnemonics) {
		panic(fmt.Errorf("got NFixedAccounts=%d but can only support up to %d (unless FixedMnemonics is updated)", cfg.NFixedAccounts, len(FixedMnemonics)))
	}

	rootCmds := make([]CmdEnv, cfg.NVals)
	keyAddresses := make([]string, cfg.NVals)

	log := gtest.NewLogger(t)

	for i := range cfg.NVals {
		// Each validator gets its own command environment
		// and therefore its own home directory.
		e := NewRootCmd(t, log.With("val_idx", i))
		rootCmds[i] = e

		// Each validator needs its own initialized config and genesis.
		valName := fmt.Sprintf("val%d", i)
		e.Run("init", valName, "--chain-id", cfg.ID).NoError(t)

		// Each validator needs its own key.
		res := e.Run("keys", "add", valName, "--output=json")
		res.NoError(t)

		// Collect the addresses from the JSON output.
		var keyOut keyAddOutput
		require.NoError(t, json.Unmarshal(res.Stdout.Bytes(), &keyOut))
		keyAddresses[i] = keyOut.Address
	}

	// Add each key address as a genesis account on the first validator's environment.
	// This is necessary for collect-gentxs later.
	for i, a := range keyAddresses {
		rootCmds[0].Run(
			"genesis", "add-genesis-account",
			a, cfg.StakeStrategy(i),
		).NoError(t)
	}

	var mnemonicDir string
	var fixedAddresses []string
	if cfg.NFixedAccounts > 0 {
		mnemonicDir = t.TempDir()
		fixedAddresses = make([]string, cfg.NFixedAccounts)
	}
	for i := range cfg.NFixedAccounts {
		m := FixedMnemonics[i]
		mPath := filepath.Join(mnemonicDir, fmt.Sprintf("%d.txt", i))
		require.NoError(t, os.WriteFile(mPath, []byte(m), 0o600))

		keyName := fmt.Sprintf("fixed%d", i)

		// Teach each validator environment about the fixed address keys.
		for j, e := range rootCmds {
			res := e.RunWithInput(
				strings.NewReader(m),
				"keys", "add", keyName, "--output=json", "--recover", "--source", mPath,
			)

			res.NoError(t)

			if j == 0 {
				var keyOut keyAddOutput
				require.NoError(t, json.Unmarshal(res.Stdout.Bytes(), &keyOut))
				fixedAddresses[i] = keyOut.Address
			}
		}

		// And add each fixed address as a genesis account.
		// This only needs to happen on the first validator.
		rootCmds[0].Run(
			"genesis", "add-genesis-account",
			keyName, fmt.Sprintf("%dstake", cfg.FixedAccountInitialBalance),
		).NoError(t)
	}

	// Add a gentx for every validator, to one shared temporary gentx directory.
	gentxDir := t.TempDir()
	for i, e := range rootCmds {
		valName := fmt.Sprintf("val%d", i)
		stake := cfg.StakeStrategy(i)
		if i > 0 {
			// The first validator has every genesis account already,
			// but each validator needs its own address as a genesis account
			// in order to do a gentx.
			e.Run(
				"genesis", "add-genesis-account",
				valName, stake,
			).NoError(t)
		}
		e.Run(
			"genesis", "gentx",
			"--chain-id", cfg.ID,
			"--output-document", filepath.Join(gentxDir, valName+".gentx.json"),
			valName, stake,
		).NoError(t)
	}

	// Collect the gentxs on the first validator, then copy it to the other validators.
	rootCmds[0].Run(
		"genesis", "collect-gentxs", "--gentx-dir", gentxDir,
	).NoError(t)

	writers := make([]io.Writer, cfg.NVals-1)
	for i := 1; i < cfg.NVals; i++ {
		gPath := filepath.Join(rootCmds[i].homeDir, "config", "genesis.json")
		f, err := os.Create(gPath)
		require.NoError(t, err)
		defer f.Close() // Yes, we are deferring a close in a loop here.
		writers[i-1] = f
	}

	origGenesisPath := filepath.Join(rootCmds[0].homeDir, "config", "genesis.json")

	origGF, err := os.Open(origGenesisPath)
	require.NoError(t, err)
	defer origGF.Close()

	_, err = io.Copy(io.MultiWriter(writers...), origGF)
	require.NoError(t, err)

	// Final configuration on every validator.
	for _, c := range rootCmds {
		// The gRPC server defaults to listening on port 9090,
		// and the test will fail if the gRPC server cannot bind,
		// so just use an anonymous port.
		// We are not disabling the server since we expect to need it for later tests anyway.
		c.Run("config", "set", "app", "grpc.address", "localhost:0", "--skip-validate").NoError(t)

		// The telemetry servers should be irrelevant for the gcosmos tests.
		// Something appears to be not respecting enable=false and resulting in contention on the port,
		// so we also just set them all to use port 0.
		c.Run("config", "set", "app", "telemetry.enable", "false", "--skip-validate").NoError(t)
		c.Run("config", "set", "app", "telemetry.address", "localhost:0", "--skip-validate").NoError(t)

		// We may enable the v2 REST API later,
		// but disable it for now to get tests passing.
		// Just like telemetry: something appears to be not respecting enable=false and resulting in contention on the port,
		// so we also just set them all to use port 0.
		c.Run("config", "set", "app", "rest.enable", "false", "--skip-validate").NoError(t)
		c.Run("config", "set", "app", "rest.address", "localhost:0", "--skip-validate").NoError(t)
	}

	return Chain{
		RootCmds: rootCmds,

		FixedAddresses: fixedAddresses,

		CanonicalGenesisPath: origGenesisPath,
	}
}

type ChainAddresses struct {
	HTTP []string
	GRPC []string

	// File containing the address of the seed node.
	// Only populated for chains with multiple validators.
	P2PSeedPath string
}

func (c Chain) Start(t *testing.T, ctx context.Context, nVals int) ChainAddresses {
	t.Helper()

	ca := ChainAddresses{
		HTTP: make([]string, nVals),
		GRPC: make([]string, nVals),
	}

	addrDir := t.TempDir()
	var seedAddrs string
	if nVals > 1 {
		// We only need to start a seed node when there are multiple validators.
		p2pSeedPath := filepath.Join(addrDir, "p2p.seed.txt")
		ca.P2PSeedPath = p2pSeedPath

		seedDone := make(chan struct{})
		go func() {
			defer close(seedDone)
			// Just discard the run result.
			// If the seed fails to start, we will have obvious failures later.
			_ = c.RootCmds[0].RunC(ctx, "gordian", "seed", p2pSeedPath)
		}()
		t.Cleanup(func() {
			<-seedDone
		})

		// The seed should start up relatively quickly.
		deadline := time.Now().Add(5 * time.Second)
		for time.Now().Before(deadline) {
			b, err := os.ReadFile(p2pSeedPath)
			if err != nil {
				if os.IsNotExist(err) {
					time.Sleep(20 * time.Millisecond)
					continue
				}
				t.Fatalf("failed to read p2p seed path file %q: %v", p2pSeedPath, err)
			}

			if !bytes.HasSuffix(b, []byte("\n")) {
				// Very unlikely partial write to file;
				// delay and try again.
				time.Sleep(20 * time.Millisecond)
				continue
			}

			// Otherwise it does end with a \n.
			// We will assume that we have sufficient addresses to connect to,
			// if there is at least one entry.
			seedAddrs = strings.TrimSuffix(string(b), "\n")
		}
	}

	// Now we start the validators.
	httpAddrFiles := make([]string, nVals)
	grpcAddrFiles := make([]string, nVals)

	var wg sync.WaitGroup
	wg.Add(nVals)
	for i := range nVals {
		httpAddrFiles[i] = filepath.Join(addrDir, fmt.Sprintf("http_addr_%d.txt", i))
		grpcAddrFiles[i] = filepath.Join(addrDir, fmt.Sprintf("grpc_addr_%d.txt", i))

		go func(i int) {
			defer wg.Done()

			startCmd := []string{"start"}
			if !gci.RunCometInsteadOfGordian {
				// Then include the HTTP and gRPC server flags.
				startCmd = append(
					startCmd,
					"--g-http-addr", "127.0.0.1:0",
					"--g-http-addr-file", httpAddrFiles[i],

					"--g-grpc-addr", "127.0.0.1:0",
					"--g-grpc-addr-file", grpcAddrFiles[i],
				)

				if nVals > 1 {
					// Only include the seed addresses when there are multiple validators.
					startCmd = append(startCmd, "--g-seed-addrs", seedAddrs)
				}

				startCmd = append(startCmd, c.RootCmds[i].sqlitePathArgs()...)
			}

			_ = c.RootCmds[i].RunC(ctx, startCmd...)
		}(i)
	}
	t.Cleanup(wg.Wait)

	// Now all the goroutines to start the servers should be running.
	// Gather their reported HTTP addresses.
	for i := range nVals {
		if gci.RunCometInsteadOfGordian {
			// Nothing to check in this mode.
			break
		}

		var httpAddr string
		deadline := time.Now().Add(5 * time.Second)
		for time.Now().Before(deadline) {
			a, err := os.ReadFile(httpAddrFiles[i])
			if err != nil {
				// Swallow the error and delay.
				time.Sleep(25 * time.Millisecond)
				continue
			}
			if !bytes.HasSuffix(a, []byte("\n")) {
				// Very unlikely incomplete write/read.
				time.Sleep(25 * time.Millisecond)
				continue
			}

			httpAddr = strings.TrimSuffix(string(a), "\n")
			break
		}

		if httpAddr == "" {
			t.Fatalf("did not read http address from %s in time", httpAddrFiles[i])
		}

		ca.HTTP[i] = httpAddr

		var grpcAddr string
		deadline = time.Now().Add(5 * time.Second)
		for time.Now().Before(deadline) {
			a, err := os.ReadFile(grpcAddrFiles[i])
			if err != nil {
				// Swallow the error and delay.
				time.Sleep(25 * time.Millisecond)
				continue
			}
			if !bytes.HasSuffix(a, []byte("\n")) {
				// Very unlikely incomplete write/read.
				time.Sleep(25 * time.Millisecond)
				continue
			}

			grpcAddr = strings.TrimSuffix(string(a), "\n")
			break
		}

		if grpcAddr == "" {
			t.Fatalf("did not read grpc address from %s in time", grpcAddrFiles[i])
		}

		ca.GRPC[i] = grpcAddr
	}

	return ca
}

var lateNodeCounter int32

func AddLateNode(
	t *testing.T,
	ctx context.Context,
	chainID string,
	canonicalGenesisPath string,
	seedPath string,
) (httpAddrFile string) {
	t.Helper()

	if chainID == "" {
		panic("test setup issue: chainID must not be empty")
	}

	lateIdx := atomic.AddInt32(&lateNodeCounter, 1)
	log := gtest.NewLogger(t).With("late_val_idx", lateIdx)

	e := NewRootCmd(t, log)
	valName := fmt.Sprintf("late_val_%d", lateIdx)

	e.Run("init", valName, "--chain-id", chainID).NoError(t)

	src, err := os.Open(canonicalGenesisPath)
	require.NoError(t, err)
	defer src.Close()

	dst, err := os.Create(filepath.Join(e.homeDir, "config", "genesis.json"))
	require.NoError(t, err)
	defer dst.Close()

	_, err = io.Copy(dst, src)
	require.NoError(t, err)
	_ = src.Close()
	_ = dst.Close()

	// Have to modify the config to not bind to 9090,
	// just like in ConfigureChain.
	e.Run("config", "set", "app", "grpc.address", "localhost:0", "--skip-validate").NoError(t)

	// Assuming it's okay to place junk files in the chain home.
	httpAddrFile = filepath.Join(e.homeDir, "http_addr.txt")

	seedAddrs, err := os.ReadFile(seedPath)
	require.NoError(t, err)

	done := make(chan struct{})
	go func() {
		defer close(done)

		startCmd := []string{"start"}
		if !gci.RunCometInsteadOfGordian {
			startCmd = append(
				startCmd,
				"--g-http-addr", "127.0.0.1:0",
				"--g-http-addr-file", httpAddrFile,

				"--g-seed-addrs", string(bytes.TrimSuffix(seedAddrs, []byte("\n"))),
			)
			startCmd = append(startCmd, e.sqlitePathArgs()...)
		}

		_ = e.RunC(ctx, startCmd...)
	}()
	t.Cleanup(func() {
		<-done
	})

	return httpAddrFile
}

func NewRootCmd(
	t *testing.T,
	log *slog.Logger,
) CmdEnv {
	t.Helper()

	return CmdEnv{
		log:     log,
		homeDir: t.TempDir(),
	}
}

type CmdEnv struct {
	log     *slog.Logger
	homeDir string
}

func (e CmdEnv) Run(args ...string) RunResult {
	return e.RunWithInput(nil, args...)
}

func (e CmdEnv) RunC(ctx context.Context, args ...string) RunResult {
	return e.RunWithInputC(ctx, nil, args...)
}

func (e CmdEnv) RunWithInput(in io.Reader, args ...string) RunResult {
	return e.RunWithInputC(context.Background(), in, args...)
}

func (e CmdEnv) RunWithInputC(ctx context.Context, in io.Reader, args ...string) RunResult {
	ctx, cancel := context.WithCancel(ctx)
	defer cancel()

	var cmd *cobra.Command

	args = append(
		slices.Clone(args),
		// Putting --home before the args would probably work,
		// but put --home at the end to be a little more sure
		// that it won't get ignored due to being parsed before the subcommand name.
		"--home", e.homeDir,
	)

	// Compile-time flag declared near top of this file.
	if gci.RunCometInsteadOfGordian {
		panic(fmt.Errorf("TODO: re-enable starting with comet (this simplifies cross-checking behavior"))
	} else {
		cmd = gci.NewGcosmosCommand(ctx, e.log, e.homeDir, args)
		cmd.SetArgs(args)
	}

	ctx = svrcmd.CreateExecuteContext(ctx)

	var res RunResult
	cmd.SetOut(&res.Stdout)
	cmd.SetErr(&res.Stderr)
	cmd.SetIn(in)

	res.Err = cmd.ExecuteContext(ctx)

	return res
}

func (e CmdEnv) sqlitePathArgs() []string {
	// Set the sqlite path based on the constants at the top of main_test.go.
	// (They are declared there for ease of discovery and editing.)
	switch {
	case useSQLiteInMem:
		return []string{"--g-sqlite-path", ":memory:"}
	case useMemStore:
		// Force it empty regardless of the default.
		return []string{"--g-sqlite-path="}
	default:
		// They can't both be set (because we would have panicked),
		// so use the homedir.
		return []string{"--g-sqlite-path", filepath.Join(e.homeDir, "gordian.sqlite")}
	}
}

type RunResult struct {
	Stdout, Stderr bytes.Buffer
	Err            error
}

func (r RunResult) NoError(t *testing.T) {
	t.Helper()

	require.NoErrorf(t, r.Err, "OUT: %s\n\nERR: %s", r.Stdout.String(), r.Stderr.String())
}

// keyAddOutput is used for unmarshaling the output of the keys add command,
// so that we can collect the bech32 address for the key that was added.
type keyAddOutput struct {
	Address string
}