zarro 1.141.1 → 1.141.2

package/gulp-tasks/modules/register-environment-variables.js

@@ -571,6 +571,36 @@
  instruct Zarro to read the mapping in foo.json for extra msbuild properties to pass on
  where applicable.`
         });
+        env.register({
+            name: "DEV_SMTP_PORT",
+            help: `the port to start the smtp dev server on`,
+            default: "25"
+        });
+        env.register({
+            name: "DEV_SMTP_INTERFACE_PORT",
+            help: "the port to start the http interface on for the dev smtp server",
+            default: "8025"
+        });
+        env.register({
+            name: "DEV_SMTP_DETACHED",
+            help: "start the dev smtp server in the background (ie, don't wait on it); you'll have to stop it yourself",
+            default: "false"
+        });
+        env.register({
+            name: "DEV_SMTP_IGNORE_ERRORS",
+            help: "when set true, don't break on being unable to download or run the dev smtp server software - just log it and move on",
+            default: "false"
+        });
+        env.register({
+            name: "DEV_SMTP_BIND_IP",
+            help: "IP to listen on for SMTP connections; default is to bind to all available interfaces",
+            default: ""
+        });
+        env.register({
+            name: "DEV_SMTP_INTERFACE_BIND_IP",
+            help: "IP to listen on for the interface; default is to bind to all available interfaces",
+            default: ""
+        });
         debug("-- env registration complete --");
     };
 })();

package/gulp-tasks/modules/spawn.js

@@ -124,24 +124,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
             opts.stdio = [...defaultOptions.stdio];
         }
         let stdOutWriter = nullConsumer, stdErrWriter = nullConsumer, stdoutFnSpecified = typeof opts.stdout === "function", stderrFnSpecified = typeof opts.stderr === "function";
-        if ((stdoutFnSpecified || stderrFnSpecified) &&
-            !Array.isArray(opts.stdio) &&
-            !!defaultOptions.stdio /* just to make ts happy */) {
-            opts.stdio = [...defaultOptions.stdio];
-        }
-        if (stdoutFnSpecified) {
-            stdOutWriter = opts.stdout;
-            opts.stdio[1] = "pipe";
-        }
-        else if (Array.isArray(opts.stdio)) {
-            opts.stdio[1] = "inherit";
-        }
-        if (stderrFnSpecified) {
-            stdErrWriter = opts.stderr;
-            opts.stdio[2] = "pipe";
+        if (opts.detached) {
+            opts.stdio = "ignore";
+            opts.stdout = undefined;
+            opts.stderr = undefined;
         }
-        else if (Array.isArray(opts.stdio)) {
-            opts.stdio[2] = "inherit";
+        else {
+            if ((stdoutFnSpecified || stderrFnSpecified) &&
+                !Array.isArray(opts.stdio) &&
+                !!defaultOptions.stdio /* just to make ts happy */) {
+                opts.stdio = [...defaultOptions.stdio];
+            }
+            if (stdoutFnSpecified) {
+                stdOutWriter = opts.stdout;
+                opts.stdio[1] = "pipe";
+            }
+            else if (Array.isArray(opts.stdio)) {
+                opts.stdio[1] = "inherit";
+            }
+            if (stderrFnSpecified) {
+                stdErrWriter = opts.stderr;
+                opts.stdio[2] = "pipe";
+            }
+            else if (Array.isArray(opts.stdio)) {
+                opts.stdio[2] = "inherit";
+            }
         }
         const result = new SpawnResult(executable, args, -1, [], []);
         executable = quoteIfRequired(executable);
@@ -152,7 +159,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
             try {
                 const child = child_process.spawn(executable, quotedArgs, opts);
                 if (!child) {
-                    reject(new Error(`unable to spawn ${executable} with args [${args.join(",")}]`));
+                    return reject(new Error(`unable to spawn ${executable} with args [${args.join(",")}]`));
+                }
+                if (opts.detached) {
+                    return resolve(result);
                 }
                 debug(child);
                 const stdout = [];

package/gulp-tasks/start-dev-smtp-server.js

@@ -0,0 +1,80 @@
+"use strict";
+(function () {
+    const { ZarroError } = requireModule("zarro-error"), { redBright } = requireModule("ansi-colors"), env = requireModule("env"), debug = require("debug")("start-smtp-server"), gulp = requireModule("gulp");
+    env.associate([
+        env.DEV_SMTP_DETACHED,
+        env.DEV_SMTP_PORT,
+        env.DEV_SMTP_BIND_IP,
+        env.DEV_SMTP_INTERFACE_PORT,
+        env.DEV_SMTP_INTERFACE_BIND_IP,
+        env.DEV_SMTP_IGNORE_ERRORS
+    ], "start-dev-smtp-server");
+    gulp.task("start-dev-smtp-server", async () => {
+        const spawn = requireModule("spawn"), mailpitBinary = await downloadMailPitToToolsFolder(), mailpitAllIps = "[::]", smtpPort = env.resolveNumber(env.DEV_SMTP_PORT), smtpIp = env.resolveWithFallback(env.DEV_SMTP_BIND_IP, mailpitAllIps), smtpInterfacePort = env.resolveNumber(env.DEV_SMTP_INTERFACE_PORT), smtpInterfaceIp = env.resolveWithFallback(env.DEV_SMTP_INTERFACE_BIND_IP, mailpitAllIps), raiseErrors = !env.resolveFlag(env.DEV_SMTP_IGNORE_ERRORS);
+        if (mailpitBinary === undefined) {
+            const downloadError = `Unable to download mailpit from GitHub`;
+            if (raiseErrors) {
+                throw new ZarroError(downloadError);
+            }
+            else {
+                console.error(redBright(downloadError));
+                return;
+            }
+        }
+        const args = [];
+        pushSmtpBind(args, smtpIp, smtpPort);
+        pushSmtpInterfacePort(args, smtpInterfaceIp, smtpInterfacePort);
+        try {
+            await spawn(mailpitBinary, args, {
+                detached: env.resolveFlag(env.DEV_SMTP_DETACHED)
+            });
+        }
+        catch (e) {
+            if (raiseErrors) {
+                throw e;
+            }
+            const err = e;
+            logError(err.message || `${e}`);
+        }
+    });
+    function logError(err) {
+        console.error(redBright(err));
+    }
+    function pushSmtpBind(args, ip, port) {
+        args.push("--smtp");
+        args.push(`${validateIp(ip)}:${port}`);
+    }
+    function pushSmtpInterfacePort(args, ip, port) {
+        args.push("--listen");
+        args.push(`${validateIp(ip)}:${port}`);
+    }
+    function validateIp(ip) {
+        if (ip.match(/^(\d{1,3}\.){3}\d{1,3}$/)) {
+            return ip;
+        }
+        throw new ZarroError(`provided value is not a valid IP: ${ip}`);
+    }
+    async function downloadMailPitToToolsFolder() {
+        const os = require("os"), { ls } = require("yafs"), path = require("path"), getToolsFolder = requireModule("get-tools-folder"), { fetchLatestRelease } = require("fetch-github-release");
+        const target = path.join(getToolsFolder(), "mailpit");
+        await fetchLatestRelease({
+            owner: "axllent",
+            repo: "mailpit",
+            destination: target,
+            shouldExtract: true
+        });
+        const contents = await ls(target, { fullPaths: true });
+        const seek = os.platform() === "win32"
+            ? "mailpit.exe"
+            : "mailpit";
+        for (const item of contents) {
+            const fn = path.basename(item);
+            if (fn.toLowerCase() === seek) {
+                debug(`will start smtp server at: ${item}`);
+                return item;
+            }
+        }
+        console.error(redBright(`Unable to find mailpit binary under ${target}`));
+        return undefined;
+    }
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zarro",
-  "version": "1.141.1",
+  "version": "1.141.2",
   "description": "Some glue to make gulp easier, perhaps even zero- or close-to-zero-conf",
   "bin": {
     "zarro": "./index.js"
@@ -44,6 +44,7 @@
     "del": "^5.1.0",
     "event-stream": "^4.0.1",
     "fancy-log": "^1.3.3",
+    "fetch-github-release": "^1.0.0",
     "gulp": "^4.0.2",
     "gulp-debug": "^4.0.0",
     "gulp-dotnet-cli": "^1.1.0",

package/types.d.ts

@@ -148,7 +148,9 @@ declare global {
     "DOTNET_TEST_PREFIXES" |
     "VERSION_INCREMENT_STRATEGY" |
     "BUILD_TOOLS_FOLDER" |
-    "MSBUILD_PROPERTIES";
+    "MSBUILD_PROPERTIES" |
+    "DEV_SMTP_BIND_IP" |
+    "DEV_SMTP_INTERFACE_BIND_IP";
 
   type NumericEnvVar =
     "BUILD_MAX_CPU_COUNT" |
@@ -161,7 +163,9 @@ declare global {
     "MAX_RETRIES" |
     "BUILD_RETRIES" |
     "RESTORE_RETRIES" |
-    "MAX_CONCURRENCY";
+    "MAX_CONCURRENCY" |
+    "DEV_SMTP_PORT" |
+    "DEV_SMTP_INTERFACE_PORT";
 
   type FlagEnvVar =
     "ENABLE_NUGET_PARALLEL_PROCESSING" |
@@ -196,7 +200,9 @@ declare global {
     "DOTNET_PUBLISH_USE_CURRENT_RUNTIME" |
     "PACK_NO_BUILD" |
     "PACK_NO_RESTORE" |
-    "ZARRO_ENABLE_CONFIGURATION_FILES";
+    "ZARRO_ENABLE_CONFIGURATION_FILES" |
+    "DEV_SMTP_DETACHED" |
+    "DEV_SMTP_IGNORE_ERRORS";
 
   type AnyEnvVar = StringEnvVar | NumericEnvVar | FlagEnvVar | VersionIncrementStrategy;
   type OverrideWhen = (existing: Optional<string>, potential: Optional<string>) => boolean;
@@ -284,6 +290,8 @@ declare global {
     VERSION_INCREMENT_STRATEGY: VersionIncrementStrategy;
     BUILD_TOOLS_FOLDER: StringEnvVar;
     MSBUILD_PROPERTIES: StringEnvVar;
+    DEV_SMTP_BIND_IP: StringEnvVar;
+    DEV_SMTP_INTERFACE_BIND_IP: StringEnvVar;
 
     ENABLE_NUGET_PARALLEL_PROCESSING: FlagEnvVar;
     BUILD_SHOW_INFO: FlagEnvVar;
@@ -317,6 +325,8 @@ declare global {
     PACK_NO_RESTORE: FlagEnvVar;
     PACK_IGNORE_MISSING_DEFAULT_NUSPEC: FlagEnvVar;
     ZARRO_ENABLE_CONFIGURATION_FILES: FlagEnvVar;
+    DEV_SMTP_DETACHED: FlagEnvVar;
+    DEV_SMTP_IGNORE_ERRORS: FlagEnvVar;
 
     BUILD_MAX_CPU_COUNT: NumericEnvVar;
     MAX_NUNIT_AGENTS: NumericEnvVar;
@@ -329,6 +339,8 @@ declare global {
     BUILD_RETRIES: NumericEnvVar;
     RESTORE_RETRIES: NumericEnvVar;
     MAX_CONCURRENCY: NumericEnvVar;
+    DEV_SMTP_PORT: NumericEnvVar;
+    DEV_SMTP_INTERFACE_PORT: NumericEnvVar;
   }
 
   type StatFunction = (path: string) => Promise<fs.Stats | null>
@@ -587,6 +599,8 @@ declare global {
     stderr?: ProcessIO;
     lineBuffer?: boolean;
 
+    detached?: boolean;
+
     /*
     * when a process is marked as interactive, no stderr/stdout
     * collection is done as the IO is left as "inherit"