JSP Editor Test Specification

Author: Jindrich Sedek
Version: 1.8
Last update: 14.06.2006
Introduction: This document contains procedures for testing JSP editor. The module provides syntax highlighting, indentation, code completion, tag matching, various settings and some more functionality in editor.
Comment: The test specification does not cover JSP documents in XML syntax (*.jspx files).

Table of Contents

• 1. Syntax highlighting
• 2. Indentation
• 3. Code completion
• 4. Code folding
• 5. Expression language
• 6. Miscellaneous
• 7. Internationalization
• 8. Development
• 9. Settings

Test suite 1: Syntax highlighting Purpose: This test suite checks that syntax highlighting in JSP editor is correct. Setup: No preparation is necessary for this test suite. # Test case Description 1 JSP syntax highlighting Use File | New Project... to create new Web Application project located in your home directory. Right click Libraries node and select Add Library.... Select JSTL 1.1 library and click Add Library button. Replace contents of index.jsp with this file and compare the colors with this picture. RESULT: Proper colors should be used. See ui specification test / JSPColoringTest.java 2 TAG syntax highlighting Right click Web Pages node and select New | File/Folder.... Select Web category and Tag File file type and press Next >. Setup test as Tag File Name and press Finish. Replace contents of test.tag with this file and compare the colors with this picture. RESULT: Tag file editor supports exactly the same syntax color highlighting as JSP editor. See previous test case.

Test suite 2: Indentation Purpose: This test suite checks that auto indentation in JSP editor is working correctly. Setup: No preparation is necessary for this test suite except having web project open with one JSP and one tag file. # Test case Description 1 Basic indentation Place the cursor at end of index.jsp or test.tag file and press Enter. Press Tab and type <a>| where | denotes cursor. End tag </a> should be completed by editor. Press Enter. New line is created and cursor is indented two TABs right (i.e. 22:9). RESULT: New line is created and cursor inherits column position of text at previous line. In this case it will be two TABs size indented to right i.e. 22:9. 2 Reformat code In both index.jsp or test.tag editors press CTRL+A. Press Shift+TAB at least 3 times so that whole text is shifted to left. Right click in editor area and select Reformat Code from popup menu. Select a piece of code and press Shift+Tab few times to break the code formating again. Change the selection to another lines and repeat step 3. RESULT: The whole source code is reformated according to JSP indentation engine settings. By default, everything inside an element is shifted one TAB to right. test / JSPFormatterTest.java ; testReformatSample1() 3 Scriptlets indentation Type <% somewhere in both index.jsp and test.tag files to create a scriptlet block. Type if (true) { and press Enter. Type switch (age) { and press Enter. Type case 10: and press Enter. Type a = b; and press Enter. Type default: and press Enter. Type sayHello(); Press Arrow Down twice and type %> to close the scriptlet. RESULT: Java code should follow Java indentation engine settings. By default, everything inside { } block or below any line ending with : character should be shifted one TAB to right. On the other hand pressing } should shift current line to left. Here you can see how it should look like: test / JSPFormatterTest.java ; testReformatSample2()

Test suite 3: Code completion Purpose: This test suite checks that automatic code completion in JSP editor is working correctly. Setup: No preparation is necessary for this test suite except having web project open with one JSP and one tag file. # Test case Description 1 Directives Open index.jsp page and type somewhere in the code <%@. Wait 500 ms or press CTRL+Space to invoke code completion. 3 directives must be offered: include, page and taglib. Repeat steps 1 and 2 but with test.tag tag file this time. RESULT: 5 directives must be offered in tag files: attribute, include, tag, taglib and variable. test / testDirectivesBasic.jsp 2 Attributes Type <%@page | in index.jsp file and invoke code completion. 13 attributes should be offered initially. Type i which should reduce the list to 5 items including import. Press Enter. Now you should have <%@page import="|" in the JSP editor. Repeat steps 1 and 2 in test.tag file with <%@tag | directive. RESULT: Code completion must offer relevant attributes for directives based on file type and context - used attributes are not suggested again. Specifically, autoFlush, buffer, contentType, errorPage, extends, import, info, isELIgnored, isErrorPage, isThreadSafe, language, pageEncoding and session for page directive and body-content, description, display-name, dynamic-attributes, example, import, isELIgnored, large-icon, language, pageEncoding and small-icon for tag directive. test / testDirectivesBasic.jsp 3 Values Type <%@page isELIgnored="|"%> in index.jsp and press CTRL+Space. Two options false and true will be suggested. Press Enter to select the first one. Repeat steps 1 and 2 in test.tag file with <%@tag isELIgnored="|"%>. RESULT: Where appropriate (i.e. set of attribute values is limited) these values should be offered by code completion. test / testDirectivesBasic.jsp 4 Entities Type & and wait for code completion or press CTRL+Space. A long list of items will be suggested. Type q character. This should reduce the list to only 1 suggestion &quot;. Press Enter. RESULT: &quot; should be automatically completed. test / testHTML.jsp 5 Page encoding Type <%@page pageEncoding="|"%> in index.jsp and press CTRL+Space. List of all known encodings will show up. Type K which reduces the list to KOI8-R and KOI8-U. Press Enter to select the first one. Repeat steps 1 and 3 in test.tag file with <%@tag pageEncoding="|"%>. RESULT: Auto completion must suggest all possible character encodings in both JSP and Tag editors. test / testDirectivesBasic.jsp 6 Import Type <%@page import="|"%> in index.jsp and press CTRL+Space. Four root packages should be offered initially: com, java, javax and org. Type o, press Enter and type . char. Now you should have <%@page import="org.|"%>. Press CTRL+Space again. This way use code completion to import e.g. org.xml.sax.SAXException class. Repeat the same in test.tag file with <%@tag import="|"%>. RESULT: Auto completion must help with selecting any j2se or j2ee package or class as value of import attribute. test / testDirectivesAdvanced.jsp 7 Include Type <%@include file="|"%> in test.tag and press CTRL+Space. Only two items show up: ../ and test.tag. Type / char. Completion suggests META-INF/, WEB-INF/ and index.jsp. Press Enter and CTRL+Space. Now you should have <%@include file="/META-INF/context.xml|"%> Repeat the same in index.jsp file with <jsp:include page="|"%>. RESULT: Code completion allows to select any file as value of file attribute. If path starts with / char, completion should offer files in document root directory (i.e. Web Pages node) whereas path without leading / offers files from the same directory as edited file initially. test / testDirectivesAdvanced.jsp 8 Scriptlets Type <% String var; var.| somewhere in both index.jsp and test.tag files. Press CTRL+Space. Appropriate fields and methogs of java.lang.String class must be suggested. Type %> <!-- comment --> <% var.| to close the scriptlet and start another one. Repeat step 2. Type %> <% "hello".| and press CTRL+Space again. Repeat step 2. Type %> <% | and press CTRL+Space again. RESULT: Implicit objects application, config, out, page, pageContext, request, response and session will show up. Besides normal Java code completion must be provided inside scriptlets. Declared variables must be available across more scriptlet blocks. test / testScriptletsImplicitObjects.jsp, testScriptletsJavaBasic.jsp 9 HTML tags Type < char somewhere in both index.jsp and test.tag files. Press CTRL+Space to invoke code completion. Type ht which should narrow selection only to 1 item. Press Enter. This should auto complete <html> tag. Verify that other HTML tags and their appropriate attributes are available in code completion. RESULT: Code completion offers all HTML tags like <body>, <table>, <form> etc. test / testHTML.jsp 10 JSP tags Type <jsp:| in both index.jsp and press CTRL+Space. The following JSP tags are offered by default: attribute, body, element, expression, fallback, forward, getProperty, include, param, params, plugin, setProperty, text and useBean. Repeat step 1 in test.tag file editor. RESULT: The same set of JSP tags is offered in tag file editor plus two more tags: doBody and invoke. test / testJSPElements.jsp 11 Implicit objects Type <% response.| somewhere in both index.jsp and test.tag files and press CTRL+Space. Code completion offers relevant fields and methods of javax.servlet.http.HttpServletResponse class. In both files replace response by session.getServletContext().| and press CTRL+Space again. RESULT: Code completion offers relevant fields and methods of javax.servlet.ServletContext class. test / testScriptletsImplicitObjects.jsp, testScriptletsJavaOther.jsp 12 Java beans Type <jsp:useBean id="myDate" scope="request" class="| in both index.jsp and test.tag files and press CTRL+Space. Java packages and classes will be offered. Use code completion to select java.util.Date and finish the tag by "/>. Type <% myD| and press CTRL+Space. myDate will be automatically completed. Type . and press CTRL+Space. RESULT: Code completion offers all fields and methods of java.util.Date class. test / testJSPElements.jsp 13 Declarations Type <%! | in both index.jsp and test.tag files and press CTRL+Space. Java packages and classes will be offered except implicit objects. Type void hello() { this.| and press CTRL+Space. RESULT: Code completion offers only appropriate fields and methods of servlet i.e. no packages or classes or implicit objects. test / testScriptletsJavaBasic.jsp 14 Expressions Type <%= re| in both index.jsp and test.tag files and press CTRL+Space. Both request and response are suggested. Press Enter and type . Press CTRL+Space to invoke code completion. RESULT: Code completion offers relevant fields and methods of javax.servlet.http.HttpServletRequest class. test / testScriptletsJavaOther.jsp 15 Library tags Right click Web Pages node and select New | File/Folder.... Select Web category and Tag Library Descriptor... file type and press Next >. Setup library as TLD Name and press Finish. Repeat steps 1 and 2 but select Tag File as file type. Setup example as Tag File Name and check Add Tag File to Tag Library Descriptor option. Use Browse button to select WEB-INF/tlds/library.tld as TLD File and push Finish. In example.tag delete lines 9 and 13 to uncomment declaration of attributes. Press CTRL+S. Type <%@taglib prefix="ex" uri="/WEB-INF/tlds/library.tld"%> in index.jsp. Type <ex| somewhere below and press CTRL+Space. It will get expanded to <ex:example|. Press Space and CTRL+Space. RESULT: Code completion offers three attributes title, author and price_info declared in example.tag tag file. test / testDirectivesAdvanced.jsp 16 Help window Type <%@| and press CTRL+Space. Code completion will show up together with help window. Use arrows to browse through items. Verify that help window displays appropriate description for selected directive. Press Esc. Press CTRL+Shift+Space which will open help window only. Press Shift+Arrow Down which will scroll down the contents of help window. Verify that help window is available for all JSP, custom or HTML tags and their attributes. RESULT: Help window is opened on each code completion invocation or alone if needed. The contents must be scrollable.

Test suite 4: Code folding Purpose: This test suite checks that code folding in JSP editor is working correctly. Setup: No preparation is necessary for this test suite except having web project open with one JSP and one tag file. test / JspFoldingTest.java # Test case Description 1 Folds creation Open JSP document created in the first test suite. Type <%! String getBestIDE() { return "NetBeans 5.5"; } %> somewhere into JSP body. RESULT: Code folds must be created for all tags occupying more than one line and JSP/HTML comments. Besides, also each directive/scriptlet/declaration section has one fold. 2 Folds collapsing Put cursor somewhere into JSP document and press CTRL+NumPad-. Verify that current tag fold was collapsed. Right click editor area and select Code Folds | Collapse Fold from popup menu. RESULT: Code folds must get collapsed/expanded on appropriate demand via shortcut, menu or mouse click. Collapsed fold is represented by [+] icon and expanded by [-] icon in the stripe next to line numbers. Besides, collapsed fold is replaced by rectangle with appropriate identification e.g. <%@...%> in case of directives. If user moves mouse over the box, window with content of tag fold is displayed. 3 Folds actions Press CTRL+Shift+NumPad- to collapse all folds in JSP document. Invoke View | Code Folds | Expand All from main menu to see whole file again. Right click in editor and choose Code Folds | Collapse All Comments from popup menu. RESULT: All multiline tags or JSP/HTML comments should be collapsed/expanded on appropriate demand. Comment: Test all 3 test cases both in index.jsp and test.tag files.

Test suite 5: Expression language Purpose: This test suite checks that expression language support provides code completion, syntax highlighting and hyperlinking. Setup: No preparation is necessary for this test suite except having web project open with one JSP file. # Test case Description 1 Basic code completion Create new el.jsp JSP file and type <jsp:useBean id="integer" class="java.lang.Integer" scope="page"/> at line 11 and ${ at next new line. Press CTRL+Space to invoke code completion. Type i to reduce suggestions to two items. Select initParam and press Enter. The statement gets expanded to ${initParam[] and cursor remains between square brackets. Press CTRL+Z twice to undo previous usage of completion. Press CTRL+Space again and select pageContext item. In ${pageContext type . (dot). Code completion shows up automatically. Type r, select response and press Enter. RESULT: The statement is expanded to ${pageContext.response test / testExpression.jsp 2 Other code completion Right click your web project root node and select Properties from popup menu. Select Frameworks category node and click Add.... Select Java Server Faces and push OK button twice. Invoke File|New File... from main menu. Select Web category, JSF Managed Bean file type and push Next >. Type inquiry (with lower case i) into Class Name and Finish buttons. Expand inquiry.java and inquiry nodes. Right click Bean Patterns and select Add|Property from popup menu. Type name to Name field and push OK. Right click Methods and select Add Method... from popup menu. Setup Return Type to String and push OK. Switch to el.jsp editor tab, create new line and type #{i| . Press CTRL+Space. The new JSF bean must be one of the three suggested items. Select inquiry and press Enter. Type . (dot). Code completion shows up automatically suggesting name property and newMethod method. Type <%@taglib uri="http://java.sun.com/jsp/jstl/functions" prefix="f"%> at line 12 and ${f:c at next new line. Press CTRL+Space. RESULT: Code completion offers all functions defined in JSTL tag library starting with c char. test / testExpression.jsp test taglib / testDirectivesBasic.jsp

Test suite 6: Miscellaneous Purpose: This test suite checks that tag matching, hyperlinking and some other small features are working correctly. Setup: No preparation is necessary for this test suite except having web project open with one JSP and one tag file. # Test case Description 1 Tag matching Place cursor behind some opening tag e.g. <head> at line 6. Matching end tag (at line 8 in this case) should be highlighted in purple color. Press CTRL+[ which must move cursor to the </head> closing tag at line 8. Press CTRL+A and Delete in both index.jsp and test.tag files and type there what you see in the following picture. Verify that matching for all tags and brackets works. RESULT: When cursor is placed in opening tag, editor highlights corresponding closing tag and vice versa. Besides, it is possible to jump between them via CTRL+[ shortcut. 2 Hyperlinking Hold down CTRL key and move your mouse pointer on WEB-INF/web.xml at line 2. It will change to hyperlink WEB-INF/web.xml. Click it. Deployment descriptor web.xml will be opened in editor. Switch back to index.jsp. Type <jsp:forward page="WEB-INF/tags/example.tag"/> somewhere in index.jsp. Use this new hyperlink to get to example.tag file. Type <jsp:include page="../../index.jsp"/> somewhere in example.tag. Use this new hyperlink to get back to index.jsp file. Hold down CTRL key and move your mouse pointer on ex:example custom tag. Click the hyperlink. RESULT: JSP/Tag editor allows by CTRL key to quickly jump to files referenced in the source. 3 Go to source Type <% String str; %> somewhere in the editor of index.jsp. Hold down CTRL and move your mouse pointer on String. It should change to hyperlink and you can click it. RESULT: New editor window with source code of String class should be opened. 4 Go to declaration Type <% if (str="") str="HALLO WORLD!"; %> on the last line of index.jsp . Hold down CTRL and move your mouse pointer on str . It should change to hyperlink and you can click it. RESULT: The focus should be moved to the declaration of str. 5 Abbreviations Invoke Tools | Options from main menu, click Advanced Options and select Editing | Editor Settings | JSP Editor node. Click ... button of Abbreviations to invoke it's customizer. Click Add..., type ext as Abbreviation and <ex:example title=" as Expansion. Push OK button twice and Close. Press Enter to create new line, type ext and press Space. It is replaced by <ex:example title=". Verify that tglb gets expanded to <%@taglib uri=""%>. RESULT: Editor allows to use predefined and user specified abbreviations in both index.jsp and test.tag files.

Test suite 7: Internationalization Purpose: This test suite checks that it is possible to use national characters in JSP editor. Setup: No preparation is necessary for this test suite except having web project open with one JSP and one tag file. # Test case Description 1 Attribute pageEncoding Type <%@page pageEncoding="ISO-8859-2"%> as the first line in both index.jsp and test.tag. Extend the page tag with info attribute and use some Czech characters in its value e.g.: Save the file. Close it and Open again. RESULT: National characters are preserved in JSP file if pageEncoding attribute is set accordingly. 2 Attribute contentType Use contentType="text/html;charset=ISO-8859-2" instead of pageEncoding="ISO-8859-2" in both index.jsp and test.tag files. Do not modify info attribute and Save the file. Close it and Open again. RESULT: National characters are preserved in JSP file if contentType attribute is set accordingly. 3 Invalid encoding Replace ISO-8859-2 with ASCII and press CTRL+S. Warning about possible loss of used characters will show up. Press No. Change the charset to invalid ASCIII and press CTRL+S again. Similar warning will show up proposing to save the file using UTF-8 encoding. Press Yes. Close the file and Open it again. Question about unknown ASCIII encoding will show up proposing to open file using UTF-8. Press Yes. Delete whole contentType attribute with its value but leave the info one with Czech characters. Press CTRL+S. Similar dialog as in step 4 will open but proposing default ISO-8859-1 encoding this time. RESULT: JSP editor warns user if document contains characters that are not contained in specified encoding. Besides, it suggests to use UTF-8 if unknown charset is declared or ISO-8859-1 if no charset is given at all.

Test suite 8: Development Purpose: This test suite checks that it is possible to compile JSP, run it, view its servlet or errors. Setup: No preparation is necessary for this test suite except having web project open with one JSP and one tag file. # Test case Description 1 Compile JSP Use File | New File... to create new test.jsp JSP file. Replace its content with this file. Right click Libraries node and select Add Library.... Select JSTL 1.1 and press Add Library button. Right click editor area of test.jsp and select Run File. RESULT: The test.jsp file gets compiled, Tomcat is started and once the web application is deployed successfully new browser window opens with Example JSP title and current date printed. 2 View servlet Right click editor area of test.jsp and select View Servlet. RESULT: Appropriate servlet file opens in editor. In this case it is test_jsp.java located in your home Tomcat subdirectory by default. 3 Errors reporting Replace content of test.jsp file with this file. It contains 8 errors in total. Invoke Build | Compile "test.jsp" from main menu or press F9 key. Complain about unterminated page tag will show up in the output window. Click the ...WebApplication1/build/web/test.jsp(2,0) link which takes the cursor to line 2. Correct the error and repeat step 2. Go after each error and fix it according to hints mentioned in the comment above the error line. Once you are done with all errors, right click editor area and select Run File. RESULT: JSP editor supports error annotations and compile action offers links to appropriate lines in output window. Errors are displayed in status bar and tooltips on particular lines. In the end browser will open with Example JSP title and current date.

Test suite 9: Settings Purpose: This test suite checks that JSP editor specific settings are working correctly and are persistent. Setup: No preparation is necessary for this test suite except having web project open with one JSP and one tag file. # Test case Description 1 Folding switch Invoke Tools | Options from main menu. Select Editor category in the left panel. Uncheck Use Code Folding option. Push OK button. RESULT: An extra stripe for folding widgets gets removed and code can't be folded. 2 Completion options Invoke Tools | Options from main menu. Select Editor category in the left panel. Uncheck Auto Popup Completion Window, Insert Single Proposals Automatically and Case Sensitive Code Completion options. Push OK button. Type < which does not invoke code completion. Type j and press CTRL+Space. Code completion suggests all 14 jsp: tags. Press ESC and type <jsp:u. Press CTRL+Space again. RESULT: Code completion offers single item jsp:useBean and does not perform instant substitution. 3 Indentation Invoke Tools | Options from main menu. Select Editor category in the left panel and Indentation tab. Set Number of Spaces per Indent to 2 and click OK button. Invoke File | Exit from main menu and restart NetBeans. Right click editor area and choose Reformat Code from popup menu. RESULT: Content of index.jsp file is reformated according to new indentation i.e. content of each tag is indented two spaces right.

---

Generated: 2006 07 20 09:04