(type egg)
(signature "cluckcheck egg")
(timestamp 1633853282)
(sxml ((section 2 "Outdated egg!" (p "This is an egg for CHICKEN 4, the unsupported old release.  You're almost certainly looking for " (int-link "/eggref/5/cluckcheck" "the CHICKEN 5 version of this egg") ", if it exists.") (p "If it does not exist, there may be equivalent functionality provided by another egg; have a look at the " (link "https://wiki.call-cc.org/chicken-projects/egg-index-5.html" "egg index") ". Otherwise, please consider porting this egg to the current version of CHICKEN.")) (section 2 "Cluckcheck" (section 3 "Description" (p "cluckcheck is a Chicken Scheme port of the " (link "http://www.cse.chalmers.se/~rjmh/QuickCheck/" "QuickCheck") " unit test framework.") (p "cluckcheck is a different kind of unit test framework. Rather than using a bunch of manual assert-assert-assert statements, cluckcheck tests properties. For an overview of the QuickCheck methodology, see the homepage.")) (section 3 "Homepage" (p (link "http://www.yellosoft.us/quickcheck" "YelloSoft QuickCheck"))) (section 3 "Source" (p (link "https://github.com/mcandre/cluckcheck" "GitHub"))) (section 3 "Authors" (p "Andrew Pennebaker (" (link "http://www.yellosoft.us/" "Homepage") ")")) (section 3 "Requirements" (p "No egg requirements.")) (section 3 "API" (def (sig (procedure "(gen-int)" (id gen-int))) (p "Generate a random integer.") (pre "> (use cluckcheck)\n> (gen-int)\n180")) (def (sig (procedure "(gen-bool)" (id gen-bool))) (p "Generate a random boolean.") (pre "> (gen-bool)\n#t")) (def (sig (procedure "(gen-char)" (id gen-char))) (p "Generate a random character.") (pre "> (gen-char)\n#\\g")) (def (sig (procedure "(gen-list gen)" (id gen-list))) (p "Generate a random list populated by gen.") (pre "> (gen-list gen-int)\n(103 24 45 253 227 28 92 45 235 193 212 27 9 195 224 228 103 255)") (p "gen-list can be combined with other generators, including custom generators, to create generators for complex data structures. See gen-string.")) (def (sig (procedure "(gen-string)" (id gen-string))) (p "Generate a random string. gen-string is a wrapper around (gen-list gen-char).") (pre "> (gen-string)\n\"\\x05&o@\\by\\x00J &\\x00\\v\\x1691\\x05\\x19\\x14z\\r<VxU\\x1b\\x06~(wE\\x05\\x03LB&T\\x1fLl-\\x15\\x06\"")) (def (sig (procedure "(for-all property gen1 gen2 gen3...)" (id for-all))) (p "Tests a property function with values generated by the generator functions. If the property returns false, testing halts and the offending input values are printed to the screen.") (pre "> (for-all even? gen-int)\n*** Failed!\n(57)") (p "Here, the test fails because an integer (57) is found, that is not even.") (p "For more examples, see " (link "https://github.com/mcandre/cluckcheck/blob/master/example.scm" "example.scm") "."))) (section 3 "License" (p "BSD")) (section 3 "Version History" (p "cluckcheck 0.0 - First release")))))
