feat: Add local path validation (#60)

bbernays · web-flow · commit afa10ccd1d72 · 2023-07-13T11:33:40.000Z
Help users running CQ with locally built plugins get better error messages
diff --git a/managedplugin/plugin.go b/managedplugin/plugin.go
@@ -146,6 +146,9 @@ func NewClient(ctx context.Context, typ PluginType, config Config, opts ...Optio
 			return nil, fmt.Errorf("failed to dial grpc source plugin at %s: %w", config.Path, err)
 		}
 	case RegistryLocal:
+		if err := validateLocalExecPath(config.Path); err != nil {
+			return nil, err
+		}
 		if err := c.startLocal(ctx, config.Path); err != nil {
 			return nil, err
 		}
@@ -367,3 +370,22 @@ func (c *Client) Terminate() error {
 
 	return nil
 }
+
+func isDirectory(path string) (bool, error) {
+	fileInfo, err := os.Stat(path)
+	if err != nil {
+		return false, err
+	}
+	return fileInfo.IsDir(), err
+}
+
+func validateLocalExecPath(filePath string) error {
+	directory, err := isDirectory(filePath)
+	if err != nil {
+		return fmt.Errorf("error validating plugin path, %s: %w", filePath, err)
+	}
+	if directory {
+		return fmt.Errorf("invalid plugin path: %s. Path cannot point to a directory", filePath)
+	}
+	return nil
+}
diff --git a/managedplugin/plugin_test.go b/managedplugin/plugin_test.go
@@ -2,6 +2,7 @@ package managedplugin
 
 import (
 	"context"
+	"os"
 	"path/filepath"
 	"testing"
 )
@@ -47,3 +48,52 @@ func TestManagedPluginGitHub(t *testing.T) {
 		t.Fatal(err)
 	}
 }
+
+func TestIsDirectory(t *testing.T) {
+	tempDir := t.TempDir()
+	directoryBool, err := isDirectory(tempDir)
+	if err != nil {
+		t.Fatal(err)
+	}
+	// directory should be `true`
+	if !directoryBool {
+		t.Fatal("expected directory")
+	}
+	tempFile, err := os.Create(tempDir + "testFile")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer tempFile.Close()
+	isFileBool, err := isDirectory(tempDir + "testFile")
+	if err != nil {
+		t.Fatal(err)
+	}
+	if isFileBool {
+		t.Fatal("expected file")
+	}
+}
+
+func TestValidatevLocalExecPath(t *testing.T) {
+	tempDir := t.TempDir()
+	// passing a directory should result in an error
+	err := validateLocalExecPath(tempDir)
+	if err == nil {
+		t.Fatal(err)
+	}
+
+	tempFile, err := os.Create(tempDir + "testFile")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer tempFile.Close()
+	err = validateLocalExecPath(tempDir + "testFile")
+	// passing a valid non directory path should result in no error
+	if err != nil {
+		t.Fatal(err)
+	}
+	// passing a file path that doesn't exist should result in an error
+	err = validateLocalExecPath(tempDir + "randomfile")
+	if err == nil {
+		t.Fatal(err)
+	}
+}
