T/16938 Extract common PFW tests loop. #333
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| /* global createTestCase */ | ||
| /* exported createTestSuite */ | ||
|
|
||
| // Creates a test suite based on the options provided. The test suite then should be passed to `bender.test` to run tests. | ||
|
There was a problem hiding this comment. Why not standard JSDoc comments, similar to our existing tests? Comments from tests don't leak into documentation, so it's safe to use JSDoc in a normal way. |
||
| // | ||
| // @param {Object} options | ||
| // @param {Array} options.browsers Array of browser names. | ||
| // @param {Array} options.wordVersions Array of word version names. | ||
| // @param {Object} options.tests Object containing tests to be generated. It contains key - value pairs, where key is name of the test file and value | ||
| // is an array of wordVersions name for which tests should be generated or a boolean indicating: true - generate for all versions, false - for none. | ||
| // @param {Object} [options.ticketTests] Object containing tests to be generated. It has same structure as `options.tests`. | ||
| // @param {Array} [options.testData] Test data object (may contain e.g. information about ignored tests). All created tests will be added into testData object. | ||
| // @param {Array} [options.customFilters] Array of custom filters (like [ pfwTools.filters.font ]) which will be used during assertions. | ||
| // @param {Boolean} [options.compareRawData=false] If `true` test case will assert against raw paste's `data.dataValue` rather than | ||
| // what will appear in the editor after all transformations and filtering. | ||
| // @param {Boolean} [options.ignoreAll=false] Whenever to ignore all tests. | ||
| // @returns {Object} Test data object which should be passed to `bender.test` function. | ||
| function createTestSuite( options ) { | ||
|
|
||
| var browsers = options.browsers || [], | ||
| wordVersions = options.wordVersions || [], | ||
| tests = options.tests || [], | ||
| ticketTests = options.ticketTests || [], | ||
| testData = options.testData || { _should: { ignore: {} } }, | ||
| ignoreAll = options.ignoreAll === true, | ||
| compareRawData = options.compareRawData === true, | ||
| customFilters = options.customFilters ? options.customFilters : null; | ||
|
There was a problem hiding this comment. IMO it can be much simplified by using |
||
|
|
||
| _prepareTests( testData, tests, browsers, wordVersions, compareRawData, customFilters, false, ignoreAll ); | ||
|
There was a problem hiding this comment. And if we're going with simplified handling of |
||
|
|
||
| _prepareTests( testData, ticketTests, browsers, wordVersions, compareRawData, customFilters, true, ignoreAll ); | ||
|
There was a problem hiding this comment. If I'm seeing correctly, the only place that uses the information if the tests are ticket ones or not is inside I'm not seeing any sense in a special treatment of |
||
|
|
||
| return testData; | ||
| } | ||
|
|
||
| // Iterates over given tests, browsers and wordVersions creating tests based on all possible combinations. | ||
| // | ||
| // @private | ||
| // @param {Object} testData | ||
| // @param {Array} tests | ||
| // @param {Array} browsers | ||
| // @param {Array} wordVersions | ||
| // @param {Boolean} compareRawData | ||
| // @param {Array} customFilters | ||
| // @param {Boolean} areTicketsTests Whenever tests should be generated using `tickets/` directory. | ||
| // @param {Boolean} ignoreAll | ||
| function _prepareTests( testData, tests, browsers, wordVersions, compareRawData, customFilters, areTicketsTests, ignoreAll ) { | ||
| var testsKeys = CKEDITOR.tools.objectKeys( tests ), | ||
| wordVersion, testKey, testName, i, k, j; | ||
|
|
||
| if ( testsKeys.length ) { | ||
| for ( i = 0; i < testsKeys.length; i++ ) { | ||
| for ( k = 0; k < browsers.length; k++ ) { | ||
| for ( j = 0; j < wordVersions.length; j++ ) { | ||
|
There was a problem hiding this comment. Shouldn't it be before |
||
|
|
||
| wordVersion = wordVersions[ j ]; | ||
| testKey = testsKeys[ i ]; | ||
|
|
||
| if ( tests[ testKey ] === true || CKEDITOR.tools.indexOf( tests[ testKey ], wordVersion ) !== -1 ) { | ||
|
|
||
| testName = [ 'test', testKey, wordVersion, browsers[ k ] ].join( ' ' ); | ||
|
|
||
| if ( ignoreAll ) { | ||
| testData._should.ignore[ testName ] = true; | ||
| } | ||
|
|
||
| testData[ testName ] = createTestCase( testKey, wordVersion, browsers[ k ], areTicketsTests, compareRawData, customFilters ); | ||
|
There was a problem hiding this comment. I'm a big fan of |
||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we're adding docs in other places, then we can also add missing docs for
createTestCaseas only one parameter is described.