]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - tests/xtm-identity.lisp
test(xtm): register variant item-identity merge original
[topic-maps.git] / tests / xtm-identity.lisp
1 (defpackage #:topic-maps.xtm.tests
2 (:use #:cl #:topic-maps.tmdm)
3 (:import-from #:topic-maps.xtm #:deserialize-octets #:xtm-rejection #:xtm-unsupported
4 #:xtm-xml-error #:error-code #:error-document-iri #:error-source-key #:error-line #:error-column)
5 (:export #:run-tests #:write-report))
6 (in-package #:topic-maps.xtm.tests)
7
8 (defparameter *document* "https://xtm-tests.example.invalid/cd165b150176c1d6842b37be9cc9051b40d4996b/xtm2/in/example.xtm")
9 (defvar *checks* nil)
10 (defvar *cases* nil)
11 (defvar *outputs* nil)
12 (defvar *fixture* nil)
13 (defvar *negative-outputs* nil)
14 (defvar *negative-controls* nil)
15 (defvar *name-outputs* nil)
16 (defvar *name-controls* nil)
17 (defvar *scope-outputs* nil)
18 (defvar *scope-controls* nil)
19 (defvar *iid-outputs* nil)
20 (defvar *iid-controls* nil)
21 (defvar *variant-outputs* nil)
22 (defvar *variant-negative-outputs* nil)
23 (defvar *variant-controls* nil)
24 (defvar *variant-merge-outputs* nil)
25 (defun check (name truth)
26 (push name *checks*)
27 (unless truth (error "XTM test failed: ~A" name))
28 (format t "XTM-CHECK-PASS ~A~%" name))
29 (defun bytes (text &optional (encoding :utf-8) bom)
30 (concatenate '(vector (unsigned-byte 8))
31 (if bom (ecase encoding (:utf-8 #(239 187 191)) (:utf-16le #(255 254)) (:utf-16be #(254 255))) #())
32 (babel:string-to-octets text :encoding encoding :use-bom nil)))
33 (defun file-bytes (path)
34 (with-open-file (in path :element-type '(unsigned-byte 8))
35 (let ((data (make-array (file-length in) :element-type '(unsigned-byte 8))))
36 (assert (= (read-sequence data in) (length data))) data)))
37 (defun corpus-path (relative) (merge-pathnames relative (topic-maps.test-foundation:default-corpus-root)))
38 (defun document (body) (format nil "<topicMap xmlns='http://www.topicmaps.org/xtm/' version='2.0'>~A</topicMap>" body))
39 (defun read-body (body &optional (iri *document*))
40 (deserialize-octets (bytes (document body)) :document-iri iri :source-key "local:xtm-semantic-test"))
41 (defun by-id (map name)
42 (find-if (lambda (topic) (member (concatenate 'string *document* "#" name)
43 (topic-item-identifiers topic) :test #'string=)) (topic-map-topics map)))
44 (defun by-si (map iri) (find iri (topic-map-topics map) :test (lambda (iri topic) (member iri (topic-subject-identifiers topic) :test #'string=))))
45 (defun core (map name) (by-si map (concatenate 'string "http://psi.topicmaps.org/iso13250/model/" name)))
46 (defun condition-from (thunk) (handler-case (progn (funcall thunk) nil) (error (c) c)))
47 (defun rejection (name source class code)
48 (let ((c (condition-from (lambda () (deserialize-octets (bytes source) :document-iri *document* :source-key name)))))
49 (check (concatenate 'string name ":class") (typep c class))
50 (check (concatenate 'string name ":code") (eq code (error-code c)))
51 (check (concatenate 'string name ":context") (and (equal (error-document-iri c) *document*) (equal (error-source-key c) name)))
52 (check (concatenate 'string name ":position") (and (integerp (error-line c)) (plusp (error-line c))
53 (integerp (error-column c)) (not (minusp (error-column c)))))))
54 (defun public-state (map)
55 ;; Actual references are retained in the snapshot, not only equivalent XML.
56 (list (item-identifiers map)
57 (mapcar (lambda (topic) (list topic (topic-parent topic) (topic-item-identifiers topic)
58 (topic-subject-identifiers topic) (topic-subject-locators topic)
59 (topic-names topic) (topic-occurrences topic) (topic-roles-played topic))) (topic-map-topics map))
60 (mapcar (lambda (a) (list a (association-parent a) (association-type a) (association-scope a) (item-identifiers a)
61 (mapcar (lambda (r) (list r (association-role-parent r) (association-role-type r)
62 (association-role-player r) (item-identifiers r))) (association-roles a))))
63 (topic-map-associations map))))
64 (defun graph-checks (label map owner type)
65 (let* ((a (first (topic-map-associations map))) (roles (association-roles a))
66 (instance (find (core map "instance") roles :key #'association-role-type :test #'eq))
67 (type-role (find (core map "type") roles :key #'association-role-type :test #'eq)))
68 (check (concatenate 'string label ":counts") (and (= 5 (length (topic-map-topics map))) (= 1 (length (topic-map-associations map))) (= 2 (length roles))))
69 (check (concatenate 'string label ":map-parent-eq") (and (eq map (association-parent a)) (every (lambda (topic) (eq map (topic-parent topic))) (topic-map-topics map))))
70 (check (concatenate 'string label ":association-type-eq") (eq (association-type a) (core map "type-instance")))
71 (check (concatenate 'string label ":role-parent-eq") (every (lambda (role) (eq a (association-role-parent role))) roles))
72 (check (concatenate 'string label ":players-eq") (and (eq owner (association-role-player instance)) (eq type (association-role-player type-role))))
73 (check (concatenate 'string label ":roles-played-eq") (and (member instance (topic-roles-played owner) :test #'eq) (member type-role (topic-roles-played type) :test #'eq)))
74 (check (concatenate 'string label ":canonical-handles") (and (eq a (canonical-association a)) (every (lambda (r) (eq r (canonical-association-role r))) roles)))))
75
76 ;; Slice 21A's twenty successful, previously unregistered originals. Keep this
77 ;; explicit: similar filenames and .sub helpers are not additional contracts.
78 (defparameter *additional-originals*
79 '("itemid-duplicate" "itemid-fragment" "itemid-relative" "itemid"
80 "merge-itemid-with-types" "merge-itemid" "merge-subjid" "merge-subjloc"
81 "subjid-duplicate" "subjid-escaping" "subjid-escaping2" "subjid-fragment"
82 "subjid-relative" "subjid-sameas-itemid" "subjid"
83 "subjloc-duplicate" "subjloc-fragment" "subjloc-multiple" "subjloc-relative" "subjloc"))
84
85 (defun references-current-p (map)
86 (let ((topics (topic-map-topics map)) (associations (topic-map-associations map)))
87 (flet ((live (topic) (and (member topic topics :test #'eq) (eq topic (canonical-topic topic)))))
88 (and
89 (every (lambda (topic) (and (live topic) (eq map (topic-parent topic))
90 (every (lambda (role) (and (eq topic (association-role-player role))
91 (member (association-role-parent role) associations :test #'eq)
92 (member role (association-roles (association-role-parent role)) :test #'eq)))
93 (topic-roles-played topic)))) topics)
94 (every (lambda (a) (and (eq a (canonical-association a)) (eq map (association-parent a))
95 (live (association-type a)) (every #'live (association-scope a))
96 (every (lambda (role) (and (eq role (canonical-association-role role))
97 (eq a (association-role-parent role)) (live (association-role-type role))
98 (live (association-role-player role))
99 (member role (topic-roles-played (association-role-player role)) :test #'eq)))
100 (association-roles a)))) associations)))))
101
102 (defun same-identifiers-p (a b)
103 (and (= (length a) (length b)) (null (set-exclusive-or a b :test #'equal))))
104
105 (defun additional-model-checks (name map)
106 (let* ((topic (by-id map "topic"))
107 (ii (list (concatenate 'string *document* "#topic"))) (si nil) (sl nil)
108 (directory (subseq *document* 0 (1+ (position #\/ *document* :from-end t))))
109 (shared "http://example.org/#topic"))
110 (check (concatenate 'string name ":declared-topic-live-eq")
111 (and topic (eq topic (canonical-topic topic)) (member topic (topic-map-topics map) :test #'eq)))
112 (cond
113 ((equal name "itemid-fragment") (push (concatenate 'string *document* "#topic2") ii))
114 ((equal name "itemid-relative") (push (concatenate 'string directory "more-tests/test.xtm#topic") ii))
115 ((equal name "itemid") (push shared ii))
116 ((member name '("merge-itemid" "merge-itemid-with-types" "merge-subjid" "merge-subjloc") :test #'equal)
117 (push (concatenate 'string *document* "#topic2") ii)
118 (cond ((member name '("merge-itemid" "merge-itemid-with-types") :test #'equal) (push shared ii))
119 ((equal name "merge-subjid") (push shared si))
120 (t (push shared sl)))
121 (check (concatenate 'string name ":merged-declarations-eq") (eq topic (by-id map "topic2"))))
122 ((member name '("subjid-duplicate" "subjid-relative") :test #'equal)
123 (push (concatenate 'string directory "photo.jpg") si))
124 ((equal name "subjid-escaping") (push "http://example.org/test+folder/#topic" si))
125 ((equal name "subjid-escaping2") (push "http://example.org/test folder/#topic" si))
126 ((equal name "subjid-fragment") (push (concatenate 'string *document* "#topic") si))
127 ((equal name "subjid-sameas-itemid")
128 (push "http://psi.example.org/test" ii) (push "http://psi.example.org/test" si))
129 ((equal name "subjid") (push shared si))
130 ((member name '("subjloc-duplicate" "subjloc-relative") :test #'equal)
131 (push (concatenate 'string directory "photo.jpg") sl))
132 ((equal name "subjloc-fragment") (push (concatenate 'string *document* "#topic") sl))
133 ((equal name "subjloc-multiple") (setf sl (list shared "http://example.org/#subject")))
134 ((equal name "subjloc") (push shared sl)))
135 (check (concatenate 'string name ":exact-ii-set") (same-identifiers-p ii (topic-item-identifiers topic)))
136 (check (concatenate 'string name ":exact-si-set") (same-identifiers-p si (topic-subject-identifiers topic)))
137 (check (concatenate 'string name ":exact-sl-set") (same-identifiers-p sl (topic-subject-locators topic)))
138 (check (concatenate 'string name ":no-unrequested-statements-or-reification")
139 (and (null (item-identifiers map)) (null (item-reifier map))
140 (every (lambda (topic) (and (null (topic-names topic)) (null (topic-occurrences topic))
141 (null (topic-reified topic)))) (topic-map-topics map))))
142 (when (equal name "merge-itemid-with-types")
143 (dolist (type-id '("topictype1" "topictype2"))
144 (let* ((type (by-id map type-id))
145 (role (find type (loop for a in (topic-map-associations map) append (association-roles a))
146 :key #'association-role-player :test #'eq))
147 (a (and role (association-role-parent role))))
148 (check (concatenate 'string name ":forward-reference:" type-id)
149 (and type role (eq type (canonical-topic type))
150 (equal (list (concatenate 'string *document* "#" type-id)) (topic-item-identifiers type))
151 (eq (association-role-type role) (core map "type"))
152 (eq (association-type a) (core map "type-instance"))
153 (= 2 (length (association-roles a)))
154 (find-if (lambda (r) (and (eq topic (association-role-player r))
155 (eq (core map "instance") (association-role-type r)))) (association-roles a))))))
156 (dolist (core-id '("type" "instance" "type-instance"))
157 (check (concatenate 'string name ":core-no-extra-ii:" core-id)
158 (null (topic-item-identifiers (core map core-id))))))))
159
160 (defun original-condition-data (condition)
161 (when condition
162 (let ((code (cond ((typep condition 'topic-maps.xtm:xtm-error) (error-code condition))
163 ((typep condition 'item-identifier-error) (item-identifier-error-code condition)))))
164 (topic-maps.test-foundation::fields
165 "class" (string (type-of condition)) "code" (when code (string-downcase (string code)))
166 "message" (princ-to-string condition)))))
167
168 (defun record-original-result (case actual expected condition)
169 ;; No rejection (XML, XTM or TMDM) can satisfy a positive original contract.
170 (topic-maps.test-foundation:record-result case
171 (cond ((typep condition 'xtm-unsupported) :unsupported) (condition :execution-error)
172 ((equalp actual expected) :cxtm-match) (t :cxtm-mismatch))
173 :diagnostics (list (if condition (format nil "~A: ~A" (type-of condition) condition)
174 (format nil "Actual ~D bytes; original baseline ~D bytes." (length actual) (length expected))))))
175
176 (defun original-model-data (map)
177 (when map
178 (flet ((array (items) (coerce items 'vector))
179 (fields (&rest args) (apply #'topic-maps.test-foundation::fields args)))
180 (let ((topics (topic-map-topics map)))
181 (labels ((ref (topic) (1+ (position topic topics :test #'eq))))
182 (fields "topicCount" (length topics) "associationCount" (length (topic-map-associations map))
183 "canonicalParentsAndInverseReferences" (if (references-current-p map) :true :false)
184 "topics" (array (loop for topic in topics collect
185 (fields "ordinal" (ref topic) "itemIdentifiers" (array (topic-item-identifiers topic))
186 "subjectIdentifiers" (array (topic-subject-identifiers topic)) "subjectLocators" (array (topic-subject-locators topic)))))
187 "associations" (array (loop for a in (topic-map-associations map) collect
188 (fields "type" (ref (association-type a)) "roles" (array (loop for role in (association-roles a) collect
189 (fields "type" (ref (association-role-type role)) "player" (ref (association-role-player role))))))))))))))
190
191 (defun original-contracts ()
192 (setf *cases* nil *outputs* nil)
193 (dolist (name (append '("empty" "topic" "itemid-tm" "topic-type" "topic-type-duplicate" "merge-three-way") *additional-originals*))
194 (let* ((id (format nil "xtm2/in/~A.xtm" name))
195 (iri (concatenate 'string "https://xtm-tests.example.invalid/cd165b150176c1d6842b37be9cc9051b40d4996b/" id))
196 (source (corpus-path id)) (baseline (corpus-path (format nil "xtm2/baseline/~A.xtm.cxtm" name)))
197 (case (topic-maps.test-foundation:make-test-case :id id :category :valid :source-pathname source
198 :document-iri iri :expected-outcome :cxtm-equal :expected-baseline baseline
199 :clauses '("XTM 2.0 4.3-4.9,4.20" "TMDM 5.1-5.3,5.7-5.8,6,7.2" "CXTM 3.13,3.18,4")))
200 (raw (file-bytes source)) (raw-before (copy-seq raw))
201 (expected (file-bytes baseline)) (map nil) (actual nil) (condition nil) (before nil))
202 (push case *cases*)
203 (handler-case
204 (setf map (deserialize-octets raw :document-iri iri :source-key id)
205 before (public-state map)
206 actual (topic-maps.cxtm:canonicalize-octets map :base-locator iri))
207 (error (c) (setf condition c)))
208 (record-original-result case actual expected condition)
209 (push (list id actual expected (original-model-data map) (original-condition-data condition) (length raw)) *outputs*)
210 (when condition (error condition))
211 (check (concatenate 'string name ":original-byte-exact") (equalp actual expected))
212 (check (concatenate 'string name ":pure") (equal before (public-state map)))
213 (check (concatenate 'string name ":deterministic") (equalp actual (topic-maps.cxtm:canonicalize-octets map :base-locator iri)))
214 (check (concatenate 'string name ":repeat-pure") (equal before (public-state map)))
215 (check (concatenate 'string name ":topic-count") (= (length (topic-map-topics map))
216 (cond ((member name '("empty" "itemid-tm") :test #'equal) 0)
217 ((member name '("topic-type" "topic-type-duplicate") :test #'equal) 5)
218 ((equal name "merge-itemid-with-types") 6) (t 1))))
219 (check (concatenate 'string name ":association-count") (= (length (topic-map-associations map))
220 (cond ((member name '("topic-type" "topic-type-duplicate") :test #'equal) 1)
221 ((equal name "merge-itemid-with-types") 2) (t 0))))
222 (check (concatenate 'string name ":canonical-parent-and-inverse-eq") (references-current-p map))
223 (check (concatenate 'string name ":source-octets-preserved") (equalp raw raw-before))
224 (when (member name *additional-originals* :test #'equal)
225 (let* ((*document* iri)
226 (other (deserialize-octets raw :document-iri iri :source-key "different-provenance-only")))
227 (additional-model-checks name map)
228 (check (concatenate 'string name ":source-key-only-provenance")
229 (and (equalp (original-model-data map) (original-model-data other))
230 (equalp actual (topic-maps.cxtm:canonicalize-octets other :base-locator iri))))))
231 (when (equal name "topic")
232 (check "topic:actual-item-locator" (equal (topic-item-identifiers (first (topic-map-topics map))) (list (concatenate 'string iri "#topic")))))
233 (when (equal name "itemid-tm")
234 (check "map:actual-item-locator" (equal (item-identifiers map) (list (concatenate 'string iri "#the-topic-map")))))
235 (when (equal name "merge-three-way")
236 (check "merge:three-identifiers" (= 3 (length (topic-item-identifiers (first (topic-map-topics map)))))))
237 (when (member name '("topic-type" "topic-type-duplicate") :test #'equal)
238 (let ((*document* iri)) (graph-checks name map (by-id map "xtm") (by-id map "format"))))))
239 (setf *cases* (nreverse *cases*) *outputs* (nreverse *outputs*))
240 (check "originals:26-unique-case-records"
241 (and (= 26 (length *cases*))
242 (= 26 (length (remove-duplicates *cases* :key #'topic-maps.test-foundation:test-case-id :test #'equal))))))
243
244 (defun result-classification-tests ()
245 (flet ((case-record () (topic-maps.test-foundation:make-test-case
246 :id "local:classification-control" :category :valid :expected-outcome :cxtm-equal)))
247 (let* ((case (case-record)) (expected (third (first *outputs*))) (actual (copy-seq expected)))
248 (setf (aref actual 0) (logxor 1 (aref actual 0)))
249 (record-original-result case actual expected nil)
250 (check "classification:changed-actual-cxtm-is-fail"
251 (and (eq :fail (topic-maps.test-foundation:test-case-status case))
252 (eq :cxtm-mismatch (topic-maps.test-foundation:test-case-actual-outcome case)))))
253 (dolist (spec (list (list "xml" "<a><b></a>" 'xtm-xml-error :fail)
254 (list "xtm" (document "<topic id='2bad'/>") 'xtm-rejection :fail)
255 (list "tmdm" (document "<itemIdentity href='#a'/><topic id='a'/>") 'item-identifier-error :fail)
256 (list "unsupported" (document "<topic id='a'><name><value>N</value><variant><scope><topicRef href='#s'/></scope><resourceRef href='urn:excluded'/></variant></name></topic>") 'xtm-unsupported :unsupported)))
257 (let ((case (case-record))
258 (c (condition-from (lambda () (deserialize-octets (bytes (second spec)) :document-iri *document*)))))
259 (record-original-result case nil #() c)
260 (check (concatenate 'string "classification:" (first spec) ":never-positive-pass")
261 (and (typep c (third spec)) (eq (fourth spec) (topic-maps.test-foundation:test-case-status case))
262 (not (eq :cxtm-match (topic-maps.test-foundation:test-case-actual-outcome case)))))))))
263
264 (defun semantic-tests ()
265 (dolist (body '("<topic id='a'><instanceOf><topicRef href='#b'/></instanceOf></topic><topic id='b'/>"
266 "<topic id='b'/><topic id='a'><instanceOf><topicRef href='#b'/></instanceOf></topic>"))
267 (let ((map (read-body body)))
268 (graph-checks (if (search "id='b'/>" body :start2 0 :end2 (min 20 (length body))) "backward" "forward") map (by-id map "a") (by-id map "b"))))
269 (let* ((map (read-body "<topic id='type'><subjectIdentifier href='#si'/></topic><topic id='a'><instanceOf><topicRef href='#si'/></instanceOf></topic>"))
270 (type (by-id map "type")))
271 (graph-checks "si-hit" map (by-id map "a") type)
272 (check "si-hit:no-extra-ii" (equal (topic-item-identifiers type) (list (concatenate 'string *document* "#type")))))
273 (let* ((map (read-body "<topic id='a'><instanceOf><topicRef href='#si'/></instanceOf></topic><topic id='type'><subjectIdentifier href='#si'/></topic>"))
274 (type (by-id map "type")))
275 (graph-checks "forward-si" map (by-id map "a") type)
276 (check "forward-si:created-ii-retained" (= 2 (length (topic-item-identifiers type)))))
277 (let* ((map (read-body "<topic id='type'><itemIdentity href='#alias'/></topic><topic id='a'><instanceOf><topicRef href='#alias'/><topicRef href='#type'/></instanceOf></topic>"))
278 (type (by-id map "type")))
279 (graph-checks "ii-hit" map (by-id map "a") type)
280 (check "ii-hit:identifiers-unchanged" (= 2 (length (topic-item-identifiers type)))))
281 (let* ((map (make-topic-map)) (si (intern-topic map :subject-identifier (concatenate 'string *document* "#s")))
282 (hit (topic-maps.xtm::find-reference-topic map (concatenate 'string *document* "#s"))))
283 (check "direct-si:actual-eq" (eq si hit))
284 (check "direct-si:no-ii" (null (topic-item-identifiers si))))
285 ;; Retain the exact object produced by a forward reference, then deserialize
286 ;; a later declaration with the same reader operation in the same context.
287 (let* ((map (make-topic-map))
288 (old (topic-maps.xtm::find-reference-topic map (concatenate 'string *document* "#future")))
289 (other (intern-topic map :subject-identifier "urn:shared"))
290 (a (make-association map (core-topic-for-test map "type-instance")
291 (list (list (core-topic-for-test map "instance") old) (list (core-topic-for-test map "type") other))))
292 (role (find old (association-roles a) :key #'association-role-player :test #'eq)))
293 (let* ((topic-maps.xtm::*document-iri* *document*) (topic-maps.xtm::*source-key* "retained-forward")
294 (root (topic-maps.xml:parse-octets
295 (bytes (document "<topic id='future'><subjectIdentifier href='urn:shared'/></topic>"))
296 (make-instance 'topic-maps.xtm::source-handler))))
297 (topic-maps.xtm::validate-source root)
298 (topic-maps.xtm::read-topic (first (topic-maps.xtm::elements root)) map))
299 (check "retained:forward-handle-eq" (and (eq (canonical-topic old) (canonical-topic other)) (not (eq old (canonical-topic old)))))
300 (check "retained:role-player-canonical" (eq (association-role-player role) (canonical-topic old)))
301 (check "retained:role-parent-canonical" (eq (association-role-parent role) (canonical-association a)))
302 (let ((before (public-state map)) (pointer (topic-maps.tmdm::%topic-forward old)))
303 (topic-maps.cxtm:canonicalize map :base-locator *document*)
304 (check "retained:cxtm-does-not-mutate" (and (equal before (public-state map)) (eq pointer (topic-maps.tmdm::%topic-forward old))))))
305 (let ((a (read-body "<topic id='same'/>") ) (b (read-body "<topic id='same'/>" "https://other.example/map.xtm")))
306 (check "documents:distinct-object" (not (eq (first (topic-map-topics a)) (first (topic-map-topics b)))))
307 (check "documents:distinct-local-locators" (not (equal (topic-item-identifiers (first (topic-map-topics a))) (topic-item-identifiers (first (topic-map-topics b)))))))
308 (let ((map (read-body "<topic id='a'><subjectLocator href='resource'/><subjectIdentifier href='urn:subject'/><itemIdentity href='#alias'/></topic>")))
309 (check "identity:three-categories" (let ((topic (first (topic-map-topics map))))
310 (and (= 2 (length (topic-item-identifiers topic)))
311 (equal '("urn:subject") (topic-subject-identifiers topic))
312 (equal (list (concatenate 'string (subseq *document* 0 (1+ (position #\/ *document* :from-end t))) "resource")) (topic-subject-locators topic))))))
313 (let ((map (read-body "<topic id=' Ä水 '><subjectIdentifier href='http://example.org/%C3%A4/%F0%9F%A6%8A'/></topic>")))
314 (check "unicode:id-collapse" (by-id map "Ä水"))
315 (check "unicode:href-percent-utf8" (equal '("http://example.org/ä/🦊") (topic-subject-identifiers (first (topic-map-topics map))))))
316 (dolist (pair '(("../folder/./x#t" "https://example.test/folder/x#t")
317 ("#t" "https://example.test/a/map.xtm#t")
318 ("?q#t" "https://example.test/a/map.xtm?q#t")
319 ("http://EXAMPLE.test:80/a" "http://EXAMPLE.test:80/a")
320 ("http://example.test/a%20b#t" "http://example.test/a b#t")))
321 (let ((topic-maps.xtm::*document-iri* *document*) (topic-maps.xtm::*source-key* "iri-test"))
322 (check (concatenate 'string "iri:" (first pair))
323 (equal (topic-maps.xtm::resolve-iri (first pair) "https://example.test/a/map.xtm" nil) (second pair)))))
324 (let* ((source (document "<topic id='a'/><topic id='b'><instanceOf><topicRef href='#a'/></instanceOf></topic>"))
325 (one (read-body "<topic id='a'/><topic id='b'><instanceOf><topicRef href='#a'/></instanceOf></topic>"))
326 (two (read-body "<topic id='b'><instanceOf><topicRef href='#a'/></instanceOf></topic><topic id='a'/>")))
327 (check "order:canonical-independence" (equal (topic-maps.cxtm:canonicalize one :base-locator *document*) (topic-maps.cxtm:canonicalize two :base-locator *document*)))
328 (dolist (spec '((:utf-8 t "UTF-8") (:utf-16le t "UTF-16") (:utf-16be t "UTF-16")
329 (:utf-16le nil "UTF-16LE") (:utf-16be nil "UTF-16BE")))
330 (destructuring-bind (encoding bom label) spec
331 (let* ((xml (format nil "<?xml version='1.0' encoding='~A'?>~A" label source))
332 (map (deserialize-octets (bytes xml encoding bom) :document-iri *document*)))
333 (check (format nil "encoding:~A:~A" encoding bom) (equal (topic-maps.cxtm:canonicalize one :base-locator *document*) (topic-maps.cxtm:canonicalize map :base-locator *document*))))))))
334 (defun core-topic-for-test (map name)
335 (intern-topic map :subject-identifier (concatenate 'string "http://psi.topicmaps.org/iso13250/model/" name)))
336
337 (defun identity-cascade-tests ()
338 (let ((map (read-body "<topic id='a'><subjectIdentifier href='urn:one'/></topic><topic id='b'><subjectIdentifier href='urn:two'/></topic><topic id='c'><itemIdentity href='#a'/><subjectIdentifier href='urn:two'/></topic>")))
339 (check "transitive:mixed-identifiers-one-topic" (= 1 (length (topic-map-topics map))))
340 (check "transitive:three-ii-two-si" (let ((topic (first (topic-map-topics map))))
341 (and (= 3 (length (topic-item-identifiers topic))) (= 2 (length (topic-subject-identifiers topic)))))))
342 (let* ((map (read-body "<topic id='s'><subjectLocator href='#x'/></topic><topic id='a'><instanceOf><topicRef href='#x'/></instanceOf></topic>"))
343 (s (by-id map "s")) (x (by-id map "x")))
344 (check "reference:subject-locator-is-not-si-or-ii" (and s x (not (eq s x)) (= 6 (length (topic-map-topics map))))))
345 (let* ((map (make-topic-map)) (topic-maps.xtm::*document-iri* *document*)
346 (topic-maps.xtm::*source-key* "association-cascade")
347 (root (topic-maps.xml:parse-octets
348 (bytes (document "<topic id='a'><instanceOf><topicRef href='#t1'/><topicRef href='#t2'/></instanceOf></topic><topic id='t1'><itemIdentity href='#t2'/></topic>"))
349 (make-instance 'topic-maps.xtm::source-handler)))
350 (nodes (topic-maps.xtm::elements (topic-maps.xtm::validate-source root))))
351 (topic-maps.xtm::read-topic (first nodes) map)
352 (let* ((associations (topic-map-associations map))
353 (roles (loop for a in associations append (association-roles a)))
354 (old-type (by-id map "t2")))
355 (check "cascade:before-two-associations" (= 2 (length associations)))
356 (topic-maps.xtm::read-topic (second nodes) map)
357 (let ((a (first (topic-map-associations map))))
358 (check "cascade:after-one-association" (and (= 1 (length (topic-map-associations map))) (= 2 (length (association-roles a)))))
359 (check "cascade:retained-association-handles-eq" (every (lambda (old) (eq a (canonical-association old))) associations))
360 (check "cascade:retained-role-handles-eq" (every (lambda (r) (member (canonical-association-role r) (association-roles a) :test #'eq)) roles))
361 (check "cascade:stored-type-player-canonical" (every (lambda (r) (and (eq a (association-role-parent r))
362 (eq (association-role-type r) (canonical-topic (association-role-type r)))
363 (eq (association-role-player r) (canonical-topic (association-role-player r))))) (association-roles a)))
364 (check "cascade:retained-topic-handle-eq" (eq (canonical-topic old-type) (by-id map "t1")))
365 (let* ((handles (append associations roles (list old-type)))
366 (pointers (mapcar #'topic-maps.tmdm::canonical-item handles))
367 (before (public-state map)))
368 (topic-maps.cxtm:canonicalize map :base-locator *document*)
369 (check "cascade:all-handles-pure" (and (equal before (public-state map))
370 (every #'eq pointers (mapcar #'topic-maps.tmdm::canonical-item handles))))))))
371 (let* ((prefixed "<x:topicMap xmlns:x='http://www.topicmaps.org/xtm/' version='2.0'><x:topic id='a'/></x:topicMap>")
372 (source (bytes prefixed))
373 (a (deserialize-octets source :document-iri *document* :source-key "disk:a"))
374 (b (deserialize-octets source :document-iri *document* :source-key "memory:b")))
375 (check "namespace:prefix-equivalent" (by-id a "a"))
376 (check "source-key:not-topic-identity" (equal (topic-item-identifiers (by-id a "a")) (topic-item-identifiers (by-id b "a")))))
377 (let* ((map (read-body "<topic id='a'><instanceOf><topicRef href='https://external.example/map.xtm#unfetched'/></instanceOf></topic>"))
378 (type (find-if (lambda (topic) (member "https://external.example/map.xtm#unfetched" (topic-item-identifiers topic) :test #'equal)) (topic-map-topics map))))
379 (graph-checks "external-reference:no-retrieval" map (by-id map "a") type)))
380
381 (defun negative-tests ()
382 (dolist (spec '(("missing-id" "<topic/>" :missing-id)
383 ("invalid-id" "<topic id='2bad'/>" :invalid-id)
384 ("id-colon" "<topic id='a:b'/>" :invalid-id)
385 ("id-empty" "<topic id=''/>" :invalid-id)
386 ("id-spaces" "<topic id='a b'/>" :invalid-id)
387 ("duplicate-id" "<topic id='a'/><topic id=' a '/>" :duplicate-id)
388 ("unknown-attribute" "<topic id='a' other='v'/>" :unexpected-attribute)
389 ("qualified-attribute" "<topic xmlns:x='urn:x' x:id='a'/>" :unexpected-attribute)
390 ("unknown-element" "<topic id='a'><garbage/></topic>" :unexpected-element)
391 ("wrong-namespace-child" "<topic xmlns='urn:other' id='a'/>" :invalid-namespace)
392 ("topic-identity-order" "<topic id='a'><instanceOf><topicRef href='#b'/></instanceOf><itemIdentity href='#c'/></topic>" :element-order)
393 ("map-identity-order" "<topic id='a'/><itemIdentity href='#map'/>" :element-order)
394 ("instance-duplicate" "<topic id='a'><instanceOf><topicRef href='#b'/></instanceOf><instanceOf><topicRef href='#b'/></instanceOf></topic>" :duplicate-instance-of)
395 ("empty-instance" "<topic id='a'><instanceOf/></topic>" :empty-instance-of)
396 ("missing-href" "<topic id='a'><subjectIdentifier/></topic>" :missing-attribute)
397 ("nonempty-locator" "<topic id='a'><subjectIdentifier href='urn:s'><topic/></subjectIdentifier></topic>" :unexpected-child)
398 ("locator-text" "<topic id='a'><subjectIdentifier href='urn:s'>text</subjectIdentifier></topic>" :unexpected-text)
399 ("non-whitespace" "text" :unexpected-text)
400 ("no-ref-fragment" "<topic id='a'><instanceOf><topicRef href='other.xtm'/></instanceOf></topic>" :invalid-topic-ref)
401 ("bad-ref-fragment" "<topic id='a'><instanceOf><topicRef href='#2bad'/></instanceOf></topic>" :invalid-topic-ref)
402 ("empty-ref-fragment" "<topic id='a'><instanceOf><topicRef href='#'/></instanceOf></topic>" :invalid-topic-ref)
403 ("xpointer-ref" "<topic id='a'><instanceOf><topicRef href='#xpointer(a)'/></instanceOf></topic>" :invalid-topic-ref)
404 ("relative-colon" "<topic id='a'><subjectIdentifier href='1bad:subject'/></topic>" :invalid-iri)
405 ("decoded-control" "<topic id='a'><subjectIdentifier href='urn:%00'/></topic>" :invalid-iri)
406 ("bad-percent" "<topic id='a'><subjectIdentifier href='urn:%GG'/></topic>" :invalid-percent-escape)
407 ("bad-percent-utf8" "<topic id='a'><subjectIdentifier href='urn:%C3%28'/></topic>" :invalid-percent-utf8)
408 ("invalid-iri" "<topic id='a'><subjectIdentifier href='urn:a b'/></topic>" :invalid-iri)))
409 (rejection (first spec) (document (second spec)) 'xtm-rejection (third spec)))
410 (rejection "missing-version" "<topicMap xmlns='http://www.topicmaps.org/xtm/'/>" 'xtm-rejection :missing-attribute)
411 (rejection "version-21" "<topicMap xmlns='http://www.topicmaps.org/xtm/' version='2.1'/>" 'xtm-rejection :invalid-version)
412 (rejection "no-namespace" "<topicMap version='2.0'/>" 'xtm-rejection :invalid-namespace)
413 (rejection "namespace-10" "<topicMap xmlns='http://www.topicmaps.org/xtm/1.0/' version='2.0'/>" 'xtm-rejection :invalid-namespace)
414 (rejection "xml-misnested" "<a><b></a>" 'xtm-xml-error :xml-not-well-formed)
415 (rejection "xml-duplicate-attribute" "<topicMap version='2.0' version='2.0'/>" 'xtm-xml-error :xml-not-well-formed)
416 (rejection "xml-undeclared-prefix" "<x:topicMap/>" 'xtm-xml-error :xml-not-well-formed)
417 (dolist (body '("<!DOCTYPE topicMap>" "<!DOCTYPE topicMap SYSTEM 'file:///tmp/no-xtm-file'>"
418 "<!DOCTYPE topicMap SYSTEM 'http://127.0.0.1:9/no-xtm-network'>"
419 "<!DOCTYPE topicMap [<!ENTITY e SYSTEM 'file:///tmp/no-xtm-file'>]>"))
420 (rejection (concatenate 'string "doctype:" body) (concatenate 'string body (document "")) 'xtm-xml-error :doctype-forbidden))
421 (dolist (spec '(("unsupported-name-variant-resourceRef" "<topic id='a'><name><value>Name</value><variant><scope><topicRef href='#s'/></scope><resourceRef href='urn:excluded'/></variant></name></topic>" :unsupported-construct)
422 ("unsupported-occurrence" "<topic id='a'><occurrence><type><topicRef href='#t'/></type><resourceData>v</resourceData></occurrence></topic>" :unsupported-construct)
423 ("unsupported-association" "<association><type><topicRef href='#t'/></type><role><type><topicRef href='#r'/></type><topicRef href='#p'/></role></association>" :unsupported-construct)
424 ("unsupported-mergemap" "<mergeMap href='other.xtm'/>" :unsupported-construct)))
425 (rejection (first spec) (document (second spec)) 'xtm-unsupported (third spec)))
426 (rejection "unsupported-reifier" "<topicMap xmlns='http://www.topicmaps.org/xtm/' version='2.0' reifier='#r'/>" 'xtm-unsupported :reification)
427 (let ((c (condition-from (lambda () (read-body (format nil "~%~%<topic id='2bad'/>"))))))
428 (check "diagnostic:multiline-observed-position" (and (typep c 'xtm-rejection) (= 3 (error-line c)) (plusp (error-column c)))))
429 (dolist (iri '(nil "relative.xtm" "https://example.test/a#fragment"))
430 (let ((c (condition-from (lambda () (deserialize-octets (bytes (document "")) :document-iri iri :source-key "document")))))
431 (check (format nil "document-iri:~S" iri) (and (typep c 'xtm-rejection) (eq (error-code c) :invalid-document-iri)))))
432 (check "api:raw-bytes-required" (typep (condition-from (lambda () (deserialize-octets (document "") :document-iri *document*))) 'type-error))
433 (let* ((source "<itemIdentity href='#a'/><topic id='a'/>")
434 (c (condition-from (lambda () (read-body source)))))
435 (check "tmdm:identifier-conflict-not-xml-or-xtm" (and (typep c 'item-identifier-error) (not (typep c 'topic-maps.xtm:xtm-error))))
436 (check "tmdm:identifier-conflict-specific" (eq (item-identifier-error-code c) :duplicate-item-identifier)))
437 (let ((c (condition-from (lambda () (read-body "<topic id='a'><subjectIdentifier href='http://psi.topicmaps.org/iso13250/model/type'/><subjectIdentifier href='http://psi.topicmaps.org/iso13250/model/instance'/></topic>")))))
438 (check "tmdm:core-subject-conflict-preserved" (and (typep c 'core-subject-error) (eq :core-subject-conflict (core-subject-error-code c)))))
439 (dolist (bad '(#(195 40) #(192 175) #(226 130) #(237 160 128)))
440 (let ((c (condition-from (lambda () (deserialize-octets
441 (concatenate '(vector (unsigned-byte 8)) (bytes "<topicMap xmlns='http://www.topicmaps.org/xtm/' version='2.0'><topic id='a'><subjectIdentifier href='urn:")
442 (coerce bad '(vector (unsigned-byte 8))) (bytes "'/></topic></topicMap>")) :document-iri *document*)))))
443 (check (format nil "actual-reader:invalid-utf8:~S" bad) (and (typep c 'xtm-xml-error) (eq :xml-not-well-formed (error-code c))))))
444 ;; Astral Unicode in an href exercises the qualified UTF-16 decoder through
445 ;; the real XTM reader. No pre-decoding strings are accepted by its API.
446 (dolist (encoding '(:utf-16le :utf-16be))
447 (let ((map (deserialize-octets (bytes (document "<topic id='a'><subjectIdentifier href='urn:🦊'/></topic>") encoding t) :document-iri *document*)))
448 (check (format nil "actual-reader:astral-surrogate:~A" encoding) (by-si map "urn:🦊"))))
449 (dolist (bad '(#(0 216) #(0 220) #(0 216 65 0)))
450 (let ((c (condition-from (lambda ()
451 (deserialize-octets (concatenate '(vector (unsigned-byte 8))
452 (bytes "<r>" :utf-16le t) (coerce bad '(vector (unsigned-byte 8))) (bytes "</r>" :utf-16le)) :document-iri *document*)))))
453 (check (format nil "actual-reader:invalid-surrogate:~S" bad) (typep c 'xtm-xml-error))))
454 ;; Verify the required entry point is actually called exactly once and sees
455 ;; the original octet vector by EQ, not a reconstructed decoded XML string.
456 (let* ((original (symbol-function 'topic-maps.xml:parse-octets))
457 (source (bytes (document "<topic id='a'/>"))) (calls 0) (same nil))
458 (unwind-protect
459 (progn (setf (symbol-function 'topic-maps.xml:parse-octets)
460 (lambda (bytes handler) (incf calls) (setf same (eq source bytes)) (funcall original bytes handler)))
461 (deserialize-octets source :document-iri *document*)
462 (check "boundary:real-parse-octets-only-once" (and (= 1 calls) same)))
463 (setf (symbol-function 'topic-maps.xml:parse-octets) original))))
464
465 (defun helper-source-test ()
466 (let* ((id "ctm/in/mergemap-xtm.sub")
467 (iri (concatenate 'string "https://xtm-tests.example.invalid/cd165b150176c1d6842b37be9cc9051b40d4996b/" id))
468 (*document* iri) (map (deserialize-octets (file-bytes (corpus-path id)) :document-iri iri :source-key id)))
469 (graph-checks "direct-sub" map (by-id map "lars") (by-id map "person"))
470 (check "direct-sub:exact-lars-ii" (equal (list (concatenate 'string iri "#lars")) (topic-item-identifiers (by-id map "lars"))))
471 (check "direct-sub:exact-person-ii" (equal (list (concatenate 'string iri "#person")) (topic-item-identifiers (by-id map "person"))))
472 (check "direct-sub:no-names-occurrences" (every (lambda (topic) (and (null (topic-names topic)) (null (topic-occurrences topic)))) (topic-map-topics map)))
473 (setf *fixture* map)))
474
475 (defun run-tests ()
476 (setf *checks* nil *fixture* nil *negative-outputs* nil *negative-controls* nil *name-outputs* nil *name-controls* nil *scope-outputs* nil *scope-controls* nil *iid-outputs* nil *iid-controls* nil *variant-outputs* nil *variant-negative-outputs* nil *variant-controls* nil *variant-merge-outputs* nil)
477 (handler-case
478 (progn (original-contracts) (negative-original-controls) (negative-original-contracts)
479 (name-original-contracts) (name-tests) (scope-original-contracts) (scope-tests) (iid-original-contracts) (iid-tests) (variant-original-contracts) (variant-negative-original) (variant-tests) (variant-merge-original-contract) (result-classification-tests)
480 (semantic-tests) (identity-cascade-tests) (negative-tests) (helper-source-test))
481 (error (condition)
482 ;; Preserve the actual failed outcome before ASDF propagates the failure.
483 (let ((report (uiop:getenv "TOPIC_MAPS_XTM_REPORT")))
484 (when report (write-report report)))
485 (error condition)))
486 (check "checks:unique-test-names" (= (length *checks*) (length (remove-duplicates *checks* :test #'equal))))
487 (format t "XTM-SUMMARY ~D PASS 0 FAIL; ~D original CXTM PASS; ~D negative originals PASS; helper source PASS~%"
488 (length *checks*) (count :valid *cases* :key #'topic-maps.test-foundation:test-case-category)
489 (count :invalid *cases* :key #'topic-maps.test-foundation:test-case-category))
490 (length *checks*))
491
492 (defun write-report (pathname)
493 (let ((cases *cases*) (fixture *fixture*))
494 (flet ((fields (&rest args) (apply #'topic-maps.test-foundation::fields args))
495 (array (items) (coerce items 'vector)))
496 (with-open-file (out pathname :direction :output :if-exists :supersede :external-format :utf-8)
497 (topic-maps.test-foundation::emit-json-value
498 (fields "scope" "XTM 2.0 identity/Name/Scope/Item-Identity/Variant subset, 49 positive and eight cause-qualified negative original contracts; no CTM Mergemap integration"
499 "corpusCommit" "cd165b150176c1d6842b37be9cc9051b40d4996b"
500 "statuses" (fields "pass" (count :pass cases :key #'topic-maps.test-foundation:test-case-status)
501 "fail" (count :fail cases :key #'topic-maps.test-foundation:test-case-status)
502 "unsupported" (count :unsupported cases :key #'topic-maps.test-foundation:test-case-status)
503 "not-run" (count :not-run cases :key #'topic-maps.test-foundation:test-case-status))
504 "otherCorpusInputs" (fields "positiveUnexecuted" (- (length (directory (corpus-path "xtm2/in/*.xtm"))) (count :valid cases :key #'topic-maps.test-foundation:test-case-category))
505 "negativeUnregisteredUnexecuted" (- (length (directory (corpus-path "xtm2/invalid/*.xtm")))
506 (count :invalid cases :key #'topic-maps.test-foundation:test-case-category)))
507 "checks" (array (reverse *checks*))
508 "cases" (array (loop for case in cases collect
509 (fields "id" (topic-maps.test-foundation:test-case-id case)
510 "documentIRI" (topic-maps.test-foundation:test-case-document-iri case)
511 "status" (string-downcase (symbol-name (topic-maps.test-foundation:test-case-status case)))
512 "actualOutcome" (string-downcase (symbol-name (topic-maps.test-foundation:test-case-actual-outcome case)))
513 "diagnostics" (array (topic-maps.test-foundation:test-case-diagnostics case)))))
514 "helperSource" (fields "id" "ctm/in/mergemap-xtm.sub" "status" (if fixture "pass" "not-run") "topics" (when fixture (length (topic-map-topics fixture)))
515 "associations" (when fixture (length (topic-map-associations fixture))) "roles" 2
516 "ctmMergemapContract" "NOT-RUN; direct helper deserialization only")
517 "negativeOriginals" (array *negative-outputs*)
518 "negativeControls" (array *negative-controls*)
519 "nameOriginals" (array *name-outputs*)
520 "nameControls" (array *name-controls*)
521 "scopeOriginals" (array *scope-outputs*)
522 "scopeControls" (array *scope-controls*)
523 "nameItemIdentityOriginals" (array *iid-outputs*)
524 "nameItemIdentityControls" (array *iid-controls*)
525 "variantOriginals" (array *variant-outputs*)
526 "variantNegativeOriginals" (array *variant-negative-outputs*)
527 "variantControls" (array *variant-controls*)
528 "variantMergeOriginals" (array *variant-merge-outputs*)
529 "actualAndExpected" (array (loop for (id actual expected model condition source-length) in *outputs* collect
530 (fields "id" id "actual" (when actual (babel:octets-to-string actual :encoding :utf-8))
531 "expected" (babel:octets-to-string expected :encoding :utf-8) "byteLength" (when actual (length actual))
532 "expectedByteLength" (length expected) "sourceByteLength" source-length
533 "firstDifferentByte" (when actual (mismatch actual expected))
534 "model" model "condition" condition)))) out)
535 (terpri out)))))