jacoco多版本报告合并

jacoco提供了一个merge命令可以给我方便的合并代码无变更时的报告，但是一旦代码发生变化，则无法通过jacoco进行直接合并，原因在《jacoco的多次代码提交merge分析》中已经说明，那么针对一次功能测试，势必会进行多轮，每一轮针对变更的数据进行覆盖率增量报告，这是没有什么问题的，但是对于一些需求可能需要展示整个测试的覆盖报告，怎么将变更类的报告也进行合并呢？这就是本文讨论的问题。

通过之前的博客，我们理解了一旦类发生变更，探针的顺序势必不同，进而无法进行合并，因为jacoco的探针数据只是存储了其顺序和是否被访问，我们无法直接将两个探针进行强制合并。网络上针对代码变更类报告合并的资料相对比较少，很多实现的方案是基于一个最终报告的裁剪，比如我第一的报告有一个a方法，他的覆盖行数是10，第二次他的覆盖行数是20，简单做了一个累加就决定了他的覆盖行数是30（这里指指令），这样明显的漏洞是我第二次的覆盖里面包含了第一次的几行，两者应该是取并集，但是jacoco的报告里有报告相关的数据，不会有具体某个指令的覆盖情况，所以基于这种方式合并报告误差率非常高。

在做不同版本之间的类覆盖率合并我们通过上图可以知道，类一致会自动合并，类发生变更后我们以方法为维度合并，如上图所示，类A有四个方法，只覆盖了A、B、D三个方法，在做第二个版本的时候，D方法被删除，新增了E方法，但是只覆盖了C方法和E方法，其中B方法发生了变动，所以我们的B方法无法继承，需要重新覆盖，最终得出的覆盖方法应该是A、C、E。所以在我上一篇博客中存在表述错误，不用关心方法之间的调用关系，只需要合并变动类中没有变动的方法覆盖率即可。

当我们去生成报告的时候，非常重要的一个文件是jacoco.exec文件，我们可以通过官方人提供的命令去简单查看一下其内容：

java -jar jacococli.jar execinfo jacoco.exec 

第一行是一个classid,在上一篇文章中有讲解过，第二个数据就是每个类探针的信息，第三个数据就是类名。我们再梳理下jacoco生成报告的过程

因为exec文件没有记录方法的信息，所以生成报告的阶段则是会基于class文件重新进行一次插桩，同时会把探针的访问信息也会恢复，这样jacoco再使用ASM遍历每个类每个方法的指令去收集指令的覆盖率，然后以此再一层层运算到行覆盖率，方法覆盖率，类覆盖率，包覆盖率等。
根据上图所示，我们想对相同全限定名的类进行合并，则需要再对指令覆盖率进行合并。
在此基础上我们首先要对jacoco的report源码有一定的了解。

jacoco的report源码分析

很多伙伴对jacoco的调试功能比较陌生，其实我们使用jacoco的单测就很方便进行代码调试，我们以report cli为入口

只需要在这里写我们自己的单测用例即可

我们以reportcli为入口，如上图所示，我们在report的时候，主要有三个方法

1. 解析exec文件并合并探针（只能合并相同classId的类的探针)
2. 根据class文件和探针信息获取覆盖数据
3. 绘制报告，在源码上渲染覆盖信息
   第一个方法我们再merge源码分析里已经清晰讲解过，这里我们详细讲解下第二个方法（第三个方法用例变更代码打标签功能，有兴趣的小伙伴可以自行了解下）
   
   如上图所示，该方法会遍历我们所有文件里的class文件，在此之前创建了一个CoverageBuilder对象，这个对象会贯穿我们整个报告计算并最终得到源码覆盖率信息
   在上文我们已经提到过，由于探针记录的信息非常有限，我们想要得到指令的覆盖率，只能在class基础上再一次进行插桩，这也是为什么classid一旦发生改变无法进行合并的原因，在找到每一个class文件后进行遍历解析
   
   这里我们要关注一下createAnalyzingVisitor方法，他的主要作用是为每个class文件创建一个ClassVistor
   
   核心功能来了，这里我们遍历class文件内的每个方法，然后进行了插桩，通过个InstructionsBuilder对象接受了指令的覆盖信息，指令覆盖信息是jacoco覆盖率最基础最原子的数据，后面的行覆盖率，类覆盖率都是基于指令覆盖率去计算的，所以我们想做不同版本类的覆盖率，需要去合并指令覆盖率，这里有一个核心问题是一旦类发生变更了，但是其中的没有变更的方法指令是否是一样的呢
   
   
   
   通过对比两个字节码，我们清晰的可以看出，指令是完全一样的，除了行号，那么我们是否就可以以此作为我们的突破口呢？
   ASM在遍历方法的指令时得到的结果又是怎样的呢？我们找到了两个不同版本的统一类进行分析
   

由于截图所限我们发现指令的key完全是一模一样的，只不过指令的value里面的line是不一样的，其实看到这里我们就很清晰的知道合并指令，只需要合并branchs和coveredBranches即可，难点在于我们怎么判断两个方法是否相等，怎么判断两个指令是否相等（指令有很多种类型），由于builder对象存储的指令信息是map结果，无序的，无疑给我们的判断指令相等带了了更加复杂的挑战，就像上图所示的。如果是fieldInsnNode的指令类型，我们则需要判断操作码，onwe,name,desc等是否相等，如果是VarInsNode的指令，则需要判断操作码和var是否相等。

合并思路

1. 引入历史版本的class文件

由于需要解析方法指令覆盖率，我们在原有的基础上需要引入历史版本的class文件

    @Option(name = "--oldClassfiles", usage = "location of old Java class files", metaVar = "<path>")
    List<File> oldclassfiles = new ArrayList<File>();

2. 过滤历史版本的class文件
   拿到历史版本的class文件后，我们则需要对classs文件进行过滤，因为一个工程的class文件会特别多，这里我们可以采取使用executionData的classId进行过滤，没有覆盖率的类没有必要进入后续的计算。
3. 先对历史版本的class文件进行插桩和指令覆盖率计算，然后将结果存储到一个map中

   //历史版本指令覆盖率，key为方法签名，value为指令覆盖率
    private Map<String, List<Map<AbstractInsnNode, Instruction>>> oldClassInstructionsMap = new HashMap<>();

需要注意的是我们只需要拿到历史版本的指令覆盖率，不需要进行后续逻辑，所以一旦获取到指令后中断
4. 进行当前版本正常的覆盖率计算，当发现存在oldClassInstructionsMap是进行指令合并
指令合并的思路是保证指令的唯一性，这样做方法变动版本和指令合并就会带来更加方便的操作，这里给每个指令加上一个签名

 

/**
 * 指令标志
 */
private String instructionSign;

在记录指令信息的时候将指令标识也维护进去，这样就能拿到每个指令的唯一标识了,这里有个点需要注意的是，我们的一个方法内部的指令可能是相同的，而ASM的解析指令是按照指令先后顺序来的，所以我们只需要给每个指令签名加上一个自增的编号，就能为一确认指令了。

    void addInstruction(final AbstractInsnNode node, String instructionSign) {
        instructionSign = node.getType() + "#" + instructionSign + "#" + this.index++;
        final Instruction insn = new Instruction(currentLine, instructionSign);
        final int labelCount = currentLabel.size();
        if (labelCount > 0) {
            for (int i = labelCount; --i >= 0; ) {
                LabelInfo.setInstruction(currentLabel.get(i), insn);
            }
            currentLabel.clear();
        }
        if (currentInsn != null) {
            currentInsn.addBranch(insn, 0);
        }
        currentInsn = insn;
        instructions.put(node, insn);
    }

对于指令合并jacoco本身提供了一个这样的方法

    public Instruction merge(final Instruction other) {
        final Instruction result = new Instruction(this.line);
        result.branches = this.branches;
        result.coveredBranches.or(this.coveredBranches);
        result.coveredBranches.or(other.coveredBranches);
        result.instructionSign= this.instructionSign;
        return result;
    }

最终效果如下，我们第一个版本做了一个全量的覆盖，第二个版本删除了test3,新增了test4,但是只副高绿test2和test4方法，我们合并报告后则会把之前test1的报告进行合并，最终得到一个全量的覆盖结果，指令覆盖结果也是没有出错的

到此我们的多版本class报告合并就完成了，思路其实不麻烦，重点是了解jacoco在生成报告的逻辑，然后进行改造就可以了。