Odoo18-Base/addons/web/static/tests/legacy/helpers/test_utils_fields.js
2025-03-10 10:52:11 +07:00

89 lines
2.6 KiB
JavaScript

/** @odoo-module **/
/**
* Field Test Utils
*
* This module defines various utility functions to help testing field widgets.
*
* Note that all methods defined in this module are exported in the main
* testUtils file.
*/
import testUtilsDom from "@web/../tests/legacy/helpers/test_utils_dom";
//-------------------------------------------------------------------------
// Public functions
//-------------------------------------------------------------------------
/**
* Sets the value of an element and then, trigger all specified events.
* Note that this helper also checks the unicity of the target.
*
* Example:
* testUtils.fields.editAndTrigger($('selector'), 'test', ['input', 'change']);
*
* @param {jQuery|EventTarget} el should target an input, textarea or select
* @param {string|number} value
* @param {string[]} events
* @returns {Promise}
*/
export async function editAndTrigger(el, value, events) {
if (el instanceof jQuery) {
if (el.length !== 1) {
throw new Error(`target ${el.selector} has length ${el.length} instead of 1`);
}
el.val(value);
} else {
el.value = value;
}
return testUtilsDom.triggerEvents(el, events);
}
/**
* Sets the value of an input.
*
* Note that this helper also checks the unicity of the target.
*
* Example:
* testUtils.fields.editInput($('selector'), 'somevalue');
*
* @param {jQuery|EventTarget} el should target an input, textarea or select
* @param {string|number} value
* @returns {Promise}
*/
export async function editInput(el, value) {
return editAndTrigger(el, value, ['input']);
}
/**
* Helper to trigger a key event on an element.
*
* @param {string} type type of key event ('press', 'up' or 'down')
* @param {jQuery} $el
* @param {string} key
* @returns {Promise}
*/
function triggerKey(type, $el, key) {
type = 'key' + type;
const params = {};
params.key = key;
return testUtilsDom.triggerEvent($el, type, params);
}
/**
* Helper to trigger a keydown event on an element.
*
* @param {jQuery} $el
* @param {number|string} key @see triggerKey
* @returns {Promise}
*/
function triggerKeydown($el, key) {
return triggerKey('down', $el, key);
}
export default {
editAndTrigger,
editInput,
triggerKeydown,
};