@wdio/image-comparison-core/dist/commands/saveTabbablePage.test.js

Image comparison core module for @wdio/visual-service - WebdriverIO visual testing framework

import { describe, it, expect, vi, afterEach, beforeEach } from 'vitest';
import saveTabbablePage from './saveTabbablePage.js';
import { BASE_CHECK_OPTIONS, createMethodOptions } from '../mocks/mocks.js';
vi.mock('./saveFullPageScreen.js', () => ({
    default: vi.fn().mockResolvedValue({
        devicePixelRatio: 2,
        fileName: 'test-tabbable-page.png'
    })
}));
vi.mock('../clientSideScripts/drawTabbableOnCanvas.js', () => ({
    default: vi.fn()
}));
vi.mock('../clientSideScripts/removeElementFromDom.js', () => ({
    default: vi.fn()
}));
describe('saveTabbablePage', () => {
    let saveFullPageScreen;
    const executeMock = vi.fn().mockResolvedValue(undefined);
    const baseOptions = {
        browserInstance: {
            execute: executeMock,
            isAndroid: false,
            isMobile: false
        },
        folders: BASE_CHECK_OPTIONS.folders,
        instanceData: BASE_CHECK_OPTIONS.instanceData,
        isNativeContext: false,
        saveTabbableOptions: {
            wic: {
                ...BASE_CHECK_OPTIONS.wic,
                tabbableOptions: {
                    circle: {
                        backgroundColor: 'red',
                        borderColor: 'blue',
                        borderWidth: 2,
                        fontColor: 'white',
                        fontFamily: 'Arial',
                        fontSize: 10,
                        size: 10,
                        showNumber: true
                    },
                    line: {
                        color: 'blue',
                        width: 1
                    }
                }
            },
            method: createMethodOptions()
        },
        tag: 'test-tabbable-page'
    };
    beforeEach(async () => {
        saveFullPageScreen = (await vi.importMock('./saveFullPageScreen.js')).default;
    });
    afterEach(() => {
        vi.clearAllMocks();
    });
    it('should throw an error when in native context', async () => {
        const options = {
            ...baseOptions,
            isNativeContext: true
        };
        await expect(saveTabbablePage(options)).rejects.toThrow('The method saveTabbablePage is not supported in native context for native mobile apps!');
        expect(executeMock).not.toHaveBeenCalled();
        expect(saveFullPageScreen).not.toHaveBeenCalled();
    });
    it('should save a tabbable page screenshot', async () => {
        const result = await saveTabbablePage(baseOptions);
        expect(result).toMatchSnapshot();
        expect(executeMock).toHaveBeenCalledTimes(2);
        expect(executeMock.mock.calls).toMatchSnapshot();
        expect(saveFullPageScreen.mock.calls).toMatchSnapshot();
    });
});