playwright/tests/playwright-test/playwright.expect.text.spec.ts

/**
 * Copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { test, expect, stripAnsi } from './playwright-test-fixtures';

test('should support toHaveText w/ regex', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div id=node>Text   content</div>');
        const locator = page.locator('#node');
        await expect(locator).toHaveText(/Text/);

        // Should not normalize whitespace.
        await expect(locator).toHaveText(/Text   content/);
        // Should respect ignoreCase.
        await expect(locator).toHaveText(/text   content/, { ignoreCase: true });
        // Should override regex flag with ignoreCase.
        await expect(locator).not.toHaveText(/text   content/i, { ignoreCase: false });
      });

      test('fail', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).toHaveText(/Text 2/, { timeout: 100 });
      });
      `,
  }, { workers: 1 });
  const output = stripAnsi(result.output);
  expect(output).toContain('Error: expect(received).toHaveText(expected)');
  expect(output).toContain('Expected pattern: /Text 2/');
  expect(output).toContain('Received string:  "Text content"');
  expect(output).toContain('expect(locator).toHaveText');
  expect(result.passed).toBe(1);
  expect(result.failed).toBe(1);
  expect(result.exitCode).toBe(1);
});

test('should support toContainText w/ regex', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div id=node>Text   content</div>');
        const locator = page.locator('#node');
        await expect(locator).toContainText(/ex/);

        // Should not normalize whitespace.
        await expect(locator).toContainText(/ext   cont/);
      });

      test('fail', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).toContainText(/ex2/, { timeout: 100 });
      });
      `,
  }, { workers: 1 });
  const output = stripAnsi(result.output);
  expect(output).toContain('Error: expect(received).toContainText(expected)');
  expect(output).toContain('Expected pattern: /ex2/');
  expect(output).toContain('Received string:  "Text content"');
  expect(output).toContain('expect(locator).toContainText');
  expect(result.passed).toBe(1);
  expect(result.failed).toBe(1);
  expect(result.exitCode).toBe(1);
});

test('should support toHaveText w/ text', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div id=node><span></span>Text \\ncontent&nbsp;    </div>');
        const locator = page.locator('#node');
        // Should normalize whitespace.
        await expect(locator).toHaveText('Text                        content');
        // Should normalize zero width whitespace.
        await expect(locator).toHaveText('T\u200be\u200bx\u200bt content');
        // Should support ignoreCase.
        await expect(locator).toHaveText('text CONTENT', { ignoreCase: true });
        // Should support falsy ignoreCase.
        await expect(locator).not.toHaveText('TEXT', { ignoreCase: false });
      });

      test('pass contain', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).toContainText('Text');
        // Should normalize whitespace.
        await expect(locator).toContainText('   ext        cont\\n  ');
        // Should support ignoreCase.
        await expect(locator).toContainText('EXT', { ignoreCase: true });
        // Should support falsy ignoreCase.
        await expect(locator).not.toContainText('TEXT', { ignoreCase: false });
      });

      test('fail', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).toHaveText('Text', { timeout: 100 });
      });
      `,
  }, { workers: 1 });
  const output = stripAnsi(result.output);
  expect(output).toContain('Error: expect(received).toHaveText(expected)');
  expect(output).toContain('Expected string: "Text"');
  expect(output).toContain('Received string: "Text content"');
  expect(output).toContain('expect(locator).toHaveText');
  expect(result.passed).toBe(2);
  expect(result.failed).toBe(1);
  expect(result.exitCode).toBe(1);
});

test('should support toHaveText w/ not', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).not.toHaveText('Text2');
        // Should be case-sensitive by default.
        await expect(locator).not.toHaveText('TEXT');
      });

      test('fail', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).not.toHaveText('Text content', { timeout: 100 });
      });
      `,
  }, { workers: 1 });
  const output = stripAnsi(result.output);
  expect(output).toContain('Error: expect(received).not.toHaveText(expected)');
  expect(output).toContain('Expected string: not "Text content"');
  expect(output).toContain('Received string: "Text content');
  expect(output).toContain('expect(locator).not.toHaveText');
  expect(result.passed).toBe(1);
  expect(result.failed).toBe(1);
  expect(result.exitCode).toBe(1);
});

test('should support toHaveText w/ array', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div>Text    \\n1</div><div>Text   2a</div>');
        const locator = page.locator('div');
        // Should only normalize whitespace in the first item.
        await expect(locator).toHaveText(['Text  1', /Text   \\d+a/]);
        // Should support ignoreCase.
        await expect(locator).toHaveText(['tEXT 1', 'TExt 2A'], { ignoreCase: true });
      });

      test('pass lazy', async ({ page }) => {
        await page.setContent('<div id=div></div>');
        const locator = page.locator('p');
        setTimeout(() => {
          page.evaluate(() => {
            div.innerHTML = "<p>Text 1</p><p>Text 2</p>";
          }).catch(() => {});
        }, 500);
        await expect(locator).toHaveText(['Text 1', 'Text 2']);
      });

      test('pass empty', async ({ page }) => {
        await page.setContent('<div></div>');
        const locator = page.locator('p');
        await expect(locator).toHaveText([]);
      });

      test('pass not empty', async ({ page }) => {
        await page.setContent('<div><p>Test</p></div>');
        const locator = page.locator('p');
        await expect(locator).not.toHaveText([]);
      });

      test('pass on empty', async ({ page }) => {
        await page.setContent('<div></div>');
        const locator = page.locator('p');
        await expect(locator).not.toHaveText(['Test']);
      });

      test('fail on not+empty', async ({ page }) => {
        await page.setContent('<div></div>');
        const locator = page.locator('p');
        await expect(locator).not.toHaveText([], { timeout: 1000 });
      });

      test('pass eventually empty', async ({ page }) => {
        await page.setContent('<div id=div><p>Text</p></div>');
        const locator = page.locator('p');
        setTimeout(() => {
          page.evaluate(() => div.innerHTML = "").catch(() => {});
        }, 500);
        await expect(locator).not.toHaveText([]);
      });

      test('fail', async ({ page }) => {
        await page.setContent('<div>Text 1</div><div>Text 3</div>');
        const locator = page.locator('div');
        await expect(locator).toHaveText(['Text 1', /Text \\d/, 'Extra'], { timeout: 1000 });
      });
      `,
  }, { workers: 1 });
  const output = stripAnsi(result.output);
  expect(output).toContain('Error: expect(received).toHaveText(expected) // deep equality');
  expect(output).toContain('await expect(locator).toHaveText');
  expect(output).toContain('-   "Extra"');
  expect(output).toContain('waiting for selector "div"');
  expect(output).toContain('selector resolved to 2 elements');
  expect(result.passed).toBe(6);
  expect(result.failed).toBe(2);
  expect(result.exitCode).toBe(1);
});

test('should support toContainText w/ array', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div>Text \\n1</div><div>Text2</div><div>Text3</div>');
        const locator = page.locator('div');
        await expect(locator).toContainText(['ext     1', /ext3/]);
        // Should support ignoreCase.
        await expect(locator).toContainText(['EXT 1', 'eXt3'], { ignoreCase: true });
      });

      test('fail', async ({ page }) => {
        await page.setContent('<div>Text 1</div><div>Text 3</div>');
        const locator = page.locator('div');
        await expect(locator).toContainText(['Text 2'], { timeout: 1000 });
      });
      `,
  }, { workers: 1 });
  const output = stripAnsi(result.output);
  expect(output).toContain('Error: expect(received).toContainText(expected)');
  expect(output).toContain('await expect(locator).toContainText');
  expect(output).toContain('-   "Text 2"');
  expect(result.passed).toBe(1);
  expect(result.failed).toBe(1);
  expect(result.exitCode).toBe(1);
});

test('should support toHaveText eventually', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass eventually', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const locator = page.locator('#node');
        await Promise.all([
          expect(locator).toHaveText(/Text 2/),
          page.waitForTimeout(1000).then(() => locator.evaluate(element => element.textContent = 'Text 2 content')),
        ]);
      });
      `,
  }, { workers: 1 });
  expect(result.passed).toBe(1);
  expect(result.failed).toBe(0);
  expect(result.exitCode).toBe(0);
});

test('should support toHaveText with innerText', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div id=node>Text <span hidden>garbage</span> content</div>');
        const locator = page.locator('#node');
        await expect(locator).toHaveText('Text content', { useInnerText: true });
      });
      `,
  }, { workers: 1 });
  expect(result.passed).toBe(1);
  expect(result.exitCode).toBe(0);
});

test('should support toHaveAttribute', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).toHaveAttribute('id', 'node');
      });
      `,
  }, { workers: 1 });
  expect(result.passed).toBe(1);
  expect(result.exitCode).toBe(0);
});

test('should support toHaveCSS', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div id=node style="color: rgb(255, 0, 0)">Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).toHaveCSS('color', 'rgb(255, 0, 0)');
      });

      test('pass with custom css properties', async ({ page }) => {
        await page.setContent('<div id=node style="--custom-color-property:#FF00FF;">Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).toHaveCSS('--custom-color-property', '#FF00FF');
      });
      `,
  }, { workers: 1 });
  expect(result.passed).toBe(2);
  expect(result.exitCode).toBe(0);
});

test('should support toHaveId', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const locator = page.locator('#node');
        await expect(locator).toHaveId('node');
      });
      `,
  }, { workers: 1 });
  expect(result.passed).toBe(1);
  expect(result.exitCode).toBe(0);
});

test('should support toHaveValue', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<input id=node></input>');
        const locator = page.locator('#node');
        await locator.fill('Text content');
        await expect(locator).toHaveValue('Text content');
      });

      test('pass on label', async ({ page }) => {
        await page.setContent('<label><input></input></label>');
        await page.locator('label input').fill('Text content');
        await expect(page.locator('label')).toHaveValue('Text content');
      });
      `,
  }, { workers: 1 });
  expect(result.passed).toBe(2);
  expect(result.exitCode).toBe(0);
});

test('should support toHaveValue regex', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<input id=node></input>');
        const locator = page.locator('#node');
        await locator.fill('Text content');
        await expect(locator).toHaveValue(/Text/);
      });
      `,
  }, { workers: 1 });
  expect(result.passed).toBe(1);
  expect(result.exitCode).toBe(0);
});

test('should support toHaveValue failing', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('pass', async ({ page }) => {
        await page.setContent('<input id=node></input>');
        const locator = page.locator('#node');
        await locator.fill('Text content');
        await expect(locator).toHaveValue(/Text2/, { timeout: 1000 });
      });
      `,
  }, { workers: 1 });
  expect(result.passed).toBe(0);
  expect(result.exitCode).toBe(1);
  expect(result.output).toContain('"Text content"');
});

test.describe('should support toHaveValues with multi-select', () => {
  test('works with text', async ({ runInlineTest }) => {
    const result = await runInlineTest({
      'a.test.ts': `
        const { test } = pwt;

        test('pass', async ({ page }) => {
          await page.setContent(\`
            <select multiple>
              <option value="R">Red</option>
              <option value="G">Green</option>
              <option value="B">Blue</option>
            </select>
          \`);
          const locator = page.locator('select');
          await locator.selectOption(['R', 'G']);
          await expect(locator).toHaveValues(['R', 'G']);
        });
        `,
    }, { workers: 1 });
    expect(result.passed).toBe(1);
    expect(result.exitCode).toBe(0);
  });

  test('follows labels', async ({ runInlineTest }) => {
    const result = await runInlineTest({
      'a.test.ts': `
        const { test } = pwt;

        test('pass', async ({ page }) => {
          await page.setContent(\`
            <label for="colors">Pick a Color</label>
            <select id="colors" multiple>
              <option value="R">Red</option>
              <option value="G">Green</option>
              <option value="B">Blue</option>
            </select>
          \`);
          const locator = page.locator('text=Pick a Color');
          await locator.selectOption(['R', 'G']);
          await expect(locator).toHaveValues(['R', 'G']);
        });
        `,
    }, { workers: 1 });
    expect(result.passed).toBe(1);
    expect(result.exitCode).toBe(0);
  });

  test('exact match with text', async ({ runInlineTest }) => {
    const result = await runInlineTest({
      'a.test.ts': `
        const { test } = pwt;

        test('pass', async ({ page }) => {
          await page.setContent(\`
            <select multiple>
              <option value="RR">Red</option>
              <option value="GG">Green</option>
            </select>
          \`);
          const locator = page.locator('select');
          await locator.selectOption(['RR', 'GG']);
          await expect(locator).toHaveValues(['R', 'G']);
        });
        `,
    }, { workers: 1 });
    expect(result.passed).toBe(0);
    expect(result.exitCode).toBe(1);
    expect(stripAnsi(result.output)).toContain(`
    - Expected  - 2
    + Received  + 2

      Array [
    -   "R",
    -   "G",
    +   "RR",
    +   "GG",
      ]
`);
  });

  test('works with regex', async ({ runInlineTest }) => {
    const result = await runInlineTest({
      'a.test.ts': `
        const { test } = pwt;

        test('pass', async ({ page }) => {
          await page.setContent(\`
            <select multiple>
              <option value="R">Red</option>
              <option value="G">Green</option>
              <option value="B">Blue</option>
            </select>
          \`);
          const locator = page.locator('select');
          await locator.selectOption(['R', 'G']);
          await expect(locator).toHaveValues([/R/, /G/]);
        });
        `,
    }, { workers: 1 });
    expect(result.passed).toBe(1);
    expect(result.exitCode).toBe(0);
  });

  test('fails when items not selected', async ({ runInlineTest }) => {
    const result = await runInlineTest({
      'a.test.ts': `
        const { test } = pwt;

        test('pass', async ({ page }) => {
          await page.setContent(\`
            <select multiple>
              <option value="R">Red</option>
              <option value="G">Green</option>
              <option value="B">Blue</option>
            </select>
          \`);
          const locator = page.locator('select');
          await locator.selectOption(['B']);
          await expect(locator).toHaveValues([/R/, /G/]);
        });
        `,
    }, { workers: 1 });
    expect(result.passed).toBe(0);
    expect(result.exitCode).toBe(1);
    expect(stripAnsi(result.output)).toContain(`
    - Expected  - 2
    + Received  + 1

      Array [
    -   /R/,
    -   /G/,
    +   "B",
      ]
`);
  });

  test('fails when multiple not specified', async ({ runInlineTest }) => {
    const result = await runInlineTest({
      'a.test.ts': `
        const { test } = pwt;

        test('pass', async ({ page }) => {
          await page.setContent(\`
            <select>
              <option value="R">Red</option>
              <option value="G">Green</option>
              <option value="B">Blue</option>
            </select>
          \`);
          const locator = page.locator('select');
          await locator.selectOption(['B']);
          await expect(locator).toHaveValues([/R/, /G/]);
        });
        `,
    }, { workers: 1 });
    expect(result.passed).toBe(0);
    expect(result.exitCode).toBe(1);
    expect(result.output).toContain('Not a select element with a multiple attribute');
  });

  test('fails when not a select element', async ({ runInlineTest }) => {
    const result = await runInlineTest({
      'a.test.ts': `
        const { test } = pwt;

        test('pass', async ({ page }) => {
          await page.setContent(\`
            <input value="foo" />
          \`);
          const locator = page.locator('input');
          await expect(locator).toHaveValues([/R/, /G/]);
        });
        `,
    }, { workers: 1 });
    expect(result.passed).toBe(0);
    expect(result.exitCode).toBe(1);
    expect(result.output).toContain('Not a select element with a multiple attribute');
  });
});

test('should print expected/received before timeout', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('times out waiting for text', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        await expect(page.locator('#node')).toHaveText('Text 2');
      });
      `,
  }, { workers: 1, timeout: 2000 });
  expect(result.exitCode).toBe(1);
  expect(result.passed).toBe(0);
  expect(result.failed).toBe(1);
  expect(result.output).toContain('Timeout of 2000ms exceeded.');
  expect(stripAnsi(result.output)).toContain('Expected string: "Text 2"');
  expect(stripAnsi(result.output)).toContain('Received string: "Text content"');
});

test('should print nice error for toHaveText', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('fail', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        await expect(page.locator('no-such-thing')).toHaveText('Text');
      });
      `,
  }, { workers: 1, timeout: 2000 });
  expect(result.failed).toBe(1);
  expect(result.exitCode).toBe(1);
  const output = stripAnsi(result.output);
  expect(output).toContain('Pending operations:');
  expect(output).toContain('Error: expect(received).toHaveText(expected)');
  expect(output).toContain('Expected string: "Text"');
  expect(output).toContain('Received string: ""');
  expect(output).toContain('waiting for selector "no-such-thing"');
});

test('should print expected/received on Ctrl+C', async ({ runInlineTest }) => {
  test.skip(process.platform === 'win32', 'No sending SIGINT on Windows');

  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('times out waiting for text', async ({ page }) => {
        await page.setContent('<div id=node>Text content</div>');
        const promise = expect(page.locator('#node')).toHaveText('Text 2');
        await new Promise(f => setTimeout(f, 500));
        console.log('\\n%%SEND-SIGINT%%');
        await promise;
      });
      `,
  }, { workers: 1 }, {}, { sendSIGINTAfter: 1 });
  expect(result.exitCode).toBe(130);
  expect(result.passed).toBe(0);
  expect(result.skipped).toBe(1);
  expect(stripAnsi(result.output)).toContain('Expected string: "Text 2"');
  expect(stripAnsi(result.output)).toContain('Received string: "Text content"');
});

test('should support not.toHaveText when selector does not match', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      const { test } = pwt;

      test('fails', async ({ page }) => {
        await page.setContent('<div>hello</div>');
        await expect(page.locator('span')).not.toHaveText('hello', { timeout: 1000 });
      });
      `,
  }, { workers: 1 });
  expect(result.exitCode).toBe(1);
  expect(result.passed).toBe(0);
  expect(result.failed).toBe(1);
  const output = stripAnsi(result.output);
  expect(output).toContain('Expected string: not "hello"');
  expect(output).toContain('Received string: ""');
  expect(output).toContain('waiting for selector "span"');
});