Differences

This shows you the differences between two versions of the page.

--- codesnippets:testingconventions [2022/04/07 12:42] – f2b216
+++ codesnippets:testingconventions [2025/10/08 00:48] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Testing conventions ======
-~~DISCUSSION~~
 ===== Setup with stack =====
@@ Line 109: / Line 108: @@
 === HUnit test ===
-  - Function: HUnit.testCase
+  * Function: HUnit.testCase
-    - 1st parameter :: [Char]/String/TestName: The test name, ends with "#", "u" for unit test and a consecutive number. Optionally the start with a name to be distinct from other sections.
+    - parameter :: [Char]/String/TestName: The test name, ends with "#", "u" for unit test and a consecutive number. Optionally the start with a name to be distinct from other sections.
-      - e.g. "Law A #u1", "Law A #u2", ... "Law A #u33"
+      * e.g. "Law A #u1", "Law A #u2", ... "Law A #u33"
-    - 2nd parameter :: Assertation: Two functions have to have the same result left and right from operator "@?=".
+    - parameter :: Assertation: Two functions have to have the same result left and right from operator "@?=".
-        - e.g. 3 * 2 @?= 2 * 3
+      * e.g. 3 * 2 @?= 2 * 3
   * example ''spec<Module>.hs'':<code>
@@ Line 132: / Line 131: @@
 === QuickCheck test ===
+  * Function: HUnit.testProperty
+    - parameter :: [Char]/String/TestName: The test name, ends with "#", "p" for property test and a consecutive number. Optionally the start with a name to be distinct from other sections.
+      * e.g. "Type 1 #p1", "Type 1 #p2", ... "Type 1 #p42"
+    - parameter :: a: Two functions from a lambda parameter left and rigth from "==>". Whereas the left on is the precondition to evaluate the rigth on, which should be an invariant beeing true.
+      * e.g. 3 * 2 @?= 2 * 3
   * example ''spec<Module>.hs'':<code>
@@ Line 292: / Line 297: @@
     * the complete set of possible test values/data is used in unit tests,
     * or values for all possible equivalence classes are used
-    * or ramdom sample values/data from complete set of possible values/data is used in case of high-volume cases (QuickCheck)
+    * or random sample values/data from complete set of possible values/data is used in case of high-volume cases (QuickCheck)
   * independence:
-    * test method is independent from library functions that are under test,
+    * test methods are independent functions within the same library,
-    * or dependent on tested functions
+    * unless they depend on independent tested functions (if dependencies are not cyclic)
-  * boundaries:
+  * edge cases:
-    * corner cases and boundaries are tested by unit tests (HUnit)
+    * edge cases are tested by unit tests (HUnit)
   * conform doc.:
     * all tests are conform to documentation, e.g. source code comments by haddock)
-After checking the abovementioned criteria, the result is documented as source code comment:
+After checking the above mentioned criteria, the result is documented as source code comment:
   * <code>
-{-  f1
+{-  * validated: ✅
-    * validated: ✅
         * completeness: ✅
         * independence: ✅
-        * boundaries  : ✅
+        * edge cases  : ✅
         * conform doc.: ✅ -}
 tgUnitf1 :: T.TestTree
@@ Line 341: / Line 345: @@
 After checking the abovementioned criteria, the result is documented as source code comment:
   * <code>
-{-  class A
+{-  * validated: ✅
-    * validated: ✅
         * documented: ✅
           * laws             : ✅
@@ Line 376: / Line 379: @@
 Description : provides a class for ...
 Copyright   : (c) <Author>, <Year>
-License     : <Licese>
+License     : <License>
 Maintainer  : <E-Mail-Address>
 Stability   : experimental
@@ Line 389: / Line 392: @@
   * example: <code>
-{- module A
+{-  * validated: ✅
-    * validated: ✅
         * documented: ✅
         * completeness: ✅ -}
@@ Line 405: / Line 407: @@
 </code>
+===== ✎ =====
+~~DISCUSSION~~