Contract testing basics in Testing Fundamentals - Framework Patterns

Framework Mode - Contract testing basics

Folder Structure

contract-testing-project/
├── contracts/           # Contract definitions (e.g., JSON schemas, Pact files)
│   ├── consumer-provider.json
│   └── ...
├── tests/               # Contract test implementations
│   ├── consumer/
│   │   └── consumerContractTest.js
│   └── provider/
│       └── providerContractTest.js
├── utils/               # Helper functions for contract tests
│   └── contractUtils.js
├── config/              # Environment and test configuration
│   └── config.js
├── reports/             # Test reports and logs
│   └── contractTestReport.html
├── package.json         # Project dependencies and scripts
└── README.md            # Project overview and instructions

Test Framework Layers

• Contract Definitions Layer: Stores the contract files that describe the expected API interactions between consumer and provider.
• Test Implementation Layer: Contains tests that verify the contracts from both consumer and provider sides.
• Utilities Layer: Helper functions to load contracts, mock data, or validate responses.
• Configuration Layer: Manages environment variables, endpoints, and test settings.
• Reporting Layer: Generates readable reports showing contract test results.

Configuration Patterns

• Environment Variables: Use environment variables to switch between test environments (e.g., dev, staging).
• Contract Versioning: Keep contract files versioned to track changes and compatibility.
• Credentials Management: Store sensitive data like API keys securely, using environment variables or secret managers.
• Test Settings: Configure timeouts, retries, and mock server URLs in a central config file.

Test Reporting and CI/CD Integration

• Generate clear reports showing which contracts passed or failed.
• Integrate contract tests into CI pipelines to run on every code push.
• Fail builds if contract tests fail to prevent breaking changes.
• Use badges or dashboards to show contract test status to the team.

Best Practices

• Keep Contracts Simple and Clear: Contracts should be easy to understand and maintain.
• Test Both Consumer and Provider: Verify contracts from both sides to ensure agreement.
• Automate Contract Verification: Run contract tests automatically in CI to catch issues early.
• Version Contracts Carefully: Manage contract changes to avoid breaking consumers or providers.
• Use Mocks for Consumer Tests: Mock provider responses to test consumer behavior without needing the real provider.

Self Check

Where in this folder structure would you add a new contract file for a new API endpoint between a consumer and provider?

Key Result

Contract testing frameworks organize contract files, tests, utilities, configs, and reports to verify API agreements between services.

Practice

1. What is the main purpose of contract testing in software development?

easy

A. To ensure two systems agree on the format and data of their communication

B. To test the user interface for visual bugs

C. To check the performance speed of an application

D. To verify database schema changes

Solution

1. Step 1: Understand contract testing definition

   Contract testing focuses on the agreement between two systems on how they communicate, including request and response formats.

2. Step 2: Compare options with contract testing purpose

   Only To ensure two systems agree on the format and data of their communication describes this agreement on communication format and data, which is the core of contract testing.

3. Final Answer:

   To ensure two systems agree on the format and data of their communication -> Option A

4. Quick Check:

   Contract testing = communication agreement [OK]

Hint: Contract testing checks communication agreements between systems [OK]

Common Mistakes:

• Confusing contract testing with UI testing
• Thinking contract testing measures performance
• Assuming contract testing checks database structure

2. Which of the following is the correct way to describe a contract in contract testing?

easy

A. A set of UI elements and their styles

B. A list of database tables and columns

C. A defined request and expected response between services

D. A performance benchmark for API calls

Solution

1. Step 1: Identify what a contract defines

   A contract in contract testing defines the request sent and the expected response received between two services.

2. Step 2: Match options to contract definition

   A defined request and expected response between services correctly describes this request-response definition, while others describe unrelated concepts.

3. Final Answer:

   A defined request and expected response between services -> Option C

4. Quick Check:

   Contract = request + expected response [OK]

Hint: Contracts define requests and expected responses [OK]

Common Mistakes:

• Mixing contracts with UI or database details
• Thinking contracts are about performance
• Confusing contracts with test cases

3. Given a contract test that expects a JSON response with a field status equal to "success", what will happen if the actual response is {"status": "fail"}?

medium

A. The test will pass because the response is JSON

B. The test will fail because the status value does not match

C. The test will pass because the field status exists

D. The test will fail due to a syntax error in the response

Solution

1. Step 1: Understand the contract expectation

   The contract expects the status field to have the value "success" exactly.

2. Step 2: Compare actual response to expected

   The actual response has "status": "fail", which does not match the expected value, causing the test to fail.

3. Final Answer:

   The test will fail because the status value does not match -> Option B

4. Quick Check:

   Expected value mismatch = test fail [OK]

Hint: Exact value mismatch causes contract test failure [OK]

Common Mistakes:

• Assuming presence of field is enough to pass
• Ignoring value differences in contract tests
• Confusing syntax errors with value mismatches

4. You wrote a contract test but it always passes even when the provider sends incorrect data. What is the most likely mistake?

medium

A. The contract test has syntax errors and does not run

B. The contract test is missing the request URL

C. The contract test is running on the wrong environment

D. The contract test is not validating the response content properly

Solution

1. Step 1: Analyze why test passes despite incorrect data

   If the test passes even with wrong data, it likely means the test is not checking the response content correctly.

2. Step 2: Evaluate other options

   Missing URL or wrong environment would cause errors or failures, and syntax errors prevent running, so these are less likely.

3. Final Answer:

   The contract test is not validating the response content properly -> Option D

4. Quick Check:

   Incorrect validation = false pass [OK]

Hint: Check if test actually validates response content [OK]

Common Mistakes:

• Ignoring validation logic in tests
• Assuming environment issues cause false passes
• Confusing syntax errors with test logic errors

5. You have two microservices: Service A (consumer) and Service B (provider). Service A expects Service B to return a JSON with a userId as a number and active as a boolean. Which contract test scenario best ensures compatibility?

hard

A. Test that Service B returns {"userId": 123, "active": true} and reject if types differ

B. Test that Service B returns any JSON object with keys userId and active regardless of types

C. Test that Service B returns a string containing userId and active anywhere

D. Test that Service B returns a JSON with userId as string and active as number

Solution

1. Step 1: Identify expected data types in contract

   Service A expects userId as a number and active as a boolean, so the contract must enforce these types.

2. Step 2: Evaluate options for strictness and correctness

   Test that Service B returns {"userId": 123, "active": true} and reject if types differ tests exact types and values, ensuring compatibility. Options A, B, and C ignore or mismatch types, risking integration errors.

3. Final Answer:

   Test that Service B returns {"userId": 123, "active": true} and reject if types differ -> Option A

4. Quick Check:

   Strict type check = compatibility ensured [OK]

Hint: Contract tests must check exact data types and values [OK]

Common Mistakes:

• Ignoring data types in contract tests
• Accepting any JSON structure without validation
• Confusing string and number types in contracts