代码检查

.代码检查摘要：代码检查是白盒测试的一种静态测试方法，是众多软件测试方法中发现软件缺陷最有效的方法之一。本文结合国内外学者在相关领域的研究情况，介绍代码检查相关的基本概念、过程和分析方法。关键字：白盒测试，代码检查，静态分析，检查规则一、 引言按照测试时源代码是否可见，软件测试可以分为白盒测试和黑盒测试两类。白盒测试（结构测试），即逻辑驱动的测试，是在了解程序内部结构的基础上，对程序的逻辑结构进行检查，从中获取测试数据。白盒测试关注的是测试用例执行的程度或覆盖程序逻辑结构的程度。白盒测试一般只应用于软件开发阶段。白盒测试，又可按照是否需要运行程序，进一步细分为了静态测试和动态测试两种。通常情况下是按照先静态后动态测试顺序来实施。其中，静态测试包括代码检查、静态结构分析、代码质量度量等测试内容。静态测试既可以由人工进行，充分发挥人的逻辑思维优势，也可以借助软件工具自动进行。代码检查是一种对程序代码进行静态检查。传统的代码检查是通过人工阅读代码的方式，检查软件设计的正确性；用人脑模拟程序在计算机中的运行，仔细推敲、校验和核实程序每一步的执行结果，进而判断其执行逻辑、控制模型、算法和使用参数与数据的正确性。在实践中，代码检查比动态测试更有效率，能找到更多的缺陷，通常能发现30%70%的逻辑设计和编码缺陷。代码检查非常耗费时间，而且需要专业知识和经验的积累。代码检查定位在编译之后和动态测试之前进行，在检查前，应准备好需求描述文档、程序设计文档、程序的源代码清单、代码编码标准和代码缺陷检查表等。代码检查可以发现的软件问题包括：声明或引用错误、函数/方法参数错误、语句不可达错误、数组越界错误、控制流错误、界面错误和输入/输出错误等。1、代码检查代码检查包括桌面检查、代码走查和代码审查等方式，主要检查代码和设计的一致性，代码对标准地遵循、可读性，代码逻辑表达的正确性，代码结构的合理性等方面；发现违背程序编写标准的问题，程序中不安全、不明确和模糊的部分，找出程序中不可移植部分、违背程序编程风格的问题，包括变量检查、命名和类型检查、程序逻辑检查、程序语法检查和程序结构检查等内容。下面对代码检查的三种具体方式进行介绍。桌面检查是一种传统的检查方法，由程序员检查自己编写的程序。程序员在程序通过编译之后对源代码代码进行分析、检验，并补充相关的文档，目的是发现程序中的错误。代码走查代码走查就是针对代码，在假想的输入情况下，逐行的浏览代码，走查代码中潜在的缺陷并记录结果的过程。代码走查以小组会议方式进行，每小组3-5人。与代码审查不同的是，走查要求与会者扮演计算机的角色让测试用例沿被测程序的逻辑运行，是在模拟动态测试；而代码审查更多的是静态测试。代码审查代码审查是由一组人通过阅读、讨论和争议对程序进行静态分析的过程，以小组会的方式进行。审查小组一般由若干程序员（包括程序代码的设计者）和代码检查人员组成。会前把设计规格说明书、控制流程图、程序文本以及要求、规范、错误检查清单交给与会者，开会时程序作者朗读解释程序，其他人则集中精力，捕捉程序在结构、功能、编码风格等方面的问题。2、代码检查项代码检查项即检查代码时，指定需要进行检查的内容。具体如：检查变量的交叉引用表；检查标号的交叉引用表；检查子程序、宏、函数；等价性检查；标准检查；风格检查；选择、激活路径；对照程序的规格说明，详细阅读代码，逐字逐句分析；补充文档。检查项可以作为依据，用来编制代码规则、规范和缺陷检查表等。3、编码规范编码规范是程序编写过程中必须遵循的一套事先约定或者已经制度化、标准化的规则集，一般会详细的规定代码的语法规则和语法格式。一个良好的编码规范能够带来许多好处：改善代码质量；提高开发进度；增进团队精神。对于软件开发而言，采用好的编程规范，虽然不能彻底杜绝糟糕的代码产生。但对于代码检查和将来的代码维护，仍然是意义重大的。4、缺陷检查表在进行人工代码检查时，使用代码缺陷检查表作为代码检查的参考依据。在软件测试项目实践中代码缺陷检查表又常被称作代码检查清单。代码缺陷检查表中一般包括开发人员容易出错的地方和在以往的工作中遇到的典型错误。对应于不同的编程语言，代码缺陷检查表的具体内容将会有所不同。例如：对于C/C+语言代码缺陷检查表内容有以下几部分：文件结构；文件的版式；命名规则；表达式与基本语句；常量；函数设计；内存管理；C+函数的高级特性；类的构造函数、析构函数和赋值函数；类的高级特性；其他的常见问题等。5、代码检查规则在代码检查中，需要依据被测软件的特点，选用适当的标准与规范。在使用测试软件进行自动化代码检查或辅助代码检查时，测试工具需要内置许多编码规范。不同编程语言，对应的检查规范有所不同。针对与C/C+语言的规则有以下几类规则：通用规则、C+编码规则、C编码规则、Meyers-Klaus规则以及自定义规则。使用时，需要根据编程语言和被测程序的特点，选择适当的规则进行检查。6、静态分析静态分析是不执行程序，而分析程序代码的过程。源代码被静态分析器分析之后，得到的静态分析结果，通常可以表示成一棵静态语法树。其中包含了被测项目源代码的静态结构信息：基本代码成分、程序结构、语句结构、类型和模板等信息。程序代码静态分析的结果能够给代码检查提供帮助。三、 代码检查过程传统的代码检查是一种静态检查程序的测试方法，通常以团队的形式来进行。检查团队由程序作者，一个负责人，一个记录员以及一些检查员组成。首先需要一系列的准备工作，包括参与者的挑选和材料的准备。然后是个人准备阶段，每个小组成员各自熟悉材料。个人准备阶段后，就是实际的检查会议。在会议上，检查小组在假想的输入下，由程序作者带领，逐行的浏览代码，评审代码中潜在的缺陷。检查小组根据发现缺陷的严重程度和类型对其进行分类，并将问题记录下来供作者修正。会议后是作者的返工，作者汇报每个缺陷，最后确认每个缺陷已经被陈述过了。图 11为传统的代码检查过程。图 1 代码检查过程示意图代码检查过程中的两个重要阶段“个人准备”和“召开会议”阶段有以下注意事项：1、“个人准备”阶段：会前准备阶段是检查过程的一个关键阶段，因为如果检查者没有为检查做好充分的准备，检查效果会大打折扣。如果有检查人员没有做好准备，主审员可取消其代码检查资格，甚至取消这次检查会议。检查人员要熟悉检查内容的相关文档，了解程序背景、设计思想和编程方法，在读懂、“吃”透代码的基础上，查出尽可能多的错误。2、“召开会议”阶段：参与会议的检查者应具有一定的专业技能和经验，缺乏经验的检查人员必然缺乏合适的领域知识来深入理解材料；参与会议的检查者应做充分的个人准备，没有做充分准备的检查人员不能在检查会中做出实质性的贡献；检查会议的速度应进行控制，如果试图在短时间内处理太多的材料，检查效果也会大打折扣。现在较为常见的代码检查速度上的建议为：汇编代码150行/小时，C语言150行/小时，而对于C+、Java这种面向对象语言，代码检查速度可以提高到200-300行/小时。由此可见，代码检查适合于采用工具辅助的特性有：文档处理，个人准备，会议支持，数据收集。文档处理这是工具可支持的最明显的领域。传统的检查要求分发每份文档的复印件等，而将纸质的文档替换成计算机式的文档，不只是简单的介质变更，更是提供了一种契机提高文档的可用性和表示性的机遇。个人准备首先，自动的缺陷检测可以用来发现简单的缺陷。如果简单问题能被自动发现，检查员就能专注于更加复杂/困难的缺陷，以及那些不能被自动发现的、潜在的、可能带来更大影响的问题。另外，自动化工具应该对个人准备阶段提供更多的帮助。例如，检查员可以利用检查表以及其它支持文档，并能很容易地交叉引用它们；还有些代码辅助理解工具，可为检查员理解程序、了解程序结构提供帮助。l 会议支持一些成员由于某些原因，可能没有花费足够的时间来进行准备，但他们仍然参加会议并试图掩盖他们的过失。项目管理人员可以使用计算机监控的个人准备时间信息，来剔除那些没有做好个人准备的成员，或者督促他们投入更多的努力。召开会议时，检查员通常面对的是一堆枯燥的程序代码，如果在代码之外再结合一些图、表等便于分析、理解代码的信息，相信检查会议可以进行得更加有序和高效。数据收集代码检查一个重要的部分就是度量信息的收集，用来提供反馈以改进检查过程。度量信息包括会议时间、发现的缺陷、检查花费的总时间等。根据这些数据，可以来评价每一次代码审查的质量，进而给出关于代码审查的改进建议。通过对检查过程的部分阶段提供计算机支持，代码检查可以进行得更加有效。使用计算机来支持检查过程，可以提高效率，并增加检查过程的严格性。四、 代码检查历史数据代码检查中的历史数据本质是软件问题（缺陷）。按照不同的代码检查角度，存在多种对缺陷分类的方法。对过往发现的软件问题进行分析，总结出今后对于类似的代码需要按照某种规则来加以检查，这种的规则就是检查清单上的一条清单项，代码检查清单就是大量规则的集合。此外，由于软件问题总是以软件问题报告为载体形式出现，因此软件问题报告也被通俗的理解为代码检查历史数据。下面对缺陷分类、代码检查清单和软件问题报告加以研究。1、缺陷分类关于缺陷分类存在以下几种常见的划分方式：1）按缺陷出现的区域分类这种分类方式是最常见的缺陷分类方式。按照出现区域将代码缺陷划分为变量级、属性级、函数/方法级和类级缺陷。其中，变量级、属性级和部分函数/方法级的缺陷，与传统的面向过程编程中的缺陷分类基本一致；而多数方法级缺陷和类级缺陷，则是针对面向对象技术编程特点提出的。2）按检测内容分类分为冲突、一致性问题两种。冲突对应于文献1中的基于确定性“信念”的判定，而一致性问题则对应于基于可能性“信念”的判定。3）按对代码的危害分类按照对代码的危害，一般分为浪费时间和空间；语义混淆；暴露封装性，扩大使用权限；程序一致性问题；程序约束条件问题和空指针问题等。2、代码检查清单（Checklist）代码检查过程中，代码检查人员都会有一份代码检查清单。代码检查清单是一份为代码检查人员准备的缺陷检查表，检查表中开列所有可能与代码有关的缺陷，并注明了检查的内容、缺陷类型以及严重性。检查清单是检查代码的依据，代码检查人员根据它来发现并判断问题。代码检查清单中会逐条列出所有应该检查的缺陷种类，以及每条缺陷的各种特征，并且根据缺陷的严重程度和类型对其进行分类。通常每一条缺陷的特征描述如下：1）缺陷描述：该缺陷的问题描述、举例说明，以及相应的正确形式；2）缺陷出现的区域：分别为表达式级、语句级、声明级、模板缺陷、预处理缺陷、类级缺陷以及性能缺陷。表达式级、语句级、声明级以及预处理的缺陷，主要面向过程程序中的缺陷；模板缺陷、类级缺陷，则是针对面向对象软件的特点提出的；代码冗余等归为性能缺陷；3）缺陷对代码的危害：代码中出现某种缺陷将会造成什么样的影响。例如，检查表中一条缺陷的特征描述如下：问题描述：指针所指内存释放后没有将指针赋为NULL。举例说明：char*p=(char*)malloc(100);strcpy(p,hello);free(p);/p所指的内存被释放，但是p所指的地址还是不变if(p!=NULL)/没有起到防错的作用strcpy(p,world);/出错正确形式：在释放内存的同时将指针置空。char*p=(char*)malloc(100);strcpy(p,hello);free(p);p=NULL;/增加指针置空语句if(p!=NULL)strcpy(p,world);出现区域：语句级。危害：指针被free释放后其地址并不会自动发生改变（非NULL），p成为了“野”指针，这种情况下再对p进行操作，很容易造成程序崩溃，后果非常严重。而代码检查清单正是由若干条这样的缺陷特征描述构成的。 3、软件问题报告（Software Problem Report）在软件测试过程中，对于发现的每个软件问题（缺陷），都要进行记录该错误的特征和再现步骤等信息，以便相关人员分析和处理软件问题。为了管理测试发现的软件问题，通常要采用软件问题报告数据库，将每一个发现的软件问题输入到软件问题报告数据库中，软件问题报告数据库的每一条记录称为一个软件问题报告。软件问题报告包括头信息、简述、操作步骤和注释。 头信息包括：被测试软件名称、版本号、缺陷或错误类型、可重复性、测试平台、平台语言、缺陷或错误范围。并要求填写完整和准确。 简述是对缺陷或错误特征的简单描述，可以使用短语或短句，要求简练和准确。 操作步骤是描述该缺陷或错误出现的操作顺序，要求完整、简洁和准确。对命令、系统变量、选项要用大写字母，对控件名称等要加双引号。 注释一般是对缺陷或错误的附加描述，一般包括缺陷或错误现象的图像，包括其他建议或注释文字。 软件问题报告是软件测试过程中最重要的文档之一。它记录了软件问题发生的环境，软件问题的再现步骤以及性质的说明，而且还可以跟踪软件问题的处理过程和状态。软件问题的处理进程从一定角度反映了测试的进程和被测软件的质量状况及改善过程。五、 代码检查规则管理的研究1、潜在的编码规则和缺陷代码模式潜在的编码规则（Implicit Coding Rules）和缺陷代码模式（Bug Code Pattern）是Tomoko MATSUMURA在文献3,4中针对代码检查实践，提出的两个相关的概念。潜在的编码规则潜在的编码规则包含以下几个特征：1）不同于在开发启动时明确决定的“编码规范”的规则，这些规则在长期的测试/维护过程中是潜伏的，对这些规则的发现是不可预见的。2）这些规则很少在设计文档或者特定的文档中被清楚的描述。他们通常只存在于开发人员、测试/维护人员的记忆中。换言之，是一种尚未系统化的经验积累和总结的结果。3）不同于使用规范库的公用规则。对于特定的软件有其特定的规则，这也意味着对于不同的软件有不同的潜在的编码规则。4）由于违反潜在的编码规则导致的缺陷通常情况下不是那么容易发现的。其中相当多一部分只在特定的罕见的情况下发生，所以在早期要想发现这些问题是很困难的。5）目前，还不存在好的工具或者检查清单来发现违反潜在的编码规则的代码片段，通常的检查工具（例如PC-Lint、Purify）和通用的检查清单只能发现常见的问题。6）为了减少违反潜在的编码规则的现象的发生，而进行重构通常很困难。要重构一个软件，准确理解代码是非常必要的，然而，老的系统太复杂，并且没有精确的文档和了解系统的专业维护人员。总之，重构过期系统的代价很大，需要冒很大的风险。缺陷代码模式：违反潜在的编码规则的编码模式。缺陷代码模式不是肯定会导致缺陷的发生，一段符合缺陷代码模式的代码片段，并不意味着代码片段一定就有缺陷，缺陷代码模式只是疑似存在缺陷。另一方面，因为缺陷代码模式是静态的，没有考虑到代码片段之间的动态关联。需要代码检查人员或者维护人员把符合缺陷代码模式的代码片段提出来，并判断究竟是否存在缺陷。在软件开发过程中发现和建立缺陷代码模式有三条主要途径。其一：在进行代码检查过程中，代码检查人员发现一个软件问题的同时，根据对该问题是否具备代表性和通用性等因素的考虑，确定是否建立一个缺陷代码模式；其二：当软件失效或者发生问题，检查对应的代码部分，发现并确定是否有潜在的编码规范与之相关；其三：分析现存的代码规范和积累的大量问题报告，从中提炼出潜在的编码规则。在文献3,4中还给我们介绍了一个代码缺陷检测系统的大致工作流程，如2所示。图2 缺陷检测模型系统的代码检查流程参考图2、C+代码检查规则类型1）规则层次在代码检查工作中常常可以发现这样的现象：有些规则能在所有的项目中都能发现问题，另一些规则所能发现的问题只存在于某类项目中。根据规则的这个特点，如图 33中所示，参考文献2中将代码检查规则分为两个层次：公共规则（General checks）：用于检查在大多数情况都有可能发生的缺陷。项目相关规则（Project specific checks）：用于在项目中检查可能的缺陷。图 3 一个典型的代码检查规则清单节选图在项目中积累了大量软件问题报告历史数据的支持下，可以从中进一步细化出与项目或开发人员相关的检查规则。在学习任何一种计算机编程语言时，总是按照基本数据类型表达式语句复杂语句函数整个程序体(类)的顺序逐步学习的。事实上软件正是按照这样的顺序自下而上逐层组建起来的，代码缺陷作为软件编程写时的一种异常情况，毫不例外也是按照这样层次的构建而成。在实际测试项目的代码检查过程中，我们发现在每个层次上都有可能存在潜在代码缺陷，要找到引起软件问题的根源，要求在尽可能低的层次上找到引发缺陷的代码。正因如此，非常有必要在C+语法的每个层次上都建立相应的检查元规则。图4为一个代码检查规则体系模型图2，图中展示了在代码检查项目开始前，通过逐级组合各种元规则和规则形成新的检查规则，最后形成了初始的检查清单。在项目实践中，经过对缺陷代码模式的推导，进而得到扩展的检查清单。初始检查清单和扩展检查清单本质上并没有什么区别，只是因为形成的时间不同。图4 代码检查规则体系模型图在检查代码时我们有时会想要定义一个带有否定意义的规则，如“在AA情况下如果没有BB，则可能存在一个问题”。这类检查规则采用自然语言描述比较容易，但是要用代码实现起来往往并不简单，并且对这类规则的定义和维护也比较麻烦。定义组合规则，是解决这类问题一种变通的方法。下面简单介绍一下定义组合规则的原理。如图5中所示定义三个规则，“满足情况AA”对应规则R1，“满足在AA情况下出现BB”对应规则R2， 将满足R1但不满足R2（即以！符号表示）组合则对应规则R3“在AA情况下如果没有BB，则可能存在一个问题”。图5 组合规则示例图根据前面讨论，本文将代码检查的规则分类设计如下：公共规则l定义针对函数体（含）以上层次的检查规则，在这些层次上出现的缺陷问题一般不容易精确到具体的代码行。关键字规则l针对每个关键字定义的检查规则。由于关键字是C+语法中一种最普通的元素，单独使用关键字规则的意义不大，一般情况需要和语句、表达式规则或者复杂语句规则配合使用。语句/表达式规则l针对基本语句类型或基本表达式定义的规则，满足对应结构的表达式，则可认为符合了相应的表达式规则。语句/表达式规则中可以包含多个关键字，在同一语句/表达式规则中包含的关键字地位是平等的，与检查的先后次序无关。复杂语句块规则l针对条件、开关选择等多分支语句定义的规则，通常由关键字、语句/表达式进行组合来定义复杂语句块，并在定义时可以进行嵌套，在定义复杂语句块规则加入语句或表达式和复杂语句时需要考虑检查的先后次序。高级组合规则l关键字规则、语句/表达式规则和复杂语句块规则合称为普通规则。对于难以使用普通规则定义方式定义的复杂语义，需要定义高级组合规则。定义高级组合规则可以使用上面几种规则作为基本单元，也可以嵌套使用其它组合规则。图6为一个由下至上、由多个缺陷代码模式组合形成的组合规则结构图。其中表示某条缺陷代码模式对应的规则。图6 组合规则结构图六、代码分析方法1、静态分析静态分析主要对源代码进行词法分析、语法分析，提取被分析程序的静态信息，所提取的静态信息是代码缺陷检测的基础。静态分析结果主要包括三部分信息：程序定义信息：程序定义信息包含了程序中所有的定义和声明信息，如类定义、方法和数据成员的定义、方法内局部变量的定义等。程序结构信息：主要指方法内的控制流信息和方法间的调用关系。静态分析器分析程序的语句分支、分支间的嵌套关系和方法调用，记录方法的控制流信息和调用信息，构造语法树。分支内的变量操作：以方法控制流程中的分支为基本单元，记录每一分支中各语句对各变量施加的操作和操作序列。2、数据流分析数据流分析也是一种静态代码检查方法。它是在不通过计算机运行被测程序的条件下，利用预先进行静态分析后获取的信息，检测对变量的赋值与使用操作中，是否存在不合理情况，即找出被测程序中是否存在变量在使用前未被赋值；变量在两次赋值之间未被使用；一个变量在被赋值后是否未被使用等异常情况。数据流分析目前的主要用途大多局限在编译器的实现和优化技术方面，而在代码检查系统中实用的数据流分析技术并不多见，主要集中在某几种缺陷检测上，如赋值引用异常检测以及内存错误检测，使用方式主要是定义数据流操作的符号，使用该符号系统构造数据流表达式（由数据操作符号构成的符号串），再分析该符号串来确定是否存在代码缺陷。数据流分析包括以下两个步骤：一是分析程序的所有逻辑路径；二是对所有逻辑路径上的所有变量，分析其所有操作序列，然后将得到的操作序列输入自动机进行分析。因此数据流分析方法不可避免的存在以下缺点：1）信息量多，上面所述的数据流分析方法是一种穷举法。事实上一个变量在大部分路径上存在问题的几率并不高，因此穷举每个变量的所有操作序列不可避免的要分析很多正确的信息，而且信息量巨大；2）组合爆炸，当程序复杂度增长时，该分析方法的复杂度呈几何级数增长，并且当这种组合是建立在对所有逻辑路径、所有变量的穷举基础上时，如果不能找到一个非常高效的算法，数据流分析方法将是一个非常低效的方法；3）实用性低，上述两点导致的数据流分析的实用性降低。为缓解这些的缺点，数据流分析过程有许多改进方法，但实现都具有一定难度。本系统中数据流分析不是重点，采取的策略是尽可能简化数据流分析的过程，或者在可能的情况下尽量避免数据流分析。.