Lay out tests following the same structure as Yampa

[ivanperez-keera]

Understanding which parts of Yampa are tested and which ones are not is generally hard.

There are (at least) two non-exclusive ways to achieve this. We could use some coverage metrics to understand how much of the implementation is covered by the tests. Alternatively, we could just make it trivial to compare a module and their corresponding tests, to determine that indeed unit tests for each published element are included.

I'd like to implement the second, as a simple, lightway approach at keeping tests organized and helping identify which elements of the interface remain to be tested. Therefore, the goal would be to open each module under yampa-test/tests/Test, compare it with its corresponding module under yampa/src/, and organize elements in the yampa-test module following the same order as in yampa.

As a side effect of this process, it would also be good to identify which elements of the interface are not covered by tests.

[ivanperez-keera]

I've added one such change here: https://github.com/ivanperez-keera/Yampa/tree/develop-tests-orgModules

As you can see, the only thing I'm doing is changing the order of definitions in the module, changing the order of tests to match, and adding haddock separators.

I used vi -d to open this module and Yampa's yampa/src/FRP/Yampa/Basic.hs side by side and compare.

Also, if anyone decides to do this, look at the commit message. You can probably get away with copying the same message, and changing the module name.

[ivanperez-keera]

Notes on Test.FRP.Yampa.Basic:

• Elements not tested in FRP.Yampa.Basic:
  (-->), (-:>), (>--), (-=>), (>=-)
• There is a prop_insert not listed under tests.
• One function prop has no signature.

[ivanperez-keera]

Notes on Test.FRP.Yampa.Conditional:

• Elements not tested:
  pause.

Notes on Test.FRP.Yampa.Delays:

• Elements not tested individually:
  pre (but iPre is defined in terms of it and is being tested), fby.
• Functions prop, prop_always_equal has no signature.

Notes on Test.FRP.Yampa.EventS:

• Elements not tested individually:
  delayEvent, delayEventCat, iEdge, edgeTag, edgeJust, notYet

Notes on Test.FRP.Yampa.Hybrid:

• Elements no tested individually:
  accumHold, dAccumHold.

Notes on Test.FRP.Yampa.Integration:

• Elements not tested individually:
  integral, imIntegral, iterFrom.
• Function prop has no signature.

[ivanperez-keera]

Notes on Test.FRP.Yampa.InternalCore:

• Elements not (directly) tested:
  • Time
  • DTime
  • SF(..)
  • SF'(..)
  • Transition
  • sfTF'
  • sfId
  • sfConst
  • sfArrG
  • sfSScan
  • FunDesc(..)
  • fdFun
  • arrPrim
  • arrEPrim
  • epPrim

Notes on Test.FRP.Yampa.Random:

• Module does not exist.

Notes on Test.FRP.Yampa.Arrow:

• Module does not exist.

Notes on Test.FRP.Yampa.Event:

• Module does not exist.

Notes on Test.FRP.Yampa.Simulation:

• Elements not (directly) tested:
  • ReactHandle
  • reactInit
  • react
  • embedSynch (tested in combination with embed)
  • deltaEncode (tested in combination with embed)
  • deltaEncodeBy
  • FutureSF
  • evalAtZero
  • evalAt
  • evalFuture

Notes on Test.FRP.Yampa.Switches:

• Elements not (directly) tested:
  • par
  • pSwitch
  • dpSwitch
  • rpSwitch
  • drpSwitch
  • parZ
  • pSwitchZ
  • dpSwitchZ
  • drpSwitchZ
  • parC

Notes on Test.FRP.Yampa.Task:

• Elements not (directly) tested:
  • runTask_
  • taskToSF
  • constT