Add UT of global config for multiple matchers

Author: dprevost-LMI

test/matchers/beMatchers.test.ts

@@ -1,7 +1,10 @@
-import { vi, test, describe, expect } from 'vitest'
+import { vi, test, describe, expect, afterEach, beforeEach } from 'vitest'
 import { $ } from '@wdio/globals'
 import { matcherLastWordName } from '../__fixtures__/utils.js'
 import * as Matchers from '../../src/matchers.js'
+import { setOptions } from '../../src/index.js'
+import { DEFAULT_OPTIONS } from '../../src/constants.js'
+import { executeCommandBe } from '../../src/utils.js'
 
 vi.mock('@wdio/globals')
 
@@ -17,6 +20,15 @@ const beMatchers = {
     'toBeSelected': 'isSelected',
 } satisfies Partial<Record<keyof typeof Matchers, keyof WebdriverIO.Element>>
 
+vi.mock('../../src/utils.js', async (importOriginal) => {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-imports
+    const actual = await importOriginal<typeof import('../../src/utils.js')>()
+    return {
+        ...actual,
+        executeCommandBe: vi.fn(actual.executeCommandBe)
+    }
+})
+
 describe('be* matchers', () => {
     describe('Ensure all toBe matchers are covered', () => {
 
@@ -135,6 +147,35 @@ Expected: "${matcherLastWordName(matcherName)}"
 Received: "not ${matcherLastWordName(matcherName)}"`
                 )
             })
+
+            describe('global options', () => {
+                const defaultOptions = { ...DEFAULT_OPTIONS }
+
+                beforeEach(() => {
+                    // Set global options to custom values before each test
+                    setOptions({ wait: 99, interval: 101 })
+                })
+
+                afterEach(() => {
+                    // Reset options after each test to avoid side effects
+                    setOptions(defaultOptions)
+                    expect(DEFAULT_OPTIONS.wait).not.toBe(99)
+                })
+
+                test('should use globally set default options', async () => {
+                    const el = await $('sel')
+                    el.isDisplayed = vi.fn().mockResolvedValue(true)
+
+                    await matcherFn.call({}, el)
+
+                    expect(DEFAULT_OPTIONS.wait).toBe(99)
+                    expect(executeCommandBe).toHaveBeenCalledWith(
+                        el,
+                        expect.anything(),
+                        expect.objectContaining({ wait: 99, interval: 101 })
+                    )
+                })
+            })
         })
     })
 })

test/matchers/element/toBeDisplayed.test.ts

@@ -1,9 +1,11 @@
-import { vi, test, describe, expect } from 'vitest'
+import { vi, test, describe, expect, afterEach, beforeEach } from 'vitest'
 import { $ } from '@wdio/globals'
 
 import { toBeDisplayed } from '../../../src/matchers/element/toBeDisplayed.js'
 import { executeCommandBe } from '../../../src/utils.js'
-import { DEFAULT_OPTIONS } from '../../../src/constants.js'
+import { DEFAULT_OPTIONS, DEFAULT_OPTIONS_TO_BE_DISPLAYED } from '../../../src/constants.js'
+import { setOptions } from '../../../src/index.js'
+import type { ChainablePromiseElement } from 'webdriverio'
 
 vi.mock('@wdio/globals')
 vi.mock('../../../src/utils.js', async (importOriginal) => {
@@ -15,7 +17,7 @@ vi.mock('../../../src/utils.js', async (importOriginal) => {
     }
 })
 
-describe('toBeDisplayed', () => {
+describe(toBeDisplayed, () => {
     /**
      * result is inverted for toBeDisplayed because it inverts isEnabled result
      * `!await el.isEnabled()`
@@ -189,4 +191,55 @@ Expected: "displayed"
 Received: "not displayed"`
         )
     })
+
+    describe('global options', () => {
+        const defaultOptions = { ...DEFAULT_OPTIONS }
+
+        let el: ChainablePromiseElement
+
+        beforeEach(async () => {
+            // Reset to known state before each test
+            setOptions({ wait: 99, interval: 101 })
+            el = await $('sel')
+            el.isDisplayed = vi.fn().mockResolvedValue(true)
+
+        })
+
+        afterEach(() => {
+            // Reset options after each test to avoid side effects
+            setOptions(defaultOptions)
+            expect(DEFAULT_OPTIONS.wait).not.toBe(99)
+        })
+
+        test('should use globally set default options with executeCommandBe', async () => {
+            await toBeDisplayed.call({}, el)
+
+            expect(DEFAULT_OPTIONS.wait).toBe(99)
+            expect(DEFAULT_OPTIONS_TO_BE_DISPLAYED.wait).toBe(99)
+            expect(executeCommandBe).toHaveBeenCalledWith(
+                el,
+                expect.anything(),
+                expect.objectContaining({ wait: 99, interval: 101 })
+            )
+        })
+
+        test('should use globally set default options with isDisplayed', async () => {
+
+            await toBeDisplayed.call({}, el)
+
+            expect(executeCommandBe).toHaveBeenCalledWith(
+                el,
+                expect.anything(),
+                expect.objectContaining({ wait: 99, interval: 101 })
+            )
+            expect(el.isDisplayed).toHaveBeenCalledWith(
+                {
+                    withinViewport: false,
+                    contentVisibilityAuto: true,
+                    opacityProperty: true,
+                    visibilityProperty: true
+                }
+            )
+        })
+    })
 })

test/options.test.ts

@@ -0,0 +1,26 @@
+import { test, expect, describe, beforeEach, afterEach } from 'vitest'
+import { setOptions } from '../src/index.js'
+import { DEFAULT_OPTIONS, DEFAULT_OPTIONS_TO_BE_DISPLAYED } from '../src/constants.js'
+
+describe('setDefaultOptions', () => {
+    const defaultOptions = { ...DEFAULT_OPTIONS }
+    beforeEach(() => {
+        // Set global options to custom values before each test
+        setOptions({ wait: 2000, interval: 100 })
+    })
+    afterEach(() => {
+        // Reset global options to default values after each test
+        setOptions(defaultOptions)
+    })
+
+    test('setDefaultOptions should update both DEFAULT_OPTIONS_TO_BE_DISPLAYED and DEFAULT_OPTIONS', () => {
+        expect(DEFAULT_OPTIONS_TO_BE_DISPLAYED.wait).not.toBe(1234)
+        expect(DEFAULT_OPTIONS.wait).not.toBe(1234)
+
+        setOptions({ wait: 1234 })
+
+        expect(DEFAULT_OPTIONS_TO_BE_DISPLAYED.wait).toBe(1234)
+        expect(DEFAULT_OPTIONS.wait).toBe(1234)
+    })
+})
+