v0.2.0 (#7)

* new release

* rename workflow

* unit tests

* fix unit tests

* version bump

* fix workflow

Author: gasse

.github/workflows/pypi.yml

@@ -1,4 +1,4 @@
-name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+name: Build and Publish
 
 on: [push, workflow_dispatch]
 

.github/workflows/unit_tests.yml

@@ -0,0 +1,102 @@
+name: Unit tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+
+  code-format:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -l {0}
+    steps:
+
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: 'pip' # caching pip dependencies
+
+      - name: Pip install
+        run: pip install black[jupyter]==24.2.0 blacken-docs
+
+      - name: Pip list
+        run: pip list
+
+      - name: Code Formatting
+        run: black . --check
+
+  browsergym-workarena-fast:
+      runs-on: ubuntu-latest
+  
+      defaults:
+        run:
+          shell: bash -l {0}
+  
+      steps:
+  
+        - name: Checkout Repository
+          uses: actions/checkout@v4
+  
+        - name: Set up Python
+          uses: actions/setup-python@v5
+          with:
+            python-version: '3.10'
+            cache: 'pip' # caching pip dependencies
+  
+        - name: Pip install
+          run: pip install -r requirements.txt
+  
+        - name: Pip list
+          run: pip list
+  
+        - name: Install Playwright
+          run: playwright install --with-deps
+  
+        - name: Run non-slow browsergym-workarena Unit Tests
+          env:
+            SNOW_INSTANCE_URL: ${{ secrets.SNOW_INSTANCE_URL }}
+            SNOW_INSTANCE_UNAME: ${{ secrets.SNOW_INSTANCE_UNAME }}
+            SNOW_INSTANCE_PWD: ${{ secrets.SNOW_INSTANCE_PWD }}
+          run: pytest -n 5 --durations=10 -m 'not slow and not pricy' --slowmo 1000 -v tests
+
+  browsergym-workarena-slow:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: 'pip' # caching pip dependencies
+
+      - name: Pip install
+        run: pip install -r requirements.txt
+
+      - name: Pip list
+        run: pip list
+
+      - name: Install Playwright
+        run: playwright install --with-deps
+
+      - name: Run slow browsergym-workarena Unit Tests
+        env:
+          SNOW_INSTANCE_URL: ${{ secrets.SNOW_INSTANCE_URL }}
+          SNOW_INSTANCE_UNAME: ${{ secrets.SNOW_INSTANCE_UNAME }}
+          SNOW_INSTANCE_PWD: ${{ secrets.SNOW_INSTANCE_PWD }}
+        run: pytest -n 5 --durations=10 -m 'slow and not pricy' --slowmo 1000 -v tests

.gitignore

@@ -0,0 +1,3 @@
+.DS_store
+__pycache__/
+*.py[cod]

requirements.txt

@@ -1,5 +1,7 @@
-browsergym-core==0.1.0rc7
+browsergym-core==0.2.0
 english-words>=2.0.1
+faker>=24.11.0
 numpy>=1.14
 requests>=2.31
 tenacity>=8.2.3  # only used in cheat() -> move to tests?
+tqdm>=4.66.2

src/browsergym/workarena/__init__.py

@@ -1,14 +1,16 @@
-__version__ = "0.1.0rc7"
+__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
 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,
@@ -21,5 +23,4 @@
     register_task(
         task.get_task_id(),
         task,
-        kwargs={"viewport": {"width": 1280, "height": 720}, "timeout": 10000},
     )

src/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

src/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

src/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)