sq/cli/cmd_add_test.go

package cli_test

import (
	"context"
	"path/filepath"
	"testing"

	"github.com/neilotoole/sq/cli/testrun"

	"github.com/neilotoole/sq/libsq/core/options"

	"github.com/neilotoole/sq/testh/tutil"

	"github.com/neilotoole/sq/drivers/csv"
	"github.com/neilotoole/sq/drivers/mysql"
	"github.com/neilotoole/sq/drivers/postgres"
	"github.com/neilotoole/sq/drivers/sqlite3"
	"github.com/neilotoole/sq/drivers/sqlserver"
	"github.com/neilotoole/sq/testh/proj"
	"github.com/neilotoole/sq/testh/sakila"

	"github.com/stretchr/testify/require"

	"github.com/neilotoole/sq/libsq/source"
	"github.com/neilotoole/sq/testh"
)

func TestCmdAdd(t *testing.T) {
	t.Parallel()

	type query struct {
		// q is the SLQ query to execute
		q        string
		wantRows int
		wantCols int
	}

	actorDataQuery := &query{
		q:        ".data",
		wantRows: sakila.TblActorCount,
		wantCols: len(sakila.TblActorCols()),
	}

	th := testh.New(t)

	testCases := []struct {
		loc         string // first arg to "add" cmd
		driver      string // --driver flag
		handle      string // --handle flag
		wantHandle  string
		wantType    source.DriverType
		wantOptions options.Options
		wantErr     bool
		query       *query
	}{
		{
			loc:     "",
			wantErr: true,
		},
		{
			loc:     "   ",
			wantErr: true,
		},
		{
			loc:     "/",
			wantErr: true,
		},
		{
			loc:     "../../",
			wantErr: true,
		},
		{
			loc:     "does/not/exist",
			wantErr: true,
		},
		{
			loc:     "_",
			wantErr: true,
		},
		{
			loc:     ".",
			wantErr: true,
		},
		{
			loc:     "/",
			wantErr: true,
		},
		{
			loc:     "../does/not/exist.csv",
			wantErr: true,
		},
		{
			loc:        proj.Rel(sakila.PathCSVActor),
			handle:     "@h1",
			wantHandle: "@h1",
			wantType:   csv.TypeCSV,
			query:      actorDataQuery,
		},
		{
			loc:        proj.Abs(sakila.PathCSVActor),
			handle:     "@h1",
			wantHandle: "@h1",
			wantType:   csv.TypeCSV,
		},
		{
			loc:        proj.Abs(sakila.PathCSVActor),
			wantHandle: "@actor",
			wantType:   csv.TypeCSV,
		},
		{
			loc:        proj.Abs(sakila.PathCSVActor),
			driver:     "csv",
			wantHandle: "@actor",
			wantType:   csv.TypeCSV,
		},
		{
			loc:     proj.Abs(sakila.PathCSVActor),
			driver:  "xlsx",
			wantErr: true,
		},
		{
			loc:        proj.Rel(sakila.PathTSVActor),
			handle:     "@h1",
			wantHandle: "@h1",
			wantType:   csv.TypeTSV,
			query:      actorDataQuery,
		},
		{
			loc:        proj.Rel(sakila.PathTSVActorNoHeader),
			handle:     "@h1",
			wantHandle: "@h1",
			wantType:   csv.TypeTSV,
			query:      actorDataQuery,
		},
		{
			// sqlite can be added both with and without the scheme "sqlite://"
			loc:        "sqlite3://" + proj.Abs(sakila.PathSL3),
			wantHandle: "@sakila",
			wantType:   sqlite3.Type,
		},

		{
			// with scheme
			loc:        proj.Abs(sakila.PathSL3),
			wantHandle: "@sakila",
			wantType:   sqlite3.Type,
		},

		{
			// without scheme, abs path
			loc:        proj.Rel(sakila.PathSL3),
			wantHandle: "@sakila",
			wantType:   sqlite3.Type,
		},
		{
			// without scheme, relative path
			loc:        th.Source(sakila.Pg).Location,
			wantHandle: "@sakila",
			wantType:   postgres.Type,
		},
		{
			loc:        th.Source(sakila.MS).Location,
			wantHandle: "@sakila",
			wantType:   sqlserver.Type,
		},
		{
			loc:        th.Source(sakila.My).Location,
			wantHandle: "@sakila",
			wantType:   mysql.Type,
		},
		{
			loc:     proj.Abs(sakila.PathCSVActor),
			handle:  source.StdinHandle, // reserved handle
			wantErr: true,
		},

		{
			loc:     proj.Abs(sakila.PathCSVActor),
			handle:  source.ActiveHandle, // reserved handle
			wantErr: true,
		},

		{
			loc:     proj.Abs(sakila.PathCSVActor),
			handle:  source.ScratchHandle, // reserved handle
			wantErr: true,
		},
		{
			loc:     proj.Abs(sakila.PathCSVActor),
			handle:  source.JoinHandle, // reserved handle
			wantErr: true,
		},
	}

	for _, tc := range testCases {
		tc := tc

		t.Run(tutil.Name(tc.wantHandle, tc.loc, tc.driver), func(t *testing.T) {
			t.Parallel()

			args := []string{"add", tc.loc}
			if tc.handle != "" {
				args = append(args, "--handle="+tc.handle)
			}
			if tc.driver != "" {
				args = append(args, "--driver="+tc.driver)
			}

			tr := testrun.New(th.Context, t, nil)
			err := tr.Exec(args...)
			if tc.wantErr {
				require.Error(t, err)
				return
			}

			require.NoError(t, err)

			// Verify that the src was actually added
			gotSrc, err := tr.Run.Config.Collection.Get(tc.wantHandle)
			require.NoError(t, err)
			require.Equal(t, tc.wantHandle, gotSrc.Handle)
			require.Equal(t, tc.wantType, gotSrc.Type)
			require.Equal(t, len(tc.wantOptions), len(gotSrc.Options))

			if tc.query == nil {
				return
			}

			tr = testrun.New(th.Context, t, tr)
			err = tr.Exec(tc.query.q, "--json")
			var results []map[string]any
			tr.Bind(&results)
			require.NoError(t, err)
			require.Equal(t, tc.query.wantRows, len(results))
			if tc.query.wantRows > 0 {
				require.Equal(t, tc.query.wantCols, len(results[0]))
			}
		})
	}
}

// TestCmdAdd_SQLite_Path has additional tests for sqlite paths.
func TestCmdAdd_SQLite_Path(t *testing.T) {
	t.Parallel()
	ctx := context.Background()

	const h1 = `@s1`

	tr := testrun.New(ctx, t, nil)
	require.NoError(t, tr.Exec("add", "-j", "sqlite3://test.db", "--handle", h1))
	got := tr.BindMap()

	absPath, err := filepath.Abs("test.db")
	require.NoError(t, err)
	absPath = filepath.ToSlash(absPath)

	wantLoc := "sqlite3://" + absPath
	require.Equal(t, wantLoc, got["location"])
}

func TestCmdAdd_Active(t *testing.T) {
	t.Parallel()
	ctx := context.Background()

	const h1, h2, h3, h4 = "@h1", "@h2", "@h3", "@h4"

	// Verify that initially there are no sources.
	tr := testrun.New(ctx, t, nil)
	require.NoError(t, tr.Exec("ls"))
	require.Zero(t, tr.Out.Len())

	// Add a new source. It should become the active source.
	tr = testrun.New(ctx, t, tr)
	require.NoError(t, tr.Exec("add", proj.Abs(sakila.PathCSVActor), "--handle", h1))
	tr = testrun.New(ctx, t, tr)
	require.NoError(t, tr.Exec("src", "-j"))
	m := tr.BindMap()
	require.Equal(t, h1, m["handle"])

	// Add a second src, without the --active flag. The active src
	// should remain h1.
	tr = testrun.New(ctx, t, tr)
	require.NoError(t, tr.Exec("add", proj.Abs(sakila.PathCSVActor), "--handle", h2))
	tr = testrun.New(ctx, t, tr)
	require.NoError(t, tr.Exec("src", "-j"))
	m = tr.BindMap()
	require.Equal(t, h1, m["handle"], "active source should still be %s", h1)

	// Add a third src, this time with the --active flag. The active src
	// should become h3.
	tr = testrun.New(ctx, t, tr)
	require.NoError(t, tr.Exec("add", proj.Abs(sakila.PathCSVActor), "--handle", h3, "--active"))
	tr = testrun.New(ctx, t, tr)
	require.NoError(t, tr.Exec("src", "-j"))
	m = tr.BindMap()
	require.Equal(t, h3, m["handle"], "active source now be %s", h3)

	// Same again with a fourth src, but this time using the shorthand -a flag.
	tr = testrun.New(ctx, t, tr)
	require.NoError(t, tr.Exec("add", proj.Abs(sakila.PathCSVActor), "--handle", h4, "-a"))
	tr = testrun.New(ctx, t, tr)
	require.NoError(t, tr.Exec("src", "-j"))
	m = tr.BindMap()
	require.Equal(t, h4, m["handle"], "active source now be %s", h4)
}