add new examples for chrome

desktop_env/evaluators/getters/__init__.py

@@ -12,7 +12,11 @@ from .chrome import (
     get_profile_name,
     get_number_of_search_results,
     get_googledrive_file,
-    get_active_tab_info
+    get_active_tab_info,
+    get_enable_do_not_track,
+    get_enable_enhanced_safety_browsing,
+    get_new_startup_page,
+    get_find_unpacked_extension_path
 )
 from .file import get_cloud_file, get_vm_file, get_cache_file
 from .general import get_vm_command_line, get_vm_terminal_output

desktop_env/evaluators/getters/chrome.py

@@ -363,6 +363,9 @@ def get_active_tab_info(env, config: Dict[str, str]):
                 break
 
         browser.close()
+        print("active_tab_title: {}".format(active_tab_info.get('title', 'None')))
+        print("active_tab_url: {}".format(active_tab_info.get('url', 'None')))
+        print("active_tab_content: {}".format(active_tab_info.get('content', 'None')))
         return active_tab_info
 
 
@@ -516,4 +519,133 @@ def get_googledrive_file(env, config: Dict[str, Any]) -> str:
                         else f"title = '{fp}' and trashed = false" for jdx, fp in enumerate(path)]
             dest = config['dest'][idx]
             _path_list.append(get_single_file(query, os.path.join(env.cache_dir, dest)))
-        return _path_list
+        return _path_list
+
+
+def get_enable_do_not_track(env, config: Dict[str, str]):
+    os_type = env.vm_platform
+    if os_type == 'Windows':
+        preference_file_path = env.controller.execute_python_command("""import os; print(os.path.join(os.getenv('LOCALAPPDATA'),
+                                            'Google\\Chrome\\User Data\\Default\\Preferences'))""")['output'].strip()
+    elif os_type == 'Darwin':
+        preference_file_path = env.controller.execute_python_command(
+            "import os; print(os.path.join(os.getenv('HOME'), 'Library/Application Support/Google/Chrome/Default/Preferences'))")[
+            'output'].strip()
+    elif os_type == 'Linux':
+        # preference_file_path = env.controller.execute_python_command(
+        #     "import os; print(os.path.join(os.getenv('HOME'), '.config/google-chrome/Default/Preferences'))")[
+        #     'output'].strip()
+        preference_file_path = env.controller.execute_python_command(
+            "import os; print(os.path.join(os.getenv('HOME'), 'snap/chromium/common/chromium/Default/Preferences'))")[
+            'output'].strip()
+    else:
+        raise Exception('Unsupported operating system')
+
+    try:
+        content = env.controller.get_file(preference_file_path)
+        data = json.loads(content)
+
+        if_enable_do_not_track = data.get('enable_do_not_track', {}) # bool
+        return "true" if if_enable_do_not_track else "false"
+    except Exception as e:
+        logger.error(f"Error: {e}")
+        return "Google"
+
+
+def get_enable_enhanced_safety_browsing(env, config: Dict[str, str]):
+    os_type = env.vm_platform
+    if os_type == 'Windows':
+        preference_file_path = env.controller.execute_python_command("""import os; print(os.path.join(os.getenv('LOCALAPPDATA'),
+                                            'Google\\Chrome\\User Data\\Default\\Preferences'))""")['output'].strip()
+    elif os_type == 'Darwin':
+        preference_file_path = env.controller.execute_python_command(
+            "import os; print(os.path.join(os.getenv('HOME'), 'Library/Application Support/Google/Chrome/Default/Preferences'))")[
+            'output'].strip()
+    elif os_type == 'Linux':
+        # preference_file_path = env.controller.execute_python_command(
+        #     "import os; print(os.path.join(os.getenv('HOME'), '.config/google-chrome/Default/Preferences'))")[
+        #     'output'].strip()
+        preference_file_path = env.controller.execute_python_command(
+            "import os; print(os.path.join(os.getenv('HOME'), 'snap/chromium/common/chromium/Default/Preferences'))")[
+            'output'].strip()
+    else:
+        raise Exception('Unsupported operating system')
+
+    try:
+        content = env.controller.get_file(preference_file_path)
+        data = json.loads(content)
+
+        if_enable_do_not_track = data.get('safebrowsing', {}).get('enhanced', {}) # bool
+        return "true" if if_enable_do_not_track else "false"
+    except Exception as e:
+        logger.error(f"Error: {e}")
+        return "Google"
+
+
+def get_new_startup_page(env, config: Dict[str, str]):
+    os_type = env.vm_platform
+    if os_type == 'Windows':
+        preference_file_path = env.controller.execute_python_command("""import os; print(os.path.join(os.getenv('LOCALAPPDATA'),
+                                            'Google\\Chrome\\User Data\\Default\\Preferences'))""")['output'].strip()
+    elif os_type == 'Darwin':
+        preference_file_path = env.controller.execute_python_command(
+            "import os; print(os.path.join(os.getenv('HOME'), 'Library/Application Support/Google/Chrome/Default/Preferences'))")[
+            'output'].strip()
+    elif os_type == 'Linux':
+        # preference_file_path = env.controller.execute_python_command(
+        #     "import os; print(os.path.join(os.getenv('HOME'), '.config/google-chrome/Default/Preferences'))")[
+        #     'output'].strip()
+        preference_file_path = env.controller.execute_python_command(
+            "import os; print(os.path.join(os.getenv('HOME'), 'snap/chromium/common/chromium/Default/Preferences'))")[
+            'output'].strip()
+    else:
+        raise Exception('Unsupported operating system')
+
+    try:
+        content = env.controller.get_file(preference_file_path)
+        data = json.loads(content)
+
+        # if data has no key called 'session', it means the chrome is on a fresh-start mode, which is a true state;
+        # otherwise, try to find the code number in 'restored_on_startup' in 'session'
+        if "session" not in data.keys():
+            return "true"
+        else:
+            if_enable_do_not_track = data.get('session', {}).get('restore_on_startup', {}) # int, need to be 5
+            return "true" if if_enable_do_not_track == 5 else "false"
+    except Exception as e:
+        logger.error(f"Error: {e}")
+        return "Google"
+
+
+def get_find_unpacked_extension_path(env, config: Dict[str, str]):
+    os_type = env.vm_platform
+    if os_type == 'Windows':
+        preference_file_path = env.controller.execute_python_command("""import os; print(os.path.join(os.getenv('LOCALAPPDATA'),
+                                            'Google\\Chrome\\User Data\\Default\\Preferences'))""")['output'].strip()
+    elif os_type == 'Darwin':
+        preference_file_path = env.controller.execute_python_command(
+            "import os; print(os.path.join(os.getenv('HOME'), 'Library/Application Support/Google/Chrome/Default/Preferences'))")[
+            'output'].strip()
+    elif os_type == 'Linux':
+        # preference_file_path = env.controller.execute_python_command(
+        #     "import os; print(os.path.join(os.getenv('HOME'), '.config/google-chrome/Default/Preferences'))")[
+        #     'output'].strip()
+        preference_file_path = env.controller.execute_python_command(
+            "import os; print(os.path.join(os.getenv('HOME'), 'snap/chromium/common/chromium/Default/Preferences'))")[
+            'output'].strip()
+    else:
+        raise Exception('Unsupported operating system')
+
+    try:
+        content = env.controller.get_file(preference_file_path)
+        data = json.loads(content)
+        # Preferences store all the path of installed extensions, return them all and let metrics try to find one matches the targeted extension path
+        all_extensions_path = []
+        all_extensions = data.get('extensions', {}).get('settings', {})
+        for id in all_extensions.keys():
+            path = all_extensions[id]["path"]
+            all_extensions_path.append(path)
+        return all_extensions_path
+    except Exception as e:
+        logger.error(f"Error: {e}")
+        return "Google"

desktop_env/evaluators/metrics/__init__.py

@@ -15,7 +15,8 @@ from .chrome import (
     check_font_size,
     check_enabled_experiments,
     check_history_deleted,
-    is_expected_search_query
+    is_expected_search_query,
+    is_expected_active_tab
 )
 from .docs import (
     compare_font_names,
@@ -53,6 +54,7 @@ from .general import (
     check_json,
     check_list,
     exact_match,
+    is_in_list,
     fuzzy_match,
     check_include_exclude
 )

desktop_env/evaluators/metrics/chrome.py

@@ -9,6 +9,22 @@ from desktop_env.evaluators.metrics.utils import are_lists_equal, compare_urls
 logger = logging.getLogger("desktopenv.metrics.chrome")
 
 
+def is_expected_active_tab(active_tab_info: Dict[str, str], rule: Dict[str, Any]) -> float:
+    """
+    Checks if the expected active tab is open in Chrome.
+    """
+    match_type = rule['type']
+
+    if match_type == "url":
+        expected_url = rule['url']
+        actual_url = active_tab_info['url']
+        print("expected_url: {}".format(expected_url))
+        print("actual_url: {}".format(actual_url))
+        return 1 if compare_urls(expected_url, actual_url) else 0
+    else:
+        logger.error(f"Unknown type: {match_type}")
+        return 0
+
 def is_expected_tabs(open_tabs: List[Dict[str, str]], rule: Dict[str, Any]) -> float:
     """
     Checks if the expected tabs are open in Chrome.

desktop_env/evaluators/metrics/general.py

@@ -38,7 +38,13 @@ def exact_match(result, rules) -> float:
     else:
         return 0.
 
-
+def is_in_list(result, rules) -> float:
+    expect = rules["expected"]
+    if expect in result:
+        return 1.
+    else:
+        return 0.
+    
 def fuzzy_match(result, rules) -> float:
     expect = rules["expected"]