草庐IT

PHPUnit 组织测试的最佳实践

coder 2023-04-28 原文

我目前打算从头开始为一个项目进行 phpunit 测试。所以我正在研究一些项目(比如 Zend),看看他们是如何做事的,以及他们如何组织他们的测试。

大部分事情都很清楚,唯一让我有问题的是如何正确组织测试套件。 Zend 有一个 AllTests.php 从中加载其他测试套件。
仔细查看它使用 PHPUnit_Framework_TestSuite 创建套件对象然后将其他套件添加到其中的类,但是如果我查看 PHPUnit 文档以在 3.4 之后的 PHPUnit 版本中组织测试,则只有一个XML 或 FileHierarchy 的描述。使用类来组织测试的那个被删除了。
我还没有发现这种方法已被弃用,像 Zend 这样的项目仍在使用它。

但如果它已被弃用,我将如何使用 xml 配置以相同的结构组织测试?执行所有测试没有问题,但是如果我只想执行几个测试,我将如何组织测试(在 xml 中)。也许创建几个xml,我只指定几个要运行的测试/测试套件?

因此,如果我只想测试应用程序的模块 1 和模块 2,我是否会为每个模块提供一个额外的 xml,并仅为其中的那些模块(模块使用的类)定义测试套件。还有一个为所有测试定义了一个测试套件?

或者在特定测试上使用 @group 注释将它们标记为模块 1 或模块 2 会更好吗?

提前感谢您向我指出一些最佳做法。

最佳答案

我将从链接到手册开始,然后进入我在该领域的所见所闻。

Organizing phpunit test suites

文件系统中的模块/测试文件夹组织

我推荐的方法是将文件系统与 xml 配置相结合。

tests/
 \ unit/
 | - module1
 | - module2
 - integration/
 - functional/

phpunit.xml用一个简单的:

<testsuites>
  <testsuite name="My whole project">
    <directory>tests</directory>
  </testsuite>
</testsuites>

您可以根据需要拆分测试套件,但这是一个项目到项目的选择。

正在运行 phpunit然后将执行所有测试并运行 phpunit tests/unit/module1将运行 module1 的所有测试。

“单元”文件夹的组织

这里最常见的方法是镜像您的 source/ tests/unit/ 中的目录结构文件夹结构。

无论如何,每个 ProductionClass 都有一个 TestClass,所以在我的书中这是一个很好的方法。

在文件组织中

  • 每个文件一个类。

如果您在一个文件中有多个测试类,那么无论如何它都不会工作,所以要避免这个陷阱。

  • 没有测试命名空间

它只是让编写测试更加冗长,因为您需要一个额外的 use 语句,所以我会说 testClass 应该与生产类在同一个命名空间中,但这不是 PHPUnit 强制您做的。我只是发现它更容易,没有缺点。

只执行几个测试

例如 phpunit --filter Factoryphpunit tests/unit/logger/ 时执行所有 FactoryTests执行所有与日志记录相关的内容。

您可以使用 @group诸如问题编号、故事之类的标签,但对于“模块”,我会使用文件夹布局。

多个xml文件

如果你想创建多个 xml 文件会很有用:

  • 没有代码覆盖率
  • 仅用于单元测试(但不适用于功能、集成或长期运行测试)
  • 其他常见的“过滤”案例
  • 例如,PHPBB3 对 their phpunit.xmls 执行此操作。

测试的代码覆盖率

因为它与开始一个带有测试的新项目有关:

  • 我的建议是使用 @covers标签 like described in my blog (仅用于单元测试,始终覆盖所有非公共(public)功能,始终使用覆盖标签。
  • 不要为您的集成测试生成覆盖率。它会给你一种虚假的安全感。
  • 始终使用白名单来包含您的所有生产代码,这样数字就不会骗您!

自动加载和引导您的测试

您的测试不需要任何类型的自动加载。 PHPUnit 会解决这个问题。

使用 <phpunit bootstrap="file">属性来指定您的测试 Bootstrap 。 tests/bootstrap.php是放置它的好地方。在那里你可以设置你的应用程序自动加载器等等(或者调用你的应用程序 Bootstrap )。

总结

  • 几乎所有事情都使用 xml 配置
  • 单独的单元和集成测试
  • 您的单元测试文件夹应该反射(reflect)您的应用程序文件夹结构
  • 要只执行特定测试,请使用 phpunit --filterphpunit tests/unit/module1
  • 使用 strict 模式从一开始就不会关闭。

要查看的示例项目

关于PHPUnit 组织测试的最佳实践,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/8313283/

有关PHPUnit 组织测试的最佳实践的更多相关文章

  1. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  2. ruby - 解析 RDFa、微数据等的最佳方式是什么,使用统一的模式/词汇(例如 schema.org)存储和显示信息 - 2

    我主要使用Ruby来执行此操作,但到目前为止我的攻击计划如下:使用gemsrdf、rdf-rdfa和rdf-microdata或mida来解析给定任何URI的数据。我认为最好映射到像schema.org这样的统一模式,例如使用这个yaml文件,它试图描述数据词汇表和opengraph到schema.org之间的转换:#SchemaXtoschema.orgconversion#data-vocabularyDV:name:namestreet-address:streetAddressregion:addressRegionlocality:addressLocalityphoto:i

  3. ruby - 使用 C 扩展开发 ruby​​gem 时,如何使用 Rspec 在本地进行测试? - 2

    我正在编写一个包含C扩展的gem。通常当我写一个gem时,我会遵循TDD的过程,我会写一个失败的规范,然后处理代码直到它通过,等等......在“ext/mygem/mygem.c”中我的C扩展和在gemspec的“扩展”中配置的有效extconf.rb,如何运行我的规范并仍然加载我的C扩展?当我更改C代码时,我需要采取哪些步骤来重新编译代码?这可能是个愚蠢的问题,但是从我的gem的开发源代码树中输入“bundleinstall”不会构建任何native扩展。当我手动运行rubyext/mygem/extconf.rb时,我确实得到了一个Makefile(在整个项目的根目录中),然后当

  4. ruby - Ruby 的 Hash 在比较键时使用哪种相等性测试? - 2

    我有一个围绕一些对象的包装类,我想将这些对象用作散列中的键。包装对象和解包装对象应映射到相同的键。一个简单的例子是这样的:classAattr_reader:xdefinitialize(inner)@inner=innerenddefx;@inner.x;enddef==(other)@inner.x==other.xendenda=A.new(o)#oisjustanyobjectthatallowso.xb=A.new(o)h={a=>5}ph[a]#5ph[b]#nil,shouldbe5ph[o]#nil,shouldbe5我试过==、===、eq?并散列所有无济于事。

  5. ruby - RSpec - 使用测试替身作为 block 参数 - 2

    我有一些Ruby代码,如下所示:Something.createdo|x|x.foo=barend我想编写一个测试,它使用double代替block参数x,这样我就可以调用:x_double.should_receive(:foo).with("whatever").这可能吗? 最佳答案 specify'something'dox=doublex.should_receive(:foo=).with("whatever")Something.should_receive(:create).and_yield(x)#callthere

  6. ruby - Sinatra:运行 rspec 测试时记录噪音 - 2

    Sinatra新手;我正在运行一些rspec测试,但在日志中收到了一堆不需要的噪音。如何消除日志中过多的噪音?我仔细检查了环境是否设置为:test,这意味着记录器级别应设置为WARN而不是DEBUG。spec_helper:require"./app"require"sinatra"require"rspec"require"rack/test"require"database_cleaner"require"factory_girl"set:environment,:testFactoryGirl.definition_file_paths=%w{./factories./test/

  7. ruby-on-rails - 迷你测试错误 : "NameError: uninitialized constant" - 2

    我遵循MichaelHartl的“RubyonRails教程:学习Web开发”,并创建了检查用户名和电子邮件长度有效性的测试(名称最多50个字符,电子邮件最多255个字符)。test/helpers/application_helper_test.rb的内容是:require'test_helper'classApplicationHelperTest在运行bundleexecraketest时,所有测试都通过了,但我看到以下消息在最后被标记为错误:ERROR["test_full_title_helper",ApplicationHelperTest,1.820016791]test

  8. ruby - 即使失败也继续进行多主机测试 - 2

    我已经构建了一些serverspec代码来在多个主机上运行一组测试。问题是当任何测试失败时,测试会在当前主机停止。即使测试失败,我也希望它继续在所有主机上运行。Rakefile:namespace:specdotask:all=>hosts.map{|h|'spec:'+h.split('.')[0]}hosts.eachdo|host|begindesc"Runserverspecto#{host}"RSpec::Core::RakeTask.new(host)do|t|ENV['TARGET_HOST']=hostt.pattern="spec/cfengine3/*_spec.r

  9. ruby-on-rails - 如何使辅助方法在 Rails 集成测试中可用? - 2

    我在app/helpers/sessions_helper.rb中有一个帮助程序文件,其中包含一个方法my_preference,它返回当前登录用户的首选项。我想在集成测试中访问该方法。例如,这样我就可以在测试中使用getuser_path(my_preference)。在其他帖子中,我读到这可以通过在测试文件中包含requiresessions_helper来实现,但我仍然收到错误NameError:undefinedlocalvariableormethod'my_preference'.我做错了什么?require'test_helper'require'sessions_hel

  10. ruby-on-rails - Cucumber 是否只是 rspec 的包装器以帮助将测试组织成功能? - 2

    只是想确保我理解了事情。据我目前收集到的信息,Cucumber只是一个“包装器”,或者是一种通过将事物分类为功能和步骤来组织测试的好方法,其中实际的单元测试处于步骤阶段。它允许您根据事物的工作方式组织您的测试。对吗? 最佳答案 有点。它是一种组织测试的方式,但不仅如此。它的行为就像最初的Rails集成测试一样,但更易于使用。这里最大的好处是您的session在整个Scenario中保持透明。关于Cucumber的另一件事是您(应该)从使用您的代码的浏览器或客户端的角度进行测试。如果您愿意,您可以使用步骤来构建对象和设置状态,但通常您

随机推荐