fastly / Viceroy

Viceroy provides local testing for developers working with Compute.
https://fastly.dev/learning/compute/testing/#running-a-local-testing-server
Apache License 2.0
150 stars 35 forks source link

[feature request] Provide a way to mock backend responses when using viceroy as a test runner #442

Open tedmielczarek-fastly opened 1 week ago

tedmielczarek-fastly commented 1 week ago

When using viceroy as a test runner it would be helpful if there were a way to mock backend responses. The motivation for this is twofold:

  1. Tests that make external network requests are inherently flaky due to transient network issues. It would be much better for reliability if backend requests in tests did not have to make an external request.
  2. Writing unit-style tests is much easier if you can mock external dependencies. If your test is making external requests it's an integration test whether you like it or not. While integration tests are valuable, using mocks for unit tests allows writing tests for edge cases such as handling specific errors which are much more difficult to test against a real external service.

I don't know the viceroy codebase well so I can't offer useful implementation suggestions, but from a user's perspective I can imagine a few ideas of solutions that would be useful:

Either of these would provide enough functionality to address the two points in the motivation list above.

dgryski commented 1 week ago

Depending on the level of configurability needed, we could even do something like embedding https://github.com/facebook/starlark-rust to allow viceroy "scripts" to handle creating responses.

tedmielczarek-fastly commented 1 week ago

For the purposes of mocking backends for tests I would personally prefer a solution that allows using a handler function alongside the existing code in the module.