mirror of
https://github.com/ProtonMail/proton-bridge.git
synced 2025-12-10 04:36:43 +00:00
237 lines
11 KiB
Go
237 lines
11 KiB
Go
// Copyright (c) 2025 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 (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/ProtonMail/go-proton-api"
|
|
"github.com/ProtonMail/proton-bridge/v3/internal/services/imapservice/observabilitymetrics/evtloopmsgevents"
|
|
"github.com/ProtonMail/proton-bridge/v3/internal/services/imapservice/observabilitymetrics/syncmsgevents"
|
|
"github.com/ProtonMail/proton-bridge/v3/internal/services/observability"
|
|
"github.com/ProtonMail/proton-bridge/v3/internal/services/observability/gluonmetrics"
|
|
smtpMetrics "github.com/ProtonMail/proton-bridge/v3/internal/services/smtp/observabilitymetrics"
|
|
"github.com/ProtonMail/proton-bridge/v3/internal/services/syncservice/observabilitymetrics"
|
|
)
|
|
|
|
// userHeartbeatPermutationsObservability corresponds to bridge_generic_user_heartbeat_total_v1.schema.json.
|
|
func (s *scenario) userHeartbeatPermutationsObservability(username string) error {
|
|
const batchSize = 1000
|
|
metrics := observability.GenerateAllHeartbeatMetricPermutations()
|
|
metricLen := len(metrics)
|
|
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
for i := 0; i < len(metrics); i += batchSize {
|
|
end := i + batchSize
|
|
if end > metricLen {
|
|
end = metricLen
|
|
}
|
|
|
|
batch := proton.ObservabilityBatch{Metrics: metrics[i:end]}
|
|
if err := c.SendObservabilityBatch(ctx, batch); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// userDistinctionMetricsPermutationsObservability corresponds to:
|
|
// - bridge_sync_errors_users_total_v1.schema.json
|
|
// - bridge_gluon_imap_errors_users_total_v1.schema.json
|
|
// - bridge_gluon_message_errors_users_total_v1.schema.json
|
|
// - bridge_gluon_other_errors_users_total_v1.schema.json
|
|
// - bridge_event_loop_events_errors_users_total_v1.schema.json.
|
|
// - bridge_smtp_errors_users_total_v1.schema.json
|
|
func (s *scenario) userDistinctionMetricsPermutationsObservability(username string) error {
|
|
batch := proton.ObservabilityBatch{
|
|
Metrics: observability.GenerateAllUsedDistinctionMetricPermutations()}
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|
|
|
|
// syncFailureMessageEventsObservability corresponds to bridge_sync_message_event_failures_total_v1.schema.json.
|
|
func (s *scenario) syncFailureMessageEventsObservability(username string) error {
|
|
batch := proton.ObservabilityBatch{
|
|
Metrics: []proton.ObservabilityMetric{
|
|
syncmsgevents.GenerateSyncFailureCreateMessageEventMetric(),
|
|
syncmsgevents.GenerateSyncFailureDeleteMessageEventMetric(),
|
|
syncmsgevents.GenerateSyncFailureUpdateMessageEventMetric(),
|
|
syncmsgevents.GenerateSyncFailureUpdateMessageDraftEventMetric(),
|
|
syncmsgevents.GenerateSyncFailureUpdateMessageCreateEventMetric(),
|
|
syncmsgevents.GenerateSyncFailureMessageUpdateChannelDoesNotExist(),
|
|
},
|
|
}
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|
|
|
|
// eventLoopFailureMessageEventsObservability corresponds to bridge_event_loop_message_event_failures_total_v1.schema.json.
|
|
func (s *scenario) eventLoopFailureMessageEventsObservability(username string) error {
|
|
batch := proton.ObservabilityBatch{
|
|
Metrics: []proton.ObservabilityMetric{
|
|
evtloopmsgevents.GenerateMessageEventFailureCreateMessageMetric(),
|
|
evtloopmsgevents.GenerateMessageEventFailureDeleteMessageMetric(),
|
|
evtloopmsgevents.GenerateMessageEventFailureUpdateMetric(),
|
|
evtloopmsgevents.GenerateMessageEventFailureUpdateDraftMetric(),
|
|
evtloopmsgevents.GenerateMessageEventFailureUpdateCreateMetric(),
|
|
evtloopmsgevents.GenerateMessageEventUpdateChannelDoesNotExist(),
|
|
},
|
|
}
|
|
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|
|
|
|
// syncFailureMessageBuiltObservability corresponds to bridge_sync_message_event_failures_total_v1.schema.json.
|
|
func (s *scenario) syncFailureMessageBuiltObservability(username string) error {
|
|
batch := proton.ObservabilityBatch{
|
|
Metrics: []proton.ObservabilityMetric{
|
|
observabilitymetrics.GenerateNoUnlockedKeyringMetric(),
|
|
observabilitymetrics.GenerateFailedToBuildMetric(),
|
|
},
|
|
}
|
|
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|
|
|
|
// syncSuccessMessageBuiltObservability corresponds to bridge_sync_message_build_success_total_v1.schema.json.
|
|
func (s *scenario) syncSuccessMessageBuiltObservability(username string) error {
|
|
batch := proton.ObservabilityBatch{
|
|
Metrics: []proton.ObservabilityMetric{
|
|
observabilitymetrics.GenerateMessageBuiltSuccessMetric(),
|
|
},
|
|
}
|
|
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|
|
|
|
// testGluonErrorObservabilityMetrics corresponds to bridge_gluon_errors_total_v1.schema.json.
|
|
func (s *scenario) testGluonErrorObservabilityMetrics(username string) error {
|
|
allMetrics := observability.GenerateAllGluonMetrics()
|
|
|
|
parsedMetrics := []proton.ObservabilityMetric{}
|
|
for _, el := range allMetrics {
|
|
ok, parsedMetric := observability.VerifyAndParseGenericMetrics(el)
|
|
if !ok {
|
|
return fmt.Errorf("failed to parse generic gluon metric")
|
|
}
|
|
parsedMetrics = append(parsedMetrics, parsedMetric)
|
|
}
|
|
|
|
batch := proton.ObservabilityBatch{Metrics: parsedMetrics}
|
|
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|
|
|
|
// SMTPErrorObservabilityMetrics corresponds to bridge_smtp_errors_total_v1.schema.json.
|
|
func (s *scenario) SMTPErrorObservabilityMetrics(username string) error {
|
|
batch := proton.ObservabilityBatch{
|
|
Metrics: []proton.ObservabilityMetric{
|
|
smtpMetrics.GenerateFailedGetParentID(),
|
|
smtpMetrics.GenerateUnsupportedMIMEType(),
|
|
smtpMetrics.GenerateFailedCreateDraft(),
|
|
smtpMetrics.GenerateFailedCreateAttachments(),
|
|
smtpMetrics.GenerateFailedCreatePackages(),
|
|
smtpMetrics.GenerateFailedToGetRecipients(),
|
|
smtpMetrics.GenerateFailedSendDraft(),
|
|
smtpMetrics.GenerateFailedDeleteFromDrafts(),
|
|
},
|
|
}
|
|
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|
|
|
|
func (s *scenario) SMTPSendSuccessObservabilityMetric(username string) error {
|
|
batch := proton.ObservabilityBatch{
|
|
Metrics: []proton.ObservabilityMetric{
|
|
smtpMetrics.GenerateSMTPSendSuccess(),
|
|
},
|
|
}
|
|
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|
|
|
|
func (s *scenario) SMTPSendRequestObservabilityMetric(username string) error {
|
|
batch := proton.ObservabilityBatch{
|
|
Metrics: []proton.ObservabilityMetric{
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 1, 10),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 10, 25),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 30, 45),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 50, 75),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 100, 150),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 200, 250),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 300, 450),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 500, 750),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 1000, 1500),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 1900, 2500),
|
|
smtpMetrics.GenerateSMTPSubmissionRequest("outlook", 3000, 3500),
|
|
},
|
|
}
|
|
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|
|
|
|
func (s *scenario) GluonNewlyOpenedIMAPConnectionsExceedThreshold(username string) error {
|
|
batch := proton.ObservabilityBatch{
|
|
Metrics: []proton.ObservabilityMetric{
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(1), observability.BucketIMAPConnections(10)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(10), observability.BucketIMAPConnections(25)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(30), observability.BucketIMAPConnections(45)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(50), observability.BucketIMAPConnections(75)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(100), observability.BucketIMAPConnections(150)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(200), observability.BucketIMAPConnections(250)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(300), observability.BucketIMAPConnections(450)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(500), observability.BucketIMAPConnections(750)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(1000), observability.BucketIMAPConnections(1500)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(1900), observability.BucketIMAPConnections(2500)),
|
|
gluonmetrics.GenerateNewOpenedIMAPConnectionsExceedThreshold("outlook", observability.BucketIMAPConnections(3000), observability.BucketIMAPConnections(3500)),
|
|
},
|
|
}
|
|
return s.t.withClientPass(context.Background(), username, s.t.getUserByName(username).userPass, func(ctx context.Context, c *proton.Client) error {
|
|
err := c.SendObservabilityBatch(ctx, batch)
|
|
return err
|
|
})
|
|
}
|