mirror of
https://github.com/jhillyerd/inbucket.git
synced 2025-12-17 17:47:03 +00:00
253 lines
6.9 KiB
Go
253 lines
6.9 KiB
Go
package file
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"log"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/inbucket/inbucket/v3/pkg/config"
|
|
"github.com/inbucket/inbucket/v3/pkg/extension"
|
|
"github.com/inbucket/inbucket/v3/pkg/storage"
|
|
"github.com/inbucket/inbucket/v3/pkg/test"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// TestSuite runs storage package test suite on file store.
|
|
func TestSuite(t *testing.T) {
|
|
test.StoreSuite(t,
|
|
func(conf config.Storage, extHost *extension.Host) (storage.Store, func(), error) {
|
|
ds, _ := setupDataStore(conf, extHost)
|
|
destroy := func() {
|
|
teardownDataStore(ds)
|
|
}
|
|
return ds, destroy, nil
|
|
})
|
|
}
|
|
|
|
// Test filestore initialization.
|
|
func TestFSNew(t *testing.T) {
|
|
// Should fail if no path specified.
|
|
ds, err := New(config.Storage{}, extension.NewHost())
|
|
require.ErrorContains(t, err, "parameter not specified")
|
|
assert.Nil(t, ds)
|
|
}
|
|
|
|
func TestFSGetMailPath(t *testing.T) {
|
|
// Path should have `mail` dir appended.
|
|
got := getMailPath(`one`)
|
|
assert.Regexp(t, "^one.mail$", got, "Expected one/mail or similar")
|
|
|
|
// Path should convert `$` to `:`.
|
|
got = getMailPath(`C$\inbucket`)
|
|
assert.Regexp(t, "^C:.inbucket.mail$", got, "Expected C:\\inbucket\\mail or similar")
|
|
}
|
|
|
|
// Test directory structure created by filestore
|
|
func TestFSDirStructure(t *testing.T) {
|
|
ds, logbuf := setupDataStore(config.Storage{}, extension.NewHost())
|
|
defer teardownDataStore(ds)
|
|
root := ds.path
|
|
|
|
// james hashes to 474ba67bdb289c6263b36dfd8a7bed6c85b04943
|
|
mbName := "james"
|
|
|
|
// Check filestore root exists
|
|
assert.True(t, isDir(root), "Expected %q to be a directory", root)
|
|
|
|
// Check mail dir exists
|
|
expect := filepath.Join(root, "mail")
|
|
assert.True(t, isDir(expect), "Expected %q to be a directory", expect)
|
|
|
|
// Check first hash section does not exist
|
|
expect = filepath.Join(root, "mail", "474")
|
|
assert.False(t, isDir(expect), "Expected %q to not exist", expect)
|
|
|
|
// Deliver test message
|
|
id1, _ := test.DeliverToStore(t, ds, mbName, "test", time.Now())
|
|
|
|
// Check path to message exists
|
|
assert.True(t, isDir(expect), "Expected %q to be a directory", expect)
|
|
expect = filepath.Join(expect, "474ba6")
|
|
assert.True(t, isDir(expect), "Expected %q to be a directory", expect)
|
|
expect = filepath.Join(expect, "474ba67bdb289c6263b36dfd8a7bed6c85b04943")
|
|
assert.True(t, isDir(expect), "Expected %q to be a directory", expect)
|
|
|
|
// Check files
|
|
mbPath := expect
|
|
expect = filepath.Join(mbPath, "index.gob")
|
|
assert.True(t, isFile(expect), "Expected %q to be a file", expect)
|
|
expect = filepath.Join(mbPath, id1+".raw")
|
|
assert.True(t, isFile(expect), "Expected %q to be a file", expect)
|
|
|
|
// Deliver second test message
|
|
id2, _ := test.DeliverToStore(t, ds, mbName, "test 2", time.Now())
|
|
|
|
// Check files
|
|
expect = filepath.Join(mbPath, "index.gob")
|
|
assert.True(t, isFile(expect), "Expected %q to be a file", expect)
|
|
expect = filepath.Join(mbPath, id2+".raw")
|
|
assert.True(t, isFile(expect), "Expected %q to be a file", expect)
|
|
|
|
// Delete message
|
|
err := ds.RemoveMessage(mbName, id1)
|
|
require.NoError(t, err)
|
|
|
|
// Message should be removed
|
|
expect = filepath.Join(mbPath, id1+".raw")
|
|
assert.False(t, isPresent(expect), "Did not expect %q to exist", expect)
|
|
expect = filepath.Join(mbPath, "index.gob")
|
|
assert.True(t, isFile(expect), "Expected %q to be a file", expect)
|
|
|
|
// Delete message
|
|
err = ds.RemoveMessage(mbName, id2)
|
|
require.NoError(t, err)
|
|
|
|
// Message should be removed
|
|
expect = filepath.Join(mbPath, id2+".raw")
|
|
assert.False(t, isPresent(expect), "Did not expect %q to exist", expect)
|
|
|
|
// No messages, index & maildir should be removed
|
|
expect = filepath.Join(mbPath, "index.gob")
|
|
assert.False(t, isPresent(expect), "Did not expect %q to exist", expect)
|
|
expect = mbPath
|
|
assert.False(t, isPresent(expect), "Did not expect %q to exist", expect)
|
|
|
|
if t.Failed() {
|
|
// Wait for handler to finish logging
|
|
time.Sleep(2 * time.Second)
|
|
// Dump buffered log data if there was a failure
|
|
_, _ = io.Copy(os.Stderr, logbuf)
|
|
}
|
|
}
|
|
|
|
// Test missing files
|
|
func TestFSMissing(t *testing.T) {
|
|
ds, logbuf := setupDataStore(config.Storage{}, extension.NewHost())
|
|
defer teardownDataStore(ds)
|
|
|
|
mbName := "fred"
|
|
subjects := []string{"a", "b", "c"}
|
|
sentIds := make([]string, len(subjects))
|
|
|
|
for i, subj := range subjects {
|
|
// Add a message
|
|
id, _ := test.DeliverToStore(t, ds, mbName, subj, time.Now())
|
|
sentIds[i] = id
|
|
}
|
|
|
|
// Delete a message file without removing it from index
|
|
msg, err := ds.GetMessage(mbName, sentIds[1])
|
|
require.NoError(t, err)
|
|
fmsg := msg.(*Message)
|
|
_ = os.Remove(fmsg.rawPath())
|
|
msg, err = ds.GetMessage(mbName, sentIds[1])
|
|
require.NoError(t, err)
|
|
|
|
// Try to read parts of message
|
|
_, err = msg.Source()
|
|
require.Error(t, err)
|
|
|
|
if t.Failed() {
|
|
// Wait for handler to finish logging
|
|
time.Sleep(2 * time.Second)
|
|
// Dump buffered log data if there was a failure
|
|
_, _ = io.Copy(os.Stderr, logbuf)
|
|
}
|
|
}
|
|
|
|
// Test Get the latest message
|
|
func TestGetLatestMessage(t *testing.T) {
|
|
ds, logbuf := setupDataStore(config.Storage{}, extension.NewHost())
|
|
defer teardownDataStore(ds)
|
|
|
|
// james hashes to 474ba67bdb289c6263b36dfd8a7bed6c85b04943
|
|
mbName := "james"
|
|
|
|
// Test empty mailbox
|
|
msg, err := ds.GetMessage(mbName, "latest")
|
|
assert.Nil(t, msg)
|
|
require.Error(t, err)
|
|
|
|
// Deliver test message
|
|
test.DeliverToStore(t, ds, mbName, "test", time.Now())
|
|
|
|
// Deliver test message 2
|
|
id2, _ := test.DeliverToStore(t, ds, mbName, "test 2", time.Now())
|
|
|
|
// Test get the latest message
|
|
msg, err = ds.GetMessage(mbName, "latest")
|
|
require.NoError(t, err)
|
|
assert.Equal(t, id2, msg.ID(), "Expected %q to be equal to %q", msg.ID(), id2)
|
|
|
|
// Deliver test message 3
|
|
id3, _ := test.DeliverToStore(t, ds, mbName, "test 3", time.Now())
|
|
|
|
msg, err = ds.GetMessage(mbName, "latest")
|
|
require.NoError(t, err)
|
|
assert.Equal(t, id3, msg.ID(), "Expected %q to be equal to %q", msg.ID(), id3)
|
|
|
|
// Test wrong id
|
|
_, err = ds.GetMessage(mbName, "wrongid")
|
|
require.Error(t, err)
|
|
|
|
if t.Failed() {
|
|
// Wait for handler to finish logging
|
|
time.Sleep(2 * time.Second)
|
|
// Dump buffered log data if there was a failure
|
|
_, _ = io.Copy(os.Stderr, logbuf)
|
|
}
|
|
}
|
|
|
|
// setupDataStore creates a new FileDataStore in a temporary directory
|
|
func setupDataStore(cfg config.Storage, extHost *extension.Host) (*Store, *bytes.Buffer) {
|
|
path, err := os.MkdirTemp("", "inbucket")
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
// Capture log output.
|
|
buf := new(bytes.Buffer)
|
|
log.SetOutput(buf)
|
|
|
|
if cfg.Params == nil {
|
|
cfg.Params = make(map[string]string)
|
|
}
|
|
cfg.Params["path"] = path
|
|
s, err := New(cfg, extHost)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
return s.(*Store), buf
|
|
}
|
|
|
|
func teardownDataStore(ds *Store) {
|
|
if err := os.RemoveAll(ds.path); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
func isPresent(path string) bool {
|
|
_, err := os.Lstat(path)
|
|
return err == nil
|
|
}
|
|
|
|
func isFile(path string) bool {
|
|
if fi, err := os.Lstat(path); err == nil {
|
|
return !fi.IsDir()
|
|
}
|
|
return false
|
|
}
|
|
|
|
func isDir(path string) bool {
|
|
if fi, err := os.Lstat(path); err == nil {
|
|
return fi.IsDir()
|
|
}
|
|
return false
|
|
}
|