mediawiki-extensions-Visual.../modules/ve-mw/tests/ui/actions/ve.ui.FormatAction.test.js
Timo Tijhof 6cbedbf9d2 tests: Adopt QUnit.test.each() and native async-await in a few places
* Remove need for manual hacking of sub groups via "msg" strings
  carefully prepended to every assertion.

* Improve CI details, by reporting the specific case that failed,
  and local dev via ability to re-run each case, and reporting names
  directly in the HTML Reporter and CLI summary.

* Reduce need for assert.async() and tracking of callbacks, especially
  to improve failure details in case of Promise rejection.
  Current logic was likely to cause a confusing timeout instead of a
  clear failure if the promise ends up rejected.

  QUnit propagates these as part of awaiting and asserting the test
  closure's promise value (as async fn) automatically.

  This approach also avoids the pitfal of a falsely passing test
  when an assertion inside a done() handler was never reached.

* Use modern for-of where possible to remove need for closures and
  arrow functions. Thus reducing complexity of test code, where
  complexity should be kept lowest to avoid false confidence.

* Use plain for-in instead of overly complex Object.keys().forEach().

Change-Id: I934a266e75e64371081f104cfb867fb2c282c84a
2024-05-01 19:01:19 +01:00

80 lines
3 KiB
JavaScript

/*!
* VisualEditor UserInterface Actions FormatAction tests.
*
* @copyright See AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
QUnit.module( 've.ui.FormatAction (MW)', ve.test.utils.newMwEnvironment() );
QUnit.test.each( 'convert (MW-specific types)',
[
{
rangeOrSelection: new ve.Range( 14, 16 ),
type: 'mwHeading',
attributes: { level: 2 },
expectedRangeOrSelection: new ve.Range( 14, 16 ),
expectedData: ( data ) => {
data.splice( 11, 2, { type: '/list' }, { type: 'mwHeading', attributes: { level: 2 } } );
data.splice( 19, 2, { type: '/mwHeading' }, { type: 'list', attributes: { style: 'bullet' } } );
},
undo: true,
msg: 'converting partial selection of list item "Item 2" to level 2 mwHeading'
},
{
rangeOrSelection: new ve.Range( 15, 50 ),
type: 'mwHeading',
attributes: { level: 3 },
expectedRangeOrSelection: new ve.Range( 15, 44 ),
expectedData: ( data ) => {
data.splice( 11, 2, { type: '/list' }, { type: 'mwHeading', attributes: { level: 3 } } );
data.splice( 19, 4, { type: '/mwHeading' }, { type: 'mwHeading', attributes: { level: 3 } } );
data.splice( 27, 4, { type: '/mwHeading' }, { type: 'mwHeading', attributes: { level: 3 } } );
data.splice( 38, 4, { type: '/mwHeading' }, { type: 'mwHeading', attributes: { level: 3 } } );
data.splice( 46, 2, { type: '/mwHeading' }, { type: 'list', attributes: { style: 'bullet' } } );
},
undo: true,
msg: 'converting partial selection across two lists surrounding a paragraph'
},
{
rangeOrSelection: new ve.Range( 4, 28 ),
type: 'mwHeading',
attributes: { level: 1 },
expectedRangeOrSelection: new ve.Range( 2, 22 ),
expectedData: ( data ) => {
data.splice( 0, 3, { type: 'mwHeading', attributes: { level: 1 } } );
data.splice( 7, 4, { type: '/mwHeading' }, { type: 'mwHeading', attributes: { level: 1 } } );
data.splice( 15, 4, { type: '/mwHeading' }, { type: 'mwHeading', attributes: { level: 1 } } );
data.splice( 23, 3, { type: '/mwHeading' } );
},
undo: true,
msg: 'converting partial selection of all list items to level 1 MWheadings'
},
{
rangeOrSelection: new ve.Range( 5, 26 ),
type: 'mwPreformatted',
attributes: undefined,
expectedRangeOrSelection: new ve.Range( 3, 20 ),
expectedData: ( data ) => {
data.splice( 0, 3, { type: 'mwPreformatted' } );
data.splice( 7, 4, { type: '/mwPreformatted' }, { type: 'mwPreformatted' } );
data.splice( 15, 4, { type: '/mwPreformatted' }, { type: 'mwPreformatted' } );
data.splice( 23, 3, { type: '/mwPreformatted' } );
},
undo: true,
msg: 'converting partial selection of some list items to mwPreformatted text'
}
],
( assert, caseItem ) => {
ve.test.utils.runActionTest(
'format', assert, caseItem.html || ve.dm.example.isolationHtml, false, 'convert',
[ caseItem.type, caseItem.attributes ], caseItem.rangeOrSelection, caseItem.msg,
{
expectedData: caseItem.expectedData,
expectedRangeOrSelection: caseItem.expectedRangeOrSelection,
undo: caseItem.undo
}
);
}
);