Skip to content

Commit bc16512

Browse files
mgolmgol
authored
Tests: Exclude tests based on compilation flags, not API presence (3.x version)
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. Closes gh-5071 Fixes gh-5069 Ref gh-5046 (partially cherry picked from commit fae5fee)
1 parent 0f6c3d9 commit bc16512

24 files changed

+162
-75
lines changed

‎build/tasks/build.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
module.exports = function( grunt ) {
1010
var fs = require( "fs" ),
1111
requirejs = require( "requirejs" ),
12+
slimBuildFlags = require( "./lib/slim-build-flags" ),
1213
Insight = require( "insight" ),
1314
pkg = require( "../../package.json" ),
1415
srcFolder = __dirname + "/../../src/",
@@ -348,7 +349,7 @@ module.exports = function( grunt ) {
348349
// the official slim build
349350
.reduce( ( acc, elem ) => acc.concat(
350351
elem === "slim" ?
351-
[ "-ajax", "-effects" ] :
352+
slimBuildFlags :
352353
[ elem ]
353354
), [] )
354355

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

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

‎test/.eslintrc.json

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
"testIframe": false,
2020
"createDashboardXML": false,
2121
"createXMLFragment": false,
22+
"includesModule": false,
2223
"moduleTeardown": false,
2324
"url": false,
2425
"q": false,

‎test/data/testinit-jsdom.js

+6
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ function url( value ) {
3939
new Date().getTime() + "" + parseInt( Math.random() * 100000, 10 );
4040
}
4141

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

‎test/data/testinit.js

+59-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,13 @@ var FILEPATH = "/test/data/testinit.js",
1515
supportjQuery = this.jQuery,
1616

1717
// see RFC 2606
18-
externalHost = "example.com";
18+
externalHost = "example.com",
19+
20+
// NOTE: keep it in sync with build/tasks/lib/slim-build-flags.js
21+
slimBuildFlags = [
22+
"-ajax",
23+
"-effects"
24+
];
1925

2026
this.hasPHP = true;
2127
this.isLocal = window.location.protocol === "file:";
@@ -309,6 +315,58 @@ function moduleTypeSupported() {
309315
}
310316
moduleTypeSupported();
311317

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

314372
// 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
@@ -944,7 +944,7 @@ QUnit.test( "val()", function( assert ) {
944944
"Select-one with only option disabled (trac-12584)"
945945
);
946946

947-
if ( jQuery.fn.serialize ) {
947+
if ( includesModule( "serialize" ) ) {
948948
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" );
949949

950950
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

@@ -191,6 +200,9 @@ QUnit.test( "manipulation", function( assert ) {
191200
".after/.before"
192201
);
193202
} );
203+
}
204+
205+
if ( includesModule( "offset" ) ) {
194206

195207
// Support: jsdom 13.2+
196208
// jsdom returns 0 for offset-related properties
@@ -204,6 +216,7 @@ QUnit[ /jsdom\//.test( navigator.userAgent ) ? "skip" : "test" ]( "offset", func
204216
assert.strictEqual( elem.position().top, 5, ".position getter" );
205217
assert.strictEqual( elem.offsetParent()[ 0 ], parent[ 0 ], ".offsetParent" );
206218
} );
219+
}
207220

208221
QUnit.test( "selector", function( assert ) {
209222
assert.expect( 2 );
@@ -215,6 +228,7 @@ QUnit.test( "selector", function( assert ) {
215228
assert.strictEqual( elem.find( "span.b a" )[ 0 ].nodeName, "A", ".find - one result" );
216229
} );
217230

231+
if ( includesModule( "serialize" ) ) {
218232
QUnit.test( "serialize", function( assert ) {
219233
assert.expect( 2 );
220234

@@ -228,6 +242,7 @@ QUnit.test( "serialize", function( assert ) {
228242
"&select1=&select2=3&select3=1&select3=2&select5=3",
229243
"form serialization as query string" );
230244
} );
245+
}
231246

232247
QUnit.test( "traversing", function( assert ) {
233248
assert.expect( 12 );
@@ -249,6 +264,7 @@ QUnit.test( "traversing", function( assert ) {
249264
assert.strictEqual( elem.contents()[ 3 ].nodeType, 3, ".contents" );
250265
} );
251266

267+
if ( includesModule( "wrap" ) ) {
252268
QUnit.test( "wrap", function( assert ) {
253269
assert.expect( 3 );
254270

@@ -279,3 +295,4 @@ QUnit.test( "wrap", function( assert ) {
279295
);
280296

281297
} );
298+
}

‎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

@@ -1536,7 +1536,7 @@ testIframe(
15361536
}
15371537
);
15381538

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

15421542
var message;
@@ -1559,7 +1559,7 @@ QUnit[ jQuery.Deferred ? "test" : "skip" ]( "jQuery.readyException (original)",
15591559
);
15601560
} );
15611561

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

15651565
var done = assert.async();

‎test/unit/css.js

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
if ( jQuery.css ) {
1+
if ( includesModule( "css" ) ) {
22

33
QUnit.module( "css", { afterEach: moduleTeardown } );
44

@@ -487,9 +487,6 @@ QUnit.test( "css(Object) where values are Functions with incoming values", funct
487487
jQuery( "#cssFunctionTest" ).remove();
488488
} );
489489

490-
// .show(), .hide(), can be excluded from the build
491-
if ( jQuery.fn.show && jQuery.fn.hide ) {
492-
493490
QUnit.test( "show()", function( assert ) {
494491

495492
assert.expect( 18 );
@@ -968,8 +965,6 @@ QUnit.test( "show/hide 3.0, inline hidden", function( assert ) {
968965
} );
969966
} );
970967

971-
}
972-
973968
QUnit[ jQuery.find.compile && jQuery.fn.toggle ? "test" : "skip" ]( "toggle()", function( assert ) {
974969
assert.expect( 9 );
975970
var div, oldHide,
@@ -1194,7 +1189,7 @@ QUnit.test( "can't get background-position in IE<9, see trac-10796", function( a
11941189
}
11951190
} );
11961191

1197-
if ( jQuery.fn.offset ) {
1192+
if ( includesModule( "offset" ) ) {
11981193
QUnit.test( "percentage properties for left and top should be transformed to pixels, see trac-9505", function( assert ) {
11991194
assert.expect( 2 );
12001195
var parent = jQuery( "<div style='position:relative;width:200px;height:200px;margin:0;padding:0;border-width:0'></div>" ).appendTo( "#qunit-fixture" ),

‎test/unit/deferred.js

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

55
( function() {
66

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

0 commit comments

Comments
 (0)