go-inbucket/pkg/extension/luahost/lua_test.go

package luahost_test

import (
	"net/mail"
	"strings"
	"testing"
	"time"

	"github.com/inbucket/inbucket/v3/pkg/extension"
	"github.com/inbucket/inbucket/v3/pkg/extension/event"
	"github.com/inbucket/inbucket/v3/pkg/extension/luahost"
	"github.com/inbucket/inbucket/v3/pkg/test"
	"github.com/rs/zerolog"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

var consoleLogger = zerolog.New(zerolog.NewConsoleWriter())

func TestEmptyScript(t *testing.T) {
	script := ""
	extHost := extension.NewHost()

	_, err := luahost.NewFromReader(consoleLogger, extHost, strings.NewReader(script), "test.lua")
	require.NoError(t, err)
}

func TestLogger(t *testing.T) {
	script := `
		local logger = require("logger")
		logger.info("_test log entry_", {})
	`

	extHost := extension.NewHost()
	output := &strings.Builder{}
	logger := zerolog.New(output)

	_, err := luahost.NewFromReader(logger, extHost, strings.NewReader(script), "test.lua")
	require.NoError(t, err)

	assert.Contains(t, output.String(), "_test log entry_")
}

func TestScriptConfigDecodeHeaders(t *testing.T) {
	script := `
		inbucket.config.decode_headers = {
			"X-Spam-Status",
			"Authentication-Results",
		}
	`
	extHost := extension.NewHost()
	luaHost, err := luahost.NewFromReader(consoleLogger, extHost,
		strings.NewReader(script), "test.lua")
	require.NoError(t, err)

	assert.Equal(t,
		[]string{"X-Spam-Status", "Authentication-Results"},
		luaHost.ScriptConfig().DecodeHeaders)
}

func TestScriptConfigDefault(t *testing.T) {
	script := ``
	extHost := extension.NewHost()
	luaHost, err := luahost.NewFromReader(consoleLogger, extHost,
		strings.NewReader(script), "test.lua")
	require.NoError(t, err)

	assert.Empty(t, luaHost.ScriptConfig().DecodeHeaders)
}

func TestAfterMessageDeleted(t *testing.T) {
	// Register lua event listener, setup notify channel.
	script := `
		async = true

		function inbucket.after.message_deleted(msg)
			-- Full message bindings tested elsewhere.
			assert_eq(msg.mailbox, "mb1")
			assert_eq(msg.id, "id1")
			notify:send(asserts_ok)
		end
	`
	extHost := extension.NewHost()
	luaHost, err := luahost.NewFromReader(consoleLogger, extHost,
		strings.NewReader(test.LuaInit+script), "test.lua")
	require.NoError(t, err)
	notify := luaHost.CreateChannel("notify")

	// Send event, check channel response is true.
	msg := &event.MessageMetadata{
		Mailbox: "mb1",
		ID:      "id1",
		From:    &mail.Address{Name: "name1", Address: "addr1"},
		To:      []*mail.Address{{Name: "name2", Address: "addr2"}},
		Date:    time.Date(2001, time.February, 3, 4, 5, 6, 0, time.UTC),
		Subject: "subj1",
		Size:    42,
	}
	extHost.Events.AfterMessageDeleted.Emit(msg)
	test.AssertNotified(t, notify)
}

func TestAfterMessageStored(t *testing.T) {
	// Register lua event listener, setup notify channel.
	script := `
		async = true

		function inbucket.after.message_stored(msg)
			-- Full message bindings tested elsewhere.
			assert_eq(msg.mailbox, "mb1")
			assert_eq(msg.id, "id1")
			notify:send(asserts_ok)
		end
	`
	extHost := extension.NewHost()
	luaHost, err := luahost.NewFromReader(consoleLogger, extHost,
		strings.NewReader(test.LuaInit+script), "test.lua")
	require.NoError(t, err)
	notify := luaHost.CreateChannel("notify")

	// Send event, check channel response is true.
	msg := &event.MessageMetadata{
		Mailbox: "mb1",
		ID:      "id1",
		From:    &mail.Address{Name: "name1", Address: "addr1"},
		To:      []*mail.Address{{Name: "name2", Address: "addr2"}},
		Date:    time.Date(2001, time.February, 3, 4, 5, 6, 0, time.UTC),
		Subject: "subj1",
		Size:    42,
	}
	extHost.Events.AfterMessageStored.Emit(msg)
	test.AssertNotified(t, notify)
}

func TestBeforeMailFromAccepted(t *testing.T) {
	// Register lua event listener.
	script := `
		function inbucket.before.mail_from_accepted(session)
			if session.from.address == "from@example.com" then
				logger.info("allowing message", {})
				return smtp.allow()
			else
				logger.info("denying message", {})
				return smtp.deny()
			end
		end
	`
	extHost := extension.NewHost()
	_, err := luahost.NewFromReader(
		consoleLogger, extHost, strings.NewReader(test.LuaInit+script), "test.lua")
	require.NoError(t, err)

	{
		// Send event to be accepted.
		session := event.SMTPSession{
			From: &mail.Address{Name: "", Address: "from@example.com"},
		}
		got := extHost.Events.BeforeMailFromAccepted.Emit(&session)
		want := event.ActionAllow
		require.NotNil(t, got, "Expected result from Emit()")
		if got.Action != want {
			t.Errorf("Got %v, wanted %v for addr %v", got.Action, want, session.From)
		}
	}

	{
		// Send event to be denied.
		session := event.SMTPSession{
			From: &mail.Address{Name: "", Address: "from@reject.com"},
		}
		got := extHost.Events.BeforeMailFromAccepted.Emit(&session)
		want := event.ActionDeny
		require.NotNil(t, got, "Expected result from Emit()")
		if got.Action != want {
			t.Errorf("Got %v, wanted %v for addr %v", got.Action, want, session.From)
		}
	}
}

func TestBeforeMessageStored(t *testing.T) {
	// Event to send.
	msg := event.InboundMessage{
		Mailboxes: []string{"one", "two"},
		From:      &mail.Address{Name: "From Name", Address: "from@example.com"},
		To: []*mail.Address{
			{Name: "To1 Name", Address: "to1@example.com"},
			{Name: "To2 Name", Address: "to2@example.com"},
		},
		Subject: "inbound subj",
		Size:    42,
	}

	// Register lua event listener.
	script := `
		async = true

		function inbucket.before.message_stored(msg)
			-- Verify incoming values.
			assert_eq(msg.mailboxes, {"one", "two"})
			assert_eq(msg.from.name, "From Name")
			assert_eq(msg.from.address, "from@example.com")
			assert_eq(2, #msg.to, "#msg.to")
			assert_eq(msg.to[1].name, "To1 Name")
			assert_eq(msg.to[1].address, "to1@example.com")
			assert_eq(msg.to[2].name, "To2 Name")
			assert_eq(msg.to[2].address, "to2@example.com")
			assert_eq(msg.subject, "inbound subj")
			assert_eq(msg.size, 42, "msg.size")
			notify:send(asserts_ok)

			-- Generate response.
			res = inbound_message.new()
			res.mailboxes = {"resone", "restwo"}
			res.from = address.new("Res From", "res@example.com")
			res.to = {
				address.new("To1 Res", "res1@example.com"),
				address.new("To2 Res", "res2@example.com"),
			}
			res.subject = "res subj"
			return res
		end
	`
	extHost := extension.NewHost()
	luaHost, err := luahost.NewFromReader(consoleLogger, extHost,
		strings.NewReader(test.LuaInit+script), "test.lua")
	require.NoError(t, err)
	notify := luaHost.CreateChannel("notify")

	// Send event to be accepted.
	got := extHost.Events.BeforeMessageStored.Emit(&msg)
	require.NotNil(t, got, "Expected result from Emit()")

	// Verify Lua assertions passed.
	test.AssertNotified(t, notify)

	// Verify response values.
	want := &event.InboundMessage{
		Mailboxes: []string{"resone", "restwo"},
		From:      &mail.Address{Name: "Res From", Address: "res@example.com"},
		To: []*mail.Address{
			{Name: "To1 Res", Address: "res1@example.com"},
			{Name: "To2 Res", Address: "res2@example.com"},
		},
		Subject: "res subj",
		Size:    0,
	}
	assert.Equal(t, want, got, "Response InboundMessage did not match")
}

func TestBeforeMessageStoredNilReturn(t *testing.T) {
	// Event to send.
	msg := event.InboundMessage{
		Mailboxes: []string{"one", "two"},
		From:      &mail.Address{Name: "From Name", Address: "from@example.com"},
		To: []*mail.Address{
			{Name: "To1 Name", Address: "to1@example.com"},
			{Name: "To2 Name", Address: "to2@example.com"},
		},
		Subject: "inbound subj",
		Size:    42,
	}

	// Register lua event listener.
	script := `
		async = true

		function inbucket.before.message_stored(msg)
			assert(msg)
			notify:send(asserts_ok)

			-- Generate response.
			return nil
		end
	`
	extHost := extension.NewHost()
	luaHost, err := luahost.NewFromReader(consoleLogger, extHost,
		strings.NewReader(test.LuaInit+script), "test.lua")
	require.NoError(t, err)
	notify := luaHost.CreateChannel("notify")

	// Send event to be accepted.
	got := extHost.Events.BeforeMessageStored.Emit(&msg)
	require.Nil(t, got, "Expected nil result from Emit()")

	// Verify Lua assertions passed.
	test.AssertNotified(t, notify)
}

func TestBeforeRcptToAccepted(t *testing.T) {
	// Event to send.
	session := event.SMTPSession{
		From: &mail.Address{Name: "", Address: "from@example.com"},
		To: []*mail.Address{
			{Name: "", Address: "to1@example.com"},
			{Name: "", Address: "to2@example.com"},
		},
	}

	// Register lua event listener.
	script := `
		async = true

		function inbucket.before.rcpt_to_accepted(msg)
			-- Verify incoming values.
			assert_eq(msg.from.address, "from@example.com")
			assert_eq(2, #msg.to, "#msg.to")
			assert_eq(msg.to[1].address, "to1@example.com")
			assert_eq(msg.to[2].address, "to2@example.com")
			notify:send(asserts_ok)

			return smtp.allow()
		end
	`
	extHost := extension.NewHost()
	luaHost, err := luahost.NewFromReader(consoleLogger, extHost,
		strings.NewReader(test.LuaInit+script), "test.lua")
	require.NoError(t, err)
	notify := luaHost.CreateChannel("notify")

	// Send event to be accepted.
	got := extHost.Events.BeforeRcptToAccepted.Emit(&session)
	require.NotNil(t, got, "Expected result from Emit()")

	// Verify Lua assertions passed.
	test.AssertNotified(t, notify)

	// Verify response values.
	want := event.SMTPResponse{Action: event.ActionAllow}
	assert.Equal(t, want, *got)
}