【问题标题】:Is naming test classes with user story id a bad thing?用用户故事 id 命名测试类是件坏事吗?
【发布时间】:2019-10-16 10:01:01
【问题描述】:

我过去曾在一个团队中工作,我们过去常常在我们的自动化(单元、集成等)测试类名称前加上用户故事 ID。

例如,“US1234NewFeature”,其中“US”表示“用户故事”,“1234”是用户故事/缺陷 ID 和一些简短描述。

这个约定对我们来说很好,但由于我在讨论中没有看到类似的东西,所以我想问一下我没有看到它是否有任何问题。

我喜欢这个约定,因为:

1 - 在制作 TDD 时,一开始我们仍然不知道您要测试哪些类。有一个您想要满足的标准或您需要验证的行为。在这里命名一个测试类可能不清楚。

2 - 对于这个用户故事,您可能需要测试不同的类,但所有这些测试都与用户故事中定义的一组标准相关联。所以最后你将把所有与用户故事或缺陷相关的测试放在一起。这是班级的责任。

3 - 当给定的测试中断时,您将很快从它所属的用户故事中得知,并可以检查您的测试实施中是否存在问题,或者是因为实际上标准已更改。这是假设您测试更多的行为然后执行。

我知道这可能是一个笼统的问题,但问题是这种方法的缺点是什么?

【问题讨论】:

    标签: unit-testing testing automated-tests coding-style integration-testing


    【解决方案1】:

    我建议为不同的用户故事提供一个包,而不是用用户故事的编号来命名类。或者在 java doc 注释中有用户故事 ID。最好让类名反映用户故事的意图,而不是他们的数量。我能想到的缺点如下:

    • 类名的可读性:使用可发音的名字很重要 对于类,因为它有助于记住类名。没有人愿意记住用户故事的编号。
    • 未来读者的清晰性:代码的未来读者可能不知道为什么类会以这种方式命名。除非您强制他们在阅读您的代码之前阅读文档,否则他们可能会错误地更改它们!
    • 可搜索的名称:当一切都以美国和一组数字开头时,使用任何 IDE 搜索您的课程有多容易?
    • 避免编码:您似乎发明了一种新的编码,并强制您的开发人员使用。未来的开发人员在编写任何测试用例之前也需要了解这一点。这有多容易?任何代码都必须易于阅读和更改。每个人都有足够的事情来处理,而不是必须学习新的编码规则。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2020-12-09
      • 1970-01-01
      相关资源
      最近更新 更多