Bug 1863636 - mochi tests for filename validation to prevent callers of new functions from creating bad file paths r=nshukla,gstoll

Added in mochi tests to validate that the C++ filename validation for taskbar tab shortcut paths works.

Differential Revision: https://phabricator.services.mozilla.com/D199689

Author: mhughes-mozilla

browser/components/shell/nsWindowsShellService.cpp

@@ -1468,7 +1468,8 @@ static void ValidateFilename(nsAString& aFilename) {
     return;
   }
 
-  uint32_t flags = nsIMIMEService::VALIDATE_SANITIZE_ONLY;
+  uint32_t flags = nsIMIMEService::VALIDATE_SANITIZE_ONLY |
+                   nsIMIMEService::VALIDATE_DONT_COLLAPSE_WHITESPACE;
 
   nsAutoString outFilename;
   mimeService->ValidateFileNameForSaving(aFilename, EmptyCString(), flags,

browser/components/shell/test/browser.toml

@@ -84,6 +84,9 @@ skip-if = [
   "tsan", #Bug 1429950 , Bug 1583315, Bug 1696109, Bug 1701449
 ]
 
+["browser_pinning.js"]
+run-if = ["os == 'win'"]
+
 ["browser_setDefaultBrowser.js"]
 
 ["browser_setDefaultPDFHandler.js"]

browser/components/shell/test/browser_pinning.js

@@ -0,0 +1,72 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+add_task(async function test_getTaskbarTabShortcutPath() {
+  // no exception generated for the following
+  ShellService.getTaskbarTabShortcutPath("working");
+  ShellService.getTaskbarTabShortcutPath("workingPath.ink");
+
+  // confirm that multiple spaces aren't collapsed
+  ShellService.getTaskbarTabShortcutPath("working    path.ink");
+
+  const invalidFilenames = [
+    // These are reserved characters that can't be in names
+    "?",
+    ":",
+    "<",
+    ">",
+    "|",
+    '"',
+    "/",
+    "*",
+    "\t",
+    "\r",
+    "\n",
+
+    // No path manipulation allowed
+    "..\\something",
+    ".\\something",
+    ".something",
+
+    // Windows doesn't allow filenames ending in period or a space
+    "something.",
+    "something ",
+
+    // The following are special reserved names
+    "CON",
+    "PRN",
+    "AUX",
+    "NUL",
+    "COM1",
+    "COM2",
+    "COM3",
+    "COM4",
+    "COM5",
+    "COM6",
+    "COM7",
+    "COM8",
+    "COM9",
+    "LPT1",
+    "LPT2",
+    "LPT3",
+    "LPT4",
+    "LPT5",
+    "LPT6",
+    "LPT7",
+    "LPT8",
+    "LPT9",
+  ];
+
+  for (const invalidFilename of invalidFilenames) {
+    Assert.throws(
+      () => {
+        ShellService.getTaskbarTabShortcutPath(invalidFilename);
+      },
+      /NS_ERROR_FILE_INVALID_PATH/,
+      invalidFilename +
+        " is an invalid filename; getTaskbarTabShortcutPath should have failed with it as a parameter."
+    );
+  }
+});