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       (mark-paragraph)
 233       (should (equal (org-export-as 'test) "text\n")))))
 234
 235 (ert-deftest test-org-export/export-snippet ()
 236   "Test export snippets transcoding."
 237   (org-test-with-temp-text "@test{A}@t{B}"
 238     (org-test-with-backend "test"
 239       (flet ((org-test-export-snippet
 240               (snippet contents info)
 241               (when (eq (org-export-snippet-backend snippet) 'test)
 242                 (org-element-property :value snippet))))
 243         (let ((org-export-snippet-translation-alist nil))
 244           (should (equal (org-export-as 'test) "A\n")))
 245         (let ((org-export-snippet-translation-alist '(("t" . "test"))))
 246           (should (equal (org-export-as 'test) "AB\n")))))))
 247
 248 (ert-deftest test-org-export/expand-include ()
 249   "Test file inclusion in an Org buffer."
 250   ;; Full insertion with recursive inclusion.
 251   (org-test-with-temp-text
 252       (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir)
 253     (org-export-expand-include-keyword)
 254     (should (equal (buffer-string)
 255                    "Small Org file with an include keyword.
 256
 257 #+BEGIN_SRC emacs-lisp :exports results\n(+ 2 1)\n#+END_SRC
 258
 259 Success!
 260
 261 * Heading
 262 body\n")))
 263   ;; Localized insertion.
 264   (org-test-with-temp-text
 265       (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\""
 266               org-test-dir)
 267     (org-export-expand-include-keyword)
 268     (should (equal (buffer-string)
 269                    "Small Org file with an include keyword.\n")))
 270   ;; Insertion with constraints on headlines level.
 271   (org-test-with-temp-text
 272       (format
 273        "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-\""
 274        org-test-dir)
 275     (org-export-expand-include-keyword)
 276     (should (equal (buffer-string) "* Top heading\n** Heading\nbody\n")))
 277   ;; Inclusion within an example block.
 278   (org-test-with-temp-text
 279       (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" example"
 280               org-test-dir)
 281     (org-export-expand-include-keyword)
 282     (should
 283      (equal
 284       (buffer-string)
 285       "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n")))
 286   ;; Inclusion within a src-block.
 287   (org-test-with-temp-text
 288       (format
 289        "#+INCLUDE: \"%s/examples/include.org\" :lines \"4-5\" src emacs-lisp"
 290        org-test-dir)
 291     (org-export-expand-include-keyword)
 292     (should (equal (buffer-string)
 293                    "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n"))))
 294
 295 (ert-deftest test-org-export/user-ignore-list ()
 296   "Test if `:ignore-list' accepts user input."
 297   (org-test-with-backend "test"
 298     (flet ((skip-note-head
 299             (data backend info)
 300             ;; Ignore headlines with the word "note" in their title.
 301             (org-element-map
 302              data 'headline
 303              (lambda (headline)
 304                (when (string-match "\\<note\\>"
 305                                    (org-element-property :raw-value headline))
 306                  (org-export-ignore-element headline info)))
 307              info)
 308             data))
 309       ;; Install function in parse tree filters.
 310       (let ((org-export-filter-parse-tree-functions '(skip-note-head)))
 311         (org-test-with-temp-text "* Head1\n* Head2 (note)\n"
 312           (should (equal (org-export-as 'test) "* Head1\n")))))))
 313
 314 (ert-deftest test-org-export/footnotes ()
 315   "Test footnotes specifications."
 316   (let ((org-footnote-section nil))
 317     ;; 1. Read every type of footnote.
 318     (org-test-with-temp-text
 319         "Text[fn:1] [1] [fn:label:C] [fn::D]\n\n[fn:1] A\n\n[1] B"
 320       (let* ((tree (org-element-parse-buffer))
 321              (info (org-combine-plists
 322                     (org-export-initial-options) '(:with-footnotes t))))
 323         (setq info (org-combine-plists
 324                     info (org-export-collect-tree-properties tree info 'test)))
 325         (should
 326          (equal
 327           '((1 . "A") (2 . "B") (3 . "C") (4 . "D"))
 328           (org-element-map
 329            tree 'footnote-reference
 330            (lambda (ref)
 331              (let ((def (org-export-get-footnote-definition ref info)))
 332                (cons (org-export-get-footnote-number ref info)
 333                      (if (eq (org-element-property :type ref) 'inline) (car def)
 334                        (car (org-element-contents
 335                              (car (org-element-contents def))))))))
 336            info)))))
 337     ;; 2. Test nested footnotes order.
 338     (org-test-with-temp-text
 339         "Text[fn:1:A[fn:2]] [fn:3].\n\n[fn:2] B [fn:3] [fn::D].\n\n[fn:3] C."
 340       (let* ((tree (org-element-parse-buffer))
 341              (info (org-combine-plists
 342                     (org-export-initial-options) '(:with-footnotes t))))
 343         (setq info (org-combine-plists
 344                     info (org-export-collect-tree-properties tree info 'test)))
 345         (should
 346          (equal
 347           '((1 . "fn:1") (2 . "fn:2") (3 . "fn:3") (4))
 348           (org-element-map
 349            tree 'footnote-reference
 350            (lambda (ref)
 351              (when (org-export-footnote-first-reference-p ref info)
 352                (cons (org-export-get-footnote-number ref info)
 353                      (org-element-property :label ref))))
 354            info)))))
 355     ;; 3. Test nested footnote in invisible definitions.
 356     (org-test-with-temp-text "Text[1]\n\n[1] B [2]\n\n[2] C."
 357       ;; Hide definitions.
 358       (narrow-to-region (point) (point-at-eol))
 359       (let* ((tree (org-element-parse-buffer))
 360              (info (org-combine-plists
 361                     (org-export-initial-options) '(:with-footnotes t))))
 362         (setq info (org-combine-plists
 363                     info (org-export-collect-tree-properties tree info 'test)))
 364         ;; Both footnotes should be seen.
 365         (should
 366          (= (length (org-export-collect-footnote-definitions tree info)) 2))))))