change(test): make tests faster by using internal/shell and keeping same db connection over entire suite

Author: Luis Silva

test/root_command_exec_test.go

@@ -26,6 +26,10 @@ func (s *RootCommandExecSuite) SetupSuite() {
 	s.tc.DropAllTables()
 }
 
+func (s *RootCommandExecSuite) TearDownSuite() {
+	s.tc.Close()
+}
+
 func (s *RootCommandExecSuite) TearDownTest() {
 	s.tc.DropAllTables()
 }

test/root_command_flags_test.go

@@ -15,7 +15,7 @@ func TestRootCommandFlags_WhenAllFlagsAreProvided_ExpectSQLStatementsExecutedWit
 	dbPath := c.TempDir() + `\test.sqlite`
 	rootCmd := cmd.NewRootCmd()
 
-	_, _, err := utils.Execute(t, rootCmd, "--exec", "CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT);", dbPath)
+	_, _, err := utils.ExecuteCobraCommand(t, rootCmd, "--exec", "CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT);", dbPath)
 
 	c.Assert(err, qt.IsNil)
 }
@@ -25,16 +25,18 @@ func TestRootCommandFlags_WhenDbIsMissing_ExpectErrorReturned(t *testing.T) {
 
 	rootCmd := cmd.NewRootCmd()
 
-	_, _, err := utils.Execute(t, rootCmd, "--exec", "CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT);")
+	_, _, err := utils.ExecuteCobraCommand(t, rootCmd, "--exec", "CREATE TABLE test (id INTEGER PRIMARY KEY, value TEXT);")
 
 	c.Assert(err.Error(), qt.Equals, `accepts 1 arg(s), received 0`)
 }
 
 func TestRootCommandFlags_GivenEmptyStatements_ExpectErrorReturned(t *testing.T) {
-	dbPath := t.TempDir() + `\test.sqlite`
-	tc := utils.NewTestContext(t, dbPath)
+	c := qt.New(t)
+
+	dbPath := c.TempDir() + `\test.sqlite`
+	rootCmd := cmd.NewRootCmd()
 
-	_, _, err := tc.Execute("")
+	_, _, err := utils.ExecuteCobraCommand(t, rootCmd, "--exec", "", dbPath)
 
-	tc.Assert(err.Error(), qt.IsNotNil)
+	c.Assert(err.Error(), qt.IsNotNil)
 }

test/root_command_shell_test.go

@@ -25,6 +25,10 @@ func (s *RootCommandShellSuite) SetupSuite() {
 	s.tc.DropAllTables()
 }
 
+func (s *RootCommandShellSuite) TearDownSuite() {
+	s.tc.Close()
+}
+
 func (s *RootCommandShellSuite) TearDownTest() {
 	s.tc.DropAllTables()
 }

test/utils/db_test_context.go

@@ -1,35 +1,75 @@
 package utils
 
 import (
+	"bytes"
 	"fmt"
 	"os"
 	"strings"
 	"testing"
 
 	qt "github.com/frankban/quicktest"
 
-	"github.com/libsql/libsql-shell-go/internal/cmd"
+	"github.com/libsql/libsql-shell-go/internal/db"
+	"github.com/libsql/libsql-shell-go/internal/shell"
+	"github.com/libsql/libsql-shell-go/pkg/shell/enums"
 )
 
 type DbTestContext struct {
 	*testing.T
 	*qt.C
 
 	dbPath string
+
+	db *db.Db
 }
 
 func NewTestContext(t *testing.T, dbPath string) *DbTestContext {
-	return &DbTestContext{T: t, C: qt.New(t), dbPath: dbPath}
+	db, err := db.NewDb(dbPath)
+	if err != nil {
+		t.Fatalf("Fail to create new db")
+	}
+
+	return &DbTestContext{T: t, C: qt.New(t), dbPath: dbPath, db: db}
+}
+
+func (tc *DbTestContext) Close() {
+	tc.db.Close()
 }
 
 func (tc *DbTestContext) Execute(statements string) (string, string, error) {
-	rootCmd := cmd.NewRootCmd()
-	return Execute(tc.T, rootCmd, "--exec", statements, tc.dbPath)
+	bufOut, bufErr, config := tc.createShellConfig("")
+	shellInstance, err := shell.NewShell(config, tc.db)
+	if err != nil {
+		tc.T.Fatalf("Fail to create new shell")
+	}
+
+	executionError := shellInstance.ExecuteCommandOrStatements(statements)
+	return strings.TrimSpace(bufOut.String()), strings.TrimSpace(bufErr.String()), executionError
 }
 
 func (tc *DbTestContext) ExecuteShell(commands []string) (outS string, errS string, err error) {
-	rootCmd := cmd.NewRootCmd()
-	return ExecuteWithInitialInput(tc.T, rootCmd, strings.Join(commands, "\n"), tc.dbPath, "--quiet")
+	bufOut, bufErr, config := tc.createShellConfig(strings.Join(commands, "\n"))
+	shellInstance, err := shell.NewShell(config, tc.db)
+	if err != nil {
+		tc.T.Fatalf("Fail to create new shell")
+	}
+
+	executionError := shellInstance.Run()
+	return strings.TrimSpace(bufOut.String()), strings.TrimSpace(bufErr.String()), executionError
+}
+
+func (tc *DbTestContext) createShellConfig(initialInput string) (bufOut *bytes.Buffer, bufErr *bytes.Buffer, config shell.ShellConfig) {
+	bufOut = new(bytes.Buffer)
+	bufErr = new(bytes.Buffer)
+	bufIn := new(bytes.Buffer)
+
+	_, err := bufIn.Write([]byte(initialInput))
+	if err != nil {
+		tc.T.Fatalf("Fail to write inside initial buffer")
+	}
+
+	config = shell.ShellConfig{InF: bufIn, OutF: bufOut, ErrF: bufErr, HistoryMode: enums.SingleHistory, QuietMode: true}
+	return
 }
 
 func (tc *DbTestContext) CreateEmptySimpleTable(tableName string) {

test/utils/utils.go

@@ -9,11 +9,11 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func Execute(t *testing.T, c *cobra.Command, args ...string) (string, string, error) {
-	return ExecuteWithInitialInput(t, c, "", args...)
+func ExecuteCobraCommand(t *testing.T, c *cobra.Command, args ...string) (string, string, error) {
+	return ExecuteCobraCommandWithInitialInput(t, c, "", args...)
 }
 
-func ExecuteWithInitialInput(t *testing.T, c *cobra.Command, initialInput string, args ...string) (string, string, error) {
+func ExecuteCobraCommandWithInitialInput(t *testing.T, c *cobra.Command, initialInput string, args ...string) (string, string, error) {
 	t.Helper()
 
 	bufOut := new(bytes.Buffer)