chore: include toHaveTitle test on main + increase coverage %

Add toHaveTitle on main so it will be easier to "compare" with multi-remote  support changes

Author: dprevost-LMI

test/matchers/browser/toHaveTitle.test.ts

@@ -0,0 +1,203 @@
+import { vi, test, expect, describe, beforeEach } from 'vitest'
+import { browser } from '@wdio/globals'
+import { toHaveTitle } from '../../../src/matchers/browser/toHaveTitle'
+
+const beforeAssertion = vi.fn()
+const afterAssertion = vi.fn()
+
+const browserA = { getTitle: vi.fn().mockResolvedValue('browserA Title') } as unknown as WebdriverIO.Browser
+const browserB = { getTitle: vi.fn().mockResolvedValue('browserB Title') } as unknown as WebdriverIO.Browser
+const multiRemoteBrowserInstances: Record<string, WebdriverIO.Browser> = {
+    'browserA':  browserA,
+    'browserB':  browserB,
+}
+
+vi.mock('@wdio/globals', () => ({
+    browser: {
+        getTitle: vi.fn().mockResolvedValue(''),
+    },
+    multiremotebrowser: {
+        isMultiremote: true,
+        getTitle: vi.fn().mockResolvedValue(['']),
+        instances: ['browserA'],
+        getInstance: (name: string) => {
+            const instance = multiRemoteBrowserInstances[name]
+            if (!instance) {
+                throw new Error(`No such instance: ${name}`)
+            }
+            return instance
+        }
+    }
+}))
+
+describe('toHaveTitle', async () => {
+    describe('given isNot false', async () => {
+        const defaultContext = { isNot: false, toHaveTitle }
+        const goodTitle = 'some Title text'
+        const wrongTitle = 'some Wrong Title text'
+
+        beforeEach(async () => {
+            beforeAssertion.mockClear()
+            afterAssertion.mockClear()
+        })
+
+        describe('Browser', async () => {
+            beforeEach(async () => {
+                browser.getTitle = vi.fn().mockResolvedValue(goodTitle)
+            })
+
+            describe('given default usage', async () => {
+                test('when success', async () => {
+                    const result = await defaultContext.toHaveTitle(browser, goodTitle)
+
+                    expect(result.pass).toBe(true)
+                })
+
+                test('when failure', async () => {
+                    browser.getTitle = vi.fn().mockResolvedValue(wrongTitle)
+                    const result = await defaultContext.toHaveTitle(browser, goodTitle)
+
+                    expect(result.pass).toBe(false)
+                    expect(result.message()).toEqual(`Expect window to have title
+
+Expected: "some Title text"
+Received: "some Wrong Title text"`
+                    )
+                })
+            })
+
+            describe('given before/after assertion hooks and options', async () => {
+                const options = {
+                    ignoreCase: true,
+                    beforeAssertion,
+                    afterAssertion,
+                } satisfies ExpectWebdriverIO.StringOptions
+
+                test('when success', async () => {
+                    const result = await defaultContext.toHaveTitle(browser, goodTitle, options)
+
+                    expect(result.pass).toBe(true)
+                    expect(beforeAssertion).toBeCalledWith({
+                        matcherName: 'toHaveTitle',
+                        expectedValue: goodTitle,
+                        options,
+                    })
+                    expect(afterAssertion).toBeCalledWith({
+                        matcherName: 'toHaveTitle',
+                        expectedValue: goodTitle,
+                        options,
+                        result,
+                    })
+                })
+
+                test('when failure', async () => {
+                    browser.getTitle = vi.fn().mockResolvedValue(wrongTitle)
+                    const result = await defaultContext.toHaveTitle(browser, goodTitle, options)
+
+                    expect(result.pass).toBe(false)
+                    expect(result.message()).toEqual(`Expect window to have title
+
+Expected: "some Title text"
+Received: "some Wrong Title text"`
+                    )
+                    expect(beforeAssertion).toBeCalledWith({
+                        matcherName: 'toHaveTitle',
+                        expectedValue: goodTitle,
+                        options: { ignoreCase: true, beforeAssertion, afterAssertion },
+                    })
+                    expect(afterAssertion).toBeCalledWith({
+                        matcherName: 'toHaveTitle',
+                        expectedValue: goodTitle,
+                        options: { ignoreCase: true, beforeAssertion, afterAssertion },
+                        result,
+                    })
+                })
+            })
+        })
+    })
+
+    describe('given isNot true', async () => {
+        const defaultContext = { isNot: true, toHaveTitle }
+        const aTitle = 'some Title text'
+        const negatedExpectedTitle = 'some Title text not expected to be'
+
+        beforeEach(async () => {
+            beforeAssertion.mockClear()
+            afterAssertion.mockClear()
+        })
+
+        describe('Browser', async () => {
+            beforeEach(async () => {
+                browser.getTitle = vi.fn().mockResolvedValue(aTitle)
+            })
+
+            describe('given default usage', async () => {
+                test('when success', async () => {
+                    const result = await defaultContext.toHaveTitle(browser, negatedExpectedTitle)
+
+                    expect(result.pass).toBe(true)
+                })
+
+                test('when failure', async () => {
+                    browser.getTitle = vi.fn().mockResolvedValue(negatedExpectedTitle)
+                    const result = await defaultContext.toHaveTitle(browser, negatedExpectedTitle)
+
+                    expect(result.pass).toBe(false)
+                    expect(result.message()).toEqual(`Expect window not to have title
+
+Expected [not]: "some Title text not expected to be"
+Received      : "some Title text not expected to be"`
+                    )
+                })
+            })
+
+            describe('given before/after assertion hooks and options', async () => {
+                const options = {
+                    ignoreCase: true,
+                    beforeAssertion,
+                    afterAssertion,
+                } satisfies ExpectWebdriverIO.StringOptions
+
+                test('when success', async () => {
+                    const result = await defaultContext.toHaveTitle(browser, negatedExpectedTitle, options)
+
+                    expect(result.pass).toBe(true)
+                    expect(beforeAssertion).toBeCalledWith({
+                        matcherName: 'toHaveTitle',
+                        expectedValue: negatedExpectedTitle,
+                        options,
+                    })
+                    expect(afterAssertion).toBeCalledWith({
+                        matcherName: 'toHaveTitle',
+                        expectedValue: negatedExpectedTitle,
+                        options,
+                        result,
+                    })
+                })
+
+                test('when failure', async () => {
+                    browser.getTitle = vi.fn().mockResolvedValue(negatedExpectedTitle)
+                    const result = await defaultContext.toHaveTitle(browser, negatedExpectedTitle, options)
+
+                    expect(result.pass).toBe(false)
+                    expect(result.message()).toEqual(`Expect window not to have title
+
+Expected [not]: "some Title text not expected to be"
+Received      : "some Title text not expected to be"`
+                    )
+                    expect(beforeAssertion).toBeCalledWith({
+                        matcherName: 'toHaveTitle',
+                        expectedValue: negatedExpectedTitle,
+                        options: { ignoreCase: true, beforeAssertion, afterAssertion },
+                    })
+                    expect(afterAssertion).toBeCalledWith({
+                        matcherName: 'toHaveTitle',
+                        expectedValue: negatedExpectedTitle,
+                        options: { ignoreCase: true, beforeAssertion, afterAssertion },
+                        result,
+                    })
+                })
+            })
+        })
+    })
+})

vitest.config.ts

@@ -29,10 +29,10 @@ export default defineConfig({
                 'types-checks-filter-out-node_modules.js',
             ],
             thresholds: {
-                lines: 87.3,
+                lines: 87.7,
                 functions: 85.8,
-                statements: 87,
-                branches: 78.6,
+                statements: 87.5,
+                branches: 78.8,
             }
         }
     }