OliveTin/service/internal/executor/arguments_test.go

package executor

import (
	config "github.com/OliveTin/OliveTin/internal/config"

	"github.com/stretchr/testify/assert"
	"testing"
)

func TestSanitizeUnsafe(t *testing.T) {
	assert.Nil(t, TypeSafetyCheck("", "_zomg_ c:/ haxxor ' bobby tables && rm -rf ", "very_dangerous_raw_string"))
}

func TestSanitizeUnimplemented(t *testing.T) {
	err := TypeSafetyCheck("", "I am a happy little argument", "greeting_type")

	assert.NotNil(t, err, "Test an argument type that does not exist")
}

func TestArgumentValueNullable(t *testing.T) {
	a1 := config.Action{
		Title: "Release the hounds",
		Shell: "echo 'Releasing {{ count }} hounds'",
		Arguments: []config.ActionArgument{
			{
				Name: "count",
				Type: "int",
			},
		},
	}

	values := map[string]string{
		"count": "",
	}

	out, err := parseActionArguments(values, &a1, "")

	assert.Equal(t, "echo 'Releasing  hounds'", out)
	assert.Nil(t, err)

	a1.Arguments[0].RejectNull = true

	_, err = parseActionArguments(values, &a1, "")

	assert.NotNil(t, err)
}

func TestArgumentNameNumbers(t *testing.T) {
	a1 := config.Action{
		Title: "Do some tickles",
		Shell: "echo 'Tickling {{ person1name }}'",
		Arguments: []config.ActionArgument{
			{
				Name: "person1name",
				Type: "ascii",
			},
		},
	}

	values := map[string]string{
		"person1name": "Fred",
	}

	out, err := parseActionArguments(values, &a1, "")

	assert.Equal(t, "echo 'Tickling Fred'", out)
	assert.Nil(t, err)
}

func TestArgumentNotProvided(t *testing.T) {
	a1 := config.Action{
		Title: "Do some tickles",
		Shell: "echo 'Tickling {{ personName }}'",
		Arguments: []config.ActionArgument{
			{
				Name: "person",
				Type: "ascii",
			},
		},
	}

	values := map[string]string{}

	out, err := parseActionArguments(values, &a1, "")

	assert.Equal(t, "", out)
	assert.Equal(t, err.Error(), "required arg not provided: personName")
}

func TestTypeSafetyCheckUrl(t *testing.T) {
	assert.Nil(t, TypeSafetyCheck("test1", "http://google.com", "url"), "Test URL: google.com")
	assert.Nil(t, TypeSafetyCheck("test2", "http://technowax.net:80?foo=bar", "url"), "Test URL: technowax.net with query arguments")
	assert.Nil(t, TypeSafetyCheck("test3", "http://localhost:80?foo=bar", "url"), "Test URL: localhost with query arguments")
	assert.NotNil(t, TypeSafetyCheck("test4", "http://lo  host:80", "url"), "Test a badly formed URL")
	assert.NotNil(t, TypeSafetyCheck("test5", "12345", "url"), "Test a badly formed URL")
	assert.NotNil(t, TypeSafetyCheck("test6", "_!23;", "url"), "Test a badly formed URL")
}

func TestTypeSafetyCheckRegex(t *testing.T) {
	tests := []struct {
		name     string
		field    string
		pattern  string
		value    string
		hasError bool
	}{
		{
			name:     "Issue #578 - Domain",
			field:    "domain",
			pattern:  "regex:^(?:[a-zA-Z0-9-]{1,63}.)+[a-zA-Z]{2,63}$",
			value:    "immich.example.dev",
			hasError: false,
		},
		{
			name:     "Don't allow numbers in username",
			field:    "Username",
			pattern:  "regex:^[a-zA-Z]$",
			value:    "James1234",
			hasError: true,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			err := typeSafetyCheckRegex(tt.field, tt.value, tt.pattern)

			if tt.hasError {
				assert.NotNil(t, err, "Expected error for value %s with pattern %s, but got no error", tt.value, tt.pattern)
			} else {
				assert.Nil(t, err, "Expected no error for value %s with pattern %s, but got error: %v", tt.value, tt.pattern, err)
			}
		})
	}
}

func TestRedactShellCommand(t *testing.T) {
	cmd := "echo 'The password for Fred is toomanysecrets'"

	args := []config.ActionArgument{
		{
			Name: "personName",
			Type: "ascii",
		},
		{
			Name: "password",
			Type: "password",
		},
	}

	values := map[string]string{
		"personName": "Fred",
		"password":   "toomanysecrets",
	}

	res := redactShellCommand(cmd, args, values)

	assert.Equal(t, "echo 'The password for Fred is <redacted>'", res, "Redacted shell command should mask the password argument")

	// Test with empty password
	values["password"] = ""
	res = redactShellCommand(cmd, args, values)
	assert.Equal(t, cmd, res, "Empty password should not change the command")

	// Test with missing password argument
	delete(values, "password")
	res = redactShellCommand(cmd, args, values)
	assert.Equal(t, cmd, res, "Missing password argument should not change the command")
}