Made changes to throw an exception if the dispatcher servlet is null - TRUNK-1589

wluyima · wluyima · commit 61fc1af2eabd · 2013-05-11T21:13:42.000-04:00
Fixed javadoc - TRUNK-1589
diff --git a/web/src/main/java/org/openmrs/module/web/WebModuleUtil.java b/web/src/main/java/org/openmrs/module/web/WebModuleUtil.java
@@ -106,7 +106,7 @@ public class WebModuleUtil {
 	 * value is returned. Otherwise, false is returned
 	 * 
 	 * @param mod Module to start
-	 * @param ServletContext the current ServletContext
+	 * @param servletContext the current ServletContext
 	 * @param delayContextRefresh true/false whether or not to do the context refresh
 	 * @return boolean whether or not the spring context need to be refreshed
 	 */
@@ -948,7 +948,7 @@ public static HttpServlet getServlet(String servletName) {
 	 */
 	public static String getModuleWebFolder(String moduleId) {
 		if (dispatcherServlet == null) {
-			return null;
+			throw new ModuleException("Dispatcher servlet must be present in the web environment");
 		}
 		String realPath = dispatcherServlet.getServletContext().getRealPath("");
 		String moduleWebFolder = (realPath + "WEB-INF/view/module/" + moduleId).replace("/", File.separator);
diff --git a/web/src/test/java/org/openmrs/module/web/WebModuleUtilTest.java b/web/src/test/java/org/openmrs/module/web/WebModuleUtilTest.java
@@ -22,6 +22,7 @@
 import org.mockito.stubbing.Answer;
 import org.openmrs.module.Module;
 import org.openmrs.module.ModuleConstants;
+import org.openmrs.module.ModuleException;
 import org.openmrs.web.DispatcherServlet;
 import org.powermock.api.mockito.PowerMockito;
 import org.powermock.core.classloader.annotations.PrepareForTest;
@@ -104,11 +105,11 @@ private Module buildModuleForMessageTest() {
 	 * @see WebModuleUtil#getModuleWebFolder(String)
 	 * @verifies return null if the dispatcher servlet is not yet set
 	 */
-	@Test
+	@Test(expected = ModuleException.class)
 	public void getModuleWebFolder_shouldReturnNullIfTheDispatcherServletIsNotYetSet() throws Exception {
 		//We need to do this in case it is run after getModuleWebFolder_shouldReturnTheCorrectModuleFolder 
 		WebModuleUtil.setDispatcherServlet(null);
-		assertNull(WebModuleUtil.getModuleWebFolder("basicmodule"));
+		WebModuleUtil.getModuleWebFolder("");
 	}
 	
 	/**
