]> code.delx.au - gnu-emacs/blob - test/automated/vc-tests.el
847e0768da8d3bd90e15a243ffff4eaf4ebdda84
[gnu-emacs] / test / automated / vc-tests.el
1 ;;; vc-tests.el --- Tests of different backends of vc.el
2
3 ;; Copyright (C) 2014-2015 Free Software Foundation, Inc.
4
5 ;; Author: Michael Albinus <michael.albinus@gmx.de>
6
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.
11 ;;
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.
16 ;;
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/'.
19
20 ;;; Commentary:
21
22 ;; For every supported VC on the machine, different test cases are
23 ;; generated automatically.
24
25 ;; Functions to be tested (see Commentary of vc.el). Mandatory
26 ;; functions are marked with `*', optional functions are marked with `-':
27
28 ;; BACKEND PROPERTIES
29 ;;
30 ;; * revision-granularity DONE
31
32 ;; STATE-QUERYING FUNCTIONS
33 ;;
34 ;; * registered (file) DONE
35 ;; * state (file) DONE
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) DONE
42 ;; - latest-on-branch-p (file)
43 ;; * checkout-model (files) DONE
44 ;; - mode-line-string (file)
45
46 ;; STATE-CHANGING FUNCTIONS
47 ;;
48 ;; * create-repo (backend) DONE
49 ;; * register (files &optional comment) DONE
50 ;; - responsible-p (file)
51 ;; - receive-file (file rev)
52 ;; - unregister (file) DONE
53 ;; * checkin (files comment)
54 ;; * find-revision (file rev buffer)
55 ;; * checkout (file &optional rev)
56 ;; * revert (file &optional contents-done)
57 ;; - rollback (files)
58 ;; - merge-file (file rev1 rev2)
59 ;; - merge-branch ()
60 ;; - merge-news (file)
61 ;; - pull (prompt)
62 ;; - steal-lock (file &optional revision)
63 ;; - modify-change-comment (files rev comment)
64 ;; - mark-resolved (files)
65 ;; - find-admin-dir (file)
66
67 ;; HISTORY FUNCTIONS
68 ;;
69 ;; * print-log (files buffer &optional shortlog start-revision limit)
70 ;; * log-outgoing (backend remote-location)
71 ;; * log-incoming (backend remote-location)
72 ;; - log-view-mode ()
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)
79 ;; - annotate-time ()
80 ;; - annotate-current-time ()
81 ;; - annotate-extract-revision-at-line ()
82 ;; - region-history (FILE BUFFER LFROM LTO)
83 ;; - region-history-mode ()
84
85 ;; TAG SYSTEM
86 ;;
87 ;; - create-tag (dir name branchp)
88 ;; - retrieve-tag (dir name update)
89
90 ;; MISCELLANEOUS
91 ;;
92 ;; - make-version-backups-p (file)
93 ;; - root (file)
94 ;; - ignore (file &optional directory)
95 ;; - ignore-completion-table
96 ;; - previous-revision (file rev)
97 ;; - next-revision (file rev)
98 ;; - log-edit-mode ()
99 ;; - check-headers ()
100 ;; - delete-file (file)
101 ;; - rename-file (old new)
102 ;; - find-file-hook ()
103 ;; - extra-menu ()
104 ;; - extra-dir-menu ()
105 ;; - conflicted-files (dir)
106
107 ;;; Code:
108
109 (require 'ert)
110 (require 'vc)
111
112 ;; The working horses.
113
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.")
117
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)))))
121
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."
125
126 (cond
127 ((eq backend 'CVS)
128 (let ((tmp-dir
129 (expand-file-name
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 (if (not (fboundp 'w32-application-type))
134 (shell-command-to-string (format "cvs -Q -d:local:%s co module"
135 tmp-dir))
136 (let ((cvs-prog (executable-find "cvs"))
137 (tdir tmp-dir))
138 ;; If CVS executable is an MSYS program, reformat the file
139 ;; name of TMP-DIR to have the /d/foo/bar form supported by
140 ;; MSYS programs. (FIXME: What about Cygwin cvs.exe?)
141 (if (eq (w32-application-type cvs-prog) 'msys)
142 (setq tdir
143 (concat "/" (substring tmp-dir 0 1) (substring tmp-dir 2))))
144 (shell-command-to-string (format "cvs -Q -d:local:%s co module"
145 tdir))))
146 (rename-file "module/CVS" default-directory)
147 (delete-directory "module" 'recursive)
148 ;; We must cleanup the "remote" CVS repo as well.
149 (add-hook 'vc-test--cleanup-hook
150 `(lambda () (delete-directory ,tmp-dir 'recursive)))))
151
152 ((eq backend 'Arch)
153 (let ((archive-name (format "%s--%s" user-mail-address (random))))
154 (when (string-match
155 "no arch user id set" (shell-command-to-string "tla my-id"))
156 (shell-command-to-string
157 (format "tla my-id \"<%s>\"" user-mail-address)))
158 (shell-command-to-string
159 (format "tla make-archive %s %s" archive-name default-directory))
160 (shell-command-to-string
161 (format "tla my-default-archive %s" archive-name))))
162
163 ((eq backend 'Mtn)
164 (let ((archive-name "foo.mtn"))
165 (shell-command-to-string
166 (format
167 "mtn db init --db=%s"
168 (expand-file-name archive-name default-directory)))
169 (shell-command-to-string
170 (format "mtn --db=%s --branch=foo setup ." archive-name))))
171
172 (t (vc-create-repo backend))))
173
174 (defun vc-test--create-repo (backend)
175 "Create a test repository in `default-directory', a temporary directory."
176
177 (let ((vc-handled-backends `(,backend))
178 (default-directory
179 (file-name-as-directory
180 (expand-file-name
181 (make-temp-name "vc-test") temporary-file-directory)))
182 vc-test--cleanup-hook)
183
184 (unwind-protect
185 (progn
186 ;; Cleanup.
187 (add-hook
188 'vc-test--cleanup-hook
189 `(lambda () (delete-directory ,default-directory 'recursive)))
190
191 ;; Check the revision granularity.
192 (should (memq (vc-test--revision-granularity-function backend)
193 '(file repository)))
194
195 ;; Create empty repository.
196 (make-directory default-directory)
197 (should (file-directory-p default-directory))
198 (vc-test--create-repo-function backend)
199 (should (eq (vc-responsible-backend default-directory) backend)))
200
201 ;; Save exit.
202 (ignore-errors (run-hooks 'vc-test--cleanup-hook)))))
203
204 ;; Why isn't there `vc-unregister'?
205 (defun vc-test--unregister-function (backend file)
206 "Run the `vc-unregister' backend function.
207 For backends which dont support it, `vc-not-supported' is signalled."
208
209 (let ((symbol (intern (downcase (format "vc-%s-unregister" backend)))))
210 (if (functionp symbol)
211 (funcall symbol file)
212 ;; CVS, SVN, SCCS, SRC and Mtn are not supported.
213 (signal 'vc-not-supported (list 'unregister backend)))))
214
215 (defun vc-test--register (backend)
216 "Register and unregister a file."
217
218 (let ((vc-handled-backends `(,backend))
219 (default-directory
220 (file-name-as-directory
221 (expand-file-name
222 (make-temp-name "vc-test") temporary-file-directory)))
223 vc-test--cleanup-hook)
224
225 (unwind-protect
226 (progn
227 ;; Cleanup.
228 (add-hook
229 'vc-test--cleanup-hook
230 `(lambda () (delete-directory ,default-directory 'recursive)))
231
232 ;; Create empty repository.
233 (make-directory default-directory)
234 (vc-test--create-repo-function backend)
235
236 (let ((tmp-name1 (expand-file-name "foo" default-directory))
237 (tmp-name2 "bla"))
238 ;; Register files. Check for it.
239 (write-region "foo" nil tmp-name1 nil 'nomessage)
240 (should (file-exists-p tmp-name1))
241 (should-not (vc-registered tmp-name1))
242 (write-region "bla" nil tmp-name2 nil 'nomessage)
243 (should (file-exists-p tmp-name2))
244 (should-not (vc-registered tmp-name2))
245 (vc-register (list backend (list tmp-name1 tmp-name2)))
246 (should (file-exists-p tmp-name1))
247 (should (vc-registered tmp-name1))
248 (should (file-exists-p tmp-name2))
249 (should (vc-registered tmp-name2))
250
251 ;; Unregister the files.
252 (condition-case err
253 (progn
254 (vc-test--unregister-function backend tmp-name1)
255 (should-not (vc-registered tmp-name1))
256 (vc-test--unregister-function backend tmp-name2)
257 (should-not (vc-registered tmp-name2)))
258 ;; CVS, SVN, SCCS, SRC and Mtn are not supported.
259 (vc-not-supported t))
260 ;; The files shall still exist.
261 (should (file-exists-p tmp-name1))
262 (should (file-exists-p tmp-name2))))
263
264 ;; Save exit.
265 (ignore-errors (run-hooks 'vc-test--cleanup-hook)))))
266
267 (defun vc-test--state (backend)
268 "Check the different states of a file."
269
270 (let ((vc-handled-backends `(,backend))
271 (default-directory
272 (file-name-as-directory
273 (expand-file-name
274 (make-temp-name "vc-test") temporary-file-directory)))
275 vc-test--cleanup-hook)
276
277 (unwind-protect
278 (progn
279 ;; Cleanup.
280 (add-hook
281 'vc-test--cleanup-hook
282 `(lambda () (delete-directory ,default-directory 'recursive)))
283
284 ;; Create empty repository. Check repository state.
285 (make-directory default-directory)
286 (vc-test--create-repo-function backend)
287
288 ;; nil: Hg Mtn RCS
289 ;; added: Git
290 ;; unregistered: CVS SCCS SRC
291 ;; up-to-date: Bzr SVN
292 (message "vc-state1 %s" (vc-state default-directory))
293 (should (eq (vc-state default-directory)
294 (vc-state default-directory backend)))
295 (should (memq (vc-state default-directory)
296 '(nil added unregistered up-to-date)))
297
298 (let ((tmp-name (expand-file-name "foo" default-directory)))
299 ;; Check state of an empty file.
300
301 ;; nil: Hg Mtn SRC SVN
302 ;; added: Git
303 ;; unregistered: RCS SCCS
304 ;; up-to-date: Bzr CVS
305 (message "vc-state2 %s" (vc-state tmp-name))
306 (should (eq (vc-state tmp-name) (vc-state tmp-name backend)))
307 (should (memq (vc-state tmp-name)
308 '(nil added unregistered up-to-date)))
309
310 ;; Write a new file. Check state.
311 (write-region "foo" nil tmp-name nil 'nomessage)
312
313 ;; nil: Mtn
314 ;; added: Git
315 ;; unregistered: Hg RCS SCCS SRC SVN
316 ;; up-to-date: Bzr CVS
317 (message "vc-state3 %s" (vc-state tmp-name))
318 (should (eq (vc-state tmp-name) (vc-state tmp-name backend)))
319 (should (memq (vc-state tmp-name)
320 '(nil added unregistered up-to-date)))
321
322 ;; Register a file. Check state.
323 (vc-register
324 (list backend (list (file-name-nondirectory tmp-name))))
325
326 ;; added: Git Mtn
327 ;; unregistered: Hg RCS SCCS SRC SVN
328 ;; up-to-date: Bzr CVS
329 (message "vc-state4 %s" (vc-state tmp-name))
330 (should (eq (vc-state tmp-name) (vc-state tmp-name backend)))
331 (should (memq (vc-state tmp-name) '(added unregistered up-to-date)))
332
333 ;; Unregister the file. Check state.
334 (condition-case nil
335 (progn
336 (vc-test--unregister-function backend tmp-name)
337
338 ;; added: Git
339 ;; unregistered: Hg RCS
340 ;; unsupported: CVS Mtn SCCS SRC SVN
341 ;; up-to-date: Bzr
342 (message "vc-state5 %s" (vc-state tmp-name))
343 (should (eq (vc-state tmp-name) (vc-state tmp-name backend)))
344 (should (memq (vc-state tmp-name)
345 '(added unregistered up-to-date))))
346 (vc-not-supported (message "vc-state5 unsupported")))))
347
348 ;; Save exit.
349 (ignore-errors (run-hooks 'vc-test--cleanup-hook)))))
350
351 (defun vc-test--working-revision (backend)
352 "Check the working revision of a repository."
353
354 (let ((vc-handled-backends `(,backend))
355 (default-directory
356 (file-name-as-directory
357 (expand-file-name
358 (make-temp-name "vc-test") temporary-file-directory)))
359 vc-test--cleanup-hook)
360
361 (unwind-protect
362 (progn
363 ;; Cleanup.
364 (add-hook
365 'vc-test--cleanup-hook
366 `(lambda () (delete-directory ,default-directory 'recursive)))
367
368 ;; Create empty repository. Check working revision of
369 ;; repository, should be nil.
370 (make-directory default-directory)
371 (vc-test--create-repo-function backend)
372
373 ;; nil: CVS Git Mtn RCS SCCS
374 ;; "0": Bzr Hg SRC SVN
375 (message
376 "vc-working-revision1 %s" (vc-working-revision default-directory))
377 (should (eq (vc-working-revision default-directory)
378 (vc-working-revision default-directory backend)))
379 (should (member (vc-working-revision default-directory) '(nil "0")))
380
381 (let ((tmp-name (expand-file-name "foo" default-directory)))
382 ;; Check initial working revision, should be nil until
383 ;; it's registered.
384
385 ;; nil: CVS Git Mtn RCS SCCS SVN
386 ;; "0": Bzr Hg SRC
387 (message "vc-working-revision2 %s" (vc-working-revision tmp-name))
388 (should (eq (vc-working-revision tmp-name)
389 (vc-working-revision tmp-name backend)))
390 (should (member (vc-working-revision tmp-name) '(nil "0")))
391
392 ;; Write a new file. Check working revision.
393 (write-region "foo" nil tmp-name nil 'nomessage)
394
395 ;; nil: CVS Git Mtn RCS SCCS SVN
396 ;; "0": Bzr Hg SRC
397 (message "vc-working-revision3 %s" (vc-working-revision tmp-name))
398 (should (eq (vc-working-revision tmp-name)
399 (vc-working-revision tmp-name backend)))
400 (should (member (vc-working-revision tmp-name) '(nil "0")))
401
402 ;; Register a file. Check working revision.
403 (vc-register
404 (list backend (list (file-name-nondirectory tmp-name))))
405
406 ;; nil: Mtn Git RCS SCCS
407 ;; "0": Bzr CVS Hg SRC SVN
408 (message "vc-working-revision4 %s" (vc-working-revision tmp-name))
409 (should (eq (vc-working-revision tmp-name)
410 (vc-working-revision tmp-name backend)))
411 (should (member (vc-working-revision tmp-name) '(nil "0")))
412
413 ;; Unregister the file. Check working revision.
414 (condition-case nil
415 (progn
416 (vc-test--unregister-function backend tmp-name)
417
418 ;; nil: Git RCS
419 ;; "0": Bzr Hg
420 ;; unsupported: CVS Mtn SCCS SRC SVN
421 (message
422 "vc-working-revision5 %s" (vc-working-revision tmp-name))
423 (should (eq (vc-working-revision tmp-name)
424 (vc-working-revision tmp-name backend)))
425 (should (member (vc-working-revision tmp-name) '(nil "0"))))
426 (vc-not-supported (message "vc-working-revision5 unsupported")))))
427
428 ;; Save exit.
429 (ignore-errors (run-hooks 'vc-test--cleanup-hook)))))
430
431 (defun vc-test--checkout-model (backend)
432 "Check the checkout model of a repository."
433
434 (let ((vc-handled-backends `(,backend))
435 (default-directory
436 (file-name-as-directory
437 (expand-file-name
438 (make-temp-name "vc-test") temporary-file-directory)))
439 vc-test--cleanup-hook)
440
441 (unwind-protect
442 (progn
443 ;; Cleanup.
444 (add-hook
445 'vc-test--cleanup-hook
446 `(lambda () (delete-directory ,default-directory 'recursive)))
447
448 ;; Create empty repository. Check repository checkout model.
449 (make-directory default-directory)
450 (vc-test--create-repo-function backend)
451
452 ;; Surprisingly, none of the backends returns 'announce.
453 ;; nil: RCS
454 ;; implicit: Bzr CVS Git Hg Mtn SRC SVN
455 ;; locking: SCCS
456 (message
457 "vc-checkout-model1 %s"
458 (vc-checkout-model backend default-directory))
459 (should (memq (vc-checkout-model backend default-directory)
460 '(announce implicit locking)))
461
462 (let ((tmp-name (expand-file-name "foo" default-directory)))
463 ;; Check checkout model of an empty file.
464
465 ;; nil: RCS
466 ;; implicit: Bzr CVS Git Hg Mtn SRC SVN
467 ;; locking: SCCS
468 (message
469 "vc-checkout-model2 %s" (vc-checkout-model backend tmp-name))
470 (should (memq (vc-checkout-model backend tmp-name)
471 '(announce implicit locking)))
472
473 ;; Write a new file. Check checkout model.
474 (write-region "foo" nil tmp-name nil 'nomessage)
475
476 ;; nil: RCS
477 ;; implicit: Bzr CVS Git Hg Mtn SRC SVN
478 ;; locking: SCCS
479 (message
480 "vc-checkout-model3 %s" (vc-checkout-model backend tmp-name))
481 (should (memq (vc-checkout-model backend tmp-name)
482 '(announce implicit locking)))
483
484 ;; Register a file. Check checkout model.
485 (vc-register
486 (list backend (list (file-name-nondirectory tmp-name))))
487
488 ;; nil: RCS
489 ;; implicit: Bzr CVS Git Hg Mtn SRC SVN
490 ;; locking: SCCS
491 (message
492 "vc-checkout-model4 %s" (vc-checkout-model backend tmp-name))
493 (should (memq (vc-checkout-model backend tmp-name)
494 '(announce implicit locking)))
495
496 ;; Unregister the file. Check checkout model.
497 (condition-case nil
498 (progn
499 (vc-test--unregister-function backend tmp-name)
500
501 ;; nil: RCS
502 ;; implicit: Bzr Git Hg
503 ;; unsupported: CVS Mtn SCCS SRC SVN
504 (message
505 "vc-checkout-model5 %s" (vc-checkout-model backend tmp-name))
506 (should (memq (vc-checkout-model backend tmp-name)
507 '(announce implicit locking))))
508 (vc-not-supported (message "vc-checkout-model5 unsupported")))))
509
510 ;; Save exit.
511 (ignore-errors (run-hooks 'vc-test--cleanup-hook)))))
512
513 ;; Create the test cases.
514
515 (defun vc-test--rcs-enabled ()
516 (executable-find "rcs"))
517
518 (defun vc-test--cvs-enabled ()
519 (executable-find "cvs"))
520
521 (defvar vc-svn-program)
522 (defun vc-test--svn-enabled ()
523 (executable-find vc-svn-program))
524
525 (defun vc-test--sccs-enabled ()
526 (executable-find "sccs"))
527
528 (defvar vc-src-program)
529 (defun vc-test--src-enabled ()
530 (executable-find vc-src-program))
531
532 (defvar vc-bzr-program)
533 (defun vc-test--bzr-enabled ()
534 (executable-find vc-bzr-program))
535
536 (defvar vc-git-program)
537 (defun vc-test--git-enabled ()
538 (executable-find vc-git-program))
539
540 (defvar vc-hg-program)
541 (defun vc-test--hg-enabled ()
542 (executable-find vc-hg-program))
543
544 (defvar vc-mtn-program)
545 (defun vc-test--mtn-enabled ()
546 (executable-find vc-mtn-program))
547
548 ;; Obsoleted.
549 (defvar vc-arch-program)
550 (defun vc-test--arch-enabled ()
551 (executable-find vc-arch-program))
552
553 ;; Create the test cases.
554 (dolist (backend vc-handled-backends)
555 (let ((backend-string (downcase (symbol-name backend))))
556 (require (intern (format "vc-%s" backend-string)))
557 (eval
558 ;; Check, whether the backend is supported.
559 `(when (funcall ',(intern (format "vc-test--%s-enabled" backend-string)))
560
561 (ert-deftest
562 ,(intern (format "vc-test-%s00-create-repo" backend-string)) ()
563 ,(format "Check `vc-create-repo' for the %s backend."
564 backend-string)
565 (vc-test--create-repo ',backend))
566
567 (ert-deftest
568 ,(intern (format "vc-test-%s01-register" backend-string)) ()
569 ,(format
570 "Check `vc-register' and `vc-registered' for the %s backend."
571 backend-string)
572 (skip-unless
573 (ert-test-passed-p
574 (ert-test-most-recent-result
575 (ert-get-test
576 ',(intern
577 (format "vc-test-%s00-create-repo" backend-string))))))
578 (vc-test--register ',backend))
579
580 (ert-deftest
581 ,(intern (format "vc-test-%s02-state" backend-string)) ()
582 ,(format "Check `vc-state' for the %s backend." backend-string)
583 (skip-unless
584 (ert-test-passed-p
585 (ert-test-most-recent-result
586 (ert-get-test
587 ',(intern
588 (format "vc-test-%s01-register" backend-string))))))
589 (vc-test--state ',backend))
590
591 (ert-deftest
592 ,(intern (format "vc-test-%s03-working-revision" backend-string)) ()
593 ,(format "Check `vc-working-revision' for the %s backend."
594 backend-string)
595 (skip-unless
596 (ert-test-passed-p
597 (ert-test-most-recent-result
598 (ert-get-test
599 ',(intern
600 (format "vc-test-%s01-register" backend-string))))))
601 (vc-test--working-revision ',backend))
602
603 (ert-deftest
604 ,(intern (format "vc-test-%s04-checkout-model" backend-string)) ()
605 ,(format "Check `vc-checkout-model' for the %s backend."
606 backend-string)
607 ;; FIXME make this pass.
608 :expected-result ,(if (equal backend 'RCS) :failed :passed)
609 (skip-unless
610 (ert-test-passed-p
611 (ert-test-most-recent-result
612 (ert-get-test
613 ',(intern
614 (format "vc-test-%s01-register" backend-string))))))
615 (vc-test--checkout-model ',backend))))))
616
617 (provide 'vc-tests)
618 ;;; vc-tests.el ends here