implement a new framework permutation based on Java, Servlet 3 and Apache Cassandra database

servlet3-cass/README.md

@@ -0,0 +1,14 @@
+
+# Servlet3 API benchmarking test
+
+Framework permutation based on the following technology stack
+
+* Java
+* Resin
+* Servlet 3 with asynchronous processing
+* Apache Cassandra database
+* Jackson 2 for JSON processing
+
+Currently implements test types 1, 2, 3, and 6.
+
+

servlet3-cass/benchmark_config

@@ -0,0 +1,43 @@
+{
+  "framework": "servlet3-cass",
+  "tests": [{
+    "default": {
+      "setup_file": "setup",
+      "json_url": "/servlet3-cass/json",
+      "plaintext_url": "/servlet3-cass/plaintext",
+      "port": 8080,
+      "approach": "Realistic",
+      "classification": "Platform",
+      "database": "None",
+      "framework": "servlet3-cass",
+      "language": "Java",
+      "orm": "Raw",
+      "platform": "Servlet",
+      "webserver": "Resin",
+      "os": "Linux",
+      "database_os": "Linux",
+      "display_name": "servlet3-cass",
+      "notes": "",
+      "versus": "servlet3-cass"
+    },
+    "raw": {
+      "setup_file": "setup",
+      "db_url": "/servlet3-cass/db",
+      "query_url": "/servlet3-cass/db?queries=",
+      "port": 8080,
+      "approach": "Realistic",
+      "classification": "Platform",
+      "database": "Apache Cassandra",
+      "framework": "servlet3-cass",
+      "language": "Java",
+      "orm": "Raw",
+      "platform": "Servlet",
+      "webserver": "Resin",
+      "os": "Linux",
+      "database_os": "Linux",
+      "display_name": "servlet3-cass",
+      "notes": "",
+      "versus": "servlet3-cass"
+    }
+  }]
+}

servlet3-cass/pom.xml

@@ -0,0 +1,87 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>fi.markoa.tfb.servlet3</groupId>
+    <artifactId>servlet3-cass</artifactId>
+    <version>0.0.1-SNAPSHOT</version>
+    <packaging>war</packaging>
+    <name>servlet3-cass</name>
+
+    <properties>
+        <sourceEncoding>UTF-8</sourceEncoding>
+        <java.version>1.7</java.version>
+
+        <slf4j.version>1.7.7</slf4j.version>
+        <logback.version>1.1.2</logback.version>
+        <jersey.version>2.10</jersey.version>
+    </properties>
+
+    <build>
+        <finalName>servlet3-cass</finalName>
+
+        <plugins>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.1</version>
+                <configuration>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
+                    <encoding>${sourceEncoding}</encoding>
+                </configuration>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-war-plugin</artifactId>
+                <version>2.4</version>
+                <configuration>
+                    <failOnMissingWebXml>false</failOnMissingWebXml>
+                </configuration>
+            </plugin>
+
+        </plugins>
+
+    </build>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>javax.servlet-api</artifactId>
+            <version>3.1.0</version>
+            <scope>provided</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.4.1</version>
+        </dependency>
+
+        <dependency>
+            <groupId>com.datastax.cassandra</groupId>
+            <artifactId>cassandra-driver-core</artifactId>
+            <version>2.0.3</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+            <scope>compile</scope>
+        </dependency>
+
+        <!--
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>${logback.version}</version>
+            <scope>runtime</scope>
+        </dependency>
+        -->
+
+    </dependencies>
+
+</project>

servlet3-cass/setup.py

@@ -0,0 +1,31 @@
+
+import subprocess
+import sys
+import os
+import setup_util
+
+def start(args, logfile, errfile):
+
+  try:
+    subprocess.check_call("mvn clean compile war:war", shell=True, cwd="servlet3-cass", stderr=errfile, stdout=logfile)
+    if os.name == 'nt':
+      subprocess.check_call("rmdir /s /q C:\\Java\\resin\\webapps", shell=True, stderr=errfile, stdout=logfile)
+      subprocess.check_call("mkdir C:\\Java\\resin\\webapps", shell=True, stderr=errfile, stdout=logfile)
+      subprocess.check_call("cp servlet3-cass\\target\\servlet3-cass.war C:\\Java\\resin\\webapps\\servlet3-cass.war", shell=True, stderr=errfile, stdout=logfile)
+      subprocess.check_call("C:\\Java\\resin\\bin\\start.bat", shell=True, stderr=errfile, stdout=logfile)
+      return 0
+    subprocess.check_call("rm -rf $RESIN_HOME/webapps/*", shell=True, stderr=errfile, stdout=logfile)
+    subprocess.check_call("cp servlet/target/servlet3-cass.war $RESIN_HOME/webapps/", shell=True, stderr=errfile, stdout=logfile)
+    subprocess.check_call("$RESIN_HOME/bin/resinctl start", shell=True, stderr=errfile, stdout=logfile)
+    return 0
+  except subprocess.CalledProcessError:
+    return 1
+def stop(logfile, errfile):
+  try:
+    if os.name == 'nt':
+      subprocess.check_call("C:\\Java\\resin\\bin\\stop.bat", shell=True, stderr=errfile, stdout=logfile)
+      return 0
+    subprocess.check_call("$RESIN_HOME/bin/resinctl shutdown", shell=True, stderr=errfile, stdout=logfile)
+    return 0
+  except subprocess.CalledProcessError:
+    return 1

servlet3-cass/source_code

@@ -0,0 +1,17 @@
+./servlet3-cass/src
+./servlet3-cass/src/main
+./servlet3-cass/src/main/java
+./servlet3-cass/src/main/java/fi
+./servlet3-cass/src/main/java/fi/markoa
+./servlet3-cass/src/main/java/fi/markoa/tfb
+./servlet3-cass/src/main/java/fi/markoa/tfb/servlet3
+./servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/DatabaseQueryServlet.java
+./servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/HelloMessage.java
+./servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/JsonSerializationServlet.java
+./servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/MessageDAO.java
+./servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/MessageDAOCassImpl.java
+./servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/PlaintextServlet.java
+./servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/World.java
+./servlet3-cass/src/main/resources
+./servlet3-cass/src/main/resources/application.properties
+./servlet3-cass/src/main/resources/logback.xml

servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/DatabaseQueryServlet.java

@@ -0,0 +1,105 @@
+package fi.markoa.tfb.servlet3;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.util.concurrent.*;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.servlet.AsyncContext;
+import javax.servlet.ServletConfig;
+import javax.servlet.ServletException;
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ThreadLocalRandom;
+
+/**
+ * Web Framework Benchmarks
+ * Test type 2: Single database query
+ * Test type 3: Multiple database queries
+ *
+ * @author marko asplund
+ */
+@WebServlet(urlPatterns={"/db", "/queries"}, asyncSupported=true)
+public class DatabaseQueryServlet extends HttpServlet {
+  private static final Logger LOGGER = LoggerFactory.getLogger(DatabaseQueryServlet.class);
+  private static final ObjectMapper mapper = new ObjectMapper();
+  private static final String MEDIATYPE_APPLICATION_JSON = "application/json";
+
+  private static final ListeningExecutorService executorService =
+    MoreExecutors.listeningDecorator(Executors.newCachedThreadPool());
+  private MessageDAOCassImpl dao;
+
+  @Override
+  public void init(ServletConfig config) throws ServletException {
+    dao = new MessageDAOCassImpl();
+    dao.init();
+  }
+
+  @Override
+  protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+    resp.setContentType(MEDIATYPE_APPLICATION_JSON);
+    final AsyncContext asyncContext = req.startAsync();
+    ListenableFuture<?> future;
+    if("/queries".equals(req.getServletPath())) {
+      List<Integer> ids = new ArrayList<>();
+      int queries = getQueries(req.getParameter("queries"));
+      for(int cnt = 0; cnt < queries; cnt++)
+        ids.add(ThreadLocalRandom.current().nextInt(1, 10001));
+      future = dao.read(ids);
+    } else {
+      int randId = ThreadLocalRandom.current().nextInt(1, 10001);
+      future = dao.read(randId);
+    }
+
+    Futures.addCallback(future, new FutureCallback<Object>() {
+      @Override
+      public void onSuccess(Object world) {
+        try {
+          mapper.writeValue(asyncContext.getResponse().getOutputStream(), world);
+        } catch (IOException ex) {
+          LOGGER.error("failed to get output stream", ex);
+          throw new RuntimeException("failed to get output stream", ex);
+        }
+        asyncContext.complete();
+      }
+
+      @Override
+      public void onFailure(Throwable th) {
+        // TODO
+        LOGGER.error("failed to get data, "+th);
+        asyncContext.complete();
+        throw new RuntimeException(th);
+      }
+    }, executorService);
+
+  }
+
+  private int getQueries(String queries) {
+    int q;
+    if(queries == null) {
+      return 1;
+    }
+    try {
+      q = Integer.parseInt(queries);
+    } catch (NumberFormatException ex) {
+      return 1;
+    }
+    if(q > 500)
+      return 500;
+    if(q < 1)
+      return 1;
+
+    return q;
+  }
+
+  @Override
+  public void destroy() {
+    dao.destroy();
+  }
+}

servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/HelloMessage.java

@@ -0,0 +1,12 @@
+package fi.markoa.tfb.servlet3;
+
+public class HelloMessage {
+  private String message = "Hello, World!";
+
+  public HelloMessage() {
+  }
+
+  public String getMessage() {
+    return message;
+  }
+}

servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/JsonSerializationServlet.java

@@ -0,0 +1,33 @@
+package fi.markoa.tfb.servlet3;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.servlet.ServletException;
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+
+/**
+ * Web Framework Benchmarks
+ * Test type 1: JSON serialization
+ *
+ * @author marko asplund
+ */
+@WebServlet("/json")
+public class JsonSerializationServlet extends HttpServlet {
+  private static final Logger LOGGER = LoggerFactory.getLogger(JsonSerializationServlet.class);
+  private static final ObjectMapper mapper = new ObjectMapper();
+  private static final String MEDIATYPE_APPLICATION_JSON = "application/json";
+
+  @Override
+  protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+    LOGGER.debug("doGet");
+    resp.setContentType(MEDIATYPE_APPLICATION_JSON);
+    mapper.writeValue(resp.getOutputStream(), new HelloMessage());
+  }
+
+}

servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/MessageDAO.java

@@ -0,0 +1,13 @@
+package fi.markoa.tfb.servlet3;
+
+import com.google.common.util.concurrent.ListenableFuture;
+
+import java.util.List;
+import java.util.Properties;
+
+public interface MessageDAO {
+  void init();
+  ListenableFuture<World> read(int id);
+  ListenableFuture<List<World>> read(List<Integer> ids);
+  void destroy();
+}

servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/MessageDAOCassImpl.java

@@ -0,0 +1,79 @@
+package fi.markoa.tfb.servlet3;
+
+import com.datastax.driver.core.*;
+import com.google.common.base.Function;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.*;
+
+/**
+ * Cassandra data access implementation class for the "World" domain model.
+ *
+ * @author marko asplund
+ */
+public class MessageDAOCassImpl implements MessageDAO {
+  private static final Logger LOGGER = LoggerFactory.getLogger(MessageDAOCassImpl.class);
+  private static final String CONFIG_FILE_NAME= "/application.properties";
+  private Cluster cluster;
+  private Session session;
+  private Map<String, PreparedStatement> statements;
+
+  @Override
+  public void init() {
+    LOGGER.debug("init()");
+
+    Properties conf;
+    try (InputStream is = this.getClass().getClassLoader().getResourceAsStream(CONFIG_FILE_NAME)) {
+      if(is == null)
+        throw new IOException("file not found: "+CONFIG_FILE_NAME);
+      conf = new Properties();
+      conf.load(is);
+    } catch (IOException ex) {
+      LOGGER.error("failed to open config file", ex);
+      throw new RuntimeException(ex);
+    }
+
+    cluster = Cluster.builder()
+      .addContactPoint(conf.getProperty("cassandra.host"))
+//      .withCredentials(conf.getProperty("cassandra.user"), conf.getProperty("cassandra.pwd"))
+      .build();
+    session = cluster.connect(conf.getProperty("cassandra.keyspace"));
+
+    Map<String, PreparedStatement> stmts = new HashMap<>();
+    stmts.put("get_by_id", session.prepare("SELECT id, randomnumber FROM world WHERE id = ?"));
+    statements = Collections.unmodifiableMap(stmts);
+  }
+
+  @Override
+  public ListenableFuture<World> read(int id) {
+    Function<ResultSet, World> transformation = new Function<ResultSet, World>() {
+      @Override
+      public World apply(ResultSet results) {
+        Row r = results.one();
+        return new World(r.getInt("id"), r.getInt("randomnumber"));
+      }
+    };
+    ResultSetFuture rsf = session.executeAsync(statements.get("get_by_id").bind(id));
+    return Futures.transform(rsf, transformation);
+  }
+
+  public ListenableFuture<List<World>> read(List<Integer> ids) {
+    List<ListenableFuture<World>> futures = new ArrayList<>();
+    for(Integer id : ids)
+      futures.add(read(id));
+    return Futures.allAsList(futures);
+  }
+
+  @Override
+  public void destroy() {
+    LOGGER.debug("destroy()");
+    session.close();
+    cluster.close();
+  }
+
+}

servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/PlaintextServlet.java

@@ -0,0 +1,32 @@
+package fi.markoa.tfb.servlet3;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.servlet.ServletException;
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.io.IOException;
+
+/**
+ * Web Framework Benchmarks
+ * Test type 6: Plaintext
+ *
+ * @author marko asplund
+ */
+@WebServlet("/plaintext")
+public class PlaintextServlet extends HttpServlet {
+  private static final Logger LOGGER = LoggerFactory.getLogger(PlaintextServlet.class);
+  private static final String MEDIATYPE_TEXT_PLAIN = "text/plain";
+  private static final byte[] CONTENT = "Hello, World!".getBytes();
+
+  @Override
+  protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+    LOGGER.debug("doGet");
+    resp.setContentType(MEDIATYPE_TEXT_PLAIN);
+    resp.getOutputStream().write(CONTENT);
+  }
+
+}

servlet3-cass/src/main/java/fi/markoa/tfb/servlet3/World.java

@@ -0,0 +1,19 @@
+package fi.markoa.tfb.servlet3;
+
+public class World {
+  private int id;
+  private int randomNumber;
+
+  public World(int id, int randomNumber) {
+    this.id = id;
+    this.randomNumber = randomNumber;
+  }
+
+  public int getId() {
+    return id;
+  }
+
+  public int getRandomNumber() {
+    return randomNumber;
+  }
+}

servlet3-cass/src/main/resources/application.properties

@@ -0,0 +1,2 @@
+cassandra.host=tfbdata
+cassandra.keyspace=tfb

servlet3-cass/src/main/resources/logback.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
+        <file>servlet3-cass.log</file>
+        <append>true</append>
+        <encoder>
+            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{35} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <logger name="fi.markoa.tfb.servlet3" level="DEBUG"/>
+
+    <root level="INFO">
+        <appender-ref ref="FILE" />
+    </root>
+</configuration>