emacs/test/lisp/nxml/nxml-mode-tests.el

;;; nxml-mode-tests.el --- Test NXML Mode -*- lexical-binding: t; -*-

;; Copyright (C) 2019-2024 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/>.

;;; Code:

(require 'ert)
(require 'nxml-mode)

(defun nxml-mode-tests-correctly-indented-string (str)
  (with-temp-buffer
    (nxml-mode)
    (insert str)
    (indent-region (point-min) (point-max))
    (equal (buffer-string) str)))

(ert-deftest nxml-indent-line-after-attribute ()
  (should (nxml-mode-tests-correctly-indented-string "
<settings
    xmlns=\"http://maven.apache.org/SETTINGS/1.0.0\"
    xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"
    xsi:schemaLocation=\"http://maven.apache.org/SETTINGS/1.0.0
                        https://maven.apache.org/xsd/settings-1.0.0.xsd\">
  <mirrors>
    ...
  </mirrors>
</settings>
"))
  (should (nxml-mode-tests-correctly-indented-string "\
<x>
  <abc xx=\"x/x/x/x/x/x/x/
           y/y/y/y/y/y/
           \">
    <zzz/>
  </abc>
  <nl>&#10;</nl>
</x>
")))

(ert-deftest nxml-balanced-close-start-tag-inline ()
  (with-temp-buffer
    (nxml-mode)
    (insert "<a><b c=\"\"</a>")
    (search-backward "</a>")
    (nxml-balanced-close-start-tag-inline)
    (should (equal (buffer-string) "<a><b c=\"\"></b></a>"))))

(ert-deftest nxml-mode-font-lock-quotes ()
  (with-temp-buffer
    (nxml-mode)
    (insert "<x a=\"dquote attr\" b='squote attr'>\"dquote text\"'squote text'</x>")
    (font-lock-ensure)
    (let ((squote-txt-pos (search-backward "squote text"))
          (dquote-txt-pos (search-backward "dquote text"))
          (squote-att-pos (search-backward "squote attr"))
          (dquote-att-pos (search-backward "dquote attr")))
      ;; Just make sure that each quote uses the same face for quoted
      ;; attribute values, and a different face for quoted text
      ;; outside tags.  Don't test `font-lock-string-face' vs
      ;; `nxml-attribute-value' here.
      (should (equal (get-text-property squote-att-pos 'face)
                     (get-text-property dquote-att-pos 'face)))
      (should (equal (get-text-property squote-txt-pos 'face)
                     (get-text-property dquote-txt-pos 'face)))
      (should-not (equal (get-text-property squote-txt-pos 'face)
                         (get-text-property dquote-att-pos 'face))))))

(ert-deftest nxml-mode-doctype-and-quote-syntax ()
  (with-temp-buffer
    (insert "<!DOCTYPE t [\n<!ENTITY f SYSTEM \"f.xml\">\n]>\n<t>'</t>")
    (nxml-mode)
    ;; Check that last tag is parsed as a tag.
    (should (= 1 (car (syntax-ppss (1- (point-max))))))
    (should (= 0 (car (syntax-ppss (point-max)))))))

(ert-deftest nxml-mode-prolog-comment ()
  (with-temp-buffer
    (insert "<?xml version=\"1.0\" encoding=\"utf-8\"?><!-- comment1 -->
<t><!-- comment2 --></t><!-- comment3 -->")
    (nxml-mode)
    ;; Check that all comments are parsed as comments
    (goto-char (point-min))
    (search-forward "comment1")
    (should (nth 4 (syntax-ppss)))
    (search-forward "comment2")
    (should (nth 4 (syntax-ppss)))
    (search-forward "comment3")))

(ert-deftest nxml-mode->-after-quote ()
  "Reduction from Bug#36092."
  (with-temp-buffer
    (insert "<root>\n"
            (make-string 1794 ?a) "\n"
            "'>"
            (make-string 196 ?a) "\n"
            "</root>")
    (nxml-mode)
    (syntax-propertize 2001)
    (syntax-propertize (point-max))     ; Triggered an assert failure.
    ;; Check that last tag is parsed as a tag.
    (should (= 1 (- (car (syntax-ppss (1- (point-max))))
                    (car (syntax-ppss (point-max))))))))

(ert-deftest nxml-mode-edit-prolog ()
  "Test for Bug#23668."
  (with-temp-buffer
    (insert "
 <t>
 <sub/>
</t>")
    (nxml-mode)
    ;; The leading "\n " before "<t>" is the prolog, indenting will
    ;; delete the space hence changing the prolog size.  If that is
    ;; not taken into account, then the <sub/> tag won't be indented
    ;; correctly.
    (indent-region (point-min) (point-max))
    (should (equal (buffer-string) "
<t>
  <sub/>
</t>"))))

(ert-deftest nxml-mode-test-comment-bug-17264 ()
  "Test for Bug#17264."
  (with-temp-buffer
    (nxml-mode)
    (let ((data "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<spocosy version=\"1.0\" responsetime=\"2011-03-15 13:53:12\" exec=\"0.171\">
  <!--
      <query-response requestid=\"\" service=\"objectquery\">
      <sport name=\"Soccer\" enetSportCode=\"s\" del=\"no\" n=\"1\" ut=\"2009-12-29
      15:36:24\" id=\"1\">
      </sport>
      </query-response>
  -->
</spocosy>
"))
      (insert data)
      (goto-char (point-min))
      (search-forward "<query-response")
      ;; Inside comment
      (should (eq (nth 4 (syntax-ppss)) t)))))

(provide 'nxml-mode-tests)
;;; nxml-mode-tests.el ends here