Introduce Page Object Model for UI test suite

Add a page object layer under src/test/pages/ to encapsulate VS Code UI
interactions, and refactor the LSP/snippet/diagnostic, hover, and dev-mode
action tests to use it. Page objects expose intent-revealing methods and
return data; assertions remain in the test files.

Page objects added:
- EditorPage: open/clear a file, move cursor to end, replace text on a line,
  hover, and expose the raw editor for generic operations (getEditor).
- ProblemsPage: hasDiagnostic() to check the Problems view for a message.
- CodeAssistPage: insertSnippet() wrapping the content-assist trigger/select/
  close flow, including the null guard and settle delay.
- QuickFixPage: applyFix() wrapping the quick-fix menu keystroke and option
  selection.
- DashboardPage: runAction()/getSection()/getProjectItem() wrapping the
  Liberty Tools sidebar section+item fetch and launchDashboardAction, with
  fresh re-fetch each call to avoid stale-element errors and the mac/non-mac
  action pairing hidden internally.

Tests refactored to use the page objects:
- MavenTestLSPRestSnippetAndDiagnostic.ts
- GradleTestLSPRestSnippetAndDiagnostic.ts
- MavenTestLSPHover.ts / GradleTestLSPHover.ts
- MavenTestDevModeActions.ts / GradleTestDevModeActions.ts

UI mechanics (drivers, selectors, command IDs, section/item bookkeeping) move
out of the test files into the page objects. Test behavior is unchanged;
existing test cases, timeouts, and logging are preserved.

Author: sharma1208

src/test/GradleTestDevModeActions.ts

@@ -3,29 +3,24 @@
  * Copyright IBM Corp. 2026
  */
 import { expect } from 'chai';
-import { EditorView, TextEditor, VSBrowser, WebDriver, Workbench } from 'vscode-extension-tester';
+import { EditorView, TextEditor, VSBrowser, Workbench, WebDriver } from 'vscode-extension-tester';
 import * as utils from './utils/testUtils';
 import { logger } from './utils/testLogger';
 import * as path from 'path';
+import { EditorPage } from './pages/EditorPage';
 
 describe('LSP Hover tests for Gradle Project', () => {
-    let editorView: EditorView;
-    let editor: TextEditor;
-    let wait: any;
-    let driver: WebDriver;
-
+    let serverXml: EditorPage;
+    
     before(async function() {
         this.timeout(60000);
-        logger.info('Setting up Gradle LSP Hover tests');
 
-        driver = VSBrowser.instance.driver;
-        await VSBrowser.instance.openResources(utils.getGradleProjectPath());
+        logger.info('Setting up Gradle LSP Hover tests');
 
         // Wait for workbench to be ready
+        await VSBrowser.instance.openResources(utils.getGradleProjectPath());
         await VSBrowser.instance.waitForWorkbench();
-        editorView = new EditorView();
-        wait = utils.getWaitHelper();
-
+        
         // Open server.xml file once for all tests
         logger.info('Opening server.xml file for all tests');
         const serverXmlPath = path.resolve(
@@ -38,11 +33,7 @@ describe('LSP Hover tests for Gradle Project', () => {
         );
         logger.info(`Server.xml path: ${serverXmlPath}`);
 
-        await VSBrowser.instance.openResources(serverXmlPath, async () => {
-            await wait.sleep(3000); // Allow time for file to load
-        });
-        
-        editor = await editorView.openEditor('server.xml') as TextEditor;
+        serverXml = await new EditorPage().openFile(serverXmlPath, 'server.xml');
         logger.info('Server.xml file opened and editor obtained');
     });
 
@@ -59,7 +50,7 @@ describe('LSP Hover tests for Gradle Project', () => {
         this.timeout(10000); // Increase timeout for cleanup operations
         // Close editor after all tests complete
         try {
-            await editorView.closeAllEditors();
+            await new EditorView().closeAllEditors();
             logger.info('Closed all editors after test suite');
         } catch (error) {
             logger.error('Failed to close editors in after hook', error);
@@ -101,18 +92,7 @@ describe('LSP Hover tests for Gradle Project', () => {
             logger.testStart(`Hover over ${testCase.element} shows Liberty Language Server documentation`);
 
             try {
-                logger.step(1, `Setting cursor position on ${testCase.element}`);
-                await editor.setCursor(testCase.line, testCase.column);
-                logger.stepSuccess(1, `Cursor positioned on ${testCase.element} at line ${testCase.line}`);
-
-                logger.step(2, 'Triggering hover via command palette');
-                await new Workbench().executeCommand('editor.action.showHover');
-                logger.stepSuccess(2, 'Hover command executed');
-
-                logger.step(3, 'Verifying hover widget appears with Liberty Language Server content');
-                const driver = VSBrowser.instance.driver;
-                const hoverText = await utils.waitForHoverWidget(driver, testCase.element, 15000);
-                
+                const hoverText = await serverXml.hoverOver(testCase.line, testCase.column, testCase.element);
                 expect(hoverText).to.not.be.empty;
                 logger.stepSuccess(3, `Hover widget displayed with Liberty Language Server content for ${testCase.element}`);
 
@@ -129,7 +109,7 @@ describe('LSP Hover tests for Gradle Project', () => {
     });
 
     describe('LSP4Jakarta Hover tests in Java file', () => {
-        let javaEditor: TextEditor;
+        let javaFile: EditorPage;
 
         before(async function() {
             this.timeout(60000);
@@ -148,12 +128,8 @@ describe('LSP Hover tests for Gradle Project', () => {
                 'HelloServlet.java'
             );
             logger.info(`Java file path: ${javaFilePath}`);
-
-            await VSBrowser.instance.openResources(javaFilePath, async () => {
-                await wait.sleep(3000); // Allow time for file to load
-            });
+            javaFile = await new EditorPage().openFile(javaFilePath, 'HelloServlet.java')
 
-            javaEditor = await editorView.openEditor('HelloServlet.java') as TextEditor;
             logger.info('HelloServlet.java file opened and editor obtained');
         });
 
@@ -188,17 +164,7 @@ describe('LSP Hover tests for Gradle Project', () => {
                 logger.testStart(`Hover over ${testCase.element} shows LSP4Jakarta documentation`);
 
                 try {
-                    logger.step(1, `Setting cursor position on ${testCase.element}`);
-                    await javaEditor.setCursor(testCase.line, testCase.column);
-                    logger.stepSuccess(1, `Cursor positioned on ${testCase.element} at line ${testCase.line}`);
-
-                    logger.step(2, 'Triggering hover via command palette');
-                    await new Workbench().executeCommand('editor.action.showHover');
-                    logger.stepSuccess(2, 'Hover command executed');
-
-                    logger.step(3, 'Verifying hover widget appears with LSP4Jakarta content');
-                    const driver = VSBrowser.instance.driver;
-                    const hoverText = await utils.waitForHoverWidget(driver, testCase.element, 15000);
+                    const hoverText = await javaFile.hoverOver(testCase.line, testCase.column, testCase.element);
 
                     expect(hoverText).to.not.be.empty;
                     logger.stepSuccess(3, `Hover widget displayed with LSP4Jakarta content for ${testCase.element}`);

src/test/GradleTestLSPHover.ts

@@ -8,10 +8,13 @@ import { EditorView, TextEditor, VSBrowser, Workbench, WebDriver, BottomBarPanel
 import * as utils from './utils/testUtils';
 import { logger } from './utils/testLogger';
 import * as path from 'path';
+import { ProblemsPage } from './pages/ProblemsPage';
+import { EditorPage } from './pages/EditorPage';
+import { CodeAssistPage } from './pages/CodeAssistPage';
+import { QuickFixPage } from './pages/QuickFixPage';
 
 describe('Rest Class Snippet Test for Gradle Project', () => {
-    let editorView: EditorView;
-    let javaEditor: TextEditor;
+    let editorPage: EditorPage;
     let wait: any;
     let driver: WebDriver;
 
@@ -26,18 +29,14 @@ describe('Rest Class Snippet Test for Gradle Project', () => {
         logger.info('Setting up rest_class snippet test');
 
         driver = VSBrowser.instance.driver;
+        wait = utils.getWaitHelper();
+        // Open folder, wait for workbench
         await VSBrowser.instance.openResources(utils.getGradleProjectPath());
-        
-        // Wait for workbench to be ready
         await VSBrowser.instance.waitForWorkbench();
-        editorView = new EditorView();
-        wait = utils.getWaitHelper();
 
-        // Open the file
-        await VSBrowser.instance.openResources(testRestPath, async () => {
-            await wait.sleep(3000); 
-        });
-        javaEditor = await editorView.openEditor('TestRest.java') as TextEditor;
+        // Open file and bind page object to editor
+        editorPage = await new EditorPage().openFile(testRestPath, 'TestRest.java');
+
     });
 
     afterEach(async function() {
@@ -50,20 +49,28 @@ describe('Rest Class Snippet Test for Gradle Project', () => {
     });
 
     after(async function() {
-        this.timeout(10000); // Increase timeout for cleanup operations
-        // Close editor after all tests complete
+        this.timeout(15000);
         try {
-            if(javaEditor){
-                await javaEditor.setText(''); 
-                await javaEditor.save(); 
-                logger.info('Reset TestRest.java to empty after test')
-
-            } 
-        } catch (error){
-                logger.error('Failed to reset TestRest.java ', error);
+            if (editorPage) {
+                // Select all text first, then clear
+                const currentText = await editorPage.getEditor().getText();
+                try {
+                    await editorPage.getEditor().selectText(currentText);
+                    await wait.sleep(300);
+                } catch (selectError) {
+                    // selectText may fail but setText still works
+                }
+                
+                await editorPage.clear();
+                logger.info('Reset TestRest.java to empty after test');
             }
+        } catch (error) {
+            logger.error('Failed to reset TestRest.java', error);
+        }
+        
         try {
-            await editorView.closeAllEditors();
+            await new EditorView().closeAllEditors();
+            await wait.sleep(500);
             logger.info('Closed all editors after test suite');
         } catch (error) {
             logger.error('Failed to close editors in after hook', error);
@@ -94,38 +101,32 @@ describe('Rest Class Snippet Test for Gradle Project', () => {
             logger.testStart('rest_class snippet inserts correct REST class');
 
             // at the top of the rest_class snippet test, before positioning the cursor
-            await javaEditor.setText('');
-            await javaEditor.save();
+            await editorPage.clear();
             await wait.sleep(1500);   // let any auto-stub settle, then confirm
-            const check = await javaEditor.getText();
+            const check = await editorPage.getEditor().getText();
             logger.info('Buffer before snippet: ' + JSON.stringify(check));
 
             try {
                 logger.step(1, 'Positioning cursor for snippet insertion');
                 // Position cursor at end of file
-                const lastLine = (await javaEditor.getText()).split('\n').length;
-                await javaEditor.setCursor(lastLine - 1, 1);
+                await editorPage.moveCursorToEnd();
 
-                logger.step(2, 'Typing "rest" to trigger snippet');
-                await javaEditor.typeText('rest');
-                logger.stepSuccess(2, 'Typed "rest"');
+                // type rest and insert snippet
+                logger.step(2, 'Opening content assist');
+                const codeAssist = new CodeAssistPage();
+                await codeAssist.insertSnippet(editorPage, 'rest', 'rest_class');
+                logger.stepSuccess(2, 'Snippet inserted');
+                await wait.sleep(1000); // Give time for snippet to fully expand
 
-                logger.step(3, 'Opening content assist');
-                const assist = await javaEditor.toggleContentAssist(true);
-                if (assist) {
-                    logger.step(4,'Selecting rest_class snippet');
-                    await assist.select('rest_class');
-                    await new Promise(res => setTimeout(res, 600)); // 300–800ms
-                    logger.stepSuccess(4, 'rest_class snippet selected');
-                }
-                await javaEditor.toggleContentAssist(false);
-                
-                logger.step(5, 'Verifying snippet insertion');
-                const codeInsertion = await javaEditor.getText();
-                logger.info('Inserted code snapshot: ' + codeInsertion);
+                logger.step(3, 'Verifying snippet insertion');
+                const codeInsertion = await editorPage.getEditor().getText();
                 expect(codeInsertion).to.include('@GET')
                 expect(codeInsertion).to.include('methodname');
-                logger.stepSuccess(5, 'Snippet rest_class was inserted correctly');
+                logger.stepSuccess(3, 'Snippet rest_class was inserted correctly');
+                
+                // Save the file so the content persists for the next test
+                await editorPage.getEditor().save();
+                await wait.sleep(500);
 
                 logger.testComplete('rest_class snippet inserts correct REST class');
             } catch (error) {
@@ -137,96 +138,37 @@ describe('Rest Class Snippet Test for Gradle Project', () => {
             this.timeout(90000);
             logger.testStart('Diagnostic for a private @GET method and quick fix clears it');
             try {
-                // Find the method with @GET and change it to private 
-                let lineNum = await javaEditor.getLineOfText('methodname');
-                 if (lineNum < 1) throw new Error('Could not find the methodname line');
-                const oldLine = await javaEditor.getTextAtLine(lineNum);
-                const newLine = oldLine.replace("public", "private");
-                await javaEditor.setTextAtLine(lineNum, newLine); 
-
-                // Save file and wait for reanalysis 
-                await javaEditor.save();
-                await wait.sleep(500); 
-
-                // Open problems view
-                const bottomBar = new BottomBarPanel();
-                await bottomBar.toggle(true);
-                let problemsView = await bottomBar.openProblemsView();
-                let markers = await problemsView.getAllVisibleMarkers(MarkerType.Any); 
-
-                // Check if the marker is present
-                let found = false;
-                for (const marker of markers) {
-                    const text = await marker.getText();
-                    // Check if text contains your diagnostic message
-                    if(text.includes('Only public methods can be exposed as resource methods.')){
-                        found = true;
-                        break;
-                    }
-                }
-                expect(found).to.be.true; 
+                // Find the method with @GET and change it to private
+                await editorPage.replaceTextWithinLineContaining('methodname', 'public' , 'private');
+
+                // Save file and wait for reanalysis
+                await editorPage.getEditor().save();
+                await wait.sleep(500);
+
+                // Check that the diagnostic is there
+                let problems = new ProblemsPage();
+                const found = await problems.hasDiagnostic('Only public methods can be exposed as resource methods.');
+                expect(found).to.be.true;
                 logger.testComplete('Diagnostic shows for private @GET method');
 
                 // Quick fix implementation to get rid of diagnostic
                 // Re-find line and place cursor on "methodname()"
-                const buffer = await javaEditor.getText();
+                const buffer = await editorPage.getEditor().getText();
                 logger.info('Buffer before quick fix: ' + JSON.stringify(buffer));
 
-                // Get column on the method name 
-                await javaEditor.selectText('methodname');
-                await wait.sleep(300); 
-
-                // Open the quick-fix menu with Cmd+. (Mac) / Ctrl+. (Linux/Windows)
-                const modKey = process.platform === 'darwin' ? Key.COMMAND : Key.CONTROL;
-                await driver.actions().keyDown(modKey).sendKeys('.').keyUp(modKey).perform();
-                await wait.sleep(2000);
-
-                // Click on the option to make the method public within the quick-fixes options
-                const options = await driver.findElements(By.css('.action-widget .action-list-item, .action-widget .monaco-list-row'));
-                let clicked = false;
-                for (const opt of options) {
-                    const text = await opt.getText();
-                    logger.info('OPTION: ' + JSON.stringify(text));
-                    if (text.toLowerCase().includes('make method public')) {
-                        await driver.executeScript('arguments[0].click();', opt);
-                        clicked = true;
-                        break;
-                    }
-                }
-                if (!clicked) {
-                    await driver.actions().sendKeys(Key.ESCAPE).perform();  // close menu cleanly
-                    throw new Error('No "make public" quick fix was offered — see OPTION logs above');
-                }
+               await new QuickFixPage().applyFix(editorPage, 'methodname', 'make method public');
+               await wait.sleep(3000);
+               await editorPage.getEditor().save();
+               await wait.sleep(5000);
 
-                await wait.sleep(3000);
-                await javaEditor.save();
-                await wait.sleep(5000);
-
-                // Check quick fix was implemented at correct line number 
-                const after = await javaEditor.getText();
-                logger.info('Buffer after quick fix: ' + JSON.stringify(after));
-                expect(after).to.include('public String methodname');
-
-                problemsView = await bottomBar.openProblemsView();
-                markers = await problemsView.getAllVisibleMarkers(MarkerType.Any); 
-
-                // Check if the marker is present
-                let stillPresent = false;
-                for (const marker of markers) {
-                    const text = await marker.getText();
-                    // Check if text contains diagnostic message
-                    if(text.includes('Only public methods can be exposed as resource methods.')){
-                        stillPresent = true;
-                        break;
-                    }
-                }
-                expect(stillPresent).to.be.false; 
-                logger.testComplete('Diagnostic no longer shows for public @GET method as expected');
+               const after = await editorPage.getEditor().getText();
+               expect(after).to.include('public String methodname');
+               expect(await problems.hasDiagnostic('Only public methods can be exposed as resource methods.')).to.be.false;
 
             } catch (error) {
                 logger.testFailed('Diagnostic/quick-fix test flow failed', error);
-                throw error; 
-            } 
+                throw error;
+            }
 
         });
  });