package com.ziesemer.utils.web;
   
   import java.io.IOException;
   import java.io.InputStream;
   import java.net.HttpURLConnection;
   import java.net.URL;
   import java.util.HashSet;
   import java.util.Iterator;
   import java.util.Set;
  
  import org.junit.After;
  import org.junit.AfterClass;
  
  import com.ziesemer.utils.junit.BaseTest;
  
  /**
   * @author Mark A. Ziesemer
   * 	<a href="http://www.ziesemer.com.">&lt;www.ziesemer.com&gt;</a>
   */
  public class BaseWebTest extends BaseTest{
  	
  	protected static ZipServletTestSupport ZSTS;
  	
  	protected Set<HttpURLConnection> connections = new HashSet<HttpURLConnection>();
  	
  	@AfterClass
  	public static void afterClass() throws Exception{
  		if(ZSTS != null){
  			ZSTS.close();
  			ZSTS = null;
  		}
  	}
  	
  	/**
  	 * Read everything remaining in streams before closing to eliminate server-side warnings.  Otherwise:
  	 * <ul>
  	 * <li>One issue is that Jetty, at least if using blocking connectors, will throw an
  	 * 	{@link InterruptedException} (logged as a warning) while still trying to write data if the client
  	 * 	closes its connection before reading everything.</li>
  	 * <li>Another issue in {@link com.ziesemer.utils.web.zipServlet.ZipServletConfigTests} is that a
  	 * 		non-thread-safe call to {@link javax.servlet.http.HttpServlet#destroy()} is called with the
  	 * 		next call to {@link com.ziesemer.utils.web.zipServlet.ZipServletConfigTests#resetServletHandler},
  	 * 		and then {@link com.ziesemer.utils.web.zipServlet.ZipServlet} attempts to continue to read
  	 * 		from a closed {@link java.util.zip.ZipFile}.</li>
  	 * </ul>
  	 */
  	@After
  	public void emptyAndCloseOpenConnections() throws Exception{
  		logger.debug("Finishing reading streams...");
  		final byte[] buffer = new byte[1 << 12];
  		long readTotal = 0;
  		int connectionsTotal = 0;
  		for(final Iterator<HttpURLConnection> iter = connections.iterator(); iter.hasNext();){
  			final HttpURLConnection huc = iter.next();
  			iter.remove();
  			long readConnection = 0;
  			try{
  				// TODO: Should check the getErrorStream() here as well, but there should currently be no
  				// 	need for it within the current tests, and it currently results in a hang when read on a
  				// 	HTTP 404 response - at least with the current version of Jetty.
  				if(huc.getResponseCode() == HttpURLConnection.HTTP_OK){
  					final InputStream is = huc.getInputStream();
  					try{
  						int read;
  						while((read = is.read(buffer)) >= 0){
  							readConnection += read;
  							readTotal += read;
  						}
  					}catch(final IOException ioe){
  						if(readConnection == 0){
  							// Java 5, 6, and 7 don't have a problem re-reading from a closed HttpURLConnection.getInputStream().
  							// However, Java 8 throws a "stream is closed" IOException - with no other way currently available to
  							//   determine if it is already closed or not.
  						}else{
  							throw ioe;
  						}
  					}finally{
  						is.close();
  					}
  				}
  			}finally{
  				huc.disconnect();
  			}
  			connectionsTotal++;
  		}
  		logger.debug("Finished reading {} bytes from {} connections.", readTotal, connectionsTotal);
  	}
  	
  	protected HttpURLConnection getTestConnection() throws Exception{
  		return getTestConnection("/" + ZipServletTestSupport.TEST_SINGLE_PATH);
  	}
  	
  	protected HttpURLConnection getTestConnection(final String href) throws Exception{
  		final HttpURLConnection huc = (HttpURLConnection)new URL(
  			ZSTS.getBaseUrl() + ZipServletTestSupport.PREFIX + href).openConnection();
  		connections.add(huc);
  		return huc;
  	}
  	
 }