Android增量代码覆盖率测试在被窝家装App中的探索与实践

public static void example() {
    a();
    if (cond()) {
        b();
    } else {
        c();
    }
    d();
}

public static example()V
      INVOKESTATIC a()V
      INVOKESTATIC cond()Z
      IFEQ L1
      INVOKESTATIC b()V
      GOTO L2
  L1: INVOKESTATIC c()V
  L2: INVOKESTATIC d()V
      RETURN

class JacocoExtension {
    //jacoco开关，false时不会进行probe插桩
    boolean jacocoEnable
    //需要对比的分支名
    String branchName
    //exec文件路径，支持多个ec文件，自动合并
    String execDir
    //源码目录，支持多个源码
    List<String> sourceDirectories
    //class目录，支持多个class目录
    List<String> classDirectories
    //需要插桩的文件
    List<String> includes
    //生成报告的目录
    String reportDirectory
    //git 提交命令
    String gitPushShell
    //复制class 的shell
    String copyClassShell
    //git-bash的路径，插件会自动寻找路径，如果找不到，建议自行配置
    private String gitBashPath
    //下载ec 的服务器
    String host
    //类过滤器 返回 true 的将会被过滤
    Closure excludeClass
    //方法过滤器 返回true 的将会被过滤
    Closure excludeMethod
}

git diff origin/feature/jinggong-1.7.6 origin/master --name-only

#!/bin/sh
oriBran=$(git name-rev --name-only HEAD)
echo "当前分支：$oriBran" #remotes/origin/main_DEALER-2932

gitBran=$1 # 本地分支
echo "gitBran=$gitBran"
workDir=$2
outDir=$3
echo "workDir=$workDir"
echo "outDir=$outDir"

echo "start checkout--"
git checkout -b $gitBran origin/$gitBran
git checkout -f $gitBran

echo "start pull--"
git pull

echo "start copy: cp -r "${workDir}/app/classes" $outDir "
cp -r "${workDir}/app/classes" $outDir

echo "copy over --"

public class DiffClassVisitor extends ClassVisitor {
  private String className;
  private int type;
  ...
  @Override
  public MethodVisitor visitMethod(int access, String name, String desc, String signature,
      String[] exceptions) {
    MethodVisitor mv = super.visitMethod(access, name, desc, signature, exceptions);
    final MethodInfo methodInfo = new MethodInfo();
    methodInfo.className = className;
    methodInfo.methodName = name;
    methodInfo.desc = desc;
    methodInfo.signature = signature;
    methodInfo.exceptions = exceptions;
    mv = new MethodVisitor(Opcodes.ASM5, mv) {
      StringBuilder builder = new StringBuilder();
      //访问方法一个参数
      @Override
      public void visitParameter(String name, int access) {
        builder.append(name);
        builder.append(access);
        super.visitParameter(name, access);
      }

      //访问方法的一个注解
      @Override
      public AnnotationVisitor visitAnnotation(String desc, boolean visible) {
        builder.append(desc);
        builder.append(visible);
        //                System.out.println("visitAnnotation--desc:" + desc + "  visible:" + visible);
        return super.visitAnnotation(desc, visible);
      }

      //访问方法签名上的一个类型的注解
      @Override
      public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, String desc,
          boolean visible) {
        builder.append(typeRef);
        builder.append(typePath.toString());
        builder.append(desc);
        builder.append(visible);
        return super.visitTypeAnnotation(typeRef, typePath, desc, visible);
      }

      //省略很多过程方法......

      //方法访问结束
      @Override
      public void visitEnd() {
        String md5 = "";
        try {
          md5 = Util.MD5(builder.toString());
        } catch (NoSuchAlgorithmException | UnsupportedEncodingException e) {
          e.printStackTrace();
        }
        methodInfo.md5 = md5;
        DiffAnalyzer.getInstance().addMethodInfo(methodInfo, type);
        super.visitEnd();
      }
    };
    return mv;
  }
}

public void diff() {
    if (!currentList.isEmpty() && !branchList.isEmpty()) {
        for (MethodInfo cMethodInfo : currentList) {
            boolean findInBranch = false;
            for (MethodInfo bMethodInfo : branchList) {
                if (cMethodInfo.className.equals(bMethodInfo.className)
                        && cMethodInfo.methodName.equals(bMethodInfo.methodName)
                        && cMethodInfo.desc.equals(bMethodInfo.desc)) {
                    if (!cMethodInfo.md5.equals(bMethodInfo.md5)) {
                        diffList.add(cMethodInfo);
                    }
                    findInBranch = true;
                    break;
                }
            }
            if (!findInBranch) {
                diffList.add(cMethodInfo);
            }
            diffClass.add(cMethodInfo.className);
        }
    }
}

@Override
void processClass(File fileIn, File fileOut) throws IOException {
    if (shouldIncludeClass(fileIn)) {
        InputStream is = null;
        OutputStream os = null;
        try {
            is = new BufferedInputStream(new FileInputStream(fileIn));
            os = new BufferedOutputStream(new FileOutputStream(fileOut));
            // For instrumentation and runtime we need a IRuntime instance
            // to collect execution data:
            // The Instrumenter creates a modified version of our test target class
            // that contains additional probes for execution data recording:
            final Instrumenter instr = new Instrumenter(new OfflineInstrumentationAccessGenerator());

            final byte[] instrumented = instr.instrument(is, fileIn.getName());
            os.write(instrumented);
        } finally {
            closeQuietly(os);
            closeQuietly(is);
        }
    } else {
        FileUtils.copyFile(fileIn, fileOut);
    }
}

@Override
public MethodVisitor visitMethod(final int access, final String name,
                                 final String desc, final String signature,
                                 final String[] exceptions) {
    if (DiffAnalyzer.getInstance().containsMethod(className, name, desc)) {
        InstrSupport.assertNotInstrumented(name, className);
        final MethodVisitor mv = cv.visitMethod(access, name, desc, signature, exceptions);
        if (mv == null) {
            return null;
        }
        final MethodVisitor frameEliminator = new DuplicateFrameEliminator(mv);
        final ProbeInserter probeVariableInserter = new ProbeInserter(access,
                name, desc, frameEliminator, probeArrayStrategy);
        return new MethodInstrumenter(probeVariableInserter,probeVariableInserter);
    } else {
        return super.visitMethod(access, name, desc, signature, exceptions);
    }
}

public class MyApplication extends EngineApplication {

  @Override
  public void onCreate() {
    super.onCreate();
    if (AppJingGongConfig.IS_DEBUG) {
      //测试包增加代码覆盖率初始化
      CodeCoverageManager.init(this, "文件上传服务器地址");
      //启动时上传上次记录的ec文件
      CodeCoverageManager.uploadData();
    }
  }
}

@Override
protected void onDestroy() {
  super.onDestroy();
  if (AppJingGongConfig.IS_DEBUG) {
    //记录操作文件
    CodeCoverageManager.generateCoverageFile();
  }
}

class BranchDiffTask extends DefaultTask {

  @TaskAction
  def getDiffClass() {
    //下载ec文件
    downloadEcData()

    //生成差异报告
    pullDiffClasses()

    if (jacocoExtension.reportDirectory == null) {
      jacocoExtension.reportDirectory = "${project.buildDir.getAbsolutePath()}/outputs/report"
    }
    //生成覆盖率报告
    ReportGenerator generator = new ReportGenerator(jacocoExtension.execDir,
        toFileList(jacocoExtension.classDirectories),
        toFileList(jacocoExtension.sourceDirectories), new File(jacocoExtension.reportDirectory));
    generator.create();
  }
}