Added SQLREPLTestSuite

Signed-off-by: Lou Marvin Caraig <[email protected]>

Author: se7entyse7en

cmd/srcd/cmd/sql_test.go

@@ -5,24 +5,225 @@ package cmd
 import (
 	"bytes"
 	"context"
+	"fmt"
 	"io"
 	"io/ioutil"
 	"log"
 	"os"
 	"os/exec"
 	"path"
 	"path/filepath"
+	"regexp"
 	"strings"
 	"testing"
 	"time"
 
+	"github.com/kr/pty"
 	cmdtest "github.com/src-d/engine/cmd/test-utils"
-
+	"github.com/src-d/engine/components"
+	"github.com/src-d/engine/docker"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 )
 
+var showTablesOutput = sqlOutput(`+--------------+
+| Table        |
++--------------+
+| blobs        |
+| commit_blobs |
+| commit_files |
+| commit_trees |
+| commits      |
+| files        |
+| ref_commits  |
+| refs         |
+| remotes      |
+| repositories |
+| tree_entries |
++--------------+
+`)
+
+var showRepoTableDescOutput = sqlOutput(`+---------------+------+
+| name          | type |
++---------------+------+
+| repository_id | TEXT |
++---------------+------+
+`)
+
+type SQLREPLTestSuite struct {
+	cmdtest.IntegrationSuite
+	testDir string
+}
+
+func TestSQLREPLTestSuite(t *testing.T) {
+	s := SQLREPLTestSuite{}
+	suite.Run(t, &s)
+}
+
+func (s *SQLREPLTestSuite) SetupTest() {
+	var err error
+	s.testDir, err = ioutil.TempDir("", "sql-repl-test")
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
+func (s *SQLREPLTestSuite) TearDownTest() {
+	s.RunCommand(context.Background(), "prune")
+	os.RemoveAll(s.testDir)
+}
+
+func (s *SQLREPLTestSuite) TestREPL() {
+	// When it is not in a terminal, the command reads stdin and exits.
+	// You can see it running:
+	//     $ echo "show tables;" | ./srcd sql
+	// So this test does not really interacts with the REPL prompt, but we still
+	// test that the code that processes each read line is working as expected.
+
+	require := s.Require()
+
+	var out, in bytes.Buffer
+
+	command := s.CommandContext(context.TODO(), "sql")
+	command.Stdout = &out
+	command.Stderr = &out
+	command.Stdin = &in
+
+	io.WriteString(&in, "show tables;\n")
+	io.WriteString(&in, "describe table repositories;\n")
+
+	err := command.Start()
+	require.NoError(err)
+
+	err = command.Wait()
+	require.NoError(err)
+
+	require.Contains(out.String(), showTablesOutput)
+	require.Contains(out.String(), showRepoTableDescOutput)
+}
+
+func (s *SQLREPLTestSuite) TestInteractiveREPL() {
+	require := s.Require()
+
+	command, stdin, ch := s.runInteractiveRepl()
+
+	res := s.runInteractiveQuery(stdin, "show tables;\n", ch)
+	require.Contains(res, showTablesOutput)
+
+	res = s.runInteractiveQuery(stdin, "describe table repositories;\n", ch)
+	require.Contains(res, showRepoTableDescOutput)
+
+	require.NoError(s.exitInteractiveAndWait(10*time.Second, stdin, ch))
+	require.NoError(s.waitMysqlCliContainerStopped(10 * time.Second))
+
+	command.Wait()
+}
+
+func (s *SQLREPLTestSuite) runInteractiveRepl() (*exec.Cmd, *os.File, <-chan string) {
+	s.T().Helper()
+
+	command := s.CommandContext(context.TODO(), "sql")
+
+	ch := make(chan string)
+	cr := cmdtest.NewChannelWriter(ch)
+
+	command.Stdout = cr
+	command.Stderr = cr
+
+	f, err := pty.Start(command)
+	if err != nil {
+		panic(err)
+	}
+
+	mysqlCliReady := make(chan struct{})
+
+	go func() {
+		for s := range ch {
+			lines := strings.Split(s, "\n")
+			for _, l := range lines {
+				if strings.HasPrefix(l, "mysql>") {
+					mysqlCliReady <- struct{}{}
+					return
+				}
+			}
+		}
+	}()
+
+	<-mysqlCliReady
+
+	return command, f, ch
+}
+
+func (s *SQLREPLTestSuite) runInteractiveQuery(stdin *os.File, query string, ch <-chan string) string {
+	io.WriteString(stdin, query)
+
+	var res strings.Builder
+	for c := range ch {
+		fmt.Printf("Message: %s\n", c)
+		res.WriteString(c)
+		if s.containsSQLOutput(res.String()) {
+			break
+		}
+	}
+
+	return res.String()
+}
+
+func (s *SQLREPLTestSuite) exitInteractiveAndWait(timeout time.Duration, stdin *os.File, ch <-chan string) error {
+	io.WriteString(stdin, "exit;\n")
+
+	done := make(chan struct{})
+	go func() {
+		for c := range ch {
+			if strings.Contains(c, "Bye") {
+				done <- struct{}{}
+				// don't return in order to consume all output and let the process exit
+			}
+		}
+	}()
+
+	select {
+	case <-done:
+		stdin.Close()
+		return nil
+	case <-time.After(timeout):
+		return fmt.Errorf("timeout of %v elapsed while waiting to exit", timeout)
+	}
+}
+
+func (s *SQLREPLTestSuite) waitMysqlCliContainerStopped(timeout time.Duration) error {
+	done := make(chan struct{})
+	go func() {
+		for {
+			running, err := docker.IsRunning(components.MysqlCli.Name, "")
+			if !running {
+				done <- struct{}{}
+				return
+			}
+
+			if err != nil {
+				panic(err)
+			}
+
+			time.Sleep(timeout / 5)
+		}
+	}()
+
+	select {
+	case <-done:
+		return nil
+	case <-time.After(timeout):
+		return fmt.Errorf("timeout of %v elapsed while waiting to stop container", timeout)
+	}
+}
+
+func (s *SQLREPLTestSuite) containsSQLOutput(out string) bool {
+	sep := regexp.MustCompile(`\+[-]+\+`)
+	matches := sep.FindAllStringIndex(out, -1)
+	return len(matches) == 3
+}
+
 type SQLTestSuite struct {
 	cmdtest.IntegrationSuite
 	testDir string
@@ -46,23 +247,6 @@ func (s *SQLTestSuite) TearDownTest() {
 	os.RemoveAll(s.testDir)
 }
 
-var showTablesOutput = sqlOutput(`+--------------+
-| Table        |
-+--------------+
-| blobs        |
-| commit_blobs |
-| commit_files |
-| commit_trees |
-| commits      |
-| files        |
-| ref_commits  |
-| refs         |
-| remotes      |
-| repositories |
-| tree_entries |
-+--------------+
-`)
-
 func (s *SQLTestSuite) TestInit() {
 	require := s.Require()
 
@@ -165,55 +349,6 @@ func (s *SQLTestSuite) TestWrongQuery() {
 	}
 }
 
-func (s *SQLTestSuite) TestREPL() {
-	// When it is not in a terminal, the command reads stdin and exits.
-	// You can see it running:
-	//     $ echo "show tables;" | ./srcd sql
-	// So this test does not really interacts with the REPL prompt, but we still
-	// test that the code that processes each read line is working as expected.
-
-	require := s.Require()
-
-	var out, in bytes.Buffer
-
-	command := s.CommandContext(context.TODO(), "sql")
-	command.Stdout = &out
-	command.Stderr = &out
-	command.Stdin = &in
-
-	io.WriteString(&in, "show tables;\n")
-	io.WriteString(&in, "describe table repositories;\n")
-
-	err := command.Start()
-	require.NoError(err)
-
-	err = command.Wait()
-	require.NoError(err)
-
-	expected := sqlOutput(`+--------------+
-| Table        |
-+--------------+
-| blobs        |
-| commit_blobs |
-| commit_files |
-| commit_trees |
-| commits      |
-| files        |
-| ref_commits  |
-| refs         |
-| remotes      |
-| repositories |
-| tree_entries |
-+--------------+
-+---------------+------+
-| name          | type |
-+---------------+------+
-| repository_id | TEXT |
-+---------------+------+`)
-
-	require.Contains(out.String(), expected)
-}
-
 func (s *SQLTestSuite) TestIndexesWorkdirChange() {
 	require := s.Require()
 

cmd/test-utils/common.go

@@ -164,3 +164,16 @@ func TraceLogMessages(fn func(), memLog *bytes.Buffer) []LogMessage {
 
 	return result
 }
+
+type ChannelWriter struct {
+	ch chan string
+}
+
+func NewChannelWriter(ch chan string) *ChannelWriter {
+	return &ChannelWriter{ch: ch}
+}
+
+func (cr *ChannelWriter) Write(b []byte) (int, error) {
+	cr.ch <- string(b)
+	return len(b), nil
+}