1// Copyright 2008 the V8 project authors. All rights reserved.
2// Redistribution and use in source and binary forms, with or without
3// modification, are permitted provided that the following conditions are
4// met:
5//
6//     * Redistributions of source code must retain the above copyright
7//       notice, this list of conditions and the following disclaimer.
8//     * Redistributions in binary form must reproduce the above
9//       copyright notice, this list of conditions and the following
10//       disclaimer in the documentation and/or other materials provided
11//       with the distribution.
12//     * Neither the name of Google Inc. nor the names of its
13//       contributors may be used to endorse or promote products derived
14//       from this software without specific prior written permission.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
28// Flags: --expose-debug-as debug
29// Get the Debug object exposed from the debug context global object.
30Debug = debug.Debug
31
32// Simple function which stores the last debug event.
33var listenerComplete = false;
34var exception = false;
35var f_script_id = 0;
36var g_script_id = 0;
37var h_script_id = 0;
38var f_line = 0;
39var g_line = 0;
40
41var base_request = '"seq":0,"type":"request","command":"setbreakpoint"'
42
43function safeEval(code) {
44  try {
45    return eval('(' + code + ')');
46  } catch (e) {
47    assertEquals(void 0, e);
48    return undefined;
49  }
50}
51
52function testArguments(dcp, arguments, success, is_script) {
53  var request = '{' + base_request + ',"arguments":' + arguments + '}'
54  var json_response = dcp.processDebugJSONRequest(request);
55  var response = safeEval(json_response);
56  if (success) {
57    assertTrue(response.success, request + ' -> ' + json_response);
58    if (is_script) {
59      assertEquals('scriptName', response.body.type, request + ' -> ' + json_response);
60    } else {
61      assertEquals('scriptId', response.body.type, request + ' -> ' + json_response);
62    }
63  } else {
64    assertFalse(response.success, request + ' -> ' + json_response);
65  }
66  return response;
67}
68
69function listener(event, exec_state, event_data, data) {
70  try {
71  if (event == Debug.DebugEvent.Break) {
72    // Get the debug command processor.
73    var dcp = exec_state.debugCommandProcessor("unspecified_running_state");
74
75    // Test some illegal setbreakpoint requests.
76    var request = '{' + base_request + '}'
77    var response = safeEval(dcp.processDebugJSONRequest(request));
78    assertFalse(response.success);
79
80    var mirror;
81
82    testArguments(dcp, '{}', false);
83    testArguments(dcp, '{"type":"xx"}', false);
84    testArguments(dcp, '{"type":"function"}', false);
85    testArguments(dcp, '{"type":"script"}', false);
86    testArguments(dcp, '{"target":"f"}', false);
87    testArguments(dcp, '{"type":"xx","target":"xx"}', false);
88    testArguments(dcp, '{"type":"function","target":1}', false);
89    testArguments(dcp, '{"type":"function","target":"f","line":-1}', false);
90    testArguments(dcp, '{"type":"function","target":"f","column":-1}', false);
91    testArguments(dcp, '{"type":"function","target":"f","ignoreCount":-1}', false);
92    testArguments(dcp, '{"type":"handle","target":"-1"}', false);
93    mirror = debug.MakeMirror(o);
94    testArguments(dcp, '{"type":"handle","target":' + mirror.handle() + '}', false);
95
96    // Test some legal setbreakpoint requests.
97    testArguments(dcp, '{"type":"function","target":"f"}', true, false);
98    testArguments(dcp, '{"type":"function","target":"h"}', true, false);
99    testArguments(dcp, '{"type":"function","target":"f","line":1}', true, false);
100    testArguments(dcp, '{"type":"function","target":"f","position":1}', true, false);
101    testArguments(dcp, '{"type":"function","target":"f","condition":"i == 1"}', true, false);
102    testArguments(dcp, '{"type":"function","target":"f","enabled":true}', true, false);
103    testArguments(dcp, '{"type":"function","target":"f","enabled":false}', true, false);
104    testArguments(dcp, '{"type":"function","target":"f","ignoreCount":7}', true, false);
105
106    testArguments(dcp, '{"type":"script","target":"test"}', true, true);
107    testArguments(dcp, '{"type":"script","target":"test"}', true, true);
108    testArguments(dcp, '{"type":"script","target":"test","line":1}', true, true);
109    testArguments(dcp, '{"type":"script","target":"test","column":1}', true, true);
110
111    testArguments(dcp, '{"type":"scriptId","target":' + f_script_id + ',"line":' + f_line + '}', true, false);
112    testArguments(dcp, '{"type":"scriptId","target":' + g_script_id + ',"line":' + g_line + '}', true, false);
113    testArguments(dcp, '{"type":"scriptId","target":' + h_script_id + ',"line":' + h_line + '}', true, false);
114
115    mirror = debug.MakeMirror(f);
116    testArguments(dcp, '{"type":"handle","target":' + mirror.handle() + '}', true, false);
117    mirror = debug.MakeMirror(o.a);
118    testArguments(dcp, '{"type":"handle","target":' + mirror.handle() + '}', true, false);
119
120    testArguments(dcp, '{"type":"script","target":"sourceUrlScript","line":0}', true, true);
121
122    // Set a break point on a line with the comment, and check that actual position
123    // is the next line after the comment.
124    request = '{"type":"scriptId","target":' + g_script_id + ',"line":' + (g_line + 1) + '}';
125    response = testArguments(dcp, request, true, false);
126    assertEquals(g_line + 2, response.body.actual_locations[0].line);
127
128    // Indicate that all was processed.
129    listenerComplete = true;
130  }
131  } catch (e) {
132    exception = e
133  };
134};
135
136// Add the debug event listener.
137Debug.setListener(listener);
138
139function f() {
140  a=1
141};
142
143function g() {
144  // Comment.
145  f();
146};
147
148eval('function h(){}');
149eval('function sourceUrlFunc() { a = 2; }\n//# sourceURL=sourceUrlScript');
150
151o = {a:function(){},b:function(){}}
152
153// Check the script ids for the test functions.
154f_script_id = Debug.findScript(f).id;
155g_script_id = Debug.findScript(g).id;
156h_script_id = Debug.findScript(h).id;
157sourceURL_script_id = Debug.findScript(sourceUrlFunc).id;
158
159assertTrue(f_script_id > 0, "invalid script id for f");
160assertTrue(g_script_id > 0, "invalid script id for g");
161assertTrue(h_script_id > 0, "invalid script id for h");
162assertTrue(sourceURL_script_id > 0, "invalid script id for sourceUrlFunc");
163assertEquals(f_script_id, g_script_id);
164
165// Get the source line for the test functions.
166f_line = Debug.findFunctionSourceLocation(f).line;
167g_line = Debug.findFunctionSourceLocation(g).line;
168h_line = Debug.findFunctionSourceLocation(h).line;
169assertTrue(f_line > 0, "invalid line for f");
170assertTrue(g_line > 0, "invalid line for g");
171assertTrue(f_line < g_line);
172assertEquals(h_line, 0, "invalid line for h");
173
174// Set a break point and call to invoke the debug event listener.
175Debug.setBreakPoint(g, 0, 0);
176g();
177
178// Make sure that the debug event listener was invoked.
179assertTrue(listenerComplete, "listener did not run to completion: " + exception);
180
181// Try setting breakpoint by url specified in sourceURL
182
183var breakListenerCalled = false;
184
185function breakListener(event) {
186  if (event == Debug.DebugEvent.Break)
187    breakListenerCalled = true;
188}
189
190Debug.setListener(breakListener);
191
192sourceUrlFunc();
193
194assertTrue(breakListenerCalled, "Break listener not called on breakpoint set by sourceURL");
195
196
197// Breakpoint in a script with no statements test case. If breakpoint is set
198// to the script body, its actual position is taken from the nearest statement
199// below or like in this case is reset to the very end of the script.
200// Unless some precautions made, this position becomes out-of-range and
201// we get an exception.
202
203// Gets a script of 'i1' function and sets the breakpoint at line #4 which
204// should be empty.
205function SetBreakpointInI1Script() {
206  var i_script = Debug.findScript(i1);
207  assertTrue(!!i_script, "invalid script for i1");
208  Debug.setScriptBreakPoint(Debug.ScriptBreakPointType.ScriptId,
209                            i_script.id, 4);
210}
211
212// Creates the eval script and tries to set the breakpoint.
213// The tricky part is that the script function must be strongly reachable at the
214// moment. Since there's no way of simply getting the pointer to the function,
215// we run this code while the script function is being activated on stack.
216eval('SetBreakpointInI1Script()\nfunction i1(){}\n\n\n\nfunction i2(){}\n');
217