peroxide/test/store_setup_test.go

// Copyright (c) 2022 Proton AG
//
// This file is part of Proton Mail Bridge.Bridge.
//
// Proton Mail Bridge is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Proton Mail Bridge is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Proton Mail Bridge. If not, see <https://www.gnu.org/licenses/>.

package tests

import (
	"fmt"
	"net/mail"
	"net/textproto"
	"strconv"
	"strings"
	"time"

	"github.com/ProtonMail/proton-bridge/v2/pkg/pmapi"
	"github.com/cucumber/godog"
)

func StoreSetupFeatureContext(s *godog.ScenarioContext) {
	s.Step(`^there is "([^"]*)" with mailboxes`, thereIsUserWithMailboxes)
	s.Step(`^there is "([^"]*)" with mailbox "([^"]*)"$`, thereIsUserWithMailbox)
	s.Step(`^there are messages in mailbox(?:es)? "([^"]*)" for "([^"]*)"$`, thereAreMessagesInMailboxesForUser)
	s.Step(`^there are messages in mailbox(?:es)? "([^"]*)" for address "([^"]*)" of "([^"]*)"$`, thereAreMessagesInMailboxesForAddressOfUser)
	s.Step(`^there are (\d+) messages in mailbox(?:es)? "([^"]*)" for "([^"]*)"$`, thereAreSomeMessagesInMailboxesForUser)
	s.Step(`^there are messages for "([^"]*)" as follows$`, thereAreSomeMessagesForUserAsFollows)
	s.Step(`^there are (\d+) messages in mailbox(?:es)? "([^"]*)" for address "([^"]*)" of "([^"]*)"$`, thereAreSomeMessagesInMailboxesForAddressOfUser)
	s.Step(`^wait for Sphinx to create duplication indices$`, waitForSphinx)
	s.Step(`^message(?:s)? "([^"]*)" (?:was|were) deleted forever without event processed for "([^"]*)"$`, messageWasDeletedWithoutEvent)
}

func thereIsUserWithMailboxes(bddUserID string, mailboxes *godog.Table) error {
	for _, row := range mailboxes.Rows {
		if err := thereIsUserWithMailbox(bddUserID, row.Cells[0].Value); err != nil {
			return err
		}
	}
	return nil
}

func thereIsUserWithMailbox(bddUserID, mailboxName string) error {
	account := ctx.GetTestAccount(bddUserID)
	if account == nil {
		return godog.ErrPending
	}
	err := ctx.GetPMAPIController().AddUserLabel(account.Username(), &pmapi.Label{
		Name: mailboxName,
		Type: pmapi.LabelTypeMailBox,
	})
	if err != nil {
		return internalError(err, "adding label %s for %s", mailboxName, account.Username())
	}
	store, err := ctx.GetStore(account.Username())
	if err != nil {
		return internalError(err, "getting store of %s", account.Username())
	}
	if store == nil {
		return nil
	}
	return internalError(store.RebuildMailboxes(), "rebuilding mailboxes")
}

func thereAreMessagesInMailboxesForUser(mailboxNames, bddUserID string, messages *godog.Table) error {
	return thereAreMessagesInMailboxesForAddressOfUser(mailboxNames, "", bddUserID, messages)
}

func thereAreMessagesInMailboxesForAddressOfUser(mailboxNames, bddAddressID, bddUserID string, messages *godog.Table) error {
	account := ctx.GetTestAccountWithAddress(bddUserID, bddAddressID)
	if account == nil {
		return godog.ErrPending
	}

	// It is needed to prevent event processing before syncing these message
	// otherwise the seqID and UID will be in reverse order. The
	// synchronization add newest message first, the eventloop adds the oldest
	// message first.
	ctx.MessagePreparationStarted(account.Username())
	defer ctx.MessagePreparationFinished(account.Username())

	labelIDs, err := ctx.GetPMAPIController().GetLabelIDs(account.Username(), strings.Split(mailboxNames, ","))
	if err != nil {
		return internalError(err, "getting labels %s for %s", mailboxNames, account.Username())
	}

	var markMessageIDsDeleted []string

	// Inserting in the opposite order becase sync is done from newest to oldest.
	// The goal is to have simply predictable IMAP sequence numbers if possible.
	head := messages.Rows[0].Cells
	for i := len(messages.Rows) - 1; i > 0; i-- {
		row := messages.Rows[i]
		message := &pmapi.Message{
			MIMEType:   pmapi.ContentTypePlainText,
			LabelIDs:   labelIDs,
			AddressID:  account.AddressID(),
			ExternalID: fmt.Sprintf("%d@integration.setup.test", time.Now().Unix()),
		}
		header := make(textproto.MIMEHeader)

		if message.HasLabelID(pmapi.SentLabel) {
			message.Flags |= pmapi.FlagSent
		} else {
			// some tests (Outlook move by DELETE EXPUNGE APPEND) imply creating hard copies of emails,
			// and the importMessage() function flags the email as Sent if the 'Received' key in not present in the
			// header.
			header.Add("Received", "from dummy.protonmail.com")
			message.Flags |= pmapi.FlagReceived
		}

		if message.HasLabelID(pmapi.DraftLabel) {
			message.Flags = pmapi.FlagInternal | pmapi.FlagE2E
		}

		bddMessageID := ""
		hasDeletedFlag := false

		for n, cell := range row.Cells {
			column := head[n].Value
			if column == "id" {
				bddMessageID = cell.Value
			}
			if column == "deleted" {
				hasDeletedFlag = cell.Value == "true"
			}
			err := processMessageTableCell(column, cell.Value, account.Username(), message, &header)
			if err != nil {
				return err
			}
		}
		message.Header = mail.Header(header)
		lastMessageID, err := ctx.GetPMAPIController().AddUserMessage(account.Username(), message)
		if err != nil {
			return internalError(err, "adding message")
		}
		ctx.PairMessageID(account.Username(), bddMessageID, lastMessageID)

		if hasDeletedFlag {
			markMessageIDsDeleted = append(markMessageIDsDeleted, lastMessageID)
		}
	}

	if err := internalError(ctx.WaitForSync(account.Username()), "waiting for sync"); err != nil {
		return err
	}

	if len(markMessageIDsDeleted) > 0 {
		for _, mailboxName := range strings.Split(mailboxNames, ",") {
			storeMailbox, err := ctx.GetStoreMailbox(account.Username(), account.AddressID(), mailboxName)
			if err != nil {
				return err
			}
			if err := storeMailbox.MarkMessagesDeleted(markMessageIDsDeleted); err != nil {
				return err
			}
		}
	}

	return nil
}

func processMessageTableCell(column, cellValue, username string, message *pmapi.Message, header *textproto.MIMEHeader) error {
	switch column {
	case "deleted", "id": // it is processed in the main function
	case "from":
		message.Sender = &mail.Address{
			Address: ctx.EnsureAddress(username, cellValue),
		}
	case "to":
		message.AddressID = ctx.EnsureAddressID(username, cellValue)
		message.ToList = []*mail.Address{{
			Address: ctx.EnsureAddress(username, cellValue),
		}}
	case "cc":
		message.AddressID = ctx.EnsureAddressID(username, cellValue)
		message.CCList = []*mail.Address{{
			Address: ctx.EnsureAddress(username, cellValue),
		}}
	case "subject":
		message.Subject = cellValue
	case "body":
		message.Body = cellValue
	case "read":
		var unread pmapi.Boolean

		if cellValue == "true" { //nolint:goconst
			unread = false
		} else {
			unread = true
		}

		message.Unread = unread
	case "starred":
		if cellValue == "true" {
			message.LabelIDs = append(message.LabelIDs, "10")
		}
	case "time": //nolint:goconst It is more easy to read like this
		date, err := time.Parse(timeFormat, cellValue)
		if err != nil {
			return internalError(err, "parsing time")
		}
		header.Set("Date", date.Format(time.RFC1123Z))
		// API will sanitize the date to not have negative timestamp
		if date.After(time.Unix(0, 0)) {
			message.Time = date.Unix()
		} else {
			message.Time = 0
		}
	case "n attachments":
		numAttachments, err := strconv.Atoi(cellValue)
		if err != nil {
			return internalError(err, "parsing n attachments")
		}
		message.NumAttachments = numAttachments
	case "content type":
		switch cellValue {
		case "html":
			message.MIMEType = pmapi.ContentTypeHTML
		case "plain":
			message.MIMEType = pmapi.ContentTypePlainText
		}
	default:
		return fmt.Errorf("unexpected column name: %s", column)
	}

	return nil
}

func thereAreSomeMessagesInMailboxesForUser(numberOfMessages int, mailboxNames, bddUserID string) error {
	return thereAreSomeMessagesInMailboxesForAddressOfUser(numberOfMessages, mailboxNames, "", bddUserID)
}

func thereAreSomeMessagesForUserAsFollows(bddUserID string, structure *godog.Table) error {
	return processMailboxStructureDataTable(structure, func(bddAddressID string, mailboxNames string, numberOfMessages int) error {
		return thereAreSomeMessagesInMailboxesForAddressOfUser(numberOfMessages, mailboxNames, bddAddressID, bddUserID)
	})
}

func processMailboxStructureDataTable(structure *godog.Table, callback func(string, string, int) error) error {
	head := structure.Rows[0].Cells
	for i := 1; i < len(structure.Rows); i++ {
		bddAddressID := ""
		mailboxNames := "INBOX"
		numberOfMessages := 0
		for n, cell := range structure.Rows[i].Cells {
			switch head[n].Value {
			case "address":
				bddAddressID = cell.Value
			case "mailboxes":
				mailboxNames = cell.Value
			case "messages":
				number, err := strconv.Atoi(cell.Value)
				if err != nil {
					return internalError(err, "converting number of messages to integer")
				}
				numberOfMessages = number
			default:
				return fmt.Errorf("unexpected column name: %s", head[n].Value)
			}
		}

		if err := callback(bddAddressID, mailboxNames, numberOfMessages); err != nil {
			return err
		}
	}
	return nil
}

func thereAreSomeMessagesInMailboxesForAddressOfUser(numberOfMessages int, mailboxNames, bddAddressID, bddUserID string) error {
	account := ctx.GetTestAccountWithAddress(bddUserID, bddAddressID)
	if account == nil {
		return godog.ErrPending
	}

	// It is needed to prevent event processing before syncing these message
	// otherwise the seqID and UID will be in reverse order. The
	// synchronization add newest message first, the eventloop adds the oldest
	// message first.
	ctx.MessagePreparationStarted(account.Username())
	defer ctx.MessagePreparationFinished(account.Username())

	for i := 1; i <= numberOfMessages; i++ {
		labelIDs, err := ctx.GetPMAPIController().GetLabelIDs(account.Username(), strings.Split(mailboxNames, ","))
		if err != nil {
			return internalError(err, "getting labels %s for %s", mailboxNames, account.Username())
		}
		lastMessageID, err := ctx.GetPMAPIController().AddUserMessage(account.Username(), &pmapi.Message{
			MIMEType:   "text/plain",
			LabelIDs:   labelIDs,
			AddressID:  account.AddressID(),
			Subject:    fmt.Sprintf("Test message #%d", i),
			Sender:     &mail.Address{Address: "anyone@example.com"},
			ToList:     []*mail.Address{{Address: account.Address()}},
			ExternalID: fmt.Sprintf("%d@integration.setup.test", time.Now().Unix()),
		})
		if err != nil {
			return internalError(err, "adding message")
		}

		// Generating IDs in the opposite order becase sync is done from newest to oldest.
		// The goal is to have simply predictable IMAP sequence numbers if possible.
		bddMessageID := fmt.Sprintf("%d", numberOfMessages-i+1)
		ctx.PairMessageID(account.Username(), bddMessageID, lastMessageID)
	}
	return internalError(ctx.WaitForSync(account.Username()), "waiting for sync")
}

func waitForSphinx() error {
	time.Sleep(15 * time.Second)
	return nil
}

func messageWasDeletedWithoutEvent(bddMessageID, bddUserID string) error {
	account := ctx.GetTestAccount(bddUserID)
	if account == nil {
		return godog.ErrPending
	}
	apiID, err := ctx.GetAPIMessageID(account.Username(), bddMessageID)
	if err != nil {
		return internalError(err, "getting BDD message ID %s", bddMessageID)
	}

	return ctx.GetPMAPIController().RemoveUserMessageWithoutEvent(account.Username(), apiID)
}