databricks-cli/internal/fs_ls_test.go

package internal

import (
	"context"
	"encoding/json"
	"io/fs"
	"path"
	"regexp"
	"strings"
	"testing"

	_ "github.com/databricks/cli/cmd/fs"
	"github.com/databricks/cli/libs/filer"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

type fsTest struct {
	name       string
	setupFiler func(t *testing.T) (filer.Filer, string)
}

var fsTests = []fsTest{
	{
		name:       "dbfs",
		setupFiler: setupDbfsFiler,
	},
	{
		name:       "uc-volumes",
		setupFiler: setupUcVolumesFiler,
	},
}

func setupLsFiles(t *testing.T, f filer.Filer) {
	err := f.Write(context.Background(), "a/hello.txt", strings.NewReader("abc"), filer.CreateParentDirectories)
	require.NoError(t, err)
	err = f.Write(context.Background(), "bye.txt", strings.NewReader("def"))
	require.NoError(t, err)
}

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

	for _, testCase := range fsTests {
		tc := testCase

		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()

			f, tmpDir := tc.setupFiler(t)
			setupLsFiles(t, f)

			stdout, stderr := RequireSuccessfulRun(t, "fs", "ls", tmpDir, "--output=json")
			assert.Equal(t, "", stderr.String())

			var parsedStdout []map[string]any
			err := json.Unmarshal(stdout.Bytes(), &parsedStdout)
			require.NoError(t, err)

			// assert on ls output
			assert.Len(t, parsedStdout, 2)

			assert.Equal(t, "a", parsedStdout[0]["name"])
			assert.Equal(t, true, parsedStdout[0]["is_directory"])
			assert.Equal(t, float64(0), parsedStdout[0]["size"])

			assert.Equal(t, "bye.txt", parsedStdout[1]["name"])
			assert.Equal(t, false, parsedStdout[1]["is_directory"])
			assert.Equal(t, float64(3), parsedStdout[1]["size"])
		})
	}
}

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

	for _, testCase := range fsTests {
		tc := testCase

		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()

			f, tmpDir := tc.setupFiler(t)
			setupLsFiles(t, f)

			stdout, stderr := RequireSuccessfulRun(t, "fs", "ls", tmpDir, "--output=json", "--absolute")
			assert.Equal(t, "", stderr.String())

			var parsedStdout []map[string]any
			err := json.Unmarshal(stdout.Bytes(), &parsedStdout)
			require.NoError(t, err)

			// assert on ls output
			assert.Len(t, parsedStdout, 2)

			assert.Equal(t, path.Join(tmpDir, "a"), parsedStdout[0]["name"])
			assert.Equal(t, true, parsedStdout[0]["is_directory"])
			assert.Equal(t, float64(0), parsedStdout[0]["size"])

			assert.Equal(t, path.Join(tmpDir, "bye.txt"), parsedStdout[1]["name"])
			assert.Equal(t, false, parsedStdout[1]["is_directory"])
			assert.Equal(t, float64(3), parsedStdout[1]["size"])
		})
	}
}

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

	for _, testCase := range fsTests {
		tc := testCase

		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()
			f, tmpDir := tc.setupFiler(t)
			setupLsFiles(t, f)

			_, _, err := RequireErrorRun(t, "fs", "ls", path.Join(tmpDir, "a", "hello.txt"), "--output=json")
			assert.Regexp(t, regexp.MustCompile("not a directory: .*/a/hello.txt"), err.Error())
			assert.ErrorAs(t, err, &filer.NotADirectory{})
		})
	}
}

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

	for _, testCase := range fsTests {
		tc := testCase

		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()

			_, tmpDir := tc.setupFiler(t)

			stdout, stderr := RequireSuccessfulRun(t, "fs", "ls", tmpDir, "--output=json")
			assert.Equal(t, "", stderr.String())
			var parsedStdout []map[string]any
			err := json.Unmarshal(stdout.Bytes(), &parsedStdout)
			require.NoError(t, err)

			// assert on ls output
			assert.Equal(t, 0, len(parsedStdout))
		})
	}
}

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

	for _, testCase := range fsTests {
		tc := testCase

		t.Run(tc.name, func(t *testing.T) {
			t.Parallel()

			_, tmpDir := tc.setupFiler(t)

			_, _, err := RequireErrorRun(t, "fs", "ls", path.Join(tmpDir, "nonexistent"), "--output=json")
			assert.ErrorIs(t, err, fs.ErrNotExist)
			assert.Regexp(t, regexp.MustCompile("no such directory: .*/nonexistent"), err.Error())
		})
	}
}

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

	t.Log(GetEnvOrSkipTest(t, "CLOUD_ENV"))

	_, _, err := RequireErrorRun(t, "fs", "ls", "/path-without-a-dbfs-scheme", "--output=json")
	assert.ErrorIs(t, err, fs.ErrNotExist)
}