SpringCloud 配置选项

2023-12-08 17:45 更新
  • testMode:定义验收测试的模式。默认情况下,模式是MockMvc,它基于Spring的MockMvc。对于真实的HTTP调用也可以将其更改为 WebTestClient JaxRsClient Explicit
  • basePackageForTests:指定所有生成的测试的基本软件包。如果未设置,则从baseClassForTests’s package and from `packageWithBaseClasses中选取值。如果这些值均未设置,则该值设置为org.springframework.cloud.contract.verifier.tests
  • ruleClassForTests:指定应添加到生成的测试类的规则。
  • baseClassForTests:为所有生成的测试创建基类。默认情况下,如果使用Spock类,则该类为spock.lang.Specification
  • contractDirectory:指定一个目录,其中包含用GroovyDSL编写的合同。默认目录为/src/test/resources/contracts
  • createdTestSourcesDir:指定应放置从Groovy DSL生成的测试的测试源目录。默认情况下,其值为$buildDir/generated-test-sources/contracts
  • createdTestResourcesDir:指定测试资源目录,测试所使用的资源在该目录中生成
  • testFramework:指定要使用的目标测试框架。当前,Spock,JUnit 4(TestFramework.JUNIT)和JUnit 5受支持,而JUnit 4是默认框架。
  • packageWithBaseClasses:定义所有基类所在的包。此设置优先于 baseClassForTests约定是这样的:如果您在(例如)src/test/resources/contract/foo/bar/baz/下拥有合同,并将packageWithBaseClasses属性的值设置为com.example.base,则Spring Cloud Contract Verifier假定存在一个com.example.base包下的BarBazBase类。换句话说,系统将获取包的最后两个部分(如果存在的话),并形成一个带有Base后缀的类。
  • baseClassMappings:指定提供contractPackageRegex的基类映射的列表,该列表将根据合同所在的包进行检查,而baseClassFQN则映射到匹配的合同的基类的标准名称。例如,如果您在src/test/resources/contract/foo/bar/baz/下有一个合同并映射了属性.* → com.example.base.BaseClass,则从这些合同生成的测试类将扩展com.example.base.BaseClass此设置优先于 packageWithBaseClasses baseClassForTests
  • contractProperties:包含要传递给Spring Cloud Contract组件的属性的映射。这些属性可能由内置或自定义存根下载器使用。

如果要从Maven存储库下载合同定义,则可以使用以下选项:

  • contractDependency:包含所有打包合同的合同依赖关系。
  • ContractsPath:具有打包合同的JAR中具体合同的路径。默认值为groupid/artifactid,其中gropuid以斜杠分隔。
  • ContractsMode:选择将要找到并注册存根的模式
  • deleteStubsAfterTest:如果设置为false,则不会从临时目录中删除任何下载的合同
  • contractRepositoryUrl:包含合同的工件的仓库的URL。如果未提供,请使用当前的Maven。
  • contractRepositoryUsername:用于通过合同连接到仓库的用户名。
  • contractRepositoryPassword:用于通过合同连接到仓库的密码。
  • contractRepositoryProxyHost:用于通过合同连接到仓库的代理主机。
  • ContractsRepositoryProxyPort:用于通过合同连接到仓库的代理端口。

我们仅缓存非快照的显式提供的版本(例如,不会缓存+1.0.0.BUILD-SNAPSHOT)。默认情况下,此功能处于打开状态。

您可以在下面找到通过插件打开的实验功能列表:

  • convertToYaml:将所有DSL转换为声明性的YAML格式。当您在Groovy DSL中使用外部库时,这可能非常有用。通过启用此功能(将其设置为true),您将不需要在使用者端添加库依赖项。
  • assertJsonSize:您可以在生成的测试中检查JSON数组的大小。默认情况下禁用此功能。
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号