Bug 1701511 - Only install visual metrics dependencies when requested on the command line; r=perftest-reviewers,Bebe

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

testing/mozharness/mozharness/mozilla/testing/raptor.py

@@ -617,7 +617,7 @@ class Raptor(
         self.chromium_dist_path = None
         self.firefox_android_browsers = ["fennec", "geckoview", "refbrow", "fenix"]
         self.android_browsers = self.firefox_android_browsers + ["chrome-m"]
-        self.browsertime_visualmetrics = False
+        self.browsertime_visualmetrics = self.config.get("browsertime_visualmetrics")
         self.browsertime_video = False
         self.enable_marionette_trace = self.config.get("enable_marionette_trace")
         self.browser_cycles = self.config.get("browser_cycles")
@@ -996,7 +996,7 @@ class Raptor(
         )
 
         modules = ["pip>=1.5"]
-        if self.run_local:
+        if self.run_local and self.browsertime_visualmetrics:
             # Add modules required for visual metrics
             modules.extend(
                 ["numpy==1.16.1", "Pillow==6.1.0", "scipy==1.2.3", "pyssim==0.4"]

testing/raptor/mach_commands.py

@@ -66,6 +66,7 @@ class RaptorRunner(MozbuildObject):
         self.conditioned_profile_scenario = kwargs["conditioned_profile_scenario"]
         self.device_name = kwargs["device_name"]
         self.enable_marionette_trace = kwargs["enable_marionette_trace"]
+        self.browsertime_visualmetrics = kwargs["browsertime_visualmetrics"]
 
         if Conditions.is_android(self) or kwargs["app"] in ANDROID_BROWSERS:
             self.binary_path = None
@@ -176,6 +177,7 @@ class RaptorRunner(MozbuildObject):
             "is_release_build": self.is_release_build,
             "device_name": self.device_name,
             "enable_marionette_trace": self.enable_marionette_trace,
+            "browsertime_visualmetrics": self.browsertime_visualmetrics,
         }
 
         sys.path.insert(0, os.path.join(self.topsrcdir, "tools", "browsertime"))

testing/raptor/raptor/browsertime/base.py

@@ -445,7 +445,9 @@ class Browsertime(Perftest):
                 if self.vismet_failed:
                     raise Exception(
                         "Browsertime visual metrics dependencies were not "
-                        "installed correctly."
+                        "installed correctly. Try removing the virtual environment at "
+                        "%s before running your command again."
+                        % os.environ["VIRTUAL_ENV"]
                     )
 
             proc = self.process_handler(cmd, processOutputLine=_line_handler, env=env)

testing/raptor/requirements.txt

@@ -2,7 +2,7 @@ mozcrash ~= 2.0
 mozrunner ~= 7.0
 mozprofile ~= 2.1
 manifestparser >= 1.1
-wptserve ~= 2.0
+wptserve ~= 3.0
 mozdevice >= 4.0.0
 pyyaml ~= 3.1
 mozpower >= 1.0.0