tlc-core-automation-framework-v3-wdio-v9/src/e2e/helpers/framework-helpers/check/checkProperty.ts

Background: - We are following multi-layer automation framework architecture using webdriver.io + cucumber + typescript This core framework has been implemented with generic utility functions and cucumber steps, which can be easily consumed by another fra

import {ConfigHelper} from "../../common-helpers/config-helper";
import {PageConfigTypes} from "../../../custom-types/pageConfig-types";
import {CustomExpect} from "../../common-helpers/custom-expect";
import {browser, $, $$, expect} from '@wdio/globals'

/**
 * Check the given property of the given element
 * @param  {String}   isCSS         Whether to check for a CSS property or an
 *                                  attribute
 * @param  {String}   attrName      The name of the attribute to check
 * @param  {String}   selector          Element selector
 * @param  {boolean}   falseCase     Whether to check if the value of the
 *                                  attribute matches or not
 * @param  {String}   expectedValue The value to match against
 */
export default async function (isCSS: boolean, attrName: string, pageConfig: PageConfigTypes, falseCase: boolean, expectedValue: number | string) {
    const command = isCSS ? 'getCSSProperty' : 'getAttribute';
    /**
     * The actual attribute value
     * @type {Mixed}
     */
    let attributeValue = await $(pageConfig.selector)[command](attrName);

    // eslint-disable-next-line
    expectedValue = isFinite(expectedValue as number) ? parseFloat(expectedValue as string) : expectedValue;

    /**
     * when getting something with a color or font-weight WebdriverIO returns a
     * object but we want to assert against a string
     */
    if (attrName.match(/(font-size|line-height|display|font-weight)/)) {
        // @ts-expect-error
        attributeValue = attributeValue.value;
    } else if (attrName.match(/(color)/)) {
        // @ts-expect-error
        attributeValue = attributeValue.parsed.hex
    }

    if (falseCase)
        CustomExpect.expectNotToEqual(attributeValue, expectedValue, `Actual "${attrName}" of element "${pageConfig.pageId}.${pageConfig.elementKey}" equals to expected`)
    else
        CustomExpect.expectToEqual(attributeValue, expectedValue, `Actual "${attrName}" of element "${pageConfig.pageId}.${pageConfig.elementKey}" is equal to expected`)
};