;;; test-ol.el --- Tests for Org Links library -*- lexical-binding: t; -*- ;; Copyright (C) 2019 Nicolas Goaziou ;; Author: Nicolas Goaziou ;; This program 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. ;; This program 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 this program. If not, see . ;;; Code: ;;; Decode and Encode Links (ert-deftest test-ol/encode () "Test `org-link-encode' specifications." ;; Regural test. (should (string= "Foo%3A%42ar" (org-link-encode "Foo:Bar" '(?\: ?\B)))) ;; Encode an ASCII character. (should (string= "%5B" (org-link-encode "[" '(?\[)))) ;; Encode an ASCII control character. (should (string= "%09" (org-link-encode "\t" '(9)))) ;; Encode a Unicode multibyte character. (should (string= "%E2%82%AC" (org-link-encode "€" '(?\€))))) (ert-deftest test-ol/decode () "Test `org-link-decode' specifications." ;; Decode an ASCII character. (should (string= "[" (org-link-decode "%5B"))) ;; Decode an ASCII control character. (should (string= "\n" (org-link-decode "%0A"))) ;; Decode a Unicode multibyte character. (should (string= "€" (org-link-decode "%E2%82%AC")))) (ert-deftest test-ol/encode-url-with-escaped-char () "Encode and decode a URL that includes an encoded char." (should (string= "http://some.host.com/form?&id=blah%2Bblah25" (org-link-decode (org-link-encode "http://some.host.com/form?&id=blah%2Bblah25" '(?\s ?\[ ?\] ?%)))))) (ert-deftest test-ol/org-toggle-link-display () "Make sure that `org-toggle-link-display' is working. See https://github.com/yantar92/org/issues/4." (dolist (org-link-descriptive '(nil t)) (org-test-with-temp-text "* Org link test [[https://example.com][A link to a site]]" (dotimes (_ 2) (goto-char 1) (re-search-forward "\\[") (should-not (org-xor org-link-descriptive (org-invisible-p))) (re-search-forward "example") (should-not (org-xor org-link-descriptive (org-invisible-p))) (re-search-forward "com") (should-not (org-xor org-link-descriptive (org-invisible-p))) (re-search-forward "]") (should-not (org-xor org-link-descriptive (org-invisible-p))) (re-search-forward "\\[") (should-not (org-invisible-p)) (re-search-forward "link") (should-not (org-invisible-p)) (re-search-forward "]") (should-not (org-xor org-link-descriptive (org-invisible-p))) (org-toggle-link-display))))) ;;; Escape and Unescape Links (ert-deftest test-ol/escape () "Test `org-link-escape' specifications." ;; No-op when there is no backslash or square bracket. (should (string= "foo" (org-link-escape "foo"))) ;; Escape square brackets at boundaries of the link. (should (string= "\\[foo\\]" (org-link-escape "[foo]"))) ;; Escape square brackets followed by another square bracket. (should (string= "foo\\]\\[bar" (org-link-escape "foo][bar"))) (should (string= "foo\\]\\]bar" (org-link-escape "foo]]bar"))) (should (string= "foo\\[\\[bar" (org-link-escape "foo[[bar"))) (should (string= "foo\\[\\]bar" (org-link-escape "foo[]bar"))) ;; Escape backslashes at the end of the link. (should (string= "foo\\\\" (org-link-escape "foo\\"))) ;; Escape backslashes that could be confused with escaping ;; characters. (should (string= "foo\\\\\\]" (org-link-escape "foo\\]"))) (should (string= "foo\\\\\\]\\[" (org-link-escape "foo\\]["))) (should (string= "foo\\\\\\]\\]bar" (org-link-escape "foo\\]]bar"))) ;; Do not escape backslash characters when unnecessary. (should (string= "foo\\bar" (org-link-escape "foo\\bar"))) ;; Pathological cases: consecutive closing square brackets. (should (string= "\\[\\[\\[foo\\]\\]\\]" (org-link-escape "[[[foo]]]"))) (should (string= "\\[\\[foo\\]\\] bar" (org-link-escape "[[foo]] bar")))) (ert-deftest test-ol/unescape () "Test `org-link-unescape' specifications." ;; No-op if there is no backslash. (should (string= "foo" (org-link-unescape "foo"))) ;; No-op if backslashes are not escaping backslashes. (should (string= "foo\\bar" (org-link-unescape "foo\\bar"))) ;; Unescape backslashes before square brackets. (should (string= "foo]bar" (org-link-unescape "foo\\]bar"))) (should (string= "foo\\]" (org-link-unescape "foo\\\\\\]"))) (should (string= "foo\\][" (org-link-unescape "foo\\\\\\]["))) (should (string= "foo\\]]bar" (org-link-unescape "foo\\\\\\]\\]bar"))) (should (string= "foo\\[[bar" (org-link-unescape "foo\\\\\\[\\[bar"))) (should (string= "foo\\[]bar" (org-link-unescape "foo\\\\\\[\\]bar"))) ;; Unescape backslashes at the end of the link. (should (string= "foo\\" (org-link-unescape "foo\\\\"))) ;; Unescape closing square bracket at boundaries of the link. (should (string= "[foo]" (org-link-unescape "\\[foo\\]"))) ;; Pathological cases: consecutive closing square brackets. (should (string= "[[[foo]]]" (org-link-unescape "\\[\\[\\[foo\\]\\]\\]"))) (should (string= "[[foo]] bar" (org-link-unescape "\\[\\[foo\\]\\] bar")))) (ert-deftest test-ol/make-string () "Test `org-link-make-string' specifications." ;; Throw an error on empty URI. (should-error (org-link-make-string "")) ;; Empty description returns a [[URI]] construct. (should (string= "[[uri]]"(org-link-make-string "uri"))) ;; Non-empty description returns a [[URI][DESCRIPTION]] construct. (should (string= "[[uri][description]]" (org-link-make-string "uri" "description"))) ;; Escape "]]" strings in the description with zero-width spaces. (should (let ((zws (string ?\x200B))) (string= (format "[[uri][foo]%s]bar]]" zws) (org-link-make-string "uri" "foo]]bar")))) ;; Prevent description from ending with a closing square bracket ;; with a zero-width space. (should (let ((zws (string ?\x200B))) (string= (format "[[uri][foo]%s]]" zws) (org-link-make-string "uri" "foo]"))))) ;;; Store links (ert-deftest test-ol/store-link () "Test `org-store-link' specifications." ;; On a headline, link to that headline. Use heading as the ;; description of the link. (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "* H1" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*H1][H1]]" file) (org-store-link nil)))))) ;; On a headline, remove TODO and COMMENT keywords, priority cookie, ;; and tags. (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "* TODO H1" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*H1][H1]]" file) (org-store-link nil)))))) (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "* COMMENT H1" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*H1][H1]]" file) (org-store-link nil)))))) (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "* [#A] H1" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*H1][H1]]" file) (org-store-link nil)))))) (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "* H1 :tag:" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*H1][H1]]" file) (org-store-link nil)))))) ;; On a headline, remove any link from description. (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "* [[#l][d]]" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*%s][d]]" file (org-link-escape "[[#l][d]]")) (org-store-link nil)))))) (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "* [[l]]" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*%s][l]]" file (org-link-escape "[[l]]")) (org-store-link nil)))))) (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "* [[l1][d1]] [[l2][d2]]" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*%s][d1 d2]]" file (org-link-escape "[[l1][d1]] [[l2][d2]]")) (org-store-link nil)))))) ;; On a named element, link to that element. (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "#+NAME: foo\nParagraph" (let ((file (buffer-file-name))) (equal (format "[[file:%s::foo][foo]]" file) (org-store-link nil)))))) ;; Store link to Org buffer, with context. (should (let ((org-stored-links nil) (org-id-link-to-org-use-id nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "* h1" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*h1][h1]]" file) (org-store-link nil)))))) ;; Store link to Org buffer, without context. (should (let ((org-stored-links nil) (org-id-link-to-org-use-id nil) (org-context-in-file-links nil)) (org-test-with-temp-text-in-file "* h1" (let ((file (buffer-file-name))) (equal (format "[[file:%s][file:%s]]" file file) (org-store-link nil)))))) ;; C-u prefix reverses `org-context-in-file-links' in Org buffer. (should (let ((org-stored-links nil) (org-id-link-to-org-use-id nil) (org-context-in-file-links nil)) (org-test-with-temp-text-in-file "* h1" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*h1][h1]]" file) (org-store-link '(4))))))) ;; A C-u C-u does *not* reverse `org-context-in-file-links' in Org ;; buffer. (should (let ((org-stored-links nil) (org-id-link-to-org-use-id nil) (org-context-in-file-links nil)) (org-test-with-temp-text-in-file "* h1" (let ((file (buffer-file-name))) (equal (format "[[file:%s][file:%s]]" file file) (org-store-link '(16))))))) ;; Store file link to non-Org buffer, with context. (should (let ((org-stored-links nil) (org-link-context-for-files t)) (org-test-with-temp-text-in-file "one\ntwo" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file) (org-store-link nil)))))) ;; Store file link to non-Org buffer, without context. (should (let ((org-stored-links nil) (org-context-in-file-links nil)) (org-test-with-temp-text-in-file "one\ntwo" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s][file:%s]]" file file) (org-store-link nil)))))) ;; C-u prefix reverses `org-context-in-file-links' in non-Org ;; buffer. (should (let ((org-stored-links nil) (org-link-context-for-files nil)) (org-test-with-temp-text-in-file "one\ntwo" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file) (org-store-link '(4))))))) ;; A C-u C-u does *not* reverse `org-context-in-file-links' in ;; non-Org buffer. (should (let ((org-stored-links nil) (org-context-in-file-links nil)) (org-test-with-temp-text-in-file "one\ntwo" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s][file:%s]]" file file) (org-store-link '(16))))))) ;; Context does not include special search syntax. (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "(two)" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file file) (org-store-link nil)))))) (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "# two" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file file) (org-store-link nil)))))) (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "*two" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file file) (org-store-link nil)))))) (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "( two )" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file file) (org-store-link nil)))))) (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "# two" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file file) (org-store-link nil)))))) (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "#( two )" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file file) (org-store-link nil)))))) (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "#** ((## two) )" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file file) (org-store-link nil)))))) (should-not (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "(two" (fundamental-mode) (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file file) (org-store-link nil)))))) ;; Context also ignore statistics cookies and special headlines ;; data. (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "* TODO [#A] COMMENT foo :bar:" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*foo][foo]]" file file) (org-store-link nil)))))) (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "* foo[33%]bar" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*foo bar][foo bar]]" file file) (org-store-link nil)))))) (should (let ((org-stored-links nil) (org-context-in-file-links t)) (org-test-with-temp-text-in-file "* [%][/] foo [35%] bar[3/5]" (let ((file (buffer-file-name))) (equal (format "[[file:%s::*foo bar][foo bar]]" file file) (org-store-link nil))))))) ;;; Radio Targets (ert-deftest test-ol/update-radio-target-regexp () "Test `org-update-radio-target-regexp' specifications." ;; Properly update cache with no previous radio target regexp. (should (eq 'link (org-test-with-temp-text "radio\n\nParagraph\n\nradio" (save-excursion (goto-char (point-max)) (org-element-context)) (insert "<<<") (search-forward "o") (insert ">>>") (org-update-radio-target-regexp) (goto-char (point-max)) (org-element-type (org-element-context))))) ;; Properly update cache with previous radio target regexp. (should (eq 'link (org-test-with-temp-text "radio\n\nParagraph\n\nradio" (save-excursion (goto-char (point-max)) (org-element-context)) (insert "<<<") (search-forward "o") (insert ">>>") (org-update-radio-target-regexp) (search-backward "r") (delete-char 5) (insert "new") (org-update-radio-target-regexp) (goto-char (point-max)) (delete-region (line-beginning-position) (point)) (insert "new") (org-element-type (org-element-context)))))) ;;; Navigation (ert-deftest test-ol/next-link () "Test `org-next-link' specifications." ;; Move to any type of link. (should (equal "[[link]]" (org-test-with-temp-text "foo [[link]]" (org-next-link) (buffer-substring (point) (line-end-position))))) (should (equal "http://link" (org-test-with-temp-text "foo http://link" (org-next-link) (buffer-substring (point) (line-end-position))))) (should (equal "" (org-test-with-temp-text "foo " (org-next-link) (buffer-substring (point) (line-end-position))))) ;; Ignore link at point. (should (equal "[[link2]]" (org-test-with-temp-text "[[link1]] [[link2]]" (org-next-link) (buffer-substring (point) (line-end-position))))) ;; Ignore fake links. (should (equal "[[truelink]]" (org-test-with-temp-text "foo\n: [[link]]\n[[truelink]]" (org-next-link) (buffer-substring (point) (line-end-position))))) ;; Do not move point when there is no link. (should (org-test-with-temp-text "foo bar" (org-next-link) (bobp))) ;; Wrap around after a failed search. (should (equal "[[link]]" (org-test-with-temp-text "[[link]]\nfoo" (org-next-link) (let* ((this-command 'org-next-link) (last-command this-command)) (org-next-link)) (buffer-substring (point) (line-end-position))))) ;; Find links with item tags. (should (equal "[[link1]]" (org-test-with-temp-text "- tag [[link1]] :: description" (org-next-link) (buffer-substring (point) (search-forward "]]" nil t)))))) (ert-deftest test-ol/previous-link () "Test `org-previous-link' specifications." ;; Move to any type of link. (should (equal "[[link]]" (org-test-with-temp-text "[[link]]\nfoo" (org-previous-link) (buffer-substring (point) (line-end-position))))) (should (equal "http://link" (org-test-with-temp-text "http://link\nfoo" (org-previous-link) (buffer-substring (point) (line-end-position))))) (should (equal "" (org-test-with-temp-text "\nfoo" (org-previous-link) (buffer-substring (point) (line-end-position))))) ;; Ignore link at point. (should (equal "[[link1]]" (org-test-with-temp-text "[[link1]]\n[[link2]]" (org-previous-link) (buffer-substring (point) (line-end-position))))) (should (equal "[[link1]]" (org-test-with-temp-text "line\n[[link1]]\n[[link2]]" (org-previous-link) (buffer-substring (point) (line-end-position))))) ;; Ignore fake links. (should (equal "[[truelink]]" (org-test-with-temp-text "[[truelink]]\n: [[link]]\n" (org-previous-link) (buffer-substring (point) (line-end-position))))) ;; Do not move point when there is no link. (should (org-test-with-temp-text "foo bar" (org-previous-link) (eobp))) ;; Wrap around after a failed search. (should (equal "[[link]]" (org-test-with-temp-text "foo\n[[link]]" (org-previous-link) (let* ((this-command 'org-previous-link) (last-command this-command)) (org-previous-link)) (buffer-substring (point) (line-end-position)))))) ;;; Link regexps (defmacro test-ol-parse-link-in-text (text) "Return list of :type and :path of link parsed in TEXT. \"\" string must be at the beginning of the link to be parsed." (declare (indent 1)) `(org-test-with-temp-text ,text (list (org-element-property :type (org-element-link-parser)) (org-element-property :path (org-element-link-parser))))) (ert-deftest test-ol/plain-link-re () "Test `org-link-plain-re'." (should (equal '("https" "//example.com") (test-ol-parse-link-in-text "(https://example.com)"))) (should (equal '("https" "//example.com/qwe()") (test-ol-parse-link-in-text "(Some text https://example.com/qwe())"))) (should (equal '("https" "//doi.org/10.1016/0160-791x(79)90023-x") (test-ol-parse-link-in-text "https://doi.org/10.1016/0160-791x(79)90023-x"))) (should (equal '("file" "aa") (test-ol-parse-link-in-text "The file:aa link"))) (should (equal '("file" "a(b)c") (test-ol-parse-link-in-text "The file:a(b)c link"))) (should (equal '("file" "a()") (test-ol-parse-link-in-text "The file:a() link"))) (should (equal '("file" "aa((a))") (test-ol-parse-link-in-text "The file:aa((a)) link"))) (should (equal '("file" "aa(())") (test-ol-parse-link-in-text "The file:aa(()) link"))) (should (equal '("file" "/a") (test-ol-parse-link-in-text "The file:/a link"))) (should (equal '("file" "/a/") (test-ol-parse-link-in-text "The file:/a/ link"))) (should (equal '("http" "//") (test-ol-parse-link-in-text "The http:// link"))) (should (equal '("file" "ab") (test-ol-parse-link-in-text "The (some file:ab) link"))) (should (equal '("file" "aa") (test-ol-parse-link-in-text "The file:aa) link"))) (should (equal '("file" "aa") (test-ol-parse-link-in-text "The file:aa( link"))) (should (equal '("http" "//foo.com/more_(than)_one_(parens)") (test-ol-parse-link-in-text "The http://foo.com/more_(than)_one_(parens) link"))) (should (equal '("http" "//foo.com/blah_(wikipedia)#cite-1") (test-ol-parse-link-in-text "The http://foo.com/blah_(wikipedia)#cite-1 link"))) (should (equal '("http" "//foo.com/blah_(wikipedia)_blah#cite-1") (test-ol-parse-link-in-text "The http://foo.com/blah_(wikipedia)_blah#cite-1 link"))) (should (equal '("http" "//foo.com/unicode_(✪)_in_parens") (test-ol-parse-link-in-text "The http://foo.com/unicode_(✪)_in_parens link"))) (should (equal '("http" "//foo.com/(something)?after=parens") (test-ol-parse-link-in-text "The http://foo.com/(something)?after=parens link")))) (provide 'test-ol) ;;; test-ol.el ends here