1 ;;; vc-tests.el --- Tests of different backends of vc.el
3 ;; Copyright (C) 2014-2015 Free Software Foundation, Inc.
5 ;; Author: Michael Albinus <michael.albinus@gmx.de>
7 ;; This program is free software: you can redistribute it and/or
8 ;; modify it under the terms of the GNU General Public License as
9 ;; published by the Free Software Foundation, either version 3 of the
10 ;; License, or (at your option) any later version.
12 ;; This program is distributed in the hope that it will be useful, but
13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 ;; General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with this program. If not, see `http://www.gnu.org/licenses/'.
22 ;; For every supported VC on the machine, different test cases are
23 ;; generated automatically.
25 ;; Functions to be tested (see Commentary of vc.el). Mandatory
26 ;; functions are marked with `*', optional functions are marked with `-':
30 ;; * revision-granularity
32 ;; STATE-QUERYING FUNCTIONS
34 ;; * registered (file)
36 ;; - dir-status (dir update-function)
37 ;; - dir-status-files (dir files default-state update-function)
38 ;; - dir-extra-headers (dir)
39 ;; - dir-printer (fileinfo)
40 ;; - status-fileinfo-extra (file)
41 ;; * working-revision (file)
42 ;; - latest-on-branch-p (file)
43 ;; * checkout-model (files)
44 ;; - mode-line-string (file)
46 ;; STATE-CHANGING FUNCTIONS
48 ;; * create-repo (backend)
49 ;; * register (files &optional comment)
50 ;; - responsible-p (file)
51 ;; - receive-file (file rev)
52 ;; - unregister (file)
53 ;; * checkin (files comment)
54 ;; * find-revision (file rev buffer)
55 ;; * checkout (file &optional rev)
56 ;; * revert (file &optional contents-done)
58 ;; - merge-file (file rev1 rev2)
60 ;; - merge-news (file)
62 ;; - steal-lock (file &optional revision)
63 ;; - modify-change-comment (files rev comment)
64 ;; - mark-resolved (files)
65 ;; - find-admin-dir (file)
69 ;; * print-log (files buffer &optional shortlog start-revision limit)
70 ;; * log-outgoing (backend remote-location)
71 ;; * log-incoming (backend remote-location)
73 ;; - show-log-entry (revision)
74 ;; - comment-history (file)
75 ;; - update-changelog (files)
76 ;; * diff (files &optional async rev1 rev2 buffer)
77 ;; - revision-completion-table (files)
78 ;; - annotate-command (file buf &optional rev)
80 ;; - annotate-current-time ()
81 ;; - annotate-extract-revision-at-line ()
82 ;; - region-history (FILE BUFFER LFROM LTO)
83 ;; - region-history-mode ()
87 ;; - create-tag (dir name branchp)
88 ;; - retrieve-tag (dir name update)
92 ;; - make-version-backups-p (file)
94 ;; - ignore (file &optional directory)
95 ;; - ignore-completion-table
96 ;; - previous-revision (file rev)
97 ;; - next-revision (file rev)
100 ;; - delete-file (file)
101 ;; - rename-file (old new)
102 ;; - find-file-hook ()
104 ;; - extra-dir-menu ()
105 ;; - conflicted-files (dir)
112 ;; The working horses.
114 (defvar vc-test--cleanup-hook nil
115 "Functions for cleanup at the end of an ert test.
116 Don't set it globally, the functions shall be let-bound.")
118 (defun vc-test--revision-granularity-function (backend)
119 "Run the `vc-revision-granularity' backend function."
120 (funcall (intern (downcase (format "vc-%s-revision-granularity" backend
)))))
122 (defun vc-test--create-repo-function (backend)
123 "Run the `vc-create-repo' backend function.
124 For backends which dont support it, it is emulated."
130 (make-temp-name "vc-test") temporary-file-directory
)))
131 (make-directory (expand-file-name "module" tmp-dir
) 'parents
)
132 (make-directory (expand-file-name "CVSROOT" tmp-dir
) 'parents
)
133 (shell-command-to-string (format "cvs -Q -d:local:%s co module" tmp-dir
))
134 (rename-file "module/CVS" default-directory
)
135 (delete-directory "module" 'recursive
)
136 ;; We must cleanup the "remote" CVS repo as well.
137 (add-hook 'vc-test--cleanup-hook
138 `(lambda () (delete-directory ,tmp-dir
'recursive
)))))
141 (let ((archive-name (format "%s--%s" user-mail-address
(random))))
143 "no arch user id set" (shell-command-to-string "tla my-id"))
144 (shell-command-to-string
145 (format "tla my-id \"<%s>\"" user-mail-address
)))
146 (shell-command-to-string
147 (format "tla make-archive %s %s" archive-name default-directory
))
148 (shell-command-to-string
149 (format "tla my-default-archive %s" archive-name
))))
152 (let ((archive-name "foo.mtn"))
153 (shell-command-to-string
155 "mtn db init --db=%s"
156 (expand-file-name archive-name default-directory
)))
157 (shell-command-to-string
158 (format "mtn --db=%s --branch=foo setup ." archive-name
))))
160 (t (vc-create-repo backend
))))
162 (defun vc-test--create-repo (backend)
163 "Create a test repository in `default-directory', a temporary directory."
165 (let ((vc-handled-backends `(,backend
))
167 (file-name-as-directory
169 (make-temp-name "vc-test") temporary-file-directory
)))
170 vc-test--cleanup-hook
)
176 'vc-test--cleanup-hook
177 `(lambda () (delete-directory ,default-directory
'recursive
)))
179 ;; Check the revision granularity.
180 (should (memq (vc-test--revision-granularity-function backend
)
183 ;; Create empty repository.
184 (make-directory default-directory
)
185 (should (file-directory-p default-directory
))
186 (vc-test--create-repo-function backend
))
189 (ignore-errors (run-hooks 'vc-test--cleanup-hook
)))))
191 ;; Why isn't there `vc-unregister'?
192 (defun vc-test--unregister-function (backend file
)
193 "Run the `vc-unregister' backend function.
194 For backends which dont support it, `vc-not-supported' is signalled."
196 (let ((symbol (intern (downcase (format "vc-%s-unregister" backend
)))))
197 (if (functionp symbol
)
198 (funcall symbol file
)
199 ;; CVS, SVN, SCCS, SRC and Mtn are not supported.
200 (signal 'vc-not-supported
(list 'unregister backend
)))))
202 (defun vc-test--register (backend)
203 "Register and unregister a file."
205 (let ((vc-handled-backends `(,backend
))
207 (file-name-as-directory
209 (make-temp-name "vc-test") temporary-file-directory
)))
210 vc-test--cleanup-hook
)
216 'vc-test--cleanup-hook
217 `(lambda () (delete-directory ,default-directory
'recursive
)))
219 ;; Create empty repository.
220 (make-directory default-directory
)
221 (vc-test--create-repo-function backend
)
223 (let ((tmp-name1 (expand-file-name "foo" default-directory
))
225 ;; Register files. Check for it.
226 (write-region "foo" nil tmp-name1 nil
'nomessage
)
227 (should (file-exists-p tmp-name1
))
228 (should-not (vc-registered tmp-name1
))
229 (write-region "bla" nil tmp-name2 nil
'nomessage
)
230 (should (file-exists-p tmp-name2
))
231 (should-not (vc-registered tmp-name2
))
233 (list backend
(list tmp-name1 tmp-name2
)))
234 (should (file-exists-p tmp-name1
))
235 (should (vc-registered tmp-name1
))
236 (should (file-exists-p tmp-name2
))
237 (should (vc-registered tmp-name2
))
239 ;; Unregister the files.
242 (vc-test--unregister-function backend tmp-name1
)
243 (should-not (vc-registered tmp-name1
))
244 (vc-test--unregister-function backend tmp-name2
)
245 (should-not (vc-registered tmp-name2
)))
246 ;; CVS, SVN, SCCS, SRC and Mtn are not supported.
247 (vc-not-supported (message "%s" (error-message-string err
))))
248 (should (file-exists-p tmp-name1
))
249 (should (file-exists-p tmp-name2
))))
252 (ignore-errors (run-hooks 'vc-test--cleanup-hook
)))))
254 ;; `vc-state' returns different results for different backends. So we
255 ;; don't check with `should', but print the results for analysis.
256 (defun vc-test--state (backend)
257 "Check the different states of a file."
259 (let ((vc-handled-backends `(,backend
))
261 (file-name-as-directory
263 (make-temp-name "vc-test") temporary-file-directory
)))
264 vc-test--cleanup-hook errors
)
270 'vc-test--cleanup-hook
271 `(lambda () (delete-directory ,default-directory
'recursive
)))
273 ;; Create empty repository.
274 (make-directory default-directory
)
275 (vc-test--create-repo-function backend
)
277 (message "%s" (vc-state default-directory backend
))
278 ;(should (eq (vc-state default-directory backend) 'up-to-date))
280 (let ((tmp-name (expand-file-name "foo" default-directory
)))
281 ;; Check for initial state.
282 (message "%s" (vc-state tmp-name backend
))
283 ;(should (eq (vc-state tmp-name backend) 'unregistered))
285 ;; Write a new file. Check for state.
286 (write-region "foo" nil tmp-name nil
'nomessage
)
287 (message "%s" (vc-state tmp-name backend
))
288 ;(should (eq (vc-state tmp-name backend) 'unregistered))
290 ;; Register a file. Check for state.
292 (list backend
(list (file-name-nondirectory tmp-name
))))
293 (message "%s" (vc-state tmp-name backend
))
294 ;(should (eq (vc-state tmp-name backend) 'added))
296 ;; Unregister the file. Check for state.
299 (vc-test--unregister-function backend tmp-name
)
300 (message "%s" (vc-state tmp-name backend
))
301 );(should (eq (vc-state tmp-name backend) 'unregistered)))
302 (vc-not-supported (message "%s" 'unsupported
)))))
305 (ignore-errors (run-hooks 'vc-test--cleanup-hook
)))))
307 (defun vc-test--working-revision (backend)
308 "Check the working revision of a repository."
310 (let ((vc-handled-backends `(,backend
))
312 (file-name-as-directory
314 (make-temp-name "vc-test") temporary-file-directory
)))
315 vc-test--cleanup-hook errors
)
321 'vc-test--cleanup-hook
322 `(lambda () (delete-directory ,default-directory
'recursive
)))
324 ;; Create empty repository.
325 (make-directory default-directory
)
326 (vc-test--create-repo-function backend
)
330 (vc-working-revision default-directory backend
) '("0" "master")))
332 (let ((tmp-name (expand-file-name "foo" default-directory
)))
333 ;; Check for initial state, should be nil until it's registered.
334 ;; Don't pass the backend explictly, otherwise some implementations
336 (should (null (vc-working-revision tmp-name
)))
338 ;; Write a new file. Check state.
339 (write-region "foo" nil tmp-name nil
'nomessage
)
340 (should (null (vc-working-revision tmp-name
)))
342 ;; Register a file. Check for state.
344 (list backend
(list (file-name-nondirectory tmp-name
))))
345 ;; FIXME: Don't pass the backend. Emacs should be able to
348 (member (vc-working-revision tmp-name backend
) '("0" "master")))
350 ;; Unregister the file. Check for working-revision.
353 (vc-test--unregister-function backend tmp-name
)
356 (vc-working-revision tmp-name backend
) '("0" "master"))))
357 (vc-not-supported (message "%s" 'unsupported
)))))
360 (ignore-errors (run-hooks 'vc-test--cleanup-hook
)))))
362 ;; Create the test cases.
364 (defun vc-test--rcs-enabled ()
365 (executable-find "rcs"))
367 (defun vc-test--cvs-enabled ()
368 (executable-find "cvs"))
370 (defvar vc-svn-program
)
371 (defun vc-test--svn-enabled ()
372 (executable-find vc-svn-program
))
374 (defun vc-test--sccs-enabled ()
375 (executable-find "sccs"))
377 (defvar vc-src-program
)
378 (defun vc-test--src-enabled ()
379 (executable-find vc-src-program
))
381 (defvar vc-bzr-program
)
382 (defun vc-test--bzr-enabled ()
383 (executable-find vc-bzr-program
))
385 (defvar vc-git-program
)
386 (defun vc-test--git-enabled ()
387 (executable-find vc-git-program
))
389 (defvar vc-hg-program
)
390 (defun vc-test--hg-enabled ()
391 (executable-find vc-hg-program
))
393 (defvar vc-mtn-program
)
394 (defun vc-test--mtn-enabled ()
395 (executable-find vc-mtn-program
))
397 (defvar vc-arch-program
)
398 (defun vc-test--arch-enabled ()
399 (executable-find vc-arch-program
))
402 ;; There are too many failed test cases yet. We suppress them on hydra.
403 (if (getenv "NIX_STORE")
404 (ert-deftest vc-test
()
405 "Dummy test case for hydra."
408 ;; Create the test cases.
409 (dolist (backend vc-handled-backends
)
410 (let ((backend-string (downcase (symbol-name backend
))))
411 (require (intern (format "vc-%s" backend-string
)))
413 ;; Check, whether the backend is supported.
414 `(when (funcall ',(intern (format "vc-test--%s-enabled" backend-string
)))
417 ,(intern (format "vc-test-%s00-create-repo" backend-string
)) ()
418 ,(format "Check `vc-create-repo' for the %s backend." backend-string
)
419 (vc-test--create-repo ',backend
))
422 ,(intern (format "vc-test-%s01-register" backend-string
)) ()
424 "Check `vc-register' and `vc-registered' for the %s backend."
428 (ert-test-most-recent-result
431 (format "vc-test-%s00-create-repo" backend-string
))))))
432 (vc-test--register ',backend
))
435 ,(intern (format "vc-test-%s02-state" backend-string
)) ()
436 ,(format "Check `vc-state' for the %s backend." backend-string
)
439 (ert-test-most-recent-result
442 (format "vc-test-%s01-register" backend-string
))))))
443 (vc-test--state ',backend
))
446 ,(intern (format "vc-test-%s03-working-revision" backend-string
)) ()
447 ,(format "Check `vc-working-revision' for the %s backend." backend-string
)
450 (ert-test-most-recent-result
453 (format "vc-test-%s01-register" backend-string
))))))
454 (vc-test--working-revision ',backend
)))))))
457 ;;; vc-tests.el ends here