1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
|
package tests
import (
"bytes"
"context"
"fmt"
"os"
"sync"
"testing"
"time"
"github.com/ProtonMail/gluon/connector"
"github.com/ProtonMail/gluon/imap"
goimap "github.com/emersion/go-imap"
uidplus "github.com/emersion/go-imap-uidplus"
"github.com/emersion/go-imap/client"
"github.com/stretchr/testify/require"
)
func TestAppend(t *testing.T) {
const (
mailboxName = "saved-messages"
messagePath = "testdata/afternoon-meeting.eml"
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t), func(client *client.Client, _ *testSession) {
require.NoError(t, client.Create(mailboxName))
{
// first check, empty mailbox
status, err := client.Status(mailboxName, []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(0), status.Messages, "Expected message count does not match")
}
{
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
require.Error(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.RecentFlag))
}
{
// second check, there should be 3 messages
status, err := client.Status(mailboxName, []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(3), status.Messages, "Expected message count does not match")
}
})
}
func TestAppendWithUidPlus(t *testing.T) {
const (
mailboxName = "saved-messages"
messagePath = "testdata/afternoon-meeting.eml"
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t, withUIDValidityGenerator(imap.NewFixedUIDValidityGenerator(imap.UID(1)))), func(client *client.Client, _ *testSession) {
const validityUid = uint32(1)
require.NoError(t, client.Create(mailboxName))
{
// first check, empty mailbox
status, err := client.Status(mailboxName, []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(0), status.Messages, "Expected message count does not match")
}
{
// Insert some messages
clientUidPlus := uidplus.NewClient(client)
{
validity, uid, err := doAppendWithClientPlusFromFile(t, clientUidPlus, mailboxName, messagePath, goimap.SeenFlag)
require.NoError(t, err)
require.Equal(t, validityUid, validity)
require.Equal(t, uint32(1), uid)
}
{
validity, uid, err := doAppendWithClientPlusFromFile(t, clientUidPlus, mailboxName, messagePath, goimap.SeenFlag)
require.NoError(t, err)
require.Equal(t, validityUid, validity)
require.Equal(t, uint32(2), uid)
}
{
validity, uid, err := doAppendWithClientPlusFromFile(t, clientUidPlus, mailboxName, messagePath, goimap.SeenFlag)
require.NoError(t, err)
require.Equal(t, validityUid, validity)
require.Equal(t, uint32(3), uid)
}
require.Error(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.RecentFlag))
}
{
// second check, there should be 3 messages
status, err := client.Status(mailboxName, []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(3), status.Messages, "Expected message count does not match")
}
})
}
func TestAppendNoSuchMailbox(t *testing.T) {
const (
mailboxName = "saved-messages"
messagePath = "testdata/afternoon-meeting.eml"
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t), func(client *client.Client, _ *testSession) {
err := doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag)
require.Error(t, err)
})
// Run the old test as well as there is no way to check for the `[TRYCREATE]` flag of the response
runOneToOneTestWithAuth(t, defaultServerOptions(t), func(c *testConnection, _ *testSession) {
c.doAppendFromFile(`saved-messages`, `testdata/afternoon-meeting.eml`, `\Seen`).expect(`NO \[TRYCREATE\]`)
})
}
func TestAppendWhileSelected(t *testing.T) {
const (
mailboxName = "saved-messages"
messagePath = "testdata/afternoon-meeting.eml"
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t), func(client *client.Client, _ *testSession) {
require.NoError(t, client.Create(mailboxName))
// Mailbox should have read-write modifier
mailboxStatus, err := client.Select(mailboxName, false)
require.NoError(t, err)
require.Equal(t, false, mailboxStatus.ReadOnly)
// Add new message
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
// EXISTS response is assigned to Messages member
require.Equal(t, uint32(1), client.Mailbox().Messages)
// Check if added
status, err := client.Status(mailboxName, []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
})
}
func TestAppendHeaderWithSpaceLine(t *testing.T) {
r := require.New(t)
const (
mailboxName = "saved-messages"
messagePath = "testdata/space_line_header.eml"
)
// Get full header from file
fullMessage, err := os.ReadFile(messagePath)
r.NoError(err)
endOfHeader := []byte{13, 10, 13, 10}
endOfHeaderKey := bytes.Index(fullMessage, endOfHeader)
r.NotEqual(-1, endOfHeaderKey)
wantHeader := string(fullMessage[0 : endOfHeaderKey+len(endOfHeader)])
runOneToOneTestClientWithAuth(t, defaultServerOptions(t), func(client *client.Client, _ *testSession) {
r.NoError(client.Create(mailboxName))
// Mailbox should have read-write modifier
mailboxStatus, err := client.Select(mailboxName, false)
r.NoError(err)
r.False(mailboxStatus.ReadOnly)
// Add new message
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
// EXISTS response is assigned to Messages member
require.Equal(t, uint32(1), client.Mailbox().Messages)
// Check if added
status, err := client.Status(mailboxName, []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
// Check has full header
newFetchCommand(t, client).
withItems(goimap.FetchRFC822Header).fetch("1").
forSeqNum(1, func(v *validatorBuilder) {
v.ignoreFlags()
v.wantSectionString(goimap.FetchRFC822Header, func(t testing.TB, literal string) {
haveHeader := skipGLUONHeader(literal)
r.Equal(wantHeader, haveHeader)
})
}).check()
})
}
type returnSameRemoteIDConnector struct {
*connector.Dummy
lock sync.Mutex
messageCreated bool
createdMessage imap.Message
messageLiteral []byte
}
func (r *returnSameRemoteIDConnector) CreateMessage(ctx context.Context, mboxID imap.MailboxID, literal []byte, flags imap.FlagSet, date time.Time) (imap.Message, []byte, error) {
r.lock.Lock()
defer r.lock.Unlock()
if !r.messageCreated {
msg, l, err := r.Dummy.CreateMessage(ctx, mboxID, literal, flags, date)
if err != nil {
return imap.Message{}, nil, err
}
r.createdMessage = msg
r.messageLiteral = l
r.messageCreated = true
}
return r.createdMessage, r.messageLiteral, nil
}
type returnSameRemoteIDConnectorBuilder struct{}
func (returnSameRemoteIDConnectorBuilder) New(usernames []string, password []byte, period time.Duration, flags, permFlags, attrs imap.FlagSet) Connector {
return &returnSameRemoteIDConnector{
Dummy: connector.NewDummy(usernames, password, period, flags, permFlags, attrs),
}
}
func TestAppendConnectorReturnsSameRemoteIDSameMBox(t *testing.T) {
const (
mailboxName = "INBOX"
messagePath = "testdata/afternoon-meeting.eml"
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t, withConnectorBuilder(&returnSameRemoteIDConnectorBuilder{})), func(client *client.Client, _ *testSession) {
{
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
}
{
// second check, there should be 1 message
status, err := client.Status(mailboxName, []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
}
})
}
func TestAppendConnectorReturnsSameRemoteIDDifferentMBox(t *testing.T) {
const (
mailboxName = "INBOX"
mailboxNameOther = "saved-messages"
messagePath = "testdata/afternoon-meeting.eml"
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t, withConnectorBuilder(&returnSameRemoteIDConnectorBuilder{})), func(client *client.Client, _ *testSession) {
require.NoError(t, client.Create(mailboxNameOther))
{
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxNameOther, messagePath, time.Now(), goimap.SeenFlag))
}
{
// there should be 1 message in mailboxName
status, err := client.Status(mailboxName, []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
}
{
// there should be 1 message in mailboxNameOther
status, err := client.Status(mailboxNameOther, []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
}
})
}
func TestAppendConnectorReturnsSameRemoteIDShouldRemoveDeletedFlag(t *testing.T) {
const (
mailboxName = "INBOX"
messagePath = "testdata/afternoon-meeting.eml"
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t, withConnectorBuilder(&returnSameRemoteIDConnectorBuilder{})), func(client *client.Client, _ *testSession) {
// Append message one time.
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
{
status, err := client.Select(mailboxName, false)
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
// Mark it as deleted.
require.NoError(t, client.Store(createSeqSet("1"), goimap.AddFlags, []interface{}{goimap.DeletedFlag}, nil))
// Check flag got set
newFetchCommand(t, client).withItems("FLAGS").fetch("1").forSeqNum(1, func(builder *validatorBuilder) {
builder.wantFlags(imap.FlagSeen, imap.FlagRecent, imap.FlagDeleted)
}).checkAndRequireMessageCount(1)
}
// Append same message again.
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
// There should be 1 message in mailboxName and not be deleted
status, err := client.Select(mailboxName, false)
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
// Deleted flag should not be present
newFetchCommand(t, client).withItems("FLAGS").fetch("1").forSeqNum(1, func(builder *validatorBuilder) {
builder.wantFlags(imap.FlagSeen)
}).checkAndRequireMessageCount(1)
})
}
func TestAppendConnectorReturnsSameInternalIDRemoveDeletedFlag(t *testing.T) {
const (
mailboxName = "INBOX"
messagePath = "testdata/afternoon-meeting.eml"
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t, withConnectorBuilder(&returnSameRemoteIDConnectorBuilder{})), func(client *client.Client, _ *testSession) {
// Append message one time.
require.NoError(t, doAppendWithClientFromFile(t, client, mailboxName, messagePath, time.Now(), goimap.SeenFlag))
var messageWithInternalID string
{
status, err := client.Select(mailboxName, false)
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
// Mark it as deleted.
require.NoError(t, client.Store(createSeqSet("1"), goimap.AddFlags, []interface{}{goimap.DeletedFlag}, nil))
// Check flag got set
newFetchCommand(t, client).withItems("FLAGS").fetch("1").forSeqNum(1, func(builder *validatorBuilder) {
builder.wantFlags(imap.FlagSeen, imap.FlagRecent, imap.FlagDeleted)
})
// Retrieve message with internal id
newFetchCommand(t, client).withItems("BODY[]").fetch("1").forSeqNum(1, func(builder *validatorBuilder) {
builder.ignoreFlags()
builder.wantSectionString("BODY[]", func(t testing.TB, literal string) {
messageWithInternalID = literal
})
}).checkAndRequireMessageCount(1)
}
// Append same message again.
require.NoError(t, doAppendWithClient(client, mailboxName, messageWithInternalID, time.Now(), goimap.SeenFlag))
// There should be 1 message in mailboxName and not be deleted
status, err := client.Select(mailboxName, false)
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
// Deleted flag should not be present
newFetchCommand(t, client).withItems("FLAGS").fetch("1").forSeqNum(1, func(builder *validatorBuilder) {
builder.wantFlags(imap.FlagSeen)
}).checkAndRequireMessageCount(1)
})
}
func TestAppendCanHandleOutOfOrderUIDUpdates(t *testing.T) {
// Make sure we are correctly handling the case where we have to clients doing append at the same time.
// Both clients append a message and get assigned UID according to whichever got there first:
//
// * Client A -> Append -> UID 1
// * Client B -> Append -> UID 2
//
// All Clients apply their changes to their local state immediately and will receive a deferred updates for the
// same mailbox if other clients make updates.
// In the case of client B, it appends UID2 as the first message and then later receives an update from A with
// an UID lower than the last UID which caused unnecessary panics in the past.
runManyToOneTestWithAuth(t, defaultServerOptions(t, withDisableParallelism()), []int{1, 2}, func(c map[int]*testConnection, session *testSession) {
const MessageCount = 20
// Select mailbox so that both clients get updates.
c[1].C("A001 SELECT INBOX").OK("A001")
c[2].C("A002 SELECT INBOX").OK("A002")
appendFN := func(clientIndex int) {
for i := 0; i < MessageCount; i++ {
c[clientIndex+1].doAppend("INBOX", buildRFC5322TestLiteral("To: f3@pm.me\r\n"), "\\Seen").expect("OK")
}
}
wg := sync.WaitGroup{}
wg.Add(2)
for i := 0; i < 2; i++ {
go func(index int) {
defer wg.Done()
appendFN(index)
}(i)
}
wg.Wait()
validateUIDListFn := func(index int) {
c[index].C("F001 FETCH 1:* (UID)")
for i := 1; i <= MessageCount; i++ {
c[index].S(fmt.Sprintf("* %v FETCH (UID %v)", i, i))
}
c[index].OK("F001")
}
validateUIDListFn(1)
validateUIDListFn(2)
})
}
func TestGODT2007AppendInternalIDPresentOnDeletedMessage(t *testing.T) {
const (
mailboxName = "saved-messages"
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t), func(client *client.Client, s *testSession) {
// Create message and mark deleted.
mboxID := s.mailboxCreated("user", []string{mailboxName})
messageID := s.messageCreated("user", mboxID, []byte(buildRFC5322TestLiteral("To: foo@bar.com\r\n")), time.Now())
s.flush("user")
_, err := client.Select(mailboxName, false)
require.NoError(t, err)
{
// Check if the header is correctly set.
result := newFetchCommand(t, client).withItems("UID", "BODY[HEADER]").fetch("1")
result.forSeqNum(1, func(builder *validatorBuilder) {
builder.ignoreFlags().wantSectionAndSkipGLUONHeaderOrPanic("BODY[HEADER]", buildRFC5322TestLiteral("To: foo@bar.com\r\n"))
builder.wantUID(1)
})
result.checkAndRequireMessageCount(1)
}
appendedMessage := fetchMessageBody(t, client, 1)
s.messageDeleted("user", messageID)
s.flush("user")
// Add the same message back with the same id
require.NoError(t, doAppendWithClient(client, mailboxName, appendedMessage, time.Now()))
{
// The message should have been created with a new internal id
result := newFetchCommand(t, client).withItems("UID", "BODY[HEADER]").fetch("1")
result.forSeqNum(1, func(builder *validatorBuilder) {
// The header value appears twice because we don't delete existing headers, we only add new ones.
builder.ignoreFlags().wantSectionAndSkipGLUONHeaderOrPanic("BODY[HEADER]", appendedMessage)
builder.wantUID(2)
})
result.checkAndRequireMessageCount(1)
}
})
}
func TestAppendIntoDraftsWithFromOnly(t *testing.T) {
const (
literalWithFrom = `From: Foo@bar`
literalWithoutFrom = `To: Foo@bar`
literalValid = `From: Foo@bar
Date: Wed, 26 Apr 2023 08:25:16 +0200
`
)
runOneToOneTestClientWithAuth(t, defaultServerOptions(t), func(client *client.Client, s *testSession) {
s.mailboxCreatedWithAttributes("user", []string{"Drafts"}, imap.NewFlagSet(imap.AttrDrafts))
s.flush("user")
{
require.NoError(t, doAppendWithClient(client, "Drafts", literalWithFrom, time.Now()))
require.NoError(t, doAppendWithClient(client, "INBOX", literalValid, time.Now()))
require.NoError(t, doAppendWithClient(client, "Drafts", literalWithoutFrom, time.Now()))
require.Error(t, doAppendWithClient(client, "INBOX", literalWithoutFrom, time.Now()))
}
{
status, err := client.Status("Drafts", []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(2), status.Messages, "Expected message count does not match")
}
{
status, err := client.Status("INBOX", []goimap.StatusItem{goimap.StatusMessages})
require.NoError(t, err)
require.Equal(t, uint32(1), status.Messages, "Expected message count does not match")
}
})
}
|