Cactus 1.4.1 for J2EE API 12

Clover coverage report - Cactus 1.4.1 for J2EE API 12

Coverage timestamp: Sat Aug 31 2002 21:56:12 BST

file stats:	LOC:	229		Methods:	9
	NCLOC:	117		Classes:	1

Source file

Conditionals

Statements

Methods

TOTAL

AbstractWebTestCaller.java

50%

72.1%

100%

74.3%

 /*   Generated by AspectJ version 1.0.5 */
 package org.apache.cactus.server;
 import java.io.IOException;
 import java.io.Writer;
 import java.lang.reflect.Constructor;
 import javax.servlet.ServletException;
 import org.apache.cactus.AbstractTestCase;
 import org.apache.cactus.HttpServiceDefinition;
 import org.apache.cactus.WebTestResult;
 import org.apache.cactus.util.ClassLoaderUtils;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 /** 
  * Responsible for instanciating the <code>TestCase</code> class on the server 
  * side, set up the implicit objects and call the test method. This class 
  * provides a common abstraction for all test web requests. 
  * 
  * @author <a href="mailto:vmassol@apache.org">Vincent Massol</a> 
  * @author <a href="mailto:ndlesiecki@apache.org">Nicholas Lesiecki</a> 
  * 
  * @version $Id: AbstractWebTestCaller.java,v 1.7 2002/07/22 12:26:04 vmassol Exp $ 
  */
 public abstract class AbstractWebTestCaller {
   /** 
        * Name of the attribute in the <code>application</code> scope that will 
        * hold the results of the test. 
        */
   protected static final String TEST_RESULTS = "ServletTestRedirector_TestResults";
   /** 
        * The logger. 
        */
   private static Log LOGGER;
   /** 
        * The implicit objects (which will be used to set the test case fields 
        * in the <code>setTesCaseFields</code> method. 
        */
   protected WebImplicitObjects webImplicitObjects;
   /** 
        * @param theObjects the implicit objects coming from the redirector 
        */
   public AbstractWebTestCaller(WebImplicitObjects theObjects) {
     super();
     this.webImplicitObjects = theObjects;
   } 
   /** 
        * Sets the implicit object in the test case class 
        * 
        * @param theTestCase the instance of the test case class on which the 
        *        class variable (implicit objects) should be set 
        * @exception Exception if an errors occurs when setting the implicit 
        *            objects 
        */
   protected abstract void setTestCaseFields(AbstractTestCase theTestCase) throws Exception;
 
   /** 
        * @return a <code>Writer</code> object that will be used to return the 
        *         test result to the client side. 
        * @exception IOException if an error occurs when retrieving the writer 
        */
   protected abstract Writer getResponseWriter() throws IOException;
 
   /** 
        * Calls a test method. The parameters needed to call this method are found 
        * in the HTTP request. Save the results in the <code>application</code> 
        * scope so that the Get Test Result service can find them. 
        * 
        * @exception ServletException if an unexpected error occurred 
        */
   public void doTest() throws ServletException {
     WebTestResult result = null;
     try {
       AbstractTestCase testInstance = this.getTestClassInstance(this.getTestClassName(), 
           this.getTestMethodName());
       this.setTestCaseFields(testInstance);
       testInstance.runBareServerTest();
       result = new WebTestResult();
     } catch (Throwable e) {
       result = new WebTestResult(e);
     } 
     AbstractWebTestCaller.LOGGER.debug("Test result : [" + result + "]");
     this.webImplicitObjects.getServletContext().setAttribute("ServletTestRedirector_TestResults", 
         result);
     AbstractWebTestCaller.LOGGER.debug("Result saved in context scope");
   } 
 
   /** 
        * Return the last test results in the HTTP response. 
        * 
        * @exception ServletException if an unexpected error occurred 
        */
   public void doGetResults() throws ServletException {
     WebTestResult result = (WebTestResult)(this.webImplicitObjects.getServletContext(
         ).getAttribute("ServletTestRedirector_TestResults"));
     AbstractWebTestCaller.LOGGER.debug("Test Result = [" + result + "]");
     try {
       Writer writer = this.getResponseWriter();
       writer.write(result.toXml());
       writer.close();
     } catch (IOException e) {
       String message = "Error writing WebTestResult instance to output stream";
       AbstractWebTestCaller.LOGGER.error(message, e);
       throw new ServletException(message, e);
     } 
   } 
 
   /** 
        * Run the connection test between client and server. This is just to 
        * ensure that configuration is set up correctly. 
        * 
        * @exception ServletException if an unexpected error occurred 
        */
   public void doRunTest() throws ServletException {
   } 
 
   /** 
        * @return the class to test class name, extracted from the HTTP request 
        * @exception ServletException if the class name of the test case is missing 
        *            from the HTTP request 
        */
   protected String getTestClassName() throws ServletException {
     String queryString = this.webImplicitObjects.getHttpServletRequest().getQueryString();
     String className = ServletUtil.getQueryStringParameter(queryString, "Cactus_TestClass");
     if (className == null) {
       String message = "Missing class name parameter [Cactus_TestClass] in HTTP request.";
       AbstractWebTestCaller.LOGGER.error(message);
       throw new ServletException(message);
     } 
     AbstractWebTestCaller.LOGGER.debug("Class to call = " + className);
     return className;
   } 
 
   /** 
        * @return the class method to call for the current test case, extracted 
        *         from the HTTP request 
        * @exception ServletException if the method name of the test case is 
        *            missing from the HTTP request 
        */
   protected String getTestMethodName() throws ServletException {
     String queryString = this.webImplicitObjects.getHttpServletRequest().getQueryString();
     String methodName = ServletUtil.getQueryStringParameter(queryString, "Cactus_TestMethod");
     if (methodName == null) {
       String message = "Missing method name parameter [Cactus_TestMethod] in HTTP request.";
       AbstractWebTestCaller.LOGGER.error(message);
       throw new ServletException(message);
     } 
     AbstractWebTestCaller.LOGGER.debug("Method to call = " + methodName);
     return methodName;
   } 
 
   /** 
        * @return true if the auto session flag for the Session can be found in 
        *         the HTTP request 
        */
   protected boolean isAutoSession() {
     String queryString = this.webImplicitObjects.getHttpServletRequest().getQueryString();
     String autoSession = ServletUtil.getQueryStringParameter(queryString, 
         "Cactus_AutomaticSession");
     boolean isAutomaticSession = Boolean.valueOf(autoSession).booleanValue();
     AbstractWebTestCaller.LOGGER.debug("Auto session is " + isAutomaticSession);
     return isAutomaticSession;
   } 
 
   /** 
        * @param theClassName the name of the test class 
        * @param theTestCaseName the name of the current test case 
        * @return an instance of the test class to call 
        * @exception ServletException if the test case instance for the current 
        *            test fails to be instanciated (for example if some 
        *            information is missing from the HTTP request) 
        */
   protected AbstractTestCase getTestClassInstance(String theClassName, 
       String theTestCaseName) throws ServletException {
     Class testClass = this.getTestClassClass(theClassName);
     AbstractTestCase testInstance = null;
     try {
       Constructor constructor = testClass.getConstructor(new java.lang.Class[] {String.class});
       testInstance = (AbstractTestCase)constructor.newInstance(new java.lang.Object[] {
           theTestCaseName});
     } catch (Exception e) {
       String message = "Error instantiating class [" + theClassName + "(" + theTestCaseName + ")]";
       AbstractWebTestCaller.LOGGER.error(message, e);
       throw new ServletException(message, e);
     } 
     return testInstance;
   } 
 
   /** 
        * @param theClassName the name of the test class 
        * @return the class object the test class to call 
        * @exception ServletException if the class of the current test case 
        *            cannot be loaded in memory (i.e. it is not in the 
        *            classpath) 
        */
   protected Class getTestClassClass(String theClassName) throws ServletException {
     Class testClass = null;
     try {
       testClass = ClassLoaderUtils.loadClass(theClassName, this.getClass());
     } catch (Exception e) {
       String message = "Error finding class [" + theClassName + 
           "] using both the Context classloader and the webapp " + 
           "classloader. Possible causes include:\r\n";
       message += "\t- Your webapp does not include your test classes,\r\n";
       message += 
           "\t- The cactus.jar is not located in your WEB-INF/lib directory and your Container has not set the Context classloader to point to the webapp one";
       AbstractWebTestCaller.LOGGER.error(message, e);
       throw new ServletException(message, e);
     } 
     return testClass;
   } 
 
   /** 
    * Responsible for instanciating the <code>TestCase</code> class on the server 
    * side, set up the implicit objects and call the test method. This class 
    * provides a common abstraction for all test web requests. 
    * 
    * @author <a href="mailto:vmassol@apache.org">Vincent Massol</a> 
    * @author <a href="mailto:ndlesiecki@apache.org">Nicholas Lesiecki</a> 
    * 
    * @version $Id: AbstractWebTestCaller.java,v 1.7 2002/07/22 12:26:04 vmassol Exp $ 
    */
   static {
     /** 
          * The logger. 
          */
     AbstractWebTestCaller.LOGGER = LogFactory.getLog(AbstractWebTestCaller.class);
   } 
 
 } 

1		/* Generated by AspectJ version 1.0.5 */
2		package org.apache.cactus.server;
3		import java.io.IOException;
4		import java.io.Writer;
5		import java.lang.reflect.Constructor;
6		import javax.servlet.ServletException;
7		import org.apache.cactus.AbstractTestCase;
8		import org.apache.cactus.HttpServiceDefinition;
9		import org.apache.cactus.WebTestResult;
10		import org.apache.cactus.util.ClassLoaderUtils;
11		import org.apache.commons.logging.Log;
12		import org.apache.commons.logging.LogFactory;
13
14		/**
15		* Responsible for instanciating the <code>TestCase</code> class on the server
16		* side, set up the implicit objects and call the test method. This class
17		* provides a common abstraction for all test web requests.
18		*
19		* @author <a href="mailto:vmassol@apache.org">Vincent Massol</a>
20		* @author <a href="mailto:ndlesiecki@apache.org">Nicholas Lesiecki</a>
21		*
22		* @version $Id: AbstractWebTestCaller.java,v 1.7 2002/07/22 12:26:04 vmassol Exp $
23		*/
24		public abstract class AbstractWebTestCaller {
25		/**
26		* Name of the attribute in the <code>application</code> scope that will
27		* hold the results of the test.
28		*/
29		protected static final String TEST_RESULTS = "ServletTestRedirector_TestResults";
30		/**
31		* The logger.
32		*/
33		private static Log LOGGER;
34		/**
35		* The implicit objects (which will be used to set the test case fields
36		* in the <code>setTesCaseFields</code> method.
37		*/
38		protected WebImplicitObjects webImplicitObjects;
39		/**
40		* @param theObjects the implicit objects coming from the redirector
41		*/
42	873	public AbstractWebTestCaller(WebImplicitObjects theObjects) {
43	873	super();
44	873	this.webImplicitObjects = theObjects;
45		}
46		/**
47		* Sets the implicit object in the test case class
48		*
49		* @param theTestCase the instance of the test case class on which the
50		* class variable (implicit objects) should be set
51		* @exception Exception if an errors occurs when setting the implicit
52		* objects
53		*/
54		protected abstract void setTestCaseFields(AbstractTestCase theTestCase) throws Exception;
55
56		/**
57		* @return a <code>Writer</code> object that will be used to return the
58		* test result to the client side.
59		* @exception IOException if an error occurs when retrieving the writer
60		*/
61		protected abstract Writer getResponseWriter() throws IOException;
62
63		/**
64		* Calls a test method. The parameters needed to call this method are found
65		* in the HTTP request. Save the results in the <code>application</code>
66		* scope so that the Get Test Result service can find them.
67		*
68		* @exception ServletException if an unexpected error occurred
69		*/
70	427	public void doTest() throws ServletException {
71	427	WebTestResult result = null;
72	427	try {
73	427	AbstractTestCase testInstance = this.getTestClassInstance(this.getTestClassName(),
74		this.getTestMethodName());
75	427	this.setTestCaseFields(testInstance);
76	427	testInstance.runBareServerTest();
77	399	result = new WebTestResult();
78		} catch (Throwable e) {
79	28	result = new WebTestResult(e);
80		}
81	427	AbstractWebTestCaller.LOGGER.debug("Test result : [" + result + "]");
82	427	this.webImplicitObjects.getServletContext().setAttribute("ServletTestRedirector_TestResults",
83		result);
84	427	AbstractWebTestCaller.LOGGER.debug("Result saved in context scope");
85		}
86
87		/**
88		* Return the last test results in the HTTP response.
89		*
90		* @exception ServletException if an unexpected error occurred
91		*/
92	427	public void doGetResults() throws ServletException {
93	427	WebTestResult result = (WebTestResult)(this.webImplicitObjects.getServletContext(
94		).getAttribute("ServletTestRedirector_TestResults"));
95	427	AbstractWebTestCaller.LOGGER.debug("Test Result = [" + result + "]");
96	427	try {
97	427	Writer writer = this.getResponseWriter();
98	427	writer.write(result.toXml());
99	427	writer.close();
100		} catch (IOException e) {
101	0	String message = "Error writing WebTestResult instance to output stream";
102	0	AbstractWebTestCaller.LOGGER.error(message, e);
103	0	throw new ServletException(message, e);
104		}
105		}
106
107		/**
108		* Run the connection test between client and server. This is just to
109		* ensure that configuration is set up correctly.
110		*
111		* @exception ServletException if an unexpected error occurred
112		*/
113	19	public void doRunTest() throws ServletException {
114		}
115
116		/**
117		* @return the class to test class name, extracted from the HTTP request
118		* @exception ServletException if the class name of the test case is missing
119		* from the HTTP request
120		*/
121	427	protected String getTestClassName() throws ServletException {
122	427	String queryString = this.webImplicitObjects.getHttpServletRequest().getQueryString();
123	427	String className = ServletUtil.getQueryStringParameter(queryString, "Cactus_TestClass");
124	427	if (className == null) {
125	0	String message = "Missing class name parameter [Cactus_TestClass] in HTTP request.";
126	0	AbstractWebTestCaller.LOGGER.error(message);
127	0	throw new ServletException(message);
128		}
129	427	AbstractWebTestCaller.LOGGER.debug("Class to call = " + className);
130	427	return className;
131		}
132
133		/**
134		* @return the class method to call for the current test case, extracted
135		* from the HTTP request
136		* @exception ServletException if the method name of the test case is
137		* missing from the HTTP request
138		*/
139	427	protected String getTestMethodName() throws ServletException {
140	427	String queryString = this.webImplicitObjects.getHttpServletRequest().getQueryString();
141	427	String methodName = ServletUtil.getQueryStringParameter(queryString, "Cactus_TestMethod");
142	427	if (methodName == null) {
143	0	String message = "Missing method name parameter [Cactus_TestMethod] in HTTP request.";
144	0	AbstractWebTestCaller.LOGGER.error(message);
145	0	throw new ServletException(message);
146		}
147	427	AbstractWebTestCaller.LOGGER.debug("Method to call = " + methodName);
148	427	return methodName;
149		}
150
151		/**
152		* @return true if the auto session flag for the Session can be found in
153		* the HTTP request
154		*/
155	427	protected boolean isAutoSession() {
156	427	String queryString = this.webImplicitObjects.getHttpServletRequest().getQueryString();
157	427	String autoSession = ServletUtil.getQueryStringParameter(queryString,
158		"Cactus_AutomaticSession");
159	427	boolean isAutomaticSession = Boolean.valueOf(autoSession).booleanValue();
160	427	AbstractWebTestCaller.LOGGER.debug("Auto session is " + isAutomaticSession);
161	427	return isAutomaticSession;
162		}
163
164		/**
165		* @param theClassName the name of the test class
166		* @param theTestCaseName the name of the current test case
167		* @return an instance of the test class to call
168		* @exception ServletException if the test case instance for the current
169		* test fails to be instanciated (for example if some
170		* information is missing from the HTTP request)
171		*/
172	427	protected AbstractTestCase getTestClassInstance(String theClassName,
173		String theTestCaseName) throws ServletException {
174	427	Class testClass = this.getTestClassClass(theClassName);
175	427	AbstractTestCase testInstance = null;
176	427	try {
177	427	Constructor constructor = testClass.getConstructor(new java.lang.Class[] {String.class});
178	427	testInstance = (AbstractTestCase)constructor.newInstance(new java.lang.Object[] {
179		theTestCaseName});
180		} catch (Exception e) {
181	0	String message = "Error instantiating class [" + theClassName + "(" + theTestCaseName + ")]";
182	0	AbstractWebTestCaller.LOGGER.error(message, e);
183	0	throw new ServletException(message, e);
184		}
185	427	return testInstance;
186		}
187
188		/**
189		* @param theClassName the name of the test class
190		* @return the class object the test class to call
191		* @exception ServletException if the class of the current test case
192		* cannot be loaded in memory (i.e. it is not in the
193		* classpath)
194		*/
195	427	protected Class getTestClassClass(String theClassName) throws ServletException {
196	427	Class testClass = null;
197	427	try {
198	427	testClass = ClassLoaderUtils.loadClass(theClassName, this.getClass());
199		} catch (Exception e) {
200	0	String message = "Error finding class [" + theClassName +
201		"] using both the Context classloader and the webapp " +
202		"classloader. Possible causes include:\r\n";
203	0	message += "\t- Your webapp does not include your test classes,\r\n";
204	0	message +=
205		"\t- The cactus.jar is not located in your WEB-INF/lib directory and your Container has not set the Context classloader to point to the webapp one";
206	0	AbstractWebTestCaller.LOGGER.error(message, e);
207	0	throw new ServletException(message, e);
208		}
209	427	return testClass;
210		}
211
212		/**
213		* Responsible for instanciating the <code>TestCase</code> class on the server
214		* side, set up the implicit objects and call the test method. This class
215		* provides a common abstraction for all test web requests.
216		*
217		* @author <a href="mailto:vmassol@apache.org">Vincent Massol</a>
218		* @author <a href="mailto:ndlesiecki@apache.org">Nicholas Lesiecki</a>
219		*
220		* @version $Id: AbstractWebTestCaller.java,v 1.7 2002/07/22 12:26:04 vmassol Exp $
221		*/
222		static {
223		/**
224		* The logger.
225		*/
226	7	AbstractWebTestCaller.LOGGER = LogFactory.getLog(AbstractWebTestCaller.class);
227		}
228
229		}