Added more documentation to the tests for the Rain frontend passes

frontends/RainPassesTest.hs

@@ -18,6 +18,15 @@ with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 -- #ignore-exports
 
+-- | This file has tests for various Rain passes.  The tests are quite nasty to look at.
+-- They usually consist of a hand-constructed AST fragment that is the input to the test.
+-- The expected output is either a resulting AST, or a check on the items matched in the pattern.
+-- This stuff is all built on top of the Pattern system, which you can find more about in the
+-- Pattern, TreeUtils and TestUtils module.  Briefly, it is an easy way to match an actual test
+-- result against an expected pattern, that may have special features in it.  See the other module
+-- documentation.
+--
+-- TODO document each test in this file.
 module RainPassesTest (tests) where
 
 import Control.Monad.State
@@ -35,9 +44,12 @@ import RainTypes
 import TestUtil
 import TreeUtil
 
+-- | A helper function that returns a simple A.Structured item (A.OnlyP m $ A.Skip m).
 skipP :: A.Structured
 skipP = A.OnlyP m (A.Skip m)
 
+-- | A function that tries to cast a given value into the return type, and dies (using "dieInternal")
+-- if the cast isn't valid.
 castAssertADI :: (Typeable b) => Maybe AnyDataItem -> IO b
 castAssertADI x = case (castADI x) of
   Just y -> return y

frontends/RainTypesTest.hs

@@ -16,6 +16,7 @@ You should have received a copy of the GNU General Public License along
 with this program.  If not, see <http://www.gnu.org/licenses/>.
 -}
 
+-- | A module testing things from the RainTypes module.
 module RainTypesTest where
 
 import Control.Monad.State
@@ -33,6 +34,8 @@ import TestUtil
 import TreeUtil
 import Types
 
+-- | Tests that constants in expressions are folded properly.  TODO these tests could do with a lot of expanding.
+-- It may even be easiest to use QuickCheck for the testing.
 constantFoldTest :: Test
 constantFoldTest = TestList
  [
@@ -61,6 +64,9 @@ constantFoldTest = TestList
    lit :: Integer -> ExprHelper
    lit n = Lit $ int64Literal n
 
+-- | Tests that integer literals are correctly annotated with the smallest type that can hold them.
+-- We only test the boundaries between each integer type, but that should suffice.
+-- TODO was there a reason I didn't test unsigned numbers?
 annotateIntTest :: Test
 annotateIntTest = TestList
  [
@@ -89,6 +95,8 @@ annotateIntTest = TestList
   failSigned :: Integer -> Test
   failSigned n = TestCase $ testPassShouldFail ("annotateIntTest: " ++ show n) (annnotateIntLiteralTypes $ int64Literal n) (return ())
 
+-- | An amazing amount of tests for testing the Rain type-checker for all the different forms of statement,
+-- such as assignment, expressions, communications, etc etc.
 --TODO add typechecks for expressions involving channels
 checkExpressionTest :: Test
 checkExpressionTest = TestList
@@ -355,9 +363,8 @@ checkExpressionTest = TestList
   pass :: Int -> A.Type -> ExprHelper -> ExprHelper -> Test
   pass n t exp act = TestCase $ pass' n t (buildExprPattern exp) (buildExpr act)
 
-  --To easily get more tests, we take the result of every successful pass (which must be fine now), and feed it back through
+  -- | To easily get more tests, we take the result of every successful pass (which must be fine now), and feed it back through
   --the type-checker to check that it is unchanged  
-  
   pass' :: Int -> A.Type -> Pattern -> A.Expression -> Assertion
   pass' n t exp act = testPassWithCheck ("checkExpressionTest " ++ show n) exp (checkExpressionTypes act) state (check t)   
     where