catala/tests
Denis Merigoux d69f1a4a39
Fixes #107
2021-04-29 17:46:56 +02:00
..
test_array Fix test output 2021-03-17 19:43:36 +01:00
test_bool Update tests with better error message 2021-04-03 19:35:59 +02:00
test_date/good refactor(tests): change the date format to ISO 2021-03-16 12:10:33 +01:00
test_dec/good refactor(tests): update tests based on the abbreviated english lexer 2021-03-09 22:07:31 +01:00
test_default/bad refactor(tests): update tests based on the abbreviated english lexer 2021-03-09 22:07:31 +01:00
test_enum Fix test output 2021-03-17 19:43:36 +01:00
test_exception Update tests with better error message 2021-04-03 19:35:59 +02:00
test_func refactor(tests): update tests based on the abbreviated english lexer 2021-03-09 22:07:31 +01:00
test_money Fix test output 2021-03-17 19:43:36 +01:00
test_name_resolution/good Fix #47 2021-03-12 17:07:25 +01:00
test_scope Fix test output 2021-03-17 19:43:36 +01:00
test_struct Fixes #107 2021-04-29 17:46:56 +02:00
Makefile Js version of Allocations familiales 2021-02-01 20:09:16 +01:00
README.md README 2021-01-25 01:17:43 -05:00

Catala test suite

This folder contains Catala source files designed to test the features of the language.

It uses make pass_tests to launch tests and compare the test terminal output with an expected output.

Expected outputs are stored using the convention <name_of_test>.catala.<name_of_scope>.out in the corresponding test output folder.

For both workflows: use CATALA_OPTS="..." make ... to pass in Catala compiler options when debugging.

Workflow for adding new tests

  1. Create a new test file in foo/{good,bad}/bar.catala (pick the right directory and an informative name for your test)
  2. Write your test, and pick a toplevel scope A to run.
  3. From this directory, launch make foo/{good,bad}/bar.catala.A.run to get the output of your test.
  4. When you're happy with the output, launch make foo/{good,bad}/bar.catala.A.in. This will record the content of the output of your test into a file.
  5. Check that your test pass with make foo/{good,bad}/output/bar.catala.A.out.
  6. That's it, you've added a new test for the Catala language!

Workflow for fixing regressions

  1. Run make, if a test fails you should see something like [FAIL foo/{good,bad}/output/bar.catala.A].
  2. Compare the computed and expected output with make foo/{good,bad}/output/bar.catala.A.out.
  3. Debug the compiler and/or the test, running make foo/{good,bad}/bar.catala.A.run periodically to check the output of Catala on the test case.
  4. When you're finished debugging, record the new test output with make foo/{good,bad}/bar.catala.A.in.
  5. Re-run make to check that everything passes.
  6. That's it, you've fixed the Catala test suite to adapt for changes in the language.

If a compiler change causes a lot of regressions (error message formatting changes for instance), you can mass-reset the expected the outputs with make reset_tests. Caution: use at your own risk, regressions should be fixed one by one in general.