All Downloads are FREE. Search and download functionalities are using the official Maven repository.

nl.nn.adapterframework.testtool.LarvaServlet Maven / Gradle / Ivy

There is a newer version: 7.9.5
Show newest version
/*
   Copyright 2022 WeAreFrank!

   Licensed 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 nl.nn.adapterframework.testtool;

import java.io.IOException;
import java.io.InputStream;
import java.io.Writer;
import java.net.URL;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.io.IOUtils;
import org.apache.logging.log4j.Logger;

import lombok.Getter;
import nl.nn.adapterframework.core.SenderException;
import nl.nn.adapterframework.http.HttpServletBase;
import nl.nn.adapterframework.lifecycle.IbisInitializer;
import nl.nn.adapterframework.util.LogUtil;
import nl.nn.adapterframework.util.Misc;
import nl.nn.adapterframework.util.StreamUtil;

@IbisInitializer
public class LarvaServlet extends HttpServletBase {
	private static final URL INDEX_TEMPLATE = getResource("/index.html.template");
	private static final String SERVLET_PATH = "/larva/";
	private final transient Logger log = LogUtil.getLogger(this);

	private enum Assets {
		STYLESHEET("/assets/style.css", "text/css"),
		LIB("/assets/lib.js", "text/javascript");

		private final @Getter String contentType;
		private final URL url;
		private final String resource;

		private Assets(String resource, String contentType) {
			this.url = getResource(resource);
			if(url == null) {
				throw new IllegalStateException("unable to find asset");
			}

			this.resource = resource;
			this.contentType = contentType;
		}

		static Assets findAsset(String resource) {
			for(Assets asset : values()) {
				if(asset.resource.equals(resource)) {
					return asset;
				}
			}
			return null;
		}

		InputStream openStream() throws IOException {
			return url.openStream();
		}
	}

	private static URL getResource(String resource) {
		return LarvaServlet.class.getResource(resource);
	}

	@Override
	protected void service(HttpServletRequest requ, HttpServletResponse resp) throws ServletException, IOException {
		HttpServletRequestWrapper req = new HttpServletRequestWrapper(requ) {
			@Override
			public String getServletPath() { //Required for the Larva testtool to initialize
				return super.getServletPath() + "/index.jsp";
			}
		};

		if(req.getPathInfo() == null) {
			resp.sendRedirect(req.getContextPath() + SERVLET_PATH + "index.jsp"); // Avoid that WebSphere removes the slash at the end of the url (causing an endless loop) by explicitly adding the welcome resource
			return;
		}

		req.setCharacterEncoding(StreamUtil.DEFAULT_INPUT_STREAM_ENCODING);
		super.service(req, resp);
	}

	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
		String path = req.getPathInfo();

		if(path.equals("/") || path.equalsIgnoreCase("/index.jsp")) {
			handleIndex(req, resp);
			return;
		} else {
			Assets asset = Assets.findAsset(path);
			if (asset != null) {
				handleAsset(asset, resp);
				return;
			}
		}
		resp.sendError(404, "resource not found");
	}

	@Override
	protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
		String path = req.getPathInfo();
		if(path.equals("/") || path.equalsIgnoreCase("/index.jsp")) {
			handleIndex(req, resp);
			return;
		} else if (path.equals("/saveResultToFile.jsp")) {
			handleSaveResult(req, resp);
			return;
		}

		resp.sendError(404, "resource not found");
	}

	private void handleAsset(Assets asset, HttpServletResponse resp) throws IOException {
		resp.setContentType(asset.getContentType());

		try(InputStream in = asset.openStream()) {
			IOUtils.copy(in, resp.getOutputStream());
		} catch (IOException e) {
			log.warn("error reading or writing resource to servlet", e);
			resp.sendError(500, e.getMessage());
			return;
		}

		resp.flushBuffer();
	}

	private void handleIndex(HttpServletRequest req, HttpServletResponse resp) throws IOException {
		Writer writer = resp.getWriter();
		resp.setContentType("text/html");
		writer.append(getTemplate("Larva Test Tool"));
		TestTool.runScenarios(getServletContext(), req, writer);
		writer.append("");
		resp.flushBuffer();
	}

	private String getTemplate(String title) throws IOException {
		String content = Misc.resourceToString(INDEX_TEMPLATE);
		return content.replace("{{title}}", title);
	}

	private void handleSaveResult(HttpServletRequest request, HttpServletResponse resp) throws IOException {
		resp.setContentType("text/html");
		Writer writer = resp.getWriter();
		if(request.getParameter("cmd") != null) {
			if (request.getParameter("cmd").equals("indentWindiff")) {
				writer.append(getTemplate("Comparing result"));
			} else {
				writer.append(getTemplate("Save actual result"));
			}
		}

		if (request.getParameter("init") != null) {
			writer.append("

Waiting for data...

"); } else if (request.getParameter("expectedFileName") == null) { writer.append("

No file name received!

"); writer.append("

In case you use Tomcat and large messages this might be caused by maxPostSize which is set to 2097152 (2 megabytes) by default. Add maxPostSize to the Connector element in server.xml with a larger value or 0.

"); } else { if (request.getParameter("cmd").equals("indentWindiff")) { writer.append("

Comparing actual result with expected result...

"); writer.flush(); try { TestTool.windiff(getServletContext(), request, request.getParameter("expectedFileName"), request.getParameter("expectedBox"), request.getParameter("resultBox")); } catch (SenderException e) { log.warn("unable to execute windiff command", e); resp.sendError(500, "unable to save file"); } catch (IOException e) { log.warn("unable to write tempFile", e); resp.sendError(500, "unable to write tempFile"); } } else { writer.append("

Overwriting expected result with actual result...

"); writer.flush(); TestTool.writeFile(request.getParameter("expectedFileName"), request.getParameter("resultBox")); } writer.append("

Done!

"); writer.append(""); } } @Override public String getUrlMapping() { return SERVLET_PATH + "*"; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy