基于SpringBoot的自动化单元测试框架

基于SpringBoot的自动化单元测试框架

相信很多开发者和团队都没有编写测试用例的习惯，究其原因，时间和精力是罪魁祸首，国内很多中小企业团队因为成本的原因不愿意把大量的时间投入在单元测试上，且多年来这个痛点在业界一直未得到解决，殊不知，单元测试是最直接、最快捷发现问题的手段。针对此问题，我们在Cat2Bug生态中添加了智能化自动单元测试框架Cat2Bug-JUnit，目标是通过几分钟简单的配置后，可以让框架自动发现并测试几百甚至上千个功能点。

连接

• 官网: https://www.cat2bug.com
• library github: https://github.com/cat2bug/cat2bug-junit
• library gitee: https://gitee.com/cat2bug/cat2bug-junit

软件架构

Cat2Bug-Spring-Boot-JUnit 以Spring Boot 2、JUnit 4 为基础,添加测试报告推送、扫包自动创建测试类功能，使开发人员可以通过添加简单注解快速进行单元测试。

运行流程

优势与特点

• 目前世面上唯一一种SpringBoot自动化单元测试框架
• 极大减少单元测试的维护时间和成本，基本可以将单元测试成本降为零，可以做到1分钟的代码编写，测试几百个接口。
• 基于Cat2Bug生态圈中，可以结合Cat2Bug-Platform平台管理Bug的生命周期，通过多样性的可视化报表辅助项目经理了解系统的实时状态。

安装

• Gradle

testImplementation ("com.cat2bug:cat2bug-spring-boot-junit:0.0.3")

• Maven

<dependency>
    <groupId>com.cat2bug</groupId>
    <artifactId>cat2bug-spring-boot-junit</artifactId>
    <version>0.0.4</version>
    <scope>test</scope>
</dependency>

在Cat2Bug生态下使用

目前Cat2Bug-Spring-Boot-JUnit可以结合Cat2Bug-Platform平台无缝联合使用，
Cat2Bug-Spring-Boot-JUnit负责单元测试，并将测试后的报告通过Open API推送到Cat2Bug-Platform平台，
Cat2Bug-Platform平台则用于管理报告中的缺陷，并可导出相关测试报告，其生态架构如下：

Cat2Bug-Platform环境的创建

如果需要在单元测试完成后，将测试失败的缺陷结果提交到BUG系统，需先部署Cat2Bug-Platform平台，并设置API KEY，以下介绍一种快速部署方式，更多详情请参阅Cat2Bug官网文档。

1. Docker下载Cat2Bug-Platform容器并部署，执行代码如下：

docker run -it -d -p 8022:8022 --name cat2bug-platform cat2bug/cat2bug-platform:latest

启动成功后，在浏览器访问http://127.0.0.1:8022， 如果可以正常访问，代表平台启动成功；

2. 在Cat2Bug-Platform平台,依次注册用户，创建团队，创建项目后，在项目设置的API KEY中，添加一个KEY，用于单元测试提交报告的鉴权用，界面如下：

至此，Cat2Bug-Platform环境已经创建完成。

使用说明

使用前注意事项

由于Cat2Bug-Spring-Boot-JUnit是通过反射机制动态创建的测试类，而所用反射到的Java类库在JDK9+版本以上都必须显式的手动开启，
因此在执行测试的时候，需要手动添加启动参数，以下已IDEA编辑器、JDK17为例，添加参数如下图：

如不加以上红框的饿配置，执行时会报找不到某些类的错误，我们也可以根据提示添加缺少的类包，Java8不会出现此问题。

测试所有接口

与JUnit测试相同，在Spring工程中创建测试类，代码如下：

@SpringBootTest
@RunWith(Cat2BugAutoSpringSuite.class)
@AutoTestScan(packageName = "com.cat2bug.junit.demo.controller")
public class Cat2bugSpringBootDemoApplicationTests {
    // 不用写任何代码
}

• @SpringBootTest：为Spring测试注解；
• @RunWith(Cat2BugAutoSpringSuite.class)：为使用Cat2Bug的套件测试；
• @AutoTestScan(packageName = “com.cat2bug.junit.demo.controller”)：需要扫描的包路径；

通过添加以上三个注解，即可自动扫描测试所有工程中的接口，所有状态码返回200的接口认定为通过测试，测试结果将形成报告，打印在控制面板中，如下图：

为指定接口设置请求参数

目前Cat2Bug-Spring-Boot-JUnit是给所有接口设置随机值进行测试的，我们也提供了RandomParameter注解为特定接口进行自定义参数的设置。示例如下：

@SpringBootTest
@RunWith(Cat2BugAutoSpringSuite.class)
@AutoTestScan(packageName = "com.cat2bug.junit.demo.controller")
@Transactional
public class Cat2bugSpringBootDemoApplicationTests {
    /**
     * 为UserController的updateUser方法设置用户参数
     * @param userRepository JAP的用户操作类
     * @return  传给updateUser接口的用户实例
     */
    @RandomParameter(className = "com.cat2bug.junit.demo.controller.UserController", methodName = "updateUser", parameterName = "user")
    public User insertUser(
            @Autowired UserRepository userRepository
    ) {
        User user = new User(1L,"admin","cat2bug");
        return userRepository.save(user);
    }

    /**
     * 设置所有接口方法包含Id的参数值。
     *
     * @return 用户ID
     */
    @RandomParameter(parameterName = ".*Id.*")
    public long userId() {
        return 1L;
    }

    /**
     * 设置参数名等于name的值。
     *
     * @return
     */
    @RandomParameter(parameterName = "name")
    public String name() {
        String[] names = { "唐玄奘", "孙悟空", "猪八戒", "沙悟净" };
        return names[(int) (Math.random() * names.length)];
    }
}

注意：RandomParameter注解的方法不能调用本类的其它方法或全局变量，因为这些带有RandomParameter方法会复制到临时的测试类中，而方法外的其它方法或属性不会被复制。

基于Spring Security的测试

在大部分的软件工程中，接口都会受权限控制，因此，在Cat2Bug-Spring-Boot-JUnit中也提供了相应的解决方案，实现代码如下：

@SpringBootTest
@RunWith(Cat2BugAutoSpringSuite.class)
@AutoTestScan(packageName = "com.cat2bug.junit.demo.controller")
@Authentication(name = "admin",password = "cat2bug")
public class Cat2bugSpringBootDemoApplicationTests {
    // 不用写任何代码
}

此方式提供的Authentication注解，用于在测试类中自动注入用户权限，其属性说明如下：

• name：系统用户账户
• password：系统用户密码

除了标准的通过注解方式鉴权之外，由于一些系统自定义处理了用户权限，因此，也可以实现一个方法用来自定义权限，代码如下：

@SpringBootTest
@RunWith(Cat2BugAutoSpringSuite.class)
@AutoTestScan(packageName = "com.cat2bug.junit.demo.controller")
public class Cat2bugSpringBootDemoApplicationTests {
    @Autowired
    public void Security(AuthenticationManager authenticationManager) {
        // 以下是标准赋权方式，用户可根据自己需求编写代码
        UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken("admin", "cat2bug");
        SecurityContext securityContext = SecurityContextHolder.createEmptyContext();
        securityContext.setAuthentication(authenticationManager.authenticate(authenticationToken));
        SecurityContextHolder.setContext(securityContext);
    }
}

通过以上两种方式中的任意一种，即可获取权限测试接口。

报告推送到Cat2Bug-Platform平台

在测试完成后，可将测试报告推送到Bug管理平台，执行代码如下:

@SpringBootTest
@RunWith(Cat2BugAutoSpringSuite.class)
@AutoTestScan(packageName = "com.cat2bug.junit.demo.controller")
@PushReport(host = "http://127.0.0.1:8022", projectKey = "20240225012438h19zzdb6sd1ahazj", handler = "admin", type = "all", version = "0.0.3")
public class Cat2bugSpringBootDemoApplicationTests {
    // 不用写任何代码
}

PushReport注解即推送数据之用，其参数功能如下：

• host：接口地址；
• projectKey：在Cat2Bug-Platform中创建的Open API密钥；
• handler：缺陷处理人，Cat2Bug-Platform中用户的登陆账号；
• type：提交的类型，all为成功失败都提交，defect为只提交失败的缺陷；
• version：测试的工程版本

除此之外，host、projectKey、handler属性也可以在SpringBoot的application.yml中设置，配置如下:

cat2bug:
  junit:
    push-report:
      host: http://127.0.0.1:2020/
      project-key: 2024032722581018ubh4nfreu1vqse
      handler: demo
      type: all
      version: 0.0.3

注意：注解的属性值优先于application.yml中的值，单元测试执行完成后，会在命令行中显示推送成功的信息。

Title: 提交测试报告
推送地址:http://127.0.0.1:8022/api/report/defect
处理人:admin
推送报告成功

Cat2Bug-Platform平台接收到的报告显示如下：

报告

Cat2Bug-Spring-Boot-JUnit中提供了多种类型的报告：

• 编译类报告：统计自动化扫描到的接口，并编译生测试类是否成功的报告；
• 测试类报告：统计每个测试类成功、失败的数据总和；
• 测试接口报告：显示每个接口测试相关信息的报告；
• HTML报告：已Html文件形式显示的报告，文件输出到工程编译目录，默认为target目录；
• 推送报告：推送到Cat2Bug-Platform的报告；

Cat2Bug交流群

QQ群： 731462000