使用 jetty-maven-plugin 运行 Jetty,并在 jetty 运行时完成构建

Posted

技术标签:

【中文标题】使用 jetty-maven-plugin 运行 Jetty,并在 jetty 运行时完成构建【英文标题】:Run Jetty with jetty-maven-plugin and finish the build when jetty is running 【发布时间】:2016-02-29 08:13:06 【问题描述】:

我想用 jetty-maven-plugin 运行 Jetty,并在 jetty 运行时完成构建。

我创建了一个 pom.xml 来启动码头并部署一个战争文件, 在码头启动后,我希望 maven 在让码头运行的同时完成构建,这样我就可以开始另一个 maven 构建来在我刚刚运行码头的服务器上运行测试。

然后我将创建另一个仅停止码头服务器的 maven 构建。

问题是我没有设法启动码头并在此之后停止 maven 构建,有谁知道该怎么做?

附言 我为此使用了“run-forked”,但它仍在等待停止信号,因此构建被卡住了。

这是 jetty-start 配置文件:

 <profile>
           <id>start-jetty</id>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.eclipse.jetty</groupId>
                        <artifactId>jetty-maven-plugin</artifactId>
                        <configuration>
                            <war>$unpacked.war.directory</war>
                            <contextXml>$unpacked.war.directory/WEB-INF/jetty-web.xml</contextXml>
                            <webApp>
                                <contextPath>/qabin</contextPath>
                            </webApp>
                            <systemProperties>
                                <systemProperty>
                                    <name>mercy.td.sa_config_dir</name>
                                    <value>$tests.runtime</value>
                                </systemProperty>
                                <systemProperty>
                                    <name>jetty.port</name>
                                    <value>$jetty.start.port</value>
                                </systemProperty>
                            </systemProperties>
                            <stopPort>$jetty.stop.port</stopPort>
                            <stopKey>STOP</stopKey>
                        </configuration>
                        <executions>
                            <execution>
                                <id>start-jetty</id>
                                <phase>pre-integration-test</phase>
                                <goals>
                                    <goal>run-forked</goal>
                                </goals>
                                <configuration>
                                    <scanIntervalSeconds>0</scanIntervalSeconds>
                                    <daemon>true</daemon>
                                </configuration>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>

【问题讨论】:

您通常不使用 Maven 来启动必须由另一个模块定位的服务器。我会使用 Jenkins 来做到这一点。使用 Maven 的一个用例是集成测试,您可以在其中启动码头,执行测试(因此保持在相同的 Maven 构建中),然后停止码头。 @Tome 你是对的,我正在使用詹金斯。问题是我需要使用不同的 settings.xml 文件进行测试。所以我将不得不使用不同的 Maven 构建。 【参考方案1】:

应该清楚 Maven 是一个构建工具,而不是一个命令执行工具。 启动/停止 Jetty 应该是集成测试执行阶段中同一构建的一部分。此外,您还在两个 maven 构建(实际上不是有效构建)之间创建依赖关系,如果停止构建失败(无论出于何种原因)并让启动的码头启动并运行,这可能是您的 CI 环境的一部分因此在未定义的时间内消耗 CI 服务器上的资源。

一个简单的启动/测试/停止流程可以作为同一个 Maven 构建的一部分实现如下:

        <build>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-surefire-plugin</artifactId>
                    <executions>
                        <execution>
                            <id>integration-test</id>
                            <goals>
                                <goal>test</goal>
                            </goals>
                            <phase>integration-test</phase>
                            <configuration>
                                <excludes>
                                    <exclude>none</exclude>
                                </excludes>
                                <includes>
                                    <include>**/*IntegrationTest.java</include>
                                </includes>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
                <plugin>
                    <groupId>org.eclipse.jetty</groupId>
                    <artifactId>jetty-maven-plugin</artifactId>
                    <version>9.2.8.v20150217</version>
                    <configuration>
                        <scanIntervalSeconds>10</scanIntervalSeconds>
                        <stopKey>foo</stopKey>
                        <stopPort>9999</stopPort>
                        <stopWait>2</stopWait>
                        <webApp>
                            <contextPath>/examplecomponent</contextPath>
                        </webApp>
                        <httpConnector>
                            <port>7777</port>
                        </httpConnector>
                    </configuration>
                    <executions>
                        <execution>
                            <id>start-jetty</id>
                            <phase>pre-integration-test</phase>
                            <goals>
                                <goal>start</goal>
                            </goals>
                            <configuration>
                                <scanIntervalSeconds>0</scanIntervalSeconds>
                            </configuration>
                        </execution>
                        <execution>
                            <id>stop-jetty</id>
                            <phase>post-integration-test</phase>
                            <goals>
                                <goal>stop</goal>
                            </goals>
                        </execution>
                    </executions>
                    <dependencies>
                        <dependency>
                            <groupId>org.eclipse.jetty</groupId>
                            <artifactId>jetty-util</artifactId>
                            <version>9.2.8.v20150217</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </build>

基本上,您将surefire插件配置为在测试阶段跳过集成测试,然后在集成测试之前启动jetty,执行集成测试(基于后缀),然后停止jetty。

我还建议将其移至配置文件,以使默认构建更快且独立于集成测试,这样它也可以在离线时成功运行,然后在需要时激活配置文件(即在 CI 构建上)。

更新:如果您确实需要在 maven 项目中开始并在其他 maven 模块中停止,您可以应用以下方法: 有一个聚合器/多模块 maven 项目:一个模块将提供启动,另一个模块将提供停止,其他模块将使用正在运行的码头。但是,maven 反应器可能不会按照您希望的顺序调用它们,然后您应该确保停止模块依赖于启动模块(将其作为依赖项),并且任何需要运行模块的模块也将启动模块作为依赖项。此外,停止模块还应该依赖于测试模块,以便它只在最后执行。这应该够了吧。 因此,总结一下:

jetty-question(聚合器项目) 启动码头模块 use-jetty-module(有 start-jetty-module 作为依赖项) stop-jetty-module(具有 start-jetty-module 和 use-jetty-module 作为依赖项)

更新 2:低于工作方法(在 Windows 机器上测试) 这里是聚合器项目jetty-question的pom文件:

<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>com.***</groupId>
  <artifactId>jetty-question</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <packaging>pom</packaging>
  <modules>
    <module>jetty-start</module>
    <module>jetty-stop</module>
    <module>jetty-use</module>
  </modules>
</project>

注意模块声明和包装为 pom(聚合器需要)。

这里是jetty-start模块的pom文件,是一个嵌套在jetty-question下的文件夹

    <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>
    <parent>
        <groupId>com.***</groupId>
        <artifactId>jetty-question</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>
    <artifactId>jetty-start</artifactId>
    <packaging>war</packaging>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-antrun-plugin</artifactId>
                <version>1.6</version>
                <executions>
                    <execution>
                        <phase>verify</phase>
                        <configuration>
                            <target>
                                <exec executable="cmd.exe" spawn="true">
                                    <arg value="/c" />
                                    <arg value="mvn jetty:run" />
                                </exec>
                            </target>
                        </configuration>
                        <goals>
                            <goal>run</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.eclipse.jetty</groupId>
                <artifactId>jetty-maven-plugin</artifactId>
                <version>9.2.8.v20150217</version>
                <configuration>
                    <scanIntervalSeconds>10</scanIntervalSeconds>
                    <stopKey>foo</stopKey>
                    <stopPort>9999</stopPort>
                    <stopWait>2</stopWait>
                    <webApp>
                        <contextPath>/jetty-start</contextPath>
                    </webApp>
                    <httpConnector>
                        <port>7777</port>
                    </httpConnector>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>org.eclipse.jetty</groupId>
                        <artifactId>jetty-util</artifactId>
                        <version>9.2.8.v20150217</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
</project>

注意:该模块正在配置jetty插件,然后通过antrun插件执行后台进程执行mvn jetty:run 在我的示例代码中,部署的应用程序 simple 提供了一个 index.html 页面打印 Hello world。

这里是jetty-use模块的pom文件:

    <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>
    <parent>
        <groupId>com.***</groupId>
        <artifactId>jetty-question</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>
    <artifactId>jetty-use</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.***</groupId>
            <artifactId>jetty-start</artifactId>
            <version>1.0.0-SNAPSHOT</version>
            <type>war</type>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.seleniumhq.selenium</groupId>
            <artifactId>selenium-java</artifactId>
            <version>2.47.1</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

重要提示:如上所述,它需要对 jetty-start 模块的依赖,以便 reactor maven 构建将在 jetty-start 之后执行它(因此我们确信在执行此构建时 jetty 会运行)。 注意 Junit 和 selenium 的依赖关系,我使用它们通过下面的 junit 集成测试有效地测试正在运行的码头:

public class AppIntegrationTest extends TestCase 

    public void testApp() throws Exception 
    // Create a new instance of the Firefox driver
    WebDriver driver = new HtmlUnitDriver();

    // Launch the Online Store Website
    driver.get("http://localhost:7777/jetty-start");

    WebElement element = driver.findElement(By.id("title"));
    Assert.assertNotNull(element);
    Assert.assertNotNull(element.getText());
    Assert.assertEquals("Hello World!", element.getText());
    

最后是jetty-stop模块的pom文件

    <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>
    <parent>
        <groupId>com.***</groupId>
        <artifactId>jetty-question</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>
    <artifactId>jetty-stop</artifactId>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-antrun-plugin</artifactId>
                <version>1.6</version>
                <executions>
                    <execution>
                        <phase>verify</phase>
                        <configuration>
                            <target>
                                <exec executable="cmd.exe" spawn="true">
                                    <arg value="/c" />
                                    <arg value="mvn jetty:stop" />
                                </exec>
                            </target>
                        </configuration>
                        <goals>
                            <goal>run</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.eclipse.jetty</groupId>
                <artifactId>jetty-maven-plugin</artifactId>
                <version>9.2.8.v20150217</version>
                <configuration>
                    <scanIntervalSeconds>10</scanIntervalSeconds>
                    <stopKey>foo</stopKey>
                    <stopPort>9999</stopPort>
                    <stopWait>2</stopWait>
                    <httpConnector>
                        <port>7777</port>
                    </httpConnector>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>org.eclipse.jetty</groupId>
                        <artifactId>jetty-util</artifactId>
                        <version>9.2.8.v20150217</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <dependency>
            <groupId>com.***</groupId>
            <artifactId>jetty-start</artifactId>
            <version>1.0.0-SNAPSHOT</version>
            <type>war</type>
        </dependency>
        <dependency>
            <groupId>com.***</groupId>
            <artifactId>jetty-use</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

注意与 jetty-start 模块类似的配置。该模块还配置了 jetty 插件,并通过 antrun 插件停止它,该插件将在后台执行 mvn jetty:stop 目标。 还要注意这个模块的依赖关系:它需要同时依赖 jetty-start 和 jetty-use 以便 maven reactor 构建将在最后执行它。

补充说明:jetty-start 和 jetty-stop 模块上的 jetty 配置显然需要共享 stop 键和 stop 端口。对于此示例,服务器端口在 pom 文件中进行了硬编码(对于 jetty-start 和 jetty-stop 模块也需要相同),但您也可以将其移动到父模块中的属性。 此外,antrun 插件在 Windows 模式下执行后台进程。如果您在 Linux 上运行,a & 后缀也应该可以解决问题。 我还建议将它保存在一个多模块项目中,以便确保依赖项耦合在一起。

虽然我不建议使用此答案顶部所述的这种方法,但让它发挥作用具有挑战性和乐趣,因此感谢您提供的乐趣。希望你也能成功。

【讨论】:

我同意,我正在为我的 CI 使用 jenkins。问题是我需要使用不同的 settings.xml 文件进行测试。所以我将不得不使用不同的 Maven 构建而不是使用阶段。 抱歉,我是在发送了我的答复后才看到您的评论。 settings.xml 是指 Maven settings.xml 文件? 是的。但是假设我想启动我的应用程序并让它一直运行直到我调用“jetty-stop”,这意味着“jetty-start”部分将是独立的。 好的,你可以使用一个多模块的maven项目,一个模块将提供启动,另一个模块将提供停止,其他模块将使用正在运行的码头。但是,maven 反应器可能不会按照您希望的顺序调用它们,然后您应该确保停止模块依赖于启动模块(将其作为依赖项),并且任何需要运行模块的模块也将启动模块作为依赖项。此外,停止模块还应该依赖于测试模块,以便它只在最后执行。这应该可以解决问题。 @ShacharHamuzimRajuan 我让它工作了,请参阅上面答案的更新 2,我试图提供尽可能多的细节,但我显然错过了一些东西(我无法附上我制作的示例项目) .如果您需要更多详细信息,请告诉我。

以上是关于使用 jetty-maven-plugin 运行 Jetty,并在 jetty 运行时完成构建的主要内容,如果未能解决你的问题,请参考以下文章

为啥有人会使用 jetty-maven-plugin 与嵌入式码头

如何使用 jetty-maven-plugin 10 指定 JAAS 配置文件

jetty-maven-plugin

jetty-maven-plugin 源代码存储库

Maven: clean jetty:run报如下错,请问是啥问题?

idea启动dubbo