--- /dev/null
+/*
+ * 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.startup;
+
+import java.io.BufferedInputStream;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.PrintWriter;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.util.List;
+import java.util.Map;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import static org.junit.Assert.fail;
+
+import org.junit.After;
+import org.junit.Before;
+
+import org.apache.catalina.LifecycleState;
+import org.apache.catalina.connector.Connector;
+import org.apache.catalina.core.AprLifecycleListener;
+import org.apache.catalina.core.StandardServer;
+import org.apache.catalina.valves.AccessLogValve;
+import org.apache.tomcat.util.buf.ByteChunk;
+
+/**
+ * Base test case that provides a Tomcat instance for each test - mainly so we
+ * don't have to keep writing the cleanup code.
+ */
+public abstract class TomcatBaseTestJUnit4 {
+ private Tomcat tomcat;
+ private File tempDir;
+ private boolean accessLogEnabled = false;
+ private static int port = 8000;
+
+ public static final String TEMP_DIR = System.getProperty("java.io.tmpdir");
+
+ /**
+ * Make Tomcat instance accessible to sub-classes.
+ */
+ public Tomcat getTomcatInstance() {
+ return tomcat;
+ }
+
+ /**
+ * Sub-classes need to know port so they can connect
+ */
+ public int getPort() {
+ return port;
+ }
+
+ /**
+ * Sub-classes may want to add connectors on a new port
+ */
+ public int getNextPort() {
+ port++;
+ return getPort();
+ }
+
+ /**
+ * Helper method that returns the path of the temporary directory used by
+ * the test runs. The directory is configured during {@link #setUp()} and is
+ * deleted at {@link #tearDown()}.
+ */
+ public File getTemporaryDirectory() {
+ return tempDir;
+ }
+
+ /**
+ * Helper method that returns the directory where Tomcat build resides. It
+ * is used to access resources that are part of default Tomcat deployment.
+ * E.g. the examples webapp.
+ */
+ public File getBuildDirectory() {
+ return new File(System.getProperty("tomcat.test.tomcatbuild",
+ "output/build"));
+ }
+
+ /**
+ * Sub-classes may want to check, whether an AccessLogValve is active
+ */
+ public boolean isAccessLogEnabled() {
+ return accessLogEnabled;
+ }
+
+ @Before
+ public void setUp() throws Exception {
+ // Need to use JULI so log messages from the tests are visible
+ System.setProperty("java.util.logging.manager",
+ "org.apache.juli.ClassLoaderLogManager");
+ System.setProperty("java.util.logging.config.file", new File(
+ getBuildDirectory(), "conf/logging.properties").toString());
+
+ tempDir = new File(System.getProperty("tomcat.test.temp", "output/tmp"));
+ if (!tempDir.exists() && !tempDir.mkdirs()) {
+ fail("Unable to create temporary directory for test");
+ }
+
+ System.setProperty("catalina.base", tempDir.getAbsolutePath());
+ // Trigger loading of catalina.properties
+ CatalinaProperties.getProperty("foo");
+
+ File appBase = new File(tempDir, "webapps");
+ if (!appBase.exists() && !appBase.mkdir()) {
+ fail("Unable to create appBase for test");
+ }
+
+ tomcat = new Tomcat();
+
+ String protocol = getProtocol();
+ Connector connector = new Connector(protocol);
+ // If each test is running on same port - they
+ // may interfere with each other
+ connector.setPort(getNextPort());
+ // Mainly set to reduce timeouts during async tests
+ connector.setAttribute("connectionTimeout", "3000");
+ tomcat.getService().addConnector(connector);
+ tomcat.setConnector(connector);
+
+ // Add AprLifecycleListener if we are using the Apr connector
+ if (protocol.contains("Apr")) {
+ StandardServer server = (StandardServer) tomcat.getServer();
+ AprLifecycleListener listener = new AprLifecycleListener();
+ listener.setSSLRandomSeed("/dev/urandom");
+ server.addLifecycleListener(listener);
+ connector.setAttribute("pollerThreadCount", Integer.valueOf(1));
+ }
+
+ tomcat.setBaseDir(tempDir.getAbsolutePath());
+ tomcat.getHost().setAppBase(appBase.getAbsolutePath());
+
+ accessLogEnabled = Boolean.parseBoolean(
+ System.getProperty("tomcat.test.accesslog", "false"));
+ if (accessLogEnabled) {
+ AccessLogValve alv = new AccessLogValve();
+ alv.setDirectory(getBuildDirectory() + "/logs");
+ alv.setPattern("%h %l %u %t \"%r\" %s %b %I %D");
+ tomcat.getHost().getPipeline().addValve(alv);
+ }
+ }
+
+ protected String getProtocol() {
+ // Has a protocol been specified
+ String protocol = System.getProperty("tomcat.test.protocol");
+
+ // Use BIO by default
+ if (protocol == null) {
+ protocol = "org.apache.coyote.http11.Http11Protocol";
+ }
+
+ return protocol;
+ }
+
+ @After
+ public void tearDown() throws Exception {
+ // Some tests may call tomcat.destroy(), some tests may just call
+ // tomcat.stop(), some not call either method. Make sure that stop() &
+ // destroy() are called as necessary.
+ if (tomcat.server != null &&
+ tomcat.server.getState() != LifecycleState.DESTROYED) {
+ if (tomcat.server.getState() != LifecycleState.STOPPED) {
+ tomcat.stop();
+ }
+ tomcat.destroy();
+ }
+ ExpandWar.delete(tempDir);
+ }
+
+ /**
+ * Simple Hello World servlet for use by test cases
+ */
+ public static final class HelloWorldServlet extends HttpServlet {
+
+ private static final long serialVersionUID = 1L;
+
+ public static final String RESPONSE_TEXT =
+ "<html><body><p>Hello World</p></body></html>";
+
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp)
+ throws ServletException, IOException {
+ PrintWriter out = resp.getWriter();
+ out.print(RESPONSE_TEXT);
+ }
+ }
+
+
+ /**
+ * Wrapper for getting the response.
+ */
+ public static ByteChunk getUrl(String path) throws IOException {
+ ByteChunk out = new ByteChunk();
+ getUrl(path, out, null);
+ return out;
+ }
+
+ public static int getUrl(String path, ByteChunk out,
+ Map<String, List<String>> resHead) throws IOException {
+ return getUrl(path, out, null, resHead);
+ }
+
+ public static int getUrl(String path, ByteChunk out,
+ Map<String, List<String>> reqHead,
+ Map<String, List<String>> resHead) throws IOException {
+ return getUrl(path, out, 1000000, reqHead, resHead);
+ }
+
+ public static int getUrl(String path, ByteChunk out, int readTimeout,
+ Map<String, List<String>> reqHead,
+ Map<String, List<String>> resHead) throws IOException {
+
+ URL url = new URL(path);
+ HttpURLConnection connection =
+ (HttpURLConnection) url.openConnection();
+ connection.setUseCaches(false);
+ connection.setReadTimeout(readTimeout);
+ if (reqHead != null) {
+ for (Map.Entry<String, List<String>> entry : reqHead.entrySet()) {
+ StringBuilder valueList = new StringBuilder();
+ for (String value : entry.getValue()) {
+ if (valueList.length() > 0) {
+ valueList.append(',');
+ }
+ valueList.append(value);
+ }
+ connection.setRequestProperty(entry.getKey(),
+ valueList.toString());
+ }
+ }
+ connection.connect();
+ int rc = connection.getResponseCode();
+ if (resHead != null) {
+ Map<String, List<String>> head = connection.getHeaderFields();
+ resHead.putAll(head);
+ }
+ if (rc == HttpServletResponse.SC_OK) {
+ InputStream is = connection.getInputStream();
+ BufferedInputStream bis = null;
+ try {
+ bis = new BufferedInputStream(is);
+ byte[] buf = new byte[2048];
+ int rd = 0;
+ while((rd = bis.read(buf)) > 0) {
+ out.append(buf, 0, rd);
+ }
+ } finally {
+ if (bis != null) {
+ try {
+ bis.close();
+ } catch (IOException e) {
+ // Ignore
+ }
+ }
+ }
+ }
+ return rc;
+ }
+
+ public static ByteChunk postUrl(byte[] body, String path)
+ throws IOException {
+ ByteChunk out = new ByteChunk();
+ postUrl(body, path, out, null);
+ return out;
+ }
+
+ public static int postUrl(byte[] body, String path, ByteChunk out,
+ Map<String, List<String>> resHead) throws IOException {
+ return postUrl(body, path, out, null, resHead);
+ }
+
+ public static int postUrl(byte[] body, String path, ByteChunk out,
+ Map<String, List<String>> reqHead,
+ Map<String, List<String>> resHead) throws IOException {
+
+ URL url = new URL(path);
+ HttpURLConnection connection =
+ (HttpURLConnection) url.openConnection();
+ connection.setDoOutput(true);
+ connection.setReadTimeout(1000000);
+ if (reqHead != null) {
+ for (Map.Entry<String, List<String>> entry : reqHead.entrySet()) {
+ StringBuilder valueList = new StringBuilder();
+ for (String value : entry.getValue()) {
+ if (valueList.length() > 0) {
+ valueList.append(',');
+ }
+ valueList.append(value);
+ }
+ connection.setRequestProperty(entry.getKey(),
+ valueList.toString());
+ }
+ }
+ connection.connect();
+
+ // Write the request body
+ OutputStream os = null;
+ try {
+ os = connection.getOutputStream();
+ if (body != null) {
+ os.write(body, 0, body.length);
+ }
+ } finally {
+ if (os != null) {
+ try {
+ os.close();
+ } catch (IOException ioe) {
+ // Ignore
+ }
+ }
+ }
+
+ int rc = connection.getResponseCode();
+ if (resHead != null) {
+ Map<String, List<String>> head = connection.getHeaderFields();
+ resHead.putAll(head);
+ }
+ if (rc == HttpServletResponse.SC_OK) {
+ InputStream is = connection.getInputStream();
+ BufferedInputStream bis = null;
+ try {
+ bis = new BufferedInputStream(is);
+ byte[] buf = new byte[2048];
+ int rd = 0;
+ while((rd = bis.read(buf)) > 0) {
+ out.append(buf, 0, rd);
+ }
+ } finally {
+ if (bis != null) {
+ try {
+ bis.close();
+ } catch (IOException e) {
+ // Ignore
+ }
+ }
+ }
+ }
+ return rc;
+ }
+
+}
projects / tomcat7.0 / commitdiff