HOME > Community > Projects > qa

Web/Enterprise Application Debugging Test Specification

Author: Jiri Skrivanek, Libor Martinek
Version: NetBeans 5.5
Last update: 6-th March 2007

Introduction: This is test specification of debugging of web and enterprise applications in NetBeans IDE 5.5.
Comment: Debugging is not supported for BEA Weblogic server.

1. JSP Debugging overall
2. JSP Debugging
3. Servlet Debugging
4. Breakpoints in JSP
5. Enterprise Application Debugging
6. Java Sources Debugging

Test suite 1: JSP Debugging overall

Setup: Open MainTestApplication and required projects. Open index.jsp and put breakpoint at title tag for example.

Test case

Description

Start debugger

Start debugger
Continue debug session
Finish debugging

RESULT: Debugger stops at breakpoint, after continue shows JSP in browser and finishes finally.

Try to repeat using different UI controls (toolbar, shortcuts, main menu - Run|Debug Main Project (F5), Run|Continue (Ctrl+F5), Run|Finish Debugger Session(Shift+F5), Debug Project on project root node)

Start debugger after run

Run project
Start debugger
Continue debugging session
Finish debugger

RESULT: Debugger stops at breakpoint.

Start debugger after reached breakpoint

Start debugger
Finish debugger when it stops at breakpoint
Start debugger again
Finish debugger

RESULT: Debugger alway stops at breakpoint.

Start debugger with stopped server

Start debugger
Finish debugger when it stops at breakpoint.
Stop server in Runtime view.
Start debugger again
Finish debugger.

RESULT: Server starts and debugger always stops at breakpoint.

Start debugger without breakpoint

Delete breakpoint from index.jsp.
Start debugger and wait until JSP is shown in browser
Add breakpoint to index.jsp
Reload JSP in browser and wait until debugger stops at breakpoint
Continue debugging
Repeat steps 4 and 5 several times.
Finish debugger.

RESULT: Debugger stops at breakpoint.

Start debugger on unsaved JSP

Modify index.jsp and put a breakpoint
Start debugger.
Finish debugger.

RESULT: JSP is saved and debugger stops at breakpoint.

Start debugger on JSP in folder

Add a breakpoint in JSP in folder.
Start debugger by menu item Run|Run File|Debug....
Continue and finish debugger.

RESULT: Debugger stops at breakpoint.

Use also shortcut Ctrl+Shift+F5 and menu item "Debug file" on the file.

Start debugger with running session

Start debugger.
When breakpoint is reached, start debugger again.
A message in output window should inform you that server is in suspended state.
Finish debugger.

Run project when debugging

Start debugger.
When breakpoint is reached, try to run project.
A message in output window should inform you that server is in suspended state.
Finish debugger.

Stop server when debugging

Start debugger and wait until it stops at breakpoint
Open context menu on server node in Runtime view.
Check it is not possible to stop and start server. All Start, Restart Stop items should be disabled.
Check also state of buttons in output view.

RESULT: Items disabled.

Two sessions - Java debugging

Start debugger
Create java application, add a breakpoint and call menu item 'Debug Project' on project's root node
Open Sessions view (Windows|Debugging|Sessions) and check there are two sessions with correct names
Double click web application session to make it current
Call ' Finish All' action in popup in Session View

RESULT: Two sessions coexist together. Make current action brings file with breakpoint to front.

Attach to external Tomcat

Create a web application and run it
Check properties of Bundled Tomcat server instance. Debugger Type should be 'Shared Memory'. Copy name 'tomcat_shared_memory_id' to clipboard.
Stop server
Start Server in debug mode
Call menu item 'Run|Attach Debugger...' and in Attach dialog fill in the following fields: Connector - SharedMemoryAttach, Name - tomcat_shared_memory_id
Click OK in Attach dialog
Add breakpoint into index.jsp in your web application and reload application in browser
Debugger should stop at breakpoint
Finish debugging
Stop server
Change Debugging Type in properties to 'Socket'
Start server in debug mode
Call menu item 'Run|Attach Debugger...' and in Attach dialog fill in the following fields: Connector - SocketAttach, Host - localhost, Port - 11555
Click OK in Attach dialog
Reload application in browser
Debugger should stop at breakpoint
Finish debugging

Shared memory is available only on Windows.

Test suite 2: JSP Debugging

Setup: Open MainTestApplication and required projects.

Test case

Description

Run to Cursor

Set cursor to a line in index.jsp
Do action 'Run To Cursor' and wait until debugger stops at the line.
Move cursor several lines ahead and do action 'Run to Cursor' again.
Move cursor several lines backward and do action 'Run to Cursor'
Reload JSP in browser and debugger should stop at specified line.
Continue.
Finish debugger.

RESULT: Debugger stops at line with cursor.

Test also F4 short cut.

Step into/out/over

Add breakpoint to index.jsp
Start debugging and wait until debugger stops at breakpoint
Try Step into action (F7) several times and check if it steps line by line in JSP
Continue and reload in browser to reach breakpoint again
Try Step Out action (Ctrl+F7) and check if debugger continues.
Reload in browser to reach breakpoint again
Try Step Over action (F8) several times and check if it steps line by line in JSP
Finish debugging

Try actions in toolbar, main menu and shortcuts - Run|Step Over (F8), Run|Step Into (F7), Run|Step Out (Ctrl+F7)

JSP includes

Add breakpoint before include directives into index.jsp (line containing 'Using include directive')
Start debugger and wait until it stops at breakpoint
Use Step Into (F7) action to go through all includes and check whether all included pages are really opened.
Continue and reload in browser to reach breakpoint again
Use Step Over (F8) to continue. It should not go into included pages (issue 31118)
Continue and reload in browser to reach breakpoint again
Use Step Into (F7) to go to the first included page. Do Step Out action. It should stop debugger after include statement (issue 31118)
Add breakpoint before '<jsp:include' into index.jsp (line containing 'Using dynamic include')
Repeat steps 2 to 7 for dynamic includes
Remove all breakpoints and add new breakpoints into every included page
Start debugger and check whether it stops everytime at breakpoint (keep in mind that there are embedded includes, so one page is accessed several times).

JSP forwards

Add breakpoint before 'jsp:forward' into forwardTest.jsp
Start debugger (Run|Run File|Debug "forwardTest.jsp") and wait until it stops at breakpoint
Use Step Into (F7) action to step into forwarded.jsp
Continue and reload in browser to reach breakpoint again
Use Step Over (F8) to continue. It should not go into forward page
Continue and reload in browser to reach breakpoint again
Use Step Into (F7) to go to the forwarded page. Do Step Out action. It should stop debugger at forward statement
Remove all breakpoints and add new breakpoints into forwarded.jsp page
Start debugger and check whether it stops at breakpoint.

Tag files

Add breakpoint before tag directive into index.jsp (line containing 'Using tag libraries')
Start debugger and wait until it stops at breakpoint
Use Step Into (F7) action to go through all tag files and handlers and check whether files are really opened.
Continue and reload in browser to reach breakpoint again
Use Step Over (F8) to continue. It should not go into tag files and handlers
Continue and reload in browser to reach breakpoint again
Use Step Into (F7) to go to the first tag handler. Do Step Out action. It should stop debugger at calling JSP.
Use Step Into (F7) to go to the first tag file. Do Step Out action. It should stop debugger at calling JSP.
Remove all breakpoints and add new breakpoints into every tag file and tag handler
Start debugger and check whether it stops everytime at breakpoint.

Tagx files

Add breakpoint before tags directive into jspxExample.jsp. It must be at 'jsp:element (issue 53734)
Start debugger for jspxExample.jspx file and wait until it stops at breakpoint
Use Step Into (F7) action to go through tagx file.
Continue and reload in browser to reach breakpoint again
Use Step Over (F8) to continue. It should not go into tag files and handlers
Continue and reload in browser to reach breakpoint again
Use Step Into (F7) to go to tagx file. Do Step Out action. It should stop debugger at calling JSP.
Remove all breakpoints and add new breakpoints into tagx file. It must be at 'jsp:element (issue 53734).
Start debugger for jspxExample.jspx file and check whether it stops at breakpoint.

Java Libraries

SETUP: Java classes in freeform project need to be compiled with debug="true" to be available for debugging.

Add breakpoint before usage of java class from library into index.jsp (line containing 'Using java libraries')
Start debugger and wait until it stops at breakpoint
Use Step Into (F7) action to go through all java files from regular java library and freeform library. Check whether files are really opened.
Continue and reload in browser to reach breakpoint again
Use Step Over (F8) to continue. It should not go into java files
Continue and reload in browser to reach breakpoint again
Use Step Into (F7) to go to the first java file. Do Step Out action. It should stop debugger at calling JSP.
Remove all breakpoints and add new breakpoints into every java file
Start debugger and check whether it stops everytime at breakpoint.

Freeform debugging

SETUP: Unzip freeformProject.zip.

Open New Project wizard and select category 'Web' and project 'Web Application with Existing Ant Script'.
Browse to unzipped FreeformProjectExample directory.
In the next page change 'build' target to 'dist'.
In the next 'Web Sources' page type '/myapp' in the context path field.
Add both 'src-servlets' and 'src-utils' folders to the Source Package Folders list.
Finish the wizard.
Start tomcat in debugging mode - first open properties for Tomcat server in Runtime view and set 'Debugger Transport' to Socket on page Startup. Then call context menu item Start in Debug Mode.
Modify passwd property in build.xml (look at ${nbuserdir}/apache-tomcat-x.x.x_base/conf/tomcat-users.xml for current value)
Build FreeformProjectExample project.
Deploy myapp.war to Tomcat server: open Tomcat manager at http://localhost:8084/manager/html, browse for war file and click deploy button. myapp application should appear both in Tomcat manager and under server node in Runtime view (need refresh).
Add breakpoint to index.jsp, servlet and java file.
Choose 'Run|Debug Main Project' (F5) and confirm generate dialog. IDE should generate nbproject/ide-targets.xml script and debug.properties.
Check debug.properties and use appropriate ones according to your needs.
Start debugger again (F5) and check that it stops at all breakpoints. Click 'Display' and 'Current time' links to reach breakpoints in java files.
Finish debugging session.

Test suite 3: Servlet Debugging

Test case

Description

Step into/out/over servlet

SETUP: Make sure all source folders from TestFreeformLibrary are checked to be used for debugging in Sources view (Window|Debugging|Sources).

Add breakpoint to DivideServlet in package org.netbeans.test.servlets under Source Packages of MainTestApplication project
Start debugging from main menu 'Run|Run File|Debug "DivideServlet.java"' and wait until debugger stops at breakpoint
Try Step into action (F7) several times and check if it steps line by line in servlet. It should also go to Divider.java class.
Continue and reload in browser to reach breakpoint again
Try Step Out action (Ctrl+F7) and check if debugger continues.
Reload in browser to reach breakpoint again
Try Step Over action (F8) several times and check if it steps line by line in servlet. It should not dive into Divider.java file.
Finish debugging

Try actions in toolbar, main menu and shortcuts - Run|Step Over (F8), Run|Step Into (F7), Run|Step Out (Ctrl+F7)

Apply Code Changes

Add breakpoint to DivideServlet in package org.netbeans.test.servlets under Source Packages of MainTestApplication project
Start debugging from main menu 'Run|Run File|Debug "DivideServlet.java"' and wait until debugger stops at breakpoint
Change something in source code of DivideServlet.java.
Click "Apply Code Changes" toolbar button and check DivideServlet.java is saved, target debug-fix is successfully run in output window.
Continue debugging and check modified content appears in browser.
Again change something in source code of DivideServlet.java.
Click main menu item "Run|Apply Code Changes" and check DivideServlet.java is saved, target debug-fix is successfully run in output window.
Continue debugging and check modified content appears in browser.
Finish debugging.

Test suite 4: Breakpoints in JSP

Test case

Description

Toggle breakpoint

Toggle breakpoint by mouse click at left side bar in editor.
Toggle breakpoint by shortcut Ctrl+F8
Toggle breakpoint by editor's popup menu 'Toggle Breakpoint'
Toggle breakpoint in unsaved JSP.
Toggle breakpoint in unsaved JSP at last line.

RESULT: All breakpoints created.

Breakpoint group

Add several breakpoints to a JSP
Open Breakpoints view (menu item 'Window|Debugging|Breakpoints)
Select one or more breakpoints
On the selection call ' Set Group Name' from popup menu and type a name in the field
Group should be created and shown in Breakpoints view

Disable breakpoint

Add a breakpoint
Open Breakpoints view (menu item 'Window|Debugging|Breakpoints)
Disable breakpoint either from popup menu or by inline check box
Start debugger and check that it doesn't stop at breakpoint
Enable breakpoint again and reload page in browser. Debugger should stop at breakpoint

Delete breakpoint

Add a breakpoint
Open Breakpoints view (menu item 'Window|Debugging|Breakpoints)
Delete breakpoint either from popup menu or by Delete shortcut. Check whether breakpoint is removed both from editor and Breakpoints view

Customize breakpoint

Add a breakpoint
Open Breakpoints view (menu item 'Window|Debugging|Breakpoints)
Open Customize Breakpoint dialog from popup menu.
Change line number and close the dialog.
Check whether breakpoint is moved in editor.

Go to source

Add a breakpoint
Close JSP with breakpoint
Open Breakpoints view (menu item 'Window|Debugging|Breakpoints)
Double click breakpoint and JSP with breakpoint should be open in editor. Try also 'Go to source' popup.

Enable/Disable/Delete All

Add more breakpoints
Open Breakpoints view (menu item 'Window|Debugging|Breakpoints)
Disable all breakpoints from popup menu item 'Disable All'
Start debugger and check that it doesn't stop at breakpoints
Enable all breakpoints from popup menu item 'Enable All' and reload page in browser. Debugger should stop at all breakpoints
Delete all breakpoints at once by popup menu

Breakpoints at various places

SETUP: Create breakpoint at the following places:

One line JSP comment
```
<%-- --%>
```
Debugger should stop here because it is translated as '\n' into servlet.
Multi line JSP comment. Debugger stops at the last line because whole JSP comment is translated as one '\n' char
One line HTML comment
```

```
Debugger stops here because comment is also in servlet
Multi line HTML comment. Debugger stops at each line because comment is in servlet.
One line scriplet
```
<% int i = 0; %>
```

Multi line scriplet

1: <%
2:      String name = 
3:              "very long name";
4: %>

Debugger stops only at lines 2 and 4.

Page directive @page.
Taglib directive @taglib.
Custom tag.
Expression language
```
${1 + 2}
```
Use bean tag
```
jsp:bean
```

RESULT: Debugger stops at all breakpoints except ones mentioned in description.

Test suite 5: Enterprise Application Debugging

Setup: In Runtime view add Application Server which supports Enterprise Applications.

# Test case Description

Enterprise Java Beans

Create new Enterprise Application by New Project wizard (category Enterprise|Enterprise Application). In the wizard check 'Create Application Client Module' option. Do not create application in directory with space in path.
On EJBModule node call New|Session Bean context menu.
Provide a package name and finish the wizard.
Right-click in editor and choose EJB Methods|Add Business Method....
Confirm "Add Business Method..." dialog and add some code to body of the method.
On WebModule node call New|Servlet context menu.
Provide a package name and finish the wizard.
Right-click in editor and choose Enterprise Resources|Call Enterprise Bean.
In "Call Enterprise Bean" dialog choose your session bean and confirm the dialog.
Add code to call your session bean from the servlet. Add something like this lookupNewSessionBean().businessMethod(); to processRequest method.
Add breakpoint at line you just added.
Start to debug enterprise application. Just press F5 if it is main project or call Debug Project on project node.
Wait until index.jsp appears in browser. Load servlet in browser to reach breakpoint. Address should look like this http://localhost:8080/EnterpriseApplication-war/NewServlet.
Use Step Into (F7) action and check you passed through your business method.
Remove breakpoint in servlet and add new breakpoint to your business method.
Reload servlet in browser and check whether debugger stops at breakpoint.
Use Step Out action (Ctrl+F7) to return to servlet code.
Finish debugging.

Web Service

SETUP: Go to Runtime view and open properties on server node. Uncheck "Use IDE Proxy Setting" and close dialog. Then stop the server to let changes to take effect after next start.

On web application node call New|Web Service... context menu.
Provide a package name and finish the wizard.
Add operation if needed.
Add breakpoint to operation body.
Start to debug enterprise application which also deploys Enterprise Application with created web service. To do so, just press F5 if it is main project or call Debug Project on project node.
On your web service node call Test Web Service (it is available only for Java EE 5 applications).
Wait until tester page is opened in browser, type in a string and click sampleOperation button.
Check whether debugger stops at breakpoint in your operation.
Continue (Ctrl+F5).
Go back and repeat once more.
Finish debugging.

Web Service Client

On web application node call New|Web Service Client... context menu.
Browse for project.
Select your web service and confirm the dialog.
Provide a package name and finish the wizard.
On web application node call New|Servlet context menu.
Provide a package name and finish the wizard.
Right-click in editor and choose Web Service Client Resources|Call Web Service Operation....
Select operation in the dialog and click OK.
Start to debug enterprise application. Just press F5 if it is main project or call Debug Project on project node.
Wait until index.jsp appears in browser. Load servlet in browser to reach breakpoint in your operation. Address should look like this http://localhost:8080/EnterpriseApplication-war/NewServlet.
Check whether debugger stops at breakpoint in your operation.
Finish debugging.

Application Client

On EJBModule node call New|Session Bean context menu.
Provide a name, a package name, check 'Remote' option and finish the wizard.
Right-click in editor and choose EJB Methods|Add Business Method....
Confirm "Add Business Method..." dialog and add some code to body of the method.
Add breakpoint to business method.
Open Main class from application client project.
Right-click in editor and choose Enterprise Resources|Call Enterprise Bean.
In "Call Enterprise Bean" dialog choose your session bean, click Remote radio button and confirm the dialog.
Add code to call your session bean from Main class. Add something like this newSession2Bean.businessMethod(); to main method.
Add breakpoint at line you just added.
Deploy your enterprise application.
Stop application server.
Start to debug application client project. Call Debug Project on project node.
Click 'No' button in dialog asking 'Is server running in debug mode?'.
Wait until breakpoint reached at Main class.
Use Step Into (F7) action and check you passed through your business method (it doesn't go into business method because of issue 83055).
Finish debugging.

RESULT: The behaviour could change after the following issues will be resolved: 81331, 83055, 83056, 83057.

Test suite 6: Java Sources Debugging

Setup: Use Enterprise application created in previous tests.

Test case

Description

Debug Sources

Create a new Java Main class in Source Packages under EJB project.
Add line into main method and toggle breaikpoint on it.
Start to debug file using Debug File context menu.
Wait until debigger stops at breakpoint and continue debugging. It should finish.
Create a new Java Main class in Source Packages under WAR project.
Add line into main method and toggle breaikpoint on it.
Start to debug file using Debug File context menu.
Wait until debigger stops at breakpoint and continue debugging. It should finish.

Debug Tests

Create a test for main classes used in previous test case. Use Tools|Create Unit Tests context menu.
Add breakpoint to a line in test.
Start to debug file using Debug File context menu.
Wait until debigger stops at breakpoint and continue debugging. It should finish.
Repeat both for EJB and WAR projects.