E2E: Add SMTP tester (grafana#88392)

* E2E: Add SMTP tester

* fix loadlocation issue when running tests on alpine

* temporary update

* add log

* update run-suite

* Update run-suite

* Update run-suite

* Update run-suite

* Update yarn.lock

* apply suggestions + cleanup logs

* update yarn.lock & package.json

* fix swagger

Author: AgnesToulet

cypress.config.js

@@ -4,6 +4,7 @@ const path = require('path');
 
 const benchmarkPlugin = require('./e2e/cypress/plugins/benchmark/index');
 const readProvisions = require('./e2e/cypress/plugins/readProvisions');
+const smtpTester = require('./e2e/cypress/plugins/smtpTester');
 const typescriptPreprocessor = require('./e2e/cypress/plugins/typescriptPreprocessor');
 
 module.exports = defineConfig({
@@ -27,6 +28,10 @@ module.exports = defineConfig({
         benchmarkPlugin.initialize(on, config);
       }
 
+      if (config.env['SMTP_PLUGIN_ENABLED'] === true) {
+        smtpTester.initialize(on, config);
+      }
+
       on('task', {
         readProvisions: (filePaths) => readProvisions({ CWD: process.cwd(), filePaths }),
       });

e2e/cypress/plugins/index.js

@@ -4,13 +4,18 @@ const path = require('path');
 const benchmarkPlugin = require('./benchmark');
 const extendConfig = require('./extendConfig');
 const readProvisions = require('./readProvisions');
+const smtpTester = require('./smtpTester');
 const typescriptPreprocessor = require('./typescriptPreprocessor');
 
 module.exports = (on, config) => {
   if (config.env['BENCHMARK_PLUGIN_ENABLED'] === true) {
     benchmarkPlugin.initialize(on, config);
   }
 
+  if (config.env['SMTP_PLUGIN_ENABLED'] === true) {
+    smtpTester.initialize(on, config);
+  }
+
   on('file:preprocessor', typescriptPreprocessor);
   on('task', {
     log({ message, optional }) {

e2e/cypress/plugins/smtpTester.js

@@ -0,0 +1,34 @@
+const ms = require('smtp-tester');
+
+const PORT = 7777;
+
+const initialize = (on, config) => {
+  // starts the SMTP server at localhost:7777
+  const mailServer = ms.init(PORT);
+  console.log('mail server at port %d', PORT);
+
+  let lastEmail = {};
+
+  // process all emails
+  mailServer.bind((addr, id, email) => {
+    lastEmail[email.headers.to] = email;
+  });
+
+  on('task', {
+    resetEmails(recipient) {
+      if (recipient) {
+        console.log('reset all emails for recipient %s', recipient);
+        delete lastEmail[recipient];
+      } else {
+        console.log('reset all emails');
+        lastEmail = {};
+      }
+    },
+
+    getLastEmail(email) {
+      return lastEmail[email] || null;
+    },
+  });
+};
+
+exports.initialize = initialize;

e2e/run-suite

@@ -66,6 +66,7 @@ case "$1" in
         ;;
     "enterprise")
         echo "Enterprise"
+        env[SMTP_PLUGIN_ENABLED]=true
         CLEANUP="rm -rf ./e2e/extensions-suite"
         SETUP="cp -Lr ./e2e/extensions ./e2e/extensions-suite"
         enterpriseSuite=$(basename "${args[1]}")
@@ -105,6 +106,11 @@ case "$1" in
                 ;;
         esac
       ;;
+   "enterprise-smtp")
+      env[SMTP_PLUGIN_ENABLED]=true
+      cypressConfig[specPattern]=./e2e/extensions/enterprise/smtp-suite/$testFilesForSingleSuite
+      cypressConfig[video]=${args[1]}
+      ;;
 
     *)
         cypressConfig[specPattern]=./e2e/"${args[0]}"/$testFilesForSingleSuite

package.json

@@ -165,6 +165,7 @@
     "css-minimizer-webpack-plugin": "6.0.0",
     "cypress": "13.10.0",
     "cypress-file-upload": "5.0.8",
+    "cypress-recurse": "^1.35.3",
     "esbuild": "0.20.2",
     "esbuild-loader": "4.1.0",
     "esbuild-plugin-browserslist": "^0.12.0",
@@ -217,6 +218,7 @@
     "rudder-sdk-js": "2.48.8",
     "sass": "1.77.4",
     "sass-loader": "14.2.1",
+    "smtp-tester": "^2.1.0",
     "style-loader": "4.0.0",
     "stylelint": "16.6.1",
     "stylelint-config-sass-guidelines": "11.1.0",

pkg/setting/setting.go

@@ -16,7 +16,6 @@ import (
 	"path"
 	"path/filepath"
 	"regexp"
-	"runtime"
 	"strconv"
 	"strings"
 	"time"
@@ -1024,9 +1023,9 @@ func (cfg *Cfg) validateStaticRootPath() error {
 func (cfg *Cfg) Load(args CommandLineArgs) error {
 	cfg.setHomePath(args)
 
-	// Fix for missing IANA db on Windows
+	// Fix for missing IANA db on Windows or Alpine
 	_, zoneInfoSet := os.LookupEnv(zoneInfo)
-	if runtime.GOOS == "windows" && !zoneInfoSet {
+	if !zoneInfoSet {
 		if err := os.Setenv(zoneInfo, filepath.Join(cfg.HomePath, "tools", "zoneinfo.zip")); err != nil {
 			cfg.Logger.Error("Can't set ZONEINFO environment variable", "err", err)
 		}