1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
;;; info-xref-tests.el --- tests for info-xref.el -*- lexical-binding:t -*-
;; Copyright (C) 2013-2025 Free Software Foundation, Inc.
;; This file is part of GNU Emacs.
;; GNU Emacs 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.
;; GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'ert)
(require 'ert-x)
(require 'info-xref)
(defun info-xref-test-internal (body result)
"Body of a basic info-xref ert test.
BODY is a string from an info buffer.
RESULT is a list (NBAD NGOOD NUNAVAIL)."
(get-buffer-create info-xref-output-buffer)
(setq info-xref-xfile-alist nil)
(require 'info)
(let ((Info-directory-list '("."))
Info-additional-directory-list)
(info-xref-with-output
(with-temp-buffer
(insert body)
(info-xref-check-buffer))))
(should (equal result (list info-xref-bad info-xref-good info-xref-unavail)))
;; If there was an error, we can leave this around.
(kill-buffer info-xref-output-buffer))
(ert-deftest info-xref-test-node-crossref ()
"Test parsing of @xref{node,crossref,,manual} with Texinfo 4/5."
(info-xref-test-internal "
*Note crossref: (manual-foo)node. Texinfo 4/5 format with crossref.
" '(0 0 1)))
(ert-deftest info-xref-test-node-4 ()
"Test parsing of @xref{node,,,manual} with Texinfo 4."
(info-xref-test-internal "
*Note node: (manual-foo)node. Texinfo 4 format with no crossref.
" '(0 0 1)))
(ert-deftest info-xref-test-node-5 ()
"Test parsing of @xref{node,,,manual} with Texinfo 5."
(info-xref-test-internal "
*Note (manual-foo)node::. Texinfo 5 format with no crossref.
" '(0 0 1)))
;; TODO Easier to have static data files in the repo?
(defun info-xref-test-write-file (file body)
"Write BODY to texi FILE."
(with-temp-buffer
(insert "\
\\input texinfo
@setfilename "
(format "%s.info\n" (file-name-sans-extension file))
"\
@settitle test
@ifnottex
@node Top
@top test
@end ifnottex
@menu
* Chapter One::
@end menu
@node Chapter One
@chapter Chapter One
text.
"
body
"\
@bye
"
)
(write-region nil nil file nil 'silent))
(if (and (eq system-type 'windows-nt)
(executable-find "sh"))
;; If we are running from MSYS Bash, makeinfo.bat might find the
;; wrong version of Perl, so make sure to run the shell script
;; named just 'makeinfo' instead, because it names the correct
;; Perl.
(should (equal 0 (call-process "sh" nil t nil
"-c" (format "makeinfo '%s'" file))))
(should (equal 0 (call-process "makeinfo" file)))))
(ert-deftest info-xref-test-makeinfo ()
"Test that info-xref can parse basic makeinfo output."
(skip-unless (executable-find "makeinfo"))
(ert-with-temp-file tempfile
:suffix ".texi"
(ert-with-temp-file tempfile2
:suffix ".texi"
(let ((errflag t))
(unwind-protect
(progn
;; tempfile contains xrefs to various things, including tempfile2.
(info-xref-test-write-file
tempfile
(concat "\
@xref{nodename,,,missing,Missing Manual}.
@xref{nodename,crossref,title,missing,Missing Manual}.
@xref{Chapter One}.
@xref{Chapter One,Something}.
"
(format "@xref{Chapter One,,,%s,Present Manual}.\n"
(file-name-sans-extension (file-name-nondirectory
tempfile2)))))
;; Something for tempfile to xref to.
(info-xref-test-write-file tempfile2 "")
(require 'info)
(save-window-excursion
(let ((Info-directory-list
(list
(or (file-name-directory tempfile) ".")))
Info-additional-directory-list)
(info-xref-check (format "%s.info" (file-name-sans-extension
tempfile))))
(should (equal (list info-xref-bad info-xref-good
info-xref-unavail)
'(0 1 2)))
(setq errflag nil)
;; If there was an error, we can leave this around.
(kill-buffer info-xref-output-buffer)))
;; Useful diagnostic in case of problems.
(if errflag
(with-temp-buffer
(call-process "makeinfo" nil t nil "--version")
(message "%s" (buffer-string))))
(ignore-errors
(delete-file (format "%s.info" (file-name-sans-extension
tempfile))))
(ignore-errors
(delete-file (format "%s.info" (file-name-sans-extension
tempfile2)))))))))
(ert-deftest info-xref-test-emacs-manuals ()
"Test that all internal links in the Emacs manuals work."
:tags '(:expensive-test)
(require 'info)
(let ((default-directory (car (Info-default-dirs)))
(Info-directory-list '(".")))
(skip-unless (file-readable-p "emacs.info"))
(info-xref-check-all)
(with-current-buffer info-xref-output-buffer
(goto-char (point-max))
(should (search-backward "done" nil t))
(should (string-match-p
" [0-9]\\{3,\\} good, 0 bad"
(buffer-substring-no-properties (pos-bol) (pos-eol)))))))
;;; info-xref-tests.el ends here
|
