support for test code reuse #320
Conversation
|
Thank you for this proposal. Can you document this feature in a new file located in |
|
Ping @lsylvestre |
|
Hi @yurug, To prevent a warning, I would like to add the following fragment in translations/fr.po: but it seems to produce a conflict. |
|
Can you give more details about your conflict? What kind of conflicts is it? |
docs/tutorials/step-8.md
Outdated
|
|
||
| Each declaration in **depend.txt** is a single line containing the relative path of an *.ml* or *.mli* file. The order of the *.ml* declarations specifies the order in which each module is loaded in the grading environment. | ||
|
|
||
| By default each dependency *foo.ml* is isolated in a module *Foo*, which can be constrained by the content of an optional signature file *foo.mli*. Furthermore, we can add an annotation `@included` at the beginning of a file *foo.ml* to denote that all the bindings of *foo.ml* is are evaluated in the toplevel environment (and not in a module *Foo*). |
There was a problem hiding this comment.
Please use shorter lines in text files (80 columns max.).
Here, who is "we"?
There was a problem hiding this comment.
| By default each dependency *foo.ml* is isolated in a module *Foo*, which can be constrained by the content of an optional signature file *foo.mli*. Furthermore, we can add an annotation `@included` at the beginning of a file *foo.ml* to denote that all the bindings of *foo.ml* is are evaluated in the toplevel environment (and not in a module *Foo*). | |
| By default each dependency *foo.ml* is isolated in a module *Foo*, which can be constrained by the content of an optional signature file *foo.mli*. Furthermore, we can add an annotation `@included` at the beginning of a file *foo.ml* to denote that all the bindings of *foo.ml* are evaluated in the toplevel environment (and not in a module *Foo*). |
There was a problem hiding this comment.
You should provide an example, especially to show what is exactly the syntax for annotations.
There was a problem hiding this comment.
thank you.
- ok for 80 columns max.
- "we" is "the authors of the exercise". I rephrase this in "an annotation
[@@@included]can be used...". - below, there is a complete example using this annotation.
Would you like me to add another simpler example ?
Co-Authored-By: Yann Régis Gianas <yrg@pps.univ-paris-diderot.fr>
docs/tutorials/step-8.md
Outdated
| Remember that **Test_lib** internally requires a user-defined sampler `sample_peano : unit -> peano` to generate value of type `peano`. This sampler has to be present in the toplevel environment -- and not in a module -- in order to be found by the introspection primitives during grading. Therefore, we define this sampler in a file starting by the annotation `@included`. | ||
| - **samples.ml**: | ||
| ```ocaml | ||
| @included |
There was a problem hiding this comment.
Using the standard syntax:
[@@@included]
would have the benefits of making this .ml file accepted by the compiler.
There was a problem hiding this comment.
I have switched to the standard syntax.
Note that the parsing of the annotation is hard-coded in grading.ml as a string comparison:
match String.trim (String.sub content 0 i) with
| "[@@@included]" -> ...Is this the right way to do it?
There was a problem hiding this comment.
That's probably fine.
A cleaner way would be to inspect the module syntax tree but I am not sure if that is easy for you to get this tree at this point of the process.
The conflict was due to my outdated version of the file |
Apparently, these links are dead in the actual version of learn-ocaml. |
Co-Authored-By: Yann Régis Gianas <yrg@pps.univ-paris-diderot.fr>
Co-Authored-By: Yann Régis Gianas <yrg@pps.univ-paris-diderot.fr>
Co-Authored-By: Yann Régis Gianas <yrg@pps.univ-paris-diderot.fr>
Yes please. |
It is done. There is a conflict as expected. |
|
Thanks! We are done here, @lsylvestre, great work! |
|
Thank you @yurug, it was my pleasure. |
This ensures learn-ocaml-client.master is still able to query a server version learn-ocaml.0.12. Minimal working example: cd .../learn-ocaml docker run --name=locaml -d -it -p 8080:8080 -v "$PWD/demo-repository:/repository" ocamlsf/learn-ocaml:0.12 TOKEN=$(docker logs locaml | grep -e 'Initial teacher token created:' | sed -e 's/^.*: //') # then git checkout 42d8127 opam install . --deps-only --locked -y opam install -y opam-installer.$(opam config var opam-version) eval $(opam env) make make opaminstall learn-ocaml-client init -s http://localhost:8080 -t "$TOKEN" touch demo.ml learn-ocaml-client grade demo.ml Output before the fix: Fatal error: exception Json_encoding.Cannot_destruct(_) Called from unknown location Called from unknown location Called from unknown location Called from unknown location Called from unknown location Called from unknown location Called from unknown location
This ensures learn-ocaml-client.master is still able to query a server version learn-ocaml.0.12. Minimal working example: cd .../learn-ocaml docker run --name=locaml -d -it -p 8080:8080 -v "$PWD/demo-repository:/repository" ocamlsf/learn-ocaml:0.12 TOKEN=$(docker logs locaml | grep -e 'Initial teacher token created:' | sed -e 's/^.*: //') # then git checkout 42d8127 opam install . --deps-only --locked -y opam install -y opam-installer.$(opam config var opam-version) eval $(opam env) make make opaminstall learn-ocaml-client init -s http://localhost:8080 -t "$TOKEN" touch demo.ml learn-ocaml-client grade demo.ml Output before the fix: Fatal error: exception Json_encoding.Cannot_destruct(_) Called from unknown location Called from unknown location Called from unknown location Called from unknown location Called from unknown location Called from unknown location Called from unknown location
This ensures learn-ocaml-client.master is still able to query a server version learn-ocaml.0.12. Minimal working example: cd .../learn-ocaml docker run --name=locaml -d -it -p 8080:8080 -v "$PWD/demo-repository:/repository" ocamlsf/learn-ocaml:0.12 TOKEN=$(docker logs locaml | grep -e 'Initial teacher token created:' | sed -e 's/^.*: //') # then git checkout 42d8127 opam install . --deps-only --locked -y opam install -y opam-installer.$(opam config var opam-version) eval $(opam env) make make opaminstall learn-ocaml-client init -s http://localhost:8080 -t "$TOKEN" touch demo.ml learn-ocaml-client grade demo.ml Output before the fix: Fatal error: exception Json_encoding.Cannot_destruct(_) Called from unknown location Called from unknown location Called from unknown location Called from unknown location Called from unknown location Called from unknown location Called from unknown location
about #169 and #174.
This PR offers a support for test code reuse.
It allows the programmer to add an optional file called depend.txt (in the exercises directory) which declares a list of dependencies as follows :
Thus, these ml and mli files are copied, ciphered and will be loaded in the toplevel during the grading, just before test.ml. It is therefore possible to use the modules M1 and M2 in test.ml and, furthermore, to use M1 in M2.