正确看待覆盖率报告

lsekfe

  您还记得大多数开发人员跳上代码质量潮流之前的情况吗？在那些日子里，熟练地放置main() 方法被认为既敏捷又足以进行测试。kes！从那时起，我们已经走了很长一段路。首先，我非常感谢自动化测试现已成为以质量为中心的代码开发的重要方面。这不是我要感谢的全部。Java?开发人员拥有大量工具，可通过代码指标，静态分析等来衡量代码质量。哎呀，我们甚至设法将重构归为一组便捷的模式！
　　确保您的代码质量
　　要获得与代码质量有关的问题的答案，请访问由Andrew Glover主持的 “代码质量”讨论论坛。
　　所有这些新工具使确保代码质量比以往更加容易，但是您必须知道如何使用它们。在本系列文章中，我将重点介绍确保代码质量的有时有些不可思议的细节。除了使您熟悉可用于代码质量保证的各种工具和技术之外，我还将向您展示如何：
　　定义并有效衡量对代码质量影响最大的方面。
　　设定质量保证目标并相应地计划您的开发工作。
　　确定哪些代码质量工具和技术真正满足您的需求。
　　实施最佳实践（并淘汰不良实践），以便尽早确保代码质量，并且通常成为开发实践中不费力且有效的方面。
　　我将从这个月开始，看看Java开发人员的质量保证工具包中最流行，最简单的功能之一：测试覆盖率测量。
　　当心被欺骗
　　使用测试覆盖率工具没有什么欺骗的。它们是单元测试范例的一个很好的补充。重要的是一旦获得信息就如何对其进行综合，这是一些开发团队犯下的第一个错误。
　　高覆盖率仅意味着要执行大量代码。高覆盖率并不意味着代码可以很好地执行。如果您专注于代码质量，则需要准确了解测试覆盖率工具的工作原理以及它们如何工作；然后您将知道如何使用这些工具来获取有价值的信息，而不仅仅是像许多开发人员一样，为实现高覆盖率目标而定。
　　测试覆盖率测量
　　测试覆盖率工具通常很容易添加到已建立的单元测试过程中，并且结果可以放心。只需下载一个可用工具，略微修改您的Ant或Maven构建脚本，您和您的同事就可以围绕饮水机提出一种新的报告：“测试覆盖率报告”。当软件包喜欢foo并且bar显示出惊人的高覆盖率时，这可能是一个很大的安慰；当您相信至少一部分代码可以证明是“无错误的”时，就容易放松。但是这样做将是一个错误。
　　覆盖率度量有不同的类型，但是大多数工具都关注 行覆盖率，也称为语句覆盖率。另外，某些工具报告分支机构覆盖率。通过使用测试工具来运行代码库并捕获与在整个测试过程的生命周期中“被触摸”的代码相对应的数据，可以获得测试覆盖率的测量结果。然后将数据合成以生成覆盖率报告。在Java商店中，测试工具通常是JUnit，覆盖工具通常是诸如Cobertura，Emma或Clover之类的工具。
　　行覆盖率只是表明已执行了特定的代码行。如果某个方法长10行，并且在测试运行中使用了8行，则该方法的行覆盖率为80％。该过程也适用于汇总级别：如果一个班级有100条1线，其中有45条线被触摸，则该班级的线覆盖率为45％。同样，如果一个代码库包含10,000条非注释行代码，并且其中3500条是在特定测试运行中执行的，则该代码库的行覆盖率为35％。
　　报告分支覆盖率的工具会尝试测量决策点的覆盖率，例如包含逻辑ANDs或ORs的条件块 。就像行覆盖率一样，如果特定方法中有两个分支并且都通过测试覆盖，那么您可以说该方法具有100％的分支覆盖率。
　　问题是，这些测量有用吗？显然，所有这些信息都很容易获得，但是要由您来辨别如何综合这些信息。一些例子阐明了我的观点。
　　实际的代码覆盖率
　　我在清单1中创建了一个简单的类，以体现类层次结构的概念。给定的类可以具有一系列超类-例如 Vector，其父级为AbstractList，其父级为AbstractCollection，其父级为 Object：
　　清单1.代表类层次结构的类：

1. package com.vanward.adana.hierarchy;
   
2. 　　import java.util.ArrayList;
   
3. 　　import java.util.Collection;
   
4. 　　import java.util.Iterator;
   
5. 　　public class Hierarchy {
   
6. 　　private Collection classes;
   
7. 　　private Class baseClass;
   
8. 　　public Hierarchy() {
   
9. 　　super();
   
10. 　　this.classes = new ArrayList();
    
11. 　　}
    
12. 　　public void addClass(final Class clzz) {
    
13. 　　this.classes.add(clzz);
    
14. 　　}
    
15. 　　/**
    
16. 　　* [url=home.php?mod=space&uid=26358]@return[/url] an array of class names as Strings
    
17. 　　*/
    
18. 　　public String[] getHierarchyClassNames() {
    
19. 　　final String[] names = new String[this.classes.size()];
    
20. 　　int x = 0;
    
21. 　　for (Iterator iter = this.classes.iterator(); iter.hasNext();) {
    
22. 　　Class clzz = (Class) iter.next();
    
23. 　　names[x++] = clzz.getName();
    
24. 　　}
    
25. 　　return names;
    
26. 　　}
    
27. 　　public Class getBaseClass() {
    
28. 　　return baseClass;
    
29. 　　}
    
30. 　　public void setBaseClass(final Class baseClass) {
    
31. 　　this.baseClass = baseClass;
    
32. 　　}
    
33. 　　}

复制代码

如您所见，清单1的Hierarchy类包含一个 baseClass实例及其超类的集合。在 HierarchyBuilder清单2中创建 Hierarchy通过两个重载类static 冠以方法buildHierarchy。
　　清单2.类层次结构构建器：

1. package com.vanward.adana.hierarchy;
   
2. 　　public class HierarchyBuilder {
   
3. 　　private HierarchyBuilder() {
   
4. 　　super();
   
5. 　　}
   
6. 　　public static Hierarchy buildHierarchy(final String clzzName)
   
7. 　　throws ClassNotFoundException {
   
8. 　　final Class clzz = Class.forName(clzzName, false,
   
9. 　　HierarchyBuilder.class.getClassLoader());
   
10. 　　return buildHierarchy(clzz);
    
11. 　　}
    
12. 　　public static Hierarchy buildHierarchy(Class clzz) {
    
13. 　　if (clzz == null) {
    
14. 　　throw new RuntimeException("Class parameter can not be null");
    
15. 　　}
    
16. 　　final Hierarchy hier = new Hierarchy();
    
17. 　　hier.setBaseClass(clzz);
    
18. 　　final Class superclass = clzz.getSuperclass();
    
19. 　　if (superclass !=
    
20. 　　null && superclass.getName().equals("java.lang.Object")) {
    
21. 　　return hier;
    
22. 　　} else {
    
23. 　　while ((clzz.getSuperclass() != null) &&
    
24. 　　(!clzz.getSuperclass().getName().equals("java.lang.Object"))) {
    
25. 　　clzz = clzz.getSuperclass();
    
26. 　　hier.addClass(clzz);
    
27. 　　}
    
28. 　　return hier;
    
29. 　　}
    
30. 　　}
    
31. 　　}

复制代码

测试时间到了！
　　如果没有测试用例，关于测试覆盖率的文章将会是什么？在清单3中，我定义了一个简单的晴天场景JUnit测试类，其中包含三个测试用例，它们试图同时使用 Hierarchy和HierarchyBuilder类：
　　清单3.测试HierarchyBuilder：

1. package test.com.vanward.adana.hierarchy;
   
2. 　　import com.vanward.adana.hierarchy.Hierarchy;
   
3. 　　import com.vanward.adana.hierarchy.HierarchyBuilder;
   
4. 　　import junit.framework.TestCase;
   
5. 　　public class HierarchyBuilderTest extends TestCase {
   
6. 　　public void testBuildHierarchyValueNotNull() {
   
7. 　　Hierarchy hier = HierarchyBuilder.buildHierarchy(HierarchyBuilderTest.class);
   
8. 　　assertNotNull("object was null", hier);
   
9. 　　}
   
10. 　　public void testBuildHierarchyName() {
    
11. 　　Hierarchy hier = HierarchyBuilder.buildHierarchy(HierarchyBuilderTest.class);
    
12. 　　assertEquals("should be junit.framework.Assert",
    
13. 　　"junit.framework.Assert",
    
14. 　　hier.getHierarchyClassNames()[1]);
    
15. 　　}
    
16. 　　public void testBuildHierarchyNameAgain() {
    
17. 　　Hierarchy hier = HierarchyBuilder.buildHierarchy(HierarchyBuilderTest.class);
    
18. 　　assertEquals("should be junit.framework.TestCase",
    
19. 　　"junit.framework.TestCase",
    
20. 　　hier.getHierarchyClassNames()[0]);
    
21. 　　}
    
22. 　　}

复制代码

因为我是一名“认真”的测试人员，所以我自然希望进行一些覆盖率测试。在Java开发人员可用的代码覆盖工具中，我倾向于使用Cobertura，因为我喜欢它的友好报告。同样，Cobertura是一个开源项目，它是开拓性的JCoverage项目的分支。
　　Cobertura报告
　　运行像Cobertura这样的工具就像运行JUnit测试一样简单，只有中间步骤，即使用专门的逻辑对被测代码进行检测以报告覆盖率（这全部通过工具的Ant任务或Maven的目标进行处理）。
　　正如你在图中看到，用于覆盖报告 HierarchyBuilder说明的代码几节 不行使。实际上，Cobertura声称其 HierarchyBuilder线路覆盖率为59％，分支覆盖率为75％。
　　因此，我对覆盖率测试的第一枪未能测试很多东西。首先，根本没有测试buildHierarchy()以String类型作为参数的方法 。其次，另buildHierarchy()一种方法中的两个条件均未执行。有趣的是，这是第二个未执行的 if块。
　　我现在不担心，因为我要做的就是添加更多测试用例。一旦到达这些令人关注的领域，我应该会很好。在这里注意我的逻辑：我使用覆盖率报告了解 未测试的内容。现在，我可以选择使用此数据来增强测试或继续前进。在这种情况下，我将增强测试，因为我发现了一些重要的领域。
　　Cobertura：第2轮
　　清单4是更新后的JUnit测试用例，其中添加了一些其他测试用例，以尝试全面行使HierarchyBuilder：
　　清单4.更新的JUnit测试用例：

1.   package test.com.vanward.adana.hierarchy;
   
2. 　　import com.vanward.adana.hierarchy.Hierarchy;
   
3. 　　import com.vanward.adana.hierarchy.HierarchyBuilder;
   
4. 　　import junit.framework.TestCase;
   
5. 　　public class HierarchyBuilderTest extends TestCase {
   
6. 　　public void testBuildHierarchyValueNotNull() {
   
7. 　　Hierarchy hier = HierarchyBuilder.buildHierarchy(HierarchyBuilderTest.class);
   
8. 　　assertNotNull("object was null", hier);
   
9. 　　}
   
10. 　　public void testBuildHierarchyName() {
    
11. 　　Hierarchy hier = HierarchyBuilder.buildHierarchy(HierarchyBuilderTest.class);
    
12. 　　assertEquals("should be junit.framework.Assert",
    
13. 　　"junit.framework.Assert",
    
14. 　　hier.getHierarchyClassNames()[1]);
    
15. 　　}
    
16. 　　public void testBuildHierarchyNameAgain() {
    
17. 　　Hierarchy hier = HierarchyBuilder.buildHierarchy(HierarchyBuilderTest.class);
    
18. 　　assertEquals("should be junit.framework.TestCase",
    
19. 　　"junit.framework.TestCase",
    
20. 　　hier.getHierarchyClassNames()[0]);
    
21. 　　}
    
22. 　　public void testBuildHierarchySize() {
    
23. 　　Hierarchy hier = HierarchyBuilder.buildHierarchy(HierarchyBuilderTest.class);
    
24. 　　assertEquals("should be 2", 2, hier.getHierarchyClassNames().length);
    
25. 　　}
    
26. 　　public void testBuildHierarchyStrNotNull() throws Exception {
    
27. 　　Hierarchy hier =
    
28. 　　HierarchyBuilder.
    
29. 　　buildHierarchy("test.com.vanward.adana.hierarchy.HierarchyBuilderTest");
    
30. 　　assertNotNull("object was null", hier);
    
31. 　　}
    
32. 　　public void testBuildHierarchyStrName() throws Exception {
    
33. 　　Hierarchy hier =
    
34. 　　HierarchyBuilder.
    
35. 　　buildHierarchy("test.com.vanward.adana.hierarchy.HierarchyBuilderTest");
    
36. 　　assertEquals("should be junit.framework.Assert",
    
37. 　　"junit.framework.Assert",
    
38. 　　hier.getHierarchyClassNames()[1]);
    
39. 　　}
    
40. 　　public void testBuildHierarchyStrNameAgain() throws Exception {
    
41. 　　Hierarchy hier =
    
42. 　　HierarchyBuilder.
    
43. 　　buildHierarchy("test.com.vanward.adana.hierarchy.HierarchyBuilderTest");
    
44. 　　assertEquals("should be junit.framework.TestCase",
    
45. 　　"junit.framework.TestCase",
    
46. 　　hier.getHierarchyClassNames()[0]);
    
47. 　　}
    
48. 　　public void testBuildHierarchyStrSize() throws Exception {
    
49. 　　Hierarchy hier =
    
50. 　　HierarchyBuilder.
    
51. 　　buildHierarchy("test.com.vanward.adana.hierarchy.HierarchyBuilderTest");
    
52. 　　assertEquals("should be 2", 2, hier.getHierarchyClassNames().length);
    
53. 　　}
    
54. 　　public void testBuildHierarchyWithNull() {
    
55. 　　try {
    
56. 　　Class clzz = null;
    
57. 　　HierarchyBuilder.buildHierarchy(clzz);
    
58. 　　fail("RuntimeException not thrown");
    
59. 　　} catch (RuntimeException e) {
    
60. 　　}
    
61. 　　}
    
62. 　　}

复制代码

当我使用新的测试用例再次运行测试覆盖率过程时，我得到了更加完整的报告，如图所示。我现在介绍了未经测试的buildHierarchy()方法以及if在另buildHierarchy()一种方法中都遇到了问题 。 HierarchyBuilder的构造函数是private，所以我无法通过我的测试类对其进行测试（也不关心）；因此，我的线路覆盖率仍然徘徊在88％。
　　条件判断的错误
　　如您所见，使用代码覆盖率工具可以发现没有相应测试用例的重要代码。重要的是在查看报告（尤其是具有较高价值的报告）时要格外小心，因为它们可能掩盖邪恶的微妙之处。让我们看几个隐藏在高覆盖率背后的代码问题示例。
　　清单5.您看到下面的缺陷了吗？

1. package com.vanward.coverage.example01;
   
2. 　　public class PathCoverage {
   
3. 　　public String pathExample(boolean condition){
   
4. 　　String value = null;
   
5. 　　if(condition){
   
6. 　　value = " " + condition + " ";
   
7. 　　}
   
8. 　　return value.trim();
   
9. 　　}
   
10. 　　}

复制代码

清单5中有一个阴险的缺陷-您看到了吗？如果没有，请不用担心：我将编写一个测试用例来练习该 pathExample()方法，并确保它在清单6中正确运行：
　　清单6.抢救JUnit！

1. package test.com.vanward.coverage.example01;
   
2. 　　import junit.framework.TestCase;
   
3. 　　import com.vanward.coverage.example01.PathCoverage;
   
4. 　　public class PathCoverageTest extends TestCase {
   
5. 　　public final void testPathExample() {
   
6. 　　PathCoverage clzzUnderTst = new PathCoverage();
   
7. 　　String value = clzzUnderTst.pathExample(true);
   
8. 　　assertEquals("should be true", "true", value);
   
9. 　　}
   
10. 　　}

复制代码

　我的测试用例运行无懈可击，而我方便的代码覆盖率报告（如图所示）使我看起来像超级明星，具有100％的测试覆盖率！
　　我想是时候该去喝水了，我是否怀疑该代码中存在缺陷？清单5的仔细检查显示，第13行确实会抛出NullPointerException if conditionis false。是的，这里发生了什么？
　　事实证明，线路覆盖率并不是测试有效性的很好指标。
　　质量测试
　　我再说一遍：您可以（并且应该）在测试过程中使用测试覆盖率工具，但是不要被覆盖率报告所迷惑。关于覆盖率报告的主要理解是，它们最好用于公开未经充分测试的代码。查看覆盖率报告时，请找出较低的值，并了解为什么未对特定代码进行完整测试。知道了这一点，开发人员，经理和质量检查专业人员可以使用他们真正认为有用的测试覆盖率工具-即针对三种常见情况：
　　估计修改现有代码的时间
　　评估代码质量
　　评估功能测试
　　既然我已经建立了一些测试覆盖率报告可以使您误入歧途的方法，请考虑使用这些最佳实践以使您受益。
　　1.估计修改现有代码的时间
　　针对代码编写测试用例自然会提高开发团队的集体信心。经过测试的代码比没有相应测试用例的代码更易于重构，维护和增强。测试用例也可以作为熟练的文档，因为它们隐式演示了被测代码的工作方式。而且，如果测试中的代码发生更改，则测试用例通常会并行更改，这与静态代码文档（例如注释和Javadocs）不同。
　　在另一方面，没有相应测试的代码可能更难以理解，并且更难安全修改。因此，了解代码是否已经过测试，并查看实际的测试覆盖率数字，可以使开发人员和管理人员更准确地预测修改现有代码所需的时间。
　　2.评估代码质量
　　开发人员测试降低了代码缺陷的风险，因此许多开发团队现在要求将单元测试与新开发或修改的代码一起编写。但是，如上文Mark所示，单元测试并不总是与编码并行进行，这可能导致较低质量的代码。
　　监视覆盖率报告可帮助开发团队快速发现正在增长的代码，而无需进行相应的测试。例如，在本周初运行覆盖报告，则表明该项目中的关键软件包的覆盖率为70％。如果本周晚些时候该软件包的覆盖率降至60％，则可以推断出：
　　该软件包的代码行有所增加，但是没有为新代码编写相应的测试（或者新添加的测试不能有效地覆盖新代码）。
　　测试用例被删除。
　　这两件事同时发生。
　　美丽之处在于能够观察趋势。定期查看报告可以更轻松地设置目标（例如获得覆盖率，维护测试用例与代码比率行等），然后监视其进度。如果您碰巧发现通常没有编写测试，则可以采取主动措施，例如设置开发人员进行培训，指导或伙伴编程。当客户发现“一生中一次”的缺陷（可能在几个月前通过简单的测试暴露出来）时，或在管理层发现单元测试未免时，不可避免的意外（和愤怒）比之，明智的响应要好得多。尚未完成。
　　使用覆盖率报告来确保正确的测试是一个好习惯。诀窍是要有纪律地做到这一点。例如，作为连续集成过程的一部分，请尝试每晚生成和查看覆盖率报告。
　　3.评估功能测试
　　鉴于代码覆盖率报告在不进行适当测试的情况下最能说明代码部分，因此质量保证人员可以使用此数据来评估与功能测试有关的领域。
　　同样，知识就是力量。通过与软件生命周期中的其他利益相关者（例如质量保证）进行仔细协调，您可以使用覆盖率报告提供的见解来促进风险缓解。在上述情况下，也许Jeff可以给Drew的团队一个较早的发行版，其中可能没有包含Mary的所有更改；但是，Drew的团队可以专注于应用程序的股票交易方面，其中缺陷的风险似乎比带有相应单元测试的代码高。
　　测试取得回报的地方
　　测试覆盖率测量工具是对单元测试范例的绝佳补充。覆盖率测量为既有利的过程又提供了深度和精确度。但是，您应该谨慎地查看代码覆盖率报告。高覆盖率本身并不能确保代码的质量。覆盖率很高的代码不一定没有缺陷，尽管包含缺陷的可能性肯定较小。
　　测试覆盖率度量的技巧是使用覆盖率报告在微观级别和宏观级别公开未经测试的代码。通过从顶层分析代码库以及分析各个类的覆盖范围，可以促进更深入的覆盖范围测试。集成了该原理后，您和您的组织就可以使用覆盖率测量工具，它们可以真正地发挥作用，例如估算项目所需的时间，持续监控代码质量并促进QA协作。