From 4ddbf128362dcb0a0a8abe42348ff20d3d511ab6 Mon Sep 17 00:00:00 2001 From: Michael Albinus Date: Thu, 24 Oct 2013 09:38:45 +0200 Subject: [PATCH] * automated/ert-tests.el (ert-test-skip-unless): New test case. (ert-test-deftest): Adapt test for changed macro expansion. (ert-test-run-tests-interactively): * automated/ert-x-tests.el (ert-test-run-tests-interactively-2): Add a skipping test. * automated/file-notify-tests.el (top): Do not require tramp-sh.el. (file-notify--test-local-enabled): Make it a function. Check also for `file-remote-p' of `temporary-file-directory'. (file-notify--test-remote-enabled-checked): New defvar. (file-notify--test-remote-enabled): Rewrite. Do not use Tramp internal functions. Cache result. (file-notify--deftest-remote, file-notify-test00-availability) (file-notify-test01-add-watch, file-notify-test02-events) (file-notify-test03-autorevert): Add checks with `skip_unless'. (file-notify-test-all): Do not check `file-notify--test-local-enabled'. --- test/ChangeLog | 19 ++ test/automated/ert-tests.el | 76 +++++-- test/automated/ert-x-tests.el | 22 +- test/automated/file-notify-tests.el | 338 ++++++++++++++-------------- 4 files changed, 252 insertions(+), 203 deletions(-) diff --git a/test/ChangeLog b/test/ChangeLog index c392b792142..10acf187967 100644 --- a/test/ChangeLog +++ b/test/ChangeLog @@ -1,3 +1,22 @@ +2013-10-24 Michael Albinus + + * automated/ert-tests.el (ert-test-skip-unless): New test case. + (ert-test-deftest): Adapt test for changed macro expansion. + (ert-test-run-tests-interactively): + * automated/ert-x-tests.el (ert-test-run-tests-interactively-2): + Add a skipping test. + + * automated/file-notify-tests.el (top): Do not require tramp-sh.el. + (file-notify--test-local-enabled): Make it a function. Check also + for `file-remote-p' of `temporary-file-directory'. + (file-notify--test-remote-enabled-checked): New defvar. + (file-notify--test-remote-enabled): Rewrite. Do not use Tramp + internal functions. Cache result. + (file-notify--deftest-remote, file-notify-test00-availability) + (file-notify-test01-add-watch, file-notify-test02-events) + (file-notify-test03-autorevert): Add checks with `skip_unless'. + (file-notify-test-all): Do not check `file-notify--test-local-enabled'. + 2013-10-24 Dmitry Gutov * indent/ruby.rb: Fix syntax error in the latest example. diff --git a/test/automated/ert-tests.el b/test/automated/ert-tests.el index a2be534c25c..cc82893dace 100644 --- a/test/automated/ert-tests.el +++ b/test/automated/ert-tests.el @@ -294,6 +294,20 @@ failed or if there was a problem." "the error signaled was a subtype of the expected type"))))) )) +(ert-deftest ert-test-skip-unless () + ;; Don't skip. + (let ((test (make-ert-test :body (lambda () (skip-unless t))))) + (let ((result (ert-run-test test))) + (should (ert-test-passed-p result)))) + ;; Skip. + (let ((test (make-ert-test :body (lambda () (skip-unless nil))))) + (let ((result (ert-run-test test))) + (should (ert-test-skipped-p result)))) + ;; Skip in case of error. + (let ((test (make-ert-test :body (lambda () (skip-unless (error "Foo")))))) + (let ((result (ert-run-test test))) + (should (ert-test-skipped-p result))))) + (defmacro ert--test-my-list (&rest args) "Don't use this. Instead, call `list' with ARGS, it does the same thing. @@ -332,23 +346,31 @@ This macro is used to test if macroexpansion in `should' works." (ert-deftest ert-test-deftest () (should (equal (macroexpand '(ert-deftest abc () "foo" :tags '(bar))) - '(progn - (ert-set-test 'abc - (make-ert-test :name 'abc - :documentation "foo" - :tags '(bar) - :body (lambda ()))) - (push '(ert-deftest . abc) current-load-list) - 'abc))) + '(progn + (ert-set-test 'abc + (progn + (vector 'cl-struct-ert-test 'abc "foo" + #'(lambda nil) + nil ':passed + '(bar)))) + (setq current-load-list + (cons + '(ert-deftest . abc) + current-load-list)) + 'abc))) (should (equal (macroexpand '(ert-deftest def () :expected-result ':passed)) - '(progn - (ert-set-test 'def - (make-ert-test :name 'def - :expected-result-type ':passed - :body (lambda ()))) - (push '(ert-deftest . def) current-load-list) - 'def))) + '(progn + (ert-set-test 'def + (progn + (vector 'cl-struct-ert-test 'def nil + #'(lambda nil) + nil ':passed 'nil))) + (setq current-load-list + (cons + '(ert-deftest . def) + current-load-list)) + 'def))) ;; :documentation keyword is forbidden (should-error (macroexpand '(ert-deftest ghi () :documentation "foo")))) @@ -543,7 +565,10 @@ This macro is used to test if macroexpansion in `should' works." :body (lambda () (ert-pass)))) (failing-test (make-ert-test :name 'failing-test :body (lambda () (ert-fail - "failure message"))))) + "failure message")))) + (skipped-test (make-ert-test :name 'skipped-test + :body (lambda () (ert-skip + "skip message"))))) (let ((ert-debug-on-error nil)) (let* ((buffer-name (generate-new-buffer-name " *ert-test-run-tests*")) (messages nil) @@ -554,23 +579,26 @@ This macro is used to test if macroexpansion in `should' works." (unwind-protect (let ((case-fold-search nil)) (ert-run-tests-interactively - `(member ,passing-test ,failing-test) buffer-name + `(member ,passing-test ,failing-test, skipped-test) buffer-name mock-message-fn) (should (equal messages `(,(concat - "Ran 2 tests, 1 results were " - "as expected, 1 unexpected")))) + "Ran 3 tests, 1 results were " + "as expected, 1 unexpected, " + "1 skipped")))) (with-current-buffer buffer-name (goto-char (point-min)) (should (equal (buffer-substring (point-min) (save-excursion - (forward-line 4) + (forward-line 5) (point))) (concat - "Selector: (member )\n" - "Passed: 1\n" - "Failed: 1 (1 unexpected)\n" - "Total: 2/2\n"))))) + "Selector: (member " + ")\n" + "Passed: 1\n" + "Failed: 1 (1 unexpected)\n" + "Skipped: 1\n" + "Total: 3/3\n"))))) (when (get-buffer buffer-name) (kill-buffer buffer-name)))))))) diff --git a/test/automated/ert-x-tests.el b/test/automated/ert-x-tests.el index dc67fe34833..0a657fd4a84 100644 --- a/test/automated/ert-x-tests.el +++ b/test/automated/ert-x-tests.el @@ -111,6 +111,9 @@ 'a 'b)) (ert-fail "failure message"))))) + (skipped-test (make-ert-test :name 'skipped-test + :body (lambda () (ert-skip + "skip message")))) (ert-debug-on-error nil) (buffer-name (generate-new-buffer-name "*ert-test-run-tests*")) (messages nil) @@ -119,10 +122,12 @@ (push (apply #'format format-string args) messages)))) (cl-flet ((expected-string (with-font-lock-p) (ert-propertized-string - "Selector: (member )\n" - "Passed: 1\n" - "Failed: 1 (1 unexpected)\n" - "Total: 2/2\n\n" + "Selector: (member " + ")\n" + "Passed: 1\n" + "Failed: 1 (1 unexpected)\n" + "Skipped: 1\n" + "Total: 3/3\n\n" "Started at:\n" "Finished.\n" "Finished at:\n\n" @@ -132,7 +137,7 @@ face ,(if with-font-lock-p 'ert-test-result-unexpected 'button)) - ".F" nil "\n\n" + ".Fs" nil "\n\n" `(category ,(button-category-symbol 'ert--results-expand-collapse-button) button (t) @@ -153,11 +158,12 @@ (unwind-protect (let ((case-fold-search nil)) (ert-run-tests-interactively - `(member ,passing-test ,failing-test) buffer-name + `(member ,passing-test ,failing-test ,skipped-test) buffer-name mock-message-fn) (should (equal messages `(,(concat - "Ran 2 tests, 1 results were " - "as expected, 1 unexpected")))) + "Ran 3 tests, 1 results were " + "as expected, 1 unexpected, " + "1 skipped")))) (with-current-buffer buffer-name (font-lock-mode 0) (should (ert-equal-including-properties diff --git a/test/automated/file-notify-tests.el b/test/automated/file-notify-tests.el index 9f552ee7ab1..627333bffd7 100644 --- a/test/automated/file-notify-tests.el +++ b/test/automated/file-notify-tests.el @@ -43,60 +43,61 @@ (defvar file-notify--test-event nil) (require 'tramp) -(require 'tramp-sh) (setq tramp-verbose 0 tramp-message-show-message nil) (when noninteractive (defalias 'tramp-read-passwd 'ignore)) ;; We do not want to try and fail `file-notify-add-watch'. -(defconst file-notify--test-local-enabled file-notify--library - "Whether local file notification is enabled.") +(defun file-notify--test-local-enabled () + "Whether local file notification is enabled. +This is needed for local `temporary-file-directory' only, in the +remote case we return always `t'." + (or file-notify--library + (not (file-remote-p temporary-file-directory)))) + +(defvar file-notify--test-remote-enabled-checked nil + "Cached result of `file-notify--test-remote-enabled'. +If the function did run, the value is a cons cell, the `cdr' +being the result.") -;; We need also a check on the remote side, w/o adding a file monitor. (defun file-notify--test-remote-enabled () "Whether remote file notification is enabled." - (ignore-errors - (and (file-remote-p file-notify-test-remote-temporary-file-directory) - (file-directory-p file-notify-test-remote-temporary-file-directory) - (file-writable-p file-notify-test-remote-temporary-file-directory) - ;; Extracted from tramp-sh-handle-file-notify-add-watch. - ;; Even though the "remote" system is just ssh@localhost, - ;; the PATH might not be the same as the "local" PATH. - ;; Eg this seems to be the case on hydra.nixos.org. - ;; Without this, tests fail with: - ;; "No file notification program found on /ssh:localhost:" - ;; Try to fix PATH instead? - (with-parsed-tramp-file-name - file-notify-test-remote-temporary-file-directory nil - (or (tramp-get-remote-gvfs-monitor-dir v) - (tramp-get-remote-inotifywait v)))))) + (unless (consp file-notify--test-remote-enabled-checked) + (let (desc) + (unwind-protect + (ignore-errors + (and + (file-remote-p file-notify-test-remote-temporary-file-directory) + (file-directory-p file-notify-test-remote-temporary-file-directory) + (file-writable-p file-notify-test-remote-temporary-file-directory) + (setq desc + (file-notify-add-watch + file-notify-test-remote-temporary-file-directory + '(change) 'ignore)))) + ;; Unwind forms. + (setq file-notify--test-remote-enabled-checked (cons t desc)) + (when desc (file-notify-rm-watch desc))))) + ;; Return result. + (cdr file-notify--test-remote-enabled-checked)) (defmacro file-notify--deftest-remote (test docstring) "Define ert `TEST-remote' for remote files." - `(when (and (file-notify--test-remote-enabled) (ert-get-test ',test)) - ;; Define the test. - (ert-deftest ,(intern (concat (symbol-name test) "-remote")) () - ,docstring - (let* ((temporary-file-directory - file-notify-test-remote-temporary-file-directory) - (ert-test (ert-get-test ',test)) - (most-recent-result (ert-test-most-recent-result ert-test)) - result) - (unwind-protect - (progn - (setq result - (condition-case err - (ert-run-test ert-test) - ((error quit) - (ert-fail err)))) - (when (ert-test-failed-p result) - (ert-fail - (cadr (ert-test-result-with-condition-condition result))))) - ;; Reset status of TEST. - (setf (ert-test-most-recent-result ert-test) most-recent-result)))))) + `(ert-deftest ,(intern (concat (symbol-name test) "-remote")) () + ,docstring + (let* ((temporary-file-directory + file-notify-test-remote-temporary-file-directory) + (ert-test (ert-get-test ',test))) + (skip-unless (file-notify--test-remote-enabled)) + ;; The local test could have passed, skipped, or quit. All of + ;; these results should not prevent us to run the remote test. + ;; That's why we skip only for failed local tests. + (skip-unless + (not (ert-test-failed-p (ert-test-most-recent-result ert-test)))) + (funcall (ert-test-body ert-test))))) (ert-deftest file-notify-test00-availability () "Test availability of `file-notify'." + (skip-unless (file-notify--test-local-enabled)) (let (desc) ;; Check, that different valid parameters are accepted. (should (setq desc (file-notify-add-watch @@ -106,42 +107,40 @@ (file-notify--deftest-remote file-notify-test00-availability "Test availability of `file-notify' for remote files.") -(when file-notify--test-local-enabled +(ert-deftest file-notify-test01-add-watch () + "Check `file-notify-add-watch'." + (skip-unless (file-notify--test-local-enabled)) + (let (desc) + ;; Check, that different valid parameters are accepted. + (should (setq desc (file-notify-add-watch + temporary-file-directory '(change) 'ignore))) + (file-notify-rm-watch desc) + (should (setq desc (file-notify-add-watch + temporary-file-directory + '(attribute-change) 'ignore))) + (file-notify-rm-watch desc) + (should (setq desc (file-notify-add-watch + temporary-file-directory + '(change attribute-change) 'ignore))) + (file-notify-rm-watch desc) - (ert-deftest file-notify-test01-add-watch () - "Check `file-notify-add-watch'." - (let (desc) - ;; Check, that different valid parameters are accepted. - (should (setq desc (file-notify-add-watch - temporary-file-directory '(change) 'ignore))) - (file-notify-rm-watch desc) - (should (setq desc (file-notify-add-watch - temporary-file-directory - '(attribute-change) 'ignore))) - (file-notify-rm-watch desc) - (should (setq desc (file-notify-add-watch - temporary-file-directory - '(change attribute-change) 'ignore))) - (file-notify-rm-watch desc) + ;; Check error handling. + (should-error (file-notify-add-watch 1 2 3 4) + :type 'wrong-number-of-arguments) + (should + (equal (should-error (file-notify-add-watch 1 2 3)) + '(wrong-type-argument 1))) + (should + (equal (should-error (file-notify-add-watch + temporary-file-directory 2 3)) + '(wrong-type-argument 2))) + (should + (equal (should-error (file-notify-add-watch + temporary-file-directory '(change) 3)) + '(wrong-type-argument 3))))) - ;; Check error handling. - (should-error (file-notify-add-watch 1 2 3 4) - :type 'wrong-number-of-arguments) - (should - (equal (should-error (file-notify-add-watch 1 2 3)) - '(wrong-type-argument 1))) - (should - (equal (should-error (file-notify-add-watch - temporary-file-directory 2 3)) - '(wrong-type-argument 2))) - (should - (equal (should-error (file-notify-add-watch - temporary-file-directory '(change) 3)) - '(wrong-type-argument 3))))) - - (file-notify--deftest-remote file-notify-test01-add-watch - "Check `file-notify-add-watch' for remote files.") - ) ;; file-notify--test-local-enabled +(file-notify--deftest-remote file-notify-test01-add-watch + "Check `file-notify-add-watch' for remote files.") (defun file-notify--test-event-test () "Ert test function to be called by `file-notify--test-event-handler'. @@ -172,117 +171,114 @@ Save the result in `file-notify--test-results', for later analysis." (expand-file-name (make-temp-name "file-notify-test") temporary-file-directory)) -(when file-notify--test-local-enabled +(ert-deftest file-notify-test02-events () + "Check file creation/removal notifications." + (skip-unless (file-notify--test-local-enabled)) + (let (desc) + (unwind-protect + (progn + (setq file-notify--test-results nil + file-notify--test-tmpfile (file-notify--test-make-temp-name) + file-notify--test-tmpfile1 (file-notify--test-make-temp-name) + desc + (file-notify-add-watch + file-notify--test-tmpfile + '(change) 'file-notify--test-event-handler)) + + ;; Check creation and removal. + (write-region "any text" nil file-notify--test-tmpfile) + (delete-file file-notify--test-tmpfile) + + ;; Check copy and rename. + (write-region "any text" nil file-notify--test-tmpfile) + (copy-file file-notify--test-tmpfile file-notify--test-tmpfile1) + (delete-file file-notify--test-tmpfile) + (delete-file file-notify--test-tmpfile1) + + (write-region "any text" nil file-notify--test-tmpfile) + (rename-file file-notify--test-tmpfile file-notify--test-tmpfile1) + (delete-file file-notify--test-tmpfile1)) + + ;; Wait for events, and exit. + (sit-for 5 'nodisplay) + (file-notify-rm-watch desc) + (ignore-errors (delete-file file-notify--test-tmpfile)) + (ignore-errors (delete-file file-notify--test-tmpfile1)))) - (ert-deftest file-notify-test02-events () - "Check file creation/removal notifications." - (let (desc) - (unwind-protect - (progn - (setq file-notify--test-results nil - file-notify--test-tmpfile (file-notify--test-make-temp-name) - file-notify--test-tmpfile1 (file-notify--test-make-temp-name) - desc - (file-notify-add-watch - file-notify--test-tmpfile - '(change) 'file-notify--test-event-handler)) - - ;; Check creation and removal. - (write-region "any text" nil file-notify--test-tmpfile) - (delete-file file-notify--test-tmpfile) - - ;; Check copy and rename. - (write-region "any text" nil file-notify--test-tmpfile) - (copy-file file-notify--test-tmpfile file-notify--test-tmpfile1) - (delete-file file-notify--test-tmpfile) - (delete-file file-notify--test-tmpfile1) - - (write-region "any text" nil file-notify--test-tmpfile) - (rename-file file-notify--test-tmpfile file-notify--test-tmpfile1) - (delete-file file-notify--test-tmpfile1)) - - ;; Wait for events, and exit. - (sit-for 5 'nodisplay) - (file-notify-rm-watch desc) - (ignore-errors (delete-file file-notify--test-tmpfile)) - (ignore-errors (delete-file file-notify--test-tmpfile1)))) - - (dolist (result file-notify--test-results) - ;(message "%s" (ert-test-result-messages result)) - (when (ert-test-failed-p result) - (ert-fail (cadr (ert-test-result-with-condition-condition result)))))) - - (file-notify--deftest-remote file-notify-test02-events - "Check file creation/removal notifications for remote files.") - ) ;; file-notify--test-local-enabled + (dolist (result file-notify--test-results) + ;(message "%s" (ert-test-result-messages result)) + (when (ert-test-failed-p result) + (ert-fail (cadr (ert-test-result-with-condition-condition result)))))) + +(file-notify--deftest-remote file-notify-test02-events + "Check file creation/removal notifications for remote files.") ;; autorevert runs only in interactive mode. (defvar auto-revert-remote-files) (setq auto-revert-remote-files t) (require 'autorevert) -(when (and file-notify--test-local-enabled (null noninteractive)) - (ert-deftest file-notify-test03-autorevert () - "Check autorevert via file notification. +(ert-deftest file-notify-test03-autorevert () + "Check autorevert via file notification. This test is skipped in batch mode." - ;; `auto-revert-buffers' runs every 5". And we must wait, until - ;; the file has been reverted. - (let ((timeout 10) - buf) - (unwind-protect - (progn - (setq file-notify--test-tmpfile (file-notify--test-make-temp-name)) - - (write-region "any text" nil file-notify--test-tmpfile) - (setq buf (find-file-noselect file-notify--test-tmpfile)) - (with-current-buffer buf - (should (string-equal (buffer-string) "any text")) - (auto-revert-mode 1) - - ;; `auto-revert-buffers' runs every 5". + (skip-unless (file-notify--test-local-enabled)) + (skip-unless (not noninteractive)) + ;; `auto-revert-buffers' runs every 5". And we must wait, until the + ;; file has been reverted. + (let ((timeout 10) + buf) + (unwind-protect + (progn + (setq file-notify--test-tmpfile (file-notify--test-make-temp-name)) + + (write-region "any text" nil file-notify--test-tmpfile) + (setq buf (find-file-noselect file-notify--test-tmpfile)) + (with-current-buffer buf + (should (string-equal (buffer-string) "any text")) + (auto-revert-mode 1) + + ;; `auto-revert-buffers' runs every 5". + (with-timeout (timeout (ignore)) + (while (null auto-revert-notify-watch-descriptor) + (sit-for 0.1 'nodisplay))) + + ;; Check, that file notification has been used. + (should auto-revert-mode) + (should auto-revert-use-notify) + (should auto-revert-notify-watch-descriptor) + + ;; Modify file. We wait for a second, in order to + ;; have another timestamp. + (sit-for 1) + (shell-command + (format "echo -n 'another text' >%s" + (or (file-remote-p file-notify--test-tmpfile 'localname) + file-notify--test-tmpfile))) + + ;; Check, that the buffer has been reverted. + (with-current-buffer (get-buffer-create "*Messages*") (with-timeout (timeout (ignore)) - (while (null auto-revert-notify-watch-descriptor) - (sit-for 0.1 'nodisplay))) - - ;; Check, that file notification has been used. - (should auto-revert-mode) - (should auto-revert-use-notify) - (should auto-revert-notify-watch-descriptor) - - ;; Modify file. We wait for a second, in order to - ;; have another timestamp. - (sit-for 1) - (shell-command - (format "echo -n 'another text' >%s" - (or (file-remote-p file-notify--test-tmpfile 'localname) - file-notify--test-tmpfile))) - - ;; Check, that the buffer has been reverted. - (with-current-buffer (get-buffer-create "*Messages*") - (with-timeout (timeout (ignore)) - (while - (null (string-match - (format "Reverting buffer `%s'." (buffer-name buf)) - (buffer-string))) - (sit-for 0.1 'nodisplay)))) - (should (string-equal (buffer-string) "another text")))) - - ;; Exit. - (ignore-errors (kill-buffer buf)) - (ignore-errors (delete-file file-notify--test-tmpfile))))) - - (file-notify--deftest-remote file-notify-test03-autorevert - "Check autorevert via file notification for remote files. + (while + (null (string-match + (format "Reverting buffer `%s'." (buffer-name buf)) + (buffer-string))) + (sit-for 0.1 'nodisplay)))) + (should (string-equal (buffer-string) "another text")))) + + ;; Exit. + (ignore-errors (kill-buffer buf)) + (ignore-errors (delete-file file-notify--test-tmpfile))))) + +(file-notify--deftest-remote file-notify-test03-autorevert + "Check autorevert via file notification for remote files. This test is skipped in batch mode.") - ) ;; (and file-notify--test-local-enabled (null noninteractive)) (defun file-notify-test-all (&optional interactive) "Run all tests for \\[file-notify]." (interactive "p") - (when file-notify--test-local-enabled - (if interactive - (ert-run-tests-interactively "^file-notify-") - (ert-run-tests-batch "^file-notify-")))) + (if interactive + (ert-run-tests-interactively "^file-notify-") + (ert-run-tests-batch "^file-notify-"))) (provide 'file-notify-tests) ;;; file-notify-tests.el ends here -- 2.39.2