Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 3490952

Browse files
Andres Ornelasesprehn
Andres Ornelas
authored and
esprehn
committed
add optional label to dsl with selectors to improve test and output readability
e.g. Before: code: element('.actions ul li a').click(); output: element .actions ul li a click After code: element('.actions ul li a', "'Configuration' link").click(); output: element 'Configuration' link ( .actions ul li a ) click
1 parent 92e31b5 commit 3490952

File tree

3 files changed

+70
-35
lines changed

3 files changed

+70
-35
lines changed

‎scenario/widgets-scenario.js

+6-6
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,24 @@ describe('widgets', function() {
2929
expect(binding('button').fromJson()).toEqual({'count': 0});
3030
expect(binding('form').fromJson()).toEqual({'count': 0});
3131

32-
element('form a').click();
32+
element('form a', "'action' link").click();
3333
expect(binding('button').fromJson()).toEqual({'count': 1});
3434

35-
element('input[value="submit input"]').click();
35+
element('input[value="submit input"]', "'submit input' button").click();
3636
expect(binding('button').fromJson()).toEqual({'count': 2});
3737
expect(binding('form').fromJson()).toEqual({'count': 1});
3838

39-
element('button:contains("submit button")').click();
39+
element('button:contains("submit button")', "'submit button' button").click();
4040
expect(binding('button').fromJson()).toEqual({'count': 2});
4141
expect(binding('form').fromJson()).toEqual({'count': 2});
4242

43-
element('input[value="button"]').click();
43+
element('input[value="button"]', "'button' button").click();
4444
expect(binding('button').fromJson()).toEqual({'count': 3});
4545

46-
element('input[type="image"]').click();
46+
element('input[type="image"]', 'form image').click();
4747
expect(binding('button').fromJson()).toEqual({'count': 4});
4848

49-
element('#navigate a').click();
49+
element('#navigate a', "'Go to #route' link").click();
5050
expect(binding('$location.hash')).toEqual('route');
5151

5252
/**

‎src/scenario/dsl.js

+34-29
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,19 @@ angular.scenario.dsl('navigateTo', function() {
6969

7070
/**
7171
* Usage:
72-
* using(selector) scopes the next DSL element selection
72+
* using(selector, label) scopes the next DSL element selection
7373
*
7474
* ex.
75-
* using('#foo').input('bar')
75+
* using('#foo', "'Foo' text field").input('bar')
7676
*/
7777
angular.scenario.dsl('using', function() {
78-
return function(selector) {
78+
return function(selector, label) {
7979
this.selector = (this.selector||'') + ' ' + selector;
80+
if (angular.isString(label) && label.length) {
81+
this.label = label + ' (' + this.selector + ' )';
82+
} else {
83+
this.label = this.selector;
84+
}
8085
return this.dsl;
8186
};
8287
});
@@ -148,15 +153,15 @@ angular.scenario.dsl('input', function() {
148153

149154
/**
150155
* Usage:
151-
* repeater('#products table').count() number of rows
152-
* repeater('#products table').row(1) all bindings in row as an array
153-
* repeater('#products table').column('product.name') all values across all rows in an array
156+
* repeater('#products table', 'Product List').count() number of rows
157+
* repeater('#products table', 'Product List').row(1) all bindings in row as an array
158+
* repeater('#products table', 'Product List').column('product.name') all values across all rows in an array
154159
*/
155160
angular.scenario.dsl('repeater', function() {
156161
var chain = {};
157162

158163
chain.count = function() {
159-
return this.addFutureAction('repeater ' + this.selector + ' count', function($window, $document, done) {
164+
return this.addFutureAction('repeater ' + this.label + ' count', function($window, $document, done) {
160165
try {
161166
done(null, $document.elements().length);
162167
} catch (e) {
@@ -166,7 +171,7 @@ angular.scenario.dsl('repeater', function() {
166171
};
167172

168173
chain.column = function(binding) {
169-
return this.addFutureAction('repeater ' + this.selector + ' column ' + binding, function($window, $document, done) {
174+
return this.addFutureAction('repeater ' + this.label + ' column ' + binding, function($window, $document, done) {
170175
var values = [];
171176
$document.elements().each(function() {
172177
_jQuery(this).find(':visible').each(function() {
@@ -181,7 +186,7 @@ angular.scenario.dsl('repeater', function() {
181186
};
182187

183188
chain.row = function(index) {
184-
return this.addFutureAction('repeater ' + this.selector + ' row ' + index, function($window, $document, done) {
189+
return this.addFutureAction('repeater ' + this.label + ' row ' + index, function($window, $document, done) {
185190
var values = [];
186191
var matches = $document.elements().slice(index, index + 1);
187192
if (!matches.length)
@@ -196,16 +201,16 @@ angular.scenario.dsl('repeater', function() {
196201
});
197202
};
198203

199-
return function(selector) {
200-
this.dsl.using(selector);
204+
return function(selector, label) {
205+
this.dsl.using(selector, label);
201206
return chain;
202207
};
203208
});
204209

205210
/**
206211
* Usage:
207-
* select(selector).option('value') select one option
208-
* select(selector).options('value1', 'value2', ...) select options from a multi select
212+
* select(name).option('value') select one option
213+
* select(name).options('value1', 'value2', ...) select options from a multi select
209214
*/
210215
angular.scenario.dsl('select', function() {
211216
var chain = {};
@@ -237,19 +242,19 @@ angular.scenario.dsl('select', function() {
237242

238243
/**
239244
* Usage:
240-
* element(selector).count() get the number of elements that match selector
241-
* element(selector).click() clicks an element
242-
* element(selector).attr(name) gets the value of an attribute
243-
* element(selector).attr(name, value) sets the value of an attribute
244-
* element(selector).val() gets the value (as defined by jQuery)
245-
* element(selector).val(value) sets the value (as defined by jQuery)
246-
* element(selector).query(fn) executes fn(selectedElements, done)
245+
* element(selector, label).count() get the number of elements that match selector
246+
* element(selector, label).click() clicks an element
247+
* element(selector, label).attr(name) gets the value of an attribute
248+
* element(selector, label).attr(name, value) sets the value of an attribute
249+
* element(selector, label).val() gets the value (as defined by jQuery)
250+
* element(selector, label).val(value) sets the value (as defined by jQuery)
251+
* element(selector, label).query(fn) executes fn(selectedElements, done)
247252
*/
248253
angular.scenario.dsl('element', function() {
249254
var chain = {};
250255

251256
chain.count = function() {
252-
return this.addFutureAction('element ' + this.selector + ' count', function($window, $document, done) {
257+
return this.addFutureAction('element ' + this.label + ' count', function($window, $document, done) {
253258
try {
254259
done(null, $document.elements().length);
255260
} catch (e) {
@@ -259,7 +264,7 @@ angular.scenario.dsl('element', function() {
259264
};
260265

261266
chain.click = function() {
262-
return this.addFutureAction('element ' + this.selector + ' click', function($window, $document, done) {
267+
return this.addFutureAction('element ' + this.label + ' click', function($window, $document, done) {
263268
var elements = $document.elements();
264269
var href = elements.attr('href');
265270
elements.trigger('click');
@@ -274,33 +279,33 @@ angular.scenario.dsl('element', function() {
274279
};
275280

276281
chain.attr = function(name, value) {
277-
var futureName = 'element ' + this.selector + ' get attribute ' + name;
282+
var futureName = 'element ' + this.label + ' get attribute ' + name;
278283
if (value) {
279-
futureName = 'element ' + this.selector + ' set attribute ' + name + ' to ' + value;
284+
futureName = 'element ' + this.label + ' set attribute ' + name + ' to ' + value;
280285
}
281286
return this.addFutureAction(futureName, function($window, $document, done) {
282287
done(null, $document.elements().attr(name, value));
283288
});
284289
};
285290

286291
chain.val = function(value) {
287-
var futureName = 'element ' + this.selector + ' value';
292+
var futureName = 'element ' + this.label + ' value';
288293
if (value) {
289-
futureName = 'element ' + this.selector + ' set value to ' + value;
294+
futureName = 'element ' + this.label + ' set value to ' + value;
290295
}
291296
return this.addFutureAction(futureName, function($window, $document, done) {
292297
done(null, $document.elements().val(value));
293298
});
294299
};
295300

296301
chain.query = function(fn) {
297-
return this.addFutureAction('element ' + this.selector + ' custom query', function($window, $document, done) {
302+
return this.addFutureAction('element ' + this.label + ' custom query', function($window, $document, done) {
298303
fn.call(this, $document.elements(), done);
299304
});
300305
};
301306

302-
return function(selector) {
303-
this.dsl.using(selector);
307+
return function(selector, label) {
308+
this.dsl.using(selector, label);
304309
return chain;
305310
};
306311
});

‎test/scenario/dslSpec.js

+30
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,16 @@ describe("angular.scenario.dsl", function() {
222222
});
223223
expect($root.futureResult).toEqual('http://example.com/myUrl');
224224
});
225+
226+
it('should use the selector as label if none is given', function() {
227+
$root.dsl.element('mySelector');
228+
expect($root.label).toEqual(' mySelector');
229+
});
230+
231+
it('should include the selector in paren when a label is given', function() {
232+
$root.dsl.element('mySelector', 'myLabel');
233+
expect($root.label).toEqual('myLabel ( mySelector )');
234+
});
225235
});
226236

227237
describe('Repeater', function() {
@@ -256,6 +266,15 @@ describe("angular.scenario.dsl", function() {
256266
chain.column('gender');
257267
expect($root.futureResult).toEqual(['male', 'female']);
258268
});
269+
270+
it('should use the selector as label if none is given', function() {
271+
expect($root.label).toEqual(' ul li');
272+
});
273+
274+
it('should include the selector in paren when a label is given', function() {
275+
$root.dsl.repeater('mySelector', 'myLabel');
276+
expect($root.label).toEqual('myLabel ( ul li mySelector )');
277+
});
259278
});
260279

261280
describe('Binding', function() {
@@ -302,6 +321,17 @@ describe("angular.scenario.dsl", function() {
302321
expect(inputs.first().val()).toEqual('something');
303322
expect(inputs.last().val()).toEqual('foo');
304323
});
324+
325+
it('should use the selector as label if none is given', function() {
326+
$root.dsl.using('mySelector');
327+
expect($root.label).toEqual(' mySelector');
328+
});
329+
330+
it('should include the selector in paren when a label is given', function() {
331+
$root.dsl.using('mySelector', 'myLabel');
332+
expect($root.label).toEqual('myLabel ( mySelector )');
333+
});
334+
305335
});
306336

307337
describe('Input', function() {

0 commit comments

Comments
 (0)