Automated testing for examples in README.md #1203
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The main version doesn't support leading comment chars yet
6af26e7 to
f2f0f38
Compare
Rewriting some of the examples to support test-doc-blocks library =prints=> has been replaced with =stdout=> because that generates actual tests for what it prints out
mattiuusitalo
commented
May 21, 2025
.github/workflows/clojure.yml
Outdated
There was a problem hiding this comment.
I didn't want to add this to the other tests, since test-doc-blocks requires clojure 1.11. I also don't think at this point testing with the whole matrix of clojure versions is necessary.
mattiuusitalo
commented
May 21, 2025
There was a problem hiding this comment.
Changes in this file were required to make the comment blocks compatible with test-doc-blocks. I also found several small discrepancies between expected results and what it actually does. Some syntax errors as well.
mattiuusitalo
commented
May 21, 2025
| @@ -368,17 +373,18 @@ Example of a multi-arity function with instrumentation scopes and custom reporti | |||
| ([x y] (* x y))))) | |||
|
|
|||
| (multi-arity-pow 4) | |||
| ; =prints=> :malli.core/invalid-output {:output [:int {:max 6}], :value 16, :args [4], :schema [:=> [:cat :int] [:int {:max 6}]]} | |||
| ; => 16 | |||
| ;; =stdout=> :malli.core/invalid-output {:output [:int {:max 6}], :value 16, :args [4], :schema [:=> [:cat :int] [:int {:max 6}]]} | |||
There was a problem hiding this comment.
This is an example of leveraging test-doc-blocks' capability of verifying what it printed in stdout.
mattiuusitalo
commented
May 21, 2025
I missed this block as the upper expression can't be tested like this. It returns a reified object which you can't test equality for.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds an automated test step which generates Clojure tests from most of the examples in the documentation and runs them to see if they still work. It uses https://github.com/lread/test-doc-blocks to do the testing.
We have over two hundred examples in the readmes and these can be verified with test-doc-blocks. The syntax is very similar to what we are already using to document the correct usage and the result it produces in the REPL. Think:
Pros
Cons