Question

我正在使用 Spark Web框架并创建 RESTful API 。（http://sparkjava.com因为有很多东西名为“Spark”）

我的雇主的标准要求我们编写一系列单元测试，每天自动运行一次以确认应用程序仍在运行。

Spark很容易使用像Postman这样的工具来测试自己，但我没有找到任何使用Spark编写JUnit测试的好例子，甚至用编程方式用 HTTP请求编写

以前有人这样做过吗？有可能吗？

Answer 1

我们开发了一个小型库，便于Spark控制器/端点的单元测试。

此外，版本1.1.3在Maven Central Repository中发布

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

Answer 2

我有同样的要求，你和我找到了让它运作的方法。我搜索了Spark源代码，发现了两个有用的类：

SparkTestUtil：此类包装Apache HttpClient并公开方法，以使用可自定义的端口（在构造函数中）和相对路径（在请求方法中）对本地Web服务器（在localhost中运行）发出不同的http请求
ServletTest：它在本地端口中启动Jetty实例，其中包含应用程序上下文和相对目录路径，可在其中找到WEB-INF / web.xml文件描述符。此web.xml将用于模拟Web应用程序。然后，它使用 SparkTestUtil 对此模拟应用程序发出http请求并声明结果。

这就是我所做的：我创建了一个实现 SparkApplication 接口的junit测试类。在该界面中，我创建并初始化＆＃34;控制器＆＃34; （我的一个类应用程序）负责回答http请求。在使用@BeforeClass注释的方法中，我使用web.xml初始化Jetty实例，该文件将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>

这可以改进，但我认为这是一个很好的起点。也许一些＆＃34; spark-test＆＃34;可以创建组件吗？

希望这对你有用！

Answer 3

这是我的解决方案。您只需要额外添加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());
    }
}

Answer 4

另一种方法是创建一个在每个path或route中实现Route的类。例如，如果您有下一条路线：

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

然后用实现(req, response) -> {....}的类替换Route lambda。

例如：

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

将是：

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

然后，您可以使用JUnit对YourRoute类进行单元测试。

Spark Web框架单元测试

4 个答案:

JUnit测试类

src / test / webapp / WEB-INF / web.xml文件