Chrome DevTools for coding agents
test: migrate snapshot tests to unit tests and move waitForTextOnPage tests to McpPage (#2698)
Mahesh Singh7a46acf9b97b
diff --git a/tests/McpPage.test.ts b/tests/McpPage.test.tsindex febb38ca..e14a0fc2 100644--- a/tests/McpPage.test.ts+++ b/tests/McpPage.test.ts@@ -17,7 +17,7 @@ import type {JSONSchema7Definition} from '../src/third_party/index.js';import type {Page} from '../src/third_party/index.js';import {createMockPuppeteerPage} from './mocks.js';-import {withMcpContext} from './utils.js';+import {html, withMcpContext} from './utils.js';describe('replaceHtmlElementsWithUids', () => {it('does nothing for boolean schemas', () => {@@ -530,4 +530,97 @@ describe('McpPage', () => {);});});++ describe('waitForTextOnPage()', () => {+ it('finds text on the page', async () => {+ await withMcpContext(async (_response, context) => {+ const mcpPage = context.getSelectedMcpPage();+ const page = mcpPage.pptrPage;++ await page.setContent(+ html`<main><span>Hello</span><span> </span><div>World</div></main>`,+ );++ const element = await mcpPage.waitForTextOnPage(['Hello']);+ assert.ok(element);+ });+ });++ it('works with any-match array', async () => {+ await withMcpContext(async (_response, context) => {+ const mcpPage = context.getSelectedMcpPage();+ const page = mcpPage.pptrPage;++ await page.setContent(+ html`<main><span>Status</span><div>Error</div></main>`,+ );++ const element = await mcpPage.waitForTextOnPage(['Complete', 'Error']);+ assert.ok(element);+ });+ });++ it('works with any-match array when element shows up later', async () => {+ await withMcpContext(async (_response, context) => {+ const mcpPage = context.getSelectedMcpPage();+ const page = mcpPage.pptrPage;++ const waitPromise = mcpPage.waitForTextOnPage(['Complete', 'Error']);++ await page.setContent(+ html`<main+ ><span>Hello</span><span> </span><div>Complete</div></main+ >`,+ );++ const element = await waitPromise;+ assert.ok(element);+ });+ });++ it('works with element that shows up later', async () => {+ await withMcpContext(async (_response, context) => {+ const mcpPage = context.getSelectedMcpPage();+ const page = mcpPage.pptrPage;++ const waitPromise = mcpPage.waitForTextOnPage(['Hello World']);++ await page.setContent(+ html`<main><span>Hello</span><span> </span><div>World</div></main>`,+ );++ const element = await waitPromise;+ assert.ok(element);+ });+ });++ it('works with aria elements', async () => {+ await withMcpContext(async (_response, context) => {+ const mcpPage = context.getSelectedMcpPage();+ const page = mcpPage.pptrPage;++ await page.setContent(+ html`<main><h1>Header</h1><div>Text</div></main>`,+ );++ const element = await mcpPage.waitForTextOnPage(['Header']);+ assert.ok(element);+ });+ });++ it('works with iframe content', async () => {+ await withMcpContext(async (_response, context) => {+ const mcpPage = context.getSelectedMcpPage();+ const page = mcpPage.pptrPage;++ await page.setContent(+ html`<h1>Top level</h1>+ <iframe srcdoc="<p>Hello iframe</p>"></iframe>`,+ );++ const element = await mcpPage.waitForTextOnPage(['Hello iframe']);+ assert.ok(element);+ });+ });+ });});diff --git a/tests/tools/snapshot.test.ts b/tests/tools/snapshot.test.tsindex 5a6f5c45..1bc5bb91 100644--- a/tests/tools/snapshot.test.ts+++ b/tests/tools/snapshot.test.ts@@ -4,190 +4,79 @@* SPDX-License-Identifier: Apache-2.0*/-import assert from 'node:assert';-import {describe, it} from 'node:test';+import {afterEach, describe, it} from 'node:test';++import sinon from 'sinon';import {takeSnapshot, waitFor} from '../../src/tools/snapshot.js';-import {html, withMcpContext} from '../utils.js';+import {createHandlerMocks} from '../mocks.js';describe('snapshot', () => {- describe('browser_snapshot', () => {- it('includes a snapshot', async () => {- await withMcpContext(async (response, context) => {- await takeSnapshot.handler(- {params: {}, page: context.getSelectedMcpPage()},- response,- context,- );- assert.ok(response.includeSnapshot);- });- });+ afterEach(() => {+ sinon.restore();});- describe('browser_wait_for', () => {- it('should work', async () => {- await withMcpContext(async (response, context) => {- const page = context.getSelectedMcpPage().pptrPage;-- await page.setContent(- html`<main><span>Hello</span><span> </span><div>World</div></main>`,- );- await waitFor.handler(- {- params: {- text: ['Hello'],- },- page: context.getSelectedMcpPage(),- },- response,- context,- );-- assert.equal(- response.responseLines[0],- 'Element matching one of ["Hello"] found.',- );- assert.ok(response.includeSnapshot);- });- });-- it('should work with any-match array', async () => {- await withMcpContext(async (response, context) => {- const page = context.getSelectedMcpPage().pptrPage;-- await page.setContent(- html`<main><span>Status</span><div>Error</div></main>`,- );- await waitFor.handler(- {- params: {- text: ['Complete', 'Error'],- },- page: context.getSelectedMcpPage(),- },- response,- context,- );-- assert.equal(- response.responseLines[0],- 'Element matching one of ["Complete","Error"] found.',- );- assert.ok(response.includeSnapshot);- });- });-- it('should work with any-match array when element shows up later', async () => {- await withMcpContext(async (response, context) => {- const page = context.getSelectedMcpPage().pptrPage;-- const handlePromise = waitFor.handler(- {- params: {- text: ['Complete', 'Error'],- },- page: context.getSelectedMcpPage(),- },- response,- context,- );- await page.setContent(- html`<main- ><span>Hello</span><span> </span><div>Complete</div></main- >`,- );-- await handlePromise;-- assert.equal(- response.responseLines[0],- 'Element matching one of ["Complete","Error"] found.',- );- assert.ok(response.includeSnapshot);+ describe('take_snapshot', () => {+ it('includes a snapshot', async () => {+ const {page, context, response} = createHandlerMocks();+ await takeSnapshot.handler({params: {}, page}, response, context);+ sinon.assert.calledOnceWithExactly(response.includeSnapshot, {+ verbose: false,+ filePath: undefined,});});- it('should work with element that show up later', async () => {- await withMcpContext(async (response, context) => {- const page = context.getSelectedMcpPage().pptrPage;-- const handlePromise = waitFor.handler(- {- params: {- text: ['Hello World'],- },- page: context.getSelectedMcpPage(),- },- response,- context,- );-- await page.setContent(- html`<main><span>Hello</span><span> </span><div>World</div></main>`,- );-- await handlePromise;-- assert.equal(- response.responseLines[0],- 'Element matching one of ["Hello World"] found.',- );- assert.ok(response.includeSnapshot);+ it('includes a snapshot with parameters', async () => {+ const {page, context, response} = createHandlerMocks();+ await takeSnapshot.handler(+ {params: {verbose: true, filePath: 'custom/path.txt'}, page},+ response,+ context,+ );+ sinon.assert.calledOnceWithExactly(response.includeSnapshot, {+ verbose: true,+ filePath: 'custom/path.txt',});});- it('should work with aria elements', async () => {- await withMcpContext(async (response, context) => {- const page = context.getSelectedMcpPage().pptrPage;-- await page.setContent(- html`<main><h1>Header</h1><div>Text</div></main>`,- );-- await waitFor.handler(- {- params: {- text: ['Header'],- },- page: context.getSelectedMcpPage(),- },- response,- context,- );+ });- assert.equal(- response.responseLines[0],- 'Element matching one of ["Header"] found.',- );- assert.ok(response.includeSnapshot);- });+ describe('wait_for', () => {+ it('waits for text and appends response line', async () => {+ const {page, context, response} = createHandlerMocks();+ await waitFor.handler(+ {params: {text: ['Hello']}, page},+ response,+ context,+ );+ sinon.assert.calledOnceWithExactly(+ page.waitForTextOnPage,+ ['Hello'],+ undefined,+ );+ sinon.assert.calledOnceWithExactly(+ response.appendResponseLine,+ 'Element matching one of ["Hello"] found.',+ );+ sinon.assert.calledOnceWithExactly(response.includeSnapshot);});- it('should work with iframe content', async () => {- await withMcpContext(async (response, context) => {- const page = context.getSelectedMcpPage().pptrPage;-- await page.setContent(- html`<h1>Top level</h1>- <iframe srcdoc="<p>Hello iframe</p>"></iframe>`,- );-- await waitFor.handler(- {- params: {- text: ['Hello iframe'],- },- page: context.getSelectedMcpPage(),- },- response,- context,- );-- assert.equal(- response.responseLines[0],- 'Element matching one of ["Hello iframe"] found.',- );- assert.ok(response.includeSnapshot);- });+ it('waits for text with timeout', async () => {+ const {page, context, response} = createHandlerMocks();+ await waitFor.handler(+ {params: {text: ['Complete', 'Error'], timeout: 5000}, page},+ response,+ context,+ );+ sinon.assert.calledOnceWithExactly(+ page.waitForTextOnPage,+ ['Complete', 'Error'],+ 5000,+ );+ sinon.assert.calledOnceWithExactly(+ response.appendResponseLine,+ 'Element matching one of ["Complete","Error"] found.',+ );+ sinon.assert.calledOnceWithExactly(response.includeSnapshot);});});});