Tests: The utilities to help skip tests on unsupported devices were added (#29826)

Signed-off-by: pharret31 <[email protected]>

Author: pharret31

packages/devextreme/testing/helpers/chat.js

@@ -0,0 +1,34 @@
+import devices from '__internal/core/m_devices';
+
+export const shouldSkipOnDevices = ({
+    deviceTypes = [],
+    assert = null,
+    message = null
+} = {}) => {
+    if(!Array.isArray(deviceTypes)) {
+        throw new Error('deviceTypes should be an array');
+    }
+    if(deviceTypes.includes(devices.real().deviceType)) {
+        assert && assert.ok(true, message || `Test skipped on devices:  ${deviceTypes.toString()}`);
+        return true;
+    }
+    return false;
+};
+
+export const shouldSkipOnDesktop = (assert = null, message = null) => shouldSkipOnDevices({
+    deviceTypes: ['desktop'],
+    assert,
+    message,
+});
+
+export const shouldSkipOnPhone = (assert = null, message = null) => shouldSkipOnDevices({
+    deviceTypes: ['phone'],
+    assert,
+    message,
+});
+
+export const shouldSkipOnMobile = (assert = null, message = null) => shouldSkipOnDevices({
+    deviceTypes: ['phone', 'tablet'],
+    assert,
+    message,
+});

packages/devextreme/testing/helpers/device.js

@@ -406,7 +406,7 @@ export class FileManagerWrapper {
     }
 
     getDetailsCellValue(rowIndex, columnIndex) {
-        columnIndex += isDesktopDevice() ? 1 : 0;
+        columnIndex += devices.real().deviceType === 'desktop' ? 1 : 0;
         return this.getRowInDetailsView(rowIndex)
             .find(`td:nth-child(${columnIndex})`)
             .text()
@@ -973,10 +973,6 @@ export const stubFileReader = object => {
     }
 };
 
-export const isDesktopDevice = () => {
-    return devices.real().deviceType === 'desktop';
-};
-
 export const getDropFileEvent = file => $.Event($.Event('drop', { dataTransfer: { files: [file] } }));
 
 export const createEditingEvents = () => {

packages/devextreme/testing/helpers/fileManagerHelpers.js

@@ -6,6 +6,7 @@ import fixtures from '../../helpers/positionFixtures.js';
 import devices from 'core/devices.js';
 import { implementationsMap } from 'core/utils/size';
 import { getWindow } from 'core/utils/window.js';
+import { shouldSkipOnDevices, shouldSkipOnPhone } from '../../helpers/device.js';
 
 const setupPosition = positionUtils.setup;
 const calculatePosition = positionUtils.calculate;
@@ -964,8 +965,11 @@ const testCollision = (name, fixtureName, params, expectedHorzDist, expectedVert
     });
 
     QUnit.test('position should return window.height() if window.outerHeight == window.innerHeight (T939748)', function(assert) {
-        const isPhone = devices.real().deviceType === 'phone';
-        if(isPhone || browser.safari) {
+        if(shouldSkipOnPhone(assert)) {
+            return;
+        }
+
+        if(browser.safari) {
             assert.ok(true, 'actual only for desktop browsers except Safari');
             return;
         }
@@ -993,8 +997,11 @@ const testCollision = (name, fixtureName, params, expectedHorzDist, expectedVert
     });
 
     QUnit.test('position should return window.width() if window.outerWidth == window.innerWidth (T939748)', function(assert) {
-        const isPhone = devices.real().deviceType === 'phone';
-        if(isPhone || browser.safari) {
+        if(shouldSkipOnPhone(assert)) {
+            return;
+        }
+
+        if(browser.safari) {
             assert.ok(true, 'actual only for desktop browsers except Safari');
             return;
         }
@@ -1022,8 +1029,7 @@ const testCollision = (name, fixtureName, params, expectedHorzDist, expectedVert
     });
 
     QUnit.test('position should be correct relative to the viewport on mobile devices', function(assert) {
-        if(devices.real().deviceType !== 'phone') {
-            assert.ok(true, 'only for mobile devices');
+        if(shouldSkipOnDevices({ deviceTypes: ['desktop', 'tablet'], assert })) {
             return;
         }
 
@@ -1050,8 +1056,7 @@ const testCollision = (name, fixtureName, params, expectedHorzDist, expectedVert
     });
 
     QUnit.test('position should be correct relative to the viewport on mobile devices when window is scrolled', function(assert) {
-        if(devices.real().deviceType !== 'phone') {
-            assert.ok(true, 'only for mobile devices');
+        if(shouldSkipOnDevices({ deviceTypes: ['desktop', 'tablet'], assert })) {
             return;
         }
 
@@ -1078,9 +1083,12 @@ const testCollision = (name, fixtureName, params, expectedHorzDist, expectedVert
     });
 
     QUnit.test('position should be correct relative to the viewport on mobile devices when window is scrolled and window.scrollTop is bigger than visualViewport.offsetTop (T750017)', function(assert) {
-        const isPhone = devices.real().deviceType === 'phone';
+        if(shouldSkipOnDevices({ deviceTypes: ['desktop', 'tablet'], assert })) {
+            return;
+        }
+
         const isAndroid = devices.real().platform === 'android';
-        if(!isPhone || isAndroid) {
+        if(isAndroid) {
             // NOTE: scrollTop/Left are always 0 on android devices
             assert.ok(true, 'only for non-android mobiles');
             return;

packages/devextreme/testing/tests/DevExpress.animation/position.tests.js

@@ -30,9 +30,9 @@ import { RowsView } from '__internal/grids/data_grid/module_not_extended/rows';
 import { GroupingHeaderPanelExtender } from '__internal/grids/data_grid/grouping/m_grouping';
 import { HeaderPanel } from '__internal/grids/data_grid/module_not_extended/header_panel';
 import Action from '__internal/core/m_action';
-import devices from '__internal/core/m_devices';
 import { getHeight } from 'core/utils/size';
 import publicComponentUtils from 'core/utils/public_component';
+import { shouldSkipOnMobile } from '../../helpers/device.js';
 
 class TestDraggingHeader2 extends columnsResizingReordering.DraggingHeaderView {
     callDragCounter = 0;
@@ -2503,8 +2503,7 @@ QUnit.module('Columns resizing', {
     });
 
     QUnit.test('The free space row is not displayed when horizontal scrollbar is shown_B253714', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'height of scrollbar equal zero on mobile device');
+        if(shouldSkipOnMobile(assert, 'height of scrollbar equals zero on mobile devices')) {
             return;
         }
 

packages/devextreme/testing/tests/DevExpress.ui.widgets.dataGrid/columnsResizingReorderingModule.tests.js

@@ -22,6 +22,7 @@ import { checkDxFontIcon, DX_ICON_XLSX_FILE_CONTENT_CODE, DX_ICON_EXPORT_SELECTE
 import { createDataGrid, baseModuleConfig, findShadowHostOrDocument } from '../../helpers/dataGridHelper.js';
 import { getOuterWidth } from 'core/utils/size';
 import { generateItems } from '../../helpers/dataGridMocks.js';
+import { shouldSkipOnMobile } from '../../helpers/device.js';
 
 const DX_STATE_HOVER_CLASS = 'dx-state-hover';
 const CELL_UPDATED_CLASS = 'dx-datagrid-cell-updated-animation';
@@ -530,8 +531,7 @@ QUnit.module('Initialization', baseModuleConfig, () => {
     });
 
     QUnit.test('Enable rows hover', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'hover is disabled for not desktop devices');
+        if(shouldSkipOnMobile(assert, 'hover is disabled for non desktop devices')) {
             return;
         }
 
@@ -556,8 +556,7 @@ QUnit.module('Initialization', baseModuleConfig, () => {
     });
 
     QUnit.test('Enable rows hover and row position', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'hover is disabled for not desktop devices');
+        if(shouldSkipOnMobile(assert, 'hover is disabled for non desktop devices')) {
             return;
         }
 
@@ -613,8 +612,7 @@ QUnit.module('Initialization', baseModuleConfig, () => {
     });
 
     QUnit.test('Enable rows hover via option method', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'hover is disabled for not desktop devices');
+        if(shouldSkipOnMobile(assert, 'hover is disabled for non desktop devices')) {
             return;
         }
 

packages/devextreme/testing/tests/DevExpress.ui.widgets.dataGrid/dataGrid.tests.js

@@ -19,6 +19,7 @@ import { generateItems } from '../../helpers/dataGridMocks.js';
 import { getOuterHeight } from 'core/utils/size';
 import { getEmulatorStyles } from '../../helpers/stylesHelper.js';
 import messageLocalization from 'common/core/localization/message';
+import { shouldSkipOnDesktop, shouldSkipOnMobile } from '../../helpers/device.js';
 
 const TEXTEDITOR_INPUT_SELECTOR = '.dx-texteditor-input';
 
@@ -3321,10 +3322,10 @@ QUnit.module('Editing', baseModuleConfig, () => {
 
     ['Batch', 'Cell'].forEach((editMode) => {
         QUnit.testInActiveWindow(`${editMode} - Cell value should not be reset when a checkbox in a neigboring cell is clicked (T1023809)`, function(assert) {
-            if(devices.real().deviceType === 'desktop') {
-                assert.ok(true, 'test only for mobile devices');
+            if(shouldSkipOnDesktop(assert)) {
                 return;
             }
+
             const data = [
                 { id: 1, field1: 'test', field2: true }
             ];
@@ -5268,8 +5269,7 @@ QUnit.module('API methods', baseModuleConfig, () => {
 
     // T553067
     QUnit.testInActiveWindow('Enter key on editor should prevent default behaviour', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'keyboard navigation is disabled for not desktop devices');
+        if(shouldSkipOnMobile(assert, 'keyboard navigation is disabled for non-desktop devices')) {
             return;
         }
 
@@ -5338,8 +5338,7 @@ QUnit.module('API methods', baseModuleConfig, () => {
     });
 
     QUnit.testInActiveWindow('Datebox editor\'s enter key handler should be replaced by noop (T819067)', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'keyboard navigation is disabled for not desktop devices');
+        if(shouldSkipOnMobile(assert, 'keyboard navigation is disabled for non-desktop devices')) {
             return;
         }
 
@@ -5369,8 +5368,7 @@ QUnit.module('API methods', baseModuleConfig, () => {
     });
 
     QUnit.testInActiveWindow('Datebox changed value should be saved on enter key if useMaskBehaviour is true (T1070850)', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'keyboard navigation is disabled for not desktop devices');
+        if(shouldSkipOnMobile(assert, 'keyboard navigation is disabled for non-desktop devices')) {
             return;
         }
 
@@ -5423,8 +5421,7 @@ QUnit.module('API methods', baseModuleConfig, () => {
     ['date', 'datetime'].forEach(dataType => {
         [true, false].forEach(useMaskBehavior => {
             QUnit.testInActiveWindow(`Datebox editor's value should be selected from calendar by keyboard (useMaskBehavior = ${useMaskBehavior}, dataType = ${dataType})`, function(assert) {
-                if(devices.real().deviceType !== 'desktop') {
-                    assert.ok(true, 'keyboard navigation is disabled for not desktop devices');
+                if(shouldSkipOnMobile(assert, 'keyboard navigation is disabled for non-desktop devices')) {
                     return;
                 }
 
@@ -5598,8 +5595,7 @@ QUnit.module('API methods', baseModuleConfig, () => {
     });
 
     QUnit.testInActiveWindow('Scroll positioned correct with fixed columns and editing', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'keyboard navigation is not actual for not desktop devices');
+        if(shouldSkipOnMobile(assert, 'keyboard navigation is disabled for non-desktop devices')) {
             return;
         }
 

packages/devextreme/testing/tests/DevExpress.ui.widgets.dataGrid/editing.integration.tests.js

@@ -30,6 +30,7 @@ import pointerMock from '../../helpers/pointerMock.js';
 import DataGridWrapper from '../../helpers/wrappers/dataGridWrappers.js';
 import { findShadowHostOrDocument } from '../../helpers/dataGridHelper.js';
 import { DataSource } from 'common/data/data_source/data_source';
+import { shouldSkipOnMobile, shouldSkipOnDesktop } from '../../helpers/device.js';
 
 QUnit.testStart(function() {
     const markup =
@@ -1107,8 +1108,7 @@ QUnit.module('Editing', {
 
     // T124946
     QUnit.test('Api method editCell with button', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'The problem is fixed for desktop only');
+        if(shouldSkipOnMobile(assert, 'The problem is fixed for desktop only')) {
             return;
         }
 
@@ -1688,10 +1688,10 @@ QUnit.module('Editing', {
 
     // T749034
     QUnit.test('Changed value should be saved on click outside dataGrid on mobile devices when cell editing mode', function(assert) {
-        if(devices.real().deviceType === 'desktop') {
-            assert.ok(true, 'test is not actual for desktop');
+        if(shouldSkipOnDesktop(assert)) {
             return;
         }
+
         // arrange
         const that = this;
         const rowsView = this.rowsView;
@@ -1767,8 +1767,7 @@ QUnit.module('Editing', {
 
     // T727856
     QUnit.test('Not close Editing Cell in batch mode on down in editing cell and up in another cell', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'focus is not actual for mobile devices');
+        if(shouldSkipOnMobile(assert, 'focus is not actual for mobile devices')) {
             return;
         }
         // arrange
@@ -7542,8 +7541,7 @@ QUnit.module('Editing with real dataController', {
 
     // T319885
     QUnit.testInActiveWindow('Focused lookup column with showEditorAlways is enabled', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'focus is not actual for mobile devices');
+        if(shouldSkipOnMobile(assert, 'focus is not actual for mobile devices')) {
             return;
         }
 
@@ -13304,8 +13302,7 @@ QUnit.module('Editing with validation', {
 
     // T497279
     QUnit.testInActiveWindow('Insert row using extern button when edit mode cell', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'focus is not actual for mobile devices');
+        if(shouldSkipOnMobile(assert, 'focus is not actual for mobile devices')) {
             return;
         }
         // arrange

packages/devextreme/testing/tests/DevExpress.ui.widgets.dataGrid/editing.tests.js

@@ -47,6 +47,7 @@ import { MockColumnsController, MockDataController, setupDataGridModules } from
 import config from 'core/config';
 import typeUtils from 'core/utils/type';
 import { noop } from 'core/utils/common';
+import { shouldSkipOnMobile } from '../../helpers/device.js';
 
 const TEXTEDITOR_INPUT_SELECTOR = '.dx-texteditor-input';
 
@@ -1511,8 +1512,7 @@ QUnit.module('Focus', {
 
     // T454719
     QUnit.testInActiveWindow('Focus on dxLookup editor', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'if device is not desktop we do not test the case');
+        if(shouldSkipOnMobile(assert)) {
             return;
         }
 
@@ -1559,8 +1559,7 @@ QUnit.module('Focus', {
 
     // T531176
     QUnit.testInActiveWindow('Focus on dxTextArea editor', function(assert) {
-        if(devices.real().deviceType !== 'desktop') {
-            assert.ok(true, 'if device is not desktop we do not test the case');
+        if(shouldSkipOnMobile(assert)) {
             return;
         }