Clear separation of different message IDs in integration tests

test/context/context.go

@@ -73,6 +73,9 @@ type TestContext struct {
 	transferRemoteIMAPServer   *mocks.IMAPServer
 	transferProgress           *transfer.Progress
 
+	// Store releated variables.
+	bddMessageIDsToAPIIDs map[string]string
+
 	// These are the cleanup steps executed when Cleanup() is called.
 	cleanupSteps []*Cleaner
 
@@ -89,18 +92,19 @@ func New(app string) *TestContext {
 	cm := pmapi.NewClientManager(cfg.GetAPIConfig())
 
 	ctx := &TestContext{
-		t:                 &bddT{},
-		cfg:               cfg,
-		listener:          listener.New(),
-		pmapiController:   newPMAPIController(cm),
-		clientManager:     cm,
-		testAccounts:      newTestAccounts(),
-		credStore:         newFakeCredStore(),
-		imapClients:       make(map[string]*mocks.IMAPClient),
-		imapLastResponses: make(map[string]*mocks.IMAPResponse),
-		smtpClients:       make(map[string]*mocks.SMTPClient),
-		smtpLastResponses: make(map[string]*mocks.SMTPResponse),
-		logger:            logrus.StandardLogger(),
+		t:                     &bddT{},
+		cfg:                   cfg,
+		listener:              listener.New(),
+		pmapiController:       newPMAPIController(cm),
+		clientManager:         cm,
+		testAccounts:          newTestAccounts(),
+		credStore:             newFakeCredStore(),
+		imapClients:           make(map[string]*mocks.IMAPClient),
+		imapLastResponses:     make(map[string]*mocks.IMAPResponse),
+		smtpClients:           make(map[string]*mocks.SMTPClient),
+		smtpLastResponses:     make(map[string]*mocks.SMTPResponse),
+		bddMessageIDsToAPIIDs: make(map[string]string),
+		logger:                logrus.StandardLogger(),
 	}
 
 	// Ensure that the config is cleaned up after the test is over.

test/context/pmapi_controller.go

@@ -32,7 +32,6 @@ type PMAPIController interface {
 	AddUserLabel(username string, label *pmapi.Label) error
 	GetLabelIDs(username string, labelNames []string) ([]string, error)
 	AddUserMessage(username string, message *pmapi.Message) (string, error)
-	GetMessageID(username, messageIndex string) string
 	GetMessages(username, labelID string) ([]*pmapi.Message, error)
 	ReorderAddresses(user *pmapi.User, addressIDs []string) error
 	PrintCalls()

test/context/store.go

@@ -0,0 +1,39 @@
+// Copyright (c) 2020 Proton Technologies AG
+//
+// This file is part of ProtonMail Bridge.Bridge.
+//
+// ProtonMail 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.
+//
+// ProtonMail 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 ProtonMail Bridge.  If not, see <https://www.gnu.org/licenses/>.
+
+package context
+
+import (
+	"errors"
+)
+
+// PairMessageID sets pairing between BDD message ID and API message ID.
+func (ctx *TestContext) PairMessageID(username, bddMessageID, realMessageID string) {
+	if bddMessageID == "" {
+		return
+	}
+	ctx.bddMessageIDsToAPIIDs[username+":"+bddMessageID] = realMessageID
+}
+
+// GetAPIMessageID returns API message ID for given BDD message ID.
+func (ctx *TestContext) GetAPIMessageID(username, bddMessageID string) (string, error) {
+	msgID, ok := ctx.bddMessageIDsToAPIIDs[username+":"+bddMessageID]
+	if !ok {
+		return "", errors.New("unknown bddMessageID")
+	}
+	return msgID, nil
+}