」工欲善其事,必先利其器。「—孔子《論語.錄靈公》
首頁 > 程式設計 > 消費者驅動的合約測試指南

消費者驅動的合約測試指南

發佈於2024-10-31
瀏覽:555

A Guide to Consumer-Driven Contract Testing
在现代微服务架构中,应用程序严重依赖服务间通信(通常通过 API)。确保这些 API 在开发期间和更改后继续按预期工作至关重要。实现这一目标的一种有效方法是通过消费者驱动的契约测试(CDCT)。 CDCT 是一种确保服务(生产者)遵守使用其 API 的服务(消费者)设定的期望的方法。

在本指南中,我们将探讨 CDCT 是什么、它是如何工作的、它在确保可靠的微服务交互方面的重要性,以及如何使用 Pact 等工具来实现它。

什么是消费者驱动的契约测试?
消费者驱动的合同测试是一种测试策略,可确保分布式架构中的服务之间的通信遵守商定的合同。它与传统的 API 测试不同,它关注消费者的需求,而不仅仅是确保 API 本身正常运行。 API 消费者和提供者之间的契约是由消费者的期望定义的,并且该契约根据提供者的实现进行验证。

关键术语:
• 消费者:使用API​​ 的服务。
• Provider(生产者):提供API的服务。
• 合同:消费者和提供商之间的正式协议,指定预期的 API 行为。

它是如何工作的?

  1. 消费者定义合约: 消费者定义其对提供商 API 应如何表现的期望(例如,其期望的端点、数据格式和响应状态代码)。
  2. 合同是共享的: 消费者与提供商共享此合同。该合同作为提供商必须满足的规范。
  3. 提供商验证合同: 提供商根据消费者的合同进行自我测试,确保其满足消费者的期望。
  4. 持续反馈循环: 提供商 API 的任何重大更改都将被尽早发现,因为提供商必须根据所有消费者的合约进行验证。这创建了一个安全网,以确保提供商的变化不会对消费者产生负面影响。

消费者驱动的合约测试的重要性
在分布式架构中,尤其是微服务,管理服务之间的依赖关系变得更加复杂。 CDCT 通过多种方式帮助减轻这种复杂性:

1.防止生产中的损坏
由于消费者定义了他们的需求,因此供应商 API 的更改如果不满足消费者的期望,就会在开发流程的早期被捕获。这降低了由于不兼容的更改而破坏生产系统的风险。

2.解耦开发
消费者驱动的契约测试允许消费者和提供商独立开发。当团队或服务单独发展时,这尤其有用。合约充当接口,确保集成按预期工作,无需在每个开发周期进行完整的集成测试。

3.更快的开发周期
通过 CDCT,消费者和提供商都可以并行开发和测试,从而加快开发速度。即使在消费者完全实现其功能之前,提供商也可以针对消费者的合约进行测试。

4。及早发现合同违规行为
在开发过程的早期检测到违反合同的提供商变更,使开发人员能够在问题变得严重之前解决问题。

如何实施消费者驱动的合约测试
有多种工具可用于实施 CDCT,其中 Pact 是最流行的工具之一。 Pact 允许消费者定义他们的合同并允许提供商验证它们。

以下是使用 Pact 实施 CDCT 的分步指南:
第 1 步: 定义消费者期望
首先,在消费者服务中,定义契约。这通常包括以下内容:
• 消费者将调用的端点。
• 请求方法(GET、POST、PUT 等)。
• 预期的请求正文或参数。
• 预期的响应正文和状态代码。
以下是在 JavaScript 中使用 Pact 在消费者测试中定义合约的示例:

const { Pact } = require('@pact-foundation/pact');
const path = require('path');

const provider = new Pact({
    consumer: 'UserService',
    provider: 'UserAPI',
    port: 1234,
    log: path.resolve(process.cwd(), 'logs', 'pact.log'),
    dir: path.resolve(process.cwd(), 'pacts'),
});

describe('Pact Consumer Test', () => {
    beforeAll(() => provider.setup());

    afterAll(() => provider.finalize());

    it('should receive user details from the API', async () => {
        // Define the expected interaction
        await provider.addInteraction({
            state: 'user exists',
            uponReceiving: 'a request for user details',
            withRequest: {
                method: 'GET',
                path: '/users/1',
                headers: {
                    Accept: 'application/json',
                },
            },
            willRespondWith: {
                status: 200,
                headers: {
                    'Content-Type': 'application/json',
                },
                body: {
                    id: 1,
                    name: 'John Doe',
                },
            },
        });

        // Make the actual request and test
        const response = await getUserDetails(1);
        expect(response).toEqual({ id: 1, name: 'John Doe' });
    });
});

在此示例中,消费者 (UserService) 希望提供者 (UserAPI) 在向 /users/1 发出 GET 请求时返回用户详细信息。

第2步:发布合约
一旦消费者测试通过,Pact 就会生成一个可以与提供者共享的合约文件(Pact 文件)。该合约可以存储在 Pact Broker 或版本控制系统中,以便提供商可以使用它进行验证。

第 3 步:提供商验证合同
提供商检索合同并验证其是否符合消费者的期望。这是通过在提供商端运行 Pact 测试来完成的。下面是用 Java 验证 Pact 合约的示例:

public class ProviderTest {

    @Test
    public void testProviderAgainstPact() {
        PactVerificationResult result = new PactVerifier()
            .verifyProvider("UserAPI", "pacts/UserService-UserAPI.json");

        assertThat(result, instanceOf(PactVerificationResult.Ok.class));
    }
}

提供商运行此测试以确保其遵守消费者指定的合同。

第四步:持续集成
一旦 CDCT 集成到您的 CI/CD 管道中,每次合同更改时,提供商都可以自动验证合同。这确保 API 更改不会打破消费者的期望,为两个团队提供安全网。

CDCT 最佳实践

  1. 小型、集中的合同: 确保您的合同规模较小,并且仅关注消费者的需求。这可以防止合同中不必要的复杂性并简化验证。
  2. 合同版本控制: 始终对合同进行版本控制。这允许提供商处理同一合同的多个版本,帮助您支持处于不同开发阶段的不同消费者。
  3. 独立部署: 确保 CDCT 是 CI/CD 管道的一部分。对消费者或提供商的任何更改都应触发合同测试,以避免破坏生产环境。
  4. 使用 Pact Broker: Pact Broker 是一个中央存储库,用于存储您的合同并允许消费者和提供商检索它们。它还提供了一个用于可视化合约版本和依赖项的 UI。

何时使用消费者驱动的契约测试
CDCT 在以下情况下特别有用:
• 您拥有具有多个交互服务的微服务或分布式架构。
• 从事不同服务的团队需要独立开发,无需频繁的集成测试。
• API 合同可能会经常更改,您希望避免打破消费者的期望。
• 您需要快速反馈循环来在开发过程的早期检测合同违规行为。

结论
消费者驱动的契约测试提供了一种可靠的方法来确保分布式系统中的服务有效通信而不破坏更改。通过关注消费者的期望并根据这些期望验证提供商,CDCT 帮助团队独立开发,同时确保稳定性。无论您是构建微服务、基于 API 的应用程序还是分布式系统,将 CDCT 纳入您的测试策略都将提高服务的可靠性和可扩展性。

版本聲明 本文轉載於:https://dev.to/keploy/a-guide-to-consumer-driven-contract-testing-2dho?1如有侵犯,請聯絡[email protected]刪除
最新教學 更多>
  • 如何在Ajax資料載入過程中顯示進度條?
    如何在Ajax資料載入過程中顯示進度條?
    如何在Ajax 資料載入期間顯示進度條處理使用者觸發的事件(例如從下拉方塊中選擇值)時,通常會使用非同步擷取資料阿賈克斯。在獲取數據時,向用戶提供正在發生某事的視覺指示是有益的。本文探討了一種在 Ajax 請求期間顯示進度條的方法。 使用 Ajax 實作進度條要建立一個準確追蹤 Ajax 呼叫進度的...
    程式設計 發佈於2024-11-08
  • 如何在 PHP 中透過 SSH 安全連接到遠端 MySQL 伺服器?
    如何在 PHP 中透過 SSH 安全連接到遠端 MySQL 伺服器?
    在PHP 中透過SSH 安全連接到遠端MySQL 伺服器要為PHP 資料庫連線建立安全隧道,以下SSH 隧道解決方案提供了一種強大的方法。 SSH 隧道設定建立通往 MySQL 資料庫伺服器的 SSH 隧道。為此,請使用以下命令:ssh -fNg -L 3307:10.3.1.55:3306 [em...
    程式設計 發佈於2024-11-08
  • 混淆技術真的可以保護可執行檔免受逆向工程的影響嗎?
    混淆技術真的可以保護可執行檔免受逆向工程的影響嗎?
    保護可執行檔免於逆向工程:解決方案有限的挑戰保護程式碼免於未經授權的逆向工程是開發人員持續關注的問題,尤其是當它包含敏感資訊時。雖然已經提出了各種方法,但重要的是要承認完全防止逆向工程實際上是不可能的。 常見混淆技術使用者建議的策略,例如程式碼注入、混淆和自訂啟動例程的目的是使反彙編變得不那麼簡單。...
    程式設計 發佈於2024-11-08
  • 掌握 Laravel 中的 Eloquent where 條件
    掌握 Laravel 中的 Eloquent where 條件
    Laravel 的 Eloquent ORM(物件關係映射)是其突出的功能之一,提供了與資料庫互動的強大而富有表現力的方式。 Eloquent 提供的一項基本功能是方法,它允許開發人員高效、直觀地過濾查詢。在本文中,我們將深入研究 where 條件,探索其各種形式和實際用例。 w...
    程式設計 發佈於2024-11-08
  • 在 Gmail 的 Chrome 12+ 更新中如何從剪貼簿貼上圖片?
    在 Gmail 的 Chrome 12+ 更新中如何從剪貼簿貼上圖片?
    將剪貼簿中的圖像貼到Gmail:Chrome 12 中的操作方法Google 宣布能夠將剪貼簿中的圖像直接貼到Gmail使用Chrome 12 的Gmail 引發了人們對其底層機制的好奇。儘管使用了最新的 Chrome 版本,但一些用戶仍然無法找到有關如何在 Webkit 中實現此增強功能的資訊。 ...
    程式設計 發佈於2024-11-08
  • JavaScript 示範場景競賽 - JS 版
    JavaScript 示範場景競賽 - JS 版
    JS1024 於 2024 年回歸! 準備好迎接令人興奮的挑戰! JS1024 回歸,透過在 JavaScript、HTML 或 GLSL 中創建令人驚嘆的演示(全部在 1024 位元組限制內),將開發人員推向極限。無論您是經驗豐富的編碼員還是新手,這都是您展示創造力和技術技能的機...
    程式設計 發佈於2024-11-08
  • 第九屆 TCmeeting 的更新
    第九屆 TCmeeting 的更新
    議程上有幾個項目,本文重點介紹第 104 次 TC39 會議 [2024 年 10 月 8 日至 10 日] 的功能提案及其進展。 第一階段: 表示度量:建議在 JavaScript 中使用適當的單位格式化和表示度量。 Immutable ArrayBuffers:新增 Arra...
    程式設計 發佈於2024-11-08
  • 如何使用 CSS 在圖像地圖上實現滑鼠懸停效果?
    如何使用 CSS 在圖像地圖上實現滑鼠懸停效果?
    使用 CSS 設定圖片地圖滑鼠懸停樣式使用 CSS 設定圖片地圖滑鼠懸停樣式建立互動網頁時,通常需要包含具有可點擊區域的圖像。通常,這是使用圖像映射來實現的。然而,事實證明,在滑鼠懸停時設置這些區域的樣式以提供額外的互動性是難以實現的。 <img src="{main_photo}&...
    程式設計 發佈於2024-11-08
  • 升級您的前端遊戲:無頭與靜態未來的學習框架
    升級您的前端遊戲:無頭與靜態未來的學習框架
    前端領域正以驚人的速度發展。忘掉笨重、單一的網站吧-未來屬於無頭 CMS 和靜態網站產生器 (SSG)。這些時尚的強大功能提供了無與倫比的速度、靈活性和安全性,但征服它們需要使用正確的工具。 為了利用他們的力量,開發人員正在轉向 Next.js 和 Gatsby,這兩個尖端的前端框架塑造了我們如何...
    程式設計 發佈於2024-11-08
  • 如何修復 PyGame 動畫閃爍:故障排除和解決方案
    如何修復 PyGame 動畫閃爍:故障排除和解決方案
    PyGame 動畫閃爍:故障排除和解決方案在執行 PyGame 程式時,您可能會遇到動畫閃爍的問題。這可能會令人沮喪,特別是如果您不熟悉使用該框架。 PyGame 中動畫閃爍的根本原因通常是多次呼叫 pygame.display.update()。不應在應用程式循環中的多個點更新顯示,而應僅在循環結...
    程式設計 發佈於2024-11-08
  • JavaScript 中的聲明式程式設計與命令式程式設計
    JavaScript 中的聲明式程式設計與命令式程式設計
    當談到程式設計方法時,經常會出現兩種常見的方法:聲明式程式設計和命令式程式設計。每個都有其優點和理想的用例,尤其是在 JavaScript 中。讓我們透過一些例子來探討這兩種風格。 命令式程式設計:告訴電腦如何做 命令式程式設計就像是給出一組詳細的指令。你告訴計算機如何一步一步達到...
    程式設計 發佈於2024-11-08
  • 掌握 NestJS 中的資料驗證:類別驗證器和類別轉換器的完整指南
    掌握 NestJS 中的資料驗證:類別驗證器和類別轉換器的完整指南
    Introduction In the fast-paced world of development, data integrity and reliability are paramount. Robust data validation and efficient handl...
    程式設計 發佈於2024-11-08
  • 有多少 Python 套件的版本控制正確?
    有多少 Python 套件的版本控制正確?
    前幾天,當我研究Python套件中的漏洞資料庫時,我意識到其中的一些套件版本無法輕鬆解析並與其他版本字串進行比較,因為它們不遵守Python 版本控制- 舊的PEP 440或取代它的版本說明符規範。所以我開始想知道這種情況有多普遍。 Python 套件索引上有多少套件實際上有有效版本? 顯而易見的...
    程式設計 發佈於2024-11-08
  • 如何在 Web 應用程式中有效地對 Ajax 請求進行排序?
    如何在 Web 應用程式中有效地對 Ajax 請求進行排序?
    排序 Ajax 請求在許多 Web 應用程式中,通常會遇到需要迭代集合並對每個元素發出 Ajax 請求的情況。雖然利用非同步請求來避免瀏覽器凍結很誘人,但有效管理這些請求可以防止伺服器過載和其他潛在問題。 jQuery 1.5 對於 jQuery 1.5 及更高版本,$. ajaxQueue() 插...
    程式設計 發佈於2024-11-08
  • JavaScript 中「%」運算子的作用是什麼?
    JavaScript 中「%」運算子的作用是什麼?
    揭開 JavaScript 中 % 運算子的本質JavaScript 中神秘的 % 符號稱為模運算子。它在數學運算中發揮關鍵作用,它會傳回一個運算元除以另一個運算元後的餘數。 模運算子通常表示如下:var1 % var2其中var1 和 var2 代表操作數。 例如,如果我們有表達式 12 % 5,...
    程式設計 發佈於2024-11-08

免責聲明: 提供的所有資源部分來自互聯網,如果有侵犯您的版權或其他權益,請說明詳細緣由並提供版權或權益證明然後發到郵箱:[email protected] 我們會在第一時間內為您處理。

Copyright© 2022 湘ICP备2022001581号-3