# fuzzing4j

**Repository Path**: ali_studio/fuzzing4j

## Basic Information

- **Project Name**: fuzzing4j
- **Description**: 基于JQF，使运行模糊测试更方便
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-03-29
- **Last Updated**: 2023-06-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# fuzzing4j
A simple fuzzing tool for java base on JQF

### 一.概述
模糊测试是一种软件测试技术。其核心思想是将自动或半自动生成的随机数据输入到一个程序中， 并监视程序异常，如崩溃，断言失败，以发现可能的程序错误，比如业务逻辑异常或内存泄漏。

### 二.模糊测试的作用
1) 通过输入大样本参数提高放方法的业务场景覆盖面，可提前发现业务逻辑异常；
2) 可检测出不易排查的系统级错误；

### 三.Fuzzing4j
基于JQF，提供了更便利的使用方式，可以个性化单个用例的执行次数或时间并一次性运行所有模糊测试用例，然后将结果记录到Excel文件。

相关注解及API介绍

#### 1.@Fuzz

加在类和方法上；标注类和方法为模糊测试用例。

**测试用例类名必须以Fuzz结尾。**

示例：
~~~~
@Fuzz
public class SomeClassFuzz{
    @Fuzz(times=10)
    public void fuzzingMethod(String param){
    ...
    }
}
~~~~
#### 2.@Inject

加在测试用例类的属性上；标注该属性的值将由外部创建后注入；配合Configurator接口使用。

示例：
~~~~
@Fuzz
public class SomeClassFuzz{
    @Inject(cfg = SpringConfigurator.class , value = "applicationContext")
    public ApplicationContext applicationContext;
}
~~~~

#### 3.Configurator接口

该接口用来定义全局资源。防止在模糊测试过程中频繁创建资源。

**其实现类必须以Configurator结尾。**

示例：

~~~~
public class SpringConfigurator implements Configurator{
    public ApplicationContext applicationContext;
    @Override
    public void init(){
        applicationContext = new SpringApplicationBuilder(XxxBootStarter.class).application().run();
    }
    @Override
    public Object lookup(){
        return applicationContext;
    }
    @Override
    public Object lookup(String name){
        return "applicationContext".equals(name)
                            ?applicationContext
                            :null;
    }
}
~~~~

### 四.运行

#### 1.IDE中运行

test目录下建立任意类，添加main方法：
~~~~
public class FuzzRunner{
    public static void main(String[] args){
        args=new String[]{
            "-q=true",//静默执行
            "-aoc=false",//用例出错是否中断
            "-d=PT30s",//全局参数-用例运行时间
            "-t=10"//全局参数-执行次数;优先级高于-d
        }
        String tcp=FuzzRunner.class.getResource("/").getPath();
        int exitCode=new CommandLine(new FuzzingCLI(tcp)).execute(args);
        System.exit(exitCode);
    }
}
~~~~
#### 2.Maven方式
引入依赖包:
~~~~
<dependency>
	<groupId>fuzzing4j</groupId>
	<artifactId>fuzzing4j-jqf-impl</artifactId>
	<version>1.0.0</version>
</dependency>
...
<plugin>
	<groupId>fuzzing4j</groupId>
	<artifactId>fuzzing4j-maven-plugin</artifactId>
	<version>1.0.0</version>
</plugin>
~~~~
命令行跳转到项目根目录下，执行:
~~~~
mvn fuzzing4j:fuzz
~~~~
参数同main方法执行;无参时,默认每个方法执行60s。

### 五.Mock与Spring

JQF基于Junit，可以直接支持Mockito框架；但不能支持Powermock，也不支持SpringTest；涉及Spring相关Mock时需要手动设置。

可以结合使用TestableMock来简化Mock编写，详见：<https://github.com/alibaba/testable-mock>
~~~~
@Fuzz
public class SomeClassFuzz{
    @Inject(cfg = SpringConfigurator.class , value = "applicationContext")
    private ApplicationContext applicationContext;
    //目标类;直接从Spring容器获取,不能使用@InjectMocks注解
    private SomeClass someClass;
    //需要mock的依赖类;不支持使用@MockBean
    @Mock
    private MockClass mockClass;
    
    @Before
    public void before(){
        MockitoAnnotations.initMocks(this);
        //手动获取目标类对象
        someClass=applicatioinContext.getBean(SomeClass.class);
        //目标类对象依赖的Mock对象需手动注入
        ReflectionTestUtils.setField(someClass,"mockClass",mockClass);
        /Mock类操作
        Mockito.doReturn(1).when(mockClass).someMethod("param");
    }
    
    @Fuzz(times=100)
    public void fuzzTargetMethod(String param){
        Assume.assumeTrue(param.length()>10);
        String result=someClass.targetMethod(param);
        Assert.assertEquals("SUCCESS",result);
    }
}
~~~~
### 六.版本问题

JUnit版本需4.13.1及以上；

JQF依赖ASM8及以上；spring-boot-start-test包依赖的json-path依赖了ASM5，引入时会引起jar包冲突，需排除json-path。