feat(GODT-2710): Send config success on IMAP/SMTP connection..

tests/bdd_test.go

@@ -254,6 +254,9 @@ func TestFeatures(testingT *testing.T) {
 			ctx.Step(`^bridge needs to send heartbeat`, s.bridgeNeedsToSendHeartbeat)
 			ctx.Step(`^bridge do not need to send heartbeat`, s.bridgeDoNotNeedToSendHeartbeat)
 			ctx.Step(`^heartbeat is not whitelisted`, s.heartbeatIsNotwhitelisted)
+			ctx.Step(`^config status file exist for user "([^"]*)"$`, s.configStatusFileExistForUser)
+			ctx.Step(`^config status is pending for user "([^"]*)"$`, s.configStatusIsPendingForUser)
+			ctx.Step(`^config status succeed for user "([^"]*)"$`, s.configStatusSucceedForUser)
 		},
 		Options: &godog.Options{
 			Format:   "pretty",

tests/config_status_test.go

@@ -0,0 +1,95 @@
+// Copyright (c) 2023 Proton AG
+//
+// This file is part of Proton Mail 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 (
+	"encoding/json"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/ProtonMail/proton-bridge/v3/internal/configstatus"
+)
+
+func (s *scenario) configStatusFileExistForUser(username string) error {
+	configStatusFile, err := getConfigStatusFile(s.t, username)
+	if err != nil {
+		return err
+	}
+	if _, err := os.Stat(configStatusFile); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (s *scenario) configStatusIsPendingForUser(username string) error {
+	configStatusFile, err := getConfigStatusFile(s.t, username)
+	if err != nil {
+		return err
+	}
+	data, err := loadConfigStatusFile(configStatusFile)
+	if err != nil {
+		return err
+	}
+	if data.DataV1.PendingSince.IsZero() {
+		return fmt.Errorf("expected ConfigStatus pending but got success instead")
+	}
+
+	return nil
+}
+
+func (s *scenario) configStatusSucceedForUser(username string) error {
+	configStatusFile, err := getConfigStatusFile(s.t, username)
+	if err != nil {
+		return err
+	}
+	data, err := loadConfigStatusFile(configStatusFile)
+	if err != nil {
+		return err
+	}
+	if !data.DataV1.PendingSince.IsZero() {
+		return fmt.Errorf("expected ConfigStatus success but got pending since %s", data.DataV1.PendingSince)
+	}
+
+	return nil
+}
+
+func getConfigStatusFile(t *testCtx, username string) (string, error) {
+	userID := t.getUserByName(username).getUserID()
+	statsDir, err := t.locator.ProvideStatsPath()
+	if err != nil {
+		return "", fmt.Errorf("failed to get Statistics directory: %w", err)
+	}
+	return filepath.Join(statsDir, userID+".json"), nil
+}
+
+func loadConfigStatusFile(filepath string) (configstatus.ConfigurationStatusData, error) {
+	data := configstatus.ConfigurationStatusData{}
+	if _, err := os.Stat(filepath); err != nil {
+		return data, err
+	}
+
+	f, err := os.Open(filepath)
+	if err != nil {
+		return data, err
+	}
+	defer func() { _ = f.Close() }()
+
+	err = json.NewDecoder(f).Decode(&data)
+	return data, err
+}

tests/features/bridge/config_status.feature

@@ -0,0 +1,28 @@
+Feature: Configuration Status Telemetry
+  Background:
+    Given there exists an account with username "[user:user]" and password "password"
+    Then it succeeds
+    When bridge starts
+    Then it succeeds
+
+  Scenario: Init config status on user addition
+    Then bridge telemetry feature is enabled
+    When the user logs in with username "[user:user]" and password "password"
+    Then config status file exist for user "[user:user]"
+    And config status is pending for user "[user:user]"
+
+  Scenario: Config Status Success on IMAP
+    Then bridge telemetry feature is enabled
+    When the user logs in with username "[user:user]" and password "password"
+    Then config status file exist for user "[user:user]"
+    And config status is pending for user "[user:user]"
+    When user "[user:user]" connects and authenticates IMAP client "1"
+    Then config status succeed for user "[user:user]"
+
+  Scenario: Config Status Success on SMTP
+    Then bridge telemetry feature is enabled
+    When the user logs in with username "[user:user]" and password "password"
+    Then config status file exist for user "[user:user]"
+    And config status is pending for user "[user:user]"
+    When user "[user:user]" connects and authenticates SMTP client "1"
+    Then config status succeed for user "[user:user]"