Bug 2036752 - allow skeleton UI when MOZ_BYPASS_FELT is set for tests

Author: victhorlopez

mozglue/misc/PreXULSkeletonUI.cpp

@@ -1633,6 +1633,7 @@ static Result<Ok, PreXULSkeletonUIError> ValidateCmdlineArguments(
 #endif
 
     bool approved = false;
+    int j = 0;
     for (const char* approvedArg : approvedArguments) {
       // We do a case-insensitive compare here with _stricmp. Even though some
       // of these arguments are *not* read as case-insensitive, others *are*.
@@ -1644,25 +1645,35 @@ static Result<Ok, PreXULSkeletonUIError> ValidateCmdlineArguments(
       if (!_stricmp(flag, approvedArg)) {
         approved = true;
 
-        if (i == profileArgIndex) {
+        if (j == profileArgIndex) {
           *explicitProfile = true;
         }
         break;
       }
+      ++j;
     }
 
     if (!approved) {
       return Err(PreXULSkeletonUIError::Cmdline);
     }
   }
 
+#if defined(MOZ_ENTERPRISE)
+  // If there is MOZ_BYPASS_FELT environment variable, then likely tests are
+  // executing and thus no `-felt <socket>` argument can be found to verify if
+  // this is running a browser. By essence of that variable it is known the
+  // browser is running and not Felt UI so explicitely use the PreSkeletonUI
+  // in this case.
+  if (EnvHasValue("MOZ_BYPASS_FELT")) {
+    return Ok();
+  }
+
   // When starting FELT, disable the PreXULSkeletonUI. Checking with
   // is_felt_browser() is not doable here because this symbol is defined in
   // libxul however the present code runs in firefox.exe. Hence checking the
   // existence of "-felt" as is_felt_browser() would be doing, so
   // PreXULSkeletonUI is kept for normal browser, just disabled for FELT
   // window.
-#if defined(MOZ_ENTERPRISE)
   if (!hasFeltFlag) {
     return Err(PreXULSkeletonUIError::Cmdline);
   }
@@ -2116,6 +2127,9 @@ HWND ConsumePreXULSkeletonUIHandle() {
   ::CloseHandle(sPreXULSKeletonUIAnimationThread);
   sPreXULSKeletonUIAnimationThread = nullptr;
   HWND result = sPreXULSkeletonUIWindow;
+  if (sPreXULSkeletonUIWindow) {
+    sPreXULSkeletonUIShown = true;
+  }
   sPreXULSkeletonUIWindow = nullptr;
   free(sPixelBuffer);
   sPixelBuffer = nullptr;

testing/enterprise/manifest.toml

@@ -54,6 +54,11 @@ run-if = [
 
 ["test_felt_browser_signout_verify.py"]
 
+["test_felt_browser_skeleton_ui.py"]
+run-if = [
+  "os == 'win'",
+]
+
 ["test_felt_browser_starts.py"]
 
 ["test_felt_browser_starts_missing_bin.py"]

testing/enterprise/test_felt_browser_skeleton_ui.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+import os
+import sys
+
+sys.path.append(os.path.dirname(__file__))
+
+from test_felt_browser_signout import BaseBrowserSignout
+
+
+class BrowserSkeletonUI(BaseBrowserSignout):
+    def test_skeleton_ui_not_shown_for_felt(self):
+        self.run_check_skeleton_ui(self._driver, expected=False)
+
+        super().run_felt_base()
+        self.connect_child_browser(
+            capabilities={
+                # Do not auto-handle prompts.
+                "unhandledPromptBehavior": "ignore"
+            }
+        )
+        # Skeleton UI is not shown for the child browser either, which is
+        # expected since we use FELT and don't need it.
+        self.run_check_skeleton_ui(self._child_driver, expected=False)
+        self._do_signout()
+
+        self._logger.info("Restarting felt out-of-process")
+        self.marionette.restart(in_app=False)
+        self._logger.info("Felt restarted")
+        self.run_check_skeleton_ui(self._driver, expected=False)
+        self._manually_closed_child = True
+
+    def run_check_skeleton_ui(self, driver, expected):
+        with driver.using_context(driver.CONTEXT_CHROME):
+            showed = driver.execute_script(
+                "return Services.startup.showedPreXULSkeletonUI;"
+            )
+        self._logger.info(f"showedPreXULSkeletonUI: {showed}")
+
+        assert showed == expected, (
+            f"Expected showedPreXULSkeletonUI to be {expected}, got {showed}"
+        )