oracle存储过程代码覆盖率统计工具

目前针对于高级语言如C++,JAVA,C#等工程都有相关的代码覆盖率统计工具，但是对于oracle存储过程或者数据库sql等方面的项目，代码覆盖率统计和扫描工具相对较少。

因此针对这种情况，设计了代码覆盖率统计工具，其实oracle已经提供了较好的代码profiler包，本文主要介绍利用DBMS_PROFILER设计的代码覆盖率统计工具。

1.代码打桩

获取代码覆盖率的前提是，需要对被测代码进行profiler,也就是打桩，需要有一个计数器去统计被执行到的代码行。Oracle提供了一个有用的工具包叫DBMS_PROFILER。通过这个包我们可以对被测的SP代码进行打桩，这个包不但可以获取被执行的代码行，而且还可以统计出代码执行的时间，也是用来做代码调优的有用工具。

工具包的使用也很方便：

1. 安装工具包，只需要在sqlplus中运行profload.sql（/oracle_home/ rdbms/admin目录下）用
2. 生成数据收集表，运行proftab.sql可以生成三张数据表，

plsql_profiler_runs ：运行记录，最重要字段为runid。

plsql_profiler_units： 每次runid对应的各个unit的一般信息

plsql_profiler_data：每次runid对应的各个unit具体line的详细信息

1. 代码打桩，在需要被测试的SP前调用dbms_profiler.start()，在sp执行结束的地方调用dbms_profiler.stop()。

在PL/SQL开头结尾添加即可

begin

DBMS_PROFILER.START_PROFILER('PLSQLNAME:'||TO_CHAR(SYSDATE,'YYYY-MM-DD HH:MI:SS'));

pl/sql statements;

DBMS_PROFILER.STOP_PROFILER;

end;

通过上述过程，测试人员在做手工测试执行之前，需要先对要测试的代码进行打桩，或者可以通过plsql来对代码进行打桩。而开发人员在做单元测试的时候可以对自己的sp代码进行打桩。

2.覆盖率数据收集

      需要从以下三张表中收集代码覆盖率数据：

      All_source:

      plsql_profiler_units:

      plsql_profiler_data:

      通过以下sql可以汇总覆盖率数据：

       

SELECT u.UNIT_OWNER || '.' || u.UNIT_NAME AS "Unit", s.line, CASE WHEN d.TOTAL_OCCUR >= 0 THEN 'C' ELSE '0' END AS Covered, s.TEXT, TO_CHAR(d.TOTAL_TIME / (1000*1000*1000), 'fm990.000009') AS "Total Time (sec)", CASE WHEN NVL(d.TOTAL_OCCUR, 1) > 0 THEN d.TOTAL_OCCUR ELSE 1 END AS "# Iterations"  , TO_CHAR(CASE WHEN d.TOTAL_OCCUR > 0 THEN d.TOTAL_TIME / (d.TOTAL_OCCUR * (1000*1000*1000))ELSE 0.0000 END, 'fm990.000009') AS "Avg Time (sec)" FROM all_source s LEFT JOIN plsql_profiler_units u ON s.OWNER = u.UNIT_OWNER AND s.NAME = u.UNIT_NAME AND s.TYPE = u.UNIT_TYPE LEFT JOIN plsql_profiler_data d ON u.UNIT_NUMBER = d.UNIT_NUMBER AND s.LINE = d.line# AND d.RUNID = u.RUNID WHERE u.unit_owner NOT IN ('SYSTEM','ULOG','<anonymous>') and s.TYPE not in ('PACKAGE SPEC')ORDER BY u.UNIT_NAME, s.LINE

得到如下图所示数据。

视图中Unit这个字段为存储过程的包名，covered这个字段中若是用代码被执行到就会被赋值为”C”，该字段的值主要是通过plsql_profiler_data中的total_occur这个字段的值来获取的，这个字段的值要是大于1那么，上图Iterations的值等于total_occur表示改行代码被执行的次数。此外视图中还有一些关于代码执行所花费的总体执行时间和平均执行时间的计算。

         可以通过计算covered字段中”c”值的总体个数除以包中代码总行数来计算包中代码的行覆盖率。由于代码覆盖率的计算公式为：执行代码行数（executed lines）/总体代码行数(total lines)*100。因此若要提高代码覆盖率，可以通过降低总体代码行数或者增加执行代码行数，其中降低总体代码行数需要结合技术公司开发规范，如哪些代码是不需要被统计到总体代码行数中的。而增加执行代码行数则需要测试人员或者开发人员丰富测试用例来覆盖相关的代码行。这样才能得到一个比较科学的代码行覆盖率。

         本次代码覆盖率工具的收集在第一阶段只能做到代码行覆盖，需要结合公司的开发规范进行统计。

3. 报告生成

主要通过java+bootstrap+cli等工具，封装生成基于命令行操作的代码覆盖率报告生成工具，首页展示所有package中sp总体的覆盖率信息，覆盖率计算通过analyzed lines/Total lines得出。点击每个package可以得到具体的覆盖率信息。

详细报告中可以看到具体代码覆盖情况，红色表示没有被覆盖到，其中ave time表示代码执行的平均时间。

目前这个版本数据库代码覆盖率工具还不够成熟，如DBMS_PRFILER不会剔除空行代码的执行，但是在覆盖率工具中我们已经剔除了空行，还有针对多行的sql，只会在第一行标上被覆盖，其实整句sql也就是说269以下的代码行都应该被覆盖，这就需要覆盖率工具需要去做些代码解析的工作，判断哪些代码应该被覆盖，如下图所示：

目前数据库代码覆盖率工具才完成第一个版本，后期会将代码开源到github.