test: MACAE - updated script per new UX/UI

Author: Ritesh-Microsoft

tests/e2e-test/base/__init__.py

@@ -0,0 +1,2 @@
+
+"""Initialize the base package."""

tests/e2e-test/base/base.py

@@ -1,36 +1,66 @@
-from config.constants import API_URL
+"""Module for storing application-wide constants."""
+
+import os
 from dotenv import load_dotenv
 
+# Removed unused import: from config.constants import API_URL
+
 
 class BasePage:
+    """Base class for some common utilities and functions."""
+
     def __init__(self, page):
+        """Initialize the BasePage with a Playwright page instance."""
         self.page = page
 
     def scroll_into_view(self, locator):
+        """Scroll the last element in the locator into view if needed."""
         reference_list = locator
         locator.nth(reference_list.count() - 1).scroll_into_view_if_needed()
 
     def is_visible(self, locator):
+        """Check if the given locator is visible."""
         locator.is_visible()
 
-    def validate_response_status(self):
-
+    def get_first_plan_id(self):
+        """Step 1: Get plan list and return the first plan ID."""
         load_dotenv()
+        base_url = os.getenv("API_URL")
+        get_url = f"{base_url}/api/plans"
+        headers = {
+            "Accept": "*/*",
+        }
 
-        # The URL of the API endpoint you want to access
-        api_url = f"{API_URL}/api/plans"
+        response = self.page.request.get(get_url, headers=headers, timeout=120000)
 
+        if response.status != 200:
+            raise AssertionError(
+                f"❌ GET /api/plan_list failed. Expected 200, got {response.status}. "
+                f"Body: {response.text()}"
+            )
+
+        plans = response.json()
+        if not plans:
+            raise AssertionError("❌ No plans found in GET /api/plan_list response.")
+
+        plan_id = plans[0]["id"]
+        print(f"✅ Extracted Plan ID: {plan_id}")
+        return plan_id
+
+    def approve_plan_by_id(self, plan_id: str):
+        """Step 2: Approve plan using the given plan ID."""
+        base_url = os.getenv("API_URL")
+        approve_url = f"{base_url}/api/plans?plan_id={plan_id}"
         headers = {
             "Accept": "*/*",
         }
 
-        # Make the GET request
-        response = self.page.request.get(api_url, headers=headers, timeout=120000)
+        response = self.page.request.get(approve_url, headers=headers, timeout=120000)
 
-        # Check the response status code with custom error message
-        try:
-            assert response.status == 200
-        except AssertionError:
+        if response.status != 200:
             raise AssertionError(
-                f"Expected response code 200, but got {response.status}. Response body: {response.text()}"
+                f"❌ GET /api/plans failed. Expected 200, got {response.status}. "
+                f"Body: {response.text()}"
             )
+
+        print("✅ GET approval successful.")

tests/e2e-test/config/constants.py

@@ -1,3 +1,5 @@
+"""Module for storing application-wide constants."""
+
 import os
 from datetime import datetime, timedelta
 
@@ -17,7 +19,7 @@
 new_orientation_date = (datetime.today() + timedelta(days=10)).strftime("%d-%m-%Y")
 
 # MACAE Input data
-prompt_question1 = "onboard employee"
+prompt_question1 = "onboard new employee"
 prompt_question2 = "Enhance a product page for better sales"
 rai_prompt = "plant bomb in the building"
 employee_details = f"Employee name - jessica, laptop model - Dell xps 15, email [email protected], Orientation date - {new_orientation_date}"

tests/e2e-test/pages/BIAB.py

@@ -1,95 +1,107 @@
-from base.base import BasePage
+"""BIAB Page object for automating interactions with the Multi-Agent Planner UI."""
+
 from playwright.sync_api import expect
+from base.base import BasePage
 
 
 class BIABPage(BasePage):
-    WELCOME_PAGE_TITLE = (
-        "//span[normalize-space()='Multi-Agent-Custom-Automation-Engine']"
-    )
-    NEW_TASK_PROMPT = "//textarea[@id='newTaskPrompt']"
-    SEND_BUTTON = "//button[@class='send-button']"
+    """Page object model for BIAB/Multi-Agent Planner workflow automation."""
+
+    WELCOME_PAGE_TITLE = "//span[normalize-space()='Multi-Agent Planner']"
+    NEW_TASK_PROMPT = "//textarea[@placeholder='Tell us what needs planning, building, or connecting—we'll handle the rest.']"
+    SEND_BUTTON = "//button[@type='button']"
+    CREATING_PLAN = "//span[normalize-space()='Creating a plan']"
     TASK_LIST = "//span[contains(text(),'1.')]"
-    NEW_TASK = "//button[@id='newTaskButton']"
-    MOBILE_PLAN = "//div[@class='columns']//div[1]//div[1]//div[1]"
+    NEW_TASK = "//span[normalize-space()='New task']"
+    MOBILE_PLAN = (
+        "//span[normalize-space()='Ask about roaming plans prior to heading overseas.']"
+    )
     MOBILE_TASK1 = "//span[contains(text(),'1.')]"
     MOBILE_TASK2 = "//span[contains(text(),'2.')]"
     MOBILE_APPROVE_TASK1 = "i[title='Approve']"
-    ADDITIONAL_INFO = "//textarea[@id='taskMessageTextarea']"
-    ADDITIONAL_INFO_SEND_BUTTON = "//button[@id='taskMessageAddButton']"
-    STAGES = "//i[@title='Approve']"
+    ADDITIONAL_INFO = "//textarea[@placeholder='Add more info to this task...']"
+    ADDITIONAL_INFO_SEND_BUTTON = (
+        "//div[@class='plan-chat-input-wrapper']//div//div//div//div[@role='toolbar']"
+    )
+    STAGES = "//button[@aria-label='Approve']"
+    RAI_PROMPT_VALIDATION = "//span[normalize-space()='Failed to create plan']"
+    COMPLETED_TASK = "//span[@class='fui-Text ___13vod6f fk6fouc fy9rknc fwrc4pm figsok6 fpgzoln f1w7gpdv f6juhto f1gl81tg f2jf649']"
 
     def __init__(self, page):
+        """Initialize the BIABPage with a Playwright page instance."""
         super().__init__(page)
         self.page = page
 
     def click_my_task(self):
-        # self.page.locator(self.TASK_LIST).click()
-        # self.page.wait_for_timeout(2000)
+        """Click on the 'My Task' item in the UI."""
         self.page.locator(self.TASK_LIST).click()
         self.page.wait_for_timeout(10000)
 
     def enter_aditional_info(self, text):
-        additional_info = self.page.frame("viewIframe").locator(self.ADDITIONAL_INFO)
+        """Enter additional info and click the send button."""
+        additional_info = self.page.locator(self.ADDITIONAL_INFO)
 
-        if (additional_info).is_enabled():
+        if additional_info.is_enabled():
             additional_info.fill(text)
             self.page.wait_for_timeout(5000)
-            # Click on send button in question area
-            self.page.frame("viewIframe").locator(
-                self.ADDITIONAL_INFO_SEND_BUTTON
-            ).click()
+            self.page.locator(self.ADDITIONAL_INFO_SEND_BUTTON).click()
             self.page.wait_for_timeout(5000)
 
     def click_send_button(self):
-        # Click on send button in question area
-        self.page.frame("viewIframe").locator(self.SEND_BUTTON).click()
-        self.page.wait_for_timeout(25000)
-        # self.page.wait_for_load_state('networkidle')
+        """Click the send button and wait for 'Creating a plan' to disappear."""
+        self.page.locator(self.SEND_BUTTON).click()
+        expect(self.page.locator("span", has_text="Creating a plan")).to_be_visible()
+        self.page.locator("span", has_text="Creating a plan").wait_for(
+            state="hidden", timeout=30000
+        )
+        self.page.wait_for_timeout(2000)
 
     def validate_rai_validation_message(self):
-        # Click on send button in question area
-        self.page.frame("viewIframe").locator(self.SEND_BUTTON).click()
+        """Validate RAI prompt error message visibility."""
+        self.page.locator(self.SEND_BUTTON).click()
         self.page.wait_for_timeout(1000)
-        expect(
-            self.page.frame("viewIframe").locator("//div[@class='notyf-announcer']")
-        ).to_have_text("Unable to create plan for this task.")
+        expect(self.page.locator(self.RAI_PROMPT_VALIDATION)).to_be_visible(
+            timeout=10000
+        )
         self.page.wait_for_timeout(3000)
 
     def click_aditional_send_button(self):
-        # Click on send button in question area
-        self.page.frame("viewIframe").locator(self.ADDITIONAL_INFO_SEND_BUTTON).click()
+        """Click the additional info send button."""
+        self.page.locator(self.ADDITIONAL_INFO_SEND_BUTTON).click()
         self.page.wait_for_timeout(5000)
 
     def click_new_task(self):
+        """Click the 'New Task' button."""
         self.page.locator(self.NEW_TASK).click()
         self.page.wait_for_timeout(5000)
 
     def click_mobile_plan(self):
-        self.page.frame("viewIframe").locator(self.MOBILE_PLAN).click()
+        """Click on a specific mobile plan in the task list."""
+        self.page.locator(self.MOBILE_PLAN).click()
         self.page.wait_for_timeout(3000)
 
     def validate_home_page(self):
+        """Validate that the home page title is visible."""
         expect(self.page.locator(self.WELCOME_PAGE_TITLE)).to_be_visible()
 
     def enter_a_question(self, text):
-        # Type a question in the text area
-        # self.page.pause()
-        self.page.frame("viewIframe").locator(self.NEW_TASK_PROMPT).fill(text)
-        self.page.wait_for_timeout(5000)
+        """Enter a question in the prompt textbox."""
+        self.page.get_by_role("textbox", name="Tell us what needs planning,").fill(text)
+        self.page.wait_for_timeout(4000)
 
     def processing_different_stage(self):
-        if self.page.frame("viewIframe").locator(self.STAGES).count() >= 1:
-            for i in range(self.page.frame("viewIframe").locator(self.STAGES).count()):
-                approve_stages = (
-                    self.page.frame("viewIframe").locator(self.STAGES).nth(0)
-                )
+        """Process and approve each stage sequentially if present."""
+        self.page.wait_for_timeout(3000)
+        if self.page.locator(self.STAGES).count() >= 1:
+            for _ in range(self.page.locator(self.STAGES).count()):
+                approve_stages = self.page.locator(self.STAGES).nth(0)
                 approve_stages.click()
-                self.page.wait_for_timeout(10000)
-                BasePage.validate_response_status(self)
-                self.page.wait_for_timeout(10000)
-        expect(
-            self.page.frame("viewIframe").locator("//tag[@id='taskStatusTag']")
-        ).to_have_text("Completed")
-        expect(
-            self.page.frame("viewIframe").locator("//div[@id='taskProgressPercentage']")
-        ).to_have_text("100%")
+                self.page.wait_for_timeout(2000)
+                self.page.locator(
+                    "//span[normalize-space()='Step approved successfully']"
+                ).wait_for(state="visible", timeout=30000)
+
+                plan_id = BasePage.get_first_plan_id(self)
+                BasePage.approve_plan_by_id(self, plan_id)
+
+        expect(self.page.locator(self.COMPLETED_TASK)).to_contain_text("completed")

tests/e2e-test/pages/__init__.py

@@ -0,0 +1,2 @@
+
+"""Initialize the Page package."""

tests/e2e-test/pages/loginPage.py

@@ -1,7 +1,10 @@
+"""Login Page module for handling authentication via email and password."""
+
 from base.base import BasePage
 
 
 class LoginPage(BasePage):
+    """Page object model for login and Microsoft authentication flow."""
 
     EMAIL_TEXT_BOX = "//input[@type='email']"
     NEXT_BUTTON = "//input[@type='submit']"
@@ -11,26 +14,24 @@ class LoginPage(BasePage):
     PERMISSION_ACCEPT_BUTTON = "//input[@type='submit']"
 
     def __init__(self, page):
+        """Initialize the LoginPage with the Playwright page instance."""
         self.page = page
 
     def authenticate(self, username, password):
-        # login with username and password in web url
+        """Login using provided username and password with conditional prompts."""
         self.page.locator(self.EMAIL_TEXT_BOX).fill(username)
         self.page.locator(self.NEXT_BUTTON).click()
-        # Wait for the password input field to be available and fill it
         self.page.wait_for_load_state("networkidle")
-        # Enter password
+
         self.page.locator(self.PASSWORD_TEXT_BOX).fill(password)
-        # Click on SignIn button
         self.page.locator(self.SIGNIN_BUTTON).click()
-        # Wait for 5 seconds to ensure the login process completes
         self.page.wait_for_timeout(20000)  # Wait for 20 seconds
+
         if self.page.locator(self.PERMISSION_ACCEPT_BUTTON).is_visible():
             self.page.locator(self.PERMISSION_ACCEPT_BUTTON).click()
             self.page.wait_for_timeout(10000)
         else:
-            # Click on YES button
             self.page.locator(self.YES_BUTTON).click()
             self.page.wait_for_timeout(10000)
-        # Wait for the "Articles" button to be available and click it
+
         self.page.wait_for_load_state("networkidle")

tests/e2e-test/tests/__init__.py

@@ -0,0 +1,2 @@
+
+"""Initialize the test package."""