world_fixture.go

package cardinal

import (
	"bytes"
	"context"
	"encoding/json"
	"fmt"
	"net"
	"net/http"
	"os"
	"strconv"
	"strings"
	"sync"
	"testing"
	"time"

	"github.com/alicebob/miniredis/v2"
	"github.com/rotisserie/eris"
	"github.com/spf13/viper"
	"gotest.tools/v3/assert"

	"pkg.world.dev/world-engine/cardinal/persona/msg"
	"pkg.world.dev/world-engine/cardinal/types"
	"pkg.world.dev/world-engine/sign"
)

// TestFixture is a helper struct that manages a cardinal.World instance. It will automatically clean up its resources
// at the end of the test.
type TestFixture struct {
	testing.TB

	// Base url is something like "localhost:5050". You must attach http:// or ws:// as well as a resource path
	BaseURL string
	World   *World
	Redis   *miniredis.Miniredis

	StartTickCh chan time.Time
	DoneTickCh  chan uint64
	doCleanup   func()
	startOnce   *sync.Once
}

// NewTestFixture creates a test fixture with user defined port for Cardinal integration tests.
func NewTestFixture(t testing.TB, redis *miniredis.Miniredis, opts ...WorldOption) *TestFixture {
	if redis == nil {
		redis = miniredis.RunT(t)
	}

	ports, err := findOpenPorts(2) //nolint:gomnd
	assert.NilError(t, err)

	cardinalPort := ports[0]
	evmPort := ports[1]

	t.Setenv("BASE_SHARD_SEQUENCER_ADDRESS", "localhost:"+evmPort)
	t.Setenv("CARDINAL_LOG_PRETTY", "true")
	t.Setenv("REDIS_ADDRESS", redis.Addr())

	startTickCh, doneTickCh := make(chan time.Time), make(chan uint64)

	defaultOpts := []WorldOption{
		WithTickChannel(startTickCh),
		WithTickDoneChannel(doneTickCh),
		WithPort(cardinalPort),
		WithMockJobQueue(),
	}

	// Default options go first so that any user supplied options overwrite the defaults.
	world, err := NewWorld(append(defaultOpts, opts...)...)
	assert.NilError(t, err)

	return &TestFixture{
		TB:      t,
		BaseURL: "localhost:" + cardinalPort,
		World:   world,
		Redis:   redis,

		StartTickCh: startTickCh,
		DoneTickCh:  doneTickCh,
		startOnce:   &sync.Once{},
		// Only register this method with t.Cleanup if the game server is actually started
		doCleanup: func() {
			viper.Reset()

			// Optionally, you can also clear environment variables if needed
			for _, key := range viper.AllKeys() {
				err := os.Unsetenv(key)
				if err != nil {
					t.Errorf("failed to unset env var %s: %v", key, err)
				}
			}

			// First, make sure completed ticks will never be blocked
			go func() {
				for range doneTickCh { //nolint:revive // This pattern drains the channel until closed
				}
			}()

			// Next, shut down the world
			world.Shutdown()

			// The world is shut down; No more ticks will be started
			close(startTickCh)
		},
	}
}

// StartWorld starts the game world and registers a cleanup function that will shut down
// the cardinal World at the end of the test. Components/Systems/Queries, etc should
// be registered before calling this function.
func (t *TestFixture) StartWorld() {
	t.startOnce.Do(func() {
		timeout := time.After(5 * time.Second) //nolint:gomnd // fine for now.
		startupError := make(chan error)
		go func() {
			// StartGame is meant to block forever, so any return value will be non-nil and cause for concern.
			// Also, calling t.Fatal from a non-main thread only reports a failure once the test on the main thread has
			// completed. By sending this error out on a channel we can fail the test right away (assuming doTick
			// has been called from the main thread).
			startupError <- t.World.StartGame()
		}()
		for !t.World.IsGameRunning() {
			select {
			case err := <-startupError:
				t.Fatalf("startup error: %v", err)
			case <-timeout:

				t.Fatal("timeout while waiting for game to start")
			default:
				time.Sleep(10 * time.Millisecond) //nolint:gomnd // its for testing its ok.
			}
		}
		t.Cleanup(t.doCleanup)
	})
}

// DoTick executes one game tick and blocks until the tick is complete. StartWorld is automatically called if it was
// not called before the first tick.
func (t *TestFixture) DoTick() {
	t.StartWorld()
	t.StartTickCh <- time.Now()
	<-t.DoneTickCh
}

func (t *TestFixture) httpURL(path string) string {
	return fmt.Sprintf("http://%s/%s", t.BaseURL, path)
}

// Post executes a http POST request to this TextFixture's cardinal server.
func (t *TestFixture) Post(path string, payload any) *http.Response {
	bz, err := json.Marshal(payload)
	assert.NilError(t, err)
	req, err := http.NewRequestWithContext(
		context.Background(),
		http.MethodPost,
		t.httpURL(strings.Trim(path, "/")),
		bytes.NewReader(bz),
	)
	assert.NilError(t, err)
	req.Header.Add("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	assert.NilError(t, err)
	return resp
}

// Get executes a http GET request to this TestFixture's cardinal server.
func (t *TestFixture) Get(path string) *http.Response {
	req, err := http.NewRequestWithContext(context.Background(), http.MethodGet, t.httpURL(strings.Trim(path, "/")),
		nil)
	assert.NilError(t, err)
	resp, err := http.DefaultClient.Do(req)
	assert.NilError(t, err)
	return resp
}

func (t *TestFixture) AddTransaction(txID types.MessageID, tx any, sigs ...*sign.Transaction) types.TxHash {
	sig := &sign.Transaction{}
	if len(sigs) > 0 {
		sig = sigs[0]
	}
	_, id := t.World.AddTransaction(txID, tx, sig)
	return id
}

func (t *TestFixture) CreatePersona(personaTag, signerAddr string) {
	personaMsg := msg.CreatePersona{
		PersonaTag:    personaTag,
		SignerAddress: signerAddr,
	}
	createPersonaMsg, exists := t.World.GetMessageByFullName("persona." + msg.CreatePersonaMessageName)
	assert.Check(
		t,
		exists,
		"message with name %q not registered in World", msg.CreatePersonaMessageName,
	)
	t.AddTransaction(createPersonaMsg.ID(), personaMsg, &sign.Transaction{})
	t.DoTick()
}

// findOpenPorts finds a set of open ports and returns them as a slice of strings.
// It is guaranteed that the returned slice will have the amount of ports requested and that there is no duplicate
// ports in the slice.
func findOpenPorts(amount int) ([]string, error) {
	ports := make([]string, 0, amount)

	// Try to find open ports until we find the target amount or we run out of retries
	for i := 0; i < amount; i++ {
		var found bool

		// Try to find a random port, retying if it turns out to be a duplicate in list of ports up to 10 times
		for retries := 10; retries > 0; retries-- {
			port, err := findOpenPort()
			if err != nil {
				continue
			}

			// Check for duplicate ports
			for _, existingPort := range ports {
				if port == existingPort {
					continue
				}
			}

			// Add the port to the list and break out of the inner loop
			ports = append(ports, port)
			found = true
			break
		}

		if !found {
			return nil, eris.New("failed to find open ports after retries")
		}
	}

	return ports, nil
}

// findOpenPort finds an open port and returns it as a string.
// If you need to find multiple ports, use findOpenPorts to make sure that the ports are unique.
func findOpenPort() (string, error) {
	findFn := func() (string, error) {
		// Try to get a random port using the wildcard 0 port
		l, err := net.Listen("tcp", "127.0.0.1:0")
		if err != nil {
			return "", eris.Wrap(err, "failed to initialize listener")
		}

		// Get the autoamtically assigned port number from the listener
		tcpAddr, err := net.ResolveTCPAddr(l.Addr().Network(), l.Addr().String())
		if err != nil {
			return "", eris.Wrap(err, "failed to resolve address")
		}

		// Close the listener when the function returns
		err = l.Close()
		if err != nil {
			return "", eris.Wrap(err, "failed to close listener")
		}
		return strconv.Itoa(tcpAddr.Port), nil
	}

	for retries := 10; retries > 0; retries-- {
		port, err := findFn()
		if err == nil {
			return port, nil
		}
		time.Sleep(10 * time.Millisecond) //nolint:gomnd // it's fine.
	}

	return "", eris.New("failed to find an open port")
}