الإعدادات
بناءً على نوع الإعداد (مثلاً استخدام ارتباطات البروتوكول المباشرة، أو حزمة WebdriverIO المستقلة أو منصة اختبار WDIO) هناك مجموعة مختلفة من الخيارات المتاحة للتحكم في البيئة.
خيارات WebDriver
الخيارات التالية محددة عند استخدام حزمة بروتوكول webdriver
:
protocol
البروتوكول المستخدم عند التواصل مع خادم السائق.
النوع: String
القيمة الافتراضية: http
hostname
مضيف خادم السائق الخاص بك.
النوع: String
القيمة الافتراضية: 0.0.0.0
port
المنفذ الذي يعمل عليه خادم السائق.
النوع: Number
القيمة الافتراضية: undefined
path
المسار إلى نقطة نهاية خادم ال سائق.
النوع: String
القيمة الافتراضية: /
queryParams
معلمات الاستعلام التي يتم تمريرها إلى خادم السائق.
النوع: Object
القيمة الافتراضية: undefined
user
اسم المستخدم لخدمة السحابة الخاصة بك (يعمل فقط مع حسابات Sauce Labs، Browserstack، TestingBot أو LambdaTest). إذا تم تعيينه، سيقوم WebdriverIO تلقائيًا بتعيين خيارات الاتصال لك. إذا كنت لا تستخدم مزودًا سحابيًا، يمكن استخدام هذا لمصادقة أي خادم WebDriver آخر.
النوع: String
القيمة الافتراضية: undefined
key
مفتاح الوصول أو المفتاح السري لخدمة السحابة الخاصة بك (يعمل فقط مع حسابات Sauce Labs، Browserstack، TestingBot أو LambdaTest). إذا تم تعيينه، سيقوم WebdriverIO تلقائيًا بتعيين خيارات الاتصال لك. إذا كنت لا تستخدم مزودًا سحابيًا، يمكن استخدام هذا لمصادقة أي خادم WebDriver آخر.
النوع: String
القيمة الافتراضية: undefined
capabilities
يحدد القدرات التي تريد تشغيلها في جلسة WebDriver الخاصة بك. راجع بروتوكول WebDriver لمزيد من التفاصيل. إذا كنت تستخدم سائقًا قديمًا لا يدعم بروتوكول WebDriver، فستحتاج إلى استخدام قدرات JSONWireProtocol لتشغيل جلسة بنجاح.
بالإضافة إلى القدرات المستندة إلى WebDriver، يمكنك تطبيق خيارات خاصة بالمتصفح والبائع تسمح بتكوين أعمق للمتصفح أو الجهاز البعيد. هذه موثقة في وثائق الموردين المقابلة، على سبيل المثال:
goog:chromeOptions
: لـ Google Chromemoz:firefoxOptions
: لـ Mozilla Firefoxms:edgeOptions
: لـ Microsoft Edgesauce:options
: لـ Sauce Labsbstack:options
: لـ BrowserStackselenoid:options
: لـ Selenoid
بالإضافة إلى ذلك، هناك أداة مفيدة هي مكون تكوين الاختبار الآلي من Sauce Labs، والتي تساعدك على إنشاء هذا الكائن من خلال النقر على القدرات المطلوبة.
النوع: Object
القيمة الافتراضية: null
مثال:
{
browserName: 'chrome', // الخيارات: `chrome`, `edge`, `firefox`, `safari`
browserVersion: '27.0', // إصدار المتصفح
platformName: 'Windows 10' // منصة نظام التشغيل
}
إذا كنت تقوم بإجراء اختبارات ويب أو اختبارات أصلية على أجهزة محمولة، فإن capabilities
تختلف عن بروتوكول WebDriver. راجع وثائق Appium لمزيد من التفاصيل.
logLevel
مستوى تفصيل السجلات.
النوع: String
القيمة الافتراضية: info
الخيارات: trace
| debug
| info
| warn
| error
| silent
outputDir
الدليل لتخزين جميع ملفات سجل منصة الاختبار (بما في ذلك سجلات المراسل وسجلات wdio
). إذا لم يتم تعيينه، يتم بث جميع السجلات إلى stdout
. نظرًا لأن معظم المراسلين مصممون للسجل في stdout
، يوصى باستخدام هذا الخيار فقط لمراسلين محددين حيث يكون من المنطقي أكثر دفع التقرير إلى ملف (مثل مراسل junit
).
عند التشغيل في الوضع المست قل، السجل الوحيد الذي يتم إنشاؤه بواسطة WebdriverIO سيكون سجل wdio
.
النوع: String
القيمة الافتراضية: null
connectionRetryTimeout
المهلة الزمنية لأي طلب WebDriver إلى سائق أو شبكة.
النوع: Number
القيمة الافتراضية: 120000
connectionRetryCount
الحد الأقصى لعدد إعادة محاولات الطلب إلى خادم Selenium.
النوع: Number
القيمة الافتراضية: 3
agent
يسمح لك باستخدام وكيل http
/https
/http2
agent مخصص لإجراء الطلبات.
النوع: Object
القيمة الافتراضية:
{
http: new http.Agent({ keepAlive: true }),
https: new https.Agent({ keepAlive: true })
}
headers
حدد headers
مخصصة لتمريرها في كل طلب WebDriver. إذا كانت شبكة Selenium الخاصة بك تتطلب المصادقة الأساسية، نوصي بتمرير رأس Authorization
من خلال هذا الخيار لمصادقة طلبات WebDriver الخاصة بك، على سبيل المثال:
import { Buffer } from 'buffer';
// قراءة اسم المستخدم وكلمة المرور من متغيرات البيئة
const username = process.env.SELENIUM_GRID_USERNAME;
const password = process.env.SELENIUM_GRID_PASSWORD;
// دمج اسم المستخدم وكلمة المرور بفاصل نقطتي
const credentials = `${username}:${password}`;
// ترميز بيانات الاعتماد باستخدام Base64
const encodedCredentials = Buffer.from(credentials).toString('base64');
export const config: WebdriverIO.Config = {
// ...
headers: {
Authorization: `Basic ${encodedCredentials}`
}
// ...
}
النوع: Object
القيمة الافتراضية: {}
transformRequest
دالة تعترض خيارات طلب HTTP قبل إجراء طلب WebDriver
النوع: (RequestOptions) => RequestOptions
القيمة الافتراضية: لا شيء
transformResponse
دالة تعترض كائنات استجابة HTTP بعد وصول استجابة WebDriver. يتم تمرير الدالة كائن الاستجابة الأصلي كمعلمة أولى وRequestOptions
المقابلة كمعلمة ثانية.
النوع: (Response, RequestOptions) => Response
القيمة الافتراضية: لا شيء
strictSSL
ما إذا كان لا يتطلب أن تكون شهادة SSL صالحة.
يمكن تعيينها عبر متغيرات بيئية مثل STRICT_SSL
أو strict_ssl
.
النوع: Boolean
القيمة الافتراضية: true
enableDirectConnect
ما إذا كان تمكين ميزة الاتصال المباشر Appium. لا يفعل شيئًا إذا لم تحتوي الاستجابة على المفاتيح المناسبة أثناء تمكين العلامة.
النوع: Boolean
القيمة الافتراضية: true
cacheDir
المسار إلى جذر دليل التخزين المؤقت. يستخدم هذا الدليل لتخزين جميع برامج التشغيل التي يتم تنزيلها عند محاولة بدء جلسة.
النوع: String
القيمة الافتراضية: process.env.WEBDRIVER_CACHE_DIR || os.tmpdir()
WebdriverIO
يمكن استخدام الخيارات التالية (بما في ذلك تلك المذكورة أعلاه) مع WebdriverIO في الوضع المستقل:
automationProtocol
حدد البروتوكول الذي تريد استخدامه لأتمتة المتصفح. حاليًا يتم دعم webdriver
فقط، حيث أنه تقنية أتمتة المتصفح الرئيسية التي يستخدمها WebdriverIO.
إذا كنت تريد أتمتة المتصفح باستخدام تقنية أتمتة مختلفة، تأكد من تعيين هذه الخاصية إلى مسار يحل إلى وحدة تلتزم بالواجهة التالية:
import type { Capabilities } from '@wdio/types';
import type { Client, AttachOptions } from 'webdriver';
export default class YourAutomationLibrary {
/**
* بدء جلسة أتمتة وإرجاع [أحادي](https://github.com/webdriverio/webdriverio/blob/940cd30939864bdbdacb2e94ee6e8ada9b1cc74c/packages/wdio-utils/src/monad.ts) WebdriverIO
* مع أوامر الأتمتة المعنية. انظر حزمة [webdriver](https://www.npmjs.com/package/webdriver)
* كتنفيذ مرجعي
*
* @param {Capabilities.RemoteConfig} options خيارات WebdriverIO
* @param {Function} hook يسمح بتعديل العميل قبل إطلاقه من الدالة
* @param {PropertyDescriptorMap} userPrototype يسمح للمستخدم بإضافة أوامر بروتوكول مخصصة
* @param {Function} customCommandWrapper يسمح بتعديل تنفيذ الأمر
* @returns مثيل عميل متوافق مع WebdriverIO
*/
static newSession(
options: Capabilities.RemoteConfig,
modifier?: (...args: any[]) => any,
userPrototype?: PropertyDescriptorMap,
customCommandWrapper?: (...args: any[]) => any
): Promise<Client>;
/**
* يسمح للمستخدم بالاتصال بالجلسات الموجودة
* @optional
*/
static attachToSession(
options?: AttachOptions,
modifier?: (...args: any[]) => any, userPrototype?: {},
commandWrapper?: (...args: any[]) => any
): Client;
/**
* يغير معرف جلسة النسخة وإمكانيات المتصفح للجلسة الجديدة
* مباشرة في كائن المتصفح الممرر
*
* @optional
* @param {object} instance الكائن الذي نحصل عليه من جلسة متصفح جديدة.
* @returns {string} معرف الجلسة الجديد للمتصفح
*/
static reloadSession(
instance: Client,
newCapabilities?: WebdriverIO.Capabilitie
): Promise<string>;
}
النوع: String
القيمة الافتراضية: webdriver
baseUrl
اختصر استدعاءات أمر url
عن طريق تعيين عنوان URL أساسي.
- إذا بدأت معلمة
url
بـ/
، فسيتم إضافةbaseUrl
في البداية (باستثناء مسارbaseUrl
، إن وجد). - إذا بدأت معلمة
url
بدون مخطط أو/
(مثلsome/path
)، فسيتم إضافةbaseUrl
الكامل في البداية مباشرة.
النوع: String
القيمة الافتراضية: null
waitforTimeout
المهلة الافتراضية لجميع أوامر waitFor*
. (لاحظ الحرف الصغير f
في اسم الخيار.) تؤثر هذه المهلة فقط على الأوامر التي تبدأ بـ waitFor*
ووقت الانتظار الافتراضي الخاص بها.
لزيادة المهلة لـ اختبار، يرجى الاطلاع على وثائق الإطار.
النوع: Number
القيمة الافتراضية: 5000
waitforInterval
الفاصل الزمني الافتراضي لجميع أوامر waitFor*
للتحقق مما إذا كانت الحالة المتوقعة (مثل الرؤية) قد تغيرت.
النوع: Number
القيمة الافتراضية: 100
region
إذا كنت تعمل على Sauce Labs، يمكنك اختيار تشغيل الاختبارات بين مراكز بيانات مختلفة: الولايات المتحدة أو الاتحاد الأوروبي.
لتغيير منطقتك إلى الاتحاد الأوروبي، أضف region: 'eu'
إلى التكوين الخاص بك.
ملاحظة: هذا يؤثر فقط إذا قدمت خيارات user
و key
المرتبطة بحساب Sauce Labs الخاص بك.
النوع: String
القيمة الافتراضية: us
(فقط للأجهزة الافتراضية و/أو المحاكيات)
خيارات منصة الاختبار
الخيارات التالية (بما في ذلك تلك المذكورة أعلاه) محددة فقط لتشغيل WebdriverIO مع منصة اختبار WDIO:
specs
تحديد المواصفات لتنفيذ الاختبار. يمكنك إما تحديد نمط عام لمطابقة ملفات متعددة في وقت واحد أو تغليف نمط عام أو مجموعة من المسارات في مصفوفة لتشغيلها ضمن عملية عامل واحدة. يتم اعتبار جميع المسارات نسبية من مسار ملف التكوين.
النوع: (String | String[])[]
القيمة الافتراضية: []
exclude
استبعاد المواصفات من تنفيذ الاختبار. يتم اعتبار جميع المسارات نسبية من مسار ملف التكوين.
النوع: String[]
القيمة الافتراضية: []
suites
كائن يصف مجموعات مختلفة، والتي يمكنك بعد ذلك تحديدها باستخدام خيار --suite
على واجهة سطر الأوامر wdio
.
النوع: Object
القيمة الافتراضية: {}
capabilities
نفس قسم capabilities
الموصوف أعلاه، باستثناء إمكانية تحديد إما كائن multiremote
، أو جلسات WebDriver متعددة في مصفوفة للتنفيذ المتوازي.
يمكنك تطبيق نفس القدرات الخاصة بالبائع والمتصفح كما هو محدد أعلاه.
النوع: Object
|Object[]
القيمة الافتراضية: [{ 'wdio:maxInstances': 5, browserName: 'firefox' }]
maxInstances
الحد الأقصى لعدد العمال المتوازية التي تعمل بشكل إجمالي.
ملاحظة: قد يكون هذا رقمًا يصل إلى 100
عندما يتم إجراء الاختبارات على بعض البائعين الخارجيين مثل آلات Sauce Labs. هناك، لا يتم اختبار الاختبارات على جهاز واحد، بل على العديد من الآلات الافتراضية. إذا كانت الاختبارات ستتم على جهاز تطوير محلي، فاستخدم رقمًا أكثر منطقية، مثل 3
أو 4
أو 5
. في الأساس، هذا هو عدد المتصفحات التي سيتم بدؤها بشكل متزامن وتشغيل اختباراتك في نفس الوقت، لذا فهو يعتمد على مقدار ذاكرة الوصول العشوائي (RAM) الموجودة على جهازك، وكم عدد التطبيقات الأخرى التي تعمل على جهازك.
يمكنك أيضًا تطبيق maxInstances
داخل كائنات القدرة الخاصة بك باستخدام قدرة wdio:maxInstances
. هذا سيحد من عدد الجلسات المتوازية لتلك القدرة المحددة.
النوع: Number
القيمة الافتراضية: 100
maxInstancesPerCapability
الحد الأقصى لعدد العمال المتوازية التي تعمل لكل قدرة.
النوع: Number
القيمة الافتراضية: 100
injectGlobals
يدخل متغيرات WebdriverIO العالمية (مثل browser
و $
و $$
) في البيئة العالمية.
إذا قمت بتعيينها إلى false
، يجب عليك الاستيراد من @wdio/globals
، على سبيل المثال:
import { browser, $, $$, expect } from '@wdio/globals'
ملاحظة: لا يتعامل WebdriverIO مع حقن المتغيرات العالمية الخاصة بإطار الاختبار.
النوع: Boolean
القيمة الافتراضية: true
bail
إذا كنت تريد إيقاف تشغيل الاختبار بعد عدد محدد من فشل الاختبارات، استخدم bail
.
(القيمة الافتراضية هي 0
، والتي تشغل جميع الاختبارات بغض النظر عن النتيجة.) ملاحظة: الاختبار في هذا السياق هو جميع الاختبارات داخل ملف مواصفات واحد (عند استخدام Mocha أو Jasmine) أو جميع الخطوات داخل ملف ميزة (عند استخدام Cucumber). إذا كنت تريد التحكم في سلوك الإنهاء داخل اختبارات ملف اختبار واحد، فألق نظرة على خيارات الإطار المتاحة.
النوع: Number
القيمة الافتراضية: 0
(لا تتوقف؛ قم بتشغيل جميع الاختبارات)
specFileRetries
عدد المرات لإعادة محاولة ملف المواصفات بالكامل عندما يفشل ككل.
النوع: Number
القيمة الافتراضية: 0
specFileRetriesDelay
التأخير بالثواني بين محاولات إعادة ملف المواصفات
النوع: Number
القيمة الافتراضية: 0
specFileRetriesDeferred
ما إذا كان يجب إعادة محاولة ملفات المواصفات المعاد تجربتها على الفور أو تأجيلها إلى نهاية قائمة الانتظار.
النوع: Boolean
القيمة الافتراضية: true
groupLogsByTestSpec
اختر عرض إخراج السجل.
إذا تم تعيينه على false
، سيتم طباعة السجلات من ملفات الاختبار المختلفة في الوقت الفعلي. يرجى ملاحظة أن هذا قد يؤدي إلى خلط مخرجات السجل من ملفات مختلفة عند التشغيل بالتوازي.
إذا تم تعيينه على true
، سيتم تجميع مخرجات السجل حسب المواصفات وطباعتها فقط عند اكتمال المواصفات.
بشكل افتراضي، يتم تعيينه على false
بحيث يتم طباعة السجلات في الوقت الفعلي.
النوع: Boolean
القيمة الافتراضية: false
services
الخدمات تتولى مهمة محددة لا تريد الاهتمام بها. إنها تعزز إعداد الاختبار الخاص بك بجهد ضئيل تقريبًا.
النوع: String[]|Object[]
القيمة الافتراضية: []
framework
يحدد إطار الاختبار الذي سيتم استخدامه بواسطة منصة اختبار WDIO.
النوع: String
القيمة الافتراضية: mocha
الخيارات: mocha
| jasmine
mochaOpts، jasmineOpts، وcucumberOpts
خيارات متعلقة بإطار عمل محدد. انظر وثائق محول الإطار حول الخيارات المتاحة. اقرأ المزيد حول هذا في الأطر.
النوع: Object
القيمة الافتراضية: { timeout: 10000 }
cucumberFeaturesWithLineNumbers
قائمة ميزات cucumber مع أرقام السطور (عند استخدام إطار عمل cucumber).
النوع: String[]
القيمة الافتراضية: []