Merge pull request #486 from ProofGeneral/coq-tests-for-master

Coq tests for master

4 files changed, 340 insertions, 52 deletions

diff --git a/ci/coq-tests.el b/ci/coq-tests.el
index 057f918e..015b831e 100644
--- a/ci/coq-tests.el
+++ b/ci/coq-tests.el
@@ -5,12 +5,19 @@
 
 ;;;  Eval this to run the tests interactively <C-x C-e>
 ;;
-;; (call-interactively #'ert-run-tests-interactively)
+;; (progn (load-file "coq-tests.el") (call-interactively #'ert))
+
+(unless (and (boundp 'coq-test-dir) coq-test-dir) ; if set by ./test.sh
+  (if buffer-file-name
+      (setq coq-test-dir (file-name-directory buffer-file-name))
+    (error "You should set 'coq-test-dir, or run coq-test.el from a file buffer.")))
 
 (setq debug-on-error t) ; open the debugger on error -- may be commented-out
+(setq ert-batch-backtrace-right-margin 79)
 
-(require 'ert-async)
-;(setq ert-async-timeout 2)
+(require 'subr-x) ;; for (string-trim)
+;;(require 'ert-async)
+;;(setq ert-async-timeout 2)
 
 ;;; Code:
 
@@ -43,50 +50,30 @@
 ; 
 ; (test-process-invisible-tactics-then-reset-and-insert)
 
+(defun coq-test-full-path (basename)
+  "Return the absolute path of BASENAME (a filename such as ./foo.v)."
+  (concat coq-test-dir basename))
+
 (defconst coq-test-file-prefix "coq_test_")
 
 (defun coq-test-init ()
   "Ensure `coq' is loaded."
   (unless (featurep 'coq)
     (add-to-list 'load-path
-		 (locate-dominating-file buffer-file-name "proof-general.el"))
+		 (locate-dominating-file coq-test-dir "proof-general.el"))
     (load "proof-general")
     (proofgeneral "coq")))
 
 (defun coq-test-exit ()
   "Exit the Coq process."
-  (proof-shell-exit t))
+  (proof-shell-exit t)) 
 
-;; AVOID THE FOLLOWING ERROR:
-;; Starting:  -emacs
-;; Debugger entered--Lisp error: (wrong-type-argument stringp nil)
-;;   file-name-directory(nil)
-;;   scomint-exec-1("coq" #<buffer *coq*> nil ("-emacs"))
-;;   scomint-exec(#<buffer *coq*> "coq" nil nil ("-emacs"))
-;;   scomint-make-in-buffer("coq" nil nil nil "-emacs")
-;;   apply(scomint-make-in-buffer "coq" nil nil nil "-emacs")
-;;   scomint-make("coq" nil nil "-emacs")
-;;   apply(scomint-make ("coq" nil nil "-emacs"))
-;;   proof-shell-start()
-;;   proof-shell-ready-prover()
-(defmacro coq-test-on-file (&rest body)
-  "Eval BODY like `progn' after opening a temporary Coq file."
-  ;; For more info: https://mullikine.github.io/posts/macro-tutorial/
-  `(let ((file (concat (make-temp-file coq-test-file-prefix) ".v")))
-     (message "Opening file %s ..." file)
-     (save-excursion          
-       (let ((buffer (find-file file))
-             (res (progn ,@body)))
-         (progn (kill-buffer buffer)
-                (ignore-errors (delete-file file))
-                res)))))
-; (pp (macroexpand '(coq-test-on-file (message "OK"))))
-; (coq-test-on-file (message (buffer-file-name)) (message "OK") 42)
+; (coq-test-on-file nil (message (buffer-file-name)) (message "OK") 42)
 
 ;; DEFINITION OF MOCKS, SEE `coq-mock' BELOW
 ;; Another solution would consist in using el-mock, mentioned in:
 ;; https://www.gnu.org/software/emacs/manual/html_mono/ert.html#Mocks-and-Stubs
-(defun mock-proof-display-three-b (&rest rest)
+(defun coq-mock-proof-display-three-b (&rest rest)
   (message (concat "Skipping proof-display-three-b on input: "
                    (pp-to-string rest)))
   ; Result:
@@ -109,31 +96,164 @@
 (defun coq-mock (f)
   (require 'pg-response) ; load the feature defining proof-display-three-b first
    (cl-letf (;((symbol-function 'foo) #'mock-foo)
-             ((symbol-function 'proof-display-three-b) #'mock-proof-display-three-b))
+             ((symbol-function 'proof-display-three-b) #'coq-mock-proof-display-three-b))
      (funcall f)))
 ;; Run <C-x C-e> on:
 ;; (coq-mock #'main)
 
 (defun coq-test-cmd (cmd)
-  (coq-test-on-file
-    (coq-test-init)
-    (proof-shell-invisible-command
-     cmd
-     'waitforit
-     #'proof-done-invisible
-     'no-error-display 'no-response-display 'no-goals-display)))
-
-(defun coq-test-001 ()
-  ;; TODO: retrieve the test status, maybe by changing the function above
-  (coq-test-cmd "Print nat."))
+  ;;(coq-test-on-file)
+  ;;(coq-test-init)
+  (proof-shell-invisible-command
+   cmd
+   'waitforit
+   #'proof-done-invisible
+   'no-error-display 'no-response-display 'no-goals-display))
+
+
+(defun coq-fixture-on-file (file body)
+  "Fixture to setup the test env: open FILE if non-nil, or a temp file
+then evaluate the BODY function and finally tear-down (exit Coq)."
+;; AVOID THE FOLLOWING ERROR:
+;; Starting:  -emacs
+;; Debugger entered--Lisp error: (wrong-type-argument stringp nil)
+;;   file-name-directory(nil)
+;;   scomint-exec-1("coq" #<buffer *coq*> nil ("-emacs"))
+;;   scomint-exec(#<buffer *coq*> "coq" nil nil ("-emacs"))
+;;   scomint-make-in-buffer("coq" nil nil nil "-emacs")
+;;   apply(scomint-make-in-buffer "coq" nil nil nil "-emacs")
+;;   scomint-make("coq" nil nil "-emacs")
+;;   apply(scomint-make ("coq" nil nil "-emacs"))
+;;   proof-shell-start()
+;;   proof-shell-ready-prover()
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;; For info on macros: https://mullikine.github.io/posts/macro-tutorial
+;;; (pp (macroexpand '(macro args)))
+  (save-excursion
+    (let* ((openfile (or file
+                         (concat (make-temp-file coq-test-file-prefix) ".v")))
+           ;; if FILE is nil, create a temporary Coq file, removed in the end
+           (rmfile (unless file openfile))
+           (buffer (find-file openfile)))    
+      (message "Opening file %s ..." openfile)
+      (unwind-protect
+          (progn
+            (coq-test-init)
+            (with-current-buffer buffer
+              (setq proof-splash-enable nil)
+              (normal-mode) ;; or (coq-mode)
+              (coq-mock body))))
+      (coq-test-exit)
+      (not-modified nil) ; Clear modification  
+      (kill-buffer buffer) 
+      (when rmfile (message "Removing file %s ..." rmfile))
+      (ignore-errors (delete-file rmfile)))))
+
+(defun coq-test-goto-before (comment)
+  "Go just before COMMENT (a unique string in the .v file).
+For example, COMMENT could be (*test-definition*)"
+  (goto-char (point-max))
+  (search-backward comment))
+
+(defun coq-test-goto-after (comment)
+  "Go just before COMMENT (a unique string in the .v file)."
+  (goto-char (point-min))
+  (search-forward comment))
+
+(defun coq-should-response (message)
+  (should (equal message
+		 (string-trim
+                  (with-current-buffer "*response*"
+                    (buffer-substring-no-properties (point-min) (point-max)))))))
+
 ;; TODO: Use https://github.com/rejeep/ert-async.el
 ;; and/or ERT https://www.gnu.org/software/emacs/manual/html_node/ert/index.html
 
-(defun coq-test-main ()
-  (coq-mock #'coq-test-001))
+(ert-deftest 010_coq-test-running ()
+  "Test that the coqtop process is started properly."
+  (coq-fixture-on-file nil
+   (lambda ()
+     (coq-test-cmd "Print 0.")
+     ;; (should (process-list)) ; wouldn't be a strong enough assert.
+     (should (get-process "coq")))))
+
 
-;(ignore-errors (coq-test-exit))
-(coq-test-main)
+(ert-deftest 020_coq-test-definition ()
+  "Test *response* output after asserting a Definition."
+  (coq-fixture-on-file
+   (coq-test-full-path "test_stepwise.v")
+   (lambda ()
+     (coq-test-goto-before "(*test-definition*)")
+     (proof-goto-point)
+     (proof-shell-wait)
+     (coq-should-response "trois is defined"))))
+
+
+(ert-deftest 030_coq-test-position ()
+  "Test locked region after Qed."
+  (coq-fixture-on-file
+   (coq-test-full-path "test_stepwise.v")
+   (lambda ()
+     (coq-test-goto-before " (*test-lemma*)")
+     (let ((proof-point (point)))
+     (proof-goto-point)
+     (proof-shell-wait)
+     (should (equal (proof-queue-or-locked-end) proof-point))))))
+
+
+(ert-deftest 040_coq-test-insert ()
+  "Test retract on insert from Qed."
+  (coq-fixture-on-file
+   (coq-test-full-path "test_stepwise.v")
+   (lambda ()
+     (coq-test-goto-before " (*test-lemma*)")
+     (proof-goto-point)
+     (proof-shell-wait)
+     (let ((proof-point (point)))
+       (coq-test-goto-before "(*test-insert*)")
+       (move-beginning-of-line nil)
+       (insert "\n")
+       ;; The locked end point should go up compared to before 
+       (should (< (proof-queue-or-locked-end) proof-point))))))
+
+
+(ert-deftest 050_coq-test-lemma-false ()
+  "Test retract on proof error."
+  (coq-fixture-on-file
+   (coq-test-full-path "test_stepwise.v")
+   (lambda ()
+     (coq-test-goto-before " (*test-lemma2*)")
+     (let ((proof-point (save-excursion (coq-test-goto-after "(*error*)")))) 
+     (proof-goto-point)
+     (proof-shell-wait)
+     (coq-should-response "Error: Unable to unify \"false\" with \"true\".")
+     (should (equal (proof-queue-or-locked-end) proof-point))))))
+
+
+(ert-deftest 060_coq-test-wholefile ()
+  "Test `proof-process-buffer'."
+  (coq-fixture-on-file
+   (coq-test-full-path "test_wholefile.v")
+   (lambda ()
+     (let ((proof-point (save-excursion
+			  (coq-test-goto-before "Theorem")
+			  (search-forward "Qed."))))
+     (proof-process-buffer)
+     (proof-shell-wait)
+     (should (equal (proof-queue-or-locked-end) proof-point))))))
+
+
+(ert-deftest 070_coq-test-regression-wholefile-no-proof ()
+  "Regression test for no proof bug"
+  (coq-fixture-on-file
+   (coq-test-full-path "test_wholefile.v")
+   (lambda ()
+     (proof-process-buffer)
+     (proof-shell-wait)
+     (goto-char (point-min))
+     (insert "(*.*)")
+     (should (equal (proof-queue-or-locked-end) 1)))))
 
 (provide 'coq-tests)
-;;; learn-ocaml-tests.el ends here
+
+;;; coq-tests.el ends here
diff --git a/ci/test.sh b/ci/test.sh
index b29d5af7..50d07579 100755
--- a/ci/test.sh
+++ b/ci/test.sh
@@ -29,10 +29,11 @@ assert () {
 
 assert emacs --version
 
-srcdir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && cd .. && pwd )
-rootdir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )
+rootdir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && cd .. && pwd )
+srcdir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )
 
-# form="(message \"OK\")"
-form="(progn (add-to-list 'load-path \"$rootdir\") (add-to-list 'load-path \"$srcdir\"))"
+form="(progn (add-to-list 'load-path \"$rootdir\")
+(add-to-list 'load-path \"$srcdir\")
+(setq coq-test-dir \"$srcdir/\"))"  # we need a trailing slash here
 
 assert emacs --batch -l ert --eval "$form" -l init-tests.el -l proof-general.el -l coq-tests.el -f ert-run-tests-batch-and-exit
diff --git a/ci/test_stepwise.v b/ci/test_stepwise.v
new file mode 100644
index 00000000..3812adbd
--- /dev/null
+++ b/ci/test_stepwise.v
@@ -0,0 +1,22 @@
+Definition trois := 3. (*test-definition*)
+Print trois.
+Eval compute in 10 * trois * trois.
+ 
+
+
+Lemma easy_proof : forall A : Prop, A -> A.
+Proof using .
+  intros A.
+  intros proof_of_A. (*test-insert*)
+  exact proof_of_A.
+Qed. (*test-lemma*)
+
+Lemma false_proof : forall A B : bool, A = B. 
+Proof.
+  intros A B.
+  destruct A.
+  destruct B.
+  reflexivity. (*error*)
+  reflexivity.
+Qed. (*test-lemma2*)
+  
diff --git a/ci/test_wholefile.v b/ci/test_wholefile.v
new file mode 100644
index 00000000..9deee01d
--- /dev/null
+++ b/ci/test_wholefile.v
@@ -0,0 +1,145 @@
+(* taken from https://coq.inria.fr/distrib/8.2/contribs/QArithSternBrocot.sqrt2.html *)
+(* Note: this file contains no "Proof" command (invariant to preserve)
+   in order to exercise 070_coq-test-regression-wholefile-no-proof. *)
+
+Require Export ArithRing.
+Require Export Compare_dec.
+Require Export Wf_nat.
+Require Export Arith.
+Require Export Omega.
+
+Theorem minus_minus : forall a b c : nat, a - b - c = a - (b + c).
+intros a; elim a; auto.
+intros n' Hrec b; case b; auto.
+Qed.
+
+Remark expand_mult2 : forall x : nat, 2 * x = x + x.
+intros x; ring.
+Qed.
+
+Theorem lt_neq : forall x y : nat, x < y -> x <> y.
+unfold not in |- *; intros x y H H1; elim (lt_irrefl x);
+ pattern x at 2 in |- *; rewrite H1; auto.
+Qed.
+Hint Resolve lt_neq.
+
+Theorem monotonic_inverse :
+ forall f : nat -> nat,
+ (forall x y : nat, x < y -> f x < f y) ->
+ forall x y : nat, f x < f y -> x < y.
+intros f Hmon x y Hlt; case (le_gt_dec y x); auto.
+intros Hle; elim (le_lt_or_eq _ _ Hle).
+intros Hlt'; elim (lt_asym _ _ Hlt); apply Hmon; auto.
+intros Heq; elim (lt_neq _ _ Hlt); rewrite Heq; auto.
+Qed.
+
+Theorem mult_lt : forall a b c : nat, c <> 0 -> a < b -> a * c < b * c.
+intros a b c; elim c.
+intros H; elim H; auto.
+intros c'; case c'.
+intros; omega.
+intros c'' Hrec Hneq Hlt;
+ repeat rewrite <- (fun x : nat => mult_n_Sm x (S c'')).
+auto with *.
+Qed.
+
+Remark add_sub_square_identity :
+ forall a b : nat,
+ (b + a - b) * (b + a - b) = (b + a) * (b + a) + b * b - 2 * ((b + a) * b).
+intros a b; rewrite minus_plus.
+repeat rewrite mult_plus_distr_r || rewrite <- (mult_comm (b + a)).
+replace (b * b + a * b + (b * a + a * a) + b * b) with
+ (b * b + a * b + (b * b + a * b + a * a)); try (ring; fail).
+rewrite expand_mult2; repeat rewrite minus_plus; auto with *.
+Qed.
+
+Theorem sub_square_identity :
+ forall a b : nat, b <= a -> (a - b) * (a - b) = a * a + b * b - 2 * (a * b).
+intros a b H; rewrite (le_plus_minus b a H); apply add_sub_square_identity.
+Qed.
+
+Theorem square_monotonic : forall x y : nat, x < y -> x * x < y * y.
+intros x; case x.
+intros y; case y; simpl in |- *; auto with *.
+intros x' y Hlt; apply lt_trans with (S x' * y).
+rewrite (mult_comm (S x') y); apply mult_lt; auto.
+apply mult_lt; omega.
+Qed.
+
+Theorem root_monotonic : forall x y : nat, x * x < y * y -> x < y.
+exact (monotonic_inverse (fun x : nat => x * x) square_monotonic).
+Qed.
+
+Remark square_recompose : forall x y : nat, x * y * (x * y) = x * x * (y * y).
+intros; ring.
+Qed.
+
+Remark mult2_recompose : forall x y : nat, x * (2 * y) = x * 2 * y.
+intros; ring.
+Qed.
+Section sqrt2_decrease.
+Variables (p q : nat) (pos_q : 0 < q) (hyp_sqrt : p * p = 2 * (q * q)).
+
+Theorem sqrt_q_non_zero : 0 <> q * q.
+generalize pos_q; case q.
+intros H; elim (lt_n_O 0); auto.
+intros n H.
+simpl in |- *; discriminate.
+Qed.
+Hint Resolve sqrt_q_non_zero.
+
+Ltac solve_comparison :=
+  apply root_monotonic; repeat rewrite square_recompose; rewrite hyp_sqrt;
+   rewrite mult2_recompose; apply mult_lt; auto with arith.
+
+Theorem comparison1 : q < p.
+replace q with (1 * q); try ring.
+replace p with (1 * p); try ring.
+solve_comparison.
+Qed.
+
+Theorem comparison2 : 2 * p < 3 * q.
+solve_comparison.
+Qed.
+
+Theorem comparison3 : 4 * q < 3 * p.
+solve_comparison.
+Qed.
+Hint Resolve comparison1 comparison2 comparison3: arith.
+
+Theorem comparison4 : 3 * q - 2 * p < q.
+apply plus_lt_reg_l with (2 * p).
+rewrite <- le_plus_minus; try (simple apply lt_le_weak; auto with arith).
+replace (3 * q) with (2 * q + q); try ring.
+apply plus_lt_le_compat; auto.
+repeat rewrite (mult_comm 2); apply mult_lt; auto with arith.
+Qed.
+
+Remark mult_minus_distr_l : forall a b c : nat, a * (b - c) = a * b - a * c.
+intros a b c; repeat rewrite (mult_comm a); apply mult_minus_distr_r.
+Qed.
+
+Remark minus_eq_decompose :
+ forall a b c d : nat, a = b -> c = d -> a - c = b - d.
+intros a b c d H H0; rewrite H; rewrite H0; auto.
+Qed.
+
+Theorem new_equality :
+ (3 * p - 4 * q) * (3 * p - 4 * q) = 2 * ((3 * q - 2 * p) * (3 * q - 2 * p)).
+repeat rewrite sub_square_identity; auto with arith.
+repeat rewrite square_recompose; rewrite mult_minus_distr_l.
+apply minus_eq_decompose; try rewrite hyp_sqrt; ring.
+Qed.
+End sqrt2_decrease.
+Hint Resolve lt_le_weak comparison2: sqrt.
+
+Theorem sqrt2_not_rational :
+ forall p q : nat, q <> 0 -> p * p = 2 * (q * q) -> False.
+intros p q; generalize p; clear p; elim q using (well_founded_ind lt_wf).
+clear q; intros q Hrec p Hneq; generalize (neq_O_lt _ (sym_not_equal Hneq));
+ intros Hlt_O_q Heq.
+apply (Hrec (3 * q - 2 * p) (comparison4 _ _ Hlt_O_q Heq) (3 * p - 4 * q)).
+apply sym_not_equal; apply lt_neq; apply plus_lt_reg_l with (2 * p);
+ rewrite <- plus_n_O; rewrite <- le_plus_minus; auto with *.
+apply new_equality; auto.
+Qed.