Julia López - Testing Integrations: The Good, the Bad, and the Ugly - Rails World 2024

Testing third-party API integrations poses unique challenges like rate limits, network conditions, authentication, and fluctuating test data

VCR is recommended as the primary tool for testing API integrations - it records HTTP interactions and replays them during tests, making the suite faster and more reliable

WebMock complements VCR by allowing explicit mocking and setting expectations on HTTP requests. Both tools work well together for comprehensive API testing

Avoid hitting real APIs in tests when possible - it makes tests slow, flaky and dependent on external services. Mock responses instead

Keep test data synchronized between your application and third-party services (like Stripe customers/prices) to prevent broken tests

Authentication flows (OAuth, tokens) require special handling in tests - consider mocking vs recording real auth interactions

Monitor for unintended API calls in tests using VCR’s warnings about unrecorded interactions

Break down complex API interactions into smaller, focused tests rather than testing everything in one large integration test

Consider the tradeoffs of using official API client gems vs direct HTTP clients - sometimes simpler HTTP clients are easier to test

Document expected request/response patterns and keep cassettes up to date when APIs change or during major version upgrades

For system/browser tests, be aware that VCR won’t capture frontend API calls - additional test coverage may be needed