Taken care of trailing slash depending on if it is included or not which depends on the servlet container's Implementation of ServletContext.getRealPath - TRUNK-1859

wluyima · wluyima · commit 965c09d325fb · 2013-05-11T23:48:58.000-04:00
diff --git a/web/src/main/java/org/openmrs/module/web/WebModuleUtil.java b/web/src/main/java/org/openmrs/module/web/WebModuleUtil.java
@@ -945,13 +945,24 @@ public static HttpServlet getServlet(String servletName) {
 	 * @return a path to a folder that stores web files or null if not in a web environment
 	 * @should return the correct module folder
 	 * @should return null if the dispatcher servlet is not yet set
+	 * @should return the correct module folder if real path has a trailing slash
 	 */
 	public static String getModuleWebFolder(String moduleId) {
 		if (dispatcherServlet == null) {
 			throw new ModuleException("Dispatcher servlet must be present in the web environment");
 		}
+		
+		String moduleFolder = "WEB-INF/view/module/";
 		String realPath = dispatcherServlet.getServletContext().getRealPath("");
-		String moduleWebFolder = (realPath + "WEB-INF/view/module/" + moduleId).replace("/", File.separator);
+		String moduleWebFolder;
+		if (realPath.endsWith("/"))
+			moduleWebFolder = realPath + moduleFolder;
+		else
+			moduleWebFolder = realPath + "/" + moduleFolder;
+		
+		moduleWebFolder += moduleId;
+		moduleWebFolder.replace("/", File.separator);
+		
 		return moduleWebFolder;
 	}
 	
diff --git a/web/src/test/java/org/openmrs/module/web/WebModuleUtilTest.java b/web/src/test/java/org/openmrs/module/web/WebModuleUtilTest.java
@@ -118,22 +118,40 @@ public void getModuleWebFolder_shouldReturnNullIfTheDispatcherServletIsNotYetSet
 	 */
 	@Test
 	public void getModuleWebFolder_shouldReturnTheCorrectModuleFolder() throws Exception {
+		setupMocks(false);
+		String moduleId = "basicmodule";
+		String expectedPath = (REAL_PATH + "/WEB-INF/view/module/" + moduleId).replace("/", File.separator);
+		String actualPath = WebModuleUtil.getModuleWebFolder(moduleId);
+		
+		assertEquals(expectedPath, actualPath);
+	}
+	
+	/**
+	 * @see WebModuleUtil#getModuleWebFolder(String)
+	 * @verifies return the correct module folder if real path has a trailing slash
+	 */
+	@Test
+	public void getModuleWebFolder_shouldReturnTheCorrectModuleFolderIfRealPathHasATrailingSlash() throws Exception {
+		setupMocks(true);
+		String moduleId = "basicmodule";
+		String expectedPath = (REAL_PATH + "/WEB-INF/view/module/" + moduleId).replace("/", File.separator);
+		String actualPath = WebModuleUtil.getModuleWebFolder(moduleId);
+		
+		assertEquals(expectedPath, actualPath);
+	}
+	
+	private static void setupMocks(boolean includeTrailingSlash) {
 		ServletConfig servletConfig = mock(ServletConfig.class);
 		
 		ServletContext servletContext = mock(ServletContext.class);
-		when(servletContext.getRealPath("")).thenReturn(REAL_PATH);
+		String realPath = (includeTrailingSlash) ? REAL_PATH + "/" : REAL_PATH;
+		when(servletContext.getRealPath("")).thenReturn(realPath);
 		
 		DispatcherServlet dispatcherServlet = mock(DispatcherServlet.class);
 		when(dispatcherServlet.getServletConfig()).thenReturn(servletConfig);
 		when(dispatcherServlet.getServletContext()).thenReturn(servletContext);
 		
 		WebModuleUtil.setDispatcherServlet(dispatcherServlet);
-		
-		String moduleId = "basicmodule";
-		String expectedPath = (REAL_PATH + "WEB-INF/view/module/" + moduleId).replace("/", File.separator);
-		String actualPath = WebModuleUtil.getModuleWebFolder(moduleId);
-		
-		assertEquals(expectedPath, actualPath);
 	}
 	
 }
