db_test.go

package integration

// Basic imports
import (
	"context"
	"io"
	"net/http"
	"os"
	"path/filepath"
	"sync"
	"testing"

	"github.com/gin-gonic/gin"
	gonanoid "github.com/matoous/go-nanoid/v2"
	"github.com/spf13/cobra"
	"github.com/stretchr/testify/require"
	"github.com/stretchr/testify/suite"
	clicmd "github.com/supabase/cli/cmd"
	"github.com/supabase/cli/test/mocks/docker"
)

type DBTestSuite struct {
	suite.Suite
	cmd     *cobra.Command
	tempDir string
	ids     []string
	bodies  []string
	params  []gin.Params
	mtx     sync.RWMutex
}

// test functions
// add tests here <-

// hooks
func (suite *DBTestSuite) SetupTest() {
	suite.tempDir = NewTempDir(Logger, TempDir)
	suite.mtx.Lock()
	suite.ids = []string{}
	suite.bodies = []string{}
	suite.params = []gin.Params{}
	suite.mtx.Unlock()

	// add docker mock handlers
	DockerMock.ExecCreateHandler = func(c *gin.Context) {
		suite.addParams(c.Copy())
		body, err := io.ReadAll(c.Request.Body)
		if err != nil {
			c.JSON(http.StatusBadRequest, gin.H{
				"message": "error reading body",
			})
			return
		}
		suite.addBody(body)

		id := gonanoid.MustGenerate(docker.IDAlphabet, docker.IDLength)
		c.JSON(http.StatusCreated, gin.H{
			"Id": id,
		})
		suite.addID(id)
	}

	DockerMock.ExecStartHandler = func(c *gin.Context) {
		suite.addParams(c.Copy())
		body, err := io.ReadAll(c.Request.Body)
		if err != nil {
			c.JSON(http.StatusBadRequest, gin.H{
				"message": "error reading body",
			})
			return
		}
		suite.addBody(body)

		docker.HijackedResponse(c, "0")
	}

	DockerMock.ContainerInspectHandler = func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{})
	}

	// create supabase dir
	suite.cmd = clicmd.GetRootCmd()
	init, _, err := suite.cmd.Find([]string{"init"})
	require.NoError(suite.T(), err)
	init.SetContext(context.Background())
	err = init.RunE(init, []string{})
	require.NoError(suite.T(), err)

	err = os.Mkdir("supabase/.branches", os.FileMode(0755))
	require.NoError(suite.T(), err)
}

func (suite *DBTestSuite) TeardownTest() {
	require.NoError(suite.T(), os.Chdir(TempDir))
}

// In order for 'go test' to run this suite, we need to create
// a normal test function and pass our suite to suite.Run
func TestDBTestSuite(t *testing.T) {
	suite.Run(t, new(DBTestSuite))
}

// helper functions
func (suite *DBTestSuite) addParams(c *gin.Context) {
	suite.mtx.Lock()
	defer suite.mtx.Unlock()
	suite.params = append(suite.params, c.Params)
}

func (suite *DBTestSuite) addBody(body []byte) {
	suite.mtx.Lock()
	defer suite.mtx.Unlock()
	suite.bodies = append(suite.bodies, string(body))
}

func (suite *DBTestSuite) addID(id string) {
	suite.mtx.Lock()
	defer suite.mtx.Unlock()
	suite.ids = append(suite.ids, id)
}

func (suite *DBTestSuite) constructParams() []gin.Params {
	ids := []gin.Params{}
	// for each exec docker call we have to calls to docker api:
	// one to create exec, one to start exec
	for _, id := range suite.ids {
		// this one represents call to create exec
		ids = append(ids, gin.Params{
			gin.Param{
				Key:   "id",
				Value: "supabase_db_" + filepath.Base(suite.tempDir),
			},
		})

		// this one represents call to start exec
		ids = append(ids, gin.Params{
			gin.Param{
				Key:   "id",
				Value: id,
			},
		})
	}
	return ids
}