schoonology / diplomat

Opinionated tool for end-to-end tests of HTTP APIs.

Welcome, friends.

Flip through the repositories. Chuckle at how eccentric my work has been. Say hello, maybe?

diplomat's Issues

Lua `require` is relative to CWD, not the requiring file

This behaviour is surprising to new users.

This library seems to violate Postel's Law

First, I want to say that this seems like a great attempt to fill a need, API testing has not received nearly enough attention and the language agnosticism and feature set are compelling. That being said, Postel's Law says "be conservative in what you do, be liberal in what you accept from others". I think the principle that diplomat adopts around strictness ("Strict by default: When something is not specified, the defaults should be as restrictive as possible, e.g. keys not specified in JSON entities are forbidden, rather than ignored.") violates Postel's law because it asserts that every test should care about every output rather then allowing an API to evolve over time to meet the demands of its consumers, which, if I'm understanding correctly, would require every API evolution to require a change in all the diplomat tests for that API.

Since I mostly work on internal APIs, I think Consumer driven contract tests are vastly superior to end-to-end API tests and Pact is my tool of choice, but if diplomat is meant to be useful for public APIs, then consumer-driven contract tests are not a good fit (and Pact doesn't have the feature set that diplomat does), but I still would be interested in your thoughts about the strictness requirement, in my experience the cost outweighs the benefits.

Spaces in Lua break request path

If you use > GET /users/{{ ctx.get("user_id") }}, you'll get > GET /users/%7B%7B instead of what you expect.

Workaround: Remove the spaces. > GET /users/{{ctx.get("user_id")}}