تخطى إلى المحتوى الرئيسي

الأوامر المخصصة

إذا كنت ترغب في توسيع مثيل browser بمجموعتك الخاصة من الأوامر، فإن طريقة المتصفح addCommand متوفرة لك. يمكنك كتابة أوامرك بطريقة غير متزامنة، تمامًا كما في مواصفاتك.

المعلمات​

اسم الأمر​

اسم يحدد الأمر وسيتم إرفاقه بنطاق المتصفح أو العنصر.

النوع: String

الدالة المخصصة​

دالة يتم تنفيذها عند استدعاء الأمر. نطاق this هو إما WebdriverIO.Browser أو WebdriverIO.Element اعتمادًا على ما إذا كان الأمر مرفقًا بنطاق المتصفح أو العنصر.

النوع: Function

الخيارات​

كائن مع خيارات التكوين التي تعدل سلوك الأمر المخصص

نطاق الهدف​

علم لتحديد ما إذا كان يجب إرفاق الأمر بنطاق المتصفح أو نطاق العنصر. إذا تم تعيينه على true، سيكون الأمر أمر عنصر.

اسم الخيار: attachToElement النوع: Boolean
الافتراضي: false

تعطيل implicitWait​

علم لتحديد ما إذا كان يجب الانتظار ضمنيًا حتى يوجد العنصر قبل استدعاء الأمر المخصص.

اسم الخيار: disableElementImplicitWait النوع: Boolean
الافتراضي: false

أمثلة​

يوضح هذا المثال كيفية إضافة أمر جديد يقوم بإرجاع عنوان URL الحالي والعنوان كنتيجة واحدة. النطاق (this) هو كائن WebdriverIO.Browser.

browser.addCommand('getUrlAndTitle', async function (customVar) {
    // `this` refers to the `browser` scope
    return {
        url: await this.getUrl(),
        title: await this.getTitle(),
        customVar: customVar
    }
})

بالإضافة إلى ذلك، يمكنك توسيع مثيل العنصر بمجموعتك الخاصة من الأوامر، عن طريق تمرير true كوسيطة نهائية. النطاق (this) في هذه الحالة هو كائن WebdriverIO.Element.

browser.addCommand("waitAndClick", async function () {
    // `this` is return value of $(selector)
    await this.waitForDisplayed()
    await this.click()
}, { attachToElement: true })

بشكل افتراضي، تنتظر أوامر العناصر المخصصة وجود العنصر قبل استدعاء الأمر المخصص. على الرغم من أن هذا مرغوب فيه في معظم الأوقات، إلا أنه يمكن تعطيله باستخدام disableImplicitWait:

browser.addCommand("waitAndClick", async function () {
    // `this` is return value of $(selector)
    await this.waitForExists()
    await this.click()
}, { attachToElement: true, disableElementImplicitWait: true })

تمنحك الأوامر المخصصة فرصة لتجميع تسلسل محدد من الأوامر التي تستخدمها بشكل متكرر في مكالمة واحدة. يمكنك تحديد أوامر مخصصة في أي نقطة في مجموعة اختبارك؛ فقط تأكد من تعريف الأمر قبل استخدامه لأول مرة. (الخطاف before في ملف wdio.conf.js هو مكان جيد لإنشائها.)

بمجرد تعريفها، يمكنك استخدامها على النحو التالي:

it('should use my custom command', async () => {
    await browser.url('http://www.github.com')
    const result = await browser.getUrlAndTitle('foobar')

    assert.strictEqual(result.url, 'https://github.com/')
    assert.strictEqual(result.title, 'GitHub · Where software is built')
    assert.strictEqual(result.customVar, 'foobar')
})

ملاحظة: إذا قمت بتسجيل أمر مخصص في نطاق browser، فلن يكون الأمر متاحًا للعناصر. وبالمثل، إذا قمت بتسجيل أمر في نطاق العنصر، فلن يكون متاحًا في نطاق browser:

browser.addCommand("myCustomBrowserCommand", () => { return 1 })
const elem = await $('body')
console.log(typeof browser.myCustomBrowserCommand) // outputs "function"
console.log(typeof elem.myCustomBrowserCommand()) // outputs "undefined"

browser.addCommand("myCustomElementCommand", () => { return 1 }, { attachToElement: true })
const elem2 = await $('body')
console.log(typeof browser.myCustomElementCommand) // outputs "undefined"
console.log(await elem2.myCustomElementCommand('foobar')) // outputs "1"

const elem3 = await $('body')
elem3.addCommand("myCustomElementCommand2", () => { return 2 })
console.log(typeof browser.myCustomElementCommand2) // outputs "undefined"
console.log(await elem3.myCustomElementCommand2('foobar')) // outputs "2"

ملاحظة: إذا كنت بحاجة إلى ربط أمر مخصص، يجب أن ينتهي الأمر بـ $,

browser.addCommand("user$", (locator) => { return ele })
browser.addCommand("user$", (locator) => { return ele }, { attachToElement: true })
await browser.user$('foo').user$('bar').click()

كن حذرًا من عدم إثقال نطاق browser بالكثير من الأوامر المخصصة.

نوصي بتعريف المنطق المخصص في page objects، بحيث تكون مرتبطة بصفحة محددة.

Multiremote​

يعمل addCommand بطريقة مماثلة لـ multiremote، باستثناء أن الأمر الجديد سينتشر إلى الأنظمة الفرعية للأطفال. يجب أن تكون حذرًا عند استخدام الكائن this لأن المتصفح متعدد التحكم browser ومثيلات الأطفال التابعة له لها this مختلفة.

يوضح هذا المثال كيفية إضافة أمر جديد لـ multiremote.

import { multiremotebrowser } from '@wdio/globals'

multiremotebrowser.addCommand('getUrlAndTitle', async function (this: WebdriverIO.MultiRemoteBrowser, customVar: any) {
    // `this` refers to:
    //      - MultiRemoteBrowser scope for browser
    //      - Browser scope for instances
    return {
        url: await this.getUrl(),
        title: await this.getTitle(),
        customVar: customVar
    }
})

multiremotebrowser.getUrlAndTitle()
/*
{
    url: [ 'https://webdriver.io/', 'https://webdriver.io/' ],
    title: [
        'WebdriverIO · Next-gen browser and mobile automation test framework for Node.js | WebdriverIO',
        'WebdriverIO · Next-gen browser and mobile automation test framework for Node.js | WebdriverIO'
    ],
    customVar: undefined
}
*/

multiremotebrowser.getInstance('browserA').getUrlAndTitle()
/*
{
    url: 'https://webdriver.io/',
    title: 'WebdriverIO · Next-gen browser and mobile automation test framework for Node.js | WebdriverIO',
    customVar: undefined
}
*/

توسيع تعريفات الأنواع​

مع TypeScript، من السهل توسيع واجهات WebdriverIO. أضف أنواعًا إلى أوامرك المخصصة كما يلي:

  1. قم بإنشاء ملف تعريف النوع (مثل ./src/types/wdio.d.ts)

  2. أ. إذا كنت تستخدم ملف تعريف النوع على نمط الوحدة (باستخدام import/export و declare global WebdriverIO في ملف تعريف النوع)، تأكد من تضمين مسار الملف في خاصية include في ملف tsconfig.json.

    ب. إذا كنت تستخدم ملفات تعريف النوع بأسلوب محيط (بدون import/export في ملفات تعريف النوع و declare namespace WebdriverIO للأوامر المخصصة)، تأكد من أن ملف tsconfig.json لا يحتوي على أي قسم include، لأن هذا سيتسبب في عدم التعرف على جميع ملفات تعريف النوع غير المدرجة في قسم include بواسطة TypeScript.

tsconfig.json
{
    "compilerOptions": { ... },
    "include": [
        "./test/**/*.ts",
        "./src/types/**/*.ts"
    ]
}
  1. أضف تعريفات لأوامرك وفقًا لوضع التنفيذ الخاص بك.
declare global {
    namespace WebdriverIO {
        interface Browser {
            browserCustomCommand: (arg: any) => Promise<void>
        }

        interface MultiRemoteBrowser {
            browserCustomCommand: (arg: any) => Promise<void>
        }

        interface Element {
            elementCustomCommand: (arg: any) => Promise<number>
        }
    }
}

دمج مكتبات الطرف الثالث​

إذا كنت تستخدم مكتبات خارجية (مثل إجراء مكالمات قاعدة البيانات) التي تدعم الوعود، فإن النهج الجيد لدمجها هو تغليف طرق API معينة بأمر مخصص.

عند إرجاع الوعد، يضمن WebdriverIO عدم المتابعة مع الأمر التالي حتى يتم حل الوعد. إذا تم رفض الوعد، فإن الأمر سيطرح خطأ.

browser.addCommand('makeRequest', async (url) => {
    const response = await fetch(url)
    return await response.json()
})

ثم، ما عليك سوى استخدامه في مواصفات اختبار WDIO الخاصة بك:

it('execute external library in a sync way', async () => {
    await browser.url('...')
    const body = await browser.makeRequest('http://...')
    console.log(body) // returns response body
})

ملاحظة: نتيجة الأمر المخصص الخاص بك هي نتيجة الوعد الذي ترجعه.

استبدال الأوامر​

يمكنك أيضًا استبدال الأوامر الأصلية باستخدام overwriteCommand.

لا يُنصح بالقيام بذلك، لأنه قد يؤدي إلى سلوك غير متوقع للإطار!

النهج العام مشابه لـ addCommand، الفرق الوحيد هو أن الوسيطة الأولى في دالة الأمر هي الدالة الأصلية التي أنت على وشك استبدالها. يرجى الاطلاع على بعض الأمثلة أدناه.

استبدال أوامر المتصفح​

/**
 * Print milliseconds before pause and return its value.
 * 
 * @param pause - name of command to be overwritten
 * @param this of func - the original browser instance on which the function was called
 * @param originalPauseFunction of func - the original pause function
 * @param ms of func - the actual parameters passed
  */
browser.overwriteCommand('pause', async function (this, originalPauseFunction, ms) {
    console.log(`sleeping for ${ms}`)
    await originalPauseFunction(ms)
    return ms
})

// then use it as before
console.log(`was sleeping for ${await browser.pause(1000)}`)

استبدال أوامر العناصر​

استبدال الأوامر على مستوى العنصر هو نفسه تقريبًا. ببساطة قم بتمرير true كوسيطة ثالثة إلى overwriteCommand:

/**
 * Attempt to scroll to element if it is not clickable.
 * Pass { force: true } to click with JS even if element is not visible or clickable.
 * Show that the original function argument type can be kept with `options?: ClickOptions`
 *
 * @param this of func - the element on which the original function was called
 * @param originalClickFunction of func - the original pause function
 * @param options of func - the actual parameters passed
 */
browser.overwriteCommand(
    'click',
    async function (this, originalClickFunction, options?: ClickOptions & { force?: boolean }) {
        const { force, ...restOptions } = options || {}
        if (!force) {
            try {
                // attempt to click
                await originalClickFunction(options)
                return
            } catch (err) {
                if ((err as Error).message.includes('not clickable at point')) {
                    console.warn('WARN: Element', this.selector, 'is not clickable.', 'Scrolling to it before clicking again.')

                    // scroll to element and click again
                    await this.scrollIntoView()
                    return originalClickFunction(options)
                }
                throw err
            }
        }

        // clicking with js
        console.warn('WARN: Using force click for', this.selector)
        await browser.execute((el) => {
            el.click()
        }, this)
    },
    { attachToElement: true }, // Don't forget to attach it to the element
)

// then use it as before
const elem = await $('body')
await elem.click()

// or pass params
await elem.click({ force: true })

إضافة المزيد من أوامر WebDriver​

إذا كنت تستخدم بروتوكول WebDriver وتقوم بتشغيل اختبارات على منصة تدعم أوامر إضافية غير محددة بأي من تعريفات البروتوكول في @wdio/protocols، يمكنك إضافتها يدويًا من خلال واجهة addCommand. توفر حزمة webdriver مغلفًا للأمر يسمح بتسجيل نقاط النهاية الجديدة بنفس طريقة الأوامر الأخرى، مما يوفر نفس فحوصات المعلمات ومعالجة الأخطاء. لتسجيل نقطة النهاية الجديدة هذه، قم باستيراد مغلف الأمر وتسجيل أمر جديد معها على النحو التالي:

import { command } from 'webdriver'

browser.addCommand('myNewCommand', command('POST', '/session/:sessionId/foobar/:someId', {
    command: 'myNewCommand',
    description: 'a new WebDriver command',
    ref: 'https://vendor.com/commands/#myNewCommand',
    variables: [{
        name: 'someId',
        description: 'some id to something'
    }],
    parameters: [{
        name: 'foo',
        type: 'string',
        description: 'a valid parameter',
        required: true
    }]
}))

استدعاء هذا الأمر بمعلمات غير صالحة يؤدي إلى نفس معالجة الأخطاء مثل أوامر البروتوكول المحددة مسبقًا، على سبيل المثال:

// call command without required url parameter and payload
await browser.myNewCommand()

/**
 * results in the following error:
 * Error: Wrong parameters applied for myNewCommand
 * Usage: myNewCommand(someId, foo)
 *
 * Property Description:
 *   "someId" (string): some id to something
 *   "foo" (string): a valid parameter
 *
 * For more info see https://my-api.com
 *    at Browser.protocolCommand (...)
 *    ...
 */

استدعاء الأمر بشكل صحيح، مثل browser.myNewCommand('foo', 'bar')، يجعل طلب WebDriver بشكل صحيح إلى على سبيل المثال http://localhost:4444/session/7bae3c4c55c3bf82f54894ddc83c5f31/foobar/foo مع حمولة مثل { foo: 'bar' }.

ملاحظة

سيتم استبدال معلمة عنوان URL :sessionId تلقائيًا بمعرف الجلسة لجلسة WebDriver. يمكن تطبيق معلمات عنوان URL الأخرى ولكن يجب تعريفها ضمن variables.

انظر أمثلة على كيفية تعريف أوامر البروتوكول في حزمة @wdio/protocols.

Welcome! How can I help?

WebdriverIO AI Copilot