用单元测试保护微服务

构建自动化防护流程:检查微服务端点,在失败时向 Slack 告警,并让后续任务只在单元测试通过后运行。该功能可用于 Enterprise Edition 和 Cloud;单元测试与 RunTest 需要对应版本能力。

现代微服务和 API 后端通常暴露健康检查端点。利用 Kestra,可以监控这些端点、编写测试验证监控流程,再按测试结果控制下游自动化。本指南依次创建 HTTP 检查与 Slack 告警流程,覆盖正常和异常路径,并在测试套件通过后触发下游逻辑。

先决条件

  • Kestra Enterprise Edition:Unit Tests 与 RunTest 任务需要此能力。
  • Slack Incoming Webhook URL,或 Notifications 插件支持的其他通知渠道。
  • 作为 KESTRA_API_TOKEN 保存的 Kestra API token,供测试运行流程使用。

步骤 1:监控 API 端点

在命名空间中创建下面的流程。当目标端点返回非 200 状态时,执行告警任务。

id: microservices-and-apis

namespace: tutorial

description: Microservices and APIs




inputs:

  - id: server_uri

    type: URI

    defaults: https://kestra.io




  - id: slack_webhook_uri

    type: URI

    defaults: https://kestra.io/api/mock




tasks:
  - id: http_request

    type: io.kestra.plugin.core.http.Request

    uri: "{{ inputs.server_uri }}"

    options:

      allowFailed: true




  - id: check_status

    type: io.kestra.plugin.core.flow.If

    condition: "{{ outputs.http_request.code != 200 }}"

    then:

      - id: server_unreachable_alert

        type: io.kestra.plugin.slack.notifications.SlackIncomingWebhook
        url: "{{ inputs.slack_webhook_uri }}"

        payload: |

          {

            "channel": "#alerts",

            "text": "The server {{ inputs.server_uri }} is down!"

          }

    else:

      - id: healthy

        type: io.kestra.plugin.core.log.Log

        message: Everything is fine!

该流程发出 HTTP 请求,配置 allowFailed: true,然后依据响应码发送 Slack 告警,或记录健康状态。

组件说明

  • server_uri 将目标端点参数化,便于复用于预发布、生产或其他健康检查端点。
  • slack_webhook_uri 接收告警地址,避免把真实密钥硬编码在流程中。也可直接在通知任务的 url 属性中引用 KV Store 或 secret。
  • http_request 请求端点并获取 HTTP 状态码。allowFailed 允许处理失败的 HTTP 响应。
  • check_status 按响应分支:非 200 时执行告警;200 时写入“Everything is fine!”日志。

步骤 2:添加单元测试

在同一命名空间中,将下面的片段保存为测试资源,以覆盖两种结果。

id: test_microservices_and_apis

flowId: microservices-and-apis

namespace: tutorial

testCases:

  - id: server_should_be_reachable

    type: io.kestra.core.tests.flow.UnitTest

    fixtures:

      inputs:

        server_uri: https://kestra.io

    assertions:
      - value: "{{ outputs.http_request.code }}"

        equalTo: 200




  - id: server_should_be_unreachable

    type: io.kestra.core.tests.flow.UnitTest

    fixtures:

      inputs:

        server_uri: https://kestra.io/bad-url

      tasks:

        - id: server_unreachable_alert

          description: no Slack message from tests

    assertions:

      - value: "{{ outputs.http_request.code }}"

        notEqualTo: 200

每个测试用例提供 fixtures(输入及可选任务覆盖)与 assertions。第二个用例替换 Slack 告警任务,避免测试发送 Slack 消息,同时检查 HTTP 响应不是 200。

组件说明

  • 测试的 id、flowId 与 namespace 将套件关联到步骤 1 的流程。
  • server_should_be_reachable 传入有效的 server_uri,并断言状态码等于 200。
  • server_should_be_unreachable 传入坏路径,以任务替身抑制告警消息,并断言状态码不等于 200,减少测试消息对频道的干扰。

步骤 3:只在测试通过后运行下游逻辑

创建控制流程,执行测试套件,并依据 outputs.run_test.result.state 布尔值决定是否继续。

id: run_if_tests_pass

namespace: tutorial




tasks:

  - id: run_test

    type: io.kestra.plugin.kestra.ee.tests.RunTest

    auth:

      apiToken: "{{ secret('KESTRA_API_TOKEN') }}"

    namespace: tutorial
    testId: test_microservices_and_apis




  - id: run_if_tests_pass

    type: io.kestra.plugin.core.flow.If

    condition: "{{ outputs.run_test.result.state }}"

    then:

      - id: log

        type: io.kestra.plugin.core.log.Log

        message: hello

可把最后的 log 任务替换为部署、升级处理或其他只有测试成功才应执行的自动化。

组件说明

  • run_test 使用 API token、命名空间和测试 ID 调用 Enterprise Edition 的 RunTest 插件,返回包含 state 布尔值的结果。
  • run_if_tests_pass 在条件判断中检查该结果,通过后执行 then 分支。

步骤 4:执行测试

从 Kestra UI 或 CLI 运行测试,检查两条断言是否通过。原文展示了测试断言结果截图,说明监控流程应能在不产生 Slack 测试噪声的情况下被验证。这是教程的操作要求与示例结果;本稿没有运行测试,也没有制作通过截图。

后续步骤

  • 遍历输入,或使用命名空间文件,让监控流程覆盖多个端点。
  • 替换 Slack 任务,改为 PagerDuty、Teams 或邮件等 Notifications 插件支持的渠道。
  • 把受测试结果门控的流程接入 CI/CD,使每次部署在上线前验证关键监控。

来源:Kestra 文档贡献者;Copyright 2019 Kestra Technologies,Write Unit Tests to Protect Your Microservices,核验于 2026-10-03。本稿翻译该 URL 本页正文,未扩展到链接指向的完整章节或额外脚本;代码保留原文,不宣称原创。译文及说明为修改部分。

原文与代码许可:Apache License 2.0;附 完整许可文本。材料按原样提供;不表示原作者或项目背书。

许可文本
Apache License
                           Version 2.0, January 2004
                        https://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.
      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.
      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.
      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).
      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.
      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."
      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.
   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.
   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.
   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and
      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and
      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.
      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.
   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.
   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.
   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.
   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.
   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.
   END OF TERMS AND CONDITIONS

   Copyright 2019 Kestra Technologies.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       https://www.apache.org/licenses/LICENSE-2.0
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

静态核验:三段YAML中的flowId/testId/namespace及任务输出引用一致;保留当前插件类名,不套用旧版本示例;异常测试仅覆盖非200返回,不保证DNS或连接异常仍有code;Slack默认URL是原文mock地址,并非实际Webhook;正常测试未显式替换Slack任务;若站点意外非200仍可能触发原文mock请求。未执行示例、安装依赖、调用模型下载或使用 GPU。

© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享
评论 抢沙发

请登录后发表评论

    暂无评论内容