草庐IT

java - Pact 提供者测试的范围应该是什么?

coder 2024-03-07 原文

大约半年前,我的组织开始使用 Pact 在用 Java 编写的 REST 服务/微服务之间创建/验证契约(Contract)。
我们很难决定提供者测试的适当范围或掌握应该是什么,并且希望从其他契约用户的经验中获得一些意见。

基本上讨论围绕在提供程序测试中模拟/ stub 的位置展开。在服务中,您至少必须模拟对其他服务的外部调用,但您也可以选择更接近 REST 资源类的模拟。

我们把它归结为两个选项:

1. 第一个选项是提供者测试应该是严格的契约测试,并且只执行提供者服务的 REST 资源类,模拟/ stub 从那里使用的服务类/编排器等。这个契约测试将通过组件测试来增强,这些测试将测试由提供者测试 stub /模拟的部分。

2. 第二种选择是使用提供者测试作为组件测试,为每个请求执行整个服务组件。只有对其他组件的可传递外部调用才会被模拟/ stub 。

这些是专业人士对每个选项的想法

选项 1 的专业版:

  • 测试将更容易实现并且占用空间更小
    => 更高的隔离度。
  • 无论如何,我们可能需要其他组件测试来覆盖消费者通常未涵盖的用例
    预期(错误流等)。这样我们就不会混合不同的
    各种组件测试(Pact 和其他)在一个包中,使测试套件更容易理解。

  • 选项 2 的专业版:
  • 测试正在执行更多的“真实”代码 => 测试风险更低
    由于错误的模拟/ stub 而导致的错误。

  • 我真的很想听听您的提供者测试在这方面的典型情况。有最佳实践吗?

    澄清我们所说的“组件”的含义:
    组件是更大的服务应用程序中的微服务或模块。我们从 Martin Fowlers http://martinfowler.com/articles/microservice-testing/ 中获取了“组件”的定义。 .

    提供者服务/组件通常在 Jersey 资源类中有一个 REST 端点。此端点是 Pact 提供程序测试的提供程序端点。一个例子:
    @Path("/customer")
    public class CustomerResource {
    
        @Autowired private CustomerOrchestrator customerOrchestrator;
    
        @GET
        @Path("/{customerId}")
        @Produces(MediaType.APPLICATION_JSON)
        public Response get(@PathParam("customerId") String id) {
            CustomerId customerId = CustomerIdValidator.validate(id);
            return Response.ok(toJson(customerOrchestrator.getCustomer(customerId))).build();
        }
    

    在上面的示例中,@Autowired(我们使用 spring)CustomerOrchestrator 可以在运行提供程序测试时被模拟,或者您可以注入(inject)真正的“Impl”类。如果您选择注入(inject)真正的“CustomerOrchestratorImpl.class”,它将具有额外的@Autowired bean 依赖项,而这些依赖项又可能具有其他……等等。最后,依赖项将最终出现在将进行数据库调用的 DAO 对象中或一个 REST 客户端,它将对其他下游服务/组件执行 HTTP 调用。

    如果我们在上面的例子中采用我的“选项 1”解决方案,我们将模拟 CustomerResource 中的 customerOrchestrator 字段,如果我们采用“选项 2”,我们将为 CustomerResource 中的每个依赖项注入(inject) Impl 类(真正的类)依赖图并创建模拟数据库条目和模拟下游服务。

    作为旁注,我应该提到我们很少在提供者测试中实际使用真正的数据库。在我们采用“选项 2”的情况下,我们模拟了 DAO 类层而不是模拟实际的数据库数据,以减少测试中移动部件的数量。

    我们创建了一个“测试框架”,可以自动模拟任何未在 spring 上下文中明确声明的 Autowired 依赖项,因此 stub /模拟对我们来说是一个轻量级的过程。这是执行 CustomerResource 并启动 stub CustomerOrchestrator bean 的提供程序测试的摘录:
    @RunWith(PactRunner.class)
    @Provider("customer-rest-api")
    @PactCachedLoader(CustomerProviderContractTest.class)
    public class CustomerProviderContractTest {
    
        @ClassRule
        public static PactJerseyWebbAppDescriptorRule webAppRule = buildWebAppDescriptorRule();
    
        @Rule
        public PactJerseyTestRule jersyTestRule = new PactJerseyTestRule(webAppRule.appDescriptor);
    
        @TestTarget public final Target target = new HttpTarget(jersyTestRule.port);
    
        private static PactJerseyWebbAppDescriptorRule buildWebAppDescriptorRule() {
            return PactJerseyWebbAppDescriptorRule.Builder.getBuilder()
                .withContextConfigLocation("classpath:applicationContext-test.xml")
                .withRestResourceClazzes(CustomerResource.class)
                .withPackages("api.rest.customer")
                .build();
        }
    
        @State("that customer with id 1111111 exists")
        public void state1() throws Exception {
            CustomerOrchestrator customerOrchestratorStub = SpringApplicationContext.getBean(CustomerOrchestrator.class)
           when(customerOrchestratorStub.getCustomer(eq("1111111"))).thenReturn(createMockedCustomer("1111111));
    
        }
        ...
    

    最佳答案

    这是一个经常出现的问题,我的回答是“为每项服务做有意义的事情”。使用pact 的第一个微服务非常小而简单,最容易测试整个服务而无需任何模拟或 stub 。调用真实服务和调用验证测试之间的唯一区别是我们使用 sqlite 进行测试。当然,我们截断了对下游服务的调用。

    如果设置真实数据比 stub 更复杂,那么我会使用 stub 。 然而 !如果您打算这样做,那么您需要确保您 stub 的调用以与协议(protocol)相同的方式进行验证。使用某种共享的fixture,并确保对于您在pact provider 测试中 stub 的每个调用,您都有一个匹配的测试,以确保行为符合您的预期。这就像您将协作/契约(Contract)测试链接在一起,如下所示:

    关于java - Pact 提供者测试的范围应该是什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40984580/

    有关java - Pact 提供者测试的范围应该是什么?的更多相关文章

    1. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

      类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

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

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

    3. ruby-on-rails - Rails - 子类化模型的设计模式是什么? - 2

      我有一个模型:classItem项目有一个属性“商店”基于存储的值,我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式?如果方法中没有大的if-else语句,这是如何干净利落地完成的? 最佳答案 通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.co

    4. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们? - 2

      我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

    5. 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

    6. ruby - 为什么 4.1%2 使用 Ruby 返回 0.0999999999999996?但是 4.2%2==0.2 - 2

      为什么4.1%2返回0.0999999999999996?但是4.2%2==0.2。 最佳答案 参见此处:WhatEveryProgrammerShouldKnowAboutFloating-PointArithmetic实数是无限的。计算机使用的位数有限(今天是32位、64位)。因此计算机进行的浮点运算不能代表所有的实数。0.1是这些数字之一。请注意,这不是与Ruby相关的问题,而是与所有编程语言相关的问题,因为它来自计算机表示实数的方式。 关于ruby-为什么4.1%2使用Ruby返

    7. 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(在整个项目的根目录中),然后当

    8. 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?并散列所有无济于事。

    9. 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

    10. ruby - ruby 中的 TOPLEVEL_BINDING 是什么? - 2

      它不等于主线程的binding,这个toplevel作用域是什么?此作用域与主线程中的binding有何不同?>ruby-e'putsTOPLEVEL_BINDING===binding'false 最佳答案 事实是,TOPLEVEL_BINDING始终引用Binding的预定义全局实例,而Kernel#binding创建的新实例>Binding每次封装当前执行上下文。在顶层,它们都包含相同的绑定(bind),但它们不是同一个对象,您无法使用==或===测试它们的绑定(bind)相等性。putsTOPLEVEL_BINDINGput

    随机推荐