| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291 | 1
1
1
1
1
1
1
1
1
1
1
| var elementByRecursion = require('./element-commands/_elementByRecursion.js');
var elementsByRecursion = require('./element-commands/_elementsByRecursion.js');
module.exports = function(Nightwatch) {
var MOUSE_BUTTON_LEFT = 'left',
MOUSE_BUTTON_MIDDLE = 'middle',
MOUSE_BUTTON_RIGHT = 'right',
DIRECTION_UP = 'up',
DIRECTION_DOWN = 'down';
var Actions = {};
//////////////////////////////////////////////////////////////////
// Session related
//////////////////////////////////////////////////////////////////
/**
* Get info about, delete or create a new session. Defaults to the current session.
*
* ```
* this.demoTest = function (browser) {
* browser.session(function(result) {
* console.log(result.value);
* });
*
* browser.session('delete', function(result) {
* console.log(result.value);
* });
*
* browser.session('delete', '12345-abc', function(result) {
* console.log(result.value);
* });
* };
* ```
*
* @link /session
* @param {string} [action] The http verb to use, can be "get", "post" or "delete". If only the callback is passed, get is assumed as default.
* @param {string} [sessionId] The id of the session to get info about or delete.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.session = function(action, sessionId, callback) {
var options = {
path : '/session'
};
if (typeof arguments[0] === 'function') {
callback = arguments[0];
sessionId = Nightwatch.sessionId;
action = 'get';
} else {
action = action.toLowerCase();
if (typeof arguments[1] === 'function') {
callback = arguments[1];
sessionId = Nightwatch.sessionId;
}
}
switch (action) {
case 'delete':
options.method = 'DELETE';
break;
case 'post':
options.method = 'POST';
break;
case 'get':
options.method = 'GET';
break;
default:
sessionId = arguments[0];
action = 'get';
options.method = 'GET';
}
if (action != 'post') {
options.path += '/' + sessionId;
}
return sendRequest(options, callback);
};
/**
* Returns a list of the currently active sessions.
*
* @link /sessions
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.sessions = function(callback) {
var options = {
path : '/sessions',
method : 'GET'
};
return sendRequest(options, callback);
};
/**
* Configure the amount of time that a particular type of operation can execute for before they are aborted and a |Timeout| error is returned to the client.
*
* @link /session/:sessionId/timeouts
* @param {string} type The type of operation to set the timeout for. Valid values are: "script" for script timeouts, "implicit" for modifying the implicit wait timeout and "page load" for setting a page load timeout.
* @param {number} ms The amount of time, in milliseconds, that time-limited commands are permitted to run.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.timeouts = function(type, ms, callback) {
var timeoutValues = ['script', 'implicit', 'page load'];
if (timeoutValues.indexOf(type) === -1) {
throw new Error('Invalid timeouts type value: ' + type + '. Possible values are: ' + timeoutValues.join(','));
}
if (typeof ms != 'number') {
throw new Error('Second argument must be number.');
}
return postRequest('/timeouts', {
type : type,
ms : ms
}, callback);
};
/**
* Set the amount of time, in milliseconds, that asynchronous scripts executed by /session/:sessionId/execute_async are permitted to run before they are aborted and a |Timeout| error is returned to the client.
*
* @link /session/:sessionId/timeouts/async_script
* @param {number} ms The amount of time, in milliseconds, that time-limited commands are permitted to run.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.timeoutsAsyncScript = function(ms, callback) {
if (typeof ms != 'number') {
throw new Error('First argument must be number.');
}
return postRequest('/timeouts/async_script', {
ms : ms
}, callback);
};
/**
* Set the amount of time the driver should wait when searching for elements. If this command is never sent, the driver will default to an implicit wait of 0ms.
*
* @link /session/:sessionId/timeouts/implicit_wait
* @param {number} ms The amount of time, in milliseconds, that time-limited commands are permitted to run.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.timeoutsImplicitWait = function(ms, callback) {
if (typeof ms != 'number') {
throw new Error('First argument must be number.');
}
return postRequest('/timeouts/implicit_wait', {
ms : ms
}, callback);
};
//////////////////////////////////////////////////////////////////
// Element related
//////////////////////////////////////////////////////////////////
/**
* Search for an element on the page, starting from the document root. The located element will be returned as a WebElement JSON object.
*
* @link /session/:sessionId/element
* @param {string} using The locator strategy to use.
* @param {string} value The search target.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.element = function(using, value, callback) {
if (using == 'recursion') {
return new elementByRecursion(Nightwatch).command(value, callback);
}
return element(using, value, callback);
};
/*!
* element protocol action
*
* @param {string} using
* @param {string} value
* @param {function} callback
* @private
*/
function element(using, value, callback) {
var strategies = ['class name', 'css selector', 'id', 'name', 'link text',
'partial link text', 'tag name', 'xpath'];
using = using.toLocaleLowerCase();
if (strategies.indexOf(using) === -1) {
throw new Error('Provided locating strategy is not supported: ' +
using + '. It must be one of the following:\n' +
strategies.join(', '));
}
return postRequest('/element', {
using: using,
value: value
}, callback);
}
/**
* Search for an element on the page, starting from the identified element. The located element will be returned as a WebElement JSON object.
*
* @link /session/:sessionId/element/:id/element
* @param {string} id ID of the element to route the command to.
* @param {string} using The locator strategy to use.
* @param {string} value The search target.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdElement = function(id, using, value, callback) {
var strategies = ['class name', 'css selector', 'id', 'name', 'link text',
'partial link text', 'tag name', 'xpath'];
using = using.toLocaleLowerCase();
if (strategies.indexOf(using) === -1) {
throw new Error('Provided locating strategy is not supported: ' +
using + '. It must be one of the following:\n' +
strategies.join(', '));
}
return postRequest('/element/' + id + '/element', {
using: using,
value: value
}, callback);
};
/**
* Search for multiple elements on the page, starting from the document root. The located elements will be returned as a WebElement JSON objects.
* Valid strings to use as locator strategies are: "class name", "css selector", "id", "name", "link text", "partial link text", "tag name", "xpath"
*
* @link /session/:sessionId/elements
* @param {string} using The locator strategy to use.
* @param {string} value The search target.
* @param {function} callback Callback function to be invoked with the result when the command finishes.
* @api protocol
*/
Actions.elements = function(using, value, callback) {
if (using == 'recursion') {
return new elementsByRecursion(Nightwatch).command(value, callback);
}
return elements(using, value, callback);
};
/*!
* elements protocol action
*
* @param {string} using
* @param {string} value
* @param {function} callback
* @private
*/
function elements(using, value, callback) {
var check = /class name|css selector|id|name|link text|partial link text|tag name|xpath/gi;
if (!check.test(using)) {
throw new Error('Please provide any of the following using strings as the first parameter: ' +
'class name, css selector, id, name, link text, partial link text, tag name, or xpath. Given: ' + using);
}
return postRequest('/elements', {
using: using,
value: value
}, callback);
}
/**
* Search for multiple elements on the page, starting from the identified element. The located element will be returned as a WebElement JSON objects.
*
* @link /session/:sessionId/element/:id/elements
* @param {string} id ID of the element to route the command to.
* @param {string} using The locator strategy to use.
* @param {string} value The search target.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdElements = function(id, using, value, callback) {
var strategies = ['class name', 'css selector', 'id', 'name', 'link text',
'partial link text', 'tag name', 'xpath'];
using = using.toLocaleLowerCase();
if (strategies.indexOf(using) === -1) {
throw new Error('Provided locating strategy is not supported: ' +
using + '. It must be one of the following:\n' +
strategies.join(', '));
}
return postRequest('/element/' + id + '/elements', {
using: using,
value: value
}, callback);
};
/**
* Get the element on the page that currently has focus.
*
* @link /session/:sessionId/element/active
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementActive = function(callback) {
return postRequest('/element/active', {}, callback);
};
/**
* Get the value of an element's attribute.
*
* @link /session/:sessionId/element/:id/attribute/:name
* @param {string} id ID of the element to route the command to.
* @param {string} attributeName The attribute name
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdAttribute = function(id, attributeName, callback) {
return getRequest('/element/' + id + '/attribute/' + attributeName, callback);
};
/**
* Click on an element.
*
* @link /session/:sessionId/element/:id/click
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdClick = function(id, callback) {
return postRequest('/element/' + id + '/click', '', callback);
};
/**
* Query the value of an element's computed CSS property.
*
*
* The CSS property to query should be specified using the CSS property name, not the JavaScript property name (e.g. background-color instead of backgroundColor).
*
* @link /session/:sessionId/element/:id/css/:propertyName
* @param {string} id ID of the element to route the command to.
* @param {string} cssPropertyName
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdCssProperty = function(id, cssPropertyName, callback) {
return getRequest('/element/' + id + '/css/' + cssPropertyName, callback);
};
/**
* Determine if an element is currently displayed.
*
* @link /session/:sessionId/element/:id/displayed
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdDisplayed = function(id, callback) {
return getRequest('/element/' + id + '/displayed', callback);
};
/**
* Determine an element's location on the screen once it has been scrolled into view.
*
* @link /session/:sessionId/element/:id/location_in_view
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdLocationInView = function(id, callback) {
return getRequest('/element/' + id + '/location_in_view', callback);
};
/**
* Determine an element's location on the page. The point (0, 0) refers to the upper-left corner of the page.
*
* The element's coordinates are returned as a JSON object with x and y properties.
*
* @link /session/:sessionId/element/:id/location
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
* @returns {x:number, y:number} The X and Y coordinates for the element on the page.
*/
Actions.elementIdLocation = function(id, callback) {
return getRequest('/element/' + id + '/location', callback);
};
/**
* Query for an element's tag name.
*
* @link /session/:sessionId/element/:id/name
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdName = function(id, callback) {
return getRequest('/element/' + id + '/name', callback);
};
/**
* Clear a TEXTAREA or text INPUT element's value.
*
* @link /session/:sessionId/element/:id/clear
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdClear = function(id, callback) {
return postRequest('/element/' + id + '/clear', callback);
};
/**
* Determine if an OPTION element, or an INPUT element of type checkbox or radio button is currently selected.
*
* @link /session/:sessionId/element/:id/selected
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdSelected = function(id, callback) {
return getRequest('/element/' + id + '/selected', callback);
};
/**
* Determine if an element is currently enabled.
*
* @link /session/:sessionId/element/:id/enabled
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdEnabled = function(id, callback) {
return getRequest('/element/' + id + '/enabled', callback);
};
/**
* Test if two element IDs refer to the same DOM element.
*
* @link /session/:sessionId/element/:id/equals/:other
* @param {string} id ID of the element to route the command to.
* @param {string} otherId ID of the element to compare against.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdEquals = function(id, otherId, callback) {
return getRequest('/element/' + id + '/equals/' + otherId, callback);
};
/**
* Determine an element's size in pixels. The size will be returned as a JSON object with width and height properties.
*
* @link /session/:sessionId/element/:id/size
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdSize = function(id, callback) {
return getRequest('/element/' + id + '/size', callback);
};
/**
* Returns the visible text for the element.
*
* @link /session/:sessionId/element/:id/text
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdText = function(id, callback) {
return getRequest('/element/' + id + '/text', callback);
};
/**
* Send a sequence of key strokes to an element or returns the current value of the element.
*
* @link /session/:sessionId/element/:id/value
* @param {string} id ID of the element to route the command to.
* @param {string|array|none} [value] Value to send to element in case of a POST
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.elementIdValue = function(id, value, callback) {
if (arguments.length === 2 && typeof arguments[1] === 'function') {
callback = arguments[1];
return getRequest('/element/' + id + '/attribute/value', callback);
}
if (Array.isArray(value)) {
value = value.join('');
} else {
value = String(value);
}
return postRequest('/element/' + id + '/value', {
value: value.split('')
}, callback);
};
/**
* Submit a FORM element. The submit command may also be applied to any element that is a descendant of a FORM element.
*
* @link /session/:sessionId/element/:id/submit
* @param {string} id ID of the element to route the command to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.submit = function(id, callback) {
return postRequest('/element/' + id + '/submit', '', callback);
};
/**
* Get the current page source.
*
* @link /session/:sessionId/source
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.source = function(callback) {
return getRequest('/source', callback);
};
//////////////////////////////////////////////////////////////////
// Context related
//////////////////////////////////////////////////////////////////
/**
* Get a list of the available contexts.
*
* Used by Appium when testing hybrid mobile web apps. More info here: https://github.com/appium/appium/blob/master/docs/en/advanced-concepts/hybrid.md.
*
* @param {function} callback Callback function to be called when the command finishes.
* @returns {Array} an array of strings representing available contexts, e.g 'WEBVIEW', or 'NATIVE'
* @api protocol
*/
Actions.contexts = function(callback) {
return getRequest('/contexts', callback);
};
/**
*
* Get current context.
*
* @param {function} callback Callback function to be called when the command finishes.
* @returns {string|null} a string representing the current context or `null`, representing "no context"
* @api protocol
*/
Actions.currentContext = function(callback) {
return getRequest('/context', callback);
};
/**
* Sets the context.
*
* @param {string} context context name to switch to - a string representing an available context.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.setContext = function (context, callback) {
var data = {
name: context
};
return postRequest('/context', data, callback);
};
//////////////////////////////////////////////////////////////////
// Orientation
//////////////////////////////////////////////////////////////////
/**
* Get the current browser orientation.
*
* @param {function} callback Callback function to be called when the command finishes.
* @returns {string} The current browser orientation: {LANDSCAPE|PORTRAIT}
* @api protocol
*/
Actions.getOrientation = function(callback) {
return getRequest('/orientation', callback);
};
/**
* Sets the browser orientation.
*
* @param {string} orientation The new browser orientation: {LANDSCAPE|PORTRAIT}
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.setOrientation = function (orientation, callback) {
orientation = orientation.toUpperCase();
var accepted = ['LANDSCAPE', 'PORTRAIT'];
if (accepted.indexOf(orientation) == -1) {
throw new Error('Invalid orientation value specified. Accepted values are: ' + accepted.join(', '));
}
return postRequest('/orientation', {
orientation : orientation
}, callback);
};
//////////////////////////////////////////////////////////////////
// Mouse related
//////////////////////////////////////////////////////////////////
/**
* Move the mouse by an offset of the specificed element. If no element is specified, the move is relative to the current mouse cursor. If an element is provided but no offset, the mouse will be moved to the center of the element.
*
* If the element is not visible, it will be scrolled into view.
*
* @link /session/:sessionId/moveto
* @param {string} element Opaque ID assigned to the element to move to. If not specified or is null, the offset is relative to current position of the mouse.
* @param {number} xoffset X offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element.
* @param {number} yoffset Y offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.moveTo = function(element, xoffset, yoffset, callback) {
var data = {};
if (typeof element == 'string') {
data.element = element;
}
if (typeof xoffset == 'number') {
data.xoffset = xoffset;
}
if (typeof yoffset == 'number') {
data.yoffset = yoffset;
}
return postRequest('/moveto', data, callback);
};
/**
* Double-clicks at the current mouse coordinates (set by moveto).
*
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.doubleClick = function(callback) {
return postRequest('/doubleclick', callback);
};
/**
* Click at the current mouse coordinates (set by moveto).
*
* The button can be (0, 1, 2) or ('left', 'middle', 'right'). It defaults to left mouse button, and if you don't pass in a button but do pass in a callback, it will handle it correctly.
*
* @link /session/:sessionId/click
* @param {string|number} button The mouse button
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.mouseButtonClick = function(button, callback) {
var buttonIndex;
if (arguments.length === 0) {
button = 0;
} else {
if (typeof(button) === 'function') {
callback = button;
button = 0;
}
if (typeof button === 'string') {
buttonIndex = [
MOUSE_BUTTON_LEFT,
MOUSE_BUTTON_MIDDLE,
MOUSE_BUTTON_RIGHT
].indexOf(button.toLowerCase());
if (buttonIndex !== -1) {
button = buttonIndex;
}
}
}
return postRequest('/click', {button: button}, callback);
};
/**
* Click and hold the left mouse button (at the coordinates set by the last moveto command). Note that the next mouse-related command that should follow is `mouseButtonUp` . Any other mouse command (such as click or another call to buttondown) will yield undefined behaviour.
*
* Can be used for implementing drag-and-drop. The button can be (0, 1, 2) or ('left', 'middle', 'right'). It defaults to left mouse button, and if you don't pass in a button but do pass in a callback, it will handle it correctly.
*
* @link /session/:sessionId/buttondown
* @param {string|number} button The mouse button
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.mouseButtonDown = function(button, callback) {
return mouseButtonHandler(DIRECTION_DOWN, button, callback);
};
/**
* Releases the mouse button previously held (where the mouse is currently at). Must be called once for every `mouseButtonDown` command issued.
*
* Can be used for implementing drag-and-drop. The button can be (0, 1, 2) or ('left', 'middle', 'right'). It defaults to left mouse button, and if you don't pass in a button but do pass in a callback, it will handle it correctly.
*
* @link /session/:sessionId/buttonup
* @param {string|number} button The mouse button
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.mouseButtonUp = function(button, callback) {
return mouseButtonHandler(DIRECTION_UP, button, callback);
};
/*!
* Helper function for mouseButton actions
*
* @param {string} direction
* @param {string|number} button
* @param {function} callback
* @private
*/
function mouseButtonHandler(direction, button, callback) {
var buttonIndex;
if (typeof(button) === 'function') {
callback = button;
button = 0;
}
if (typeof button === 'string') {
buttonIndex = [
MOUSE_BUTTON_LEFT,
MOUSE_BUTTON_MIDDLE,
MOUSE_BUTTON_RIGHT
].indexOf(button.toLowerCase());
if (buttonIndex !== -1) {
button = buttonIndex;
}
}
return postRequest('/button' + direction, {button: button}, callback);
}
/////////////////////////////////////////////////////////////////////////////
// Window specific commands
/////////////////////////////////////////////////////////////////////////////
/*!
* Helper function for execute and execute_async
*
* @param {string} path
* @param {string|function} script
* @param {Array} args
* @param {function} callback
* @private
*/
function executeHandler(path, script, args, callback) {
var fn;
if (typeof script === 'function') {
fn = 'var passedArgs = Array.prototype.slice.call(arguments,0); return ' +
script.toString() + '.apply(window, passedArgs);';
} else {
fn = script;
}
if (arguments.length === 2) {
args = [];
} else if ((arguments.length === 3) && (typeof arguments[2] === 'function')) {
callback = arguments[2];
args = [];
}
return postRequest(path, {
script: fn,
args: args
}, callback);
}
/**
* Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame. The executed script is assumed to be synchronous and the result of evaluating the script is returned to the client.
* The script argument defines the script to execute in the form of a function body. The value returned by that function will be returned to the client.
*
* The function will be invoked with the provided args array and the values may be accessed via the arguments object in the order specified.
*
* ```
* this.demoTest = function (browser) {
* browser.execute(function(data) {
* // resize operation
* return true;
* }, [imagedata], function(result) {
* ...
* });
* };
* ```
*
* @link /session/:sessionId/execute
* @param {string|function} body The function body to be injected.
* @param {Array} args An array of arguments which will be passed to the function.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
* @returns {*} The script result.
*/
Actions.execute = function(body, args, callback) {
var executeArgs = Array.prototype.slice.call(arguments, 0);
executeArgs.unshift('/execute');
return executeHandler.apply(null, executeArgs);
};
/**
* Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame. The executed script is assumed to be asynchronous and the result of evaluating the script is returned to the client.
*
* Asynchronous script commands may not span page loads. If an unload event is fired while waiting for a script result, an error should be returned to the client.
*
* ```
* this.demoTest = function (browser) {
* browser.executeAsync(function(data, done) {
* someAsyncOperation(function() {
* done(true);
* });
* }, [imagedata], function(result) {
* // ...
* });
* };
* ```
*
* @link /session/:sessionId/execute_async
* @param {string|function} script The function body to be injected.
* @param {Array} args An array of arguments which will be passed to the function.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
* @returns {*} The script result.
*/
Actions.executeAsync = function(script, args, callback) {
args = Array.prototype.slice.call(arguments, 0);
args.unshift('/execute_async');
return executeHandler.apply(null, args);
};
/*!
* @deprecated
*/
Actions.execute_async = Actions.executeAsync;
/**
* Change focus to another frame on the page. If the frame id is missing or null, the server should switch to the page's default content.
*
* @link /session/:sessionId/frame
* @param {string|number|null} [frameId] Identifier for the frame to change focus to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.frame = function(frameId, callback) {
if (arguments.length === 1 && typeof frameId === 'function') {
callback = frameId;
return postRequest('/frame', callback);
}
return postRequest('/frame', {
id: frameId
}, callback);
};
/**
* Change focus to the parent context. If the current context is the top level browsing context, the context remains unchanged.
*
* @link /session/:sessionId/frame/parent
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @since v0.4.8
* @api protocol
*/
Actions.frameParent = function(callback) {
return postRequest('/frame/parent', callback);
};
/**
* Change focus to another window or close the current window.
*
* @link /session/:sessionId/window
* @param {string} method The HTTP method to use
* @param {string} handleOrName The window to change focus to.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @since v0.3.0
* @api protocol
*/
Actions.window = function(method, handleOrName, callback) {
method = method.toUpperCase();
switch (method) {
case 'POST':
if (arguments.length < 2) {
throw new Error('POST requests to /window must include a name parameter also.');
}
return postRequest('/window', {
name : handleOrName
}, callback);
case 'DELETE':
return deleteRequest('/window', arguments[1]);
default:
throw new Error('This method expects first argument to be either POST or DELETE.');
}
};
/**
* Retrieve the current window handle.
*
* @link /session/:sessionId/window_handle
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.windowHandle = function(callback) {
return getRequest('/window_handle', callback);
};
/**
* Retrieve the current window handle.
*
* @link /session/:sessionId/window/:windowHandle/maximize
* @param {string} [handleOrName] windowHandle URL parameter; if it is "current", the currently active window will be maximized.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.windowMaximize = function(handleOrName, callback) {
return postRequest('/window/'+ handleOrName + '/maximize', callback);
};
/*!
* @deprecated
*/
Actions.window_handle = Actions.windowHandle;
/**
* Retrieve the list of all window handles available to the session.
*
* @link /session/:sessionId/window_handles
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.windowHandles = function(callback) {
return getRequest('/window_handles', callback);
};
/*!
* @deprecated
*/
Actions.window_handles = Actions.windowHandles;
/**
* Change or get the size of the specified window. If the second argument is a function it will be used as a callback and the call will perform a get request to retrieve the existing window size.
*
* @link /session/:sessionId/window/:windowHandle/size
* @param {string} windowHandle
* @param {number} width
* @param {number} height
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.windowSize = function(windowHandle, width, height, callback) {
if (typeof windowHandle !== 'string') {
throw new Error('First argument must be a window handle string.');
}
var path = '/window/' + windowHandle + '/size';
if (arguments.length === 2 && typeof arguments[1] === 'function') {
return getRequest(path, arguments[1]);
}
width = Number(width);
height = Number(height);
if (typeof width !== 'number' || isNaN(width)) {
throw new Error('Width and height arguments must be passed as numbers.');
}
if (typeof height !== 'number' || isNaN(height)) {
throw new Error('Width and height arguments must be passed as numbers.');
}
return postRequest(path, {
width : width,
height : height
}, callback);
};
/**
* Change or get the position of the specified window. If the second argument is a function it will be used as a callback and the call will perform a get request to retrieve the existing window position.
*
* @link /session/:sessionId/window/:windowHandle/position
* @param {string} windowHandle
* @param {number} offsetX
* @param {number} offsetY
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.windowPosition = function(windowHandle, offsetX, offsetY, callback) {
if (typeof windowHandle !== 'string') {
throw new Error('First argument must be a window handle string.');
}
var path = '/window/' + windowHandle + '/position';
if (arguments.length === 2 && typeof arguments[1] === 'function') {
return getRequest(path, arguments[1]);
}
offsetX = Number(offsetX);
offsetY = Number(offsetY);
if (typeof offsetX !== 'number' || isNaN(offsetX)) {
throw new Error('Offset arguments must be passed as numbers.');
}
if (typeof offsetY !== 'number' || isNaN(offsetY)) {
throw new Error('Offset arguments must be passed as numbers.');
}
return postRequest(path, {
x : offsetX,
y : offsetY
}, callback);
};
/**
* Refresh the current page.
*
* @link /session/:sessionId/refresh
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.refresh = function(callback) {
return postRequest('/refresh', callback);
};
/**
* Navigate backwards in the browser history, if possible.
*
* @link /session/:sessionId/back
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.back = function(callback) {
return postRequest('/back', callback);
};
/**
* Navigate forwards in the browser history, if possible.
*
* @link /session/:sessionId/back
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.forward = function(callback) {
return postRequest('/forward', callback);
};
/**
* Take a screenshot of the current page.
*
* @link /session/:sessionId/screenshot
* @param {boolean} log_screenshot_data Whether or not the screenshot data should appear in the logs when running with --verbose
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.screenshot = function(log_screenshot_data, callback) {
return getRequest('/screenshot', callback).on('beforeResult', function(result) {
result = result || {};
if (!log_screenshot_data) {
result.suppressBase64Data = true;
}
});
};
/**
* Retrieve the URL of the current page or navigate to a new URL.
*
* @link /session/:sessionId/url
* @param {string|function} [url] If missing, it will return the URL of the current page as an argument to the supplied callback
* @param {Function} [callback]
* @api protocol
*/
Actions.url = function(url, callback) {
if (typeof url == 'string') {
return postRequest('/url', {
url : url
}, callback);
}
if (typeof url == 'function') {
callback = url;
}
return getRequest('/url', callback);
};
/**
* Query the server's current status.
*
* @link /status
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.status = function(callback) {
return sendRequest({
method : 'GET',
path : '/status'
}, callback);
};
/**
* Get the current page title.
*
* @link /session/:sessionId/title
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.title = function(callback) {
return getRequest('/title', callback);
};
/**
* Send a sequence of key strokes to the active element. The sequence is defined in the same format as the `sendKeys` command.
* An object map with available keys and their respective UTF-8 characters, as defined on [W3C WebDriver draft spec](http://www.w3.org/TR/webdriver/#character-types), is loaded onto the main Nightwatch instance as `client.Keys`.
*
* Rather than the `setValue`, the modifiers are not released at the end of the call. The state of the modifier keys is kept between calls, so mouse interactions can be performed while modifier keys are depressed.
*
* @link /session/:sessionId/keys
* @param {Array} keysToSend The keys sequence to be sent.
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.keys = function(keysToSend, callback) {
if (!Array.isArray(keysToSend)) {
keysToSend = [keysToSend];
}
return postRequest('/keys', {
value: keysToSend
}, callback);
};
/////////////////////////////////////////////////////////////////////////////
// Cookies
/////////////////////////////////////////////////////////////////////////////
/**
* Retrieve or delete all cookies visible to the current page or set a cookie.
*
* @link /session/:sessionId/cookie
* @param {string} method Http method
* @param {function|object} [callbackOrCookie] Optional callback function to be called when the command finishes.
* @since v0.4.0
* @api protocol
*/
Actions.cookie = function(method, callbackOrCookie) {
switch (method) {
case 'GET':
return getRequest('/cookie', callbackOrCookie);
case 'POST':
if (arguments.length < 2) {
throw new Error('POST requests to /cookie must include a cookie object parameter also.');
}
return postRequest('/cookie', {
cookie : callbackOrCookie
}, arguments[2]);
case 'DELETE':
if (typeof callbackOrCookie === 'undefined' || typeof callbackOrCookie === 'function') {
return deleteRequest('/cookie', callbackOrCookie);
}
return deleteRequest('/cookie/' + callbackOrCookie, arguments[2]);
default:
throw new Error('This method expects first argument to be either GET, POST or DELETE.');
}
};
/////////////////////////////////////////////////////////////////////////////
// Alert handling
/////////////////////////////////////////////////////////////////////////////
/**
* Accepts the currently displayed alert dialog. Usually, this is equivalent to clicking on the 'OK' button in the dialog.
*
* @link /session/:sessionId/accept_alert
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.acceptAlert = function(callback) {
return postRequest('/accept_alert', callback);
};
/*!
* @deprecated
*/
Actions.accept_alert = Actions.acceptAlert;
/**
* Dismisses the currently displayed alert dialog. For confirm() and prompt() dialogs, this is equivalent to clicking the 'Cancel' button.
*
* For alert() dialogs, this is equivalent to clicking the 'OK' button.
*
* @link /session/:sessionId/dismiss_alert
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.dismissAlert = function(callback) {
return postRequest('/dismiss_alert', callback);
};
/**
* Sends keystrokes to a JavaScript prompt() dialog.
*
* @link /session/:sessionId/alert_text
* @param {string} value Keystrokes to send to the prompt() dialog
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @api protocol
*/
Actions.setAlertText = function(value, callback) {
return postRequest('/alert_text', {text: value}, callback);
};
/**
* Gets the text of the currently displayed JavaScript alert(), confirm(), or prompt() dialog.
*
* @link /session/:sessionId/alert_text
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @returns {string} The text of the currently displayed alert.
* @api protocol
*/
Actions.getAlertText = function(callback) {
return getRequest('/alert_text', callback);
};
/*!
* @deprecated
*/
Actions.dismiss_alert = Actions.dismissAlert;
/**
* Gets the text of the log type specified
*
* @link /session/:sessionId/log
* @param {string} typeString Type of log to request
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @returns {Array} Array of the text entries of the log.
* @api protocol
*/
Actions.sessionLog = function(typeString, callback) {
return postRequest('/log', {type: typeString}, callback);
};
/**
* Gets an array of strings for which log types are available.
*
* @link /session/:sessionId/log/types
* @param {function} [callback] Optional callback function to be called when the command finishes.
* @returns {Array} Available log types
* @api protocol
*/
Actions.sessionLogTypes = function(callback) {
return getRequest('/log/types', callback);
};
/////////////////////////////////////////////////////////////////////////////
// Helpers
/////////////////////////////////////////////////////////////////////////////
function getRequest(path, callback) {
var options = {
path : '/session/' + Nightwatch.sessionId + path,
method : 'GET'
};
return sendRequest(options, callback);
}
function deleteRequest(path, callback) {
var options = {
path : '/session/' + Nightwatch.sessionId + path,
method : 'DELETE'
};
return sendRequest(options, callback);
}
function postRequest(path, data, callback) {
if (arguments.length === 2 && typeof data === 'function') {
callback = data;
data = '';
}
var options = {
path : '/session/' + Nightwatch.sessionId + path,
method : 'POST',
data : data || ''
};
return sendRequest(options, callback);
}
function sendRequest(options, callback) {
callback = callback || function() {};
return Nightwatch.runProtocolAction(options, callback).send();
}
return Actions;
};
|