Bug 1732376 - Add a --clean option to remove the raptor venv before r…

…unning r=sparky,perftest-reviewers

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

.hgignore

@@ -214,6 +214,9 @@ tps_result\.json
 ^testing/raptor/raptor/tests/json/
 ^testing/raptor/webext/raptor/auto_gen_test_config.js
 
+# Ignore condprofile build directory
+^testing/condprofile/build
+
 # Ignore browsertime output directory
 ^browsertime-results
 

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

@@ -530,6 +530,18 @@ class Raptor(
                     "help": "Enable marionette tracing",
                 },
             ],
+            [
+                ["--clean"],
+                {
+                    "action": "store_true",
+                    "dest": "clean",
+                    "default": False,
+                    "help": (
+                        "Clean the python virtualenv (remove, and rebuild) for "
+                        "Raptor before running tests."
+                    ),
+                },
+            ],
         ]
         + testing_config_options
         + copy.deepcopy(code_coverage_config_options)
@@ -648,6 +660,7 @@ def __init__(self, **kwargs):
         self.browsertime_video = False
         self.enable_marionette_trace = self.config.get("enable_marionette_trace")
         self.browser_cycles = self.config.get("browser_cycles")
+        self.clean = self.config.get("clean")
 
         for (arg,), details in Raptor.browsertime_options:
             # Allow overriding defaults on the `./mach raptor-test ...` command-line.
@@ -987,6 +1000,9 @@ def create_virtualenv(self, **kwargs):
         # We need it in-path to import jsonschema later when validating output for perfherder.
         _virtualenv_path = self.config.get("virtualenv_path")
 
+        if self.clean:
+            rmtree(_virtualenv_path)
+
         if self.run_local and os.path.exists(_virtualenv_path):
             self.info("Virtualenv already exists, skipping creation")
             # ffmpeg exists outside of this virtual environment so

testing/raptor/mach_commands.py

@@ -66,6 +66,7 @@ def init_variables(self, raptor_args, kwargs):
         self.device_name = kwargs["device_name"]
         self.enable_marionette_trace = kwargs["enable_marionette_trace"]
         self.browsertime_visualmetrics = kwargs["browsertime_visualmetrics"]
+        self.clean = kwargs["clean"]
 
         if Conditions.is_android(self) or kwargs["app"] in ANDROID_BROWSERS:
             self.binary_path = None
@@ -178,6 +179,7 @@ def make_config(self):
             "enable_marionette_trace": self.enable_marionette_trace,
             "browsertime_visualmetrics": self.browsertime_visualmetrics,
             "mozbuild_path": get_state_dir(),
+            "clean": self.clean,
         }
 
         sys.path.insert(0, os.path.join(self.topsrcdir, "tools", "browsertime"))

testing/raptor/raptor/cmdline.py

@@ -429,6 +429,13 @@ def create_parser(mach_interface=False):
         default=False,
         help="Enable marionette tracing",
     )
+    add_arg(
+        "--clean",
+        dest="clean",
+        action="store_true",
+        default=False,
+        help="Clean the python virtualenv (remove, and rebuild) for Raptor before running tests.",
+    )
 
     add_logging_group(parser)
     return parser