Move editor utility methods out of EditorPage into editorUtils.ts

sharma1208 · sharma1208 · commit e180a8d1b941 · 2026-06-24T15:55:23.000-05:00
EditorPage now only models the page object (openFile, getEditor).
The utility methods clear, moveCursorToEnd, replaceTextWithinLineContaining,
and hoverOver have been moved to src/test/utils/editorUtils.ts as standalone
exported functions, per code review feedback.
diff --git a/src/test/GradleTestLSPHover.ts b/src/test/GradleTestLSPHover.ts
@@ -3,11 +3,12 @@
  * Copyright IBM Corp. 2026
  */
 import { expect } from 'chai';
-import { EditorView, TextEditor, VSBrowser, Workbench, WebDriver } from 'vscode-extension-tester';
+import { EditorView, VSBrowser } 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';
+import * as editorUtils from './utils/editorUtils';
 
 describe('LSP Hover tests for Gradle Project', () => {
     let serverXml: EditorPage;
@@ -92,7 +93,7 @@ describe('LSP Hover tests for Gradle Project', () => {
             logger.testStart(`Hover over ${testCase.element} shows Liberty Language Server documentation`);
             
             try {
-                const hoverText = await serverXml.hoverOver(testCase.line, testCase.column, testCase.element);
+                const hoverText = await editorUtils.hoverOver(serverXml.getEditor(), 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}`);
 
@@ -164,7 +165,7 @@ describe('LSP Hover tests for Gradle Project', () => {
                 logger.testStart(`Hover over ${testCase.element} shows LSP4Jakarta documentation`);
                 
                 try {
-                    const hoverText = await javaFile.hoverOver(testCase.line, testCase.column, testCase.element);
+                    const hoverText = await editorUtils.hoverOver(javaFile.getEditor(), testCase.line, testCase.column, testCase.element);
                     
                     expect(hoverText).to.not.be.empty;
                     logger.stepSuccess(3, `Hover widget displayed with LSP4Jakarta content for ${testCase.element}`);
diff --git a/src/test/GradleTestLSPRestSnippetAndDiagnostic.ts b/src/test/GradleTestLSPRestSnippetAndDiagnostic.ts
@@ -4,14 +4,15 @@
  * Copyright IBM Corp. 2026
  */
 import { expect } from 'chai';
-import { EditorView, TextEditor, VSBrowser, Workbench, WebDriver, BottomBarPanel, MarkerType, Key, By } from 'vscode-extension-tester';
+import { EditorView, VSBrowser, WebDriver } from 'vscode-extension-tester';
 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';
+import * as editorUtils from './utils/editorUtils';
 
 describe('Rest Class Snippet Test for Gradle Project', () => {
     let editorPage: EditorPage;
@@ -61,7 +62,7 @@ describe('Rest Class Snippet Test for Gradle Project', () => {
                     // selectText may fail but setText still works
                 }
                 
-                await editorPage.clear();
+                await editorUtils.clearEditor(editorPage.getEditor());
                 logger.info('Reset TestRest.java to empty after test');
             }
         } catch (error) {
@@ -101,15 +102,15 @@ 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 editorPage.clear();
+            await editorUtils.clearEditor(editorPage.getEditor());
             await wait.sleep(1500);   // let any auto-stub settle, then confirm
             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
-                await editorPage.moveCursorToEnd();
+                await editorUtils.moveCursorToEnd(editorPage.getEditor());
                 
                 // type rest and insert snippet
                 logger.step(2, 'Opening content assist');
@@ -139,7 +140,7 @@ describe('Rest Class Snippet Test for Gradle Project', () => {
             logger.testStart('Diagnostic for a private @GET method and quick fix clears it');
             try {
                 // Find the method with @GET and change it to private
-                await editorPage.replaceTextWithinLineContaining('methodname', 'public' , 'private');
+                await editorUtils.replaceTextWithinLineContaining(editorPage.getEditor(), 'methodname', 'public', 'private');
 
                 // Save file and wait for reanalysis
                 await editorPage.getEditor().save();
diff --git a/src/test/MavenTestLSPHover.ts b/src/test/MavenTestLSPHover.ts
@@ -3,11 +3,12 @@
  * Copyright IBM Corp. 2026
  */
 import { expect } from 'chai';
-import { EditorView, TextEditor, VSBrowser, Workbench, WebDriver } from 'vscode-extension-tester';
+import { EditorView, VSBrowser } 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';
+import * as editorUtils from './utils/editorUtils';
 
 describe('LSP Hover tests for Maven Project', () => {
     let serverXml: EditorPage;
@@ -91,7 +92,7 @@ describe('LSP Hover tests for Maven Project', () => {
             logger.testStart(`Hover over ${testCase.element} shows Liberty Language Server documentation`);
             
             try {
-                const hoverText = await serverXml.hoverOver(testCase.line, testCase.column, testCase.element);
+                const hoverText = await editorUtils.hoverOver(serverXml.getEditor(), 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}`);
 
@@ -163,7 +164,7 @@ describe('LSP Hover tests for Maven Project', () => {
                 logger.testStart(`Hover over ${testCase.element} shows LSP4Jakarta documentation`);
                 
                 try {
-                    const hoverText = await javaFile.hoverOver(testCase.line, testCase.column, testCase.element);
+                    const hoverText = await editorUtils.hoverOver(javaFile.getEditor(), testCase.line, testCase.column, testCase.element);
                     
                     expect(hoverText).to.not.be.empty;
                     logger.stepSuccess(3, `Hover widget displayed with LSP4Jakarta content for ${testCase.element}`);
diff --git a/src/test/MavenTestLSPRestSnippetAndDiagnostic.ts b/src/test/MavenTestLSPRestSnippetAndDiagnostic.ts
@@ -4,14 +4,15 @@
  * Copyright IBM Corp. 2026
  */
 import { expect } from 'chai';
-import { EditorView, TextEditor, VSBrowser, Workbench, WebDriver, BottomBarPanel, MarkerType, Key, By } from 'vscode-extension-tester';
+import { EditorView, VSBrowser, WebDriver } from 'vscode-extension-tester';
 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';
+import * as editorUtils from './utils/editorUtils';
 
 describe('Rest Class Snippet Test for Maven Project', () => {
     let editorPage: EditorPage; 
@@ -61,7 +62,7 @@ describe('Rest Class Snippet Test for Maven Project', () => {
                     // selectText may fail but setText still works
                 }
                 
-                await editorPage.clear();
+                await editorUtils.clearEditor(editorPage.getEditor());
                 logger.info('Reset TestRest.java to empty after test');
             }
         } catch (error) {
@@ -101,15 +102,15 @@ describe('Rest Class Snippet Test for Maven Project', () => {
             logger.testStart('rest_class snippet inserts correct REST class');
 
             // at the top of the rest_class snippet test, before positioning the cursor
-            await editorPage.clear();
+            await editorUtils.clearEditor(editorPage.getEditor());
             await wait.sleep(1500);   // let any auto-stub settle, then confirm
             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
-                await editorPage.moveCursorToEnd();
+                await editorUtils.moveCursorToEnd(editorPage.getEditor());
                 
                 // Type rest and trigger snippet insertion
                 logger.step(2, 'Opening content assist');
@@ -139,7 +140,7 @@ describe('Rest Class Snippet Test for Maven Project', () => {
             logger.testStart('Diagnostic for a private @GET method and quick fix clears it');
             try {
                 // Find the method with @GET and change it to private 
-                await editorPage.replaceTextWithinLineContaining('methodname', 'public' , 'private');
+                await editorUtils.replaceTextWithinLineContaining(editorPage.getEditor(), 'methodname', 'public', 'private');
 
                 // Save file and wait for reanalysis 
                 await editorPage.getEditor().save();
diff --git a/src/test/pages/EditorPage.ts b/src/test/pages/EditorPage.ts
@@ -1,4 +1,4 @@
-import { EditorView, TextEditor, VSBrowser, Workbench } from 'vscode-extension-tester';
+import { EditorView, TextEditor, VSBrowser } from 'vscode-extension-tester';
 import * as utils from '../utils/testUtils';
 
 export class EditorPage {   
@@ -11,8 +11,8 @@ export class EditorPage {
      * @param tabTitle    The editor tab title (usually the file name).
      * @param loadDelayMs Time to let the file/language server settle.
      */
-    async openFile(filePath: string, tabTitle: string, loadDelay = 3000) : Promise<this> {
-            await VSBrowser.instance.openResources(filePath, async () => {
+    async openFile(filePath: string, tabTitle: string, loadDelay = 3000): Promise<this> {
+        await VSBrowser.instance.openResources(filePath, async () => {
             await utils.getWaitHelper().sleep(loadDelay); 
         });
         this.editor = await this.editorView.openEditor(tabTitle) as TextEditor;
@@ -22,51 +22,4 @@ export class EditorPage {
     getEditor(): TextEditor {
         return this.editor;
     }
-
-    /** Reset the editor to an empty, saved buffer. */
-    async clear(): Promise<void> {
-        await this.editor.setText('');
-        await this.editor.save();
-    }
-
-    /**
-     * Place the cursor at the start of the last line of content.
-     * Note: split('\n').length counts a trailing empty segment when the file
-     * ends in a newline, so `lastLine - 1` lands on the last real line.
-     */
-    async moveCursorToEnd(): Promise<void> {
-        const lastLine = (await this.editor.getText()).split('\n').length;
-        await this.editor.setCursor(lastLine - 1, 1);
-
-    }
-
-    /**
-     * On the first line containing `token`, replace `find` with `replace`.
-     * Does not save. 
-     * @throws if no line contains `token`.
-     */
-    async replaceTextWithinLineContaining(token: string, find: string, replace: string) : Promise<void>{
-        const lineNum = await this.editor.getLineOfText(token);
-        if (lineNum < 1) throw new Error(`Could not find a line containing "${token}"`);
-        const oldLine = await this.editor.getTextAtLine(lineNum);
-        await this.editor.setTextAtLine(lineNum, oldLine.replace(find, replace));
-    }
-
-    /**
-     * Position the cursor, trigger the hover widget, and return its text.
-     * @param elementDescription Human-readable element name, for logging.
-     */
-    async hoverOver(
-            line: number,
-            column: number,
-            elementDescription: string,
-            timeoutMs = 15000
-        ): Promise<string> {
-            await this.editor.setCursor(line, column);
-            await new Workbench().executeCommand('editor.action.showHover');
-            return utils.waitForHoverWidget(VSBrowser.instance.driver, elementDescription, timeoutMs);
-        }
-
-
-
-}
+}
diff --git a/src/test/utils/editorUtils.ts b/src/test/utils/editorUtils.ts
@@ -0,0 +1,53 @@
+import { TextEditor, VSBrowser, Workbench } from 'vscode-extension-tester';
+import * as utils from './testUtils';
+
+/**
+ * Reset the editor to an empty, saved buffer.
+ */
+export async function clearEditor(editor: TextEditor): Promise<void> {
+    await editor.setText('');
+    await editor.save();
+}
+
+/**
+ * Place the cursor at the start of the last line of content.
+ * Note: split('\n').length counts a trailing empty segment when the file
+ * ends in a newline, so `lastLine - 1` lands on the last real line.
+ */
+export async function moveCursorToEnd(editor: TextEditor): Promise<void> {
+    const lastLine = (await editor.getText()).split('\n').length;
+    await editor.setCursor(lastLine - 1, 1);
+}
+
+/**
+ * On the first line containing `token`, replace `find` with `replace`.
+ * Does not save.
+ * @throws if no line contains `token`.
+ */
+export async function replaceTextWithinLineContaining(
+    editor: TextEditor,
+    token: string,
+    find: string,
+    replace: string
+): Promise<void> {
+    const lineNum = await editor.getLineOfText(token);
+    if (lineNum < 1) throw new Error(`Could not find a line containing "${token}"`);
+    const oldLine = await editor.getTextAtLine(lineNum);
+    await editor.setTextAtLine(lineNum, oldLine.replace(find, replace));
+}
+
+/**
+ * Position the cursor, trigger the hover widget, and return its text.
+ * @param elementDescription Human-readable element name, for logging.
+ */
+export async function hoverOver(
+    editor: TextEditor,
+    line: number,
+    column: number,
+    elementDescription: string,
+    timeoutMs = 15000
+): Promise<string> {
+    await editor.setCursor(line, column);
+    await new Workbench().executeCommand('editor.action.showHover');
+    return utils.waitForHoverWidget(VSBrowser.instance.driver, elementDescription, timeoutMs);
+}
