Added detailed description to regression tests.

Author: klaas

regression/contracts/function_apply_01/main.c

@@ -1,8 +1,11 @@
-#include <assert.h>
+// function_apply_01
 
-// Note that this is supposed to have an incorrect contract.
+// Note that this test is supposed to have an incorrect contract.
 // We verify that applying (without checking) the contract yields success,
 // and that checking the contract yields failure.
+
+#include <assert.h>
+
 int foo() 
 __CPROVER_ensures(__CPROVER_return_value == 0)
 {

regression/contracts/function_check_01/main.c

@@ -1,3 +1,8 @@
+// function_check_01
+
+// This tests a simple example of a function with requires and
+// ensures which should both be satisfied.
+
 #include <assert.h>
 
 int min(int a, int b)

regression/contracts/function_check_02/main.c

@@ -1,3 +1,8 @@
+// function_check_02
+
+// This test checks the use of quantifiers in ensures clauses.
+// A known bug causes the use of quantifiers in ensures to fail.
+
 int initialize(int* arr)
 __CPROVER_ensures(
   __CPROVER_forall {int i; (0 <= i && i < 10) ==> arr[i] == i}

regression/contracts/function_check_03/main.c

@@ -1,3 +1,10 @@
+// function_check_03
+
+// This extends function_check_02's test of quantifiers in ensures
+// and adds in a loop invariant which can be used to prove the ensures.
+// This currently fails because side-effect checking in loop invariants is
+// incorrect.
+
 void initialize(int* arr, int len)
 __CPROVER_ensures(
   __CPROVER_forall {int i; (0 <= i && i < len) ==> arr[i] == i}

regression/contracts/function_check_04/main.c

@@ -1,8 +1,10 @@
+// function_check_04
+
+// Note that this test is supposed to have an incorrect contract.
+// We verify that checking this faulty contract (correctly) yields a failure.
+
 #include <assert.h>
 
-// Note that this is supposed to have an incorrect contract.
-// We verify that applying (without checking) the contract yields success,
-// and that checking the contract yields failure.
 int foo() 
 __CPROVER_ensures(__CPROVER_return_value == 0)
 {

regression/contracts/function_check_05/main.c

@@ -1,3 +1,10 @@
+// function_check_05
+
+// This test checks that when a function call is replaced by an invariant,
+// it adequately havocs the locations modified by the function.
+// This test currently fails because the analysis of what is modified by
+// a function is flawed.
+
 #include <assert.h>
 
 int foo(int* x) 

regression/contracts/function_check_mem_01/main.c

@@ -1,3 +1,10 @@
+// function_check_mem_01
+
+// This test checks the use of pointer-related predicates in assumptions and
+// requires.
+// This test currently fails because of the lack of support for assuming
+// pointer predicates.
+
 #include <stddef.h>
 
 #define __CPROVER_VALID_MEM(ptr, size) \

regression/contracts/invar_check_01/main.c

@@ -1,3 +1,8 @@
+// invar_check_01
+
+// This test checks that a basic loop invariant can be proven and used in
+// combination with the negation of the loop guard to get a result.
+
 #include <assert.h>
 
 int main()

regression/contracts/invar_check_02/main.c

@@ -1,3 +1,7 @@
+// invar_check_02
+
+// This test checks that loop invariants adequately handle continues.
+
 #include <assert.h>
 
 int main()

regression/contracts/invar_check_03/main.c

@@ -1,3 +1,10 @@
+// invar_check_03
+
+// This test checks the use of loop invariants on a larger problem --- in this
+// case, the partition portion of quicksort, applied to a fixed-length array.
+// This serves as a stop-gap test until issues to do with quantifiers and
+// side-effects in loop invariants are fixed.
+
 #include <stdio.h>
 #include <assert.h>