test/org/apache/catalina/core/TestStandardContextValve.java - tomcat - Git at Google

 /*
  *  Licensed to the Apache Software Foundation (ASF) under one or more
  *  contributor license agreements.  See the NOTICE file distributed with
  *  this work for additional information regarding copyright ownership.
  *  The ASF licenses this file to You under the Apache License, Version 2.0
  *  (the "License"); you may not use this file except in compliance with
  *  the License.  You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  *  Unless required by applicable law or agreed to in writing, software
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  */
 package org.apache.catalina.core;

 import java.io.IOException;
 import java.util.Locale;

 import jakarta.servlet.ServletException;
 import jakarta.servlet.ServletRequestEvent;
 import jakarta.servlet.ServletRequestListener;
 import jakarta.servlet.http.HttpServlet;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;

 import org.junit.Assert;
 import org.junit.Test;

 import org.apache.catalina.Context;
 import org.apache.catalina.connector.Connector;
 import org.apache.catalina.connector.Response;
 import org.apache.catalina.startup.ExpectationClient;
 import org.apache.catalina.startup.Tomcat;
 import org.apache.catalina.startup.TomcatBaseTest;
 import org.apache.coyote.ContinueResponseTiming;
 import org.apache.tomcat.util.buf.ByteChunk;
 import org.apache.tomcat.util.descriptor.web.ErrorPage;

 public class TestStandardContextValve extends TomcatBaseTest {

     @Test
     public void testBug51653a() throws Exception {
         // Set up a container
         Tomcat tomcat = getTomcatInstance();

         // No file system docBase required
         Context ctx = getProgrammaticRootContext();

         // Traces order of events across multiple components
         StringBuilder trace = new StringBuilder();

         // Add the error page
         Tomcat.addServlet(ctx, "errorPage", new Bug51653ErrorPage(trace));
         ctx.addServletMappingDecoded("/error", "errorPage");
         // And the handling for 404 responses
         ErrorPage errorPage = new ErrorPage();
         errorPage.setErrorCode(Response.SC_NOT_FOUND);
         errorPage.setLocation("/error");
         ctx.addErrorPage(errorPage);

         // Add the request listener
         Bug51653RequestListener reqListener = new Bug51653RequestListener(trace);
         ((StandardContext) ctx).addApplicationEventListener(reqListener);

         tomcat.start();

         // Request a page that does not exist
         int rc = getUrl("http://localhost:" + getPort() + "/invalid", new ByteChunk(), null);

         // Need to allow time (but not too long in case the test fails) for
         // ServletRequestListener to complete
         int i = 40;
         while (i > 0) {
             if (trace.toString().endsWith("Destroy")) {
                 break;
             }
             Thread.sleep(250);
             i--;
         }

         Assert.assertEquals(Response.SC_NOT_FOUND, rc);
         Assert.assertEquals("InitErrorDestroy", trace.toString());
     }


     @Test
     public void testBug51653b() throws Exception {
         // Set up a container
         Tomcat tomcat = getTomcatInstance();

         // No file system docBase required
         Context ctx = getProgrammaticRootContext();

         // Traces order of events across multiple components
         StringBuilder trace = new StringBuilder();

         // Add the page that generates the error
         Tomcat.addServlet(ctx, "test", new Bug51653ErrorTrigger());
         ctx.addServletMappingDecoded("/test", "test");

         // Add the error page
         Tomcat.addServlet(ctx, "errorPage", new Bug51653ErrorPage(trace));
         ctx.addServletMappingDecoded("/error", "errorPage");
         // And the handling for 404 responses
         ErrorPage errorPage = new ErrorPage();
         errorPage.setErrorCode(Response.SC_NOT_FOUND);
         errorPage.setLocation("/error");
         ctx.addErrorPage(errorPage);

         // Add the request listener
         Bug51653RequestListener reqListener = new Bug51653RequestListener(trace);
         ((StandardContext) ctx).addApplicationEventListener(reqListener);

         tomcat.start();

         // Request a page that does not exist
         int rc = getUrl("http://localhost:" + getPort() + "/test", new ByteChunk(), null);

         // Need to allow time (but not too long in case the test fails) for
         // ServletRequestListener to complete
         int i = 40;
         while (i > 0) {
             if (trace.toString().endsWith("Destroy")) {
                 break;
             }
             Thread.sleep(250);
             i--;
         }

         Assert.assertEquals(Response.SC_NOT_FOUND, rc);
         Assert.assertEquals("InitErrorDestroy", trace.toString());
     }


     private static class Bug51653ErrorTrigger extends HttpServlet {
         private static final long serialVersionUID = 1L;

         @Override
         protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
             resp.sendError(Response.SC_NOT_FOUND);
         }
     }


     private static class Bug51653ErrorPage extends HttpServlet {
         private static final long serialVersionUID = 1L;

         private StringBuilder sb;

         Bug51653ErrorPage(StringBuilder sb) {
             this.sb = sb;
         }

         @Override
         protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
             sb.append("Error");

             resp.setContentType("text/plain");
             resp.getWriter().write("Error");
         }
     }


     private static class Bug51653RequestListener implements ServletRequestListener {

         private StringBuilder sb;

         Bug51653RequestListener(StringBuilder sb) {
             this.sb = sb;
         }

         @Override
         public void requestInitialized(ServletRequestEvent sre) {
             sb.append("Init");
         }

         @Override
         public void requestDestroyed(ServletRequestEvent sre) {
             sb.append("Destroy");
         }

     }


     @Test
     public void test100ContinueDefault() throws Exception {
         // The default setting is IMMEDIATELY
         // This test verifies that we get proper 100 Continue responses
         // when the continueResponseTiming property is not set
         test100Continue();
     }


     @Test
     public void test100ContinueSentImmediately() throws Exception {
         final Tomcat tomcat = getTomcatInstance();

         final Connector connector = tomcat.getConnector();
         connector.setProperty("continueResponseTiming", "immediately");

         test100Continue();
     }


     @Test
     public void test100ContinueSentOnRequestContentRead() throws Exception {
         final Tomcat tomcat = getTomcatInstance();

         final Connector connector = tomcat.getConnector();
         final String policyString = ContinueResponseTiming.ON_REQUEST_BODY_READ.toString().toLowerCase(Locale.ENGLISH);
         connector.setProperty("continueResponseTiming", policyString);

         test100Continue();
     }


     private void test100Continue() throws Exception {
         // Makes a request that expects a 100 Continue response and verifies
         // that the 100 Continue response is received. This does not check
         // that the correct ContinueResponseTiming was used, just
         // that a 100 Continue response is received. The unit tests for
         // Request verify that the various settings are correctly implemented.

         final Tomcat tomcat = getTomcatInstance();

         // No file system docBase required
         final Context ctx = getProgrammaticRootContext();

         Tomcat.addServlet(ctx, "echo", new EchoBodyServlet());
         ctx.addServletMappingDecoded("/echo", "echo");

         tomcat.start();

         final ExpectationClient client = new ExpectationClient();

         client.setPort(tomcat.getConnector().getLocalPort());
         // Expected content doesn't end with a CR-LF so if it isn't chunked make
         // sure the content length is used as reading it line-by-line will fail
         // since there is no "line".
         client.setUseContentLength(true);

         client.connect();

         client.doRequestHeaders();

         Assert.assertTrue(client.isResponse100());

         client.doRequestBody();
         Assert.assertTrue(client.isResponse200());
         Assert.assertTrue(client.isResponseBodyOK());
     }
 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one or more
	* contributor license agreements. See the NOTICE file distributed with
	* this work for additional information regarding copyright ownership.
	* The ASF licenses this file to You under the Apache License, Version 2.0
	* (the "License"); you may not use this file except in compliance with
	* the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/
	package org.apache.catalina.core;

	import java.io.IOException;
	import java.util.Locale;

	import jakarta.servlet.ServletException;
	import jakarta.servlet.ServletRequestEvent;
	import jakarta.servlet.ServletRequestListener;
	import jakarta.servlet.http.HttpServlet;
	import jakarta.servlet.http.HttpServletRequest;
	import jakarta.servlet.http.HttpServletResponse;

	import org.junit.Assert;
	import org.junit.Test;

	import org.apache.catalina.Context;
	import org.apache.catalina.connector.Connector;
	import org.apache.catalina.connector.Response;
	import org.apache.catalina.startup.ExpectationClient;
	import org.apache.catalina.startup.Tomcat;
	import org.apache.catalina.startup.TomcatBaseTest;
	import org.apache.coyote.ContinueResponseTiming;
	import org.apache.tomcat.util.buf.ByteChunk;
	import org.apache.tomcat.util.descriptor.web.ErrorPage;

	public class TestStandardContextValve extends TomcatBaseTest {

	@Test
	public void testBug51653a() throws Exception {
	// Set up a container
	Tomcat tomcat = getTomcatInstance();

	// No file system docBase required
	Context ctx = getProgrammaticRootContext();

	// Traces order of events across multiple components
	StringBuilder trace = new StringBuilder();

	// Add the error page
	Tomcat.addServlet(ctx, "errorPage", new Bug51653ErrorPage(trace));
	ctx.addServletMappingDecoded("/error", "errorPage");
	// And the handling for 404 responses
	ErrorPage errorPage = new ErrorPage();
	errorPage.setErrorCode(Response.SC_NOT_FOUND);
	errorPage.setLocation("/error");
	ctx.addErrorPage(errorPage);

	// Add the request listener
	Bug51653RequestListener reqListener = new Bug51653RequestListener(trace);
	((StandardContext) ctx).addApplicationEventListener(reqListener);

	tomcat.start();

	// Request a page that does not exist
	int rc = getUrl("http://localhost:" + getPort() + "/invalid", new ByteChunk(), null);

	// Need to allow time (but not too long in case the test fails) for
	// ServletRequestListener to complete
	int i = 40;
	while (i > 0) {
	if (trace.toString().endsWith("Destroy")) {
	break;
	}
	Thread.sleep(250);
	i--;
	}

	Assert.assertEquals(Response.SC_NOT_FOUND, rc);
	Assert.assertEquals("InitErrorDestroy", trace.toString());
	}


	@Test
	public void testBug51653b() throws Exception {
	// Set up a container
	Tomcat tomcat = getTomcatInstance();

	// No file system docBase required
	Context ctx = getProgrammaticRootContext();

	// Traces order of events across multiple components
	StringBuilder trace = new StringBuilder();

	// Add the page that generates the error
	Tomcat.addServlet(ctx, "test", new Bug51653ErrorTrigger());
	ctx.addServletMappingDecoded("/test", "test");

	// Add the error page
	Tomcat.addServlet(ctx, "errorPage", new Bug51653ErrorPage(trace));
	ctx.addServletMappingDecoded("/error", "errorPage");
	// And the handling for 404 responses
	ErrorPage errorPage = new ErrorPage();
	errorPage.setErrorCode(Response.SC_NOT_FOUND);
	errorPage.setLocation("/error");
	ctx.addErrorPage(errorPage);

	// Add the request listener
	Bug51653RequestListener reqListener = new Bug51653RequestListener(trace);
	((StandardContext) ctx).addApplicationEventListener(reqListener);

	tomcat.start();

	// Request a page that does not exist
	int rc = getUrl("http://localhost:" + getPort() + "/test", new ByteChunk(), null);

	// Need to allow time (but not too long in case the test fails) for
	// ServletRequestListener to complete
	int i = 40;
	while (i > 0) {
	if (trace.toString().endsWith("Destroy")) {
	break;
	}
	Thread.sleep(250);
	i--;
	}

	Assert.assertEquals(Response.SC_NOT_FOUND, rc);
	Assert.assertEquals("InitErrorDestroy", trace.toString());
	}


	private static class Bug51653ErrorTrigger extends HttpServlet {
	private static final long serialVersionUID = 1L;

	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
	resp.sendError(Response.SC_NOT_FOUND);
	}
	}


	private static class Bug51653ErrorPage extends HttpServlet {
	private static final long serialVersionUID = 1L;

	private StringBuilder sb;

	Bug51653ErrorPage(StringBuilder sb) {
	this.sb = sb;
	}

	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
	sb.append("Error");

	resp.setContentType("text/plain");
	resp.getWriter().write("Error");
	}
	}


	private static class Bug51653RequestListener implements ServletRequestListener {

	private StringBuilder sb;

	Bug51653RequestListener(StringBuilder sb) {
	this.sb = sb;
	}

	@Override
	public void requestInitialized(ServletRequestEvent sre) {
	sb.append("Init");
	}

	@Override
	public void requestDestroyed(ServletRequestEvent sre) {
	sb.append("Destroy");
	}

	}


	@Test
	public void test100ContinueDefault() throws Exception {
	// The default setting is IMMEDIATELY
	// This test verifies that we get proper 100 Continue responses
	// when the continueResponseTiming property is not set
	test100Continue();
	}


	@Test
	public void test100ContinueSentImmediately() throws Exception {
	final Tomcat tomcat = getTomcatInstance();

	final Connector connector = tomcat.getConnector();
	connector.setProperty("continueResponseTiming", "immediately");

	test100Continue();
	}


	@Test
	public void test100ContinueSentOnRequestContentRead() throws Exception {
	final Tomcat tomcat = getTomcatInstance();

	final Connector connector = tomcat.getConnector();
	final String policyString = ContinueResponseTiming.ON_REQUEST_BODY_READ.toString().toLowerCase(Locale.ENGLISH);
	connector.setProperty("continueResponseTiming", policyString);

	test100Continue();
	}


	private void test100Continue() throws Exception {
	// Makes a request that expects a 100 Continue response and verifies
	// that the 100 Continue response is received. This does not check
	// that the correct ContinueResponseTiming was used, just
	// that a 100 Continue response is received. The unit tests for
	// Request verify that the various settings are correctly implemented.

	final Tomcat tomcat = getTomcatInstance();

	// No file system docBase required
	final Context ctx = getProgrammaticRootContext();

	Tomcat.addServlet(ctx, "echo", new EchoBodyServlet());
	ctx.addServletMappingDecoded("/echo", "echo");

	tomcat.start();

	final ExpectationClient client = new ExpectationClient();

	client.setPort(tomcat.getConnector().getLocalPort());
	// Expected content doesn't end with a CR-LF so if it isn't chunked make
	// sure the content length is used as reading it line-by-line will fail
	// since there is no "line".
	client.setUseContentLength(true);

	client.connect();

	client.doRequestHeaders();

	Assert.assertTrue(client.isResponse100());

	client.doRequestBody();
	Assert.assertTrue(client.isResponse200());
	Assert.assertTrue(client.isResponseBodyOK());
	}
	}