feat: add Servo as web browser subject with tar.gz support (WIP)

Author: GJFR

bughog/subject/factory.py

@@ -15,16 +15,14 @@
 from bughog.subject.web_browser.chromium.subject import Chromium
 from bughog.subject.web_browser.evaluation_framework import BrowserEvaluationFramework
 from bughog.subject.web_browser.firefox.subject import Firefox
+from bughog.subject.web_browser.servo.subject import Servo
 
 subjects = {
     'js_engine': {'evaluation_framework': JSEngineEvaluationFramework, 'subjects': [V8Subject(), V8SandboxSubject()]},
     'wasm_runtime': {'evaluation_framework': WasmRuntimeEvaluationFramework, 'subjects': [WasmtimeSubject()]},
     'web_browser': {
         'evaluation_framework': BrowserEvaluationFramework,
-        'subjects': [
-            Chromium(),
-            Firefox(),
-        ],
+        'subjects': [Chromium(), Firefox(), Servo()],
     },
 }
 

bughog/subject/web_browser/servo/__init__.py

@@ -0,0 +1,53 @@
+import re
+
+from bughog import cli
+from bughog.parameters import SubjectConfiguration
+from bughog.subject.web_browser.executable import BrowserExecutable
+from bughog.version_control.state.base import State
+
+
+class ServoExecutable(BrowserExecutable):
+    def __init__(self, config: SubjectConfiguration, state: State) -> None:
+        super().__init__(config, state)
+        self._profile_path = None
+
+    @property
+    def executable_name(self) -> str:
+        return 'servo'
+
+    def _get_version(self) -> str:
+        command = f'./{self.executable_name} --version'
+        output = cli.execute_and_return_output(command, cwd=self.staging_folder)
+        match = re.match(r'Chromium (?P<version>[0-9]+\.[0-9]+\.[0-9]+)', output)
+        if match:
+            return match.group('version')
+        raise AttributeError(f"Could not determine version of executable at '{self.executable_name}'.")
+
+    def _optimize_for_storage(self) -> None:
+        pass
+
+    def _configure_executable(self) -> None:
+        cli.execute_and_return_status(f'chmod -R a+x {self.staging_folder}')
+
+    @property
+    def post_experiment_sleep_duration(self) -> int:
+        return 1
+
+    @property
+    def open_console_hotkey(self) -> list[str]:
+        raise NotImplementedError()
+
+    @property
+    def supported_options(self) -> list[str]:
+        return []
+
+    def _get_cli_command(self) -> list[str]:
+        cmd = [self.executable_path, f'--profile={self._profile_path}']
+        return cmd
+
+    def _prepare_profile_folder(self):
+        cli.execute_and_return_status(f'mkdir -p {self._profile_path}')
+
+    def _remove_profile_folder(self):
+        if self._profile_path:
+            cli.execute_and_return_status(f'rm -rf {self._profile_path}')

bughog/subject/web_browser/servo/executable.py

@@ -0,0 +1,52 @@
+from typing import Literal
+
+from bughog.subject.state_oracle import StateOracle
+from bughog.version_control.conversion import bughog_service
+
+
+class ServoStateOracle(StateOracle):
+    def find_commit_nb(self, commit_id: str) -> int:
+        return bughog_service.find_commit_nb(self.subject_name, commit_id)
+
+    def find_commit_id(self, commit_nb: int) -> str | None:
+        return bughog_service.find_commit_id(self.subject_name, commit_nb)
+
+    def find_commit_of_release(self, release_version: int) -> tuple[int, str]:
+        return bughog_service.find_version_commit(self.subject_name, release_version)
+
+    def get_oldest_supported_release_version(self) -> int:
+        return 0
+
+    def get_most_recent_major_release_version(self) -> int:
+        return bughog_service.find_latest_major_version(self.subject_name)
+
+    def has_public_executable(self, state_index: int, state_type: Literal['release', 'commit']) -> bool:
+        match state_type:
+            case 'release':
+                # For now, only support commits.
+                return False
+            case 'commit':
+                return bughog_service.find_commit_executable_info(self.subject_name, state_index) is not None
+
+    def get_executable_download_urls(self, state_index: int, state_type: Literal['release', 'commit']) -> list[str]:
+        match state_type:
+            case 'release':
+                # For now, only support commits.
+                return []
+            case 'commit':
+                commit_info = bughog_service.find_commit_executable_info(self.subject_name, state_index)
+                if commit_info is None:
+                    return []
+                return [commit_info['base_url'] + 'servo-latest.tar.gz']
+
+    def get_nearest_commit_with_executable(
+        self, target_commit_nb: int, lower_bound: int, upper_bound: int
+    ) -> int | None:
+        commit_info = bughog_service.find_nearest_commit_with_executable(
+            self.subject_name, target_commit_nb, lower_bound, upper_bound
+        )
+        return commit_info.get('nb') if commit_info else None
+
+    def get_commit_url(self, commit_nb: int, commit_id: str | None) -> str | None:
+        commit_info = bughog_service.find_commit_info(self.subject_name, commit_nb)
+        return commit_info.get('url') if commit_info else None

bughog/subject/web_browser/servo/state_oracle.py

@@ -0,0 +1,19 @@
+from bughog.parameters import SubjectConfiguration
+from bughog.subject.state_oracle import StateOracle
+from bughog.subject.web_browser.servo.executable import ServoExecutable
+from bughog.subject.web_browser.servo.state_oracle import ServoStateOracle
+from bughog.subject.web_browser.subject import WebBrowser
+from bughog.version_control.state.base import State
+
+
+class Servo(WebBrowser):
+    @property
+    def name(self) -> str:
+        return 'servo'
+
+    @property
+    def _state_oracle_class(self) -> type[StateOracle]:
+        return ServoStateOracle
+
+    def create_executable(self, subject_configuration: SubjectConfiguration, state: State) -> ServoExecutable:
+        return ServoExecutable(subject_configuration, state)

bughog/subject/web_browser/servo/subject.py

@@ -170,7 +170,7 @@ def __get_session(token: Optional[str] = None, max_retries: int = 3, backoff_fac
 def download_and_extract(urls: list[str], dst_folder_path: str) -> bool:
     """
     Downloads the archive residing at the given URL and extracts it to the given dest_path.
-    This method currently supports zip, tar.bz2 and tar.xz archives.
+    This method currently supports zip, tar.gz, tar.bz2 and tar.xz archives.
 
     :return bool: Returns True if the archive was successfully downloaded and extracted, otherwise False.
     """
@@ -196,9 +196,7 @@ def download_and_extract(urls: list[str], dst_folder_path: str) -> bool:
         match file_extension:
             case '.zip':
                 unzip(tmp_file_path, dst_folder_path)
-            case '.bz2':
-                untar(tmp_file_path, dst_folder_path)
-            case '.xz':
+            case '.gz' | '.bz2' | '.xz':
                 untar(tmp_file_path, dst_folder_path)
             case _:
                 AttributeError(f'File extension {file_extension} is not supported.')