Модульные тесты веб-фреймворка Spark

У меня было то же требование, что и вы, и я нашли способ заставить его работать. Я просмотрел исходный код Spark и нашел два полезных класса:

• SparkTestUtil: этот класс обертывает Apache HttpClient и методы предоставления различных HTTP-запросов к локальному веб-серверу (работающему на локальном хосте) с настраиваемым портом (в конструкторе) и относительным путем (в методах запросов)
• ServletTest: он запускает Экземпляр Jetty в локальном порту с контекстом приложения и относительным путем к каталогу, где можно найти файловый дескриптор WEB-INF/web.xml. Этот файл web.xml будет использоваться для имитации веб-приложения. Затем он использует SparkTestUtil для выполнения http-запросов к этому моделируемому приложению и проверки результатов.

Вот что я сделал: я создал тестовый класс junit, который реализует интерфейс SparkApplication. В этом интерфейсе я создаю и инициализирую «контроллер» (класс моего приложения), отвечающий за ответы на http-запросы. В методе, аннотированном @BeforeClass, я инициализирую экземпляр Jetty, используя файл web.xml, который ссылается на тестовый класс junit как на SparkApplication и SparkTestUtil.

Тестовый класс JUnit

package com.test

import org.eclipse.jetty.server.Connector;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.ServerConnector;
import org.eclipse.jetty.webapp.WebAppContext;

public class ControllerTest implements SparkApplication {

    private static SparkTestUtil sparkTestUtil;

    private static Server webServer;

    @Override
    public void init() {
         new Controller(...)
    }

    @BeforeClass
    public static void beforeClass() throws Exception {
       sparkTestUtil = new SparkTestUtil(PORT);
       webServer = new Server();
       ServerConnector connector = new ServerConnector(webServer);
       connector.setPort(PORT);
       webServer.setConnectors(new Connector[] {connector});
       WebAppContext bb = new WebAppContext();
       bb.setServer(webServer);
       bb.setContextPath("/");
       bb.setWar("src/test/webapp/");
       webServer.setHandler(bb);
       webServer.start();
       (...)
    }

    @AfterClass
    public static void afterClass() throws Exception {
       webServer.stop();
       (...)
    }    

}

файл src/test/webapp/WEB-INF/web.xml

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
    <display-name>Archetype Created Web Application</display-name>
    <filter>
        <filter-name>SparkFilter</filter-name>
        <filter-class>spark.servlet.SparkFilter</filter-class>
        <init-param>
            <param-name>applicationClass</param-name>
            <param-value>com.test.ControllerTest</param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>SparkFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

Это можно улучшить, но я думаю, что это хорошая отправная точка. Может быть, можно создать какой-нибудь компонент "spark-test"?

Надеюсь, это будет полезно для вас!

мы разработали небольшую библиотеку, которая упрощает модульное тестирование контроллеров/конечных точек Spark.

Github

Также версия 1.1.3 опубликована в Центральном репозитории Maven.

<dependency>
        <groupId>com.despegar</groupId>
        <artifactId>spark-test</artifactId>
        <version>1.1.3</version>
        <scope>test</scope>
    </dependency>

Вот мое решение. Вам просто нужно добавить дополнительные зависимости apache-http и junit.

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.2</version>
</dependency>

public class SparkServer {
    public static void main(String[] args) {
        Spark.port(8888);
        Spark.threadPool(1000, 1000,60000);
        Spark.get("/ping", (req, res) -> "pong");
    }
}

public class SparkTest {
    @Before
    public void setup() {
        SparkServer.main(null);
    }
    @After
    public void tearDown() throws Exception {
        Thread.sleep(1000);
        Spark.stop();
    }
    @Test
    public void test() throws IOException {

        CloseableHttpClient httpClient = HttpClients.custom()
                .build();

        HttpGet httpGet = new HttpGet("http://localhost:8888/ping");
        CloseableHttpResponse response = httpClient.execute(httpGet);

        int statusCode = response.getStatusLine().getStatusCode();
        BufferedReader rd = new BufferedReader(
                 new InputStreamReader(response.getEntity().getContent()));

        StringBuffer result = new StringBuffer();
        String line = "";
        while ((line = rd.readLine()) != null) {
            result.append(line);
        }

        assertEquals(200, statusCode);
        assertEquals("pong", result.toString());
    }
}

Другой подход заключался в создании класса, реализующего Route в каждом path или route. Например, если у вас есть следующий маршрут:

get("maintenance/task", (req, response) -> {....}); 

Затем замените (req, response) -> {....} lambda классом, реализующим Route.

Например:

public class YourRoute implements Route {
   public Object handle(Request request, Response response) throws Exception {
     ....
   }
}

Было бы:

get("maintenance/task", new YourRoute()); 

Затем вы можете выполнить модульное тестирование класса YourRoute с помощью JUnit.