Skip to content

Commit fae5fee

Browse files
mgolmgol
authored
Tests: Exclude tests based on compilation flags, not API presence
Introduces a new test API, `includesModule`. The method returns whether a particular module like "ajax" or "deprecated" is included in the current jQuery build; it handles the slim build as well. The util was created so that we don't treat presence of particular APIs to decide whether to run a test as then if we accidentally remove an API, the tests would still not fail. Fixes gh-5069 Closes gh-5046
1 parent 52f452b commit fae5fee

24 files changed

+157
-59
lines changed

‎build/tasks/build.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ module.exports = function( grunt ) {
1010
const fs = require( "fs" );
1111
const path = require( "path" );
1212
const rollup = require( "rollup" );
13+
const slimBuildFlags = require( "./lib/slim-build-flags" );
1314
const rollupFileOverrides = require( "./lib/rollup-plugin-file-overrides" );
1415
const Insight = require( "insight" );
1516
const pkg = require( "../../package.json" );
@@ -60,7 +61,6 @@ module.exports = function( grunt ) {
6061
const done = this.async();
6162

6263
try {
63-
const slimFlags = [ "-ajax", "-callbacks", "-deferred", "-effects", "-queue" ];
6464
const flags = this.flags;
6565
const optIn = flags[ "*" ];
6666
let name = grunt.option( "filename" );
@@ -79,7 +79,7 @@ module.exports = function( grunt ) {
7979

8080
if ( flags.slim ) {
8181
delete flags.slim;
82-
for ( const flag of slimFlags ) {
82+
for ( const flag of slimBuildFlags ) {
8383
flags[ flag ] = true;
8484
}
8585
}

‎build/tasks/lib/slim-build-flags.js

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
"use strict";
2+
3+
// NOTE: keep it in sync with test/data/testinit.js
4+
module.exports = [
5+
"-ajax",
6+
"-callbacks",
7+
"-deferred",
8+
"-effects",
9+
"-queue"
10+
];

‎test/.eslintrc.json

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"createDashboardXML": false,
2222
"createWithFriesXML": false,
2323
"createXMLFragment": false,
24+
"includesModule": false,
2425
"moduleTeardown": false,
2526
"url": false,
2627
"q": false,

‎test/data/testinit-jsdom.js

+6
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ function url( value ) {
4242
new Date().getTime() + "" + parseInt( Math.random() * 100000, 10 );
4343
}
4444

45+
// We only run basic tests in jsdom so we don't need to repeat the logic
46+
// from the regular testinit.js
47+
this.includesModule = function() {
48+
return true;
49+
};
50+
4551
// The file-loading part of testinit.js#loadTests is handled by
4652
// jsdom Karma config; here we just need to trigger relevant APIs.
4753
this.loadTests = function() {

‎test/data/testinit.js

+62-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,16 @@ var FILEPATH = "/test/data/testinit.js",
1717
supportjQuery = this.jQuery,
1818

1919
// see RFC 2606
20-
externalHost = "example.com";
20+
externalHost = "example.com",
21+
22+
// NOTE: keep it in sync with build/tasks/lib/slim-build-flags.js
23+
slimBuildFlags = [
24+
"-ajax",
25+
"-callbacks",
26+
"-deferred",
27+
"-effects",
28+
"-queue"
29+
];
2130

2231
this.hasPHP = true;
2332
this.isLocal = window.location.protocol === "file:";
@@ -309,6 +318,58 @@ QUnit.jQuerySelectors = true;
309318
QUnit.isIE = !!window.document.documentMode;
310319
QUnit.testUnlessIE = QUnit.isIE ? QUnit.skip : QUnit.test;
311320

321+
// Returns whether a particular module like "ajax" or "deprecated"
322+
// is included in the current jQuery build; it handles the slim build
323+
// as well. The util was created so that we don't treat presence of
324+
// particular APIs to decide whether to run a test as then if we
325+
// accidentally remove an API, the tests would still not fail.
326+
this.includesModule = function( moduleName ) {
327+
328+
var excludedModulesPart, excludedModules;
329+
330+
// A short-cut for the slim build, e.g. "4.0.0-pre slim"
331+
if ( jQuery.fn.jquery.indexOf( " slim" ) > -1 ) {
332+
333+
// The module is included if it does NOT exist on the list
334+
// of modules excluded in the slim build
335+
return slimBuildFlags.indexOf( "-" + moduleName ) === -1;
336+
}
337+
338+
// example version for `grunt custom:-deprecated`:
339+
// "4.0.0-pre -deprecated,-deprecated/ajax-event-alias,-deprecated/event"
340+
excludedModulesPart = jQuery.fn.jquery
341+
342+
// Take the flags out of the version string.
343+
// Example: "-deprecated,-deprecated/ajax-event-alias,-deprecated/event"
344+
.split( " " )[ 1 ];
345+
346+
if ( !excludedModulesPart ) {
347+
348+
// No build part => the full build where everything is included.
349+
return true;
350+
}
351+
352+
excludedModules = excludedModulesPart
353+
354+
// Turn to an array.
355+
// Example: [ "-deprecated", "-deprecated/ajax-event-alias", "-deprecated/event" ]
356+
.split( "," )
357+
358+
// Remove the leading "-".
359+
// Example: [ "deprecated", "deprecated/ajax-event-alias", "deprecated/event" ]
360+
.map( function( moduleName ) {
361+
return moduleName.slice( 1 );
362+
} )
363+
364+
// Filter out deep names - ones that contain a slash.
365+
// Example: [ "deprecated" ]
366+
.filter( function( moduleName ) {
367+
return moduleName.indexOf( "/" ) === -1;
368+
} );
369+
370+
return excludedModules.indexOf( moduleName ) === -1;
371+
};
372+
312373
this.loadTests = function() {
313374

314375
// QUnit.config is populated from QUnit.urlParams but only at the beginning

‎test/unit/ajax.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ QUnit.module( "ajax", {
1313
assert.ok( !isLocal, "Unit tests are not ran from file:// (especially in Chrome. If you must test from file:// with Chrome, run it with the --allow-file-access-from-files flag!)" );
1414
} );
1515

16-
if ( !jQuery.ajax || ( isLocal && !hasPHP ) ) {
16+
if ( !includesModule( "ajax" ) || ( isLocal && !hasPHP ) ) {
1717
return;
1818
}
1919

‎test/unit/animation.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
( function() {
22

33
// Can't test what ain't there
4-
if ( !jQuery.fx ) {
4+
if ( !includesModule( "effects" ) ) {
55
return;
66
}
77

‎test/unit/attributes.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -921,7 +921,7 @@ QUnit.test( "val()", function( assert ) {
921921
"Select-one with only option disabled (trac-12584)"
922922
);
923923

924-
if ( jQuery.fn.serialize ) {
924+
if ( includesModule( "serialize" ) ) {
925925
checks = jQuery( "<input type='checkbox' name='test' value='1'/><input type='checkbox' name='test' value='2'/><input type='checkbox' name='test' value=''/><input type='checkbox' name='test'/>" ).appendTo( "#form" );
926926

927927
assert.deepEqual( checks.serialize(), "", "Get unchecked values." );

‎test/unit/basic.js

+20-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
QUnit.module( "basic", { afterEach: moduleTeardown } );
22

3-
if ( jQuery.ajax ) {
3+
if ( includesModule( "ajax" ) ) {
44
QUnit.test( "ajax", function( assert ) {
55
assert.expect( 4 );
66

@@ -33,6 +33,7 @@ QUnit.test( "ajax", function( assert ) {
3333
} );
3434
}
3535

36+
if ( includesModule( "attributes" ) ) {
3637
QUnit.test( "attributes", function( assert ) {
3738
assert.expect( 6 );
3839

@@ -51,8 +52,9 @@ QUnit.test( "attributes", function( assert ) {
5152

5253
assert.strictEqual( input.val( "xyz" ).val(), "xyz", ".val getter/setter" );
5354
} );
55+
}
5456

55-
if ( jQuery.css ) {
57+
if ( includesModule( "css" ) ) {
5658
QUnit.test( "css", function( assert ) {
5759
assert.expect( 1 );
5860

@@ -62,7 +64,7 @@ QUnit.test( "css", function( assert ) {
6264
} );
6365
}
6466

65-
if ( jQuery.fn.show && jQuery.fn.hide ) {
67+
if ( includesModule( "css" ) ) {
6668
QUnit.test( "show/hide", function( assert ) {
6769
assert.expect( 2 );
6870

@@ -123,6 +125,7 @@ QUnit.test( "core", function( assert ) {
123125
2, "jQuery.parseHTML" );
124126
} );
125127

128+
if ( includesModule( "data" ) ) {
126129
QUnit.test( "data", function( assert ) {
127130
assert.expect( 4 );
128131

@@ -133,7 +136,9 @@ QUnit.test( "data", function( assert ) {
133136
assert.strictEqual( elem.data( "c" ), "d", ".data from data-* attributes" );
134137
assert.ok( jQuery.hasData( elem[ 0 ] ), "jQuery.hasData - true" );
135138
} );
139+
}
136140

141+
if ( includesModule( "dimensions" ) ) {
137142
QUnit.test( "dimensions", function( assert ) {
138143
assert.expect( 3 );
139144

@@ -145,7 +150,9 @@ QUnit.test( "dimensions", function( assert ) {
145150
assert.strictEqual( elem.innerWidth(), 64, ".innerWidth getter" );
146151
assert.strictEqual( elem.outerWidth(), 68, ".outerWidth getter" );
147152
} );
153+
}
148154

155+
if ( includesModule( "event" ) ) {
149156
QUnit.test( "event", function( assert ) {
150157
assert.expect( 1 );
151158

@@ -162,7 +169,9 @@ QUnit.test( "event", function( assert ) {
162169
} )
163170
.trigger( "click" );
164171
} );
172+
}
165173

174+
if ( includesModule( "manipulation" ) ) {
166175
QUnit.test( "manipulation", function( assert ) {
167176
assert.expect( 5 );
168177

@@ -195,6 +204,9 @@ QUnit.test( "manipulation", function( assert ) {
195204
".after/.before"
196205
);
197206
} );
207+
}
208+
209+
if ( includesModule( "offset" ) ) {
198210

199211
// Support: jsdom 13.2+
200212
// jsdom returns 0 for offset-related properties
@@ -208,6 +220,7 @@ QUnit[ /jsdom\//.test( navigator.userAgent ) ? "skip" : "test" ]( "offset", func
208220
assert.strictEqual( elem.position().top, 5, ".position getter" );
209221
assert.strictEqual( elem.offsetParent()[ 0 ], parent[ 0 ], ".offsetParent" );
210222
} );
223+
}
211224

212225
QUnit.test( "selector", function( assert ) {
213226
assert.expect( 2 );
@@ -219,6 +232,7 @@ QUnit.test( "selector", function( assert ) {
219232
assert.strictEqual( elem.find( "span.b a" )[ 0 ].nodeName, "A", ".find - one result" );
220233
} );
221234

235+
if ( includesModule( "serialize" ) ) {
222236
QUnit.test( "serialize", function( assert ) {
223237
assert.expect( 2 );
224238

@@ -232,6 +246,7 @@ QUnit.test( "serialize", function( assert ) {
232246
"&select1=&select2=3&select3=1&select3=2&select5=3",
233247
"form serialization as query string" );
234248
} );
249+
}
235250

236251
QUnit.test( "traversing", function( assert ) {
237252
assert.expect( 12 );
@@ -253,6 +268,7 @@ QUnit.test( "traversing", function( assert ) {
253268
assert.strictEqual( elem.contents()[ 3 ].nodeType, 3, ".contents" );
254269
} );
255270

271+
if ( includesModule( "wrap" ) ) {
256272
QUnit.test( "wrap", function( assert ) {
257273
assert.expect( 3 );
258274

@@ -283,3 +299,4 @@ QUnit.test( "wrap", function( assert ) {
283299
);
284300

285301
} );
302+
}

‎test/unit/callbacks.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ QUnit.module( "callbacks", {
44

55
( function() {
66

7-
if ( !jQuery.Callbacks ) {
7+
if ( !includesModule( "callbacks" ) ) {
88
return;
99
}
1010

‎test/unit/core.js

+11-11
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,23 @@ QUnit.test( "jQuery()", function( assert ) {
3636

3737
// The $(html, props) signature can stealth-call any $.fn method, check for a
3838
// few here but beware of modular builds where these methods may be excluded.
39-
if ( jQuery.fn.click ) {
39+
if ( includesModule( "deprecated" ) ) {
4040
expected++;
4141
attrObj[ "click" ] = function() { assert.ok( exec, "Click executed." ); };
4242
}
43-
if ( jQuery.fn.width ) {
43+
if ( includesModule( "dimensions" ) ) {
4444
expected++;
4545
attrObj[ "width" ] = 10;
4646
}
47-
if ( jQuery.fn.offset ) {
47+
if ( includesModule( "offset" ) ) {
4848
expected++;
4949
attrObj[ "offset" ] = { "top": 1, "left": 1 };
5050
}
51-
if ( jQuery.fn.css ) {
51+
if ( includesModule( "css" ) ) {
5252
expected += 2;
5353
attrObj[ "css" ] = { "paddingLeft": 1, "paddingRight": 1 };
5454
}
55-
if ( jQuery.fn.attr ) {
55+
if ( includesModule( "attributes" ) ) {
5656
expected++;
5757
attrObj.attr = { "desired": "very" };
5858
}
@@ -115,20 +115,20 @@ QUnit.test( "jQuery()", function( assert ) {
115115

116116
elem = jQuery( "<div></div>", attrObj );
117117

118-
if ( jQuery.fn.width ) {
118+
if ( includesModule( "dimensions" ) ) {
119119
assert.equal( elem[ 0 ].style.width, "10px", "jQuery() quick setter width" );
120120
}
121121

122-
if ( jQuery.fn.offset ) {
122+
if ( includesModule( "offset" ) ) {
123123
assert.equal( elem[ 0 ].style.top, "1px", "jQuery() quick setter offset" );
124124
}
125125

126-
if ( jQuery.fn.css ) {
126+
if ( includesModule( "css" ) ) {
127127
assert.equal( elem[ 0 ].style.paddingLeft, "1px", "jQuery quick setter css" );
128128
assert.equal( elem[ 0 ].style.paddingRight, "1px", "jQuery quick setter css" );
129129
}
130130

131-
if ( jQuery.fn.attr ) {
131+
if ( includesModule( "attributes" ) ) {
132132
assert.equal( elem[ 0 ].getAttribute( "desired" ), "very", "jQuery quick setter attr" );
133133
}
134134

@@ -1522,7 +1522,7 @@ testIframe(
15221522
}
15231523
);
15241524

1525-
QUnit[ jQuery.Deferred ? "test" : "skip" ]( "jQuery.readyException (original)", function( assert ) {
1525+
QUnit[ includesModule( "deferred" ) ? "test" : "skip" ]( "jQuery.readyException (original)", function( assert ) {
15261526
assert.expect( 1 );
15271527

15281528
var message;
@@ -1545,7 +1545,7 @@ QUnit[ jQuery.Deferred ? "test" : "skip" ]( "jQuery.readyException (original)",
15451545
);
15461546
} );
15471547

1548-
QUnit[ jQuery.Deferred ? "test" : "skip" ]( "jQuery.readyException (custom)", function( assert ) {
1548+
QUnit[ includesModule( "deferred" ) ? "test" : "skip" ]( "jQuery.readyException (custom)", function( assert ) {
15491549
assert.expect( 1 );
15501550

15511551
var done = assert.async();

0 commit comments

Comments
 (0)