【JUnit实战3_22】 第十三章：用 JUnit 5 做持续集成（下）：Jenkins + JUnit 5 + Git 持续集成本地实战演练完整复盘

《JUnit in Action》全新第3版封面截图

写在前面
上篇讲了，第十三章的后半部分内容围绕 Jenkins 如何开展持续集成进行了演示，但中途由于牵涉太多 Git 工作流和相关配置细节的问题，很多重要节点没能详细展开。本篇根据书中思路在本地进行了完整实战演练，并对当中的详细配置细节及遇到的问题进行了深入分析，以便今后复盘。

第十三章：用 JUnit 5 做持续集成

（接上篇）

13.4 CI 实战：在 Jenkins 创建项目并处理构建任务

本章后续内容就是模拟了一个用 Jenkins 做持续集成的小案例，具体场景即示例公司 Tested Data Systems 的航班管理应用，涉及两个实体类的交互：Flight 和 Passenger，分别由两位开发者独立维护。航班对象有一个名为 passengers 的乘客集合，并且提供了实例方法来动态添加或删除乘客元素；此外还有一些校验逻辑，限制乘客总数不超过总的座位数。

模拟的工作流是这样的：两位开发者先实现各自的实体类和测试类，运行无误后完成了代码版本的初始提交。后来维护 Passenger 的开发者决定新增一个实例方法，让乘客也能主动选择某个航班，而不是只能被动地接受航班的指派。结果修改完代码并提交到代码库后，Jenkins 构建失败了，原因是 Flight 及其测试类也需要同步修改一些细节。于是，维护 Flight 的开发者又重新签出项目代码，修复 Bug 并提交了一个新的版本到 Jenkins。最后通过了 Jenkins 的手动构建任务。

这个流程涉及 Jenkins 的相关配置、Git 本地代码库的临时搭建、多次版本提交的演示、以及 Jenkins 构建任务的执行。可能是篇幅有限，作者并没有详细展开演示每一个步骤，很多地方都是一带而过。作为以实战为主的自学笔记，肯定是需要亲自动手尝试的，一来看看书中有没有遗漏的关键节点，二来也可以验证一下五年后的新版本新环境下会遇到哪些具体的新问题。

以下是具体实测过程。

13.4.1 构建示例项目

在桌面新建文件夹 ch13_ci_demo 作为项目的本地 Git 仓库。先完成基础配置：

# 在桌面创建一个空的示例文件夹，用于存放本地 Git 代码库，以及模拟两个开发者的本地工作空间（稍后实现）
> (pwd).Path
F:\mydesktop
> mkdir ch13_ci_demo | Out-Null
> cd ch13_ci_demo
# 用 Maven 命令快速初始化示例项目
> mvn archetype:generate -DgroupId="com.manning.junitbook" -DartifactId="ch13-ci-demo" -DarchetypeArtifactid="maven-artifact-mojo"

关于 Maven 命令中的两个细节

注意：在 PowerShell 命令行中，各参数的值最好用双引号标注一下（如 "com.manning.junitbook"），以免运行报错。如果是 CMD 命令行环境则可以不用加注。

另外，上述 Maven 命令在最后确认环节如果需要调整某些配置，只需输入一个 n，再按回车确认，即可逐一审核每个初始参数。例如初始配置的 Java 版本是 17，我本地只有 21，于是就有手动修改环节：

然后用 IDEA 打开该项目：

然后根据书中步骤，完成 Flight 实体、Passenger 实体及其各自的测试类的创建：

package com.manning.junitbook.flights;import com.manning.junitbook.passengers.Passenger;import java.util.HashSet;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;public class Flight {private final String flightNumber;private final int seats;private final Set<Passenger> passengers = new HashSet<>();private static final String flightNumberRegex = "^[A-Z]{2}\\d{3,4}$";private static final Pattern pattern = Pattern.compile(flightNumberRegex);public Flight(String flightNumber, int seats) {Matcher matcher = pattern.matcher(flightNumber);if (!matcher.matches()) {throw new RuntimeException("Invalid flight number");}this.flightNumber = flightNumber;this.seats = seats;}public String getFlightNumber() {return flightNumber;}public int getNumberOfPassengers() {return passengers.size();}public boolean addPassenger(Passenger passenger) {if (getNumberOfPassengers() >= seats) {throw new RuntimeException("Not enough seats for flight " + getFlightNumber());}return passengers.add(passenger);}public boolean removePassenger(Passenger passenger) {return passengers.remove(passenger);}
}

初始测试类 FlightTest：

package com.manning.junitbook.flights;import org.junit.jupiter.api.Test;import static org.junit.jupiter.api.Assertions.*;class FlightTest {@Testpublic void testFlightCreation() {Flight flight = new Flight("AA123", 100);assertNotNull(flight);}@Testpublic void testInvalidFlightNumber() {assertThrows(RuntimeException.class,() -> new Flight("AA12", 100));}
}

乘客实体类 Passenger：

package com.manning.junitbook.passengers;import java.util.Arrays;
import java.util.Locale;public class Passenger {private final String identifier;private final String name;private final String countryCode;public Passenger(String identifier, String name, String countryCode) {if (!Arrays.asList(Locale.getISOCountries()).contains(countryCode)) {throw new RuntimeException("Invalid country code");}this.identifier = identifier;this.name = name;this.countryCode = countryCode;}public String getIdentifier() {return identifier;}public String getName() {return name;}public String getCountryCode() {return countryCode;}@Overridepublic String toString() {return "Passenger " + getName() + " with identifier: " + getIdentifier() + " from " + getCountryCode();}
}

对应的初始测试类 PassengerTest：

package com.manning.junitbook.passengers;import org.junit.jupiter.api.Test;import static org.junit.jupiter.api.Assertions.*;class PassengerTest {@Testvoid testPassengerCreation() {Passenger passenger = new Passenger("123-45-6789", "John Smith", "US");assertNotNull(passenger);}@Testvoid testInvalidCountryCode() {assertThrows(RuntimeException.class,() -> new Passenger("900-45-6789", "John Smith", "GJ"));}@Testvoid testPassengerToString() {Passenger passenger = new Passenger("123-45-6789", "John Smith", "US");assertEquals("Passenger John Smith with identifier: 123-45-6789 from US", passenger.toString());}
}

由于 Flight 航班实体可以控制预订该航班乘客的数量，因此负责实现 Flight 的开发者又新增了一个集成测试类 FlightWithPassengersTest：

package com.manning.junitbook.flightspassengers;import com.manning.junitbook.flights.Flight;
import com.manning.junitbook.passengers.Passenger;
import org.junit.jupiter.api.Test;import static org.junit.jupiter.api.Assertions.*;public class FlightWithPassengersTest {private final Flight flight = new Flight("AA123", 1);@Testvoid testAddRemovePassengers() {Passenger passenger = new Passenger("124-56-7890", "Michael Johnson", "US");assertTrue(flight.addPassenger(passenger));assertEquals(1, flight.getNumberOfPassengers ());assertTrue(flight.removePassenger(passenger));assertEquals(0, flight.getNumberOfPassengers ());}@Testvoid testNumberOfSeats() {Passenger passenger1 = new Passenger("124-56-7890", "Michael Johnson", "US");flight.addPassenger(passenger1);assertEquals(1, flight.getNumberOfPassengers ());Passenger passenger2 = new Passenger("127-23-7991", "John Smith", "GB");final RuntimeException ex = assertThrows(RuntimeException.class, () -> flight.addPassenger(passenger2));assertEquals("Not enough seats for flight AA123", ex.getMessage());}
}

最后运行测试，为下一步 Git 仓库的初始化做准备：

13.4.2 Git 仓库初始化

根据书中的演示内容，远程仓库的地址是 \\192.168.1.5\ch13-continuous。这就需要在本地创建一个 Git 远程仓库，并共享该仓库，好让后续两个开发者签出代码。具体操作如下：

# 导航到示例项目根目录下
> cd F:/mydesktop/ch13_ci_demo/ch13-ci-demo
# 初始化 Git 仓库
> git init
# 添加 .gitignore 忽略文件，筛除无关内容
> vim .gitignore
> cat .gitignore
.idea
.mvntarget
# 添加本地变更
> git add *
# 生成首个本地提交版本
> git commit -m 'init commit'
[master (root-commit) 7c23e4d] init repo7 files changed, 255 insertions(+)create mode 100644 .gitignorecreate mode 100644 pom.xmlcreate mode 100644 src/main/java/com/manning/junitbook/flights/Flight.javacreate mode 100644 src/main/java/com/manning/junitbook/passengers/Passenger.javacreate mode 100644 src/test/java/com/manning/junitbook/flights/FlightTest.javacreate mode 100644 src/test/java/com/manning/junitbook/flightspassengers/FlightWithPassengersTest.javacreate mode 100644 src/test/java/com/manning/junitbook/passengers/PassengerTest.java

接下来这一步很关键，要在本地模拟一个 Git 远程仓库，名称为 ch13-continuous：

# 生成模拟远程仓库
> git init --bare ../ch13-continuous
Initialized empty Git repository in F:/mydesktop/ch13_ci_demo/ch13-continuous/
# 关联本地工作目录与远程仓库
> git remote add origin "F:\mydesktop\ch13_ci_demo\ch13-continuous"
# 推送本地变更到远程库
> git push -u origin master
Enumerating objects: 25, done.
Counting objects: 100% (25/25), done.
Delta compression using up to 16 threads
Compressing objects: 100% (12/12), done.
Writing objects: 100% (25/25), 3.74 KiB | 637.00 KiB/s, done.
Total 25 (delta 0), reused 0 (delta 0), pack-reused 0 (from 0)
To F:\mydesktop\ch13_ci_demo\ch13-continuous* [new branch]      master -> master
branch 'master' set up to track 'origin/master'.

然后共享该远程仓库，得到远程仓库的访问地址（即 \\TX2\ch13-continuous）：

然后就可以模拟两个开发者的工作目录了（devPassenger、devFlight）：

> (pwd).Path
F:\mydesktop\ch13_ci_demo
# 模拟维护 Passenger 的开发者 Beth，其本地工作目录命名为 devPassenger
> git clone \\TX2\ch13-continuous devPassenger
Cloning into 'devPassenger'...
done.
> cd devPassenger
> git config user.name Beth
> git config user.email "[e-mail]"
# 同理，模拟维护 Flight 的开发者 John，其本地工作目录命名为 devFlight
> git clone \\TX2\ch13-continuous devFlight
Cloning into 'devFlight'...
done.
> cd devFlight
> git config user.name John
> git config user.email "[e-mail]"

对上述操作不熟的朋友可以参考我的 Git 笔记专栏。

13.4.3 用 Jenkins 完成首次构建

这里实测时遇到个大坑：Windows 自动安装的 Jenkins 服务始终无法正常构建项目，因为出于安全考虑中止了本地共享文件夹做 Git 远程仓库的相关操作：

而按照截图中的提示，启动时需要添加一个系统属性 hudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT，值设为 true 就能运行。但无论是修改 Jenkins 安装目录下的配置文件 jenkins.xml，还是从 WebUI 界面运行 Groovy 脚本 System.setProperty('hudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT', 'true') 都不生效；唯一生效的方案是在 CMD 命令行用 java -jar 启动：

java -Dhudson.plugins.git.GitSCM.ALLOW_LOCAL_CHECKOUT=true -jar jenkins.war

这种方式也要重新安装插件（如图所示）、重新初始化登录帐号密码等例行步骤：

接着来到 新建Item 的配置页（http://localhost:8080/job/ch13-continuous/configure），在源码管理栏填写刚建好的远程 Git 仓库地址：

然后在 Build Steps 栏输入构建命令 clean install：

保存配置，就得到一个名为 ch13-continuous 的构建目标：

点击右边的运行按钮，完成首次构建：

稍等片刻，刷新页面会看到状态已经更新（表示构建成功）：

13.4.4 新增乘客主动选择航班接口

用 IDEA 打开由开发者 A 维护的工作目录 devPassenger，在 Passenger 实体类中新增一个实例方法 public void joinFlight(Flight flight)，让乘客可以自主选择某个航班：

public class Passenger {// -- snip --private Flight flight;public Flight getFlight() {return flight;}public void setFlight(Flight flight) {this.flight = flight;}public void joinFlight(Flight flight) {Flight previousFlight = this.flight;if (null != previousFlight) {if (!previousFlight.removePassenger(this)) {throw new RuntimeException("Cannot remove passenger");}}setFlight(flight);if (null != flight) {if (!flight.addPassenger(this)) {throw new RuntimeException("Cannot add passenger");}}}// -- snip --
}

这里一定要十分仔细，因为 Flight 和 Passenger 此时实现了双向通信，作为参数传入 joinFlight() 方法的 flight 对象也可以直接访问预订该航班的乘客集合 passengers，因此在第 L20 行指定新的航班前后，都需要 同步更新 前一航班及当前航班的乘客集合。

同时，集成测试类也要新增相应的测试用例，并微调之前的测试逻辑：

public class FlightWithPassengersTest {// -- snip --@Testpublic void testPassengerJoinsFlight() {Passenger passenger = new Passenger("123-45-6789", "John Smith", "US");Flight flight = new Flight("AA123", 100);passenger.joinFlight(flight);assertEquals(flight, passenger.getFlight());assertEquals(1, flight.getNumberOfPassengers());}@Testvoid testAddRemovePassengers() {Passenger passenger = new Passenger("124-56-7890", "Michael Johnson", "US");assertTrue(flight.addPassenger(passenger));assertEquals(1, flight.getNumberOfPassengers ());assertEquals(flight, passenger.getFlight());assertTrue(flight.removePassenger(passenger));assertEquals(0, flight.getNumberOfPassengers ());assertNull(passenger.getFlight());}// -- snip --
}

13.4.5 用 Jenkins 完成第二次构建

为了演示构建失败的效果，这里故意跳过了本地测试，直接推送到远程仓库：

> (pwd).Path
F:\mydesktop\ch13_ci_demo\devPassenger
> git add *.java
> git commit -m 'Allow the passenger to make the individual choice of a flight'
[master e5d238a] Allow the passenger to make the individual choice of a flight2 files changed, 38 insertions(+)
# 推送到远程仓库
> git push
Enumerating objects: 31, done.
Counting objects: 100% (31/31), done.
Delta compression using up to 16 threads
Compressing objects: 100% (8/8), done.
Writing objects: 100% (17/17), 1.43 KiB | 366.00 KiB/s, done.
Total 17 (delta 3), reused 0 (delta 0), pack-reused 0 (from 0)
To \\TX2\ch13-continuous7c23e4d..e5d238a  master -> master
# 确认推送结果
> git log --oneline --graph --decorate --all
* e5d238a (HEAD -> master, origin/master, origin/HEAD) Allow the passenger to make the individual choice of a flight
* 7c23e4d init repo
> 

回到 Jenkins 页面，重新构建项目失败了：

从编号为 #2 的构建记录中查看报错原因，发现有个为空的断言失败了：

在 IDEA 中再次定位报错断言：

13.4.6 修复集成测试中的 Bug

经分析，是 Flight 在管理乘客时没有对该乘客所在的航班进行同步关联，这需要另一名开发者进行修改。于是负责 Flight 的开发者 John 先同步最新的代码到他的工作空间：

> (pwd).Path
F:\mydesktop\ch13_ci_demo\devFlight
> git pull
From \\TX2\ch13-continuous+ 3a43104...e5d238a master     -> origin/master  (forced update)
Updating 7c23e4d..e5d238a
Fast-forward.../manning/junitbook/passengers/Passenger.java    | 26 ++++++++++++++++++++++.../FlightWithPassengersTest.java                  | 12 ++++++++++2 files changed, 38 insertions(+)
> 

再对 addPassenger() 和 removePassenger() 修改如下（L7、L12）：

public class Flight {// -- snip --public boolean addPassenger(Passenger passenger) {if (getNumberOfPassengers() >= seats) {throw new RuntimeException("Not enough seats for flight " + getFlightNumber());}passenger.setFlight(this);return passengers.add(passenger);}public boolean removePassenger(Passenger passenger) {passenger.setFlight(null);return passengers.remove(passenger);}
}

在本地运行 mvn test 确认无误后，再推送到远程：

> git add *.java
> git commit -m 'Adding integration code for a passenger join/unjoin'
[master 3a43104] Adding integration code for a passenger join/unjoin1 file changed, 2 insertions(+)
> git push
Enumerating objects: 19, done.
Counting objects: 100% (19/19), done.
Delta compression using up to 16 threads
Compressing objects: 100% (5/5), done.
Writing objects: 100% (10/10), 711 bytes | 355.00 KiB/s, done.
Total 10 (delta 2), reused 0 (delta 0), pack-reused 0 (from 0)
To \\TX2\ch13-continuouse5d238a..3a43104  master -> master
> 

13.4.7 用 Jenkins 完成第三次构建

再次回到 Jenkins 页面，状态图标重新变为正常，构建成功，Bug 已修复：

完整的构建历史记录如下：

至此，Jenkins 持续集成与示例开发流程的交互过程全部演示完毕。