gambas-source-code/comp/src/gb.test/taskell.md

## To Do

- Plan
    > Plan does not work. It should define the  count of assertions in a subtest and if  defined ensure that all are executed
    * [ ] Plan for subtests
    * [ ] Plan for testmodules (as a constant?)
- Parser parse subtests
- Decide where Skip, SkipAll, Todo reside
    > SkipAll is in Test, Skip in Assert, Todo in Assert. This is inconsistent, We have to decide where they should be.
- Skip all
    > Parse `1..0 # SKIP` style TAPs indicating that a whole test was skipped.
- Plan selftests
    > gb.test: Every subtest in all tests must plan the own assertion count

## Work

- Install gbt3 at Gambas installation
    > gbt3 is compiled and installed by make but there is no symlink gbt3 > gbt3.gambas

## Done

- Ensure TAP created according to  spec
    > Tested TAP via gbt3 and python tappy
- gbt3 has to return exit status at the end
- Assert and Test documentation
    > Every public method in Test and Assert has to have a description
- Hide symbols in Test
    > There are symbols in Test which should not be shown to the enduser. These shoult be hidden by a leading underscore:
    * [ ] Subtest
    * [ ] Finish
    * [ ] Reset
- No Bug: Directives always 0
    > Was no bug, was lack of understanding
- TestAssertion: Skip and Todo
    > TestAssertion must contain variables to store Skip and Todo for summary. See TestSummary.
- Todo Directive
    > Todo directive does not exist. See TestSummary. Was wrong. Todo exists.
- Free Assert from non-assertions
    > There are things in Assert which are no assertions, like Print, Finish, Note and so on. These should be methods of Test. For example: Test.Plan, Test.Note, Test.Finish ...
- Test.Main has to complain if testmodule doesn't exist
- Human readability of TAP output
- Subtests don't count the right way
    > If there is only one testmodule called, subtest counts a lot of subtests instead just one
- gb.test doesn't print to console
- Summary as a TAP comment
    > Description in .hidden/summary-example-txt
    * [x] New method Test.ShowTodos
    * [x] New method Test.ShowSkips
Taskell Kanboard Taskell is a somewhat bulky kanboard for the commandline, but for me seems to be sufficient to organize the few things we have to do until 3.15. 2020-04-12 10:38:02 +02:00			`## To Do`

README and tasks updated 2020-05-03 07:36:31 +02:00			`- Plan`
			`> Plan does not work. It should define the count of assertions in a subtest and if defined ensure that all are executed`
			`* [ ] Plan for subtests`
			`* [ ] Plan for testmodules (as a constant?)`
			`- Parser parse subtests`
hide Test.Finish and documentation 2020-05-02 18:35:48 +02:00			`- Decide where Skip, SkipAll, Todo reside`
			`> SkipAll is in Test, Skip in Assert, Todo in Assert. This is inconsistent, We have to decide where they should be.`
Taskell next task todo and skip Both are not implemented well but necessary for summary 2020-04-26 12:49:06 +02:00			`- Skip all`
Show TODOs and SKIPs in summary [GB.TEST] * BUG: Do not trim whitespace from diagnostic lines. * NEW: Show TODOs (failed and bonus) and SKIPs in summary. Previously, TapPrinter.Diagnostic would Trim$ its argument before splitting it by line. This would remove any indentation that may be useful for formatted diagnostics output, so it has to go. Additionally I special-case Null and gb.Lf to print exactly "#\n", which is a common use case as a visual separator. 2020-05-01 15:57:53 +02:00			> Parse `1..0 # SKIP` style TAPs indicating that a whole test was skipped.
Fix: Test bails out if testmodule doesn't exist 2020-04-26 11:23:01 +02:00			`- Plan selftests`
			`> gb.test: Every subtest in all tests must plan the own assertion count`
Taskell Kanboard Taskell is a somewhat bulky kanboard for the commandline, but for me seems to be sufficient to organize the few things we have to do until 3.15. 2020-04-12 10:38:02 +02:00
			`## Work`

gbt3 install and task 2020-05-03 11:26:05 +02:00			`- Install gbt3 at Gambas installation`
			`> gbt3 is compiled and installed by make but there is no symlink gbt3 > gbt3.gambas`
hide Test.Finish and documentation 2020-05-02 18:35:48 +02:00
			`## Done`

gbt3: some fixes and tasks done Returns exit code. Doesn't print a summary any more as this is provided by gb.test. Doesn't print blank line at the beginning any more. Plan has to be in the first line. Works fine with tappy (python TAP consumer) Kills temporary startup file 2020-05-03 10:24:13 +02:00			`- Ensure TAP created according to spec`
			`> Tested TAP via gbt3 and python tappy`
			`- gbt3 has to return exit status at the end`
hide Test.Finish and documentation 2020-05-02 18:35:48 +02:00			`- Assert and Test documentation`
			`> Every public method in Test and Assert has to have a description`
started documentation and task hide symbols 2020-05-02 11:53:30 +02:00			`- Hide symbols in Test`
			`> There are symbols in Test which should not be shown to the enduser. These shoult be hidden by a leading underscore:`
			`* [ ] Subtest`
			`* [ ] Finish`
			`* [ ] Reset`
Rewrite TestSummary and TestMe TestSummary.DoSomeAsserts, DoTodo and DoSkip succeed 2020-05-01 10:42:29 +02:00			`- No Bug: Directives always 0`
			`> Was no bug, was lack of understanding`
taskell updated: Todo exists 2020-04-28 09:36:44 +02:00			`- TestAssertion: Skip and Todo`
			`> TestAssertion must contain variables to store Skip and Todo for summary. See TestSummary.`
			`- Todo Directive`
			`> Todo directive does not exist. See TestSummary. Was wrong. Todo exists.`
Fix: Free Assert from non-assertions Assert free from non-assertions. Also Assert and Test now are modules. 2020-04-27 12:01:47 +02:00			`- Free Assert from non-assertions`
			`> There are things in Assert which are no assertions, like Print, Finish, Note and so on. These should be methods of Test. For example: Test.Plan, Test.Note, Test.Finish ...`
Fix: Test bails out if testmodule doesn't exist 2020-04-26 11:23:01 +02:00			`- Test.Main has to complain if testmodule doesn't exist`
			`- Human readability of TAP output`
gb.test and gbt3 some refactoring and future tasks 2020-04-25 11:38:52 +02:00			`- Subtests don't count the right way`
			`> If there is only one testmodule called, subtest counts a lot of subtests instead just one`
			`- gb.test doesn't print to console`
Show TODOs and SKIPs in summary [GB.TEST] * BUG: Do not trim whitespace from diagnostic lines. * NEW: Show TODOs (failed and bonus) and SKIPs in summary. Previously, TapPrinter.Diagnostic would Trim$ its argument before splitting it by line. This would remove any indentation that may be useful for formatted diagnostics output, so it has to go. Additionally I special-case Null and gb.Lf to print exactly "#\n", which is a common use case as a visual separator. 2020-05-01 15:57:53 +02:00			`- Summary as a TAP comment`
			`> Description in .hidden/summary-example-txt`
			`* [x] New method Test.ShowTodos`
			`* [x] New method Test.ShowSkips`