testing/lisp/test-org-export.el

   1 ;;; test-org-export.el --- Tests for org-export.el
   2
   3 ;; Copyright (C) 2012  Nicolas Goaziou
   4
   5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
   6
   7 ;; Released under the GNU General Public License version 3
   8 ;; see: http://www.gnu.org/licenses/gpl-3.0.html
   9
  10 ;;;; Comments
  11
  12
  13 \f
  14 ;;; Code:
  15
  16 (unless (featurep 'org-export)
  17   (signal 'missing-test-dependency "org-export"))
  18
  19
  20 \f
  21 ;;; Tests
  22
  23 (defmacro org-test-with-backend (backend &rest body)
  24   "Execute body with an export back-end defined.
  25
  26 BACKEND is the name, as a string, of the back-end.  BODY is the
  27 body to execute.  The defined back-end simply returns parsed data
  28 as Org syntax."
  29   (declare (debug (form body)) (indent 1))
  30   `(flet ,(let (transcoders)
  31             (dolist (type (append org-element-all-elements
  32                                   org-element-all-objects)
  33                           transcoders)
  34               (push `(,(intern (format "org-%s-%s" backend type))
  35                       (obj contents info)
  36                       (,(intern (format "org-element-%s-interpreter" type))
  37                        obj contents))
  38                     transcoders)))
  39      ,@body))
  40
  41 (ert-deftest test-org-export/parse-option-keyword ()
  42   "Test reading all standard #+OPTIONS: items."
  43   (should
  44    (equal
  45     (org-export-parse-option-keyword
  46      "H:1 num:t \\n:t timestamp:t arch:t author:t creator:t d:t email:t
  47  *:t e:t ::t f:t pri:t -:t ^:t toc:t |:t tags:t tasks:t <:t todo:t")
  48     '(:headline-levels
  49       1 :preserve-breaks t :section-numbers t :time-stamp-file t
  50       :with-archived-trees t :with-author t :with-creator t :with-drawers t
  51       :with-email t :with-emphasize t :with-entities t :with-fixed-width t
  52       :with-footnotes t :with-priority t :with-special-strings t
  53       :with-sub-superscript t :with-toc t :with-tables t :with-tags t
  54       :with-tasks t :with-timestamps t :with-todo-keywords t)))
  55   ;; Test some special values.
  56   (should
  57    (equal
  58     (org-export-parse-option-keyword
  59      "arch:headline creator:comment d:(\"TEST\")
  60  ^:{} toc:1 tags:not-in-toc tasks:todo num:2")
  61     '( :section-numbers
  62        2
  63        :with-archived-trees headline :with-creator comment
  64        :with-drawers ("TEST") :with-sub-superscript {} :with-toc 1
  65        :with-tags not-in-toc :with-tasks todo))))
  66
  67 (ert-deftest test-org-export/get-inbuffer-options ()
  68   "Test reading all standard export keywords."
  69   (should
  70    (equal
  71     (org-test-with-temp-text "#+AUTHOR: Me, Myself and I
  72 #+CREATOR: Idem
  73 #+DATE: Today
  74 #+DESCRIPTION: Testing
  75 #+DESCRIPTION: with two lines
  76 #+EMAIL: some@email.org
  77 #+EXPORT_EXCLUDE_TAGS: noexport invisible
  78 #+KEYWORDS: test
  79 #+LANGUAGE: en
  80 #+EXPORT_SELECT_TAGS: export
  81 #+TITLE: Some title
  82 #+TITLE: with spaces"
  83       (org-export-get-inbuffer-options))
  84     '(:author
  85       "Me, Myself and I" :creator "Idem" :date "Today"
  86       :description "Testing\nwith two lines" :email "some@email.org"
  87       :exclude-tags ("noexport" "invisible") :keywords "test" :language "en"
  88       :select-tags ("export") :title "Some title with spaces"))))
  89
  90 (ert-deftest test-org-export/define-macro ()
  91   "Try defining various Org macro using in-buffer #+MACRO: keyword."
  92   ;; Parsed macro.
  93   (should (equal (org-test-with-temp-text "#+MACRO: one 1"
  94                    (org-export-get-inbuffer-options))
  95                  '(:macro-one ("1"))))
  96   ;; Evaled macro.
  97   (should (equal (org-test-with-temp-text "#+MACRO: two (eval (+ 1 1))"
  98                    (org-export-get-inbuffer-options))
  99                  '(:macro-two "(eval (+ 1 1))")))
 100   ;; Incomplete macro.
 101   (should-not (org-test-with-temp-text "#+MACRO: three"
 102                 (org-export-get-inbuffer-options)))
 103   ;; Macro with newline character.
 104   (should (equal (org-test-with-temp-text "#+MACRO: four a\\nb"
 105                    (org-export-get-inbuffer-options))
 106                  '(:macro-four ("a\nb"))))
 107   ;; Macro with protected newline character.
 108   (should (equal (org-test-with-temp-text "#+MACRO: five a\\\\nb"
 109                    (org-export-get-inbuffer-options))
 110                  '(:macro-five ("a\\nb"))))
 111   ;; Recursive macro.
 112   (org-test-with-temp-text "#+MACRO: six 6\n#+MACRO: seven 1 + {{{six}}}"
 113     (should
 114      (equal
 115       (org-export-get-inbuffer-options)
 116       '(:macro-six
 117         ("6")
 118         :macro-seven
 119         ("1 + " (macro (:key "six" :value "{{{six}}}" :args nil :begin 5 :end 14
 120                              :post-blank 0))))))))
 121
 122 (ert-deftest test-org-export/handle-options ()
 123   "Test if export options have an impact on output."
 124   ;; Test exclude tags.
 125   (org-test-with-temp-text "* Head1 :noexport:"
 126     (org-test-with-backend "test"
 127       (should
 128        (equal (org-export-as 'test nil nil nil '(:exclude-tags ("noexport")))
 129               ""))))
 130   ;; Test include tags.
 131   (org-test-with-temp-text "
 132 * Head1
 133 ** Sub-Head1.1 :export:
 134 *** Sub-Head1.1.1
 135 * Head2"
 136     (org-test-with-backend "test"
 137       (should
 138        (string-match
 139         "\\* Head1\n\\*\\* Sub-Head1.1[ \t]+:export:\n\\*\\*\\* Sub-Head1.1.1\n"
 140         (org-export-as 'test nil nil nil '(:select-tags ("export")))))))
 141   ;; Test mixing include tags and exclude tags.
 142   (org-test-with-temp-text "
 143 * Head1 :export:
 144 ** Sub-Head1 :noexport:
 145 ** Sub-Head2
 146 * Head2 :noexport:
 147 ** Sub-Head1 :export:"
 148     (org-test-with-backend "test"
 149       (should
 150        (string-match
 151         "\\* Head1[ \t]+:export:\n\\*\\* Sub-Head2\n"
 152         (org-export-as
 153          'test nil nil nil
 154          '(:select-tags ("export") :exclude-tags ("noexport")))))))
 155   ;; Ignore tasks.
 156   (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
 157     (org-test-with-temp-text "* TODO Head1"
 158       (org-test-with-backend "test"
 159         (should (equal (org-export-as 'test nil nil nil '(:with-tasks nil))
 160                        "")))))
 161   (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
 162     (org-test-with-temp-text "* TODO Head1"
 163       (org-test-with-backend "test"
 164         (should (equal (org-export-as 'test nil nil nil '(:with-tasks t))
 165                        "* TODO Head1\n")))))
 166   ;; Archived tree.
 167   (org-test-with-temp-text "* Head1 :archive:"
 168     (let ((org-archive-tag "archive"))
 169       (org-test-with-backend "test"
 170         (should
 171          (equal (org-export-as 'test nil nil nil '(:with-archived-trees nil))
 172                 "")))))
 173   (org-test-with-temp-text "* Head1 :archive:\nbody\n** Sub-head 2"
 174     (let ((org-archive-tag "archive"))
 175       (org-test-with-backend "test"
 176         (should
 177          (string-match
 178           "\\* Head1[ \t]+:archive:"
 179           (org-export-as 'test nil nil nil
 180                          '(:with-archived-trees headline)))))))
 181   (org-test-with-temp-text "* Head1 :archive:"
 182     (let ((org-archive-tag "archive"))
 183       (org-test-with-backend "test"
 184         (should
 185          (string-match
 186           "\\`\\* Head1[ \t]+:archive:\n\\'"
 187           (org-export-as 'test nil nil nil '(:with-archived-trees t)))))))
 188   ;; Drawers.
 189   (let ((org-drawers '("TEST")))
 190     (org-test-with-temp-text ":TEST:\ncontents\n:END:"
 191       (org-test-with-backend "test"
 192         (should (equal (org-export-as 'test nil nil nil '(:with-drawers nil))
 193                        "")))))
 194   (let ((org-drawers '("TEST")))
 195     (org-test-with-temp-text ":TEST:\ncontents\n:END:"
 196       (org-test-with-backend "test"
 197         (should (equal (org-export-as 'test nil nil nil '(:with-drawers t))
 198                        ":TEST:\ncontents\n:END:\n"))))))
 199
 200 (ert-deftest test-org-export/comment-tree ()
 201   "Test if export process ignores commented trees."
 202   (let ((org-comment-string "COMMENT"))
 203     (org-test-with-temp-text "* COMMENT Head1"
 204       (org-test-with-backend "test"
 205         (should (equal (org-export-as 'test) ""))))))
 206
 207 (ert-deftest test-org-export/export-scope ()
 208   "Test all export scopes."
 209   (org-test-with-temp-text "
 210 * Head1
 211 ** Head2
 212 text
 213 *** Head3"
 214     (org-test-with-backend "test"
 215       ;; Subtree.
 216       (forward-line 3)
 217       (should (equal (org-export-as 'test 'subtree) "text\n*** Head3\n"))
 218       ;; Visible.
 219       (goto-char (point-min))
 220       (forward-line)
 221       (org-cycle)
 222       (should (equal (org-export-as 'test nil 'visible) "* Head1\n"))
 223       ;; Body only.
 224       (flet ((org-test-template (body info) (format "BEGIN\n%sEND" body)))
 225         (should (equal (org-export-as 'test nil nil 'body-only)
 226                        "* Head1\n** Head2\ntext\n*** Head3\n"))
 227         (should (equal (org-export-as 'test)
 228                        "BEGIN\n* Head1\n** Head2\ntext\n*** Head3\nEND")))
 229       ;; Region.
 230       (goto-char (point-min))
 231       (forward-line 3)
 232       (transient-mark-mode 1)
 233       (push-mark (point) t t)
 234       (goto-char (point-at-eol))
 235       (should (equal (org-export-as 'test) "text\n")))))
 236
 237 (ert-deftest test-org-export/export-snippet ()
 238   "Test export snippets transcoding."
 239   (org-test-with-temp-text "@test{A}@t{B}"
 240     (org-test-with-backend "test"
 241       (flet ((org-test-export-snippet
 242               (snippet contents info)
 243               (when (eq (org-export-snippet-backend snippet) 'test)
 244                 (org-element-property :value snippet))))
 245         (let ((org-export-snippet-translation-alist nil))
 246           (should (equal (org-export-as 'test) "A\n")))
 247         (let ((org-export-snippet-translation-alist '(("t" . "test"))))
 248           (should (equal (org-export-as 'test) "AB\n")))))))
 249
 250 (ert-deftest test-org-export/expand-include ()
 251   "Test file inclusion in an Org buffer."
 252   ;; Full insertion with recursive inclusion.
 253   (org-test-with-temp-text
 254       (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir)
 255     (org-export-expand-include-keyword)
 256     (should (equal (buffer-string)
 257                    "Small Org file with an include keyword.
 258
 259 #+BEGIN_SRC emacs-lisp :exports results\n(+ 2 1)\n#+END_SRC
 260
 261 Success!
 262
 263 * Heading
 264 body\n")))
 265   ;; Localized insertion.
 266   (org-test-with-temp-text
 267       (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\""
 268               org-test-dir)
 269     (org-export-expand-include-keyword)
 270     (should (equal (buffer-string)
 271                    "Small Org file with an include keyword.\n")))
 272   ;; Insertion with constraints on headlines level.
 273   (org-test-with-temp-text
 274       (format
 275        "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-\""
 276        org-test-dir)
 277     (org-export-expand-include-keyword)
 278     (should (equal (buffer-string) "* Top heading\n** Heading\nbody\n")))
 279   ;; Inclusion within an example block.
 280   (org-test-with-temp-text
 281       (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" example"
 282               org-test-dir)
 283     (org-export-expand-include-keyword)
 284     (should
 285      (equal
 286       (buffer-string)
 287       "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n")))
 288   ;; Inclusion within a src-block.
 289   (org-test-with-temp-text
 290       (format
 291        "#+INCLUDE: \"%s/examples/include.org\" :lines \"4-5\" src emacs-lisp"
 292        org-test-dir)
 293     (org-export-expand-include-keyword)
 294     (should (equal (buffer-string)
 295                    "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n"))))
 296
 297 (ert-deftest test-org-export/user-ignore-list ()
 298   "Test if `:ignore-list' accepts user input."
 299   (org-test-with-backend "test"
 300     (flet ((skip-note-head
 301             (data backend info)
 302             ;; Ignore headlines with the word "note" in their title.
 303             (org-element-map
 304              data 'headline
 305              (lambda (headline)
 306                (when (string-match "\\<note\\>"
 307                                    (org-element-property :raw-value headline))
 308                  (org-export-ignore-element headline info)))
 309              info)
 310             data))
 311       ;; Install function in parse tree filters.
 312       (let ((org-export-filter-parse-tree-functions '(skip-note-head)))
 313         (org-test-with-temp-text "* Head1\n* Head2 (note)\n"
 314           (should (equal (org-export-as 'test) "* Head1\n")))))))
 315
 316 (ert-deftest test-org-export/footnotes ()
 317   "Test footnotes specifications."
 318   (let ((org-footnote-section nil))
 319     ;; 1. Read every type of footnote.
 320     (org-test-with-temp-text
 321         "Text[fn:1] [1] [fn:label:C] [fn::D]\n\n[fn:1] A\n\n[1] B"
 322       (let* ((tree (org-element-parse-buffer))
 323              (info (org-combine-plists
 324                     (org-export-initial-options) '(:with-footnotes t))))
 325         (setq info (org-combine-plists
 326                     info (org-export-collect-tree-properties tree info 'test)))
 327         (should
 328          (equal
 329           '((1 . "A") (2 . "B") (3 . "C") (4 . "D"))
 330           (org-element-map
 331            tree 'footnote-reference
 332            (lambda (ref)
 333              (let ((def (org-export-get-footnote-definition ref info)))
 334                (cons (org-export-get-footnote-number ref info)
 335                      (if (eq (org-element-property :type ref) 'inline) (car def)
 336                        (car (org-element-contents
 337                              (car (org-element-contents def))))))))
 338            info)))))
 339     ;; 2. Test nested footnotes order.
 340     (org-test-with-temp-text
 341         "Text[fn:1:A[fn:2]] [fn:3].\n\n[fn:2] B [fn:3] [fn::D].\n\n[fn:3] C."
 342       (let* ((tree (org-element-parse-buffer))
 343              (info (org-combine-plists
 344                     (org-export-initial-options) '(:with-footnotes t))))
 345         (setq info (org-combine-plists
 346                     info (org-export-collect-tree-properties tree info 'test)))
 347         (should
 348          (equal
 349           '((1 . "fn:1") (2 . "fn:2") (3 . "fn:3") (4))
 350           (org-element-map
 351            tree 'footnote-reference
 352            (lambda (ref)
 353              (when (org-export-footnote-first-reference-p ref info)
 354                (cons (org-export-get-footnote-number ref info)
 355                      (org-element-property :label ref))))
 356            info)))))
 357     ;; 3. Test nested footnote in invisible definitions.
 358     (org-test-with-temp-text "Text[1]\n\n[1] B [2]\n\n[2] C."
 359       ;; Hide definitions.
 360       (narrow-to-region (point) (point-at-eol))
 361       (let* ((tree (org-element-parse-buffer))
 362              (info (org-combine-plists
 363                     (org-export-initial-options) '(:with-footnotes t))))
 364         (setq info (org-combine-plists
 365                     info (org-export-collect-tree-properties tree info 'test)))
 366         ;; Both footnotes should be seen.
 367         (should
 368          (= (length (org-export-collect-footnote-definitions tree info)) 2))))
 369     ;; 4. Test footnotes definitions collection.
 370     (org-test-with-temp-text "Text[fn:1:A[fn:2]] [fn:3].
 371
 372 \[fn:2] B [fn:3] [fn::D].
 373
 374 \[fn:3] C."
 375       (let ((tree (org-element-parse-buffer))
 376             (info (org-combine-plists
 377                    (org-export-initial-options) '(:with-footnotes t))))
 378         (setq info (org-combine-plists
 379                     info (org-export-collect-tree-properties tree info 'test)))
 380         (should (= (length (org-export-collect-footnote-definitions tree info))
 381                    4))))))
 382
 383 (ert-deftest test-org-export/fuzzy-links ()
 384   "Test fuzz link export specifications."
 385   ;; 1. Links to invisible (keyword) targets should be ignored.
 386   (org-test-with-temp-text
 387       "Paragraph.\n#+TARGET: Test\n[[Test]]"
 388     (let* ((tree (org-element-parse-buffer))
 389            (info (org-combine-plists (org-export-initial-options))))
 390       (setq info (org-combine-plists
 391                   info (org-export-collect-tree-properties tree info 'test)))
 392       (should-not
 393        (org-element-map
 394         tree 'link
 395         (lambda (link)
 396           (org-export-get-ordinal
 397            (org-export-resolve-fuzzy-link link info) info)) info))))
 398   ;; 2. Link to an headline should return headline's number.
 399   (org-test-with-temp-text
 400       "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]"
 401     (let* ((tree (org-element-parse-buffer))
 402            (info (org-combine-plists (org-export-initial-options))))
 403       (setq info (org-combine-plists
 404                   info (org-export-collect-tree-properties tree info 'test)))
 405       (should
 406        ;; Note: Headline's number is in fact a list of numbers.
 407        (equal '(2)
 408               (org-element-map
 409                tree 'link
 410                (lambda (link)
 411                  (org-export-get-ordinal
 412                   (org-export-resolve-fuzzy-link link info) info)) info t)))))
 413   ;; 3. Link to a target in an item should return item's number.
 414   (org-test-with-temp-text
 415       "- Item1\n  - Item11\n  - <<test>>Item12\n- Item2\n\n\n[[test]]"
 416     (let* ((tree (org-element-parse-buffer))
 417            (info (org-combine-plists (org-export-initial-options))))
 418       (setq info (org-combine-plists
 419                   info (org-export-collect-tree-properties tree info 'test)))
 420       (should
 421        ;; Note: Item's number is in fact a list of numbers.
 422        (equal '(1 2)
 423               (org-element-map
 424                tree 'link
 425                (lambda (link)
 426                  (org-export-get-ordinal
 427                   (org-export-resolve-fuzzy-link link info) info)) info t)))))
 428   ;; 4. Link to a target in a footnote should return footnote's
 429   ;;    number.
 430   (org-test-with-temp-text
 431       "Paragraph[1][2][fn:lbl3:C<<target>>][[test]][[target]]\n[1] A\n\n[2] <<test>>B"
 432     (let* ((tree (org-element-parse-buffer))
 433            (info (org-combine-plists (org-export-initial-options))))
 434       (setq info (org-combine-plists
 435                   info (org-export-collect-tree-properties tree info 'test)))
 436       (should
 437        (equal '(2 3)
 438               (org-element-map
 439                tree 'link
 440                (lambda (link)
 441                  (org-export-get-ordinal
 442                   (org-export-resolve-fuzzy-link link info) info)) info)))))
 443   ;; 5. Link to a named element should return sequence number of that
 444   ;;    element.
 445   (org-test-with-temp-text
 446       "#+NAME: tbl1\n|1|2|\n#+NAME: tbl2\n|3|4|\n#+NAME: tbl3\n|5|6|\n[[tbl2]]"
 447     (let* ((tree (org-element-parse-buffer))
 448            (info (org-combine-plists (org-export-initial-options))))
 449       (setq info (org-combine-plists
 450                   info (org-export-collect-tree-properties tree info 'test)))
 451       (should
 452        (= 2
 453           (org-element-map
 454            tree 'link
 455            (lambda (link)
 456              (org-export-get-ordinal
 457               (org-export-resolve-fuzzy-link link info) info)) info t)))))
 458   ;; 6. Link to a target not within an item, a table, a footnote
 459   ;;    reference or definition should return section number.
 460   (org-test-with-temp-text
 461       "* Head1\n* Head2\nParagraph<<target>>\n* Head3\n[[target]]"
 462     (let* ((tree (org-element-parse-buffer))
 463            (info (org-combine-plists (org-export-initial-options))))
 464       (setq info (org-combine-plists
 465                   info (org-export-collect-tree-properties tree info 'test)))
 466       (should
 467        (equal '(2)
 468               (org-element-map
 469                tree 'link
 470                (lambda (link)
 471                  (org-export-get-ordinal
 472                   (org-export-resolve-fuzzy-link link info) info)) info t))))))