Normalize test names to support unicode #249
Conversation
There was a problem hiding this comment.
You'll need to specify uutf as a dependency by adding it to the Alcotest (package) stanza (in dune-project) and running dune build @install.
This uses the escaped form of the name in the console output, which I believe is not necessary? e.g. in the test case, we could be printing the 🔥 emoji in the output. Regardless, this PR is still an improvement, and better CLI output could be a follow-up.
Oh nice! Yes seeing the actual test name would be a lot better than seeing the normalized name! |
|
Indeed, most of the printing is done in https://github.com/mirage/alcotest/blob/master/src/alcotest-engine/pp.ml. However, there's another open PR with some fairly big diffs to this logic (#246), so it may not be worth bothering with right now. I hope that once that PR is in, this code will be easier to modify. |
|
LGTM. Would you add a CHANGES entry? Then we can merge. |
Fix mirage#171, normalize all names with the unicode representation of characters other than alphabets, numbers, '-', '_' and ' '. If the character is malformed then u_rep, the replacement character ( U+FFFD ) is added instead.
Uutf has a String module with fold function which simplifies the normalizing function a lot. Update some names, and some cleanup.
The registering function can now be simplified since all inputs are valid inputs and are normalized! 🎉
|
Rebased. Will merge when the CI goes green. |
|
Thanks for the contribution 😊 |
…age (1.2.0) CHANGES: - Add an `alcotest-mirage` package, allowing the construction of MirageOS unikernels that run Alcotest test suites. (mirage/alcotest#238, @hannesm @linse) - Add `Alcotest.check'`, a variant of `Alcotest.check` with labeled arguments. (mirage/alcotest#239, @hartmut27) - Add a testable for the `bytes` type. (mirage/alcotest#253, @mefyl) - Many assorted improvements to Alcotest output formatting. (mirage/alcotest#246, @craigfe) - Default to `--color=always` when running inside Dune (mirage/alcotest#242, @craigfe). The value can be overridden by setting the `ALCOTEST_COLOR` variable in a `dune` file, for example: ```dune (env (_ (env-vars (ALCOTEST_COLOR auto)))) ``` - Support all UTF-8 characters in test names and suite names, by normalising them for file-system interactions. (mirage/alcotest#249, @gs0510; mirage/alcotest#246, @craigfe) - Fix various crashes when using non-filesystem-safe characters in test suite names (these break Alcotest when attempting to generate a corresponding log file). (mirage/alcotest#241, @mefyl; mirage/alcotest#246 @craigfe)
Fix #171, normalize all names with the unicode representation of characters
other than alphabets, numbers, '-', '_' and ' '. If the character is malformed
then u_rep, the replacement character ( U+FFFD ) is added instead.