emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [HELP] Request for patches to improve Org test coverage
Date: Wed, 24 Nov 2021 21:11:28 +0800	[thread overview]
Message-ID: <874k81bsvz.fsf@localhost> (raw)

Dear Fellow Orgers,

Despite being not directly visible to users, Org mode testing suite is
critical to maintain overall codebase stability. It helps to avoid
unintentional breakages as we keep adding new features to Org.

Yet, writing tests is probably not the most exciting part for
volunteer contributors. Not many new patches also include tests and the
core Org maintainers do not have a bandwidth to supply every new
significant patch with tests.

I am writing this help request in a hope that someone interested and/or
experienced with writing tests can help improving Org tests without a
need to spend a lot of time doing something unfamiliar (e.g. I
personally wrote my very first test as a patch for Org, not knowing much
about code testing beforehand).

Some of the possible improvements to Org test suite are listed below:

- Tests on bugfix branch fail to run using Emacs 26.
  Not because of main Org code, but because test-org re-defines
  decode-time in a way not supported by older Emacs versions. (This has
  been fixed on main and simply need to be ported back to bugfix).

- Tests always run in a single process and cannot benefit from make -j
  Supporting parallel execution of multiple test sets would make Org
  development much faster by reducing make test runtime.

- Testing native-compiled Org is missing. Having it would be nice.

- Tests covering state logging are missing. I wrote an example patch how
  to write such tests, but never got around for more
  https://orgmode.org/list/87tul1v11c.fsf@localhost

- Most of the tests are written assuming default values of customised
  variables. We have very basic test coverage for non-standard settings.
  A way to run all possible tests under most common user customisations
  would improve the test coverage a lot.

- Generally, more and better tests would be welcome.

Best,
Ihor


             reply	other threads:[~2021-11-24 13:45 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-24 13:11 Ihor Radchenko [this message]
2021-11-24 14:27 ` Max Nikulin
2021-11-25 12:13   ` Ihor Radchenko
2021-11-24 14:36 ` Daniele Pizzolli
2021-11-25 12:32   ` Ihor Radchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=874k81bsvz.fsf@localhost \
    --to=yantar92@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: [HELP] Request for patches to improve Org test coverage' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).