Homework to practice IO basics, testing, and project documentation
This time you will work on a "half-done" smaller project called SELF-TESTER.
- CLI = your task is to implement command line interface so a user can do a self-test in console interactively. First, you need to explore the code a bit and then implement
Tester.CLI(some requirements are there in comments). The test should be loaded from a JSON file (using aeson library, seeTester.Model.AesonInstances), the file is provided via argument. There are also some behavioral options... Then the interface should ask questions and show results. No tests are provided. You can run the CLI withstack exec selftester(afterstack build). Since there are no tests, you can use your creativity as well as change/extend given modules as you need. - Tests = second task is to write tests using HSpec and also its integration with QuickCheck for testing properties. Tests dependencies have to be specified by you. You can get some inspiration from previous hws. Everything should be tested... If you find some problems, fix them. We will try to make faulty implementations and check if those will or won't pass your tests.
- Documentation = final task is to write Haddock documentation for
Testermodules - keep it short and clear... but complete and comprehensive!
% stack build
% stack test
% stack haddock
% stack exec selftester ./haskell-test.json learn
% stack exec selftester ./haskell-test.json train
% stack exec selftester ./haskell-test.json
- If you encounter some trouble, create an issue in your repository.
- In case you find a bug or have an idea how to improve assignment project, create an issue or PR in this repository.
This project is licensed under the MIT License - see the LICENSE file for more details.