《Effective Unit Testing》 读书笔记 8 可信任性 code smell

如何理解可信任性(Trustworthiness )?可以用人做比较,一个可信任的人言出必行,而一个不可信任的人说的话不算数、承诺的事做不到。测试也是如此。这章介绍影响可信任性的code smell.

  1. 被注释掉的测试
    简单得说,被整个注释掉的测试还不如把这部分代码直接删掉。我们有版本管理工具,根本不用担心找不回被删掉的代码。

  2. 误导人的注释
    误导人的注释比没有注释更可怕。另外说一句,通过好的方法名和变量名通常我们能做到尽量不写注释。一定要写注释的的话,注释应该是解释why,而不是说明what。比如我们写了个很丑陋的循环,我们不需要解释这个循环做什么,这是起个好的方法名就可以达到的功能,但我们可以写注释说明非要这么写的理由(比如为了更好的性能)。

  3. 从不会失败的测试
    这种情况的出现,一般是因为测试的assert只存在于某个条件分支中。一种特别要注意的情况是把assert写在了catch语句里。见下面这个例子。

 @Test
public void includeForMissingResourceFails() {
  try {
    new Environment().include("somethingthatdoesnotexist");
  } catch (IOException e) {
    assertThat(e.getMessage(), contains("somethingthatdoesnotexist"));
  }
}

这个方法如果没有抛exception,测试同样是能通过的,但这并不是我们想要的结果。之所以测试能通过是因为我们忘记了在条件不满足的情况下让这个测试失败。改进方法很简单,加入fail()。

 @Test
public void includeForMissingResourceFails() {
  try {
    new Environment().include("somethingthatdoesnotexist");
    fail();  //
  } catch (IOException e) {
    assertThat(e.getMessage(), contains("somethingthatdoesnotexist"));
  }
}
  1. 浅承诺 (shallow promises)
    这是指测试并没有实际上校验它的名字所宣称要校验的内容。

  2. 降低的期待(lowered expectations)
    这是像素级精确的反面,只是粗略地判断了所要assert的逻辑,比如我们只是验证某方法返回值不为空,但是不去看实际内容对不对。测试太粗略了就导致它应该fail的时候不fail。如何在过于精确和过于粗略中把握度是一种艺术。

  3. 平台偏见
    这个问题出现在要测试一段代码功能,这段代码需要在不同的平台表现出不同的行为,比如返回正确的用户目录。
    有意思的是,解决这个问题的正确方式不是在测试代码这头,而是在设计功能性代码时就要把平台这个概念抽象出来,不能依赖跑测试所在机器实际上的平台。

  4. 条件化测试(conditional tests)
    assert出现在某个条件分支中。这导致如果测试没跑到这个条件中,测试照样能通过。举个例子:

@Test
public void multipleArgumentsAreSentToShell() throws Exception {
  File dir = createTempDirWithChild("hello.txt");
  String[] cmd = new String[] { "ls", "-1", dir.getAbsolutePath() };
  Process process = new Process(cmd).runAndWait();
  if (process.exitCode() == 0) {
    assertEquals("hello.txt", process.output().trim());
  }
}

解决的大原则是,所有条件分支都要跑到,而且所有分支要有测试fail的可能性。其实代码中就不应该出现条件分支,而应该为每个分支建立单独的测试方法。

code smell的介绍通过可读性,可维护性,可信任性三篇文章就到此结束了,下一章将介绍我比较感兴趣的内容:可测试的设计,testable design。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,634评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,951评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,427评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,770评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,835评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,799评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,768评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,544评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,979评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,271评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,427评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,121评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,756评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,375评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,579评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,410评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,315评论 2 352

推荐阅读更多精彩内容