mirrors
/
org-mode
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git
0
0
Fork 1
Code Releases Activity
org-mode/testing/lisp/test-org-lint.el

653 lines
20 KiB
EmacsLisp
Raw Normal View History

Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
;;; test-org-lint.el --- Tests for Org Lint -*- lexical-binding: t; -*-
Update copyright year
2019-01-01 10:50:56 +00:00
;; Copyright (C) 2016, 2019 Nicolas Goaziou
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
;; Author: Nicolas Goaziou <mail@nicolasgoaziou.fr>
;; 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
Prefer HTTPS to HTTP for links to gnu.org
2021-03-20 07:27:57 +00:00
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
;;; Code:
testing: Make all files use `lexical-binding` Mainly, add the corresponding cookie, but also add various `require`s so that the compiler knows which vars should be trated as dynbound. This does not fix all the warnings, but does try to eliminate all those about "unused" variables. For the variables truly unused, the patch usually adds an underscore to their name to silence the warning. Some of the fixes affect files which already used `lexical-binding`. Not sure why the test worked before: maybe because the tests were run without compiling them first (which could cause some of the missing `require`d packages to be autoloaded before we got to the problematic code, thus hiding the problem)? I found some suspicious code, for which I added FIXMEs. There are also a few changes to the main files. * lisp/org-protocol.el (org-protocol-check-filename-for-protocol): Don't call `server-edit` if it's not yet defined. [ Needed to get the tests to pass. ] * lisp/ob-core.el (org-babel-temporary-directory) (org-babel-temporary-stable-directory): Always define (and use nil if we don't want to create a directory for it). Simplify the code based on the fact that (defvar V E) only evaluates E if V is not yet `boundp`. (org-babel-temp-file, org-babel-temp-stable-file) (org-babel-remove-temporary-directory) (org-babel-remove-temporary-stable-directory): Adjust accordingly. * lisp/org.el (org-log-beginning): Add FIXME. * testing/org-test.el: Require `org` and `org-id`. (org-id-locations-file): Don't `defconst` it. (org-test-at-id, org-test-in-example-file, org-test-at-marker) (org-test-with-temp-text, org-test-with-temp-text-in-file): Move edebug specs into `declare` (and simplify them). (org-test-with-tramp-remote-dir--worker): Declare dynbound tramp vars. (org--compile-when): Fix quoting of `exp`. (org-test-load): Tweak regexps. * testing/org-batch-test-init.el: Tweak regexp, remove dead code and add a FIXME about it. * testing/lisp/test-ox.el: Require `ox` instead of erroring out if it's not already loaded. Also require `org-inlinetask`. (org-test-with-parsed-data): Silence warnings when `info` is not used. (test-org-export/bind-keyword): Add FIXME. * testing/lisp/test-ox-publish.el: Require `org-test` and `ox-publish`. (test-org-publish/resolve-external-link): Expose lambdas to the compiler. Remove unused var `ids`. (test-org-publish/get-project-from-filename): Remove unused var `file`. * testing/lisp/test-org.el: Require `org-macs`, `org`, `org-inlinetask`, `org-refile`, and `org-agenda`. (test-org/org-read-date): Declare `org-time-was-given` as dynbound. (test-org/set-regexps-and-options): Add FIXME. * testing/lisp/test-org-timer.el: Require `org-timer`. * testing/lisp/test-org-table.el: Require `ox`. * testing/lisp/test-org-protocol.el: Require `org-protocol` instead of erroring out if it's not already loaded. Also require `capture`, and add missing `provide` statement. * testing/lisp/test-org-pcomplete.el: Require `org`. * testing/lisp/test-org-list.el: Require `org-list` and `org`. * testing/lisp/test-org-lint.el: Require `org-footnote` and `org-lint`. * testing/lisp/test-org-footnote.el: Require `org-footnote`. * testing/lisp/test-org-element.el: Require `org-element` instead of erroring out if it's not already loaded. Also require `org` and `org-inlinetask`. * testing/lisp/test-org-duration.el: Require `org-duration`. * testing/lisp/test-org-datetree.el: Require `org-datetree`. * testing/lisp/test-org-colview.el: Require `org-colview`, `org-duration`, and `org-inlinetask`. * testing/lisp/test-org-clock.el: Require `org-duration` and `org-clock`. * testing/lisp/test-org-archive.el: Require `org-archive`. * testing/lisp/test-org-agenda.el (test-org-agenda/bulk-custom-arg-func): Add FIXME. * testing/lisp/test-ol.el: Require `ol` and `org-id`. (test-org-link/store-link): Declare `org-store-link-props` and add FIXME. * testing/lisp/test-oc.el (test-org-cite/export-capability): Add FIXME. * testing/lisp/test-ob.el: Require `ob-core`, `org-src`, `ob-ref`, and `org-table`. (test-ob/eval-header-argument): Rename `foo` to `test-ob--foo` and declare it as dynbound. (test-ob/blocks-with-spaces, test-ob/specific-colnames): Add FIXME. (test-ob/noweb-expansions-in-cache): Declare `noweb-expansions-in-cache-var` as dynbound. * testing/lisp/test-ob-tangle.el: Require `org` and `ob-tangle`. * testing/lisp/test-ob-shell.el: * testing/lisp/test-ob-python.el: Require `ob-core`. * testing/lisp/test-ob-lob.el: Require `ob-lob`. (temporary-value-for-test): Declare as dynbound. * testing/lisp/test-ob-plantuml.el: Require `ob-plantuml` instead of erroring out if it's not already loaded. * testing/lisp/test-ob-lilypond.el: Require `ob-lilypond` instead of erroring out if it's not already loaded. Use `with-current-buffer`. * testing/lisp/test-ob-julia.el: Require `ob-core`. * testing/lisp/test-ob-java.el (org-babel-temporary-directory): Remove dead code now that `org-babel-temporary-directory` is always bound. * testing/lisp/test-ob-exp.el: Require `ob-exp`, `org-src`, and `org-test`. (ob-exp/evaluate-all-executables-in-order): Declare `*evaluation-collector*` as dynbound. * testing/lisp/test-ob-emacs-lisp.el (ob-emacs-lisp/dynamic-lexical-edit) (ob-emacs-lisp/dynamic-lexical-execute): Rename dynbound var to `ob-emacs--x` and declare it as such. * testing/lisp/test-ob-R.el: Require `ob-core`. (ess-ask-for-ess-directory, ess-history-file): Declare vars.
2022-09-14 21:21:37 +00:00
(require 'org-footnote)
(require 'org-lint)
lint: Allow user-defined checkers during linting * lisp/org-lint.el (org-lint-add-checker): New function. (org-lint--generate-reports): Checker function now must be specified. It is not deduced anymore from the name of the checker. * testing/lisp/test-org-lint.el (test-org-lint/add-checker): New test.
2021-12-01 15:09:13 +00:00
(ert-deftest test-org-lint/add-checker ()
"Test `org-lint-add-checker'."
;; Name should be a non-nil symbol.
(should-error (org-lint-add-checker nil "Nil check" #'ignore))
(should-error (org-lint-add-checker 2 "Odd check" #'ignore))
;; Check function should be valid.
(should-error (org-lint-add-checker 'check "check" (gensym)))
;; Checkers must be named uniquely.
(should
(= 1
(let ((org-lint--checkers nil))
(org-lint-add-checker 'check "check" #'ignore)
(length org-lint--checkers))))
(should-not
(= 2
(let ((org-lint--checkers nil))
(org-lint-add-checker 'check "check" #'ignore)
(org-lint-add-checker 'check "other check" #'ignore)
(length org-lint--checkers)))))
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(ert-deftest test-org-lint/duplicate-custom-id ()
"Test `org-lint-duplicate-custom-id' checker."
(should
(org-test-with-temp-text "
* H1
:PROPERTIES:
:CUSTOM_ID: foo
:END:
* H2
:PROPERTIES:
:CUSTOM_ID: foo
:END:"
(org-lint '(duplicate-custom-id))))
(should-not
(org-test-with-temp-text "
* H1
:PROPERTIES:
:CUSTOM_ID: foo
:END:
* H2
:PROPERTIES:
:CUSTOM_ID: bar
:END:"
(org-lint '(duplicate-custom-id)))))
(ert-deftest test-org-lint/duplicate-name ()
"Test `org-lint-duplicate-name' checker."
(should
(org-test-with-temp-text "
#+name: foo
Paragraph1
#+name: foo
Paragraph 2"
(org-lint '(duplicate-name))))
(should-not
(org-test-with-temp-text "
#+name: foo
Paragraph1
#+name: bar
Paragraph 2"
(org-lint '(duplicate-name)))))
(ert-deftest test-org-lint/duplicate-target ()
"Test `org-lint-duplicate-target' checker."
(should
(org-test-with-temp-text "<<foo>> <<foo>>"
(org-lint '(duplicate-target))))
(should-not
(org-test-with-temp-text "<<foo>> <<bar>>"
(org-lint '(duplicate-target)))))
(ert-deftest test-org-lint/duplicate-footnote-definition ()
"Test `org-lint-duplicate-footnote-definition' checker."
(should
(org-test-with-temp-text "
\[fn:1] Definition 1
\[fn:1] Definition 2"
(org-lint '(duplicate-footnote-definition))))
(should-not
(org-test-with-temp-text "
\[fn:1] Definition 1
\[fn:2] Definition 2"
(org-lint '(duplicate-footnote-definition)))))
(ert-deftest test-org-lint/orphaned-affiliated-keywords ()
"Test `org-lint-orphaned-affiliated-keywords' checker."
(should
(org-test-with-temp-text "#+name: foo"
(org-lint '(orphaned-affiliated-keywords)))))
(ert-deftest test-org-lint/deprecated-export-blocks ()
"Test `org-lint-deprecated-export-blocks' checker."
(should
(org-test-with-temp-text "
#+begin_latex
...
#+end_latex"
(org-lint '(deprecated-export-blocks)))))
(ert-deftest test-org-lint/deprecated-header-syntax ()
"Test `org-lint-deprecated-header-syntax' checker."
(should
(org-test-with-temp-text "#+property: cache yes"
(org-lint '(deprecated-header-syntax))))
(should
(org-test-with-temp-text "
* H
:PROPERTIES:
:cache: yes
:END:"
(org-lint '(deprecated-header-syntax)))))
(ert-deftest test-org-lint/missing-language-in-src-block ()
"Test `org-lint-missing-language-in-src-block' checker."
(should
(org-test-with-temp-text "
#+begin_src
...
#+end_src"
(org-lint '(missing-language-in-src-block)))))
(ert-deftest test-org-lint/missing-backend-in-export-block ()
"Test `org-lint-missing-backend-in-export-block' checker."
(should
(org-test-with-temp-text "
#+begin_export
...
#+end_export"
(org-lint '(missing-backend-in-export-block)))))
(ert-deftest test-org-lint/invalid-babel-call-block ()
"Test `org-lint-invalid-babel-call-block' checker."
(should
(org-test-with-temp-text "#+call:"
(org-lint '(invalid-babel-call-block))))
(should
(org-test-with-temp-text "#+call: foo() [:exports code]"
(org-lint '(invalid-babel-call-block)))))
(ert-deftest test-org-lint/deprecated-category-setup ()
"Test `org-lint-deprecated-category-setup' checker."
(should
(org-test-with-temp-text "#+category: foo\n#+category: bar"
(org-lint '(deprecated-category-setup)))))
(ert-deftest test-org-lint/invalid-coderef-link ()
"Test `org-lint-invalid-coderef-link' checker."
(should
(org-test-with-temp-text "[[(unknown)]]"
(org-lint '(invalid-coderef-link))))
(should-not
(org-test-with-temp-text "[[(foo)]]
#+begin_src emacs-lisp -l \"; ref:%s\"
testing: Make all files use `lexical-binding` Mainly, add the corresponding cookie, but also add various `require`s so that the compiler knows which vars should be trated as dynbound. This does not fix all the warnings, but does try to eliminate all those about "unused" variables. For the variables truly unused, the patch usually adds an underscore to their name to silence the warning. Some of the fixes affect files which already used `lexical-binding`. Not sure why the test worked before: maybe because the tests were run without compiling them first (which could cause some of the missing `require`d packages to be autoloaded before we got to the problematic code, thus hiding the problem)? I found some suspicious code, for which I added FIXMEs. There are also a few changes to the main files. * lisp/org-protocol.el (org-protocol-check-filename-for-protocol): Don't call `server-edit` if it's not yet defined. [ Needed to get the tests to pass. ] * lisp/ob-core.el (org-babel-temporary-directory) (org-babel-temporary-stable-directory): Always define (and use nil if we don't want to create a directory for it). Simplify the code based on the fact that (defvar V E) only evaluates E if V is not yet `boundp`. (org-babel-temp-file, org-babel-temp-stable-file) (org-babel-remove-temporary-directory) (org-babel-remove-temporary-stable-directory): Adjust accordingly. * lisp/org.el (org-log-beginning): Add FIXME. * testing/org-test.el: Require `org` and `org-id`. (org-id-locations-file): Don't `defconst` it. (org-test-at-id, org-test-in-example-file, org-test-at-marker) (org-test-with-temp-text, org-test-with-temp-text-in-file): Move edebug specs into `declare` (and simplify them). (org-test-with-tramp-remote-dir--worker): Declare dynbound tramp vars. (org--compile-when): Fix quoting of `exp`. (org-test-load): Tweak regexps. * testing/org-batch-test-init.el: Tweak regexp, remove dead code and add a FIXME about it. * testing/lisp/test-ox.el: Require `ox` instead of erroring out if it's not already loaded. Also require `org-inlinetask`. (org-test-with-parsed-data): Silence warnings when `info` is not used. (test-org-export/bind-keyword): Add FIXME. * testing/lisp/test-ox-publish.el: Require `org-test` and `ox-publish`. (test-org-publish/resolve-external-link): Expose lambdas to the compiler. Remove unused var `ids`. (test-org-publish/get-project-from-filename): Remove unused var `file`. * testing/lisp/test-org.el: Require `org-macs`, `org`, `org-inlinetask`, `org-refile`, and `org-agenda`. (test-org/org-read-date): Declare `org-time-was-given` as dynbound. (test-org/set-regexps-and-options): Add FIXME. * testing/lisp/test-org-timer.el: Require `org-timer`. * testing/lisp/test-org-table.el: Require `ox`. * testing/lisp/test-org-protocol.el: Require `org-protocol` instead of erroring out if it's not already loaded. Also require `capture`, and add missing `provide` statement. * testing/lisp/test-org-pcomplete.el: Require `org`. * testing/lisp/test-org-list.el: Require `org-list` and `org`. * testing/lisp/test-org-lint.el: Require `org-footnote` and `org-lint`. * testing/lisp/test-org-footnote.el: Require `org-footnote`. * testing/lisp/test-org-element.el: Require `org-element` instead of erroring out if it's not already loaded. Also require `org` and `org-inlinetask`. * testing/lisp/test-org-duration.el: Require `org-duration`. * testing/lisp/test-org-datetree.el: Require `org-datetree`. * testing/lisp/test-org-colview.el: Require `org-colview`, `org-duration`, and `org-inlinetask`. * testing/lisp/test-org-clock.el: Require `org-duration` and `org-clock`. * testing/lisp/test-org-archive.el: Require `org-archive`. * testing/lisp/test-org-agenda.el (test-org-agenda/bulk-custom-arg-func): Add FIXME. * testing/lisp/test-ol.el: Require `ol` and `org-id`. (test-org-link/store-link): Declare `org-store-link-props` and add FIXME. * testing/lisp/test-oc.el (test-org-cite/export-capability): Add FIXME. * testing/lisp/test-ob.el: Require `ob-core`, `org-src`, `ob-ref`, and `org-table`. (test-ob/eval-header-argument): Rename `foo` to `test-ob--foo` and declare it as dynbound. (test-ob/blocks-with-spaces, test-ob/specific-colnames): Add FIXME. (test-ob/noweb-expansions-in-cache): Declare `noweb-expansions-in-cache-var` as dynbound. * testing/lisp/test-ob-tangle.el: Require `org` and `ob-tangle`. * testing/lisp/test-ob-shell.el: * testing/lisp/test-ob-python.el: Require `ob-core`. * testing/lisp/test-ob-lob.el: Require `ob-lob`. (temporary-value-for-test): Declare as dynbound. * testing/lisp/test-ob-plantuml.el: Require `ob-plantuml` instead of erroring out if it's not already loaded. * testing/lisp/test-ob-lilypond.el: Require `ob-lilypond` instead of erroring out if it's not already loaded. Use `with-current-buffer`. * testing/lisp/test-ob-julia.el: Require `ob-core`. * testing/lisp/test-ob-java.el (org-babel-temporary-directory): Remove dead code now that `org-babel-temporary-directory` is always bound. * testing/lisp/test-ob-exp.el: Require `ob-exp`, `org-src`, and `org-test`. (ob-exp/evaluate-all-executables-in-order): Declare `*evaluation-collector*` as dynbound. * testing/lisp/test-ob-emacs-lisp.el (ob-emacs-lisp/dynamic-lexical-edit) (ob-emacs-lisp/dynamic-lexical-execute): Rename dynbound var to `ob-emacs--x` and declare it as such. * testing/lisp/test-ob-R.el: Require `ob-core`. (ess-ask-for-ess-directory, ess-history-file): Declare vars.
2022-09-14 21:21:37 +00:00
\(+ 1 1) ; ref:foo
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
#+end_src"
(org-lint '(invalid-coderef-link)))))
(ert-deftest test-org-lint/invalid-custom-id-link ()
"Test `org-lint-invalid-custom-id-link' checker."
(should
(org-test-with-temp-text "[[#unknown]]"
(org-lint '(invalid-custom-id-link))))
(should-not
(org-test-with-temp-text "[[#foo]]
* H
:PROPERTIES:
:CUSTOM_ID: foo
:END:"
(org-lint '(invalid-custom-id-link)))))
(ert-deftest test-org-lint/invalid-fuzzy-link ()
"Test `org-lint-invalid-fuzzy-link' checker."
(should
(org-test-with-temp-text "[[*unknown]]"
(org-lint '(invalid-fuzzy-link))))
(should-not
(org-test-with-temp-text "[[*foo]]\n* foo"
(org-lint '(invalid-fuzzy-link))))
(should
(org-test-with-temp-text "[[unknown]]"
(org-lint '(invalid-fuzzy-link))))
(should-not
(org-test-with-temp-text "[[foo]]\n#+name: foo\nParagraph"
(org-lint '(invalid-fuzzy-link))))
(should-not
(org-test-with-temp-text "[[foo]]\n<<foo>>"
(org-lint '(invalid-fuzzy-link)))))
(ert-deftest test-org-lint/special-property-in-properties-drawer ()
"Test `org-lint-special-property-in-properties-drawer' checker."
(should
(org-test-with-temp-text "
* H
:PROPERTIES:
:TODO: foo
:END:"
(org-lint '(special-property-in-properties-drawer)))))
(ert-deftest test-org-lint/obsolete-properties-drawer ()
"Test `org-lint-obsolete-properties-drawer' checker."
org-element: Fix property drawers parsing * lisp/org-element.el (org-element--next-mode): Properly handle first section. * lisp/org-lint.el (org-lint-obsolete-properties-drawer): Ignore document-level property drawers. * testing/lisp/test-org-lint.el (test-org-lint/obsolete-properties-drawer): Add tests.
2020-04-22 14:06:43 +00:00
(should-not
(org-test-with-temp-text "
* H
:PROPERTIES:
:SOMETHING: foo
:END:"
(org-lint '(obsolete-properties-drawer))))
(should-not
(org-test-with-temp-text "
* H
SCHEDULED: <2012-03-29>
:PROPERTIES:
:SOMETHING: foo
:END:"
(org-lint '(obsolete-properties-drawer))))
(should-not
(org-test-with-temp-text ":PROPERTIES:
:SOMETHING: foo
:END:"
(org-lint '(obsolete-properties-drawer))))
(should-not
(org-test-with-temp-text "# Comment
:PROPERTIES:
:SOMETHING: foo
:END:"
(org-lint '(obsolete-properties-drawer))))
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(should
(org-test-with-temp-text "
* H
Paragraph
:PROPERTIES:
:SOMETHING: foo
:END:"
(org-lint '(obsolete-properties-drawer))))
(should
(org-test-with-temp-text "
* H
:PROPERTIES:
This is not a node property
org-element: Fix property drawers parsing * lisp/org-element.el (org-element--next-mode): Properly handle first section. * lisp/org-lint.el (org-lint-obsolete-properties-drawer): Ignore document-level property drawers. * testing/lisp/test-org-lint.el (test-org-lint/obsolete-properties-drawer): Add tests.
2020-04-22 14:06:43 +00:00
:END:"
(org-lint '(obsolete-properties-drawer))))
(should
(org-test-with-temp-text "Paragraph
:PROPERTIES:
:FOO: bar
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
:END:"
(org-lint '(obsolete-properties-drawer)))))
org-lint: Report invalid durations in effort properties * lisp/org-lint.el (org-lint-invalid-effort-property): New checker. * testing/lisp/test-org-lint.el (test-org-lint/invalid-effort-property): New test.
2017-03-12 08:08:28 +00:00
(ert-deftest test-org-lint/invalid-effort-property ()
"Test `org-lint-invalid-effort-property' checker."
(should
(org-test-with-temp-text "* H\n:PROPERTIES:\n:EFFORT: something\n:END:"
(org-lint '(invalid-effort-property))))
(should-not
(org-test-with-temp-text "* H\n:PROPERTIES:\n:EFFORT: 1:23\n:END:"
(org-lint '(invalid-effort-property)))))
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(ert-deftest test-org-lint/link-to-local-file ()
"Test `org-lint-link-to-local-file' checker."
(should
(org-test-with-temp-text "[[file:/Idonotexist.org]]"
(org-lint '(link-to-local-file)))))
(ert-deftest test-org-lint/non-existent-setupfile-parameter ()
"Test `org-lint-non-existent-setupfile-parameter' checker."
(should
(org-test-with-temp-text "#+setupfile: Idonotexist.org"
org-lint: Do not warn about URL setup files * lisp/org-lint.el (org-lint-non-existent-setupfile-parameter): Do not warn when setup file is a URL. * testing/lisp/test-org-lint.el (test-org-lint/non-existent-setupfile-parameter): Add test. Reported-by: Dominik Schrempf <dominik.schrempf@gmail.com> <http://lists.gnu.org/r/emacs-orgmode/2019-03/msg00169.html>
2019-03-14 17:11:00 +00:00
(org-lint '(non-existent-setupfile-parameter))))
(should-not
(org-test-with-temp-text "#+setupfile: https://I.do/not.exist.org"
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(org-lint '(non-existent-setupfile-parameter)))))
(ert-deftest test-org-lint/wrong-include-link-parameter ()
"Test `org-lint-wrong-include-link-parameter' checker."
(should
(org-test-with-temp-text "#+include:"
(org-lint '(wrong-include-link-parameter))))
(should
(org-test-with-temp-text "#+include: Idonotexist.org"
(org-lint '(wrong-include-link-parameter))))
(should
(org-test-with-temp-text-in-file ""
(let ((file (buffer-file-name)))
(org-test-with-temp-text (format "#+include: \"%s::#foo\"" file)
(org-lint '(wrong-include-link-parameter))))))
(should-not
(org-test-with-temp-text-in-file "* foo"
(let ((file (buffer-file-name)))
(org-test-with-temp-text (format "#+include: \"%s::*foo\"" file)
(org-lint '(wrong-include-link-parameter)))))))
(ert-deftest test-org-lint/obsolete-include-markup ()
"Test `org-lint-obsolete-include-markup' checker."
(should
(org-test-with-temp-text-in-file ""
(let ((file (buffer-file-name)))
(org-test-with-temp-text (format "#+include: \"%s\" html" file)
(org-lint '(obsolete-include-markup))))))
(should-not
(org-test-with-temp-text-in-file ""
(let ((file (buffer-file-name)))
(org-test-with-temp-text (format "#+include: \"%s\" export html" file)
(org-lint '(obsolete-include-markup)))))))
(ert-deftest test-org-lint/unknown-options-item ()
"Test `org-lint-unknown-options-item' checker."
(should
(org-test-with-temp-text "#+options: foobarbaz:t"
ox: Do not choke on incomplete OPTIONS items * lisp/ox.el (org-export--parse-option-keyword): Prevent "End of file during parsing" error when an OPTIONS item is incomplete. * lisp/org-lint.el (org-lint-unknown-options-item): Check for incomplete options items. * testing/lisp/test-org-lint.el (test-org-lint/unknown-options-item): Add test.
2021-04-09 20:47:57 +00:00
(org-lint '(unknown-options-item))))
(should
(org-test-with-temp-text "#+options: H:"
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(org-lint '(unknown-options-item)))))
(ert-deftest test-org-lint/invalid-macro-argument-and-template ()
"Test `org-lint-invalid-macro-argument-and-template' checker."
(should
(org-test-with-temp-text "{{{undefined()}}}"
(org-lint '(invalid-macro-argument-and-template))))
(should
(org-test-with-temp-text
"#+macro: wrongsignature $1 $2\n{{{wrongsignature(1, 2, 3)}}}"
(org-lint '(invalid-macro-argument-and-template))))
(should
(org-test-with-temp-text "#+macro:"
(org-lint '(invalid-macro-argument-and-template))))
(should
(org-test-with-temp-text "#+macro: missingtemplate"
(org-lint '(invalid-macro-argument-and-template))))
(should
(org-test-with-temp-text "#+macro: unusedplaceholders $1 $3"
(org-lint '(invalid-macro-argument-and-template))))
(should-not
(org-test-with-temp-text
"#+macro: valid $1 $2\n{{{valid(1, 2)}}}"
lint: Improve checks for internal macros * lisp/org-lint.el (org-lint-invalid-macro-argument-and-template): Add arity checks for internal macros. * testing/lisp/test-org-lint.el (test-org-lint/invalid-macro-argument-and-template): Add tests.
2021-04-19 00:06:01 +00:00
(org-lint '(invalid-macro-argument-and-template))))
(should
(org-test-with-temp-text "{{{keyword}}}"
(org-lint '(invalid-macro-argument-and-template))))
(should
(org-test-with-temp-text "{{{keyword(one, too many)}}}"
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(org-lint '(invalid-macro-argument-and-template)))))
(ert-deftest test-org-lint/undefined-footnote-reference ()
"Test `org-lint-undefined-footnote-reference' checker."
(should
(org-test-with-temp-text "Text[fn:1]"
(org-lint '(undefined-footnote-reference))))
(should-not
(org-test-with-temp-text "Text[fn:1]\n[fn:1] Definition"
org-lint: Fix wrong warning with inline footnotes * lisp/org-lint.el (org-lint-undefined-footnote-reference): Do not warn when definition is inline. * testing/lisp/test-org-lint.el (test-org-lint/undefined-footnote-reference): Add tests. Reported-by: Eric S Fraga <esflists@gmail.com> <http://lists.gnu.org/archive/html/emacs-orgmode/2017-08/msg00577.html>
2017-08-25 13:24:07 +00:00
(org-lint '(undefined-footnote-reference))))
(should-not
(org-test-with-temp-text "Text[fn:1:inline reference]"
(org-lint '(undefined-footnote-reference))))
lint: Fix false positive with inline footnote definitions * lisp/org-lint.el (org-lint-invalid-macro-argument-and-template): Take into consideration inline definitions. * testing/lisp/test-org-lint.el (test-org-lint/undefined-footnote-reference): Add test. Reported-by: Timothy <tecosaur@gmail.com>
2022-02-13 21:13:41 +00:00
(should-not
(org-test-with-temp-text "Text[fn:1:inline reference] [fn:1]"
(org-lint '(undefined-footnote-reference))))
org-lint: Fix wrong warning with inline footnotes * lisp/org-lint.el (org-lint-undefined-footnote-reference): Do not warn when definition is inline. * testing/lisp/test-org-lint.el (test-org-lint/undefined-footnote-reference): Add tests. Reported-by: Eric S Fraga <esflists@gmail.com> <http://lists.gnu.org/archive/html/emacs-orgmode/2017-08/msg00577.html>
2017-08-25 13:24:07 +00:00
(should-not
(org-test-with-temp-text "Text[fn::anonymous reference]"
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(org-lint '(undefined-footnote-reference)))))
(ert-deftest test-org-lint/unreferenced-footnote-definition ()
"Test `org-lint-unreferenced-footnote-definition' checker."
(should
(org-test-with-temp-text "[fn:1] Definition"
(org-lint '(unreferenced-footnote-definition))))
(should-not
(org-test-with-temp-text "Text[fn:1]\n[fn:1] Definition"
(org-lint '(unreferenced-footnote-definition)))))
ox-icalendar: Add support for unscheduled and repeating TODOs * lisp/ox-icalendar.el (org-icalendar-todo-unscheduled-start): New customization to control the exported start time of unscheduled tasks. (org-icalendar--rrule): Helper function for RRULE export. (org-icalendar--vevent): Use the new helper function for RRULE. (org-icalendar--repeater-type): Helper function to get the repeater type, and display warning if not supported. (org-icalendar--vtodo): Change how unscheduled TODOs are handled using the new customization option. Export SCHEDULED and DEADLINE repeaters. In case of SCHEDULED repeater and a DEADLINE without repeater, treat DEADLINE as RRULE UNTIL. Emit a warning for tricky edge cases that are not yet implemented. * testing/lisp/test-ox-icalendar.el (test-ox-icalendar/todo-repeater-shared): Test for exporting shared SCHEDULED/DEADLINE repeater. (test-ox-icalendar/todo-repeating-deadline-warndays): Test using warning days as DTSTART of repeating deadline. (test-ox-icalendar/todo-repeater-until): Test using DEADLINE as RRULE UNTIL. (test-ox-icalendar/todo-repeater-until-utc): Test RRULE UNTIL is in UTC format when DTSTART is not in local time format. (test-ox-icalendar/warn-unsupported-repeater): Unit test to warn for unsupported repeater types. * lisp/org-lint.el (org-lint-mismatched-planning-repeaters): Add lint for mismatched SCHEDULED and DEADLINE repeaters. * testing/lisp/test-org-lint.el (test-org-lint/mismatched-planning-repeaters): Add test for linting of mismatched SCHEDULED and DEADLINE repeaters. * doc/org-manual.org (iCalendar Export): Add link to new variable `org-icalendar-todo-unscheduled-start'.
2023-06-11 14:50:20 +00:00
(ert-deftest test-org-lint/mismatched-planning-repeaters ()
"Test `org-lint-mismatched-planning-repeaters' checker."
(should
(org-test-with-temp-text "* H
DEADLINE: <2023-03-26 Sun +2w> SCHEDULED: <2023-03-26 Sun +1w>"
(org-lint '(mismatched-planning-repeaters)))))
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(ert-deftest test-org-lint/misplaced-planning-info ()
"Test `org-lint-misplaced-planning-info' checker."
(should
(org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
(org-lint '(misplaced-planning-info))))
(should
(org-test-with-temp-text "
* H
Text
SCHEDULED: <2012-03-29 thu.>"
(org-lint '(misplaced-planning-info))))
(should-not
(org-test-with-temp-text "
* H
SCHEDULED: <2012-03-29 thu.>"
(org-lint '(misplaced-planning-info)))))
(ert-deftest test-org-lint/incomplete-drawer ()
"Test `org-lint-incomplete-drawer' checker."
(should
(org-test-with-temp-text ":DRAWER:"
(org-lint '(incomplete-drawer))))
lint: Catch misleading drawers within drawers * lisp/org-lint.el (org-lint-incomplete-drawer): Catch misleading drawers within drawers. * testing/lisp/test-org-lint.el (test-org-lint/incomplete-drawer): Add test.
2020-05-27 12:55:04 +00:00
(should
(org-test-with-temp-text ":DRAWER:\n:ODD:\n:END:"
(org-lint '(incomplete-drawer))))
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(should-not
(org-test-with-temp-text ":DRAWER:\n:END:"
(org-lint '(incomplete-drawer)))))
(ert-deftest test-org-lint/indented-diary-sexp ()
"Test `org-lint-indented-diary-sexp' checker."
(should
(org-test-with-temp-text " %%(foo)"
(org-lint '(indented-diary-sexp))))
(should-not
(org-test-with-temp-text "%%(foo)"
(org-lint '(indented-diary-sexp)))))
(ert-deftest test-org-lint/invalid-block ()
"Test `org-lint-invalid-block' checker."
(should
(org-test-with-temp-text "#+begin_foo"
(org-lint '(invalid-block))))
(should-not
(org-test-with-temp-text "#+begin_foo\n#+end_foo"
(org-lint '(invalid-block)))))
(ert-deftest test-org-lint/invalid-keyword-syntax ()
"Test `org-lint-invalid-keyword-syntax' checker."
(should
(org-test-with-temp-text "#+keyword"
(org-lint '(invalid-keyword-syntax))))
(should-not
(org-test-with-temp-text "#+keyword:"
(org-lint '(invalid-keyword-syntax)))))
(ert-deftest test-org-lint/extraneous-element-in-footnote-section ()
"Test `org-lint-extraneous-element-in-footnote-section' checker."
(should
(org-test-with-temp-text "* Footnotes\nI'm not a footnote definition"
(let ((org-footnote-section "Footnotes"))
(org-lint '(extraneous-element-in-footnote-section)))))
(should-not
(org-test-with-temp-text "* Footnotes\n[fn:1] I'm a footnote definition"
(let ((org-footnote-section "Footnotes"))
(org-lint '(extraneous-element-in-footnote-section))))))
(ert-deftest test-org-lint/quote-section ()
"Test `org-lint-quote-section' checker."
(should
(org-test-with-temp-text "* QUOTE H"
(org-lint '(quote-section))))
(should
(org-test-with-temp-text "* COMMENT QUOTE H"
(org-lint '(quote-section)))))
(ert-deftest test-org-lint/file-application ()
"Test `org-lint-file-application' checker."
(should
(org-test-with-temp-text "[[file+emacs:foo.org]]"
(org-lint '(file-application)))))
org-lint: Add checker for obsolete link escape syntax * lisp/org-lint.el (org-lint--checkers): Add new linter. (org-lint-percent-encoding-link-escape): New function. * testing/lisp/test-org-lint.el (test-org-lint/percenc-encoding-link-escape): New test.
2019-03-10 14:11:58 +00:00
(ert-deftest test-org-lint/percenc-encoding-link-escape ()
"Test `org-lint-percent-encoding-link-escape' checker."
(should
(org-test-with-temp-text "[[A%20B]]"
(org-lint '(percent-encoding-link-escape))))
(should
(org-test-with-temp-text "[[%5Bfoo%5D]]"
(org-lint '(percent-encoding-link-escape))))
(should
(org-test-with-temp-text "[[A%2520B]]"
(org-lint '(percent-encoding-link-escape))))
(should-not
(org-test-with-temp-text "[[A B]]"
(org-lint '(percent-encoding-link-escape))))
(should-not
(org-test-with-temp-text "[[A%30B]]"
(org-lint '(percent-encoding-link-escape))))
(should-not
(org-test-with-temp-text "[[A%20%30B]]"
(org-lint '(percent-encoding-link-escape))))
(should-not
(org-test-with-temp-text "<file:A%20B>"
(org-lint '(percent-encoding-link-escape))))
(should-not
(org-test-with-temp-text "[[A B%]]"
(org-lint '(percent-encoding-link-escape)))))
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(ert-deftest test-org-lint/wrong-header-argument ()
"Test `org-lint-wrong-header-argument' checker."
(should
(org-test-with-temp-text "#+call: foo() barbaz yes"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "#+call: foo() :barbaz yes"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "call_foo[barbaz yes]()"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "call_foo[:barbaz yes]()"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "#+property: header-args barbaz yes"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "#+property: header-args :barbaz yes"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "
* H
:PROPERTIES:
:HEADER-ARGS: barbaz yes
:END:"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "
* H
:PROPERTIES:
:HEADER-ARGS: :barbaz yes
:END:"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "
#+header: :barbaz yes
#+begin_src emacs-lisp
\(+ 1 1)
#+end_src"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "src_emacs-lisp[barbaz yes]{}"
(org-lint '(wrong-header-argument))))
(should
(org-test-with-temp-text "src_emacs-lisp[:barbaz yes]{}"
(org-lint '(wrong-header-argument)))))
(ert-deftest test-org-lint/wrong-header-value ()
"Test `org-lint-wrong-header-value' checker."
(should
(org-test-with-temp-text "
#+header: :cache maybe
#+begin_src emacs-lisp
\(+ 1 1)
#+end_src"
(org-lint '(wrong-header-value))))
(should
(org-test-with-temp-text "
#+header: :exports both none
#+begin_src emacs-lisp
\(+ 1 1)
#+end_src"
(org-lint '(wrong-header-value))))
(should-not
(org-test-with-temp-text "
#+header: :cache yes
#+begin_src emacs-lisp
\(+ 1 1)
#+end_src"
(org-lint '(wrong-header-value)))))
org-lint: Add checker for spurious colons in tags * lisp/org-lint.el (org-lint--checkers): Add checker. (org-lint-spurious-colons): New function. * testing/lisp/test-org-lint.el (test-org/spurious-colons): New test.
2018-05-14 15:41:04 +00:00
(ert-deftest test-org/spurious-colons ()
"Test `org-list-spurious-colons' checker."
(should-not
(org-test-with-temp-text "* H :tag:tag2:"
(org-lint '(spurious-colons))))
(should
(org-test-with-temp-text "* H :tag::tag2:"
(org-lint '(spurious-colons))))
(should
(org-test-with-temp-text "* H :tag::"
(org-lint '(spurious-colons)))))
org-lint: Add checkers for citations and related * lisp/org-lint.el (org-lint--checkers): Register new checkers. (org-lint-non-existent-bibliography): (org-lint-missing-print-bibliography): (org-lint-invalid-cite-export-declaration): (org-lint-incomplete-citation): New functions. * testing/lisp/test-org-lint.el (test-org-lint/non-existent-bibliography): (test-org-lint/missing-print-bibliography): (test-org-lint/invalid-cite-export-declaration): (test-org-lint/incomplete-citation): New tests.
2021-11-30 14:39:17 +00:00
(ert-deftest test-org-lint/non-existent-bibliography ()
"Test `org-lint-non-existent-bibliography' checker."
(should
(org-test-with-temp-text "#+bibliography: Idonotexist.bib"
(org-lint '(non-existent-bibliography)))))
(ert-deftest test-org-lint/missing-print-bibliography ()
"Test `org-lint-missing-print-bibliography' checker."
(should
(org-test-with-temp-text "[cite:@foo]"
(org-lint '(missing-print-bibliography))))
(should-not
(org-test-with-temp-text "[cite:@foo]\n#+print_bibliography:"
(org-lint '(missing-print-bibliography))))
(should-not
(org-test-with-temp-text ""
(org-lint '(missing-print-bibliography)))))
(ert-deftest test-org-lint/invalid-cite-export-declaration ()
"Test `org-lint-invalid-cite-export-declaration' checker."
(should
(org-test-with-temp-text "#+cite_export: "
(org-lint '(invalid-cite-export-declaration))))
(should
(org-test-with-temp-text "#+cite_export: 2"
(org-lint '(invalid-cite-export-declaration))))
(should
(org-test-with-temp-text "#+cite_export: basic bar baz qux"
(org-lint '(invalid-cite-export-declaration))))
(should
(org-test-with-temp-text "#+cite_export: basic \"bar"
(org-lint '(invalid-cite-export-declaration))))
(should
(org-test-with-temp-text "#+cite_export: unknown"
(org-lint '(invalid-cite-export-declaration))))
(should-not
(org-test-with-temp-text "#+cite_export: basic"
(org-lint '(invalid-cite-export-declaration)))))
(ert-deftest test-org-lint/incomplete-citation ()
"Test `org-lint-incomplete-citation' checker."
(should
(org-test-with-temp-text "[cite:foo]"
(org-lint '(incomplete-citation))))
(should
(org-test-with-temp-text "[cite:@foo"
(org-lint '(incomplete-citation))))
(should-not
(org-test-with-temp-text "[cite:@foo]"
(org-lint '(incomplete-citation)))))
org-lint: Add checker for empty headlines with tags * lisp/org-lint.el (org-lint--checkers): Add checker. (org-lint-empty-headline-with-tags): New function. * testing/lisp/test-org-lint.el (test-org-lint/empty-headline-with-tags): New test.
2017-02-17 12:23:26 +00:00
Add tests for Org Lint * testing/lisp/test-org-lint.el: New file.
2016-09-18 22:57:20 +00:00
(provide 'test-org-lint)
;;; test-org-lint.el ends here