browsergym-workarena 0.1.0rc6__py3-none-any.whl → 0.2.0__py3-none-any.whl

browsergym/workarena/__init__.py

@@ -1,7 +1,8 @@
-__version__ = "0.1.0rc6"
+__version__ = "0.2.0"
 
 from browsergym.core.registration import register_task
 
+from .tasks.dashboard import __TASKS__ as DASHBOARD_TASKS
 from .tasks.form import __TASKS__ as FORM_TASKS
 from .tasks.knowledge import __TASKS__ as KB_TASKS
 from .tasks.list import __TASKS__ as LIST_TASKS
@@ -9,6 +10,7 @@ from .tasks.navigation import __TASKS__ as NAVIGATION_TASKS
 from .tasks.service_catalog import __TASKS__ as SERVICE_CATALOG_TASKS
 
 ALL_WORKARENA_TASKS = [
+    *DASHBOARD_TASKS,
     *FORM_TASKS,
     *KB_TASKS,
     *LIST_TASKS,
@@ -18,4 +20,7 @@ ALL_WORKARENA_TASKS = [
 
 # register the WorkArena benchmark
 for task in ALL_WORKARENA_TASKS:
-    register_task(task.get_task_id(), task)
+    register_task(
+        task.get_task_id(),
+        task,
+    )

browsergym/workarena/api/ui_themes.py

@@ -0,0 +1,35 @@
+"""
+Utility functions for UI themes
+
+"""
+
+from .utils import table_api_call
+
+
+def get_workarena_theme_variants(instance):
+    """
+    Get the list of available WorkArena UI themes
+
+    Parameters:
+    -----------
+    instance: SNowInstance
+        The ServiceNow instance to get the UI themes from
+
+    Returns:
+    --------
+    list[dict]
+        The list of available WorkArena UI themes and their information
+
+    """
+    themes = table_api_call(
+        instance=instance,
+        table="m2m_theme_style",
+        params={
+            "sysparm_query": "style.type=variant",
+            "sysparm_fields": "theme.name,theme.sys_id,style.name,style.sys_id",
+            "sysparm_display_value": True,
+        },
+        method="GET",
+    )["result"]
+    themes = [t for t in themes if t["theme.name"] == "WorkArena"]
+    return themes

browsergym/workarena/api/user.py

@@ -0,0 +1,153 @@
+import random
+from faker import Faker
+import time
+
+fake = Faker()
+
+from ..instance import SNowInstance
+from .ui_themes import get_workarena_theme_variants
+from .utils import table_api_call
+
+
+def create_user(
+    instance: SNowInstance,
+    first_name: str = None,
+    last_name: str = None,
+    user_name: str = None,
+    admin=True,
+) -> list[str]:
+    """
+    Create a user with a random username and password with an admin role
+
+    Parameters:
+    -----------
+    first_name: str
+        The first name of the user, defaults to a random first name
+    last_name: str
+        The last name of the user, defaults to a random last name
+    user_name: str
+        The user name of the user, defaults to first_name.last_name
+    admin: bool
+        Whether to give the user admin permissions
+
+    Returns:
+    --------
+    username, password, sys_id
+
+    """
+    user_idx = str(random.randint(1000, 9999))
+    user_password = "aStrongPassword!"
+    first_name = fake.first_name() if not first_name else first_name
+    last_name = fake.last_name() if not last_name else last_name
+
+    # Create user
+    user_data = {
+        "user_name": f"{first_name}.{last_name}.{user_idx}" if not user_name else user_name,
+        "first_name": first_name,
+        "last_name": last_name,
+        "email": f"{first_name}.{last_name}.{user_idx}@workarena.com".lower(),
+        "user_password": user_password,
+        "active": True,
+    }
+    user_params = {"sysparm_input_display_value": True}
+    user_response = table_api_call(
+        instance=instance, table="sys_user", json=user_data, params=user_params, method="POST"
+    )["result"]
+    user_name = user_response["user_name"]
+    user_sys_id = user_response["sys_id"]
+
+    # Get admin role sys_id
+    if admin:
+        role_sys_id = table_api_call(
+            instance=instance,
+            table="sys_user_role",
+            params={"sysparm_query": "name=admin", "sysparm_fields": "sys_id"},
+            method="GET",
+        )["result"][0]["sys_id"]
+
+        # Give admin permissions
+        association_data = {"user": user_sys_id, "role": role_sys_id}
+        table_api_call(
+            instance=instance, table="sys_user_has_role", json=association_data, method="POST"
+        )
+
+    # Randomly pick a UI theme and set it for the user
+    themes = get_workarena_theme_variants(instance)
+    theme = random.choice(themes)
+    set_user_preference(
+        instance, "glide.ui.polaris.theme.variant", theme["style.sys_id"], user=user_sys_id
+    )
+
+    return user_name, user_password, user_sys_id
+
+
+def set_user_preference(instance: SNowInstance, key: str, value: str, user=None) -> dict:
+    """
+    Set a user preference in the ServiceNow instance
+
+    Parameters:
+    -----------
+    key: str
+        The name of the preference
+    value: str
+        The value of the preference
+    user: str
+        The sys_id of the user. If None, the preference will be set globally.
+
+    Returns:
+    --------
+    dict
+        The preference that was set
+
+    """
+    if user is None:
+        # make it global
+        user = ""
+        system = True
+    else:
+        system = False
+
+    # Try to get the preference's sys_id
+    preference = table_api_call(
+        instance=instance,
+        table="sys_user_preference",
+        params={"sysparm_query": f"name={key},user={user}", "sysparm_fields": "sys_id"},
+    )["result"]
+
+    if not preference:
+        # ... The preference key doesn't exist, create it
+        pref_sysid = ""
+        method = "POST"
+    else:
+        # ... The preference key exists, update it
+        pref_sysid = "/" + preference[0]["sys_id"]
+        method = "PUT"
+
+    property = table_api_call(
+        instance=instance,
+        table=f"sys_user_preference{pref_sysid}",
+        method=method,
+        json={
+            "name": key,
+            "value": value,
+            "user": user,
+            "system": system,
+            "description": "Updated by WorkArena",
+        },
+    )["result"]
+
+    # Verify that the property was updated
+    property["user"] = (
+        property["user"].get("value") if isinstance(property["user"], dict) else property["user"]
+    )
+    assert (
+        property["value"] == value
+    ), f"Error setting system property {key}, incorrect value {property['value']}, while expecting {value}."
+    assert (
+        property["user"] == user
+    ), f"Error setting system property {key}, incorrect user {property['user']}, while expecting {user}."
+    assert (
+        property["system"] == str(system).lower()
+    ), f"Error setting {key}, incorrect system {property['system']}, while expecting {system}."
+
+    return property

browsergym/workarena/api/utils.py

@@ -86,7 +86,7 @@ def table_column_info(instance: SNowInstance, table: str) -> dict:
 
     # Clean column value choices
     for info in meta_info.values():
-        if "choices" in info:
+        if info.get("choices", None):
             info["choices"] = {c["value"]: c["label"] for c in info["choices"]}
 
     # Query the sys_dictionnary table to find more info (e.g., is this column dependent on another)

browsergym/workarena/config.py

@@ -7,10 +7,25 @@ from ..workarena.tasks import utils
 SNOW_DATA_LOOKBACK_MINUTES = 5
 SNOW_BROWSER_TIMEOUT = 30000  # Milliseconds
 SNOW_JS_UTILS_FILEPATH = str(resources.files(utils).joinpath("js_utils.js"))
-SNOW_SUPPORTED_RELEASES = ["utah"]
+SNOW_SUPPORTED_RELEASES = ["washingtondc"]
 
 # Path to the Menu navigation task configuration
 ALL_MENU_PATH = str(resources.files(data_files).joinpath("task_configs/all_menu.json"))
+
+# Path to the dashboard/report retrieval task configurations
+DASHBOARD_RETRIEVAL_MINMAX_CONFIG_PATH = str(
+    resources.files(data_files).joinpath("task_configs/dashboard_retrieval_minmax_task.json")
+)
+DASHBOARD_RETRIEVAL_VALUE_CONFIG_PATH = str(
+    resources.files(data_files).joinpath("task_configs/dashboard_retrieval_value_task.json")
+)
+REPORT_RETRIEVAL_MINMAX_CONFIG_PATH = str(
+    resources.files(data_files).joinpath("task_configs/report_retrieval_minmax_task.json")
+)
+REPORT_RETRIEVAL_VALUE_CONFIG_PATH = str(
+    resources.files(data_files).joinpath("task_configs/report_retrieval_value_task.json")
+)
+
 # Path to knowledge base task configurations
 KB_CONFIG_PATH = str(
     resources.files(data_files).joinpath("task_configs/knowledge_base_configs.json")
@@ -119,6 +134,28 @@ WORKFLOWS = {
     }
 }
 
+
+# Custom UI Themes
+UI_THEMES_UPDATE_SET = {
+    "name": "WorkArena UI Themes",
+    "update_set": str(
+        resources.files(data_files).joinpath("setup_files/ui_themes/workarena_themes.xml")
+    ),
+    "variants": [
+        "Astranova",
+        "Charlies",
+        "Great pasta",
+        "Mighty capital",
+        "Speedy tires",
+        "Skyward",
+        "Turbobots",
+        "Ultrashoes",
+        "Vitasphere",
+        "Workarena",
+    ],
+}
+
+
 # Expected columns for list tasks; used in setup
 EXPECTED_ASSET_LIST_COLUMNS_PATH = str(
     resources.files(data_files).joinpath("setup_files/lists/expected_asset_list_columns.json")
@@ -163,3 +200,8 @@ EXPECTED_PROBLEM_FORM_FIELDS_PATH = str(
 EXPECTED_USER_FORM_FIELDS_PATH = str(
     resources.files(data_files).joinpath("setup_files/forms/expected_user_form_fields.json")
 )
+
+
+# Report date filter patch flag
+REPORT_PATCH_FLAG = "WORKARENA_DATE_FILTER_PATCH"
+REPORT_DATE_FILTER = "2024-04-01"

browsergym/workarena/data_files/setup_files/lists/expected_asset_list_columns.json

@@ -1 +1,34 @@
-["model.display_name", "model_category", "asset_tag", "substatus", "asset_function", "install_status", "sys_class_name", "assigned_to", "serial_number", "location"]
+[
+    "model.display_name",
+    "model_category",
+    "asset_tag",
+    "substatus",
+    "asset_function",
+    "install_status",
+    "sys_class_name",
+    "assigned_to",
+    "serial_number",
+    "location",
+    "vendor",
+    "assigned",
+    "company",
+    "cost",
+    "department",
+    "display_name",
+    "model",
+    "sys_updated_by",
+    "sys_updated_on",
+    "sys_mod_count",
+    "retirement_date",
+    "retired",
+    "residual",
+    "quantity",
+    "purchase_date",
+    "po_number",
+    "order_date",
+    "delivery_date",
+    "managed_by",
+    "invoice_number",
+    "cost_center",
+    "warranty_expiration"
+]

browsergym/workarena/data_files/setup_files/lists/expected_change_request_list_columns.json

@@ -1 +1,48 @@
-["requested_by", "type", "sys_created_on", "end_date", "assignment_group", "assigned_to", "risk", "start_date", "state", "number", "short_description", "chg_model"]
+[
+    "number",
+    "short_description",
+    "chg_model",
+    "type",
+    "state",
+    "risk",
+    "start_date",
+    "end_date",
+    "requested_by",
+    "assignment_group",
+    "assigned_to",
+    "sys_created_on",
+    "active",
+    "work_end",
+    "work_start",
+    "approval",
+    "approval_history",
+    "approval_set",
+    "backout_plan",
+    "category",
+    "change_plan",
+    "close_code",
+    "close_notes",
+    "closed_at",
+    "closed_by",
+    "cmdb_ci",
+    "conflict_last_run",
+    "conflict_status",
+    "contact_type",
+    "sys_created_by",
+    "delivery_plan",
+    "delivery_task",
+    "description",
+    "task_effective_number",
+    "escalation",
+    "impact",
+    "implementation_plan",
+    "justification",
+    "knowledge",
+    "made_sla",
+    "opened_at",
+    "opened_by",
+    "phase",
+    "phase_state",
+    "priority",
+    "reassignment_count"
+]

browsergym/workarena/data_files/setup_files/lists/expected_hardware_list_columns.json

@@ -1 +1,53 @@
-["display_name", "model_category", "asset_tag", "serial_number", "assigned_to", "company", "install_status", "substatus", "cost", "ci", "asset_function"]
+[
+    "display_name",
+    "model_category",
+    "asset_tag",
+    "serial_number",
+    "assigned_to",
+    "company",
+    "install_status",
+    "substatus",
+    "cost",
+    "ci",
+    "asset_function",
+    "acquisition_method",
+    "active_to",
+    "assigned",
+    "beneficiary",
+    "checked_in",
+    "checked_out",
+    "sys_class_name",
+    "comments",
+    "cost_center",
+    "sys_created_on",
+    "sys_created_by",
+    "department",
+    "due",
+    "due_in",
+    "eligible_for_refresh",
+    "expenditure_type",
+    "install_date",
+    "invoice_number",
+    "justification",
+    "lease_id",
+    "location",
+    "managed_by",
+    "model",
+    "delivery_date",
+    "order_date",
+    "owned_by",
+    "po_number",
+    "purchase_date",
+    "quantity",
+    "request_line",
+    "retirement_date",
+    "skip_sync",
+    "stockroom",
+    "support_group",
+    "supported_by",
+    "sys_updated_on",
+    "sys_updated_by",
+    "sys_mod_count",
+    "vendor",
+    "warranty_expiration"
+]

browsergym/workarena/data_files/setup_files/lists/expected_incident_list_columns.json

@@ -1 +1,28 @@
-["number", "caller_id", "category", "cmdb_ci", "priority", "state", "short_description", "assignment_group", "assigned_to", "child_incidents"]
+[
+    "number",
+    "caller_id",
+    "category",
+    "cmdb_ci",
+    "priority",
+    "state",
+    "short_description",
+    "assignment_group",
+    "assigned_to",
+    "child_incidents",
+    "active",
+    "activity_due",
+    "business_duration",
+    "business_stc",
+    "closed_at",
+    "closed_by",
+    "company",
+    "sys_created_on",
+    "sys_created_on",
+    "description",
+    "calendar_duration",
+    "task_effective_number",
+    "escalation",
+    "impact",
+    "incident_state",
+    "location"
+]

browsergym/workarena/data_files/setup_files/lists/expected_service_catalog_list_columns.json

@@ -1 +1,29 @@
-["name", "short_description", "active", "roles", "sc_catalogs", "category", "price", "type", "sys_updated_on"]
+[
+    "name",
+    "short_description",
+    "active",
+    "roles",
+    "sc_catalogs",
+    "category",
+    "price",
+    "type",
+    "sys_updated_on",
+    "access_type",
+    "sys_scope",
+    "availability",
+    "sys_class_name",
+    "mobile_picture_type",
+    "sys_created_on",
+    "sys_created_by",
+    "delivery_time",
+    "sys_name",
+    "description",
+    "delivery_plan",
+    "fulfillment_automation_level",
+    "flow_designer_flow",
+    "no_cart_v2",
+    "no_wishlist_v2",
+    "no_attachment_v2",
+    "hide_sp",
+    "no_quantity_v2"
+]