test-org-lint.el 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504
  1. ;;; test-org-lint.el --- Tests for Org Lint -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2016 Nicolas Goaziou
  3. ;; Author: Nicolas Goaziou <mail@nicolasgoaziou.fr>
  4. ;; This program is free software; you can redistribute it and/or modify
  5. ;; it under the terms of the GNU General Public License as published by
  6. ;; the Free Software Foundation, either version 3 of the License, or
  7. ;; (at your option) any later version.
  8. ;; This program is distributed in the hope that it will be useful,
  9. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. ;; GNU General Public License for more details.
  12. ;; You should have received a copy of the GNU General Public License
  13. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. ;;; Code:
  15. (ert-deftest test-org-lint/duplicate-custom-id ()
  16. "Test `org-lint-duplicate-custom-id' checker."
  17. (should
  18. (org-test-with-temp-text "
  19. * H1
  20. :PROPERTIES:
  21. :CUSTOM_ID: foo
  22. :END:
  23. * H2
  24. :PROPERTIES:
  25. :CUSTOM_ID: foo
  26. :END:"
  27. (org-lint '(duplicate-custom-id))))
  28. (should-not
  29. (org-test-with-temp-text "
  30. * H1
  31. :PROPERTIES:
  32. :CUSTOM_ID: foo
  33. :END:
  34. * H2
  35. :PROPERTIES:
  36. :CUSTOM_ID: bar
  37. :END:"
  38. (org-lint '(duplicate-custom-id)))))
  39. (ert-deftest test-org-lint/duplicate-name ()
  40. "Test `org-lint-duplicate-name' checker."
  41. (should
  42. (org-test-with-temp-text "
  43. #+name: foo
  44. Paragraph1
  45. #+name: foo
  46. Paragraph 2"
  47. (org-lint '(duplicate-name))))
  48. (should-not
  49. (org-test-with-temp-text "
  50. #+name: foo
  51. Paragraph1
  52. #+name: bar
  53. Paragraph 2"
  54. (org-lint '(duplicate-name)))))
  55. (ert-deftest test-org-lint/duplicate-target ()
  56. "Test `org-lint-duplicate-target' checker."
  57. (should
  58. (org-test-with-temp-text "<<foo>> <<foo>>"
  59. (org-lint '(duplicate-target))))
  60. (should-not
  61. (org-test-with-temp-text "<<foo>> <<bar>>"
  62. (org-lint '(duplicate-target)))))
  63. (ert-deftest test-org-lint/duplicate-footnote-definition ()
  64. "Test `org-lint-duplicate-footnote-definition' checker."
  65. (should
  66. (org-test-with-temp-text "
  67. \[fn:1] Definition 1
  68. \[fn:1] Definition 2"
  69. (org-lint '(duplicate-footnote-definition))))
  70. (should-not
  71. (org-test-with-temp-text "
  72. \[fn:1] Definition 1
  73. \[fn:2] Definition 2"
  74. (org-lint '(duplicate-footnote-definition)))))
  75. (ert-deftest test-org-lint/orphaned-affiliated-keywords ()
  76. "Test `org-lint-orphaned-affiliated-keywords' checker."
  77. (should
  78. (org-test-with-temp-text "#+name: foo"
  79. (org-lint '(orphaned-affiliated-keywords)))))
  80. (ert-deftest test-org-lint/deprecated-export-blocks ()
  81. "Test `org-lint-deprecated-export-blocks' checker."
  82. (should
  83. (org-test-with-temp-text "
  84. #+begin_latex
  85. ...
  86. #+end_latex"
  87. (org-lint '(deprecated-export-blocks)))))
  88. (ert-deftest test-org-lint/deprecated-header-syntax ()
  89. "Test `org-lint-deprecated-header-syntax' checker."
  90. (should
  91. (org-test-with-temp-text "#+property: cache yes"
  92. (org-lint '(deprecated-header-syntax))))
  93. (should
  94. (org-test-with-temp-text "
  95. * H
  96. :PROPERTIES:
  97. :cache: yes
  98. :END:"
  99. (org-lint '(deprecated-header-syntax)))))
  100. (ert-deftest test-org-lint/missing-language-in-src-block ()
  101. "Test `org-lint-missing-language-in-src-block' checker."
  102. (should
  103. (org-test-with-temp-text "
  104. #+begin_src
  105. ...
  106. #+end_src"
  107. (org-lint '(missing-language-in-src-block)))))
  108. (ert-deftest test-org-lint/missing-backend-in-export-block ()
  109. "Test `org-lint-missing-backend-in-export-block' checker."
  110. (should
  111. (org-test-with-temp-text "
  112. #+begin_export
  113. ...
  114. #+end_export"
  115. (org-lint '(missing-backend-in-export-block)))))
  116. (ert-deftest test-org-lint/invalid-babel-call-block ()
  117. "Test `org-lint-invalid-babel-call-block' checker."
  118. (should
  119. (org-test-with-temp-text "#+call:"
  120. (org-lint '(invalid-babel-call-block))))
  121. (should
  122. (org-test-with-temp-text "#+call: foo() [:exports code]"
  123. (org-lint '(invalid-babel-call-block)))))
  124. (ert-deftest test-org-lint/deprecated-category-setup ()
  125. "Test `org-lint-deprecated-category-setup' checker."
  126. (should
  127. (org-test-with-temp-text "#+category: foo\n#+category: bar"
  128. (org-lint '(deprecated-category-setup)))))
  129. (ert-deftest test-org-lint/invalid-coderef-link ()
  130. "Test `org-lint-invalid-coderef-link' checker."
  131. (should
  132. (org-test-with-temp-text "[[(unknown)]]"
  133. (org-lint '(invalid-coderef-link))))
  134. (should-not
  135. (org-test-with-temp-text "[[(foo)]]
  136. #+begin_src emacs-lisp -l \"; ref:%s\"
  137. (+ 1 1) ; ref:foo
  138. #+end_src"
  139. (org-lint '(invalid-coderef-link)))))
  140. (ert-deftest test-org-lint/invalid-custom-id-link ()
  141. "Test `org-lint-invalid-custom-id-link' checker."
  142. (should
  143. (org-test-with-temp-text "[[#unknown]]"
  144. (org-lint '(invalid-custom-id-link))))
  145. (should-not
  146. (org-test-with-temp-text "[[#foo]]
  147. * H
  148. :PROPERTIES:
  149. :CUSTOM_ID: foo
  150. :END:"
  151. (org-lint '(invalid-custom-id-link)))))
  152. (ert-deftest test-org-lint/invalid-fuzzy-link ()
  153. "Test `org-lint-invalid-fuzzy-link' checker."
  154. (should
  155. (org-test-with-temp-text "[[*unknown]]"
  156. (org-lint '(invalid-fuzzy-link))))
  157. (should-not
  158. (org-test-with-temp-text "[[*foo]]\n* foo"
  159. (org-lint '(invalid-fuzzy-link))))
  160. (should
  161. (org-test-with-temp-text "[[unknown]]"
  162. (org-lint '(invalid-fuzzy-link))))
  163. (should-not
  164. (org-test-with-temp-text "[[foo]]\n#+name: foo\nParagraph"
  165. (org-lint '(invalid-fuzzy-link))))
  166. (should-not
  167. (org-test-with-temp-text "[[foo]]\n<<foo>>"
  168. (org-lint '(invalid-fuzzy-link)))))
  169. (ert-deftest test-org-lint/special-property-in-properties-drawer ()
  170. "Test `org-lint-special-property-in-properties-drawer' checker."
  171. (should
  172. (org-test-with-temp-text "
  173. * H
  174. :PROPERTIES:
  175. :TODO: foo
  176. :END:"
  177. (org-lint '(special-property-in-properties-drawer)))))
  178. (ert-deftest test-org-lint/obsolete-properties-drawer ()
  179. "Test `org-lint-obsolete-properties-drawer' checker."
  180. (should
  181. (org-test-with-temp-text "
  182. * H
  183. Paragraph
  184. :PROPERTIES:
  185. :SOMETHING: foo
  186. :END:"
  187. (org-lint '(obsolete-properties-drawer))))
  188. (should
  189. (org-test-with-temp-text "
  190. * H
  191. :PROPERTIES:
  192. This is not a node property
  193. :END:"
  194. (org-lint '(obsolete-properties-drawer)))))
  195. (ert-deftest test-org-lint/invalid-effort-property ()
  196. "Test `org-lint-invalid-effort-property' checker."
  197. (should
  198. (org-test-with-temp-text "* H\n:PROPERTIES:\n:EFFORT: something\n:END:"
  199. (org-lint '(invalid-effort-property))))
  200. (should-not
  201. (org-test-with-temp-text "* H\n:PROPERTIES:\n:EFFORT: 1:23\n:END:"
  202. (org-lint '(invalid-effort-property)))))
  203. (ert-deftest test-org-lint/link-to-local-file ()
  204. "Test `org-lint-link-to-local-file' checker."
  205. (should
  206. (org-test-with-temp-text "[[file:/Idonotexist.org]]"
  207. (org-lint '(link-to-local-file)))))
  208. (ert-deftest test-org-lint/non-existent-setupfile-parameter ()
  209. "Test `org-lint-non-existent-setupfile-parameter' checker."
  210. (should
  211. (org-test-with-temp-text "#+setupfile: Idonotexist.org"
  212. (org-lint '(non-existent-setupfile-parameter)))))
  213. (ert-deftest test-org-lint/wrong-include-link-parameter ()
  214. "Test `org-lint-wrong-include-link-parameter' checker."
  215. (should
  216. (org-test-with-temp-text "#+include:"
  217. (org-lint '(wrong-include-link-parameter))))
  218. (should
  219. (org-test-with-temp-text "#+include: Idonotexist.org"
  220. (org-lint '(wrong-include-link-parameter))))
  221. (should
  222. (org-test-with-temp-text-in-file ""
  223. (let ((file (buffer-file-name)))
  224. (org-test-with-temp-text (format "#+include: \"%s::#foo\"" file)
  225. (org-lint '(wrong-include-link-parameter))))))
  226. (should-not
  227. (org-test-with-temp-text-in-file "* foo"
  228. (let ((file (buffer-file-name)))
  229. (org-test-with-temp-text (format "#+include: \"%s::*foo\"" file)
  230. (org-lint '(wrong-include-link-parameter)))))))
  231. (ert-deftest test-org-lint/obsolete-include-markup ()
  232. "Test `org-lint-obsolete-include-markup' checker."
  233. (should
  234. (org-test-with-temp-text-in-file ""
  235. (let ((file (buffer-file-name)))
  236. (org-test-with-temp-text (format "#+include: \"%s\" html" file)
  237. (org-lint '(obsolete-include-markup))))))
  238. (should-not
  239. (org-test-with-temp-text-in-file ""
  240. (let ((file (buffer-file-name)))
  241. (org-test-with-temp-text (format "#+include: \"%s\" export html" file)
  242. (org-lint '(obsolete-include-markup)))))))
  243. (ert-deftest test-org-lint/unknown-options-item ()
  244. "Test `org-lint-unknown-options-item' checker."
  245. (should
  246. (org-test-with-temp-text "#+options: foobarbaz:t"
  247. (org-lint '(unknown-options-item)))))
  248. (ert-deftest test-org-lint/invalid-macro-argument-and-template ()
  249. "Test `org-lint-invalid-macro-argument-and-template' checker."
  250. (should
  251. (org-test-with-temp-text "{{{undefined()}}}"
  252. (org-lint '(invalid-macro-argument-and-template))))
  253. (should
  254. (org-test-with-temp-text
  255. "#+macro: wrongsignature $1 $2\n{{{wrongsignature(1, 2, 3)}}}"
  256. (org-lint '(invalid-macro-argument-and-template))))
  257. (should
  258. (org-test-with-temp-text "#+macro:"
  259. (org-lint '(invalid-macro-argument-and-template))))
  260. (should
  261. (org-test-with-temp-text "#+macro: missingtemplate"
  262. (org-lint '(invalid-macro-argument-and-template))))
  263. (should
  264. (org-test-with-temp-text "#+macro: unusedplaceholders $1 $3"
  265. (org-lint '(invalid-macro-argument-and-template))))
  266. (should-not
  267. (org-test-with-temp-text
  268. "#+macro: valid $1 $2\n{{{valid(1, 2)}}}"
  269. (org-lint '(invalid-macro-argument-and-template)))))
  270. (ert-deftest test-org-lint/undefined-footnote-reference ()
  271. "Test `org-lint-undefined-footnote-reference' checker."
  272. (should
  273. (org-test-with-temp-text "Text[fn:1]"
  274. (org-lint '(undefined-footnote-reference))))
  275. (should-not
  276. (org-test-with-temp-text "Text[fn:1]\n[fn:1] Definition"
  277. (org-lint '(undefined-footnote-reference))))
  278. (should-not
  279. (org-test-with-temp-text "Text[fn:1:inline reference]"
  280. (org-lint '(undefined-footnote-reference))))
  281. (should-not
  282. (org-test-with-temp-text "Text[fn::anonymous reference]"
  283. (org-lint '(undefined-footnote-reference)))))
  284. (ert-deftest test-org-lint/unreferenced-footnote-definition ()
  285. "Test `org-lint-unreferenced-footnote-definition' checker."
  286. (should
  287. (org-test-with-temp-text "[fn:1] Definition"
  288. (org-lint '(unreferenced-footnote-definition))))
  289. (should-not
  290. (org-test-with-temp-text "Text[fn:1]\n[fn:1] Definition"
  291. (org-lint '(unreferenced-footnote-definition)))))
  292. (ert-deftest test-org-lint/colon-in-name ()
  293. "Test `org-lint-colon-in-name' checker."
  294. (should
  295. (org-test-with-temp-text "#+name: tab:name\n| a |"
  296. (org-lint '(colon-in-name))))
  297. (should-not
  298. (org-test-with-temp-text "#+name: name\n| a |"
  299. (org-lint '(colon-in-name)))))
  300. (ert-deftest test-org-lint/misplaced-planning-info ()
  301. "Test `org-lint-misplaced-planning-info' checker."
  302. (should
  303. (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
  304. (org-lint '(misplaced-planning-info))))
  305. (should
  306. (org-test-with-temp-text "
  307. * H
  308. Text
  309. SCHEDULED: <2012-03-29 thu.>"
  310. (org-lint '(misplaced-planning-info))))
  311. (should-not
  312. (org-test-with-temp-text "
  313. * H
  314. SCHEDULED: <2012-03-29 thu.>"
  315. (org-lint '(misplaced-planning-info)))))
  316. (ert-deftest test-org-lint/incomplete-drawer ()
  317. "Test `org-lint-incomplete-drawer' checker."
  318. (should
  319. (org-test-with-temp-text ":DRAWER:"
  320. (org-lint '(incomplete-drawer))))
  321. (should-not
  322. (org-test-with-temp-text ":DRAWER:\n:END:"
  323. (org-lint '(incomplete-drawer)))))
  324. (ert-deftest test-org-lint/indented-diary-sexp ()
  325. "Test `org-lint-indented-diary-sexp' checker."
  326. (should
  327. (org-test-with-temp-text " %%(foo)"
  328. (org-lint '(indented-diary-sexp))))
  329. (should-not
  330. (org-test-with-temp-text "%%(foo)"
  331. (org-lint '(indented-diary-sexp)))))
  332. (ert-deftest test-org-lint/invalid-block ()
  333. "Test `org-lint-invalid-block' checker."
  334. (should
  335. (org-test-with-temp-text "#+begin_foo"
  336. (org-lint '(invalid-block))))
  337. (should-not
  338. (org-test-with-temp-text "#+begin_foo\n#+end_foo"
  339. (org-lint '(invalid-block)))))
  340. (ert-deftest test-org-lint/invalid-keyword-syntax ()
  341. "Test `org-lint-invalid-keyword-syntax' checker."
  342. (should
  343. (org-test-with-temp-text "#+keyword"
  344. (org-lint '(invalid-keyword-syntax))))
  345. (should-not
  346. (org-test-with-temp-text "#+keyword:"
  347. (org-lint '(invalid-keyword-syntax)))))
  348. (ert-deftest test-org-lint/extraneous-element-in-footnote-section ()
  349. "Test `org-lint-extraneous-element-in-footnote-section' checker."
  350. (should
  351. (org-test-with-temp-text "* Footnotes\nI'm not a footnote definition"
  352. (let ((org-footnote-section "Footnotes"))
  353. (org-lint '(extraneous-element-in-footnote-section)))))
  354. (should-not
  355. (org-test-with-temp-text "* Footnotes\n[fn:1] I'm a footnote definition"
  356. (let ((org-footnote-section "Footnotes"))
  357. (org-lint '(extraneous-element-in-footnote-section))))))
  358. (ert-deftest test-org-lint/quote-section ()
  359. "Test `org-lint-quote-section' checker."
  360. (should
  361. (org-test-with-temp-text "* QUOTE H"
  362. (org-lint '(quote-section))))
  363. (should
  364. (org-test-with-temp-text "* COMMENT QUOTE H"
  365. (org-lint '(quote-section)))))
  366. (ert-deftest test-org-lint/file-application ()
  367. "Test `org-lint-file-application' checker."
  368. (should
  369. (org-test-with-temp-text "[[file+emacs:foo.org]]"
  370. (org-lint '(file-application)))))
  371. (ert-deftest test-org-lint/wrong-header-argument ()
  372. "Test `org-lint-wrong-header-argument' checker."
  373. (should
  374. (org-test-with-temp-text "#+call: foo() barbaz yes"
  375. (org-lint '(wrong-header-argument))))
  376. (should
  377. (org-test-with-temp-text "#+call: foo() :barbaz yes"
  378. (org-lint '(wrong-header-argument))))
  379. (should
  380. (org-test-with-temp-text "call_foo[barbaz yes]()"
  381. (org-lint '(wrong-header-argument))))
  382. (should
  383. (org-test-with-temp-text "call_foo[:barbaz yes]()"
  384. (org-lint '(wrong-header-argument))))
  385. (should
  386. (org-test-with-temp-text "#+property: header-args barbaz yes"
  387. (org-lint '(wrong-header-argument))))
  388. (should
  389. (org-test-with-temp-text "#+property: header-args :barbaz yes"
  390. (org-lint '(wrong-header-argument))))
  391. (should
  392. (org-test-with-temp-text "
  393. * H
  394. :PROPERTIES:
  395. :HEADER-ARGS: barbaz yes
  396. :END:"
  397. (org-lint '(wrong-header-argument))))
  398. (should
  399. (org-test-with-temp-text "
  400. * H
  401. :PROPERTIES:
  402. :HEADER-ARGS: :barbaz yes
  403. :END:"
  404. (org-lint '(wrong-header-argument))))
  405. (should
  406. (org-test-with-temp-text "
  407. #+header: :barbaz yes
  408. #+begin_src emacs-lisp
  409. \(+ 1 1)
  410. #+end_src"
  411. (org-lint '(wrong-header-argument))))
  412. (should
  413. (org-test-with-temp-text "src_emacs-lisp[barbaz yes]{}"
  414. (org-lint '(wrong-header-argument))))
  415. (should
  416. (org-test-with-temp-text "src_emacs-lisp[:barbaz yes]{}"
  417. (org-lint '(wrong-header-argument)))))
  418. (ert-deftest test-org-lint/wrong-header-value ()
  419. "Test `org-lint-wrong-header-value' checker."
  420. (should
  421. (org-test-with-temp-text "
  422. #+header: :cache maybe
  423. #+begin_src emacs-lisp
  424. \(+ 1 1)
  425. #+end_src"
  426. (org-lint '(wrong-header-value))))
  427. (should
  428. (org-test-with-temp-text "
  429. #+header: :exports both none
  430. #+begin_src emacs-lisp
  431. \(+ 1 1)
  432. #+end_src"
  433. (org-lint '(wrong-header-value))))
  434. (should-not
  435. (org-test-with-temp-text "
  436. #+header: :cache yes
  437. #+begin_src emacs-lisp
  438. \(+ 1 1)
  439. #+end_src"
  440. (org-lint '(wrong-header-value)))))
  441. (ert-deftest test-org-lint/empty-headline-with-tags ()
  442. "Test `org-lint-empty-headline-with-tags' checker."
  443. (should
  444. (org-test-with-temp-text "* :tag:"
  445. (org-lint '(empty-headline-with-tags))))
  446. (should
  447. (org-test-with-temp-text "* :tag: "
  448. (org-lint '(empty-headline-with-tags))))
  449. (should-not
  450. (org-test-with-temp-text "* notag: "
  451. (org-lint '(empty-headline-with-tags)))))
  452. (provide 'test-org-lint)
  453. ;;; test-org-lint.el ends here