2015-09-10 15:18:15 +00:00
|
|
|
;;; file-notify-tests.el --- Tests of file notifications -*- lexical-binding: t; -*-
|
2013-07-04 09:43:17 +00:00
|
|
|
|
2015-01-01 22:26:41 +00:00
|
|
|
;; Copyright (C) 2013-2015 Free Software Foundation, Inc.
|
2013-07-04 09:43:17 +00:00
|
|
|
|
|
|
|
;; Author: Michael Albinus <michael.albinus@gmx.de>
|
|
|
|
|
|
|
|
;; This program is free software: you can redistribute it and/or
|
|
|
|
;; modify it under the terms of the GNU General Public License as
|
|
|
|
;; published by the Free Software Foundation, either version 3 of the
|
|
|
|
;; License, or (at your option) any later version.
|
|
|
|
;;
|
|
|
|
;; This program is distributed in the hope that it will be useful, but
|
|
|
|
;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
;; General Public License for more details.
|
|
|
|
;;
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
|
|
;; along with this program. If not, see `http://www.gnu.org/licenses/'.
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
2014-04-24 08:21:58 +00:00
|
|
|
;; Some of the tests require access to a remote host files. Since
|
|
|
|
;; this could be problematic, a mock-up connection method "mock" is
|
|
|
|
;; used. Emulating a remote connection, it simply calls "sh -i".
|
2014-04-25 10:35:01 +00:00
|
|
|
;; Tramp's file name handlers still run, so this test is sufficient
|
2014-04-24 08:21:58 +00:00
|
|
|
;; except for connection establishing.
|
|
|
|
|
|
|
|
;; If you want to test a real Tramp connection, set
|
|
|
|
;; $REMOTE_TEMPORARY_FILE_DIRECTORY to a suitable value in order to
|
|
|
|
;; overwrite the default value. If you want to skip tests accessing a
|
|
|
|
;; remote host, set this environment variable to "/dev/null" or
|
|
|
|
;; whatever is appropriate on your system.
|
2013-07-05 14:06:14 +00:00
|
|
|
|
2013-11-27 14:23:32 +00:00
|
|
|
;; A whole test run can be performed calling the command `file-notify-test-all'.
|
2013-07-04 09:43:17 +00:00
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
|
|
|
(require 'ert)
|
|
|
|
(require 'filenotify)
|
2014-04-24 08:21:58 +00:00
|
|
|
(require 'tramp)
|
2013-07-04 09:43:17 +00:00
|
|
|
|
2013-07-05 14:06:14 +00:00
|
|
|
;; There is no default value on w32 systems, which could work out of the box.
|
|
|
|
(defconst file-notify-test-remote-temporary-file-directory
|
2013-11-27 14:23:32 +00:00
|
|
|
(cond
|
|
|
|
((getenv "REMOTE_TEMPORARY_FILE_DIRECTORY"))
|
|
|
|
((eq system-type 'windows-nt) null-device)
|
2014-04-24 08:21:58 +00:00
|
|
|
(t (add-to-list
|
|
|
|
'tramp-methods
|
|
|
|
'("mock"
|
|
|
|
(tramp-login-program "sh")
|
|
|
|
(tramp-login-args (("-i")))
|
|
|
|
(tramp-remote-shell "/bin/sh")
|
|
|
|
(tramp-remote-shell-args ("-c"))
|
|
|
|
(tramp-connection-timeout 10)))
|
|
|
|
(format "/mock::%s" temporary-file-directory)))
|
2013-07-05 14:06:14 +00:00
|
|
|
"Temporary directory for Tramp tests.")
|
|
|
|
|
|
|
|
(defvar file-notify--test-tmpfile nil)
|
|
|
|
(defvar file-notify--test-tmpfile1 nil)
|
2015-06-02 21:47:17 +00:00
|
|
|
(defvar file-notify--test-desc nil)
|
2013-07-05 14:06:14 +00:00
|
|
|
(defvar file-notify--test-results nil)
|
|
|
|
(defvar file-notify--test-event nil)
|
2015-09-09 19:46:40 +00:00
|
|
|
(defvar file-notify--test-events nil)
|
2015-10-26 15:46:48 +00:00
|
|
|
(defvar file-notify--test-expected-events nil)
|
|
|
|
|
2015-09-20 16:44:36 +00:00
|
|
|
(defun file-notify--test-timeout ()
|
2015-10-13 07:44:48 +00:00
|
|
|
"Timeout to wait for arriving events, in seconds."
|
2015-10-23 11:14:09 +00:00
|
|
|
(if (file-remote-p temporary-file-directory) 6 3))
|
2013-07-05 14:06:14 +00:00
|
|
|
|
2015-09-10 15:18:15 +00:00
|
|
|
(defun file-notify--test-cleanup ()
|
|
|
|
"Cleanup after a test."
|
|
|
|
(file-notify-rm-watch file-notify--test-desc)
|
|
|
|
|
|
|
|
(when (and file-notify--test-tmpfile
|
|
|
|
(file-exists-p file-notify--test-tmpfile))
|
2015-10-26 15:46:48 +00:00
|
|
|
(if (file-directory-p file-notify--test-tmpfile)
|
2015-09-20 16:44:36 +00:00
|
|
|
(delete-directory file-notify--test-tmpfile 'recursive)
|
2015-09-14 07:52:31 +00:00
|
|
|
(delete-file file-notify--test-tmpfile)))
|
2015-09-10 15:18:15 +00:00
|
|
|
(when (and file-notify--test-tmpfile1
|
|
|
|
(file-exists-p file-notify--test-tmpfile1))
|
2015-10-26 15:46:48 +00:00
|
|
|
(if (file-directory-p file-notify--test-tmpfile1)
|
2015-09-20 16:44:36 +00:00
|
|
|
(delete-directory file-notify--test-tmpfile1 'recursive)
|
2015-09-14 07:52:31 +00:00
|
|
|
(delete-file file-notify--test-tmpfile1)))
|
2015-09-20 16:44:36 +00:00
|
|
|
(when (file-remote-p temporary-file-directory)
|
|
|
|
(tramp-cleanup-connection
|
|
|
|
(tramp-dissect-file-name temporary-file-directory) nil 'keep-password))
|
2015-09-10 15:18:15 +00:00
|
|
|
|
2015-10-25 13:18:17 +00:00
|
|
|
(setq file-notify--test-tmpfile nil
|
|
|
|
file-notify--test-tmpfile1 nil
|
|
|
|
file-notify--test-desc nil
|
|
|
|
file-notify--test-results nil
|
2015-10-26 15:46:48 +00:00
|
|
|
file-notify--test-events nil
|
|
|
|
file-notify--test-expected-events nil)
|
2015-09-10 15:18:15 +00:00
|
|
|
(when file-notify--test-event
|
|
|
|
(error "file-notify--test-event should not be set but bound dynamically")))
|
|
|
|
|
2014-04-25 10:35:01 +00:00
|
|
|
(setq password-cache-expiry nil
|
|
|
|
tramp-verbose 0
|
2013-07-05 14:06:14 +00:00
|
|
|
tramp-message-show-message nil)
|
2013-11-27 14:23:32 +00:00
|
|
|
|
2013-11-08 09:31:15 +00:00
|
|
|
;; This shall happen on hydra only.
|
|
|
|
(when (getenv "NIX_STORE")
|
|
|
|
(add-to-list 'tramp-remote-path 'tramp-own-remote-path))
|
2013-07-05 14:06:14 +00:00
|
|
|
|
2013-07-24 13:56:19 +00:00
|
|
|
;; We do not want to try and fail `file-notify-add-watch'.
|
2013-10-24 07:38:45 +00:00
|
|
|
(defun file-notify--test-local-enabled ()
|
|
|
|
"Whether local file notification is enabled.
|
|
|
|
This is needed for local `temporary-file-directory' only, in the
|
2015-05-21 17:04:45 +00:00
|
|
|
remote case we return always t."
|
2013-10-24 07:38:45 +00:00
|
|
|
(or file-notify--library
|
2014-01-21 13:31:39 +00:00
|
|
|
(file-remote-p temporary-file-directory)))
|
2013-10-24 07:38:45 +00:00
|
|
|
|
|
|
|
(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.")
|
2013-07-24 13:56:19 +00:00
|
|
|
|
|
|
|
(defun file-notify--test-remote-enabled ()
|
|
|
|
"Whether remote file notification is enabled."
|
2013-10-24 07:38:45 +00:00
|
|
|
(unless (consp file-notify--test-remote-enabled-checked)
|
2015-06-03 18:03:42 +00:00
|
|
|
(let (desc)
|
|
|
|
(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))))
|
|
|
|
(setq file-notify--test-remote-enabled-checked (cons t desc))
|
|
|
|
(when desc (file-notify-rm-watch desc))))
|
2013-10-24 07:38:45 +00:00
|
|
|
;; Return result.
|
|
|
|
(cdr file-notify--test-remote-enabled-checked))
|
2013-07-24 13:56:19 +00:00
|
|
|
|
2013-07-05 14:06:14 +00:00
|
|
|
(defmacro file-notify--deftest-remote (test docstring)
|
|
|
|
"Define ert `TEST-remote' for remote files."
|
2015-06-03 12:07:06 +00:00
|
|
|
(declare (indent 1))
|
2013-10-24 07:38:45 +00:00
|
|
|
`(ert-deftest ,(intern (concat (symbol-name test) "-remote")) ()
|
|
|
|
,docstring
|
2015-06-03 18:03:42 +00:00
|
|
|
(let* ((temporary-file-directory
|
|
|
|
file-notify-test-remote-temporary-file-directory)
|
|
|
|
(ert-test (ert-get-test ',test)))
|
|
|
|
(skip-unless (file-notify--test-remote-enabled))
|
|
|
|
(tramp-cleanup-connection
|
|
|
|
(tramp-dissect-file-name temporary-file-directory) nil 'keep-password)
|
|
|
|
(funcall (ert-test-body ert-test)))))
|
2013-07-05 14:06:14 +00:00
|
|
|
|
|
|
|
(ert-deftest file-notify-test00-availability ()
|
|
|
|
"Test availability of `file-notify'."
|
2013-10-24 07:38:45 +00:00
|
|
|
(skip-unless (file-notify--test-local-enabled))
|
2015-09-10 18:01:33 +00:00
|
|
|
;; Report the native library which has been used.
|
2015-09-12 08:37:32 +00:00
|
|
|
(if (null (file-remote-p temporary-file-directory))
|
|
|
|
(message "Local library: `%s'" file-notify--library)
|
|
|
|
(message "Remote command: `%s'"
|
|
|
|
(replace-regexp-in-string
|
|
|
|
"<[[:digit:]]+>\\'" ""
|
|
|
|
(process-name (cdr file-notify--test-remote-enabled-checked)))))
|
2015-06-02 21:47:17 +00:00
|
|
|
(should
|
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch temporary-file-directory '(change) 'ignore)))
|
2015-09-20 16:44:36 +00:00
|
|
|
|
|
|
|
;; Cleanup.
|
2015-09-10 15:18:15 +00:00
|
|
|
(file-notify--test-cleanup))
|
2013-07-24 13:56:19 +00:00
|
|
|
|
|
|
|
(file-notify--deftest-remote file-notify-test00-availability
|
|
|
|
"Test availability of `file-notify' for remote files.")
|
2013-07-04 09:43:17 +00:00
|
|
|
|
2013-10-24 07:38:45 +00:00
|
|
|
(ert-deftest file-notify-test01-add-watch ()
|
|
|
|
"Check `file-notify-add-watch'."
|
|
|
|
(skip-unless (file-notify--test-local-enabled))
|
2015-10-25 13:18:17 +00:00
|
|
|
|
|
|
|
(setq file-notify--test-tmpfile (file-notify--test-make-temp-name)
|
|
|
|
file-notify--test-tmpfile1
|
|
|
|
(format "%s/%s" file-notify--test-tmpfile (md5 (current-time-string))))
|
|
|
|
|
2015-06-02 21:47:17 +00:00
|
|
|
;; Check, that different valid parameters are accepted.
|
|
|
|
(should
|
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch temporary-file-directory '(change) 'ignore)))
|
|
|
|
(file-notify-rm-watch file-notify--test-desc)
|
|
|
|
(should
|
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch
|
|
|
|
temporary-file-directory '(attribute-change) 'ignore)))
|
|
|
|
(file-notify-rm-watch file-notify--test-desc)
|
|
|
|
(should
|
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch
|
|
|
|
temporary-file-directory '(change attribute-change) 'ignore)))
|
|
|
|
(file-notify-rm-watch file-notify--test-desc)
|
2015-10-25 13:18:17 +00:00
|
|
|
;; The file does not need to exist, just the upper directory.
|
|
|
|
(should
|
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile '(change attribute-change) 'ignore)))
|
|
|
|
(file-notify-rm-watch file-notify--test-desc)
|
2015-06-02 21:47:17 +00:00
|
|
|
|
|
|
|
;; 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))
|
2015-09-10 15:18:15 +00:00
|
|
|
'(wrong-type-argument 3)))
|
2015-10-25 13:18:17 +00:00
|
|
|
;; The upper directory of a file must exist.
|
|
|
|
(should
|
|
|
|
(equal (should-error
|
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile1 '(change attribute-change) 'ignore))
|
|
|
|
`(file-notify-error
|
|
|
|
"Directory does not exist" ,file-notify--test-tmpfile)))
|
2015-09-10 15:18:15 +00:00
|
|
|
|
2015-09-20 16:44:36 +00:00
|
|
|
;; Cleanup.
|
2015-09-10 15:18:15 +00:00
|
|
|
(file-notify--test-cleanup))
|
2013-07-09 07:52:25 +00:00
|
|
|
|
2013-10-24 07:38:45 +00:00
|
|
|
(file-notify--deftest-remote file-notify-test01-add-watch
|
|
|
|
"Check `file-notify-add-watch' for remote files.")
|
2013-07-04 09:43:17 +00:00
|
|
|
|
2013-07-05 14:06:14 +00:00
|
|
|
(defun file-notify--test-event-test ()
|
|
|
|
"Ert test function to be called by `file-notify--test-event-handler'.
|
|
|
|
We cannot pass arguments, so we assume that `file-notify--test-event'
|
2013-07-04 09:43:17 +00:00
|
|
|
is bound somewhere."
|
2015-06-02 21:47:17 +00:00
|
|
|
;; Check the descriptor.
|
|
|
|
(should (equal (car file-notify--test-event) file-notify--test-desc))
|
2013-07-04 09:43:17 +00:00
|
|
|
;; Check the file name.
|
|
|
|
(should
|
2015-10-26 15:46:48 +00:00
|
|
|
(or (string-equal (file-notify--event-file-name file-notify--test-event)
|
|
|
|
file-notify--test-tmpfile)
|
|
|
|
(string-equal (directory-file-name
|
|
|
|
(file-name-directory
|
|
|
|
(file-notify--event-file-name file-notify--test-event)))
|
|
|
|
file-notify--test-tmpfile)))
|
2013-07-04 09:43:17 +00:00
|
|
|
;; Check the second file name if exists.
|
2013-07-05 14:06:14 +00:00
|
|
|
(when (eq (nth 1 file-notify--test-event) 'renamed)
|
2013-07-04 09:43:17 +00:00
|
|
|
(should
|
|
|
|
(string-equal
|
2013-07-05 14:06:14 +00:00
|
|
|
(file-notify--event-file1-name file-notify--test-event)
|
|
|
|
file-notify--test-tmpfile1))))
|
|
|
|
|
2015-09-10 15:18:15 +00:00
|
|
|
(defun file-notify--test-event-handler (event)
|
2013-07-05 14:06:14 +00:00
|
|
|
"Run a test over FILE-NOTIFY--TEST-EVENT.
|
2015-09-20 16:44:36 +00:00
|
|
|
For later analysis, append the test result to `file-notify--test-results'
|
|
|
|
and the event to `file-notify--test-events'."
|
2015-09-10 15:18:15 +00:00
|
|
|
(let* ((file-notify--test-event event)
|
2015-09-20 16:44:36 +00:00
|
|
|
(result
|
|
|
|
(ert-run-test (make-ert-test :body 'file-notify--test-event-test))))
|
2015-10-26 15:46:48 +00:00
|
|
|
;; Do not add temporary files, this would confuse the checks.
|
|
|
|
(unless (string-match
|
|
|
|
(regexp-quote ".#")
|
|
|
|
(file-notify--event-file-name file-notify--test-event))
|
|
|
|
;;(message "file-notify--test-event-handler %S" file-notify--test-event)
|
|
|
|
(setq file-notify--test-events
|
|
|
|
(append file-notify--test-events `(,file-notify--test-event))
|
|
|
|
file-notify--test-results
|
|
|
|
(append file-notify--test-results `(,result))))))
|
2013-07-05 14:06:14 +00:00
|
|
|
|
|
|
|
(defun file-notify--test-make-temp-name ()
|
2013-07-04 09:43:17 +00:00
|
|
|
"Create a temporary file name for test."
|
|
|
|
(expand-file-name
|
|
|
|
(make-temp-name "file-notify-test") temporary-file-directory))
|
|
|
|
|
2014-01-21 13:31:39 +00:00
|
|
|
(defmacro file-notify--wait-for-events (timeout until)
|
2015-09-09 19:46:40 +00:00
|
|
|
"Wait for and return file notification events until form UNTIL is true.
|
2014-01-27 19:10:02 +00:00
|
|
|
TIMEOUT is the maximum time to wait for, in seconds."
|
2014-01-21 13:31:39 +00:00
|
|
|
`(with-timeout (,timeout (ignore))
|
|
|
|
(while (null ,until)
|
2014-02-04 11:41:20 +00:00
|
|
|
(read-event nil nil 0.1))))
|
2014-01-21 13:31:39 +00:00
|
|
|
|
2015-09-21 13:07:06 +00:00
|
|
|
(defmacro file-notify--test-with-events (timeout events &rest body)
|
|
|
|
"Run BODY collecting events and then compare with EVENTS.
|
2015-09-10 19:11:18 +00:00
|
|
|
Don't wait longer than TIMEOUT seconds for the events to be delivered."
|
2015-09-21 13:07:06 +00:00
|
|
|
(declare (indent 2))
|
2015-09-10 15:18:15 +00:00
|
|
|
(let ((outer (make-symbol "outer")))
|
|
|
|
`(let ((,outer file-notify--test-events))
|
2015-10-26 15:46:48 +00:00
|
|
|
(setq file-notify--test-expected-events
|
|
|
|
(append file-notify--test-expected-events ,events))
|
2015-09-20 16:44:36 +00:00
|
|
|
(let (file-notify--test-events)
|
2015-09-10 15:18:15 +00:00
|
|
|
,@body
|
|
|
|
(file-notify--wait-for-events
|
2015-09-21 13:07:06 +00:00
|
|
|
,timeout (= (length ,events) (length file-notify--test-events)))
|
|
|
|
(should (equal ,events (mapcar #'cadr file-notify--test-events)))
|
2015-09-10 15:18:15 +00:00
|
|
|
(setq ,outer (append ,outer file-notify--test-events)))
|
|
|
|
(setq file-notify--test-events ,outer))))
|
|
|
|
|
2013-10-24 07:38:45 +00:00
|
|
|
(ert-deftest file-notify-test02-events ()
|
2015-09-12 08:37:32 +00:00
|
|
|
"Check file creation/change/removal notifications."
|
2013-10-24 07:38:45 +00:00
|
|
|
(skip-unless (file-notify--test-local-enabled))
|
2015-10-26 15:46:48 +00:00
|
|
|
|
|
|
|
(setq file-notify--test-tmpfile (file-notify--test-make-temp-name)
|
|
|
|
file-notify--test-tmpfile1 (file-notify--test-make-temp-name))
|
|
|
|
|
2015-06-02 21:47:17 +00:00
|
|
|
(unwind-protect
|
|
|
|
(progn
|
2015-10-26 15:46:48 +00:00
|
|
|
;; Check creation, change and deletion.
|
|
|
|
(setq file-notify--test-desc
|
2015-06-02 21:47:17 +00:00
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile
|
|
|
|
'(change) 'file-notify--test-event-handler))
|
2015-09-10 15:18:15 +00:00
|
|
|
(file-notify--test-with-events
|
2015-10-26 15:46:48 +00:00
|
|
|
(file-notify--test-timeout) '(created changed deleted)
|
2015-09-10 15:18:15 +00:00
|
|
|
(write-region
|
|
|
|
"any text" nil file-notify--test-tmpfile nil 'no-message)
|
|
|
|
(delete-file file-notify--test-tmpfile))
|
2015-10-26 15:46:48 +00:00
|
|
|
;; `file-notify-rm-watch' fires the `stopped' event. Suppress it.
|
|
|
|
(let (file-notify--test-events)
|
|
|
|
(file-notify-rm-watch file-notify--test-desc))
|
|
|
|
|
|
|
|
;; Check creation, change and deletion. There must be a
|
|
|
|
;; `stopped' event when deleting the directory. It doesn't
|
|
|
|
;; work for w32notify.
|
|
|
|
(unless (eq file-notify--library 'w32notify)
|
|
|
|
(make-directory file-notify--test-tmpfile)
|
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile
|
|
|
|
'(change) 'file-notify--test-event-handler))
|
|
|
|
(file-notify--test-with-events
|
|
|
|
(file-notify--test-timeout)
|
|
|
|
;; There are two `deleted' events, for the file and for
|
|
|
|
;; the directory.
|
|
|
|
'(created changed deleted deleted stopped)
|
|
|
|
(write-region
|
|
|
|
"any text" nil (expand-file-name "foo" file-notify--test-tmpfile)
|
|
|
|
nil 'no-message)
|
|
|
|
(delete-directory file-notify--test-tmpfile 'recursive))
|
|
|
|
;; `file-notify-rm-watch' fires the `stopped' event. Suppress it.
|
|
|
|
(let (file-notify--test-events)
|
|
|
|
(file-notify-rm-watch file-notify--test-desc)))
|
2015-09-10 15:18:15 +00:00
|
|
|
|
|
|
|
;; Check copy.
|
2015-09-23 20:25:02 +00:00
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile
|
|
|
|
'(change) 'file-notify--test-event-handler))
|
|
|
|
(should file-notify--test-desc)
|
2015-09-10 15:18:15 +00:00
|
|
|
(file-notify--test-with-events
|
2015-09-21 13:07:06 +00:00
|
|
|
(file-notify--test-timeout)
|
|
|
|
;; w32notify does not distinguish between `changed' and
|
|
|
|
;; `attribute-changed'.
|
|
|
|
(if (eq file-notify--library 'w32notify)
|
2015-10-26 15:46:48 +00:00
|
|
|
'(created changed changed deleted)
|
|
|
|
'(created changed deleted))
|
2015-09-10 15:18:15 +00:00
|
|
|
(write-region
|
|
|
|
"any text" nil file-notify--test-tmpfile nil 'no-message)
|
|
|
|
(copy-file file-notify--test-tmpfile file-notify--test-tmpfile1)
|
2015-09-20 16:44:36 +00:00
|
|
|
;; The next two events shall not be visible.
|
|
|
|
(set-file-modes file-notify--test-tmpfile 000)
|
2015-09-21 13:07:06 +00:00
|
|
|
(read-event nil nil 0.1) ; In order to distinguish the events.
|
2015-09-20 16:44:36 +00:00
|
|
|
(set-file-times file-notify--test-tmpfile '(0 0))
|
2015-09-10 15:18:15 +00:00
|
|
|
(delete-file file-notify--test-tmpfile)
|
|
|
|
(delete-file file-notify--test-tmpfile1))
|
2015-10-26 15:46:48 +00:00
|
|
|
;; `file-notify-rm-watch' fires the `stopped' event. Suppress it.
|
|
|
|
(let (file-notify--test-events)
|
|
|
|
(file-notify-rm-watch file-notify--test-desc))
|
2015-09-10 15:18:15 +00:00
|
|
|
|
|
|
|
;; Check rename.
|
2015-09-23 20:25:02 +00:00
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile
|
|
|
|
'(change) 'file-notify--test-event-handler))
|
|
|
|
(should file-notify--test-desc)
|
2015-09-10 15:18:15 +00:00
|
|
|
(file-notify--test-with-events
|
2015-10-26 15:46:48 +00:00
|
|
|
(file-notify--test-timeout) '(created changed renamed)
|
2015-09-10 15:18:15 +00:00
|
|
|
(write-region
|
|
|
|
"any text" nil file-notify--test-tmpfile nil 'no-message)
|
|
|
|
(rename-file file-notify--test-tmpfile file-notify--test-tmpfile1)
|
|
|
|
;; After the rename, we won't get events anymore.
|
|
|
|
(delete-file file-notify--test-tmpfile1))
|
2015-10-26 15:46:48 +00:00
|
|
|
;; `file-notify-rm-watch' fires the `stopped' event. Suppress it.
|
|
|
|
(let (file-notify--test-events)
|
|
|
|
(file-notify-rm-watch file-notify--test-desc))
|
2015-09-10 15:18:15 +00:00
|
|
|
|
2015-09-21 13:07:06 +00:00
|
|
|
;; Check attribute change. It doesn't work for w32notify.
|
|
|
|
(unless (eq file-notify--library 'w32notify)
|
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile
|
|
|
|
'(attribute-change) 'file-notify--test-event-handler))
|
|
|
|
(file-notify--test-with-events
|
2015-10-23 11:14:09 +00:00
|
|
|
(file-notify--test-timeout)
|
|
|
|
(if (file-remote-p temporary-file-directory)
|
|
|
|
;; In the remote case, `write-region' raises also an
|
|
|
|
;; `attribute-changed' event.
|
|
|
|
'(attribute-changed attribute-changed attribute-changed)
|
|
|
|
'(attribute-changed attribute-changed))
|
|
|
|
;; We must use short delays between the operations.
|
|
|
|
;; Otherwise, not all events arrive us in the remote case.
|
2015-09-21 13:07:06 +00:00
|
|
|
(write-region
|
|
|
|
"any text" nil file-notify--test-tmpfile nil 'no-message)
|
2015-10-25 13:18:17 +00:00
|
|
|
(read-event nil nil 0.1)
|
2015-09-21 13:07:06 +00:00
|
|
|
(set-file-modes file-notify--test-tmpfile 000)
|
2015-10-25 13:18:17 +00:00
|
|
|
(read-event nil nil 0.1)
|
2015-10-23 11:14:09 +00:00
|
|
|
(set-file-times file-notify--test-tmpfile '(0 0))
|
2015-10-25 13:18:17 +00:00
|
|
|
(read-event nil nil 0.1)
|
2015-09-23 20:25:02 +00:00
|
|
|
(delete-file file-notify--test-tmpfile))
|
2015-10-26 15:46:48 +00:00
|
|
|
;; `file-notify-rm-watch' fires the `stopped' event. Suppress it.
|
|
|
|
(let (file-notify--test-events)
|
|
|
|
(file-notify-rm-watch file-notify--test-desc)))
|
2015-09-20 16:44:36 +00:00
|
|
|
|
2015-09-10 15:18:15 +00:00
|
|
|
;; Check the global sequence again just to make sure that
|
|
|
|
;; `file-notify--test-events' has been set correctly.
|
2015-10-26 15:46:48 +00:00
|
|
|
(should (equal (mapcar #'cadr file-notify--test-events)
|
|
|
|
file-notify--test-expected-events))
|
2015-09-10 15:18:15 +00:00
|
|
|
(should file-notify--test-results)
|
|
|
|
(dolist (result file-notify--test-results)
|
|
|
|
(when (ert-test-failed-p result)
|
2015-09-12 08:37:32 +00:00
|
|
|
(ert-fail
|
|
|
|
(cadr (ert-test-result-with-condition-condition result))))))
|
2015-09-20 16:44:36 +00:00
|
|
|
|
|
|
|
;; Cleanup.
|
2015-09-10 15:18:15 +00:00
|
|
|
(file-notify--test-cleanup)))
|
2013-10-24 07:38:45 +00:00
|
|
|
|
|
|
|
(file-notify--deftest-remote file-notify-test02-events
|
2015-09-12 08:37:32 +00:00
|
|
|
"Check file creation/change/removal notifications for remote files.")
|
2013-07-04 09:43:17 +00:00
|
|
|
|
|
|
|
(require 'autorevert)
|
2015-06-02 21:47:17 +00:00
|
|
|
(setq auto-revert-notify-exclude-dir-regexp "nothing-to-be-excluded"
|
|
|
|
auto-revert-remote-files t
|
|
|
|
auto-revert-stop-on-user-input nil)
|
2013-07-04 09:43:17 +00:00
|
|
|
|
2013-10-24 07:38:45 +00:00
|
|
|
(ert-deftest file-notify-test03-autorevert ()
|
2015-09-14 20:15:20 +00:00
|
|
|
"Check autorevert via file notification."
|
2013-10-24 07:38:45 +00:00
|
|
|
(skip-unless (file-notify--test-local-enabled))
|
|
|
|
;; `auto-revert-buffers' runs every 5". And we must wait, until the
|
|
|
|
;; file has been reverted.
|
2015-06-02 21:47:17 +00:00
|
|
|
(let ((timeout (if (file-remote-p temporary-file-directory) 60 10))
|
|
|
|
buf)
|
2013-10-24 07:38:45 +00:00
|
|
|
(unwind-protect
|
|
|
|
(progn
|
|
|
|
(setq file-notify--test-tmpfile (file-notify--test-make-temp-name))
|
|
|
|
|
2013-11-13 15:36:12 +00:00
|
|
|
(write-region
|
|
|
|
"any text" nil file-notify--test-tmpfile nil 'no-message)
|
2013-10-24 07:38:45 +00:00
|
|
|
(setq buf (find-file-noselect file-notify--test-tmpfile))
|
|
|
|
(with-current-buffer buf
|
|
|
|
(should (string-equal (buffer-string) "any text"))
|
2015-06-02 21:47:17 +00:00
|
|
|
;; `buffer-stale--default-function' checks for
|
|
|
|
;; `verify-visited-file-modtime'. We must ensure that it
|
|
|
|
;; returns nil.
|
|
|
|
(sleep-for 1)
|
2013-10-24 07:38:45 +00:00
|
|
|
(auto-revert-mode 1)
|
|
|
|
|
|
|
|
;; `auto-revert-buffers' runs every 5".
|
|
|
|
(with-timeout (timeout (ignore))
|
|
|
|
(while (null auto-revert-notify-watch-descriptor)
|
2014-02-04 11:41:20 +00:00
|
|
|
(sleep-for 1)))
|
2013-10-24 07:38:45 +00:00
|
|
|
|
|
|
|
;; 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.
|
2015-10-27 15:02:26 +00:00
|
|
|
(with-current-buffer (get-buffer-create "*Messages*")
|
|
|
|
(narrow-to-region (point-max) (point-max)))
|
2014-02-04 11:41:20 +00:00
|
|
|
(sleep-for 1)
|
2015-06-02 21:47:17 +00:00
|
|
|
(write-region
|
|
|
|
"another text" nil file-notify--test-tmpfile nil 'no-message)
|
2013-10-24 07:38:45 +00:00
|
|
|
|
|
|
|
;; Check, that the buffer has been reverted.
|
|
|
|
(with-current-buffer (get-buffer-create "*Messages*")
|
2014-01-21 13:31:39 +00:00
|
|
|
(file-notify--wait-for-events
|
|
|
|
timeout
|
2015-09-12 08:37:32 +00:00
|
|
|
(string-match
|
|
|
|
(format-message "Reverting buffer `%s'." (buffer-name buf))
|
|
|
|
(buffer-string))))
|
2015-10-27 15:02:26 +00:00
|
|
|
(should (string-match "another text" (buffer-string)))
|
|
|
|
|
|
|
|
;; Stop file notification. Autorevert shall still work via polling.
|
|
|
|
(file-notify-rm-watch auto-revert-notify-watch-descriptor)
|
|
|
|
(file-notify--wait-for-events
|
|
|
|
timeout (null auto-revert-use-notify))
|
|
|
|
(should-not auto-revert-use-notify)
|
|
|
|
(should-not auto-revert-notify-watch-descriptor)
|
|
|
|
|
|
|
|
;; Modify file. We wait for a second, in order to
|
|
|
|
;; have another timestamp.
|
|
|
|
(with-current-buffer (get-buffer-create "*Messages*")
|
|
|
|
(narrow-to-region (point-max) (point-max)))
|
|
|
|
(sleep-for 2)
|
|
|
|
(write-region
|
|
|
|
"foo bla" nil file-notify--test-tmpfile nil 'no-message)
|
|
|
|
|
|
|
|
;; Check, that the buffer has been reverted.
|
|
|
|
(with-current-buffer (get-buffer-create "*Messages*")
|
|
|
|
(file-notify--wait-for-events
|
|
|
|
timeout
|
|
|
|
(string-match
|
|
|
|
(format-message "Reverting buffer `%s'." (buffer-name buf))
|
|
|
|
(buffer-string))))
|
|
|
|
(should (string-match "foo bla" (buffer-string)))))
|
2013-10-24 07:38:45 +00:00
|
|
|
|
2015-09-20 16:44:36 +00:00
|
|
|
;; Cleanup.
|
2015-10-27 15:02:26 +00:00
|
|
|
(with-current-buffer "*Messages*" (widen))
|
2013-10-24 07:38:45 +00:00
|
|
|
(ignore-errors (kill-buffer buf))
|
2015-09-10 15:18:15 +00:00
|
|
|
(file-notify--test-cleanup))))
|
2013-10-24 07:38:45 +00:00
|
|
|
|
|
|
|
(file-notify--deftest-remote file-notify-test03-autorevert
|
2015-09-14 20:15:20 +00:00
|
|
|
"Check autorevert via file notification for remote files.")
|
2013-07-04 09:43:17 +00:00
|
|
|
|
2015-09-14 06:03:11 +00:00
|
|
|
(ert-deftest file-notify-test04-file-validity ()
|
2015-09-14 20:15:20 +00:00
|
|
|
"Check `file-notify-valid-p' for files."
|
2015-09-14 06:03:11 +00:00
|
|
|
(skip-unless (file-notify--test-local-enabled))
|
2015-09-20 16:44:36 +00:00
|
|
|
|
|
|
|
(unwind-protect
|
|
|
|
(progn
|
2015-10-25 13:18:17 +00:00
|
|
|
(setq file-notify--test-tmpfile (file-notify--test-make-temp-name)
|
|
|
|
file-notify--test-desc
|
2015-09-21 13:07:06 +00:00
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile
|
|
|
|
'(change) #'file-notify--test-event-handler))
|
2015-09-20 16:44:36 +00:00
|
|
|
(file-notify--test-with-events
|
2015-10-26 15:46:48 +00:00
|
|
|
(file-notify--test-timeout) '(created changed deleted)
|
2015-09-20 16:44:36 +00:00
|
|
|
(should (file-notify-valid-p file-notify--test-desc))
|
|
|
|
(write-region
|
|
|
|
"any text" nil file-notify--test-tmpfile nil 'no-message)
|
2015-10-26 15:46:48 +00:00
|
|
|
(delete-file file-notify--test-tmpfile))
|
|
|
|
;; After deleting the file, the descriptor is still valid.
|
|
|
|
(should (file-notify-valid-p file-notify--test-desc))
|
|
|
|
;; After removing the watch, the descriptor must not be valid
|
2015-09-20 16:44:36 +00:00
|
|
|
;; anymore.
|
|
|
|
(file-notify-rm-watch file-notify--test-desc)
|
|
|
|
(should-not (file-notify-valid-p file-notify--test-desc)))
|
|
|
|
|
|
|
|
;; Cleanup.
|
|
|
|
(file-notify--test-cleanup))
|
|
|
|
|
2015-09-14 06:03:11 +00:00
|
|
|
(unwind-protect
|
2015-09-21 13:07:06 +00:00
|
|
|
;; The batch-mode operation of w32notify is fragile (there's no
|
|
|
|
;; input threads to send the message to).
|
2015-10-26 15:46:48 +00:00
|
|
|
;(unless (and noninteractive (eq file-notify--library 'w32notify))
|
|
|
|
(unless (eq file-notify--library 'w32notify)
|
|
|
|
(let ((temporary-file-directory
|
|
|
|
(make-temp-file "file-notify-test-parent" t)))
|
2015-10-25 13:18:17 +00:00
|
|
|
(setq file-notify--test-tmpfile (file-notify--test-make-temp-name)
|
|
|
|
file-notify--test-desc
|
2015-09-21 13:07:06 +00:00
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile
|
|
|
|
'(change) #'file-notify--test-event-handler))
|
|
|
|
(file-notify--test-with-events
|
2015-10-26 15:46:48 +00:00
|
|
|
(file-notify--test-timeout) '(created changed deleted stopped)
|
2015-09-21 13:07:06 +00:00
|
|
|
(should (file-notify-valid-p file-notify--test-desc))
|
|
|
|
(write-region
|
|
|
|
"any text" nil file-notify--test-tmpfile nil 'no-message)
|
2015-10-26 15:46:48 +00:00
|
|
|
(delete-directory temporary-file-directory t))
|
|
|
|
;; After deleting the parent directory, the descriptor must
|
|
|
|
;; not be valid anymore.
|
2015-09-21 13:07:06 +00:00
|
|
|
(should-not (file-notify-valid-p file-notify--test-desc))))
|
2015-09-14 06:03:11 +00:00
|
|
|
|
2015-09-20 16:44:36 +00:00
|
|
|
;; Cleanup.
|
2015-09-14 20:15:20 +00:00
|
|
|
(file-notify--test-cleanup)))
|
2015-09-14 06:03:11 +00:00
|
|
|
|
|
|
|
(file-notify--deftest-remote file-notify-test04-file-validity
|
2015-09-14 20:15:20 +00:00
|
|
|
"Check `file-notify-valid-p' via file notification for remote files.")
|
2015-09-14 06:03:11 +00:00
|
|
|
|
|
|
|
(ert-deftest file-notify-test05-dir-validity ()
|
|
|
|
"Check `file-notify-valid-p' for directories."
|
|
|
|
(skip-unless (file-notify--test-local-enabled))
|
2015-09-20 16:44:36 +00:00
|
|
|
|
|
|
|
(unwind-protect
|
|
|
|
(progn
|
2015-10-26 15:46:48 +00:00
|
|
|
(setq file-notify--test-tmpfile
|
|
|
|
(file-name-as-directory (file-notify--test-make-temp-name)))
|
2015-09-20 16:44:36 +00:00
|
|
|
(make-directory file-notify--test-tmpfile)
|
2015-09-21 13:07:06 +00:00
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile
|
|
|
|
'(change) #'file-notify--test-event-handler))
|
2015-09-20 16:44:36 +00:00
|
|
|
(should (file-notify-valid-p file-notify--test-desc))
|
|
|
|
;; After removing the watch, the descriptor must not be valid
|
|
|
|
;; anymore.
|
|
|
|
(file-notify-rm-watch file-notify--test-desc)
|
2015-10-26 15:46:48 +00:00
|
|
|
(file-notify--wait-for-events
|
|
|
|
(file-notify--test-timeout)
|
|
|
|
(not (file-notify-valid-p file-notify--test-desc)))
|
2015-09-20 16:44:36 +00:00
|
|
|
(should-not (file-notify-valid-p file-notify--test-desc)))
|
|
|
|
|
|
|
|
;; Cleanup.
|
|
|
|
(file-notify--test-cleanup))
|
|
|
|
|
2015-09-14 06:03:11 +00:00
|
|
|
(unwind-protect
|
2015-09-21 13:07:06 +00:00
|
|
|
;; The batch-mode operation of w32notify is fragile (there's no
|
|
|
|
;; input threads to send the message to).
|
|
|
|
(unless (and noninteractive (eq file-notify--library 'w32notify))
|
2015-10-26 15:46:48 +00:00
|
|
|
(setq file-notify--test-tmpfile
|
|
|
|
(file-name-as-directory (file-notify--test-make-temp-name)))
|
2015-09-14 07:52:31 +00:00
|
|
|
(make-directory file-notify--test-tmpfile)
|
2015-09-21 13:07:06 +00:00
|
|
|
(setq file-notify--test-desc
|
|
|
|
(file-notify-add-watch
|
|
|
|
file-notify--test-tmpfile
|
|
|
|
'(change) #'file-notify--test-event-handler))
|
2015-09-14 06:03:11 +00:00
|
|
|
(should (file-notify-valid-p file-notify--test-desc))
|
2015-09-14 20:15:20 +00:00
|
|
|
;; After deleting the directory, the descriptor must not be
|
2015-09-14 07:52:31 +00:00
|
|
|
;; valid anymore.
|
2015-09-20 16:44:36 +00:00
|
|
|
(delete-directory file-notify--test-tmpfile t)
|
|
|
|
(file-notify--wait-for-events
|
|
|
|
(file-notify--test-timeout)
|
|
|
|
(not (file-notify-valid-p file-notify--test-desc)))
|
2015-09-14 20:15:20 +00:00
|
|
|
(should-not (file-notify-valid-p file-notify--test-desc)))
|
2015-09-14 06:03:11 +00:00
|
|
|
|
2015-09-20 16:44:36 +00:00
|
|
|
;; Cleanup.
|
2015-09-14 20:15:20 +00:00
|
|
|
(file-notify--test-cleanup)))
|
2015-09-14 06:03:11 +00:00
|
|
|
|
|
|
|
(file-notify--deftest-remote file-notify-test05-dir-validity
|
2015-09-14 20:15:20 +00:00
|
|
|
"Check `file-notify-valid-p' via file notification for remote directories.")
|
2015-09-14 06:03:11 +00:00
|
|
|
|
2013-07-04 09:43:17 +00:00
|
|
|
(defun file-notify-test-all (&optional interactive)
|
|
|
|
"Run all tests for \\[file-notify]."
|
|
|
|
(interactive "p")
|
2013-10-24 07:38:45 +00:00
|
|
|
(if interactive
|
|
|
|
(ert-run-tests-interactively "^file-notify-")
|
|
|
|
(ert-run-tests-batch "^file-notify-")))
|
2013-07-04 09:43:17 +00:00
|
|
|
|
2015-10-26 15:46:48 +00:00
|
|
|
;; TODO:
|
|
|
|
|
|
|
|
;; * It does not work yet for local gfilenotify and remote inotifywait.
|
|
|
|
;; * For w32notify, no stopped events arrive when a directory is removed.
|
|
|
|
|
2013-07-04 09:43:17 +00:00
|
|
|
(provide 'file-notify-tests)
|
|
|
|
;;; file-notify-tests.el ends here
|