🧹 extract find cmd generator into its own package

Author: chris-rock

providers/os/resources/files.go

@@ -6,7 +6,6 @@ package resources
 
 import (
 	"errors"
-	"fmt"
 	"regexp"
 	"strconv"
 	"strings"
@@ -15,17 +14,9 @@ import (
 	"go.mondoo.com/cnquery/v12/llx"
 	"go.mondoo.com/cnquery/v12/providers-sdk/v1/plugin"
 	"go.mondoo.com/cnquery/v12/providers/os/connection/shared"
+	"go.mondoo.com/cnquery/v12/providers/os/resources/filesfind"
 )
 
-var findTypes = map[string]string{
-	"file":      "f",
-	"directory": "d",
-	"character": "c",
-	"block":     "b",
-	"socket":    "s",
-	"link":      "l",
-}
-
 func initFilesFind(runtime *plugin.Runtime, args map[string]*llx.RawData) (map[string]*llx.RawData, plugin.Resource, error) {
 	if args["permissions"] == nil {
 		args["permissions"] = llx.IntData(int64(0o777))
@@ -34,10 +25,6 @@ func initFilesFind(runtime *plugin.Runtime, args map[string]*llx.RawData) (map[s
 	return args, nil, nil
 }
 
-func octal2string(o int64) string {
-	return fmt.Sprintf("%o", o)
-}
-
 func (l *mqlFilesFind) id() (string, error) {
 	var id strings.Builder
 	id.WriteString(l.From.Data)
@@ -62,7 +49,7 @@ func (l *mqlFilesFind) id() (string, error) {
 	}
 
 	if l.Permissions.Data != 0o777 {
-		id.WriteString(" permissions=" + octal2string(l.Permissions.Data))
+		id.WriteString(" permissions=" + filesfind.Octal2string(l.Permissions.Data))
 	}
 
 	return id.String(), nil
@@ -84,6 +71,9 @@ func (l *mqlFilesFind) list() ([]any, error) {
 		}
 	} else if conn.Capabilities().Has(shared.Capability_RunCommand) && pf.IsFamily("unix") {
 		foundFiles, err = l.unixFilesFindCmd()
+		if err != nil {
+			return nil, err
+		}
 	} else {
 		return nil, errors.New("find is not supported for your platform")
 	}
@@ -142,45 +132,14 @@ func (l *mqlFilesFind) fsFilesFind(conn shared.Connection) ([]string, error) {
 }
 
 func (l *mqlFilesFind) unixFilesFindCmd() ([]string, error) {
-	var call strings.Builder
-	call.WriteString("find -L ")
-	call.WriteString(strconv.Quote(l.From.Data))
-
-	if !l.Xdev.Data {
-		call.WriteString(" -xdev")
-	}
-
-	if l.Type.Data != "" {
-		t, ok := findTypes[l.Type.Data]
-		if ok {
-			call.WriteString(" -type " + t)
-		}
-	}
-
-	if l.Regex.Data != "" {
-		// TODO: we need to escape regex here
-		call.WriteString(" -regex '")
-		call.WriteString(l.Regex.Data)
-		call.WriteString("'")
-	}
-
-	if l.Permissions.Data != 0o777 {
-		call.WriteString(" -perm -")
-		call.WriteString(octal2string(l.Permissions.Data))
-	}
-
-	if l.Name.Data != "" {
-		call.WriteString(" -name ")
-		call.WriteString(l.Name.Data)
-	}
-
+	var depth *int64
 	if l.Depth.IsSet() {
-		call.WriteString(" -maxdepth ")
-		call.WriteString(octal2string(l.Depth.Data))
+		depth = &l.Depth.Data
 	}
 
+	callCmd := filesfind.BuildFilesFindCmd(l.From.Data, l.Xdev.Data, l.Type.Data, l.Regex.Data, l.Permissions.Data, l.Name.Data, depth)
 	rawCmd, err := CreateResource(l.MqlRuntime, "command", map[string]*llx.RawData{
-		"command": llx.StringData(call.String()),
+		"command": llx.StringData(callCmd),
 	})
 	if err != nil {
 		return nil, err

providers/os/resources/filesfind/unix_findcmd.go

@@ -0,0 +1,63 @@
+// Copyright (c) Mondoo, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
+package filesfind
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+)
+
+var findTypes = map[string]string{
+	"file":      "f",
+	"directory": "d",
+	"character": "c",
+	"block":     "b",
+	"socket":    "s",
+	"link":      "l",
+}
+
+func Octal2string(o int64) string {
+	return fmt.Sprintf("%o", o)
+}
+
+func BuildFilesFindCmd(from string, xdev bool, fileType string, regex string, permission int64, search string, depth *int64) string {
+	var call strings.Builder
+	call.WriteString("find -L ")
+	call.WriteString(strconv.Quote(from))
+
+	if !xdev {
+		call.WriteString(" -xdev")
+	}
+
+	if fileType != "" {
+		t, ok := findTypes[fileType]
+		if ok {
+			call.WriteString(" -type " + t)
+		}
+	}
+
+	if regex != "" {
+		// TODO: we need to escape regex here
+		call.WriteString(" -regex '")
+		call.WriteString(regex)
+		call.WriteString("'")
+	}
+
+	if permission != 0o777 {
+		call.WriteString(" -perm -")
+		call.WriteString(Octal2string(permission))
+	}
+
+	if search != "" {
+		call.WriteString(" -name ")
+		call.WriteString(search)
+	}
+
+	if depth != nil {
+		call.WriteString(" -maxdepth ")
+		call.WriteString(Octal2string(*depth))
+	}
+	return call.String()
+}

providers/os/resources/filesfind/unix_findcmd_test.go

@@ -0,0 +1,34 @@
+// Copyright (c) Mondoo, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
+package filesfind
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestUnixFilesCmdGeneration(t *testing.T) {
+	tests := []struct {
+		From        string
+		Xdev        bool
+		FileType    string
+		Regex       string
+		Permission  int64
+		Search      string
+		Depth       *int64
+		ExpectedCmd string
+	}{
+		{
+			From:        "/Users/john/.aws",
+			FileType:    "file",
+			ExpectedCmd: "find -L \"/Users/john/.aws\" -xdev -type f -perm -0",
+		},
+	}
+
+	for _, tt := range tests {
+		cmd := BuildFilesFindCmd(tt.From, tt.Xdev, tt.FileType, tt.Regex, tt.Permission, tt.Search, tt.Depth)
+		assert.Equal(t, tt.ExpectedCmd, cmd)
+	}
+}