An integration test checks that parts of a system work together: your app and a payment provider, an email service, a stock system or another team's API. An integration test template lists those checks one hand-off per row, with the systems each row crosses and the test data it needs. The table above is that template with five worked examples for an example online shop, and you can download it as an Excel workbook, a CSV file or Markdown.
How to use it#
- Read the examples above. Each row names the systems it crosses, such as Shop to Payments, and the test data it needs.
- Select Download .xlsx for a workbook with a How to use tab, the examples and 20 blank rows, or Download .csv to import the rows into another tool.
- List every place your app hands work to another system, and write at least one row for the normal path and one for a refusal.
- Set up the test data first, in test mode where the other system has one, then run the rows and set Status.
What each column means#
| Column | What goes in it |
|---|---|
| ID | A short, unique reference, so a result or a bug can point at this row. |
| Systems | The systems the row crosses, such as Shop to Payments, or Orders to Email. |
| Title | A short name for the check, readable in a list. |
| Preconditions | What must be true before the first step: who is signed in, what data exists, which page is open. |
| Steps | What to do, one numbered action per line, written so someone new to the app can follow them. |
| Expected result | What should happen if the app works. Write something you can see or check, not 'works correctly'. |
| Test data | The accounts, cards or records the row uses, so anyone can repeat it. |
| Status | The result of the last run: Not run, Passed, Failed or Blocked. |
What integration tests catch#
Each part can pass its own tests and still fail when they meet. A payment can succeed at the provider while the shop records nothing, an email can be sent twice, or stock can stay the same after an order. The examples check both sides of each hand-off: the payment appears in the provider's dashboard with the same amount, the confirmation email arrives once with the order number, and the stock count goes down. They also check a refusal, a declined card, because an app has to handle the other system saying no.
Test data#
The Test data column keeps the cards, inboxes and accounts a row needs in one place, so the next person can run it without asking. Use the test mode and test cards your providers publish, never live payment details. Note which environment each row runs against, because an integration can behave differently in test and live mode.
Integration testing vs functional testing#
A functional test checks that one feature does what its requirement says, inside your app. An integration test checks a hand-off between two systems, where the fault is often in neither side alone. Write the feature's own behaviour in the functional test template and its hand-offs here. This template is for integration checks a person runs through the app. Developers also write integration tests in code, which run in CI. Types of software tests explains where each kind fits.
Questions#
What is an integration test case template?#
A sheet with one row per hand-off between systems, with columns for the systems crossed, the preconditions, the steps, the expected result on both sides, the test data and a status.
How is integration testing different from functional testing?#
Functional tests check that one feature does what its requirement says. Integration tests check the hand-offs between systems, where the problem is often in neither side alone.
Can I run these against live services?#
Use each service's test mode wherever it has one. Running against live payment or email services can charge money or reach customers.
Is the template free?#
Yes. Download it without an account and use it in your own plans and tools.